FM / library

/usr/share/doc/python2-docs/html/_sources/library/

/usr/share/doc/python2-docs/html/_sources/library

Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	edit dl rm
abc.rst.txt	7219	0644	edit dl rm
aepack.rst.txt	4257	0644	edit dl rm
aetools.rst.txt	3532	0644	edit dl rm
aetypes.rst.txt	4257	0644	edit dl rm
aifc.rst.txt	7086	0644	edit dl rm
al.rst.txt	5309	0644	edit dl rm
allos.rst.txt	695	0644	edit dl rm
anydbm.rst.txt	4111	0644	edit dl rm
archiving.rst.txt	424	0644	edit dl rm
argparse.rst.txt	74685	0644	edit dl rm
array.rst.txt	10524	0644	edit dl rm
ast.rst.txt	10111	0644	edit dl rm
asynchat.rst.txt	9206	0644	edit dl rm
asyncore.rst.txt	12937	0644	edit dl rm
atexit.rst.txt	3910	0644	edit dl rm
audioop.rst.txt	10395	0644	edit dl rm
autogil.rst.txt	1015	0644	edit dl rm
base64.rst.txt	6252	0644	edit dl rm
basehttpserver.rst.txt	10404	0644	edit dl rm
bastion.rst.txt	2611	0644	edit dl rm
bdb.rst.txt	12456	0644	edit dl rm
binascii.rst.txt	6508	0644	edit dl rm
binhex.rst.txt	1910	0644	edit dl rm
bisect.rst.txt	5415	0644	edit dl rm
bsddb.rst.txt	7575	0644	edit dl rm
bz2.rst.txt	8064	0644	edit dl rm
calendar.rst.txt	11282	0644	edit dl rm
carbon.rst.txt	15956	0644	edit dl rm
cd.rst.txt	11974	0644	edit dl rm
cgi.rst.txt	22853	0644	edit dl rm
cgihttpserver.rst.txt	2788	0644	edit dl rm
cgitb.rst.txt	2874	0644	edit dl rm
chunk.rst.txt	4955	0644	edit dl rm
cmath.rst.txt	7647	0644	edit dl rm
cmd.rst.txt	8565	0644	edit dl rm
code.rst.txt	7115	0644	edit dl rm
codecs.rst.txt	66966	0644	edit dl rm
codeop.rst.txt	3774	0644	edit dl rm
collections.rst.txt	41448	0644	edit dl rm
colorpicker.rst.txt	913	0644	edit dl rm
colorsys.rst.txt	1819	0644	edit dl rm
commands.rst.txt	2595	0644	edit dl rm
compileall.rst.txt	4678	0644	edit dl rm
compiler.rst.txt	37464	0644	edit dl rm
configparser.rst.txt	19607	0644	edit dl rm
constants.rst.txt	2328	0644	edit dl rm
contextlib.rst.txt	6012	0644	edit dl rm
cookie.rst.txt	9543	0644	edit dl rm
cookielib.rst.txt	27875	0644	edit dl rm
copy.rst.txt	3351	0644	edit dl rm
copy_reg.rst.txt	2329	0644	edit dl rm
crypt.rst.txt	2292	0644	edit dl rm
crypto.rst.txt	355	0644	edit dl rm
csv.rst.txt	22757	0644	edit dl rm
ctypes.rst.txt	90513	0644	edit dl rm
curses.ascii.rst.txt	9046	0644	edit dl rm
curses.panel.rst.txt	2740	0644	edit dl rm
curses.rst.txt	74877	0644	edit dl rm
custominterp.rst.txt	570	0644	edit dl rm
datatypes.rst.txt	864	0644	edit dl rm
datetime.rst.txt	74679	0644	edit dl rm
dbhash.rst.txt	3865	0644	edit dl rm
dbm.rst.txt	3117	0644	edit dl rm
debug.rst.txt	446	0644	edit dl rm
decimal.rst.txt	70926	0644	edit dl rm
development.rst.txt	640	0644	edit dl rm
difflib.rst.txt	30716	0644	edit dl rm
dircache.rst.txt	1813	0644	edit dl rm
dis.rst.txt	23248	0644	edit dl rm
distribution.rst.txt	426	0644	edit dl rm
distutils.rst.txt	1958	0644	edit dl rm
dl.rst.txt	3392	0644	edit dl rm
doctest.rst.txt	73985	0644	edit dl rm
docxmlrpcserver.rst.txt	3802	0644	edit dl rm
dumbdbm.rst.txt	2841	0644	edit dl rm
dummy_thread.rst.txt	1058	0644	edit dl rm
dummy_threading.rst.txt	799	0644	edit dl rm
easydialogs.rst.txt	10346	0644	edit dl rm
email-examples.rst.txt	1271	0644	edit dl rm
email.charset.rst.txt	9654	0644	edit dl rm
email.encoders.rst.txt	2376	0644	edit dl rm
email.errors.rst.txt	4006	0644	edit dl rm
email.generator.rst.txt	6132	0644	edit dl rm
email.header.rst.txt	7531	0644	edit dl rm
email.iterators.rst.txt	2421	0644	edit dl rm
email.message.rst.txt	25217	0644	edit dl rm
email.mime.rst.txt	9917	0644	edit dl rm
email.parser.rst.txt	10327	0644	edit dl rm
email.rst.txt	16111	0644	edit dl rm
email.utils.rst.txt	6475	0644	edit dl rm
ensurepip.rst.txt	5022	0644	edit dl rm
errno.rst.txt	6708	0644	edit dl rm
exceptions.rst.txt	18343	0644	edit dl rm
fcntl.rst.txt	7361	0644	edit dl rm
filecmp.rst.txt	5348	0644	edit dl rm
fileformats.rst.txt	302	0644	edit dl rm
fileinput.rst.txt	7417	0644	edit dl rm
filesys.rst.txt	806	0644	edit dl rm
fl.rst.txt	17646	0644	edit dl rm
fm.rst.txt	2699	0644	edit dl rm
fnmatch.rst.txt	3104	0644	edit dl rm
formatter.rst.txt	13245	0644	edit dl rm
fpectl.rst.txt	4171	0644	edit dl rm
fpformat.rst.txt	1747	0644	edit dl rm
fractions.rst.txt	5297	0644	edit dl rm
framework.rst.txt	11444	0644	edit dl rm
frameworks.rst.txt	378	0644	edit dl rm
ftplib.rst.txt	15720	0644	edit dl rm
functions.rst.txt	75554	0644	edit dl rm
functools.rst.txt	7448	0644	edit dl rm
future_builtins.rst.txt	2010	0644	edit dl rm
gc.rst.txt	9014	0644	edit dl rm
gdbm.rst.txt	4882	0644	edit dl rm
gensuitemodule.rst.txt	3113	0644	edit dl rm
getopt.rst.txt	6670	0644	edit dl rm
getpass.rst.txt	1876	0644	edit dl rm
gettext.rst.txt	29040	0644	edit dl rm
gl.rst.txt	6009	0644	edit dl rm
glob.rst.txt	2414	0644	edit dl rm
grp.rst.txt	2256	0644	edit dl rm
gzip.rst.txt	4828	0644	edit dl rm
hashlib.rst.txt	7379	0644	edit dl rm
heapq.rst.txt	13185	0644	edit dl rm
hmac.rst.txt	3073	0644	edit dl rm
hotshot.rst.txt	4289	0644	edit dl rm
htmllib.rst.txt	7379	0644	edit dl rm
htmlparser.rst.txt	11640	0644	edit dl rm
httplib.rst.txt	37454	0644	edit dl rm
i18n.rst.txt	409	0644	edit dl rm
ic.rst.txt	5005	0644	edit dl rm
idle.rst.txt	22182	0644	edit dl rm
imageop.rst.txt	4001	0644	edit dl rm
imaplib.rst.txt	17221	0644	edit dl rm
imgfile.rst.txt	2765	0644	edit dl rm
imghdr.rst.txt	2635	0644	edit dl rm
imp.rst.txt	12593	0644	edit dl rm
importlib.rst.txt	1126	0644	edit dl rm
imputil.rst.txt	7023	0644	edit dl rm
index.rst.txt	2287	0644	edit dl rm
inspect.rst.txt	28151	0644	edit dl rm
internet.rst.txt	950	0644	edit dl rm
intro.rst.txt	2803	0644	edit dl rm
io.rst.txt	39015	0644	edit dl rm
ipc.rst.txt	630	0644	edit dl rm
itertools.rst.txt	36324	0644	edit dl rm
jpeg.rst.txt	3858	0644	edit dl rm
json.rst.txt	25545	0644	edit dl rm
keyword.rst.txt	617	0644	edit dl rm
language.rst.txt	523	0644	edit dl rm
linecache.rst.txt	1887	0644	edit dl rm
locale.rst.txt	24975	0644	edit dl rm
logging.config.rst.txt	31560	0644	edit dl rm
logging.handlers.rst.txt	28153	0644	edit dl rm
logging.rst.txt	46882	0644	edit dl rm
mac.rst.txt	791	0644	edit dl rm
macos.rst.txt	3824	0644	edit dl rm
macosa.rst.txt	3964	0644	edit dl rm
macostools.rst.txt	4017	0644	edit dl rm
macpath.rst.txt	650	0644	edit dl rm
mailbox.rst.txt	68129	0644	edit dl rm
mailcap.rst.txt	3675	0644	edit dl rm
markup.rst.txt	1249	0644	edit dl rm
marshal.rst.txt	5689	0644	edit dl rm
math.rst.txt	10920	0644	edit dl rm
md5.rst.txt	2815	0644	edit dl rm
mhlib.rst.txt	3966	0644	edit dl rm
mimetools.rst.txt	4504	0644	edit dl rm
mimetypes.rst.txt	9839	0644	edit dl rm
mimewriter.rst.txt	3360	0644	edit dl rm
mimify.rst.txt	3519	0644	edit dl rm
miniaeframe.rst.txt	2564	0644	edit dl rm
misc.rst.txt	248	0644	edit dl rm
mm.rst.txt	447	0644	edit dl rm
mmap.rst.txt	10481	0644	edit dl rm
modulefinder.rst.txt	3380	0644	edit dl rm
modules.rst.txt	382	0644	edit dl rm
msilib.rst.txt	19062	0644	edit dl rm
msvcrt.rst.txt	4346	0644	edit dl rm
multifile.rst.txt	6613	0644	edit dl rm
multiprocessing.rst.txt	92621	0644	edit dl rm
mutex.rst.txt	1939	0644	edit dl rm
netdata.rst.txt	432	0644	edit dl rm
netrc.rst.txt	3119	0644	edit dl rm
new.rst.txt	2653	0644	edit dl rm
nis.rst.txt	2108	0644	edit dl rm
nntplib.rst.txt	14531	0644	edit dl rm
numbers.rst.txt	8007	0644	edit dl rm
numeric.rst.txt	751	0644	edit dl rm
operator.rst.txt	22092	0644	edit dl rm
optparse.rst.txt	77101	0644	edit dl rm
os.path.rst.txt	13094	0644	edit dl rm
os.rst.txt	82580	0644	edit dl rm
ossaudiodev.rst.txt	17309	0644	edit dl rm
othergui.rst.txt	2721	0644	edit dl rm
parser.rst.txt	15385	0644	edit dl rm
pdb.rst.txt	16043	0644	edit dl rm
persistence.rst.txt	826	0644	edit dl rm
pickle.rst.txt	37262	0644	edit dl rm
pickletools.rst.txt	1997	0644	edit dl rm
pipes.rst.txt	3786	0644	edit dl rm
pkgutil.rst.txt	7714	0644	edit dl rm
platform.rst.txt	9554	0644	edit dl rm
plistlib.rst.txt	4134	0644	edit dl rm
popen2.rst.txt	7022	0644	edit dl rm
poplib.rst.txt	6220	0644	edit dl rm
posix.rst.txt	3630	0644	edit dl rm
posixfile.rst.txt	7200	0644	edit dl rm
pprint.rst.txt	9071	0644	edit dl rm
profile.rst.txt	28666	0644	edit dl rm
pty.rst.txt	1762	0644	edit dl rm
pwd.rst.txt	2725	0644	edit dl rm
pyclbr.rst.txt	3296	0644	edit dl rm
pydoc.rst.txt	4083	0644	edit dl rm
pyexpat.rst.txt	28891	0644	edit dl rm
python.rst.txt	514	0644	edit dl rm
py_compile.rst.txt	2479	0644	edit dl rm
queue.rst.txt	7034	0644	edit dl rm
quopri.rst.txt	2670	0644	edit dl rm
random.rst.txt	13319	0644	edit dl rm
re.rst.txt	55102	0644	edit dl rm
readline.rst.txt	10513	0644	edit dl rm
repr.rst.txt	4718	0644	edit dl rm
resource.rst.txt	9595	0644	edit dl rm
restricted.rst.txt	3327	0644	edit dl rm
rexec.rst.txt	11742	0644	edit dl rm
rfc822.rst.txt	14037	0644	edit dl rm
rlcompleter.rst.txt	2494	0644	edit dl rm
robotparser.rst.txt	2190	0644	edit dl rm
runpy.rst.txt	6938	0644	edit dl rm
sched.rst.txt	4644	0644	edit dl rm
scrolledtext.rst.txt	1379	0644	edit dl rm
select.rst.txt	20705	0644	edit dl rm
sets.rst.txt	14973	0644	edit dl rm
sgi.rst.txt	322	0644	edit dl rm
sgmllib.rst.txt	10664	0644	edit dl rm
sha.rst.txt	2807	0644	edit dl rm
shelve.rst.txt	8319	0644	edit dl rm
shlex.rst.txt	11313	0644	edit dl rm
shutil.rst.txt	13491	0644	edit dl rm
signal.rst.txt	10719	0644	edit dl rm
simplehttpserver.rst.txt	4559	0644	edit dl rm
simplexmlrpcserver.rst.txt	10881	0644	edit dl rm
site.rst.txt	7880	0644	edit dl rm
smtpd.rst.txt	2464	0644	edit dl rm
smtplib.rst.txt	14906	0644	edit dl rm
sndhdr.rst.txt	1759	0644	edit dl rm
socket.rst.txt	40765	0644	edit dl rm
socketserver.rst.txt	22512	0644	edit dl rm
someos.rst.txt	599	0644	edit dl rm
spwd.rst.txt	2825	0644	edit dl rm
sqlite3.rst.txt	35448	0644	edit dl rm
ssl.rst.txt	76554	0644	edit dl rm
stat.rst.txt	7778	0644	edit dl rm
statvfs.rst.txt	1300	0644	edit dl rm
stdtypes.rst.txt	122668	0644	edit dl rm
string.rst.txt	44085	0644	edit dl rm
stringio.rst.txt	4166	0644	edit dl rm
stringprep.rst.txt	4238	0644	edit dl rm
strings.rst.txt	746	0644	edit dl rm
struct.rst.txt	17100	0644	edit dl rm
subprocess.rst.txt	33648	0644	edit dl rm
sun.rst.txt	249	0644	edit dl rm
sunau.rst.txt	7124	0644	edit dl rm
sunaudio.rst.txt	5849	0644	edit dl rm
symbol.rst.txt	975	0644	edit dl rm
symtable.rst.txt	5064	0644	edit dl rm
sys.rst.txt	47520	0644	edit dl rm
sysconfig.rst.txt	7639	0644	edit dl rm
syslog.rst.txt	3931	0644	edit dl rm
tabnanny.rst.txt	1999	0644	edit dl rm
tarfile.rst.txt	28214	0644	edit dl rm
telnetlib.rst.txt	7482	0644	edit dl rm
tempfile.rst.txt	10504	0644	edit dl rm
termios.rst.txt	3733	0644	edit dl rm
test.rst.txt	17659	0644	edit dl rm
textwrap.rst.txt	8552	0644	edit dl rm
thread.rst.txt	6588	0644	edit dl rm
threading.rst.txt	32468	0644	edit dl rm
time.rst.txt	26020	0644	edit dl rm
timeit.rst.txt	11598	0644	edit dl rm
tix.rst.txt	22693	0644	edit dl rm
tk.rst.txt	1612	0644	edit dl rm
tkinter.rst.txt	33456	0644	edit dl rm
token.rst.txt	2451	0644	edit dl rm
tokenize.rst.txt	5570	0644	edit dl rm
trace.rst.txt	6724	0644	edit dl rm
traceback.rst.txt	10711	0644	edit dl rm
ttk.rst.txt	57411	0644	edit dl rm
tty.rst.txt	1011	0644	edit dl rm
turtle.rst.txt	64097	0644	edit dl rm
types.rst.txt	6200	0644	edit dl rm
undoc.rst.txt	6550	0644	edit dl rm
unicodedata.rst.txt	5736	0644	edit dl rm
unittest.rst.txt	82952	0644	edit dl rm
unix.rst.txt	490	0644	edit dl rm
urllib.rst.txt	24960	0644	edit dl rm
urllib2.rst.txt	35211	0644	edit dl rm
urlparse.rst.txt	16071	0644	edit dl rm
user.rst.txt	2748	0644	edit dl rm
userdict.rst.txt	9290	0644	edit dl rm
uu.rst.txt	2369	0644	edit dl rm
uuid.rst.txt	8378	0644	edit dl rm
warnings.rst.txt	19815	0644	edit dl rm
wave.rst.txt	5047	0644	edit dl rm
weakref.rst.txt	12926	0644	edit dl rm
webbrowser.rst.txt	9863	0644	edit dl rm
whichdb.rst.txt	931	0644	edit dl rm
windows.rst.txt	273	0644	edit dl rm
winsound.rst.txt	5066	0644	edit dl rm
wsgiref.rst.txt	30567	0644	edit dl rm
xdrlib.rst.txt	8077	0644	edit dl rm
xml.dom.minidom.rst.txt	11208	0644	edit dl rm
xml.dom.pulldom.rst.txt	1571	0644	edit dl rm
xml.dom.rst.txt	40182	0644	edit dl rm
xml.etree.elementtree.rst.txt	35707	0644	edit dl rm
xml.rst.txt	6090	0644	edit dl rm
xml.sax.handler.rst.txt	15371	0644	edit dl rm
xml.sax.reader.rst.txt	12257	0644	edit dl rm
xml.sax.rst.txt	6460	0644	edit dl rm
xml.sax.utils.rst.txt	3560	0644	edit dl rm
xmlrpclib.rst.txt	22559	0644	edit dl rm
zipfile.rst.txt	18871	0644	edit dl rm
zipimport.rst.txt	5957	0644	edit dl rm
zlib.rst.txt	12766	0644	edit dl rm
_winreg.rst.txt	23305	0644	edit dl rm
__builtin__.rst.txt	1494	0644	edit dl rm
__future__.rst.txt	4952	0644	edit dl rm
__main__.rst.txt	535	0644	edit dl rm

Edit: /usr/share/doc/python2-docs/html/_sources/library/cd.rst.txt (11974B)

:mod:`cd` --- CD-ROM access on SGI systems
==========================================

.. module:: cd
   :platform: IRIX
   :synopsis: Interface to the CD-ROM on Silicon Graphics systems.
   :deprecated:

.. deprecated:: 2.6
    The :mod:`cd` module has been removed in Python 3.

This module provides an interface to the Silicon Graphics CD library. It is
available only on Silicon Graphics systems.

The way the library works is as follows.  A program opens the CD-ROM device with
:func:`.open` and creates a parser to parse the data from the CD with
:func:`createparser`.  The object returned by :func:`.open` can be used to read
data from the CD, but also to get status information for the CD-ROM device, and
to get information about the CD, such as the table of contents.  Data from the
CD is passed to the parser, which parses the frames, and calls any callback
functions that have previously been added.

An audio CD is divided into :dfn:`tracks` or :dfn:`programs` (the terms are used
interchangeably).  Tracks can be subdivided into :dfn:`indices`.  An audio CD
contains a :dfn:`table of contents` which gives the starts of the tracks on the
CD.  Index 0 is usually the pause before the start of a track.  The start of the
track as given by the table of contents is normally the start of index 1.

Positions on a CD can be represented in two ways.  Either a frame number or a
tuple of three values, minutes, seconds and frames.  Most functions use the
latter representation.  Positions can be both relative to the beginning of the
CD, and to the beginning of the track.

Module :mod:`cd` defines the following functions and constants:

.. function:: createparser()

Create and return an opaque parser object.  The methods of the parser object are
   described below.

.. function:: msftoframe(minutes, seconds, frames)

Converts a ``(minutes, seconds, frames)`` triple representing time in absolute
   time code into the corresponding CD frame number.

.. function:: open([device[, mode]])

Open the CD-ROM device.  The return value is an opaque player object; methods of
   the player object are described below.  The device is the name of the SCSI
   device file, e.g. ``'/dev/scsi/sc0d4l0'``, or ``None``.  If omitted or ``None``,
   the hardware inventory is consulted to locate a CD-ROM drive.  The *mode*, if
   not omitted, should be the string ``'r'``.

The module defines the following variables:

.. exception:: error

Exception raised on various errors.

.. data:: DATASIZE

The size of one frame's worth of audio data.  This is the size of the audio data
   as passed to the callback of type ``audio``.

.. data:: BLOCKSIZE

The size of one uninterpreted frame of audio data.

The following variables are states as returned by :func:`getstatus`:

.. data:: READY

The drive is ready for operation loaded with an audio CD.

.. data:: NODISC

The drive does not have a CD loaded.

.. data:: CDROM

The drive is loaded with a CD-ROM.  Subsequent play or read operations will
   return I/O errors.

.. data:: ERROR

An error occurred while trying to read the disc or its table of contents.

.. data:: PLAYING

The drive is in CD player mode playing an audio CD through its audio jacks.

.. data:: PAUSED

The drive is in CD layer mode with play paused.

.. data:: STILL

The equivalent of :const:`PAUSED` on older (non 3301) model Toshiba CD-ROM
   drives.  Such drives have never been shipped by SGI.

.. data:: audio
          pnum
          index
          ptime
          atime
          catalog
          ident
          control

Integer constants describing the various types of parser callbacks that can be
   set by the :meth:`addcallback` method of CD parser objects (see below).

.. _player-objects:

Player Objects
--------------

Player objects (returned by :func:`.open`) have the following methods:

.. method:: CD player.allowremoval()

Unlocks the eject button on the CD-ROM drive permitting the user to eject the
   caddy if desired.

.. method:: CD player.bestreadsize()

Returns the best value to use for the *num_frames* parameter of the
   :meth:`readda` method.  Best is defined as the value that permits a continuous
   flow of data from the CD-ROM drive.

.. method:: CD player.close()

Frees the resources associated with the player object.  After calling
   :meth:`close`, the methods of the object should no longer be used.

.. method:: CD player.eject()

Ejects the caddy from the CD-ROM drive.

.. method:: CD player.getstatus()

Returns information pertaining to the current state of the CD-ROM drive.  The
   returned information is a tuple with the following values: *state*, *track*,
   *rtime*, *atime*, *ttime*, *first*, *last*, *scsi_audio*, *cur_block*. *rtime*
   is the time relative to the start of the current track; *atime* is the time
   relative to the beginning of the disc; *ttime* is the total time on the disc.
   For more information on the meaning of the values, see the man page
   :manpage:`CDgetstatus(3dm)`. The value of *state* is one of the following:
   :const:`ERROR`, :const:`NODISC`, :const:`READY`, :const:`PLAYING`,
   :const:`PAUSED`, :const:`STILL`, or :const:`CDROM`.

.. method:: CD player.gettrackinfo(track)

Returns information about the specified track.  The returned information is a
   tuple consisting of two elements, the start time of the track and the duration
   of the track.

.. method:: CD player.msftoblock(min, sec, frame)

Converts a minutes, seconds, frames triple representing a time in absolute time
   code into the corresponding logical block number for the given CD-ROM drive.
   You should use :func:`msftoframe` rather than :meth:`msftoblock` for comparing
   times.  The logical block number differs from the frame number by an offset
   required by certain CD-ROM drives.

.. method:: CD player.play(start, play)

Starts playback of an audio CD in the CD-ROM drive at the specified track.  The
   audio output appears on the CD-ROM drive's headphone and audio jacks (if
   fitted).  Play stops at the end of the disc. *start* is the number of the track
   at which to start playing the CD; if *play* is 0, the CD will be set to an
   initial paused state.  The method :meth:`togglepause` can then be used to
   commence play.

.. method:: CD player.playabs(minutes, seconds, frames, play)

Like :meth:`play`, except that the start is given in minutes, seconds, and
   frames instead of a track number.

.. method:: CD player.playtrack(start, play)

Like :meth:`play`, except that playing stops at the end of the track.

.. method:: CD player.playtrackabs(track, minutes, seconds, frames, play)

Like :meth:`play`, except that playing begins at the specified absolute time and
   ends at the end of the specified track.

.. method:: CD player.preventremoval()

Locks the eject button on the CD-ROM drive thus preventing the user from
   arbitrarily ejecting the caddy.

.. method:: CD player.readda(num_frames)

Reads the specified number of frames from an audio CD mounted in the CD-ROM
   drive.  The return value is a string representing the audio frames.  This string
   can be passed unaltered to the :meth:`parseframe` method of the parser object.

.. method:: CD player.seek(minutes, seconds, frames)

Sets the pointer that indicates the starting point of the next read of digital
   audio data from a CD-ROM.  The pointer is set to an absolute time code location
   specified in *minutes*, *seconds*, and *frames*.  The return value is the
   logical block number to which the pointer has been set.

.. method:: CD player.seekblock(block)

Sets the pointer that indicates the starting point of the next read of digital
   audio data from a CD-ROM.  The pointer is set to the specified logical block
   number.  The return value is the logical block number to which the pointer has
   been set.

.. method:: CD player.seektrack(track)

Sets the pointer that indicates the starting point of the next read of digital
   audio data from a CD-ROM.  The pointer is set to the specified track.  The
   return value is the logical block number to which the pointer has been set.

.. method:: CD player.stop()

Stops the current playing operation.

.. method:: CD player.togglepause()

Pauses the CD if it is playing, and makes it play if it is paused.

.. _cd-parser-objects:

Parser Objects
--------------

Parser objects (returned by :func:`createparser`) have the following methods:

.. method:: CD parser.addcallback(type, func, arg)

Adds a callback for the parser.  The parser has callbacks for eight different
   types of data in the digital audio data stream.  Constants for these types are
   defined at the :mod:`cd` module level (see above). The callback is called as
   follows: ``func(arg, type, data)``, where *arg* is the user supplied argument,
   *type* is the particular type of callback, and *data* is the data returned for
   this *type* of callback.  The type of the data depends on the *type* of callback
   as follows:

.. method:: CD parser.deleteparser()

Deletes the parser and frees the memory it was using.  The object should not be
   used after this call.  This call is done automatically when the last reference
   to the object is removed.

.. method:: CD parser.parseframe(frame)

Parses one or more frames of digital audio data from a CD such as returned by
   :meth:`readda`.  It determines which subcodes are present in the data.  If these
   subcodes have changed since the last frame, then :meth:`parseframe` executes a
   callback of the appropriate type passing to it the subcode data found in the
   frame. Unlike the C function, more than one frame of digital audio data can be
   passed to this method.

.. method:: CD parser.removecallback(type)

Removes the callback for the given *type*.

.. method:: CD parser.resetparser()

Resets the fields of the parser used for tracking subcodes to an initial state.
   :meth:`resetparser` should be called after the disc has been changed.

:mod:`cd` --- CD-ROM access on SGI systems ========================================== .. module:: cd :platform: IRIX :synopsis: Interface to the CD-ROM on Silicon Graphics systems. :deprecated: .. deprecated:: 2.6 The :mod:`cd` module has been removed in Python 3. This module provides an interface to the Silicon Graphics CD library. It is available only on Silicon Graphics systems. The way the library works is as follows. A program opens the CD-ROM device with :func:`.open` and creates a parser to parse the data from the CD with :func:`createparser`. The object returned by :func:`.open` can be used to read data from the CD, but also to get status information for the CD-ROM device, and to get information about the CD, such as the table of contents. Data from the CD is passed to the parser, which parses the frames, and calls any callback functions that have previously been added. An audio CD is divided into :dfn:`tracks` or :dfn:`programs` (the terms are used interchangeably). Tracks can be subdivided into :dfn:`indices`. An audio CD contains a :dfn:`table of contents` which gives the starts of the tracks on the CD. Index 0 is usually the pause before the start of a track. The start of the track as given by the table of contents is normally the start of index 1. Positions on a CD can be represented in two ways. Either a frame number or a tuple of three values, minutes, seconds and frames. Most functions use the latter representation. Positions can be both relative to the beginning of the CD, and to the beginning of the track. Module :mod:`cd` defines the following functions and constants: .. function:: createparser() Create and return an opaque parser object. The methods of the parser object are described below. .. function:: msftoframe(minutes, seconds, frames) Converts a ``(minutes, seconds, frames)`` triple representing time in absolute time code into the corresponding CD frame number. .. function:: open([device[, mode]]) Open the CD-ROM device. The return value is an opaque player object; methods of the player object are described below. The device is the name of the SCSI device file, e.g. ``'/dev/scsi/sc0d4l0'``, or ``None``. If omitted or ``None``, the hardware inventory is consulted to locate a CD-ROM drive. The *mode*, if not omitted, should be the string ``'r'``. The module defines the following variables: .. exception:: error Exception raised on various errors. .. data:: DATASIZE The size of one frame's worth of audio data. This is the size of the audio data as passed to the callback of type ``audio``. .. data:: BLOCKSIZE The size of one uninterpreted frame of audio data. The following variables are states as returned by :func:`getstatus`: .. data:: READY The drive is ready for operation loaded with an audio CD. .. data:: NODISC The drive does not have a CD loaded. .. data:: CDROM The drive is loaded with a CD-ROM. Subsequent play or read operations will return I/O errors. .. data:: ERROR An error occurred while trying to read the disc or its table of contents. .. data:: PLAYING The drive is in CD player mode playing an audio CD through its audio jacks. .. data:: PAUSED The drive is in CD layer mode with play paused. .. data:: STILL The equivalent of :const:`PAUSED` on older (non 3301) model Toshiba CD-ROM drives. Such drives have never been shipped by SGI. .. data:: audio pnum index ptime atime catalog ident control Integer constants describing the various types of parser callbacks that can be set by the :meth:`addcallback` method of CD parser objects (see below). .. _player-objects: Player Objects -------------- Player objects (returned by :func:`.open`) have the following methods: .. method:: CD player.allowremoval() Unlocks the eject button on the CD-ROM drive permitting the user to eject the caddy if desired. .. method:: CD player.bestreadsize() Returns the best value to use for the *num_frames* parameter of the :meth:`readda` method. Best is defined as the value that permits a continuous flow of data from the CD-ROM drive. .. method:: CD player.close() Frees the resources associated with the player object. After calling :meth:`close`, the methods of the object should no longer be used. .. method:: CD player.eject() Ejects the caddy from the CD-ROM drive. .. method:: CD player.getstatus() Returns information pertaining to the current state of the CD-ROM drive. The returned information is a tuple with the following values: *state*, *track*, *rtime*, *atime*, *ttime*, *first*, *last*, *scsi_audio*, *cur_block*. *rtime* is the time relative to the start of the current track; *atime* is the time relative to the beginning of the disc; *ttime* is the total time on the disc. For more information on the meaning of the values, see the man page :manpage:`CDgetstatus(3dm)`. The value of *state* is one of the following: :const:`ERROR`, :const:`NODISC`, :const:`READY`, :const:`PLAYING`, :const:`PAUSED`, :const:`STILL`, or :const:`CDROM`. .. method:: CD player.gettrackinfo(track) Returns information about the specified track. The returned information is a tuple consisting of two elements, the start time of the track and the duration of the track. .. method:: CD player.msftoblock(min, sec, frame) Converts a minutes, seconds, frames triple representing a time in absolute time code into the corresponding logical block number for the given CD-ROM drive. You should use :func:`msftoframe` rather than :meth:`msftoblock` for comparing times. The logical block number differs from the frame number by an offset required by certain CD-ROM drives. .. method:: CD player.play(start, play) Starts playback of an audio CD in the CD-ROM drive at the specified track. The audio output appears on the CD-ROM drive's headphone and audio jacks (if fitted). Play stops at the end of the disc. *start* is the number of the track at which to start playing the CD; if *play* is 0, the CD will be set to an initial paused state. The method :meth:`togglepause` can then be used to commence play. .. method:: CD player.playabs(minutes, seconds, frames, play) Like :meth:`play`, except that the start is given in minutes, seconds, and frames instead of a track number. .. method:: CD player.playtrack(start, play) Like :meth:`play`, except that playing stops at the end of the track. .. method:: CD player.playtrackabs(track, minutes, seconds, frames, play) Like :meth:`play`, except that playing begins at the specified absolute time and ends at the end of the specified track. .. method:: CD player.preventremoval() Locks the eject button on the CD-ROM drive thus preventing the user from arbitrarily ejecting the caddy. .. method:: CD player.readda(num_frames) Reads the specified number of frames from an audio CD mounted in the CD-ROM drive. The return value is a string representing the audio frames. This string can be passed unaltered to the :meth:`parseframe` method of the parser object. .. method:: CD player.seek(minutes, seconds, frames) Sets the pointer that indicates the starting point of the next read of digital audio data from a CD-ROM. The pointer is set to an absolute time code location specified in *minutes*, *seconds*, and *frames*. The return value is the logical block number to which the pointer has been set. .. method:: CD player.seekblock(block) Sets the pointer that indicates the starting point of the next read of digital audio data from a CD-ROM. The pointer is set to the specified logical block number. The return value is the logical block number to which the pointer has been set. .. method:: CD player.seektrack(track) Sets the pointer that indicates the starting point of the next read of digital audio data from a CD-ROM. The pointer is set to the specified track. The return value is the logical block number to which the pointer has been set. .. method:: CD player.stop() Stops the current playing operation. .. method:: CD player.togglepause() Pauses the CD if it is playing, and makes it play if it is paused. .. _cd-parser-objects: Parser Objects -------------- Parser objects (returned by :func:`createparser`) have the following methods: .. method:: CD parser.addcallback(type, func, arg) Adds a callback for the parser. The parser has callbacks for eight different types of data in the digital audio data stream. Constants for these types are defined at the :mod:`cd` module level (see above). The callback is called as follows: ``func(arg, type, data)``, where *arg* is the user supplied argument, *type* is the particular type of callback, and *data* is the data returned for this *type* of callback. The type of the data depends on the *type* of callback as follows: +-------------+---------------------------------------------+ | Type | Value | +=============+=============================================+ | ``audio`` | String which can be passed unmodified to | | | :func:`al.writesamps`. | +-------------+---------------------------------------------+ | ``pnum`` | Integer giving the program (track) number. | +-------------+---------------------------------------------+ | ``index`` | Integer giving the index number. | +-------------+---------------------------------------------+ | ``ptime`` | Tuple consisting of the program time in | | | minutes, seconds, and frames. | +-------------+---------------------------------------------+ | ``atime`` | Tuple consisting of the absolute time in | | | minutes, seconds, and frames. | +-------------+---------------------------------------------+ | ``catalog`` | String of 13 characters, giving the catalog | | | number of the CD. | +-------------+---------------------------------------------+ | ``ident`` | String of 12 characters, giving the ISRC | | | identification number of the recording. | | | The string consists of two characters | | | country code, three characters owner code, | | | two characters giving the year, and five | | | characters giving a serial number. | +-------------+---------------------------------------------+ | ``control`` | Integer giving the control bits from the CD | | | subcode data | +-------------+---------------------------------------------+ .. method:: CD parser.deleteparser() Deletes the parser and frees the memory it was using. The object should not be used after this call. This call is done automatically when the last reference to the object is removed. .. method:: CD parser.parseframe(frame) Parses one or more frames of digital audio data from a CD such as returned by :meth:`readda`. It determines which subcodes are present in the data. If these subcodes have changed since the last frame, then :meth:`parseframe` executes a callback of the appropriate type passing to it the subcode data found in the frame. Unlike the C function, more than one frame of digital audio data can be passed to this method. .. method:: CD parser.removecallback(type) Removes the callback for the given *type*. .. method:: CD parser.resetparser() Resets the fields of the parser used for tracking subcodes to an initial state. :meth:`resetparser` should be called after the disc has been changed.