fixed video component eating stdout

+ made height/width into properties to simplify render methods

10 files changed, 141 insertions, 155 deletions

diff --git a/src/component.py b/src/component.py
index 5de67d1..1c5ccb3 100644
--- a/src/component.py
+++ b/src/component.py
@@ -4,6 +4,9 @@
 '''
 from PyQt5 import uic, QtCore, QtWidgets
 import os
+import time
+
+from toolkit.frame import BlankFrame
 
 
 class ComponentMetaclass(type(QtCore.QObject)):
@@ -28,10 +31,12 @@ class ComponentMetaclass(type(QtCore.QObject)):
         def renderWrapper(self, *args, **kwargs):
             try:
                 return func(self, *args, **kwargs)
-            except Exception:
-                from toolkit.frame import BlankFrame
+            except Exception as e:
                 try:
-                    raise ComponentError(self, 'renderer')
+                    if e.__name__.startswith('Component'):
+                        raise
+                    else:
+                        raise ComponentError(self, 'renderer')
                 except ComponentError:
                     return BlankFrame()
         return renderWrapper
@@ -93,7 +98,7 @@ class ComponentMetaclass(type(QtCore.QObject)):
             'names',                            # Class methods
             'error', 'audio', 'properties',     # Properties
             'preFrameRender', 'previewRender',
-            'command',
+            'frameRender', 'command',
         )
 
         # Auto-decorate methods
@@ -110,7 +115,7 @@ class ComponentMetaclass(type(QtCore.QObject)):
             if key == 'command':
                 attrs[key] = cls.commandWrapper(attrs[key])
 
-            if key == 'previewRender':
+            if key in ('previewRender', 'frameRender'):
                 attrs[key] = cls.renderWrapper(attrs[key])
 
             if key == 'preFrameRender':
@@ -181,6 +186,37 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
         )
 
     # =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~==~=~=~=~=~=~=~=~=~=~=~=~=~=~
+    # Critical Methods
+    # =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~==~=~=~=~=~=~=~=~=~=~=~=~=~=~
+
+    def previewRender(self):
+        image = BlankFrame(self.width, self.height)
+        return image
+
+    def preFrameRender(self, **kwargs):
+        '''
+            Must call super() when subclassing
+            Triggered only before a video is exported (video_thread.py)
+                self.worker = the video thread worker
+                self.completeAudioArray = a list of audio samples
+                self.sampleSize = number of audio samples per video frame
+                self.progressBarUpdate = signal to set progress bar number
+                self.progressBarSetText = signal to set progress bar text
+            Use the latter two signals to update the MainWindow if needed
+            for a long initialization procedure (i.e., for a visualizer)
+        '''
+        for key, value in kwargs.items():
+            setattr(self, key, value)
+
+    def frameRender(self, frameNo):
+        audioArrayIndex = frameNo * self.sampleSize
+        image = BlankFrame(self.width, self.height)
+        return image
+
+    def renderFinished(self):
+        pass
+
+    # =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~==~=~=~=~=~=~=~=~=~=~=~=~=~=~
     # Properties
     # =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~==~=~=~=~=~=~=~=~=~=~=~=~=~=~
 
@@ -196,6 +232,8 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
         '''
             Return a string containing an error message, or None for a default.
             Or tuple of two strings for a message with details.
+            Alternatively use lockError(msgString) within properties()
+            to skip this method entirely.
         '''
         return
 
@@ -211,7 +249,7 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
         '''
 
     # =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~==~=~=~=~=~=~=~=~=~=~=~=~=~=~
-    # Methods
+    # Idle Methods
     # =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~==~=~=~=~=~=~=~=~=~=~=~=~=~=~
 
     def widget(self, parent):
@@ -244,33 +282,11 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
         for widget in widgets['comboBox']:
             widget.currentIndexChanged.connect(self.update)
 
-    def trackWidgets(self, trackDict, **kwargs):
-        '''
-            Name widgets to track in update(), savePreset(), loadPreset(), and
-            command(). Requires a dict of attr names as keys, widgets as values
-
-            Optional args:
-                'presetNames': preset variable names to replace attr names
-                'commandArgs': arg keywords that differ from attr names
-
-            NOTE: Any kwarg key set to None will selectively disable tracking.
-        '''
-        self._trackedWidgets = trackDict
-        for kwarg in kwargs:
-            try:
-                if kwarg in ('presetNames', 'commandArgs'):
-                    setattr(self, '_%s' % kwarg, kwargs[kwarg])
-                else:
-                    raise ComponentError(
-                        self, 'Nonsensical keywords to trackWidgets.')
-            except ComponentError:
-                continue
-
     def update(self):
         '''
             Reads all tracked widget values into instance attributes
             and tells the MainWindow that the component was modified.
-            Call at the END of your method if you need to subclass this.
+            Call super() at the END if you need to subclass this.
         '''
         for attr, widget in self._trackedWidgets.items():
             if type(widget) == QtWidgets.QLineEdit:
@@ -320,20 +336,6 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
             ] = getattr(self, attr)
         return saveValueStore
 
-    def preFrameRender(self, **kwargs):
-        '''
-            Triggered only before a video is exported (video_thread.py)
-                self.worker = the video thread worker
-                self.completeAudioArray = a list of audio samples
-                self.sampleSize = number of audio samples per video frame
-                self.progressBarUpdate = signal to set progress bar number
-                self.progressBarSetText = signal to set progress bar text
-            Use the latter two signals to update the MainWindow if needed
-            for a long initialization procedure (i.e., for a visualizer)
-        '''
-        for key, value in kwargs.items():
-            setattr(self, key, value)
-
     def commandHelp(self):
         '''Help text as string for this component's commandline arguments'''
 
@@ -356,6 +358,28 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
     # "Private" Methods
     # =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~==~=~=~=~=~=~=~=~=~=~=~=~=~=~
 
+    def trackWidgets(self, trackDict, **kwargs):
+        '''
+            Name widgets to track in update(), savePreset(), loadPreset(), and
+            command(). Requires a dict of attr names as keys, widgets as values
+
+            Optional args:
+                'presetNames': preset variable names to replace attr names
+                'commandArgs': arg keywords that differ from attr names
+
+            NOTE: Any kwarg key set to None will selectively disable tracking.
+        '''
+        self._trackedWidgets = trackDict
+        for kwarg in kwargs:
+            try:
+                if kwarg in ('presetNames', 'commandArgs'):
+                    setattr(self, '_%s' % kwarg, kwargs[kwarg])
+                else:
+                    raise ComponentError(
+                        self, 'Nonsensical keywords to trackWidgets.')
+            except ComponentError:
+                continue
+
     def lockProperties(self, propList):
         self._lockedProperties = propList
 
@@ -372,6 +396,14 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
         '''Load a Qt Designer ui file to use for this component's widget'''
         return uic.loadUi(os.path.join(self.core.componentsPath, filename))
 
+    @property
+    def width(self):
+        return int(self.settings.value('outputWidth'))
+
+    @property
+    def height(self):
+        return int(self.settings.value('outputHeight'))
+
     def cancel(self):
         '''Stop any lengthy process in response to this variable.'''
         self.canceled = True
@@ -381,41 +413,24 @@ class Component(QtCore.QObject, metaclass=ComponentMetaclass):
         self.unlockProperties()
         self.unlockError()
 
-    '''
-    ### Reference methods for creating a new component
-    ### (Inherit from this class and define these)
-
-    def previewRender(self, previewWorker):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        from toolkit.frame import BlankFrame
-        image = BlankFrame(width, height)
-        return image
-
-    def frameRender(self, layerNo, frameNo):
-        audioArrayIndex = frameNo * self.sampleSize
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        from toolkit.frame import BlankFrame
-        image = BlankFrame(width, height)
-        return image
-    '''
-
 
 class ComponentError(RuntimeError):
     '''Gives the MainWindow a traceback to display, and cancels the export.'''
 
     prevErrors = []
+    lastTime = time.time()
 
     def __init__(self, caller, name):
-        print('ComponentError by %s: %s' % (caller.name, name))
-        super().__init__()
+        print('##### ComponentError by %s: %s' % (caller.name, name))
         if len(ComponentError.prevErrors) > 1:
             ComponentError.prevErrors.pop()
         ComponentError.prevErrors.insert(0, name)
-        if name in ComponentError.prevErrors[1:]:
-            # Don't create multiple windows for repeated messages
+        curTime = time.time()
+        if name in ComponentError.prevErrors[1:] \
+                and curTime - ComponentError.lastTime < 0.2:
+            # Don't create multiple windows for quickly repeated messages
             return
+        ComponentError.lastTime = time.time()
 
         from toolkit import formatTraceback
         import sys
@@ -440,4 +455,5 @@ class ComponentError(RuntimeError):
                 )
             )
 
+        super().__init__(string)
         caller._error.emit(string, detail)
diff --git a/src/components/color.py b/src/components/color.py
index 8257ed9..2abd79a 100644
--- a/src/components/color.py
+++ b/src/components/color.py
@@ -96,18 +96,14 @@ class Component(Component):
 
         super().update()
 
-    def previewRender(self, previewWorker):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return self.drawFrame(width, height)
+    def previewRender(self):
+        return self.drawFrame(self.width, self.height)
 
     def properties(self):
         return ['static']
 
-    def frameRender(self, layerNo, frameNo):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return self.drawFrame(width, height)
+    def frameRender(self, frameNo):
+        return self.drawFrame(self.width, self.height)
 
     def drawFrame(self, width, height):
         r, g, b = self.color1
diff --git a/src/components/image.py b/src/components/image.py
index a705904..a96f127 100644
--- a/src/components/image.py
+++ b/src/components/image.py
@@ -31,10 +31,8 @@ class Component(Component):
             },
         )
 
-    def previewRender(self, previewWorker):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return self.drawFrame(width, height)
+    def previewRender(self):
+        return self.drawFrame(self.width, self.height)
 
     def properties(self):
         props = ['static']
@@ -48,10 +46,8 @@ class Component(Component):
         if not os.path.exists(self.imagePath):
             return "The image selected does not exist!"
 
-    def frameRender(self, layerNo, frameNo):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return self.drawFrame(width, height)
+    def frameRender(self, frameNo):
+        return self.drawFrame(self.width, self.height)
 
     def drawFrame(self, width, height):
         frame = BlankFrame(width, height)
diff --git a/src/components/original.py b/src/components/original.py
index 570465d..3d1a574 100644
--- a/src/components/original.py
+++ b/src/components/original.py
@@ -59,13 +59,11 @@ class Component(Component):
         saveValueStore['visColor'] = self.visColor
         return saveValueStore
 
-    def previewRender(self, previewWorker):
+    def previewRender(self):
         spectrum = numpy.fromfunction(
             lambda x: float(self.scale)/2500*(x-128)**2, (255,), dtype="int16")
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
         return self.drawBars(
-            width, height, spectrum, self.visColor, self.layout
+            self.width, self.height, spectrum, self.visColor, self.layout
         )
 
     def preFrameRender(self, **kwargs):
@@ -74,8 +72,6 @@ class Component(Component):
         self.smoothConstantUp = 0.8
         self.lastSpectrum = None
         self.spectrumArray = {}
-        self.width = int(self.settings.value('outputWidth'))
-        self.height = int(self.settings.value('outputHeight'))
 
         for i in range(0, len(self.completeAudioArray), self.sampleSize):
             if self.canceled:
@@ -93,7 +89,7 @@ class Component(Component):
             self.progressBarSetText.emit(pStr)
             self.progressBarUpdate.emit(int(progress))
 
-    def frameRender(self, layerNo, frameNo):
+    def frameRender(self, frameNo):
         arrayNo = frameNo * self.sampleSize
         return self.drawBars(
             self.width, self.height,
diff --git a/src/components/sound.py b/src/components/sound.py
index fcd9e4e..aff43d3 100644
--- a/src/components/sound.py
+++ b/src/components/sound.py
@@ -21,11 +21,6 @@ class Component(Component):
             'sound': None,
         })
 
-    def previewRender(self, previewWorker):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return BlankFrame(width, height)
-
     def preFrameRender(self, **kwargs):
         pass
 
@@ -63,11 +58,6 @@ class Component(Component):
             self.page.lineEdit_sound.setText(filename)
             self.update()
 
-    def frameRender(self, layerNo, frameNo):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return BlankFrame(width, height)
-
     def commandHelp(self):
         print('Path to audio file:\n    path=/filepath/to/sound.ogg')
 
diff --git a/src/components/text.py b/src/components/text.py
index 1d64617..8a302ff 100644
--- a/src/components/text.py
+++ b/src/components/text.py
@@ -97,10 +97,8 @@ class Component(Component):
         saveValueStore['textColor'] = self.textColor
         return saveValueStore
 
-    def previewRender(self, previewWorker):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return self.addText(width, height)
+    def previewRender(self):
+        return self.addText(self.width, self.height)
 
     def properties(self):
         props = ['static']
@@ -111,13 +109,10 @@ class Component(Component):
     def error(self):
         return "No text provided."
 
-    def frameRender(self, layerNo, frameNo):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        return self.addText(width, height)
+    def frameRender(self, frameNo):
+        return self.addText(self.width, self.height)
 
     def addText(self, width, height):
-
         image = FramePainter(width, height)
         self.titleFont.setPixelSize(self.fontSize)
         image.setFont(self.titleFont)
diff --git a/src/components/video.py b/src/components/video.py
index 8872fbf..48ac557 100644
--- a/src/components/video.py
+++ b/src/components/video.py
@@ -3,10 +3,11 @@ from PyQt5 import QtGui, QtCore, QtWidgets
 import os
 import math
 import subprocess
+import signal
 import threading
 from queue import PriorityQueue
 
-from component import Component
+from component import Component, ComponentError
 from toolkit.frame import BlankFrame
 from toolkit.ffmpeg import testAudioStream
 from toolkit import openPipe, checkOutput
@@ -14,6 +15,10 @@ from toolkit import openPipe, checkOutput
 
 class Video:
     '''Opens a pipe to ffmpeg and stores a buffer of raw video frames.'''
+
+    # error from the thread used to fill the buffer
+    threadError = None
+
     def __init__(self, **kwargs):
         mandatoryArgs = [
             'ffmpeg',     # path to ffmpeg, usually self.core.FFMPEG_BIN
@@ -71,8 +76,8 @@ class Video:
             self.frameBuffer.task_done()
 
     def fillBuffer(self):
-        pipe = openPipe(
-            self.command, stdout=subprocess.PIPE,
+        self.pipe = openPipe(
+            self.command, stdin=subprocess.DEVNULL, stdout=subprocess.PIPE,
             stderr=subprocess.DEVNULL, bufsize=10**8
         )
         while True:
@@ -85,19 +90,11 @@ class Video:
                 if len(self.currentFrame) == 0:
                     self.frameBuffer.put((self.frameNo-1, self.lastFrame))
                     continue
-            except AttributeError as e:
-                self.parent.showMessage(
-                    msg='%s couldn\'t be loaded. '
-                        'This is a fatal error.' % os.path.basename(
-                            self.videoPath
-                        ),
-                    detail=str(e),
-                    icon='Warning'
-                )
-                self.parent.stopVideo()
+            except AttributeError:
+                Video.threadError = ComponentError(self.component, 'video')
                 break
 
-            self.currentFrame = pipe.stdout.read(self.chunkSize)
+            self.currentFrame = self.pipe.stdout.read(self.chunkSize)
             if len(self.currentFrame) != 0:
                 self.frameBuffer.put((self.frameNo, self.currentFrame))
                 self.lastFrame = self.currentFrame
@@ -143,13 +140,11 @@ class Component(Component):
             self.page.spinBox_volume.setEnabled(False)
         super().update()
 
-    def previewRender(self, previewWorker):
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        self.updateChunksize(width, height)
-        frame = self.getPreviewFrame(width, height)
+    def previewRender(self):
+        self.updateChunksize()
+        frame = self.getPreviewFrame(self.width, self.height)
         if not frame:
-            return BlankFrame(width, height)
+            return BlankFrame(self.width, self.height)
         else:
             return frame
 
@@ -184,23 +179,23 @@ class Component(Component):
 
     def preFrameRender(self, **kwargs):
         super().preFrameRender(**kwargs)
-        width = int(self.settings.value('outputWidth'))
-        height = int(self.settings.value('outputHeight'))
-        self.blankFrame_ = BlankFrame(width, height)
-        self.updateChunksize(width, height)
+        self.updateChunksize()
         self.video = Video(
             ffmpeg=self.core.FFMPEG_BIN, videoPath=self.videoPath,
-            width=width, height=height, chunkSize=self.chunkSize,
+            width=self.width, height=self.height, chunkSize=self.chunkSize,
             frameRate=int(self.settings.value("outputFrameRate")),
             parent=self.parent, loopVideo=self.loopVideo,
             component=self, scale=self.scale
         ) if os.path.exists(self.videoPath) else None
 
-    def frameRender(self, layerNo, frameNo):
-        if self.video:
-            return self.video.frame(frameNo)
-        else:
-            return self.blankFrame_
+    def frameRender(self, frameNo):
+        if Video.threadError is not None:
+            raise Video.threadError
+        return self.video.frame(frameNo)
+
+    def renderFinished(self):
+        self.video.pipe.stdout.close()
+        self.video.pipe.send_signal(signal.SIGINT)
 
     def pickVideo(self):
         imgDir = self.settings.value("componentDir", os.path.expanduser("~"))
@@ -230,20 +225,20 @@ class Component(Component):
             '-vframes', '1',
         ]
         pipe = openPipe(
-            command, stdout=subprocess.PIPE,
+            command, stdin=subprocess.DEVNULL, stdout=subprocess.PIPE,
             stderr=subprocess.DEVNULL, bufsize=10**8
         )
         byteFrame = pipe.stdout.read(self.chunkSize)
-        frame = finalizeFrame(self, byteFrame, width, height)
         pipe.stdout.close()
-        pipe.kill()
+        pipe.send_signal(signal.SIGINT)
 
+        frame = finalizeFrame(self, byteFrame, width, height)
         return frame
 
-    def updateChunksize(self, width, height):
+    def updateChunksize(self):
         if self.scale != 100 and not self.distort:
-            width, height = scale(self.scale, width, height, int)
-        self.chunkSize = 4*width*height
+            width, height = scale(self.scale, self.width, self.height, int)
+        self.chunkSize = 4 * width * height
 
     def command(self, arg):
         if '=' in arg:
diff --git a/src/preview_thread.py b/src/preview_thread.py
index 9917e4b..0a6a856 100644
--- a/src/preview_thread.py
+++ b/src/preview_thread.py
@@ -59,7 +59,7 @@ class Worker(QtCore.QObject):
             components = nextPreviewInformation["components"]
             for component in reversed(components):
                 try:
-                    newFrame = component.previewRender(self)
+                    newFrame = component.previewRender()
                     frame = Image.alpha_composite(
                         frame, newFrame
                     )
diff --git a/src/toolkit/ffmpeg.py b/src/toolkit/ffmpeg.py
index 8d63659..2fffc7b 100644
--- a/src/toolkit/ffmpeg.py
+++ b/src/toolkit/ffmpeg.py
@@ -252,7 +252,7 @@ def getAudioDuration(filename):
     return duration
 
 
-def readAudioFile(filename, parent):
+def readAudioFile(filename, videoWorker):
     '''
         Creates the completeAudioArray given to components
         and used to draw the classic visualizer.
@@ -296,8 +296,8 @@ def readAudioFile(filename, parent):
 
         if lastPercent != percent:
             string = 'Loading audio file: '+str(percent)+'%'
-            parent.progressBarSetText.emit(string)
-            parent.progressBarUpdate.emit(percent)
+            videoWorker.progressBarSetText.emit(string)
+            videoWorker.progressBarUpdate.emit(percent)
 
         lastPercent = percent
 
diff --git a/src/video_thread.py b/src/video_thread.py
index c5a3c09..8c7d585 100644
--- a/src/video_thread.py
+++ b/src/video_thread.py
@@ -60,8 +60,7 @@ class Worker(QtCore.QObject):
             audioI = self.compositeQueue.get()
             bgI = int(audioI / self.sampleSize)
             frame = None
-            for compNo, comp in reversed(list(enumerate(self.components))):
-                layerNo = len(self.components) - compNo - 1
+            for layerNo, comp in enumerate(reversed((self.components))):
                 if layerNo in self.staticComponents:
                     if self.staticComponents[layerNo] is None:
                         # this layer was merged into a following layer
@@ -76,10 +75,10 @@ class Worker(QtCore.QObject):
                 else:
                     # animated component
                     if frame is None:  # bottom-most layer
-                        frame = comp.frameRender(compNo, bgI)
+                        frame = comp.frameRender(bgI)
                     else:
                         frame = Image.alpha_composite(
-                            frame, comp.frameRender(compNo, bgI)
+                            frame, comp.frameRender(bgI)
                         )
 
             self.renderQueue.put([audioI, frame])
@@ -185,7 +184,7 @@ class Worker(QtCore.QObject):
                 break
             if 'static' in compProps:
                 self.staticComponents[compNo] = \
-                    comp.frameRender(compNo, 0).copy()
+                    comp.frameRender(0).copy()
 
         if self.canceled:
             if canceledByComponent:
@@ -290,8 +289,11 @@ class Worker(QtCore.QObject):
             print(self.out_pipe.stderr.read())
             self.out_pipe.stderr.close()
             self.error = True
-        # out_pipe.terminate() # don't terminate ffmpeg too early
         self.out_pipe.wait()
+
+        for comp in reversed(self.components):
+            comp.renderFinished()
+
         if self.canceled:
             print("Export Canceled")
             try: