[Python-checkins] CVS: python/dist/src/Doc/lib libsunau.tex,1.2,1.3

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory slayer.i.sourceforge.net:/tmp/cvs-serv5458/lib

Modified Files:
	libsunau.tex 
Log Message:

Include more information from the docstrings.


Index: libsunau.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsunau.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** libsunau.tex	2000/07/16 19:01:10	1.2
--- libsunau.tex	2000/10/06 21:07:14	1.3
***************
*** 6,13 ****
  \modulesynopsis{Provide an interface to the Sun AU sound format.}
  
! The \module{sunau} module provides a convenient interface to the Sun AU sound
! format. Note that this module is interface-compatible with the modules
! \refmodule{aifc} and \refmodule{wave}.
  
  The \module{sunau} module defines the following functions:
  
--- 6,32 ----
  \modulesynopsis{Provide an interface to the Sun AU sound format.}
  
! The \module{sunau} module provides a convenient interface to the Sun
! AU sound format.  Note that this module is interface-compatible with
! the modules \refmodule{aifc} and \refmodule{wave}.
! 
! An audio file consists of a header followed by the data.  The fields
! of the header are:
! 
! \begin{tableii}{l|l}{textrm}{Field}{Contents}
!   \lineii{magic word}{The four bytes \samp{.snd}.}
!   \lineii{header size}{Size of the header, including info, in bytes.}
!   \lineii{data size}{Physical size of the data, in bytes.}
!   \lineii{encoding}{Indicates how the audio samples are encoded.}
!   \lineii{sample rate}{The sampling rate.}
!   \lineii{\# of channels}{The number of channels in the samples.}
!   \lineii{info}{\ASCII{} string giving a description of the audio
!                 file (padded with null bytes).}
! \end{tableii}
! 
! Apart from the info field, all header fields are 4 bytes in size.
! They are all 32-bit unsigned integers encoded in big-endian byte
! order.
  
+ 
  The \module{sunau} module defines the following functions:
  
***************
*** 37,44 ****
  \end{excdesc}
  
! The \module{sunau} module defines the following data item:
  
  \begin{datadesc}{AUDIO_FILE_MAGIC}
! An integer every valid Sun AU file begins with a big-endian encoding of.
  \end{datadesc}
  
--- 56,84 ----
  \end{excdesc}
  
! The \module{sunau} module defines the following data items:
  
  \begin{datadesc}{AUDIO_FILE_MAGIC}
! An integer every valid Sun AU file begins with, stored in big-endian
! form.  This is the string \samp{.snd} interpreted as an integer.
! \end{datadesc}
! 
! \begin{datadesc}{AUDIO_FILE_ENCODING_MULAW_8}
! \dataline{AUDIO_FILE_ENCODING_LINEAR_8}
! \dataline{AUDIO_FILE_ENCODING_LINEAR_16}
! \dataline{AUDIO_FILE_ENCODING_LINEAR_24}
! \dataline{AUDIO_FILE_ENCODING_LINEAR_32}
! \dataline{AUDIO_FILE_ENCODING_ALAW_8}
! Values of the encoding field from the AU header which are supported by
! this module.
! \end{datadesc}
! 
! \begin{datadesc}{AUDIO_FILE_ENCODING_FLOAT}
! \dataline{AUDIO_FILE_ENCODING_DOUBLE}
! \dataline{AUDIO_FILE_ENCODING_ADPCM_G721}
! \dataline{AUDIO_FILE_ENCODING_ADPCM_G722}
! \dataline{AUDIO_FILE_ENCODING_ADPCM_G723_3}
! \dataline{AUDIO_FILE_ENCODING_ADPCM_G723_5}
! Additional known values of the encoding field from the AU header, but
! which are not supported by this module.
  \end{datadesc}
  
***************
*** 99,107 ****
  
  \begin{methoddesc}[AU_read]{setpos}{pos}
! Set the file pointer to the specified position.
  \end{methoddesc}
  
  \begin{methoddesc}[AU_read]{tell}{}
! Return current file pointer position.
  \end{methoddesc}
  
--- 139,149 ----
  
  \begin{methoddesc}[AU_read]{setpos}{pos}
! Set the file pointer to the specified position.  Only values returned
! from \method{tell()} should be used for \var{pos}.
  \end{methoddesc}
  
  \begin{methoddesc}[AU_read]{tell}{}
! Return current file pointer position.  Note that the returned value
! has nothing to do with the actual position in the file.
  \end{methoddesc}