- Got rid of newmodule.c
[python/dscho.git] / Demo / sgi / cd / CD.doc
blob67f6a028f0debefd748ffae42d77eb831f8b3387
1 Introduction.
3 A number of programs have been written which access the Silicon
4 Graphics CD-ROM player.  These programs all use the interface defined
5 in readcd.py (see readcd.doc for documentation).
7 Specifying music stretches.
9 The programs that are capable of reading music CD's all use the same
10 syntax to describe which part of the CD is to be read.  The syntax
11 closely corresponds to the available methods in readcd.py.
13 The music to be read is divided into stretches of music.  Each stretch
14 must be specified as a separate argument on the command line.  A
15 stretch can be a whole CD track, specified as a single number; or it
16 can be a start time and a end time.  The start and end times must be
17 specified as a tuple, thus: ``(starttime, endtime)''.  Don't forget to
18 quote the parenthesis to the shell.  Both starttime and endtime can be
19 ``None'', a simple number which refers to a CD track, or a tuple
20 consisting of either 3 or 4 elements.  A starttime of ``None'' refers
21 to the start of the CD, an endtime of ``None'' refers to the end of
22 the CD.  A tuple of 3 elements is an absolute time on the CD.  The
23 three elements are (minutes, seconds, frames).  A tuple of 4 elements
24 is a track-relative time.  The four elements are (track, minutes,
25 seconds, frames).
27 When one stretch ends at the end of a track and the following stretch
28 starts at the next track, there is the option of either playing or not
29 playing the pause between the two tracks.  When either the end time of
30 the first stretch or the start time of the second stretch is specified
31 using absolute or track-relative times, the pause will not be played.
32 When both times are specified as simple track numbers, the pause will
33 be played.
35 If no stretches are specified, the whole CD will be played.
37 The programs.
39 Currently, the following programs exist.
40 playcd [ stretch specification ]
41         Play (part of) a CD through the system loadspeaker or
42         headphone set.
43 cdaiff [ file [ stretch specification ] ]
44         Copy (part of) a CD to a file.  The file will be written in
45         AIFF format.  If no file is specified, cdaiff will write to
46         the file ``@'' in the current directory.