sunau - pydoc - phpman

Help on module sunau:

NAME
    sunau - Stuff to parse Sun and NeXT audio files.

MODULE REFERENCE
    https://docs.python.org/3.10/library/sunau.html

    The following documentation is automatically generated from the Python
    source files.  It may be incomplete, incorrect or include features that
    are considered implementation detail and may vary between Python
    implementations.  When in doubt, consult the module reference at the
    location listed above.

DESCRIPTION
    An audio file consists of a header followed by the data.  The structure
    of the header is as follows.

            +---------------+
            | magic word    |
            +---------------+
            | header size   |
            +---------------+
            | data size     |
            +---------------+
            | encoding      |
            +---------------+
            | sample rate   |
            +---------------+
            | # of channels |
            +---------------+
            | info          |
            |               |
            +---------------+

    The magic word consists of the 4 characters '.snd'.  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 header size really gives the start of the data.
    The data size is the physical size of the data.  From the other
    parameters the number of frames can be calculated.
    The encoding gives the way in which audio samples are encoded.
    Possible values are listed below.
    The info field currently consists of an ASCII string giving a
    human-readable description of the audio file.  The info field is
    padded with NUL bytes to the header size.

    Usage.

    Reading audio files:
            f = sunau.open(file, 'r')
    where file is either the name of a file or an open file pointer.
    The open file pointer must have methods read(), seek(), and close().
    When the setpos() and rewind() methods are not used, the seek()
    method is not  necessary.

    This returns an instance of a class with the following public methods:
            getnchannels()  -- returns number of audio channels (1 for
                               mono, 2 for stereo)
            getsampwidth()  -- returns sample width in bytes
            getframerate()  -- returns sampling frequency
            getnframes()    -- returns number of audio frames
            getcomptype()   -- returns compression type ('NONE' or 'ULAW')
            getcompname()   -- returns human-readable version of
                               compression type ('not compressed' matches 'NONE')
            getparams()     -- returns a namedtuple consisting of all of the
                               above in the above order
            getmarkers()    -- returns None (for compatibility with the
                               aifc module)
            getmark(id)     -- raises an error since the mark does not
                               exist (for compatibility with the aifc module)
            readframes(n)   -- returns at most n frames of audio
            rewind()        -- rewind to the beginning of the audio stream
            setpos(pos)     -- seek to the specified position
            tell()          -- return the current position
            close()         -- close the instance (make it unusable)
    The position returned by tell() and the position given to setpos()
    are compatible and have nothing to do with the actual position in the
    file.
    The close() method is called automatically when the class instance
    is destroyed.

    Writing audio files:
            f = sunau.open(file, 'w')
    where file is either the name of a file or an open file pointer.
    The open file pointer must have methods write(), tell(), seek(), and
    close().

    This returns an instance of a class with the following public methods:
            setnchannels(n) -- set the number of channels
            setsampwidth(n) -- set the sample width
            setframerate(n) -- set the frame rate
            setnframes(n)   -- set the number of frames
            setcomptype(type, name)
                            -- set the compression type and the
                               human-readable compression type
            setparams(tuple)-- set all parameters at once
            tell()          -- return current position in output file
            writeframesraw(data)
                            -- write audio frames without pathing up the
                               file header
            writeframes(data)
                            -- write audio frames and patch up the file header
            close()         -- patch up the file header and close the
                               output file
    You should set the parameters before the first writeframesraw or
    writeframes.  The total number of frames does not need to be set,
    but when it is set to the correct value, the header does not have to
    be patched up.
    It is best to first set all parameters, perhaps possibly the
    compression type, and then write audio frames using writeframesraw.
    When all frames have been written, either call writeframes(b'') or
    close() to patch up the sizes in the header.
    The close() method is called automatically when the class instance
    is destroyed.

CLASSES
    builtins.Exception(builtins.BaseException)
        Error
    builtins.object
        Au_read
        Au_write

    class Au_read(builtins.object)
     |  Au_read(f)
     |
     |  Methods defined here:
     |
     |  __del__(self)
     |
     |  __enter__(self)
     |
     |  __exit__(self, *args)
     |
     |  __init__(self, f)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  close(self)
     |
     |  getcompname(self)
     |
     |  getcomptype(self)
     |
     |  getfp(self)
     |
     |  getframerate(self)
     |
     |  getmark(self, id)
     |
     |  getmarkers(self)
     |
     |  getnchannels(self)
     |
     |  getnframes(self)
     |
     |  getparams(self)
     |
     |  getsampwidth(self)
     |
     |  initfp(self, file)
     |
     |  readframes(self, nframes)
     |
     |  rewind(self)
     |
     |  setpos(self, pos)
     |
     |  tell(self)
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  __weakref__
     |      list of weak references to the object (if defined)

    class Au_write(builtins.object)
     |  Au_write(f)
     |
     |  Methods defined here:
     |
     |  __del__(self)
     |
     |  __enter__(self)
     |
     |  __exit__(self, *args)
     |
     |  __init__(self, f)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  close(self)
     |
     |  getcompname(self)
     |
     |  getcomptype(self)
     |
     |  getframerate(self)
     |
     |  getnchannels(self)
     |
     |  getnframes(self)
     |
     |  getparams(self)
     |
     |  getsampwidth(self)
     |
     |  initfp(self, file)
     |
     |  setcomptype(self, type, name)
     |
     |  setframerate(self, framerate)
     |
     |  setnchannels(self, nchannels)
     |
     |  setnframes(self, nframes)
     |
     |  setparams(self, params)
     |
     |  setsampwidth(self, sampwidth)
     |
     |  tell(self)
     |
     |  writeframes(self, data)
     |
     |  writeframesraw(self, data)
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  __weakref__
     |      list of weak references to the object (if defined)

    class Error(builtins.Exception)
     |  Method resolution order:
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |
     |  Data descriptors defined here:
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.Exception:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |
     |  __reduce__(...)
     |      Helper for pickle.
     |
     |  __repr__(self, /)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |
     |  __setstate__(...)
     |
     |  __str__(self, /)
     |      Return str(self).
     |
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |
     |  __cause__
     |      exception cause
     |
     |  __context__
     |      exception context
     |
     |  __dict__
     |
     |  __suppress_context__
     |
     |  __traceback__
     |
     |  args

FUNCTIONS
    open(f, mode=None)

DATA
    AUDIO_FILE_ENCODING_ADPCM_G721 = 23
    AUDIO_FILE_ENCODING_ADPCM_G722 = 24
    AUDIO_FILE_ENCODING_ADPCM_G723_3 = 25
    AUDIO_FILE_ENCODING_ADPCM_G723_5 = 26
    AUDIO_FILE_ENCODING_ALAW_8 = 27
    AUDIO_FILE_ENCODING_DOUBLE = 7
    AUDIO_FILE_ENCODING_FLOAT = 6
    AUDIO_FILE_ENCODING_LINEAR_16 = 3
    AUDIO_FILE_ENCODING_LINEAR_24 = 4
    AUDIO_FILE_ENCODING_LINEAR_32 = 5
    AUDIO_FILE_ENCODING_LINEAR_8 = 2
    AUDIO_FILE_ENCODING_MULAW_8 = 1
    AUDIO_FILE_MAGIC = 779316836
    AUDIO_UNKNOWN_SIZE = 4294967295

FILE
    /usr/lib/python3.10/sunau.py