wave: add format to getparams

Author: mbeijen

Lib/test/audiotests.py

@@ -38,13 +38,14 @@ def check_params(self, f, nchannels, sampwidth, framerate, nframes,
 
         params = f.getparams()
         self.assertEqual(params,
-                (nchannels, sampwidth, framerate, nframes, comptype, compname))
+                (nchannels, sampwidth, framerate, nframes, comptype, compname, format))
         self.assertEqual(params.nchannels, nchannels)
         self.assertEqual(params.sampwidth, sampwidth)
         self.assertEqual(params.framerate, framerate)
         self.assertEqual(params.nframes, nframes)
         self.assertEqual(params.comptype, comptype)
         self.assertEqual(params.compname, compname)
+        self.assertEqual(params.format, format)
 
         for proto in range(pickle.HIGHEST_PROTOCOL + 1):
             dump = pickle.dumps(params, proto)
@@ -304,6 +305,8 @@ def test_read(self):
             f.setpos(f.getnframes() + 1)
 
     def test_copy(self):
+        if self.readonly:
+            self.skipTest('Read only file format')
         f = self.f = self.module.open(self.sndfilepath)
         fout = self.fout = self.module.open(TESTFN, 'wb')
         fout.setparams(f.getparams())

Lib/test/test_wave.py

@@ -173,6 +173,38 @@ def test__all__(self):
 
 class WaveLowLevelTest(unittest.TestCase):
 
+    def test_setparams_6_tuple_defaults_to_pcm(self):
+        with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
+            filename = fp.name
+        self.addCleanup(unlink, filename)
+
+        with wave.open(filename, 'wb') as w:
+            w.setformat(wave.WAVE_FORMAT_IEEE_FLOAT)
+            w.setparams((1, 2, 22050, 0, 'NONE', 'not compressed'))
+            self.assertEqual(w.getformat(), wave.WAVE_FORMAT_PCM)
+
+    def test_setparams_7_tuple_uses_format(self):
+        with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
+            filename = fp.name
+        self.addCleanup(unlink, filename)
+
+        with wave.open(filename, 'wb') as w:
+            w.setparams((1, 2, 22050, 0, 'NONE', 'not compressed',
+                         wave.WAVE_FORMAT_IEEE_FLOAT))
+            self.assertEqual(w.getformat(), wave.WAVE_FORMAT_IEEE_FLOAT)
+
+    def test_getparams_has_format_field(self):
+        with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
+            filename = fp.name
+        self.addCleanup(unlink, filename)
+
+        with wave.open(filename, 'wb') as w:
+            w.setparams((1, 2, 22050, 0, 'NONE', 'not compressed',
+                         wave.WAVE_FORMAT_IEEE_FLOAT))
+            params = w.getparams()
+            self.assertEqual(params.format, wave.WAVE_FORMAT_IEEE_FLOAT)
+            self.assertEqual(params[:6], (1, 2, 22050, 0, 'NONE', 'not compressed'))
+
     def test_getformat_setformat(self):
         with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
             filename = fp.name

Lib/wave.py

@@ -93,7 +93,8 @@ class Error(Exception):
 _array_fmts = None, 'b', 'h', None, 'i'
 
 _wave_params = namedtuple('_wave_params',
-                     'nchannels sampwidth framerate nframes comptype compname')
+                     'nchannels sampwidth framerate nframes comptype compname format',
+                     defaults=(WAVE_FORMAT_PCM,))
 
 
 def _byteswap(data, width):
@@ -349,7 +350,8 @@ def getcompname(self):
     def getparams(self):
         return _wave_params(self.getnchannels(), self.getsampwidth(),
                        self.getframerate(), self.getnframes(),
-                       self.getcomptype(), self.getcompname())
+                       self.getcomptype(), self.getcompname(),
+                       self.getformat())
 
     def setpos(self, pos):
         if pos < 0 or pos > self._nframes:
@@ -552,20 +554,25 @@ def getcompname(self):
         return self._compname
 
     def setparams(self, params):
-        nchannels, sampwidth, framerate, nframes, comptype, compname = params
         if self._datawritten:
             raise Error('cannot change parameters after starting to write')
+        if len(params) == 6:
+            nchannels, sampwidth, framerate, nframes, comptype, compname = params
+            format = WAVE_FORMAT_PCM
+        else:
+            nchannels, sampwidth, framerate, nframes, comptype, compname, format = params
         self.setnchannels(nchannels)
         self.setsampwidth(sampwidth)
         self.setframerate(framerate)
         self.setnframes(nframes)
         self.setcomptype(comptype, compname)
+        self.setformat(format)
 
     def getparams(self):
         if not self._nchannels or not self._sampwidth or not self._framerate:
             raise Error('not all parameters set')
         return _wave_params(self._nchannels, self._sampwidth, self._framerate,
-              self._nframes, self._comptype, self._compname)
+              self._nframes, self._comptype, self._compname, self._format)
 
     def tell(self):
         return self._nframeswritten