182 lines
5.9 KiB
C++
182 lines
5.9 KiB
C++
/*
|
|
$Id: devices.hpp,v 1.5 2008/03/25 15:59:10 karl Exp $
|
|
|
|
Copyright (C) 2005, 2006, 2008 Rocky Bernstein <rocky@gnu.org>
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** \file devices.hpp
|
|
*
|
|
* \brief methods relating to devices. It is *not* part of a class.
|
|
* This file should not be #included directly.
|
|
*/
|
|
|
|
|
|
/*!
|
|
Close media tray in CD drive if there is a routine to do so.
|
|
|
|
@param psz_drive the name of CD-ROM to be closed.
|
|
@param driver_id is the driver to be used or that got used if
|
|
it was DRIVER_UNKNOWN or DRIVER_DEVICE; If this is NULL, we won't
|
|
report back the driver used.
|
|
*/
|
|
void closeTray (const char *psz_drive, /*in/out*/ driver_id_t &driver_id);
|
|
|
|
/*!
|
|
Close media tray in CD drive if there is a routine to do so.
|
|
|
|
@param psz_drive the name of CD-ROM to be closed. If omitted or
|
|
NULL, we'll scan for a suitable CD-ROM.
|
|
*/
|
|
void closeTray (const char *psz_drive=(const char *)NULL);
|
|
|
|
/*!
|
|
Get a string decribing driver_id.
|
|
|
|
@param driver_id the driver you want the description for
|
|
@return a sring of driver description
|
|
*/
|
|
const char *driverDescribe (driver_id_t driver_id);
|
|
|
|
/*!
|
|
Eject media in CD drive if there is a routine to do so.
|
|
|
|
If the CD is ejected, object is destroyed.
|
|
*/
|
|
void ejectMedia (const char *psz_drive);
|
|
|
|
/*!
|
|
Free device list returned by GetDevices
|
|
|
|
@param device_list list returned by GetDevices
|
|
|
|
@see GetDevices
|
|
|
|
*/
|
|
void freeDeviceList (char * device_list[]);
|
|
|
|
/*!
|
|
Return a string containing the default CD device if none is specified.
|
|
if p_driver_id is DRIVER_UNKNOWN or DRIVER_DEVICE
|
|
then find a suitable one set the default device for that.
|
|
|
|
NULL is returned if we couldn't get a default device.
|
|
*/
|
|
char * getDefaultDevice(/*in/out*/ driver_id_t &driver_id);
|
|
|
|
/*! Return an array of device names. If you want a specific
|
|
devices for a driver, give that device. If you want hardware
|
|
devices, give DRIVER_DEVICE and if you want all possible devices,
|
|
image drivers and hardware drivers give DRIVER_UNKNOWN.
|
|
|
|
NULL is returned if we couldn't return a list of devices.
|
|
|
|
In some situations of drivers or OS's we can't find a CD device if
|
|
there is no media in it and it is possible for this routine to return
|
|
NULL even though there may be a hardware CD-ROM.
|
|
*/
|
|
char ** getDevices(driver_id_t driver_id=DRIVER_DEVICE);
|
|
|
|
/*! Like GetDevices above, but we may change the p_driver_id if we
|
|
were given DRIVER_DEVICE or DRIVER_UNKNOWN. This is because
|
|
often one wants to get a drive name and then *open* it
|
|
afterwards. Giving the driver back facilitates this, and speeds
|
|
things up for libcdio as well.
|
|
*/
|
|
|
|
char **getDevices (driver_id_t &driver_id);
|
|
|
|
/*!
|
|
Get an array of device names in search_devices that have at least
|
|
the capabilities listed by the capabities parameter. If
|
|
search_devices is NULL, then we'll search all possible CD drives.
|
|
|
|
If "b_any" is set false then every capability listed in the
|
|
extended portion of capabilities (i.e. not the basic filesystem)
|
|
must be satisified. If "any" is set true, then if any of the
|
|
capabilities matches, we call that a success.
|
|
|
|
To find a CD-drive of any type, use the mask CDIO_FS_MATCH_ALL.
|
|
|
|
@return the array of device names or NULL if we couldn't get a
|
|
default device. It is also possible to return a non NULL but
|
|
after dereferencing the the value is NULL. This also means nothing
|
|
was found.
|
|
*/
|
|
char ** getDevices(/*in*/ char *ppsz_search_devices[],
|
|
cdio_fs_anal_t capabilities, bool b_any=false);
|
|
|
|
/*!
|
|
Like GetDevices above but we return the driver we found
|
|
as well. This is because often one wants to search for kind of drive
|
|
and then *open* it afterwards. Giving the driver back facilitates this,
|
|
and speeds things up for libcdio as well.
|
|
*/
|
|
char ** getDevices(/*in*/ char* ppsz_search_devices[],
|
|
cdio_fs_anal_t capabilities, /*out*/ driver_id_t &driver_id,
|
|
bool b_any=false);
|
|
|
|
/*! Return true if we Have driver for driver_id */
|
|
bool haveDriver (driver_id_t driver_id);
|
|
|
|
/*!
|
|
|
|
Determine if bin_name is the bin file part of a CDRWIN CD disk image.
|
|
|
|
@param bin_name location of presumed CDRWIN bin image file.
|
|
@return the corresponding CUE file if bin_name is a BIN file or
|
|
NULL if not a BIN file.
|
|
*/
|
|
char *isBinFile(const char *psz_bin_name);
|
|
|
|
|
|
/*!
|
|
Determine if cue_name is the cue sheet for a CDRWIN CD disk image.
|
|
|
|
@return corresponding BIN file if cue_name is a CDRWIN cue file or
|
|
NULL if not a CUE file.
|
|
*/
|
|
char *isCueFile(const char *psz_cue_name);
|
|
|
|
/*!
|
|
Determine if psz_source refers to a real hardware CD-ROM.
|
|
|
|
@param psz_source location name of object
|
|
@param driver_id driver for reading object. Use DRIVER_UNKNOWN if you
|
|
don't know what driver to use.
|
|
@return true if psz_source is a device; If false is returned we
|
|
could have a CD disk image.
|
|
*/
|
|
bool isDevice(const char *psz_source, driver_id_t driver_id);
|
|
|
|
/*!
|
|
Determine if psz_nrg is a Nero CD disk image.
|
|
|
|
@param psz_nrg location of presumed NRG image file.
|
|
@return true if psz_nrg is a Nero NRG image or false
|
|
if not a NRG image.
|
|
*/
|
|
bool isNero(const char *psz_nrg);
|
|
|
|
/*!
|
|
Determine if psz_toc is a TOC file for a cdrdao CD disk image.
|
|
|
|
@param psz_toc location of presumed TOC image file.
|
|
@return true if toc_name is a cdrdao TOC file or false
|
|
if not a TOC file.
|
|
*/
|
|
bool isTocFile(const char *psz_toc);
|
|
|