libcdio  0.93
Data Structures | Typedefs | Enumerations | Functions | Variables
device.h File Reference

C header for driver- or device-related libcdio calls. ("device" includes CD-image reading devices). More...

#include <cdio/types.h>
#include <cdio/cdio.h>

Go to the source code of this file.

Data Structures

struct  cdio_hwinfo
 Structure to return CD vendor, model, and revision-level strings obtained via the INQUIRY command. More...
 

Typedefs

typedef uint32_t cdio_drive_read_cap_t
 
typedef uint32_t cdio_drive_write_cap_t
 
typedef uint32_t cdio_drive_misc_cap_t
 
typedef struct cdio_hwinfo cdio_hwinfo_t
 Structure to return CD vendor, model, and revision-level strings obtained via the INQUIRY command. More...
 

Enumerations

enum  cdio_drive_cap_misc_t {
  CDIO_DRIVE_CAP_ERROR = 0x40000, CDIO_DRIVE_CAP_UNKNOWN = 0x80000, CDIO_DRIVE_CAP_MISC_CLOSE_TRAY = 0x00001, CDIO_DRIVE_CAP_MISC_EJECT = 0x00002,
  CDIO_DRIVE_CAP_MISC_LOCK = 0x00004, CDIO_DRIVE_CAP_MISC_SELECT_SPEED = 0x00008, CDIO_DRIVE_CAP_MISC_SELECT_DISC = 0x00010, CDIO_DRIVE_CAP_MISC_MULTI_SESSION = 0x00020,
  CDIO_DRIVE_CAP_MISC_MEDIA_CHANGED = 0x00080, CDIO_DRIVE_CAP_MISC_RESET = 0x00100, CDIO_DRIVE_CAP_MISC_FILE = 0x20000
}
 Drive capability bits returned by cdio_get_drive_cap() NOTE: Setting a bit here means the presence of a capability. More...
 
enum  cdio_drive_cap_read_t {
  CDIO_DRIVE_CAP_READ_AUDIO = 0x00001, CDIO_DRIVE_CAP_READ_CD_DA = 0x00002, CDIO_DRIVE_CAP_READ_CD_G = 0x00004, CDIO_DRIVE_CAP_READ_CD_R = 0x00008,
  CDIO_DRIVE_CAP_READ_CD_RW = 0x00010, CDIO_DRIVE_CAP_READ_DVD_R = 0x00020, CDIO_DRIVE_CAP_READ_DVD_PR = 0x00040, CDIO_DRIVE_CAP_READ_DVD_RAM = 0x00080,
  CDIO_DRIVE_CAP_READ_DVD_ROM = 0x00100, CDIO_DRIVE_CAP_READ_DVD_RW = 0x00200, CDIO_DRIVE_CAP_READ_DVD_RPW = 0x00400, CDIO_DRIVE_CAP_READ_C2_ERRS = 0x00800,
  CDIO_DRIVE_CAP_READ_MODE2_FORM1 = 0x01000, CDIO_DRIVE_CAP_READ_MODE2_FORM2 = 0x02000, CDIO_DRIVE_CAP_READ_MCN = 0x04000, CDIO_DRIVE_CAP_READ_ISRC = 0x08000
}
 
enum  cdio_drive_cap_write_t {
  CDIO_DRIVE_CAP_WRITE_CD_R = 0x00001, CDIO_DRIVE_CAP_WRITE_CD_RW = 0x00002, CDIO_DRIVE_CAP_WRITE_DVD_R = 0x00004, CDIO_DRIVE_CAP_WRITE_DVD_PR = 0x00008,
  CDIO_DRIVE_CAP_WRITE_DVD_RAM = 0x00010, CDIO_DRIVE_CAP_WRITE_DVD_RW = 0x00020, CDIO_DRIVE_CAP_WRITE_DVD_RPW = 0x00040, CDIO_DRIVE_CAP_WRITE_MT_RAINIER = 0x00080,
  CDIO_DRIVE_CAP_WRITE_BURN_PROOF = 0x00100, CDIO_DRIVE_CAP_WRITE_CD, CDIO_DRIVE_CAP_WRITE_DVD, CDIO_DRIVE_CAP_WRITE
}
 
enum  cdio_mmc_hw_len_t { CDIO_MMC_HW_VENDOR_LEN = 8, CDIO_MMC_HW_MODEL_LEN = 16, CDIO_MMC_HW_REVISION_LEN = 4 }
 
enum  cdio_src_category_mask_t { CDIO_SRC_IS_DISK_IMAGE_MASK = 0x0001, CDIO_SRC_IS_DEVICE_MASK = 0x0002, CDIO_SRC_IS_SCSI_MASK = 0x0004, CDIO_SRC_IS_NATIVE_MASK = 0x0008 }
 
enum  driver_id_t {
  DRIVER_UNKNOWN, DRIVER_AIX, DRIVER_BSDI, DRIVER_FREEBSD,
  DRIVER_NETBSD, DRIVER_LINUX, DRIVER_SOLARIS, DRIVER_OS2,
  DRIVER_OSX, DRIVER_WIN32, DRIVER_CDRDAO, DRIVER_BINCUE,
  DRIVER_NRG, DRIVER_DEVICE
}
 
enum  driver_return_code_t {
  DRIVER_OP_SUCCESS = 0, DRIVER_OP_ERROR = -1, DRIVER_OP_UNSUPPORTED = -2, DRIVER_OP_UNINIT = -3,
  DRIVER_OP_NOT_PERMITTED = -4, DRIVER_OP_BAD_PARAMETER = -5, DRIVER_OP_BAD_POINTER = -6, DRIVER_OP_NO_DRIVER = -7,
  DRIVER_OP_MMC_SENSE_DATA = -8
}
 

Functions

 LIBCDIO_DEPRECATED (static const driver_id_t CDIO_MIN_DRIVER,"please use cdio_drivers") = DRIVER_NRG
 
 LIBCDIO_DEPRECATED (static const driver_id_t CDIO_MIN_DEVICE_DRIVER,"please use cdio_device_drivers") = DRIVER_WIN32
 
driver_return_code_t cdio_close_tray (const char *psz_drive, driver_id_t *p_driver_id)
 
const char * cdio_driver_errmsg (driver_return_code_t drc)
 
driver_return_code_t cdio_eject_media (CdIo_t **p_cdio)
 
driver_return_code_t cdio_eject_media_drive (const char *psz_drive)
 
void cdio_free_device_list (char *device_list[])
 
char * cdio_get_default_device (const CdIo_t *p_cdio)
 
char * cdio_get_default_device_driver (driver_id_t *p_driver_id)
 
char ** cdio_get_devices (driver_id_t driver_id)
 
char ** cdio_get_devices_with_cap (char *ppsz_search_devices[], cdio_fs_anal_t capabilities, bool b_any)
 
char ** cdio_get_devices_with_cap_ret (char *ppsz_search_devices[], cdio_fs_anal_t capabilities, bool b_any, driver_id_t *p_driver_id)
 
char ** cdio_get_devices_ret (driver_id_t *p_driver_id)
 
void cdio_get_drive_cap (const CdIo_t *p_cdio, cdio_drive_read_cap_t *p_read_cap, cdio_drive_write_cap_t *p_write_cap, cdio_drive_misc_cap_t *p_misc_cap)
 
void cdio_get_drive_cap_dev (const char *device, cdio_drive_read_cap_t *p_read_cap, cdio_drive_write_cap_t *p_write_cap, cdio_drive_misc_cap_t *p_misc_cap)
 
const char * cdio_get_driver_name (const CdIo_t *p_cdio)
 
const char * cdio_get_driver_name_from_id (driver_id_t driver_id)
 
driver_id_t cdio_get_driver_id (const CdIo_t *p_cdio)
 
bool cdio_get_hwinfo (const CdIo_t *p_cdio, cdio_hwinfo_t *p_hw_info)
 
driver_return_code_t cdio_get_last_session (CdIo_t *p_cdio, lsn_t *i_last_session)
 
int cdio_get_media_changed (CdIo_t *p_cdio)
 
bool_3way_t cdio_have_atapi (CdIo_t *p_cdio)
 
bool cdio_have_driver (driver_id_t driver_id)
 
void cdio_destroy (CdIo_t *p_cdio)
 
const char * cdio_driver_describe (driver_id_t driver_id)
 
CdIo_tcdio_open (const char *psz_source, driver_id_t driver_id)
 
CdIo_tcdio_open_am (const char *psz_source, driver_id_t driver_id, const char *psz_access_mode)
 
CdIo_tcdio_open_bincue (const char *psz_cue_name)
 
CdIo_tcdio_open_am_bincue (const char *psz_cue_name, const char *psz_access_mode)
 
CdIo_tcdio_open_cdrdao (const char *psz_toc_name)
 
CdIo_tcdio_open_am_cdrdao (const char *psz_toc_name, const char *psz_access_mode)
 
char * cdio_get_default_device_bincue (void)
 
char ** cdio_get_devices_bincue (void)
 
char * cdio_get_default_device_cdrdao (void)
 
char ** cdio_get_devices_cdrdao (void)
 
CdIo_tcdio_open_cd (const char *device_name)
 
CdIo_tcdio_open_am_cd (const char *psz_device, const char *psz_access_mode)
 
CdIo_tcdio_open_cue (const char *cue_name)
 
CdIo_tcdio_open_am_aix (const char *psz_source, const char *psz_access_mode)
 
CdIo_tcdio_open_aix (const char *psz_source)
 
char * cdio_get_default_device_aix (void)
 
char ** cdio_get_devices_aix (void)
 
CdIo_tcdio_open_bsdi (const char *psz_source)
 
CdIo_tcdio_open_am_bsdi (const char *psz_source, const char *psz_access_mode)
 
char * cdio_get_default_device_bsdi (void)
 
char ** cdio_get_devices_bsdi (void)
 
CdIo_tcdio_open_freebsd (const char *paz_psz_source)
 
CdIo_tcdio_open_am_freebsd (const char *psz_source, const char *psz_access_mode)
 
char * cdio_get_default_device_freebsd (void)
 
char ** cdio_get_devices_freebsd (void)
 
CdIo_tcdio_open_linux (const char *psz_source)
 
CdIo_tcdio_open_am_linux (const char *psz_source, const char *access_mode)
 
char * cdio_get_default_device_linux (void)
 
char ** cdio_get_devices_linux (void)
 
CdIo_tcdio_open_solaris (const char *psz_source)
 
CdIo_tcdio_open_am_solaris (const char *psz_source, const char *psz_access_mode)
 
char * cdio_get_default_device_solaris (void)
 
char ** cdio_get_devices_solaris (void)
 
CdIo_tcdio_open_osx (const char *psz_source)
 
CdIo_tcdio_open_am_osx (const char *psz_source, const char *psz_access_mode)
 
char * cdio_get_default_device_osx (void)
 
char ** cdio_get_devices_osx (void)
 
CdIo_tcdio_open_win32 (const char *psz_source)
 
CdIo_tcdio_open_am_win32 (const char *psz_source, const char *psz_access_mode)
 
char * cdio_get_default_device_win32 (void)
 
char ** cdio_get_devices_win32 (void)
 
CdIo_tcdio_open_os2 (const char *psz_source)
 
CdIo_tcdio_open_am_os2 (const char *psz_source, const char *psz_access_mode)
 
char * cdio_get_default_device_os2 (void)
 
char ** cdio_get_devices_os2 (void)
 
CdIo_tcdio_open_nrg (const char *psz_source)
 
CdIo_tcdio_open_am_nrg (const char *psz_source, const char *psz_access_mode)
 
char * cdio_get_default_device_nrg (void)
 
char ** cdio_get_devices_nrg (void)
 
char * cdio_is_binfile (const char *bin_name)
 
char * cdio_is_cuefile (const char *cue_name)
 
bool cdio_is_nrg (const char *psz_nrg)
 
bool cdio_is_tocfile (const char *psz_toc)
 
bool cdio_is_device (const char *psz_source, driver_id_t driver_id)
 
driver_return_code_t cdio_set_blocksize (const CdIo_t *p_cdio, int i_blocksize)
 
driver_return_code_t cdio_set_speed (const CdIo_t *p_cdio, int i_drive_speed)
 
const char * cdio_get_arg (const CdIo_t *p_cdio, const char key[])
 
driver_return_code_t cdio_set_arg (CdIo_t *p_cdio, const char key[], const char value[])
 
bool cdio_init (void)
 

Variables

const driver_id_t cdio_drivers []
 
const driver_id_t cdio_device_drivers []
 
const driver_id_t cdio_os_driver
 
cdio_drive_cap_misc_t debug_cdio_drive_cap_misc
 
cdio_drive_cap_read_t debug_cdio_drive_cap_read_t
 
cdio_drive_cap_write_t debug_drive_cap_write_t
 
cdio_mmc_hw_len_t debug_cdio_mmc_hw_len
 
cdio_src_category_mask_t debug_cdio_src_category_mask
 

Detailed Description

C header for driver- or device-related libcdio calls. ("device" includes CD-image reading devices).

Typedef Documentation

typedef uint32_t cdio_drive_misc_cap_t
typedef uint32_t cdio_drive_read_cap_t

The type of an drive capability bit mask. See below for values

typedef uint32_t cdio_drive_write_cap_t
typedef struct cdio_hwinfo cdio_hwinfo_t

Structure to return CD vendor, model, and revision-level strings obtained via the INQUIRY command.

Enumeration Type Documentation

Drive capability bits returned by cdio_get_drive_cap() NOTE: Setting a bit here means the presence of a capability.

Miscellaneous capabilities.

Enumerator
CDIO_DRIVE_CAP_ERROR 

Error

CDIO_DRIVE_CAP_UNKNOWN 

Dunno. It can be on if we have only partial information or are not completely certain

CDIO_DRIVE_CAP_MISC_CLOSE_TRAY 

caddy systems can't close...

CDIO_DRIVE_CAP_MISC_EJECT 

but can eject.

CDIO_DRIVE_CAP_MISC_LOCK 

disable manual eject

CDIO_DRIVE_CAP_MISC_SELECT_SPEED 

programmable speed

CDIO_DRIVE_CAP_MISC_SELECT_DISC 

select disc from juke-box

CDIO_DRIVE_CAP_MISC_MULTI_SESSION 

read sessions>1

CDIO_DRIVE_CAP_MISC_MEDIA_CHANGED 

media changed

CDIO_DRIVE_CAP_MISC_RESET 

hard reset device

CDIO_DRIVE_CAP_MISC_FILE 

drive is really a file, i.e a CD file image

Reading masks..

Enumerator
CDIO_DRIVE_CAP_READ_AUDIO 

drive can play CD audio

CDIO_DRIVE_CAP_READ_CD_DA 

drive can read CD-DA

CDIO_DRIVE_CAP_READ_CD_G 

drive can read CD+G

CDIO_DRIVE_CAP_READ_CD_R 

drive can read CD-R

CDIO_DRIVE_CAP_READ_CD_RW 

drive can read CD-RW

CDIO_DRIVE_CAP_READ_DVD_R 

drive can read DVD-R

CDIO_DRIVE_CAP_READ_DVD_PR 

drive can read DVD+R

CDIO_DRIVE_CAP_READ_DVD_RAM 

drive can read DVD-RAM

CDIO_DRIVE_CAP_READ_DVD_ROM 

drive can read DVD-ROM

CDIO_DRIVE_CAP_READ_DVD_RW 

drive can read DVD-RW

CDIO_DRIVE_CAP_READ_DVD_RPW 

drive can read DVD+RW

CDIO_DRIVE_CAP_READ_C2_ERRS 

has C2 error correction

CDIO_DRIVE_CAP_READ_MODE2_FORM1 

can read mode 2 form 1

CDIO_DRIVE_CAP_READ_MODE2_FORM2 

can read mode 2 form 2

CDIO_DRIVE_CAP_READ_MCN 

can read MCN

CDIO_DRIVE_CAP_READ_ISRC 

can read ISRC

Writing masks..

Enumerator
CDIO_DRIVE_CAP_WRITE_CD_R 

drive can write CD-R

CDIO_DRIVE_CAP_WRITE_CD_RW 

drive can write CD-RW

CDIO_DRIVE_CAP_WRITE_DVD_R 

drive can write DVD-R

CDIO_DRIVE_CAP_WRITE_DVD_PR 

drive can write DVD+R

CDIO_DRIVE_CAP_WRITE_DVD_RAM 

drive can write DVD-RAM

CDIO_DRIVE_CAP_WRITE_DVD_RW 

drive can write DVD-RW

CDIO_DRIVE_CAP_WRITE_DVD_RPW 

drive can write DVD+RW

CDIO_DRIVE_CAP_WRITE_MT_RAINIER 

Mount Rainier

CDIO_DRIVE_CAP_WRITE_BURN_PROOF 

burn proof

CDIO_DRIVE_CAP_WRITE_CD 

Has some sort of CD writer ability

CDIO_DRIVE_CAP_WRITE_DVD 

Has some sort of DVD writer ability

CDIO_DRIVE_CAP_WRITE 

Has some sort of DVD or CD writing ability

Size of fields returned by an INQUIRY command

Enumerator
CDIO_MMC_HW_VENDOR_LEN 

length of vendor field

CDIO_MMC_HW_MODEL_LEN 

length of model field

CDIO_MMC_HW_REVISION_LEN 

length of revision field

Flags specifying the category of device to open or is opened.

Enumerator
CDIO_SRC_IS_DISK_IMAGE_MASK 

Read source is a CD image.

CDIO_SRC_IS_DEVICE_MASK 

Read source is a CD device.

CDIO_SRC_IS_SCSI_MASK 

Read source SCSI device.

CDIO_SRC_IS_NATIVE_MASK 

The driver_id_t enumerations may be used to tag a specific driver that is opened or is desired to be opened. Note that this is different than what is available on a given host.

Order should not be changed lightly because it breaks the ABI. One is not supposed to iterate over the values, but iterate over the cdio_drivers and cdio_device_drivers arrays.

NOTE: IF YOU MODIFY ENUM MAKE SURE INITIALIZATION IN CDIO.C AGREES.

Enumerator
DRIVER_UNKNOWN 

Used as input when we don't care what kind of driver to use.

DRIVER_AIX 

AIX driver

DRIVER_BSDI 

BSDI driver

DRIVER_FREEBSD 

FreeBSD driver - includes CAM and ioctl access

DRIVER_NETBSD 

NetBSD Driver.

DRIVER_LINUX 

GNU/Linux Driver

DRIVER_SOLARIS 

Sun Solaris Driver

DRIVER_OS2 

IBM OS/2 Driver

DRIVER_OSX 

Apple OSX Driver

DRIVER_WIN32 

Microsoft Windows Driver. Includes ASPI and ioctl access.

DRIVER_CDRDAO 

cdrdao format CD image. This is listed before BIN/CUE, to make the code prefer cdrdao over BIN/CUE when both exist.

DRIVER_BINCUE 

CDRWIN BIN/CUE format CD image. This is listed before NRG, to make the code prefer BIN/CUE over NRG when both exist.

DRIVER_NRG 

Nero NRG format CD image.

DRIVER_DEVICE 

Is really a set of the above; should come last

The following are status codes for completion of a given cdio operation. By design 0 is successful completion and -1 is error completion. This is compatable with ioctl so those routines that call ioctl can just pass the value the get back (cast as this enum). Also, by using negative numbers for errors, the enumeration values below can be used in places where a positive value is expected when things complete successfully. For example, get_blocksize returns the blocksize, but on error uses the error codes below. So note that this enumeration is often cast to an integer. C seems to tolerate this.

Enumerator
DRIVER_OP_SUCCESS 

in cases where an int is returned, like cdio_set_speed, more the negative return codes are for errors and the positive ones for success.

DRIVER_OP_ERROR 

operation returned an error

DRIVER_OP_UNSUPPORTED 

returned when a particular driver doesn't support a particular operation. For example an image driver which doesn't really "eject" a CD.

DRIVER_OP_UNINIT 

returned when a particular driver hasn't been initialized or a null pointer has been passed.

DRIVER_OP_NOT_PERMITTED 

Operation not permitted. For example might be a permission problem.

DRIVER_OP_BAD_PARAMETER 

Bad parameter passed

DRIVER_OP_BAD_POINTER 

Bad pointer to memory area

DRIVER_OP_NO_DRIVER 

Operation called on a driver not available on this OS

DRIVER_OP_MMC_SENSE_DATA 

MMC operation returned sense data, but no other error above recorded.

Function Documentation

driver_return_code_t cdio_close_tray ( const char *  psz_drive,
driver_id_t p_driver_id 
)

Close media tray in CD drive if there is a routine to do so.

Parameters
psz_drivethe name of CD-ROM to be closed. If NULL, we will use the default device.
p_driver_idis 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 cdio_destroy ( CdIo_t p_cdio)

Free any resources associated with p_cdio. Call this when done using p_cdio and using CD reading/control operations.

Parameters
p_cdiothe CD object to eliminated.
const char* cdio_driver_describe ( driver_id_t  driver_id)

Get a string decribing driver_id.

Parameters
driver_idthe driver you want the description for
Returns
a string of driver description
const char* cdio_driver_errmsg ( driver_return_code_t  drc)
Parameters
drcthe return code you want interpreted.
Returns
the string information about drc
driver_return_code_t cdio_eject_media ( CdIo_t **  p_cdio)

Eject media in CD drive if there is a routine to do so.

Parameters
p_cdiothe CD object to be acted upon. If the CD is ejected *p_cdio is free'd and p_cdio set to NULL.
driver_return_code_t cdio_eject_media_drive ( const char *  psz_drive)

Eject media in CD drive if there is a routine to do so.

Parameters
psz_drivethe name of the device to be acted upon. If NULL is given as the drive, we'll use the default driver device.
void cdio_free_device_list ( char *  device_list[])

Free device list returned by cdio_get_devices or cdio_get_devices_with_cap.

Parameters
device_listlist returned by cdio_get_devices or cdio_get_devices_with_cap
See Also
cdio_get_devices, cdio_get_devices_with_cap
const char* cdio_get_arg ( const CdIo_t p_cdio,
const char  key[] 
)

Get the value associatied with key.

Parameters
p_cdiothe CD object queried
keythe key to retrieve
Returns
the value associatd with "key" or NULL if p_cdio is NULL or "key" does not exist.
char* cdio_get_default_device ( const CdIo_t p_cdio)

Get the default CD device. if p_cdio is NULL (we haven't initialized a specific device driver), then find a suitable one and return the default device for that.

Parameters
p_cdiothe CD object queried
Returns
a string containing the default CD device or NULL is if we couldn't get a default device.

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* cdio_get_default_device_aix ( void  )

Return a string containing the default device name that the AIX driver would use when none is specified.

Returns
the cdio object for subsequent operations. NULL on error or there is no AIX driver.
See Also
cdio_open_cd, cdio_open
char* cdio_get_default_device_bincue ( void  )

Return a string containing the default CUE file that would be used when none is specified.

Returns
the cdio object or NULL on error or no device.
char* cdio_get_default_device_bsdi ( void  )

Return a string containing the default device name that the BSDI driver would use when none is specified.

Returns
the cdio object for subsequent operations. NULL on error or there is no BSDI driver.
See Also
cdio_open_cd, cdio_open
char* cdio_get_default_device_cdrdao ( void  )
Returns
string containing the default CUE file that would be used when none is specified. NULL is returned on error or there is no device.
char* cdio_get_default_device_driver ( driver_id_t p_driver_id)

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* cdio_get_default_device_freebsd ( void  )

Return a string containing the default device name that the FreeBSD driver would use when none is specified.

NULL is returned on error or there is no CD-ROM device.

char* cdio_get_default_device_linux ( void  )

Return a string containing the default device name that the GNU/Linux driver would use when none is specified. A scan is made for CD-ROM drives with CDs in them.

NULL is returned on error or there is no CD-ROM device.

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.

See Also
cdio_open_cd, cdio_open
char* cdio_get_default_device_nrg ( void  )

Get a string containing the default device name that the NRG driver would use when none is specified. A scan is made for NRG disk images in the current directory.

Returns
string containing the default device. NULL on error or there is no CD-ROM device.
char* cdio_get_default_device_os2 ( void  )

Return a string containing the default device name that the OS/2 driver would use when none is specified. A scan is made for CD-ROM drives with CDs in them.

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* cdio_get_default_device_osx ( void  )

Return a string containing the default device name that the OSX driver would use when none is specified. A scan is made for CD-ROM drives with CDs in them.

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* cdio_get_default_device_solaris ( void  )

Return a string containing the default device name that the Solaris driver would use when none is specified. A scan is made for CD-ROM drives with CDs in them.

NULL is returned on error or there is no CD-ROM device.

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.

See Also
cdio_open_cd, cdio_open
char* cdio_get_default_device_win32 ( void  )

Return a string containing the default device name that the Win32 driver would use when none is specified. A scan is made for CD-ROM drives with CDs in them.

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.

See Also
cdio_open_cd, cdio_open
char** cdio_get_devices ( 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** cdio_get_devices_aix ( void  )

Return a list of all of the CD-ROM devices that the AIX driver can find.

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** cdio_get_devices_bincue ( void  )
char** cdio_get_devices_bsdi ( void  )

Return a list of all of the CD-ROM devices that the BSDI driver can find.

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** cdio_get_devices_cdrdao ( void  )
char** cdio_get_devices_freebsd ( void  )

Return a list of all of the CD-ROM devices that the FreeBSD driver can find.

char** cdio_get_devices_linux ( void  )

Return a list of all of the CD-ROM devices that the GNU/Linux driver can find.

char** cdio_get_devices_nrg ( void  )
char** cdio_get_devices_os2 ( void  )

Return a list of all of the CD-ROM devices that the OS/2 driver can find.

char** cdio_get_devices_osx ( void  )

Return a list of all of the CD-ROM devices that the OSX driver can find.

char** cdio_get_devices_ret ( driver_id_t p_driver_id)

Like cdio_get_devices, 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** cdio_get_devices_solaris ( void  )

Return a list of all of the CD-ROM devices that the Solaris driver can find.

char** cdio_get_devices_win32 ( void  )
char** cdio_get_devices_with_cap ( char *  ppsz_search_devices[],
cdio_fs_anal_t  capabilities,
bool  b_any 
)

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.

Capabilities have two parts to them, a "filesystem" part and an "analysis" part.

The filesystem part is mutually exclusive. For example either the filesystem is at most one of the High-Sierra, UFS, or HFS, ISO9660, fileystems. Valid combinations of say HFS and ISO9660 are specified as a separate "filesystem".

Capabilities on the other hand are not mutually exclusive. For example a filesystem may have none, either, or both of the XA or Rock-Ridge extension properties.

If "b_any" is set false then every capability listed in the analysis portion of capabilities (i.e. not the basic filesystem) must be satisified. If no analysis capabilities are specified, that's a match.

If "b_any" is set true, then if any of the analysis capabilities matches, we call that a success.

In either case, in the filesystem portion different filesystem either specify 0 to match any filesystem or the specific filesystem type.

To find a CD-drive of any type, use the mask CDIO_FS_MATCH_ALL.

Returns
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** cdio_get_devices_with_cap_ret ( char *  ppsz_search_devices[],
cdio_fs_anal_t  capabilities,
bool  b_any,
driver_id_t p_driver_id 
)

Like cdio_get_devices_with_cap 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.

void cdio_get_drive_cap ( const CdIo_t p_cdio,
cdio_drive_read_cap_t p_read_cap,
cdio_drive_write_cap_t p_write_cap,
cdio_drive_misc_cap_t p_misc_cap 
)

Get the what kind of device we've got.

Parameters
p_cdiothe CD object queried
p_read_cappointer to return read capabilities
p_write_cappointer to return write capabilities
p_misc_cappointer to return miscellaneous other capabilities

In some situations of drivers or OS's we can't find a CD device if there is no media in it. In this situation capabilities will show up as NULL even though there isa hardware CD-ROM.

void cdio_get_drive_cap_dev ( const char *  device,
cdio_drive_read_cap_t p_read_cap,
cdio_drive_write_cap_t p_write_cap,
cdio_drive_misc_cap_t p_misc_cap 
)

Get the drive capabilities for a specified device.

Return a list of device capabilities.

In some situations of drivers or OS's we can't find a CD device if there is no media in it. In this situation capabilities will show up as NULL even though there isa hardware CD-ROM.

driver_id_t cdio_get_driver_id ( const CdIo_t p_cdio)

Get the driver id. if CdIo_t is NULL (we haven't initialized a specific device driver), then return DRIVER_UNKNOWN.

Returns
the driver id..
const char* cdio_get_driver_name ( const CdIo_t p_cdio)

Get a string containing the name of the driver in use.

Returns
a string with driver name or NULL if CdIo_t is NULL (we haven't initialized a specific device.
const char* cdio_get_driver_name_from_id ( driver_id_t  driver_id)

Return a string containing the name of the driver in use from the driver_id. if CdIo is NULL (we haven't initialized a specific device driver), then return NULL.

bool cdio_get_hwinfo ( const CdIo_t p_cdio,
cdio_hwinfo_t p_hw_info 
)

Get the CD-ROM hardware info via a SCSI MMC INQUIRY command. False is returned if we had an error getting the information.

driver_return_code_t cdio_get_last_session ( CdIo_t p_cdio,
lsn_t i_last_session 
)

Get the LSN of the first track of the last session of on the CD.

Parameters
p_cdiothe CD object to be acted upon.
i_last_sessionpointer to the session number to be returned.
int cdio_get_media_changed ( CdIo_t p_cdio)

Find out if media has changed since the last call.

Parameters
p_cdiothe CD object to be acted upon.
Returns
1 if media has changed since last call, 0 if not. Error return codes are the same as driver_return_code_t
bool_3way_t cdio_have_atapi ( CdIo_t p_cdio)

True if CD-ROM understand ATAPI commands.

bool cdio_have_driver ( driver_id_t  driver_id)

Like cdio_have_xxx but uses an enumeration instead.

bool cdio_init ( void  )

Initialize CD Reading and control routines. Should be called first.

char* cdio_is_binfile ( const char *  bin_name)

Determine if bin_name is the bin file part of a CDRWIN CD disk image.

Parameters
bin_namelocation of presumed CDRWIN bin image file.
Returns
the corresponding CUE file if bin_name is a BIN file or NULL if not a BIN file.
char* cdio_is_cuefile ( const char *  cue_name)

Determine if cue_name is the cue sheet for a CDRWIN CD disk image.

Returns
corresponding BIN file if cue_name is a CDRWIN cue file or NULL if not a CUE file.
bool cdio_is_device ( const char *  psz_source,
driver_id_t  driver_id 
)

Determine if psz_source refers to a real hardware CD-ROM.

Parameters
psz_sourcelocation name of object
driver_iddriver for reading object. Use DRIVER_UNKNOWN if you don't know what driver to use.
Returns
true if psz_source is a device; If false is returned we could have a CD disk image.
bool cdio_is_nrg ( const char *  psz_nrg)

Determine if psg_nrg is a Nero CD disc image.

Parameters
psz_nrglocation of presumed NRG image file.
Returns
true if psz_nrg is a Nero NRG image or false if not a NRG image.
bool cdio_is_tocfile ( const char *  psz_toc)

Determine if psz_toc is a TOC file for a cdrdao CD disc image.

Parameters
psz_toclocation of presumed TOC image file.
Returns
true if toc_name is a cdrdao TOC file or false if not a TOC file.
CdIo_t* cdio_open ( const char *  psz_source,
driver_id_t  driver_id 
)

Sets up to read from place specified by psz_source and driver_id. This or cdio_open_* should be called before using any other routine, except cdio_init or any routine that accesses the CD-ROM drive by name. cdio_open will call cdio_init, if that hasn't been done previously.

Returns
the cdio object or NULL on error or no device. If NULL is given as the source, we'll use the default driver device.
CdIo_t* cdio_open_aix ( const char *  psz_source)

Set up CD-ROM for reading using the AIX driver. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no AIX driver.
See Also
cdio_open
CdIo_t* cdio_open_am ( const char *  psz_source,
driver_id_t  driver_id,
const char *  psz_access_mode 
)

Sets up to read from place specified by psz_source, driver_id and access mode. This or cdio_open* should be called before using any other routine, except cdio_init or any routine that accesses the CD-ROM drive by name. This will call cdio_init, if that hasn't been done previously.

If NULL is given as the source, we'll use the default driver device.

Returns
the cdio object or NULL on error or no device.
CdIo_t* cdio_open_am_aix ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the AIX driver. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no AIX driver.
See Also
cdio_open
CdIo_t* cdio_open_am_bincue ( const char *  psz_cue_name,
const char *  psz_access_mode 
)

Set up BIN/CUE CD disk-image for reading. Source is the .bin or .cue file

Returns
the cdio object or NULL on error or no device..
CdIo_t* cdio_open_am_bsdi ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the BSDI driver. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no BSDI driver.
See Also
cdio_open
CdIo_t* cdio_open_am_cd ( const char *  psz_device,
const char *  psz_access_mode 
)

Set up CD-ROM for reading. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no driver for a some sort of hardware CD-ROM.
CdIo_t* cdio_open_am_cdrdao ( const char *  psz_toc_name,
const char *  psz_access_mode 
)

Set up cdrdao CD disk-image for reading. Source is the .toc file

Returns
the cdio object or NULL on error or no device..
CdIo_t* cdio_open_am_freebsd ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the FreeBSD driver. The device_name is the some sort of device name.

NULL is returned on error or there is no FreeBSD driver.

See Also
cdio_open_cd, cdio_open
CdIo_t* cdio_open_am_linux ( const char *  psz_source,
const char *  access_mode 
)

Set up CD-ROM for reading using the GNU/Linux driver. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no GNU/Linux driver.
CdIo_t* cdio_open_am_nrg ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the Nero driver. The device_name is the some sort of device name.

Returns
true on success; NULL on error or there is no Nero driver.
CdIo_t* cdio_open_am_os2 ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the IBM OS/2 driver. The device_name is the some sort of device name.

NULL is returned on error or there is no OS/2 driver.

See Also
cdio_open_cd, cdio_open
CdIo_t* cdio_open_am_osx ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the Apple OSX driver. The device_name is the some sort of device name.

NULL is returned on error or there is no OSX driver.

See Also
cdio_open_cd, cdio_open
CdIo_t* cdio_open_am_solaris ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the Sun Solaris driver. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no Solaris driver.
CdIo_t* cdio_open_am_win32 ( const char *  psz_source,
const char *  psz_access_mode 
)

Set up CD-ROM for reading using the Microsoft Windows driver. The device_name is the some sort of device name.

NULL is returned on error or there is no Microsof Windows driver.

CdIo_t* cdio_open_bincue ( const char *  psz_cue_name)

Set up BIN/CUE CD disk-image for reading. Source is the .bin or .cue file

Returns
the cdio object or NULL on error or no device.
CdIo_t* cdio_open_bsdi ( const char *  psz_source)

Set up CD-ROM for reading using the BSDI driver. The device_name is the some sort of device name.

Parameters
psz_sourcethe name of the device to open
Returns
the cdio object for subsequent operations. NULL on error or there is no BSDI driver.
See Also
cdio_open
CdIo_t* cdio_open_cd ( const char *  device_name)

Set up CD-ROM for reading. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no driver for a some sort of hardware CD-ROM.
CdIo_t* cdio_open_cdrdao ( const char *  psz_toc_name)

Set up cdrdao CD disk-image for reading. Source is the .toc file

Returns
the cdio object or NULL on error or no device.
CdIo_t* cdio_open_cue ( const char *  cue_name)

CDRWIN BIN/CUE CD disc-image routines. Source is the .cue file

Returns
the cdio object for subsequent operations. NULL on error.
CdIo_t* cdio_open_freebsd ( const char *  paz_psz_source)

Set up CD-ROM for reading using the FreeBSD driver. The device_name is the some sort of device name.

NULL is returned on error or there is no FreeBSD driver.

See Also
cdio_open_cd, cdio_open
CdIo_t* cdio_open_linux ( const char *  psz_source)

Set up CD-ROM for reading using the GNU/Linux driver. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no GNU/Linux driver.

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.

CdIo_t* cdio_open_nrg ( const char *  psz_source)

Set up CD-ROM for reading using the Nero driver. The device_name is the some sort of device name.

Returns
true on success; NULL on error or there is no Nero driver.
CdIo_t* cdio_open_os2 ( const char *  psz_source)

Set up CD-ROM for reading using the IBM OS/2 driver. The device_name is the some sort of device name.

NULL is returned on error or there is no OS/2 driver.

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.

See Also
cdio_open_cd, cdio_open
CdIo_t* cdio_open_osx ( const char *  psz_source)

Set up CD-ROM for reading using the Apple OSX driver. The device_name is the some sort of device name.

NULL is returned on error or there is no OSX driver.

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.

See Also
cdio_open_cd, cdio_open
CdIo_t* cdio_open_solaris ( const char *  psz_source)

Set up CD-ROM for reading using the Sun Solaris driver. The device_name is the some sort of device name.

Returns
the cdio object for subsequent operations. NULL on error or there is no Solaris driver.
CdIo_t* cdio_open_win32 ( const char *  psz_source)

Set up CD-ROM for reading using the Microsoft Windows driver. The device_name is the some sort of device name.

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.

driver_return_code_t cdio_set_arg ( CdIo_t p_cdio,
const char  key[],
const char  value[] 
)

Set the arg "key" with "value" in "p_cdio".

Parameters
p_cdiothe CD object to set
keythe key to set
valuethe value to assocaiate with key
driver_return_code_t cdio_set_blocksize ( const CdIo_t p_cdio,
int  i_blocksize 
)

Set the blocksize for subsequent reads.

driver_return_code_t cdio_set_speed ( const CdIo_t p_cdio,
int  i_drive_speed 
)

Set the drive speed.

Parameters
p_cdioCD structure set by cdio_open().
i_drive_speedspeed in CD-ROM speed units. Note this not Kbs as would be used in the MMC spec or in mmc_set_speed(). To convert CD-ROM speed units to Kbs, multiply the number by 176 (for raw data) and by 150 (for filesystem data). On many CD-ROM drives, specifying a value too large will result in using the fastest speed.
See Also
mmc_set_speed and mmc_set_drive_speed
LIBCDIO_DEPRECATED ( static const driver_id_t  CDIO_MIN_DRIVER,
"please use cdio_drivers  
) = DRIVER_NRG

Those are deprecated; use cdio_drivers or cdio_device_drivers to iterate over all drivers or only the device drivers. Make sure what's listed for CDIO_MIN_DRIVER is the last enumeration in driver_id_t. Since we have a bogus (but useful) 0th entry above we don't have to add one.

LIBCDIO_DEPRECATED ( static const driver_id_t  CDIO_MIN_DEVICE_DRIVER,
"please use cdio_device_drivers  
) = DRIVER_WIN32

Variable Documentation

const driver_id_t cdio_device_drivers[]

A null-terminated (that is DRIVER_UNKNOWN-terminated) ordered (in order of preference) array of device drivers.

const driver_id_t cdio_drivers[]

A null-terminated (that is DRIVER_UNKNOWN-terminated) ordered (in order of preference) array of drivers.

const driver_id_t cdio_os_driver

There will generally be only one hardware for a given build/platform from the list above. You can use the variable below to determine which you've got. If the build doesn't make an hardware driver, then the value will be DRIVER_UNKNOWN.

cdio_drive_cap_misc_t debug_cdio_drive_cap_misc

The below variables are trickery to force the above enum symbol values to be recorded in debug symbol tables. They are used to allow one to refer to the enumeration value names in the typedefs above in a debugger and debugger expressions.

cdio_drive_cap_read_t debug_cdio_drive_cap_read_t
cdio_mmc_hw_len_t debug_cdio_mmc_hw_len
cdio_src_category_mask_t debug_cdio_src_category_mask
cdio_drive_cap_write_t debug_drive_cap_write_t