Fred Drake | 295da24 | 1998-08-10 19:42:37 +0000 | [diff] [blame] | 1 | \section{\module{cd} --- |
| 2 | Interface to the CD-ROM on Silicon Graphics systems.} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 3 | \declaremodule{builtin}{cd} |
| 4 | |
| 5 | \modulesynopsis{Interface to the CD-ROM on Silicon Graphics systems.} |
| 6 | |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 7 | |
| 8 | This module provides an interface to the Silicon Graphics CD library. |
| 9 | It is available only on Silicon Graphics systems. |
| 10 | |
| 11 | The way the library works is as follows. A program opens the CD-ROM |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 12 | device with \function{open()} and creates a parser to parse the data |
| 13 | from the CD with \function{createparser()}. The object returned by |
| 14 | \function{open()} can be used to read data from the CD, but also to get |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 15 | status information for the CD-ROM device, and to get information about |
| 16 | the CD, such as the table of contents. Data from the CD is passed to |
| 17 | the parser, which parses the frames, and calls any callback |
| 18 | functions that have previously been added. |
| 19 | |
| 20 | An audio CD is divided into \dfn{tracks} or \dfn{programs} (the terms |
| 21 | are used interchangeably). Tracks can be subdivided into |
| 22 | \dfn{indices}. An audio CD contains a \dfn{table of contents} which |
| 23 | gives the starts of the tracks on the CD. Index 0 is usually the |
| 24 | pause before the start of a track. The start of the track as given by |
| 25 | the table of contents is normally the start of index 1. |
| 26 | |
| 27 | Positions on a CD can be represented in two ways. Either a frame |
| 28 | number or a tuple of three values, minutes, seconds and frames. Most |
| 29 | functions use the latter representation. Positions can be both |
| 30 | relative to the beginning of the CD, and to the beginning of the |
| 31 | track. |
| 32 | |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 33 | Module \module{cd} defines the following functions and constants: |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 34 | |
Guido van Rossum | d45c156 | 1995-03-30 11:47:50 +0000 | [diff] [blame] | 35 | |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 36 | \begin{funcdesc}{createparser}{} |
| 37 | Create and return an opaque parser object. The methods of the parser |
| 38 | object are described below. |
| 39 | \end{funcdesc} |
| 40 | |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 41 | \begin{funcdesc}{msftoframe}{minutes, seconds, frames} |
| 42 | Converts a \code{(\var{minutes}, \var{seconds}, \var{frames})} triple |
| 43 | representing time in absolute time code into the corresponding CD |
| 44 | frame number. |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 45 | \end{funcdesc} |
| 46 | |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 47 | \begin{funcdesc}{open}{\optional{device\optional{, mode}}} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 48 | Open the CD-ROM device. The return value is an opaque player object; |
| 49 | methods of the player object are described below. The device is the |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 50 | name of the SCSI device file, e.g. \code{'/dev/scsi/sc0d4l0'}, or |
| 51 | \code{None}. If omitted or \code{None}, the hardware inventory is |
| 52 | consulted to locate a CD-ROM drive. The \var{mode}, if not omited, |
| 53 | should be the string \code{'r'}. |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 54 | \end{funcdesc} |
| 55 | |
| 56 | The module defines the following variables: |
| 57 | |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 58 | \begin{excdesc}{error} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 59 | Exception raised on various errors. |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 60 | \end{excdesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 61 | |
| 62 | \begin{datadesc}{DATASIZE} |
| 63 | The size of one frame's worth of audio data. This is the size of the |
| 64 | audio data as passed to the callback of type \code{audio}. |
| 65 | \end{datadesc} |
| 66 | |
| 67 | \begin{datadesc}{BLOCKSIZE} |
| 68 | The size of one uninterpreted frame of audio data. |
| 69 | \end{datadesc} |
| 70 | |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 71 | The following variables are states as returned by |
| 72 | \function{getstatus()}: |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 73 | |
| 74 | \begin{datadesc}{READY} |
| 75 | The drive is ready for operation loaded with an audio CD. |
| 76 | \end{datadesc} |
| 77 | |
| 78 | \begin{datadesc}{NODISC} |
| 79 | The drive does not have a CD loaded. |
| 80 | \end{datadesc} |
| 81 | |
| 82 | \begin{datadesc}{CDROM} |
| 83 | The drive is loaded with a CD-ROM. Subsequent play or read operations |
| 84 | will return I/O errors. |
| 85 | \end{datadesc} |
| 86 | |
| 87 | \begin{datadesc}{ERROR} |
| 88 | An error aoocurred while trying to read the disc or its table of |
| 89 | contents. |
| 90 | \end{datadesc} |
| 91 | |
| 92 | \begin{datadesc}{PLAYING} |
| 93 | The drive is in CD player mode playing an audio CD through its audio |
| 94 | jacks. |
| 95 | \end{datadesc} |
| 96 | |
| 97 | \begin{datadesc}{PAUSED} |
| 98 | The drive is in CD layer mode with play paused. |
| 99 | \end{datadesc} |
| 100 | |
| 101 | \begin{datadesc}{STILL} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 102 | The equivalent of \constant{PAUSED} on older (non 3301) model Toshiba |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 103 | CD-ROM drives. Such drives have never been shipped by SGI. |
| 104 | \end{datadesc} |
| 105 | |
Guido van Rossum | d45c156 | 1995-03-30 11:47:50 +0000 | [diff] [blame] | 106 | \begin{datadesc}{audio} |
| 107 | \dataline{pnum} |
| 108 | \dataline{index} |
| 109 | \dataline{ptime} |
| 110 | \dataline{atime} |
| 111 | \dataline{catalog} |
| 112 | \dataline{ident} |
| 113 | \dataline{control} |
| 114 | Integer constants describing the various types of parser callbacks |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 115 | that can be set by the \method{addcallback()} method of CD parser |
Guido van Rossum | d45c156 | 1995-03-30 11:47:50 +0000 | [diff] [blame] | 116 | objects (see below). |
| 117 | \end{datadesc} |
| 118 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 119 | |
| 120 | \subsection{Player Objects} |
| 121 | \label{player-objects} |
| 122 | |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 123 | Player objects (returned by \function{open()}) have the following |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 124 | methods: |
| 125 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 126 | \begin{methoddesc}[CD player]{allowremoval}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 127 | Unlocks the eject button on the CD-ROM drive permitting the user to |
| 128 | eject the caddy if desired. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 129 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 130 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 131 | \begin{methoddesc}[CD player]{bestreadsize}{} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 132 | Returns the best value to use for the \var{num_frames} parameter of |
| 133 | the \method{readda()} method. Best is defined as the value that |
| 134 | permits a continuous flow of data from the CD-ROM drive. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 135 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 136 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 137 | \begin{methoddesc}[CD player]{close}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 138 | Frees the resources associated with the player object. After calling |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 139 | \method{close()}, the methods of the object should no longer be used. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 140 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 141 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 142 | \begin{methoddesc}[CD player]{eject}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 143 | Ejects the caddy from the CD-ROM drive. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 144 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 145 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 146 | \begin{methoddesc}[CD player]{getstatus}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 147 | Returns information pertaining to the current state of the CD-ROM |
| 148 | drive. The returned information is a tuple with the following values: |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 149 | \var{state}, \var{track}, \var{rtime}, \var{atime}, \var{ttime}, |
| 150 | \var{first}, \var{last}, \var{scsi_audio}, \var{cur_block}. |
| 151 | \var{rtime} is the time relative to the start of the current track; |
| 152 | \var{atime} is the time relative to the beginning of the disc; |
| 153 | \var{ttime} is the total time on the disc. For more information on |
| 154 | the meaning of the values, see the man page \manpage{CDgetstatus}{3dm}. |
| 155 | The value of \var{state} is one of the following: \constant{ERROR}, |
| 156 | \constant{NODISC}, \constant{READY}, \constant{PLAYING}, |
| 157 | \constant{PAUSED}, \constant{STILL}, or \constant{CDROM}. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 158 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 159 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 160 | \begin{methoddesc}[CD player]{gettrackinfo}{track} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 161 | Returns information about the specified track. The returned |
| 162 | information is a tuple consisting of two elements, the start time of |
| 163 | the track and the duration of the track. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 164 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 165 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 166 | \begin{methoddesc}[CD player]{msftoblock}{min, sec, frame} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 167 | Converts a minutes, seconds, frames triple representing a time in |
| 168 | absolute time code into the corresponding logical block number for the |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 169 | given CD-ROM drive. You should use \function{msftoframe()} rather than |
| 170 | \method{msftoblock()} for comparing times. The logical block number |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 171 | differs from the frame number by an offset required by certain CD-ROM |
| 172 | drives. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 173 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 174 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 175 | \begin{methoddesc}[CD player]{play}{start, play} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 176 | Starts playback of an audio CD in the CD-ROM drive at the specified |
| 177 | track. The audio output appears on the CD-ROM drive's headphone and |
| 178 | audio jacks (if fitted). Play stops at the end of the disc. |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 179 | \var{start} is the number of the track at which to start playing the |
| 180 | CD; if \var{play} is 0, the CD will be set to an initial paused |
| 181 | state. The method \method{togglepause()} can then be used to commence |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 182 | play. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 183 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 184 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 185 | \begin{methoddesc}[CD player]{playabs}{minutes, seconds, frames, play} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 186 | Like \method{play()}, except that the start is given in minutes, |
| 187 | seconds, and frames instead of a track number. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 188 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 189 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 190 | \begin{methoddesc}[CD player]{playtrack}{start, play} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 191 | Like \method{play()}, except that playing stops at the end of the |
| 192 | track. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 193 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 194 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 195 | \begin{methoddesc}[CD player]{playtrackabs}{track, minutes, seconds, frames, play} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 196 | Like \method{play()}, except that playing begins at the spcified |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 197 | absolute time and ends at the end of the specified track. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 198 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 199 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 200 | \begin{methoddesc}[CD player]{preventremoval}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 201 | Locks the eject button on the CD-ROM drive thus preventing the user |
| 202 | from arbitrarily ejecting the caddy. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 203 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 204 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 205 | \begin{methoddesc}[CD player]{readda}{num_frames} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 206 | Reads the specified number of frames from an audio CD mounted in the |
| 207 | CD-ROM drive. The return value is a string representing the audio |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 208 | frames. This string can be passed unaltered to the |
| 209 | \method{parseframe()} method of the parser object. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 210 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 211 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 212 | \begin{methoddesc}[CD player]{seek}{minutes, seconds, frames} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 213 | Sets the pointer that indicates the starting point of the next read of |
| 214 | digital audio data from a CD-ROM. The pointer is set to an absolute |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 215 | time code location specified in \var{minutes}, \var{seconds}, and |
| 216 | \var{frames}. The return value is the logical block number to which |
| 217 | the pointer has been set. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 218 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 219 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 220 | \begin{methoddesc}[CD player]{seekblock}{block} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 221 | Sets the pointer that indicates the starting point of the next read of |
| 222 | digital audio data from a CD-ROM. The pointer is set to the specified |
| 223 | logical block number. The return value is the logical block number to |
| 224 | which the pointer has been set. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 225 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 226 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 227 | \begin{methoddesc}[CD player]{seektrack}{track} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 228 | Sets the pointer that indicates the starting point of the next read of |
| 229 | digital audio data from a CD-ROM. The pointer is set to the specified |
| 230 | track. The return value is the logical block number to which the |
| 231 | pointer has been set. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 232 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 233 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 234 | \begin{methoddesc}[CD player]{stop}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 235 | Stops the current playing operation. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 236 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 237 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 238 | \begin{methoddesc}[CD player]{togglepause}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 239 | Pauses the CD if it is playing, and makes it play if it is paused. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 240 | \end{methoddesc} |
| 241 | |
| 242 | |
| 243 | \subsection{Parser Objects} |
| 244 | \label{cd-parser-objects} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 245 | |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 246 | Parser objects (returned by \function{createparser()}) have the |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 247 | following methods: |
| 248 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 249 | \begin{methoddesc}[CD parser]{addcallback}{type, func, arg} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 250 | Adds a callback for the parser. The parser has callbacks for eight |
Guido van Rossum | d45c156 | 1995-03-30 11:47:50 +0000 | [diff] [blame] | 251 | different types of data in the digital audio data stream. Constants |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 252 | for these types are defined at the \module{cd} module level (see above). |
| 253 | The callback is called as follows: \code{\var{func}(\var{arg}, type, |
| 254 | data)}, where \var{arg} is the user supplied argument, \var{type} is |
| 255 | the particular type of callback, and \var{data} is the data returned |
| 256 | for this \var{type} of callback. The type of the data depends on the |
| 257 | \var{type} of callback as follows: |
| 258 | |
Fred Drake | ee60191 | 1998-04-11 20:53:03 +0000 | [diff] [blame] | 259 | \begin{tableii}{l|p{4in}}{code}{Type}{Value} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 260 | \lineii{audio}{String which can be passed unmodified to |
| 261 | \function{al.writesamps()}.} |
| 262 | \lineii{pnum}{Integer giving the program (track) number.} |
| 263 | \lineii{index}{Integer giving the index number.} |
| 264 | \lineii{ptime}{Tuple consisting of the program time in minutes, |
| 265 | seconds, and frames.} |
| 266 | \lineii{atime}{Tuple consisting of the absolute time in minutes, |
| 267 | seconds, and frames.} |
| 268 | \lineii{catalog}{String of 13 characters, giving the catalog number |
| 269 | of the CD.} |
| 270 | \lineii{ident}{String of 12 characters, giving the ISRC |
Fred Drake | 0d213d3 | 1998-04-11 16:40:46 +0000 | [diff] [blame] | 271 | identification number of the recording. The string consists of two |
| 272 | characters country code, three characters owner code, two characters |
| 273 | giving the year, and five characters giving a serial number.} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 274 | \lineii{control}{Integer giving the control bits from the CD |
| 275 | subcode data} |
| 276 | \end{tableii} |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 277 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 278 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 279 | \begin{methoddesc}[CD parser]{deleteparser}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 280 | Deletes the parser and frees the memory it was using. The object |
| 281 | should not be used after this call. This call is done automatically |
| 282 | when the last reference to the object is removed. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 283 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 284 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 285 | \begin{methoddesc}[CD parser]{parseframe}{frame} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 286 | Parses one or more frames of digital audio data from a CD such as |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 287 | returned by \method{readda()}. It determines which subcodes are |
| 288 | present in the data. If these subcodes have changed since the last |
| 289 | frame, then \method{parseframe()} executes a callback of the |
| 290 | appropriate type passing to it the subcode data found in the frame. |
| 291 | Unlike the \C{} function, more than one frame of digital audio data |
| 292 | can be passed to this method. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 293 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 294 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 295 | \begin{methoddesc}[CD parser]{removecallback}{type} |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 296 | Removes the callback for the given \var{type}. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 297 | \end{methoddesc} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 298 | |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 299 | \begin{methoddesc}[CD parser]{resetparser}{} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 300 | Resets the fields of the parser used for tracking subcodes to an |
Fred Drake | d98329c | 1998-03-16 06:38:42 +0000 | [diff] [blame] | 301 | initial state. \method{resetparser()} should be called after the disc |
| 302 | has been changed. |
Fred Drake | fc57619 | 1998-04-04 07:15:02 +0000 | [diff] [blame] | 303 | \end{methoddesc} |