EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Lib / wave.py

"""Stuff to parse WAVE files.\r
\r
Usage.\r
\r
Reading WAVE files:\r
      f = wave.open(file, 'r')\r
where file is either the name of a file or an open file pointer.\r
The open file pointer must have methods read(), seek(), and close().\r
When the setpos() and rewind() methods are not used, the seek()\r
method is not  necessary.\r
\r
This returns an instance of a class with the following public methods:\r
      getnchannels()  -- returns number of audio channels (1 for\r
                         mono, 2 for stereo)\r
      getsampwidth()  -- returns sample width in bytes\r
      getframerate()  -- returns sampling frequency\r
      getnframes()    -- returns number of audio frames\r
      getcomptype()   -- returns compression type ('NONE' for linear samples)\r
      getcompname()   -- returns human-readable version of\r
                         compression type ('not compressed' linear samples)\r
      getparams()     -- returns a tuple consisting of all of the\r
                         above in the above order\r
      getmarkers()    -- returns None (for compatibility with the\r
                         aifc module)\r
      getmark(id)     -- raises an error since the mark does not\r
                         exist (for compatibility with the aifc module)\r
      readframes(n)   -- returns at most n frames of audio\r
      rewind()        -- rewind to the beginning of the audio stream\r
      setpos(pos)     -- seek to the specified position\r
      tell()          -- return the current position\r
      close()         -- close the instance (make it unusable)\r
The position returned by tell() and the position given to setpos()\r
are compatible and have nothing to do with the actual position in the\r
file.\r
The close() method is called automatically when the class instance\r
is destroyed.\r
\r
Writing WAVE files:\r
      f = wave.open(file, 'w')\r
where file is either the name of a file or an open file pointer.\r
The open file pointer must have methods write(), tell(), seek(), and\r
close().\r
\r
This returns an instance of a class with the following public methods:\r
      setnchannels(n) -- set the number of channels\r
      setsampwidth(n) -- set the sample width\r
      setframerate(n) -- set the frame rate\r
      setnframes(n)   -- set the number of frames\r
      setcomptype(type, name)\r
                      -- set the compression type and the\r
                         human-readable compression type\r
      setparams(tuple)\r
                      -- set all parameters at once\r
      tell()          -- return current position in output file\r
      writeframesraw(data)\r
                      -- write audio frames without pathing up the\r
                         file header\r
      writeframes(data)\r
                      -- write audio frames and patch up the file header\r
      close()         -- patch up the file header and close the\r
                         output file\r
You should set the parameters before the first writeframesraw or\r
writeframes.  The total number of frames does not need to be set,\r
but when it is set to the correct value, the header does not have to\r
be patched up.\r
It is best to first set all parameters, perhaps possibly the\r
compression type, and then write audio frames using writeframesraw.\r
When all frames have been written, either call writeframes('') or\r
close() to patch up the sizes in the header.\r
The close() method is called automatically when the class instance\r
is destroyed.\r
"""\r
\r
import __builtin__\r
\r
__all__ = ["open", "openfp", "Error"]\r
\r
class Error(Exception):\r
    pass\r
\r
WAVE_FORMAT_PCM = 0x0001\r
\r
_array_fmts = None, 'b', 'h', None, 'l'\r
\r
# Determine endian-ness\r
import struct\r
if struct.pack("h", 1) == "\000\001":\r
    big_endian = 1\r
else:\r
    big_endian = 0\r
\r
from chunk import Chunk\r
\r
class Wave_read:\r
    """Variables used in this class:\r
\r
    These variables are available to the user though appropriate\r
    methods of this class:\r
    _file -- the open file with methods read(), close(), and seek()\r
              set through the __init__() method\r
    _nchannels -- the number of audio channels\r
              available through the getnchannels() method\r
    _nframes -- the number of audio frames\r
              available through the getnframes() method\r
    _sampwidth -- the number of bytes per audio sample\r
              available through the getsampwidth() method\r
    _framerate -- the sampling frequency\r
              available through the getframerate() method\r
    _comptype -- the AIFF-C compression type ('NONE' if AIFF)\r
              available through the getcomptype() method\r
    _compname -- the human-readable AIFF-C compression type\r
              available through the getcomptype() method\r
    _soundpos -- the position in the audio stream\r
              available through the tell() method, set through the\r
              setpos() method\r
\r
    These variables are used internally only:\r
    _fmt_chunk_read -- 1 iff the FMT chunk has been read\r
    _data_seek_needed -- 1 iff positioned correctly in audio\r
              file for readframes()\r
    _data_chunk -- instantiation of a chunk class for the DATA chunk\r
    _framesize -- size of one frame in the file\r
    """\r
\r
    def initfp(self, file):\r
        self._convert = None\r
        self._soundpos = 0\r
        self._file = Chunk(file, bigendian = 0)\r
        if self._file.getname() != 'RIFF':\r
            raise Error, 'file does not start with RIFF id'\r
        if self._file.read(4) != 'WAVE':\r
            raise Error, 'not a WAVE file'\r
        self._fmt_chunk_read = 0\r
        self._data_chunk = None\r
        while 1:\r
            self._data_seek_needed = 1\r
            try:\r
                chunk = Chunk(self._file, bigendian = 0)\r
            except EOFError:\r
                break\r
            chunkname = chunk.getname()\r
            if chunkname == 'fmt ':\r
                self._read_fmt_chunk(chunk)\r
                self._fmt_chunk_read = 1\r
            elif chunkname == 'data':\r
                if not self._fmt_chunk_read:\r
                    raise Error, 'data chunk before fmt chunk'\r
                self._data_chunk = chunk\r
                self._nframes = chunk.chunksize // self._framesize\r
                self._data_seek_needed = 0\r
                break\r
            chunk.skip()\r
        if not self._fmt_chunk_read or not self._data_chunk:\r
            raise Error, 'fmt chunk and/or data chunk missing'\r
\r
    def __init__(self, f):\r
        self._i_opened_the_file = None\r
        if isinstance(f, basestring):\r
            f = __builtin__.open(f, 'rb')\r
            self._i_opened_the_file = f\r
        # else, assume it is an open file object already\r
        try:\r
            self.initfp(f)\r
        except:\r
            if self._i_opened_the_file:\r
                f.close()\r
            raise\r
\r
    def __del__(self):\r
        self.close()\r
    #\r
    # User visible methods.\r
    #\r
    def getfp(self):\r
        return self._file\r
\r
    def rewind(self):\r
        self._data_seek_needed = 1\r
        self._soundpos = 0\r
\r
    def close(self):\r
        if self._i_opened_the_file:\r
            self._i_opened_the_file.close()\r
            self._i_opened_the_file = None\r
        self._file = None\r
\r
    def tell(self):\r
        return self._soundpos\r
\r
    def getnchannels(self):\r
        return self._nchannels\r
\r
    def getnframes(self):\r
        return self._nframes\r
\r
    def getsampwidth(self):\r
        return self._sampwidth\r
\r
    def getframerate(self):\r
        return self._framerate\r
\r
    def getcomptype(self):\r
        return self._comptype\r
\r
    def getcompname(self):\r
        return self._compname\r
\r
    def getparams(self):\r
        return self.getnchannels(), self.getsampwidth(), \\r
               self.getframerate(), self.getnframes(), \\r
               self.getcomptype(), self.getcompname()\r
\r
    def getmarkers(self):\r
        return None\r
\r
    def getmark(self, id):\r
        raise Error, 'no marks'\r
\r
    def setpos(self, pos):\r
        if pos < 0 or pos > self._nframes:\r
            raise Error, 'position not in range'\r
        self._soundpos = pos\r
        self._data_seek_needed = 1\r
\r
    def readframes(self, nframes):\r
        if self._data_seek_needed:\r
            self._data_chunk.seek(0, 0)\r
            pos = self._soundpos * self._framesize\r
            if pos:\r
                self._data_chunk.seek(pos, 0)\r
            self._data_seek_needed = 0\r
        if nframes == 0:\r
            return ''\r
        if self._sampwidth > 1 and big_endian:\r
            # unfortunately the fromfile() method does not take\r
            # something that only looks like a file object, so\r
            # we have to reach into the innards of the chunk object\r
            import array\r
            chunk = self._data_chunk\r
            data = array.array(_array_fmts[self._sampwidth])\r
            nitems = nframes * self._nchannels\r
            if nitems * self._sampwidth > chunk.chunksize - chunk.size_read:\r
                nitems = (chunk.chunksize - chunk.size_read) / self._sampwidth\r
            data.fromfile(chunk.file.file, nitems)\r
            # "tell" data chunk how much was read\r
            chunk.size_read = chunk.size_read + nitems * self._sampwidth\r
            # do the same for the outermost chunk\r
            chunk = chunk.file\r
            chunk.size_read = chunk.size_read + nitems * self._sampwidth\r
            data.byteswap()\r
            data = data.tostring()\r
        else:\r
            data = self._data_chunk.read(nframes * self._framesize)\r
        if self._convert and data:\r
            data = self._convert(data)\r
        self._soundpos = self._soundpos + len(data) // (self._nchannels * self._sampwidth)\r
        return data\r
\r
    #\r
    # Internal methods.\r
    #\r
\r
    def _read_fmt_chunk(self, chunk):\r
        wFormatTag, self._nchannels, self._framerate, dwAvgBytesPerSec, wBlockAlign = struct.unpack('<hhllh', chunk.read(14))\r
        if wFormatTag == WAVE_FORMAT_PCM:\r
            sampwidth = struct.unpack('<h', chunk.read(2))[0]\r
            self._sampwidth = (sampwidth + 7) // 8\r
        else:\r
            raise Error, 'unknown format: %r' % (wFormatTag,)\r
        self._framesize = self._nchannels * self._sampwidth\r
        self._comptype = 'NONE'\r
        self._compname = 'not compressed'\r
\r
class Wave_write:\r
    """Variables used in this class:\r
\r
    These variables are user settable through appropriate methods\r
    of this class:\r
    _file -- the open file with methods write(), close(), tell(), seek()\r
              set through the __init__() method\r
    _comptype -- the AIFF-C compression type ('NONE' in AIFF)\r
              set through the setcomptype() or setparams() method\r
    _compname -- the human-readable AIFF-C compression type\r
              set through the setcomptype() or setparams() method\r
    _nchannels -- the number of audio channels\r
              set through the setnchannels() or setparams() method\r
    _sampwidth -- the number of bytes per audio sample\r
              set through the setsampwidth() or setparams() method\r
    _framerate -- the sampling frequency\r
              set through the setframerate() or setparams() method\r
    _nframes -- the number of audio frames written to the header\r
              set through the setnframes() or setparams() method\r
\r
    These variables are used internally only:\r
    _datalength -- the size of the audio samples written to the header\r
    _nframeswritten -- the number of frames actually written\r
    _datawritten -- the size of the audio samples actually written\r
    """\r
\r
    def __init__(self, f):\r
        self._i_opened_the_file = None\r
        if isinstance(f, basestring):\r
            f = __builtin__.open(f, 'wb')\r
            self._i_opened_the_file = f\r
        try:\r
            self.initfp(f)\r
        except:\r
            if self._i_opened_the_file:\r
                f.close()\r
            raise\r
\r
    def initfp(self, file):\r
        self._file = file\r
        self._convert = None\r
        self._nchannels = 0\r
        self._sampwidth = 0\r
        self._framerate = 0\r
        self._nframes = 0\r
        self._nframeswritten = 0\r
        self._datawritten = 0\r
        self._datalength = 0\r
        self._headerwritten = False\r
\r
    def __del__(self):\r
        self.close()\r
\r
    #\r
    # User visible methods.\r
    #\r
    def setnchannels(self, nchannels):\r
        if self._datawritten:\r
            raise Error, 'cannot change parameters after starting to write'\r
        if nchannels < 1:\r
            raise Error, 'bad # of channels'\r
        self._nchannels = nchannels\r
\r
    def getnchannels(self):\r
        if not self._nchannels:\r
            raise Error, 'number of channels not set'\r
        return self._nchannels\r
\r
    def setsampwidth(self, sampwidth):\r
        if self._datawritten:\r
            raise Error, 'cannot change parameters after starting to write'\r
        if sampwidth < 1 or sampwidth > 4:\r
            raise Error, 'bad sample width'\r
        self._sampwidth = sampwidth\r
\r
    def getsampwidth(self):\r
        if not self._sampwidth:\r
            raise Error, 'sample width not set'\r
        return self._sampwidth\r
\r
    def setframerate(self, framerate):\r
        if self._datawritten:\r
            raise Error, 'cannot change parameters after starting to write'\r
        if framerate <= 0:\r
            raise Error, 'bad frame rate'\r
        self._framerate = framerate\r
\r
    def getframerate(self):\r
        if not self._framerate:\r
            raise Error, 'frame rate not set'\r
        return self._framerate\r
\r
    def setnframes(self, nframes):\r
        if self._datawritten:\r
            raise Error, 'cannot change parameters after starting to write'\r
        self._nframes = nframes\r
\r
    def getnframes(self):\r
        return self._nframeswritten\r
\r
    def setcomptype(self, comptype, compname):\r
        if self._datawritten:\r
            raise Error, 'cannot change parameters after starting to write'\r
        if comptype not in ('NONE',):\r
            raise Error, 'unsupported compression type'\r
        self._comptype = comptype\r
        self._compname = compname\r
\r
    def getcomptype(self):\r
        return self._comptype\r
\r
    def getcompname(self):\r
        return self._compname\r
\r
    def setparams(self, params):\r
        nchannels, sampwidth, framerate, nframes, comptype, compname = params\r
        if self._datawritten:\r
            raise Error, 'cannot change parameters after starting to write'\r
        self.setnchannels(nchannels)\r
        self.setsampwidth(sampwidth)\r
        self.setframerate(framerate)\r
        self.setnframes(nframes)\r
        self.setcomptype(comptype, compname)\r
\r
    def getparams(self):\r
        if not self._nchannels or not self._sampwidth or not self._framerate:\r
            raise Error, 'not all parameters set'\r
        return self._nchannels, self._sampwidth, self._framerate, \\r
              self._nframes, self._comptype, self._compname\r
\r
    def setmark(self, id, pos, name):\r
        raise Error, 'setmark() not supported'\r
\r
    def getmark(self, id):\r
        raise Error, 'no marks'\r
\r
    def getmarkers(self):\r
        return None\r
\r
    def tell(self):\r
        return self._nframeswritten\r
\r
    def writeframesraw(self, data):\r
        self._ensure_header_written(len(data))\r
        nframes = len(data) // (self._sampwidth * self._nchannels)\r
        if self._convert:\r
            data = self._convert(data)\r
        if self._sampwidth > 1 and big_endian:\r
            import array\r
            data = array.array(_array_fmts[self._sampwidth], data)\r
            data.byteswap()\r
            data.tofile(self._file)\r
            self._datawritten = self._datawritten + len(data) * self._sampwidth\r
        else:\r
            self._file.write(data)\r
            self._datawritten = self._datawritten + len(data)\r
        self._nframeswritten = self._nframeswritten + nframes\r
\r
    def writeframes(self, data):\r
        self.writeframesraw(data)\r
        if self._datalength != self._datawritten:\r
            self._patchheader()\r
\r
    def close(self):\r
        if self._file:\r
            self._ensure_header_written(0)\r
            if self._datalength != self._datawritten:\r
                self._patchheader()\r
            self._file.flush()\r
            self._file = None\r
        if self._i_opened_the_file:\r
            self._i_opened_the_file.close()\r
            self._i_opened_the_file = None\r
\r
    #\r
    # Internal methods.\r
    #\r
\r
    def _ensure_header_written(self, datasize):\r
        if not self._headerwritten:\r
            if not self._nchannels:\r
                raise Error, '# channels not specified'\r
            if not self._sampwidth:\r
                raise Error, 'sample width not specified'\r
            if not self._framerate:\r
                raise Error, 'sampling rate not specified'\r
            self._write_header(datasize)\r
\r
    def _write_header(self, initlength):\r
        assert not self._headerwritten\r
        self._file.write('RIFF')\r
        if not self._nframes:\r
            self._nframes = initlength / (self._nchannels * self._sampwidth)\r
        self._datalength = self._nframes * self._nchannels * self._sampwidth\r
        self._form_length_pos = self._file.tell()\r
        self._file.write(struct.pack('<l4s4slhhllhh4s',\r
            36 + self._datalength, 'WAVE', 'fmt ', 16,\r
            WAVE_FORMAT_PCM, self._nchannels, self._framerate,\r
            self._nchannels * self._framerate * self._sampwidth,\r
            self._nchannels * self._sampwidth,\r
            self._sampwidth * 8, 'data'))\r
        self._data_length_pos = self._file.tell()\r
        self._file.write(struct.pack('<l', self._datalength))\r
        self._headerwritten = True\r
\r
    def _patchheader(self):\r
        assert self._headerwritten\r
        if self._datawritten == self._datalength:\r
            return\r
        curpos = self._file.tell()\r
        self._file.seek(self._form_length_pos, 0)\r
        self._file.write(struct.pack('<l', 36 + self._datawritten))\r
        self._file.seek(self._data_length_pos, 0)\r
        self._file.write(struct.pack('<l', self._datawritten))\r
        self._file.seek(curpos, 0)\r
        self._datalength = self._datawritten\r
\r
def open(f, mode=None):\r
    if mode is None:\r
        if hasattr(f, 'mode'):\r
            mode = f.mode\r
        else:\r
            mode = 'rb'\r
    if mode in ('r', 'rb'):\r
        return Wave_read(f)\r
    elif mode in ('w', 'wb'):\r
        return Wave_write(f)\r
    else:\r
        raise Error, "mode must be 'r', 'rb', 'w', or 'wb'"\r
\r
openfp = open # B/W compatibility\r