Changeset 466

Timestamp:

23-05-11 16:57:16 (2 years ago)

Author:

thomas

Message:

• morituri/test/test_common_encode.py: Generate an actual file by spawning gst-launch; otherwise with proper error handling we get an error from wavparse that there is not enough data to typefind.
• morituri/common/gstreamer.py: Move the gst import to start() and set it as a class attribute. Document methods.
• morituri/common/encode.py: Convert EncodeTask? to a GstPipelineTask?.

Location:

trunk

Files:

• ChangeLog (modified) (1 diff)
• morituri/common/encode.py (modified) (10 diffs)
• morituri/common/gstreamer.py (modified) (4 diffs)
• morituri/test/test_common_encode.py (modified) (4 diffs)

trunk/ChangeLog

@@ +1 @@
+2011-05-23  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+        * morituri/test/test_common_encode.py:
+          Generate an actual file by spawning gst-launch; otherwise
+          with proper error handling we get an error from wavparse that
+          there is not enough data to typefind.
+        * morituri/common/gstreamer.py:
+          Move the gst import to start() and set it as a class attribute.
+          Document methods.
+        * morituri/common/encode.py:
+          Convert EncodeTask to a GstPipelineTask.
+
 2011-05-23  Thomas Vander Stichele  <thomas at apestaart dot org>
 

trunk/morituri/common/encode.py

@@ -26 +26 @@
 import tempfile
 
-from morituri.common import common, task, log
+from morituri.common import common, task, log, gstreamer
 
 class Profile(object):
@@ -123 +123 @@
 ALL_PROFILES.update(LOSSY_PROFILES)
 
-class EncodeTask(task.Task):
+class EncodeTask(gstreamer.GstPipelineTask):
     """
     I am a task that encodes a .wav file.
@@ -159 +159 @@
         self._profile.test()
 
-    def start(self, runner):
-        task.Task.start(self, runner)
-
-        # here to avoid import gst eating our options
-        import gst
-
-        desc = '''
+    def getPipelineDesc(self):
+        return '''
             filesrc location="%s" !
             decodebin name=decoder !
@@ -176 +171 @@
                 common.quoteParse(self._outpath).encode('utf-8'))
 
-        self.debug('creating pipeline: %r', desc)
-        self._pipeline = gst.parse_launch(desc)
-
-        tagger = self._pipeline.get_by_name('tagger')
+    def parsed(self):
+        tagger = self.pipeline.get_by_name('tagger')
 
         # set tags
@@ -186 +179 @@
             # See for example comment saying wavenc did not have it.
             try:
-                tagger.merge_tags(self._taglist, gst.TAG_MERGE_APPEND)
+                tagger.merge_tags(self._taglist, self.gst.TAG_MERGE_APPEND)
             except AttributeError, e:
                 self.warning('Could not merge tags: %r',
                     log.getExceptionMessage(e))
 
-        self.debug('pausing pipeline')
-        self._pipeline.set_state(gst.STATE_PAUSED)
-        self._pipeline.get_state()
-        self.debug('paused pipeline')
-
+    def paused(self):
         # get length
-        identity = self._pipeline.get_by_name('identity')
+        identity = self.pipeline.get_by_name('identity')
         self.debug('query duration')
         try:
-            length, qformat = identity.query_duration(gst.FORMAT_DEFAULT)
-        except gst.QueryError, e:
+            length, qformat = identity.query_duration(self.gst.FORMAT_DEFAULT)
+        except self.gst.QueryError, e:
             self.setException(e)
             self.stop()
@@ -207 +196 @@
 
         # wavparse 0.10.14 returns in bytes
-        if qformat == gst.FORMAT_BYTES:
+        if qformat == self.gst.FORMAT_BYTES:
             self.debug('query returned in BYTES format')
             length /= 4
@@ -213 +202 @@
         self._length = length
 
-        # add eos handling
-        bus = self._pipeline.get_bus()
+        # set up level callbacks
+        # FIXME: publicize bus and reuse it instead of regetting and adding ?
+        bus = self.pipeline.get_bus()
         bus.add_signal_watch()
-        bus.connect('message::eos', self._message_eos_cb)
-
-        # set up level callbacks
+
         bus.connect('message::element', self._message_element_cb)
-        self._level = self._pipeline.get_by_name('level')
+        self._level = self.pipeline.get_by_name('level')
         # add a probe so we can track progress
         # we connect to level because this gives us offset in samples
@@ -226 +214 @@
         srcpad.add_buffer_probe(self._probe_handler)
 
+        # FIXME: move to base class ?
         self.debug('scheduling setting to play')
         # since set_state returns non-False, adding it as timeout_add
         # will repeatedly call it, and block the main loop; so
-        #   gobject.timeout_add(0L, self._pipeline.set_state, gst.STATE_PLAYING)
+        #   gobject.timeout_add(0L, self.pipeline.set_state, self.gst.STATE_PLAYING)
         # would not work.
 
         def play():
-            self._pipeline.set_state(gst.STATE_PLAYING)
+            self.pipeline.set_state(self.gst.STATE_PLAYING)
             return False
         self.runner.schedule(0, play)
 
-        #self._pipeline.set_state(gst.STATE_PLAYING)
+        #self.pipeline.set_state(gst.STATE_PLAYING)
         self.debug('scheduled setting to play')
 
@@ -250 +239 @@
         return True
 
-    def _message_eos_cb(self, bus, message):
+    def bus_eos_cb(self, bus, message):
         self.debug('eos, scheduling stop')
         self.runner.schedule(0, self.stop)
@@ -271 +260 @@
                 self._peakdB = p
 
+    # FIXME: move to base class, have stopped handler ?
     def stop(self):
-        # here to avoid import gst eating our options
-        import gst
-
         self.debug('stopping')
         self.debug('setting state to NULL')
-        self._pipeline.set_state(gst.STATE_NULL)
+        self.pipeline.set_state(self.gst.STATE_NULL)
         self.debug('set state to NULL')
         # FIXME: maybe this should move lower ? If used by BaseMultiTask,

trunk/morituri/common/gstreamer.py

@@ -21 +21 @@
 # along with morituri.  If not, see <http://www.gnu.org/licenses/>.
 
-import gst
-
 from morituri.common import common, task
 
@@ -36 +34 @@
 
     I handle errors and raise them appropriately.
+
+    @cvar gst: the GStreamer module, so code does not have to import gst
+               as a module in code everywhere to avoid option stealing.
     """
+
+    gst = None
+
     def start(self, runner):
+        import gst
+        self.gst = gst
+
         task.Task.start(self, runner)
         desc = self.getPipelineDesc()
 
         self.debug('creating pipeline %r', desc)
-        self.pipeline = gst.parse_launch(desc)
+        self.pipeline = self.gst.parse_launch(desc)
 
         self._bus = self.pipeline.get_bus()
-        gst.debug('got bus %r' % self._bus)
+        self.gst.debug('got bus %r' % self._bus)
 
         # a signal watch calls callbacks from an idle loop
@@ -60 +67 @@
 
         self.debug('pausing pipeline')
-        self.pipeline.set_state(gst.STATE_PAUSED)
+        self.pipeline.set_state(self.gst.STATE_PAUSED)
         # FIXME: this can block
         self.pipeline.get_state()
@@ -86 +93 @@
 
     def bus_eos_cb(self, bus, message):
+        """
+        Called synchronously (ie from messaging thread) on eos message.
+
+        Override me to handle eos
+        """
         pass
 
     def bus_tag_cb(self, bus, message):
+        """
+        Called synchronously (ie from messaging thread) on tag message.
+
+        Override me to handle tags.
+        """
         pass
 
     def bus_error_cb(self, bus, message):
+        """
+        Called synchronously (ie from messaging thread) on error message.
+        """
         exc = GstException(*message.parse_error())
         self.setAndRaiseException(exc)
-        gst.debug('error, scheduling stop')
+        # FIXME: why is this commented ?
+        # self.gst.debug('error, scheduling stop')
         #self.runner.schedule(0, self.stop)

trunk/morituri/test/test_common_encode.py

@@ -10 +10 @@
 import gst
 
-from morituri.test import common
+from morituri.test import common as tcommon
 
-from morituri.common import task, encode, log
+from morituri.common import task, encode, log, common
 
-class PathTestCase(common.TestCase):
+class PathTestCase(tcommon.TestCase):
     def _testSuffix(self, suffix):
         self.runner = task.SyncRunner(verbose=False)
-        fd, path = tempfile.mkstemp(
-            suffix=suffix)
+        fd, path = tempfile.mkstemp(suffix=suffix)
+        cmd = "gst-launch " \
+            "audiotestsrc num-buffers=100 samplesperbuffer=1024 ! " \
+            "audioconvert ! audio/x-raw-int,width=16,depth=16,channels =2 ! " \
+            "wavenc ! " \
+            "filesink location=\"%s\" > /dev/null 2>&1" % (
+            common.quoteParse(path).encode('utf-8'), )
+        os.system(cmd)
+        self.failUnless(os.path.exists(path))
         encodetask = encode.EncodeTask(path, path + '.out',
             encode.WavProfile())
-        e = self.assertRaises(task.TaskException, self.runner.run,
-            encodetask, verbose=False)
-        self.failUnless(isinstance(e.exception, gst.QueryError),
-            "%r is not a gst.QueryError" % e.exception)
+        self.runner.run(encodetask, verbose=False)
         os.close(fd)
         os.unlink(path)
         os.unlink(path + '.out')
 
-class UnicodePathTestCase(PathTestCase, common.UnicodeTestMixin):
+class UnicodePathTestCase(PathTestCase, tcommon.UnicodeTestMixin):
     def testUnicodePath(self):
         # this test makes sure we can checksum a unicode path
@@ -41 +45 @@
         self._testSuffix(u'.morituri.test_encode.12" edit')
 
-class TagReadTestCase(common.TestCase):
+class TagReadTestCase(tcommon.TestCase):
     def testRead(self):
         path = os.path.join(os.path.dirname(__file__), u'track.flac')
@@ -51 +55 @@
         self.assertEquals(t.taglist['description'], 'audiotest wave')
 
-class TagWriteTestCase(common.TestCase):
+class TagWriteTestCase(tcommon.TestCase):
     def testWrite(self):
         fd, inpath = tempfile.mkstemp(suffix=u'.morituri.tagwrite.flac')
@@ -82 +86 @@
         os.unlink(outpath)
         
-class SafeRetagTestCase(common.TestCase):
+class SafeRetagTestCase(tcommon.TestCase):
     def setUp(self):
         self._fd, self._path = tempfile.mkstemp(suffix=u'.morituri.retag.flac')