.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "perlcdio 3pm" .TH perlcdio 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME perlcdio \- lower\-level wrapper to libcdio, the CD Input and Control library .SH SYNOPSIS .IX Header "SYNOPSIS" This is fairly straight-forward wrapper around the C library libcdio. Although this is perfectly usable on its own, it is expected that the Object-Oriented interface Device::Cdio is what most people will want to use. .PP There are various constants that are defined here. .SH DESCRIPTION .IX Header "DESCRIPTION" Encapsulation is done in two parts. The lower-level Perl interface is called perlcdio (this file) and is generated via SWIG. .SH CONSTANTS .IX Header "CONSTANTS" .SS "Driver ID's" .IX Subsection "Driver ID's" .IP DRIVER_UNKNOWN 4 .IX Item "DRIVER_UNKNOWN" Use when you don't know what kind of driver and you don't care if it is an CD image driver or a real CD-ROM driver. See also DRIVER_DEVICE which doesn't include image drivers. .IP DRIVER_AIX 4 .IX Item "DRIVER_AIX" Driver for IBM's AIX. .IP DRIVER_BSDI 4 .IX Item "DRIVER_BSDI" Driver for BSDI. .IP DRIVER_FREEBSD 4 .IX Item "DRIVER_FREEBSD" Driver for Free BSD .IP DRIVER_LINUX 4 .IX Item "DRIVER_LINUX" Driver for GNU/LINUX .IP DRIVER_SOLARIS 4 .IX Item "DRIVER_SOLARIS" Driver for Solaris .IP DRIVER_OSX 4 .IX Item "DRIVER_OSX" Driver for Apple's OS X. .IP DRIVER_WIN32 4 .IX Item "DRIVER_WIN32" Driver for Microsoft Windows .IP DRIVER_CDRDAO 4 .IX Item "DRIVER_CDRDAO" Image Driver for cdrdao .IP DRIVER_BINCUE 4 .IX Item "DRIVER_BINCUE" Image driver for CDRWin BIN/CUE .IP DRIVER_NRG 4 .IX Item "DRIVER_NRG" Image driver for Nero NRG .IP DRIVER_DEVICE 4 .IX Item "DRIVER_DEVICE" Use when you don't know what kind of driver but the driver must be a real CD-ROM driver. See also DRIVER_UNKNOWN which includes image drivers. .SS "Driver Return codes" .IX Subsection "Driver Return codes" May driver operations return a status code. .IP DRIVER_OP_SUCCESS 4 .IX Item "DRIVER_OP_SUCCESS" Driver operation was successful .IP DRIVER_OP_ERROR 4 .IX Item "DRIVER_OP_ERROR" Driver operation had an error of some sort .IP DRIVER_OP_UNSUPPORTED 4 .IX Item "DRIVER_OP_UNSUPPORTED" Operation is not supported for this driver. For example ejecting a CD from an image driver. .IP DRIVER_OP_UNINIT 4 .IX Item "DRIVER_OP_UNINIT" Source is not initialized for this operation. .IP DRIVER_OP_NOT_PERMITTED 4 .IX Item "DRIVER_OP_NOT_PERMITTED" Operation is not permitted .IP DRIVER_OP_BAD_PARAMETER 4 .IX Item "DRIVER_OP_BAD_PARAMETER" An invalid parameter was passed to the routine .IP DRIVER_OP_BAD_POINTER 4 .IX Item "DRIVER_OP_BAD_POINTER" A pointer somehow got corrupted. .IP DRIVER_OP_NO_DRIVER 4 .IX Item "DRIVER_OP_NO_DRIVER" No driver has been set. .SS "Device Capabilities" .IX Subsection "Device Capabilities" \fIMiscellaneous\fR .IX Subsection "Miscellaneous" .IP DRIVE_CAP_ERROR 4 .IX Item "DRIVE_CAP_ERROR" .PD 0 .IP DRIVE_CAP_UNKNOWN 4 .IX Item "DRIVE_CAP_UNKNOWN" .IP DRIVE_CAP_MISC_CLOSE_TRAY 4 .IX Item "DRIVE_CAP_MISC_CLOSE_TRAY" .IP DRIVE_CAP_MISC_EJECT 4 .IX Item "DRIVE_CAP_MISC_EJECT" .IP DRIVE_CAP_MISC_LOCK 4 .IX Item "DRIVE_CAP_MISC_LOCK" .IP DRIVE_CAP_MISC_SELECT_SPEED 4 .IX Item "DRIVE_CAP_MISC_SELECT_SPEED" .IP DRIVE_CAP_MISC_SELECT_DISC 4 .IX Item "DRIVE_CAP_MISC_SELECT_DISC" .IP DRIVE_CAP_MISC_MULTI_SESSION 4 .IX Item "DRIVE_CAP_MISC_MULTI_SESSION" .IP DRIVE_CAP_MISC_MEDIA_CHANGED 4 .IX Item "DRIVE_CAP_MISC_MEDIA_CHANGED" .IP DRIVE_CAP_MISC_RESET 4 .IX Item "DRIVE_CAP_MISC_RESET" .IP DRIVE_CAP_MISC_FILE 4 .IX Item "DRIVE_CAP_MISC_FILE" .PD .PP \fIRead Capabilities\fR .IX Subsection "Read Capabilities" .IP DRIVE_CAP_READ_AUDIO 4 .IX Item "DRIVE_CAP_READ_AUDIO" .PD 0 .IP DRIVE_CAP_READ_CD_DA 4 .IX Item "DRIVE_CAP_READ_CD_DA" .IP DRIVE_CAP_READ_CD_G 4 .IX Item "DRIVE_CAP_READ_CD_G" .IP DRIVE_CAP_READ_CD_R 4 .IX Item "DRIVE_CAP_READ_CD_R" .IP DRIVE_CAP_READ_CD_RW 4 .IX Item "DRIVE_CAP_READ_CD_RW" .IP DRIVE_CAP_READ_DVD_R 4 .IX Item "DRIVE_CAP_READ_DVD_R" .IP DRIVE_CAP_READ_DVD_PR 4 .IX Item "DRIVE_CAP_READ_DVD_PR" .IP DRIVE_CAP_READ_DVD_RAM 4 .IX Item "DRIVE_CAP_READ_DVD_RAM" .IP DRIVE_CAP_READ_DVD_ROM 4 .IX Item "DRIVE_CAP_READ_DVD_ROM" .IP DRIVE_CAP_READ_DVD_RW 4 .IX Item "DRIVE_CAP_READ_DVD_RW" .IP DRIVE_CAP_READ_DVD_RPW 4 .IX Item "DRIVE_CAP_READ_DVD_RPW" .IP DRIVE_CAP_READ_C2_ERRS 4 .IX Item "DRIVE_CAP_READ_C2_ERRS" .IP DRIVE_CAP_READ_MODE2_FORM1 4 .IX Item "DRIVE_CAP_READ_MODE2_FORM1" .IP DRIVE_CAP_READ_MODE2_FORM2 4 .IX Item "DRIVE_CAP_READ_MODE2_FORM2" .IP DRIVE_CAP_READ_MCN 4 .IX Item "DRIVE_CAP_READ_MCN" .IP DRIVE_CAP_READ_ISRC 4 .IX Item "DRIVE_CAP_READ_ISRC" .PD .SS "Writing masks" .IX Subsection "Writing masks" .IP DRIVE_CAP_WRITE_CD_R 4 .IX Item "DRIVE_CAP_WRITE_CD_R" .PD 0 .IP DRIVE_CAP_WRITE_CD_RW 4 .IX Item "DRIVE_CAP_WRITE_CD_RW" .IP DRIVE_CAP_WRITE_DVD_R 4 .IX Item "DRIVE_CAP_WRITE_DVD_R" .IP DRIVE_CAP_WRITE_DVD_PR 4 .IX Item "DRIVE_CAP_WRITE_DVD_PR" .IP DRIVE_CAP_WRITE_DVD_RAM 4 .IX Item "DRIVE_CAP_WRITE_DVD_RAM" .IP DRIVE_CAP_WRITE_DVD_RW 4 .IX Item "DRIVE_CAP_WRITE_DVD_RW" .IP DRIVE_CAP_WRITE_DVD_RPW 4 .IX Item "DRIVE_CAP_WRITE_DVD_RPW" .IP DRIVE_CAP_WRITE_MT_RAINIER 4 .IX Item "DRIVE_CAP_WRITE_MT_RAINIER" .IP DRIVE_CAP_WRITE_BURN_PROOF 4 .IX Item "DRIVE_CAP_WRITE_BURN_PROOF" .PD .PP \fIDerived Capabilities\fR .IX Subsection "Derived Capabilities" .IP DRIVE_CAP_WRITE_CD 4 .IX Item "DRIVE_CAP_WRITE_CD" Has some sort of CD writer ability .IP DRIVE_CAP_WRITE_DVD 4 .IX Item "DRIVE_CAP_WRITE_DVD" Has some sort of DVD writer ability .IP DRIVE_CAP_WRITE 4 .IX Item "DRIVE_CAP_WRITE" Has some sort of writer ability .SS "Filesystem type constants" .IX Subsection "Filesystem type constants" These constants are used in getting drive capabilities: .IP FS_AUDIO 4 .IX Item "FS_AUDIO" audio only \- not really a filesystem .IP FS_HIGH_SIERRA 4 .IX Item "FS_HIGH_SIERRA" High-Sierra Filesystem .IP FS_ISO_9660 4 .IX Item "FS_ISO_9660" ISO\-9660 filesystem .IP FS_INTERACTIVE 4 .IX Item "FS_INTERACTIVE" .PD 0 .IP FS_HFS 4 .IX Item "FS_HFS" .PD file system used on the Macintosh system in MacOS 6 through MacOS 9 and deprecated in OSX .IP FS_UFS 4 .IX Item "FS_UFS" Generic Unix file system derived from the Berkeley fast file system. .IP FS_EXT2 4 .IX Item "FS_EXT2" EXT2 was the GNU/Linux native filesystem for early kernels. Newer GNU/Linux OS's may use EXT3 which EXT2 with a journal. .IP FS_ISO_HFS 4 .IX Item "FS_ISO_HFS" both HFS & ISO\-9660 filesystem .IP FS_ISO_9660_INTERACTIVE 4 .IX Item "FS_ISO_9660_INTERACTIVE" both CD-RTOS and ISO filesystem .IP FS_3DO 4 .IX Item "FS_3DO" The 3DO is, technically, a set of specifications created by the 3DO company. These specs are for making a 3DO Interactive Multiplayer which uses a CD-player. Panasonic in the early 90's was the first company to manufacture and market a 3DO player. .IP FS_XISO 4 .IX Item "FS_XISO" Microsoft X\-BOX CD .IP FS_UDFX 4 .IX Item "FS_UDFX" .PD 0 .IP FS_UDF 4 .IX Item "FS_UDF" .IP FS_ISO_UDF 4 .IX Item "FS_ISO_UDF" .IP FS_ANAL_XA 4 .IX Item "FS_ANAL_XA" .PD eXtended Architecture format .IP FS_ANAL_MULTISESSION 4 .IX Item "FS_ANAL_MULTISESSION" CD has multisesion .IP FS_ANAL_PHOTO_CD 4 .IX Item "FS_ANAL_PHOTO_CD" Is a Kodak Photo CD .IP FS_ANAL_HIDDEN_TRACK 4 .IX Item "FS_ANAL_HIDDEN_TRACK" Hidden track at the beginning the CD .IP FS_ANAL_CDTV 4 .IX Item "FS_ANAL_CDTV" .PD 0 .IP FS_ANAL_BOOTABLE 4 .IX Item "FS_ANAL_BOOTABLE" .PD CD is bootable .IP FS_ANAL_VIDEOCD 4 .IX Item "FS_ANAL_VIDEOCD" VCD 1.1 .IP FS_ANAL_ROCKRIDGE 4 .IX Item "FS_ANAL_ROCKRIDGE" Has Rock Ridge Extensions to ISO 9660 .IP FS_ANAL_JOLIET 4 .IX Item "FS_ANAL_JOLIET" Microsoft Joliet extensions to ISO 9660 .IP FS_ANAL_SVCD 4 .IX Item "FS_ANAL_SVCD" Super VCD or Choiji Video CD .IP FS_ANAL_CVD 4 .IX Item "FS_ANAL_CVD" Choiji Video CD .IP FS_ANAL_XISO 4 .IX Item "FS_ANAL_XISO" XBOX CD determined by some analysis .IP FS_MATCH_ALL 4 .IX Item "FS_MATCH_ALL" bitmask which can be used to specify matching any sort of CD .SS "Sector size constants" .IX Subsection "Sector size constants" .IP CD_FRAMESIZE 4 .IX Item "CD_FRAMESIZE" .PD 0 .IP CD_FRAMESIZE_RAW 4 .IX Item "CD_FRAMESIZE_RAW" .PD Size of a Philip Red book CD-DA block. It is also the maximum CD sector size possible: 2352 bytes. .IP ISO_BLOCKSIZE 4 .IX Item "ISO_BLOCKSIZE" Size of an ISO 9660 block. Also the size of the data portion in CD data reads: 2048 bytes. .IP M2F2_SECTOR_SIZE 4 .IX Item "M2F2_SECTOR_SIZE" Mode 2 Form 2 Data size: 2328 bytes. .IP M2RAW_SECTOR_SIZE 4 .IX Item "M2RAW_SECTOR_SIZE" Mod1 Form 1 Data size: 2336 bytes. .SS "Reading Modes" .IX Subsection "Reading Modes" .IP READ_MODE_AUDIO 4 .IX Item "READ_MODE_AUDIO" audio mode (CD-DA) read. Blocksize is a multiple of \&\f(CW$perlcdio::CD_FRAMESIZE_RAW\fR (2352) bytes. .IP READ_MODE_M1F1 4 .IX Item "READ_MODE_M1F1" Mode 1 Form 1 read. Blocksize is a multiple of \f(CW$perlcdio::CD_FRAMESIZE\fR (2048) bytes. .IP READ_MODE_M1F2 4 .IX Item "READ_MODE_M1F2" Mode 1 Form 2 read. Blocksize is a multiple of \f(CW$perlcdio::M2RAW_SECTIOR_SIZE\fR (2336) bytes. .IP READ_MODE_M2F1 4 .IX Item "READ_MODE_M2F1" Mode 2 Form 1 read. Blocksize is a multiple of \f(CW$perlcdio::CD_FRAMESIZE\fR (2048) bytes. .IP READ_MODE_M2F2 4 .IX Item "READ_MODE_M2F2" Mode 2 Form 1 read. Blocksize is a multiple of (2328) bytes. .SS Miscellaneous .IX Subsection "Miscellaneous" .IP VERSION_NUM 4 .IX Item "VERSION_NUM" libcdio version that is getting used .IP INVALID_LBA 4 .IX Item "INVALID_LBA" Canonical value used for an invalid LBA. .IP INVALID_LSN 4 .IX Item "INVALID_LSN" Canonical value used for an invalid LSN. .IP INVALID_TRACK 4 .IX Item "INVALID_TRACK" Canonical value used for an invalid track number. (Valid range is 0 to 99.) .IP LEADOUT_TRACK 4 .IX Item "LEADOUT_TRACK" Canonical value for the "leadout" or track just after the last track. So again this value is outside the range 0 to 99. The leadout track is often used to get the last LSN or LBA. The libcdio routines also allow the last actual track plus one as a synonym for the leadout track. .SH METHODS .IX Header "METHODS" .SS cdio_version .IX Subsection "cdio_version" .Vb 1 \& perlcdio::cdio_version .Ve .PP Returns the libcdio version string Device::Cdio is currently linked with. .SS this .IX Subsection "this" This seems to be an artifact of SWIG. .SH "SEE ALSO" .IX Header "SEE ALSO" has documentation on libcdio including the a manual and the API via doxygen. .SH AUTHORS .IX Header "AUTHORS" Rocky Bernstein \f(CW\*(C`\*(C'\fR. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2006, 2008, 2011 Rocky Bernstein .PP 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. .PP 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. .PP You should have received a copy of the GNU General Public License along with this program. If not, see .