Merge pull request #49 from djfun/toolkit

Code reorganization, more readable component code, better error messages

1 files changed, 204 insertions, 106 deletions

diff --git a/src/mainwindow.py b/src/mainwindow.py
index ca8e697..070131c 100644
--- a/src/mainwindow.py
+++ b/src/mainwindow.py
@@ -14,13 +14,18 @@ import signal
 import filecmp
 import time
 
-import core
+from core import Core
 import preview_thread
 from presetmanager import PresetManager
-from toolkit import LoadDefaultSettings, disableWhenEncoding, checkOutput
+from toolkit import disableWhenEncoding, disableWhenOpeningProject, checkOutput
 
 
 class PreviewWindow(QtWidgets.QLabel):
+    '''
+        Paints the preview QLabel and maintains the aspect ratio when the
+        window is resized.
+    '''
+
     def __init__(self, parent, img):
         super(PreviewWindow, self).__init__()
         self.parent = parent
@@ -45,8 +50,24 @@ class PreviewWindow(QtWidgets.QLabel):
         self.pixmap = QtGui.QPixmap(img)
         self.repaint()
 
+    @QtCore.pyqtSlot(str)
+    def threadError(self, msg):
+        self.parent.showMessage(
+            msg=msg,
+            icon='Critical',
+            parent=self
+        )
+
 
 class MainWindow(QtWidgets.QMainWindow):
+    '''
+        The MainWindow wraps many Core methods in order to update the GUI
+        accordingly. E.g., instead of self.core.openProject(), it will use
+        self.openProject() and update the window titlebar within the wrapper.
+
+        MainWindow manages the autosave feature, although Core has the
+        primary functions for opening and creating project files.
+    '''
 
     createVideo = QtCore.pyqtSignal()
     newTask = QtCore.pyqtSignal(list)  # for the preview window
@@ -54,38 +75,45 @@ class MainWindow(QtWidgets.QMainWindow):
 
     def __init__(self, window, project):
         QtWidgets.QMainWindow.__init__(self)
-
         # print('main thread id: {}'.format(QtCore.QThread.currentThreadId()))
         self.window = window
-        self.core = core.Core()
+        self.core = Core()
 
-        self.pages = []  # widgets of component settings
+        # widgets of component settings
+        self.pages = []
         self.lastAutosave = time.time()
+        # list of previous five autosave times, used to reduce update spam
+        self.autosaveTimes = []
+        self.autosaveCooldown = 0.2
         self.encoding = False
 
         # Create data directory, load/create settings
-        self.dataDir = self.core.dataDir
+        self.dataDir = Core.dataDir
+        self.presetDir = Core.presetDir
         self.autosavePath = os.path.join(self.dataDir, 'autosave.avp')
-        self.settings = self.core.settings
-        LoadDefaultSettings(self)
+        self.settings = Core.settings
         self.presetManager = PresetManager(
             uic.loadUi(
-                os.path.join(self.core.wd, 'presetmanager.ui')), self)
+                os.path.join(Core.wd, 'presetmanager.ui')), self)
 
         if not os.path.exists(self.dataDir):
             os.makedirs(self.dataDir)
         for neededDirectory in (
-          self.core.presetDir, self.settings.value("projectDir")):
+          self.presetDir, self.settings.value("projectDir")):
             if not os.path.exists(neededDirectory):
                 os.mkdir(neededDirectory)
 
-        # Make queues/timers for the preview thread
+        # Create the preview window and its thread, queues, and timers
+        self.previewWindow = PreviewWindow(self, os.path.join(
+            Core.wd, "background.png"))
+        window.verticalLayout_previewWrapper.addWidget(self.previewWindow)
+
         self.previewQueue = Queue()
         self.previewThread = QtCore.QThread(self)
         self.previewWorker = preview_thread.Worker(self, self.previewQueue)
+        self.previewWorker.error.connect(self.previewWindow.threadError)
         self.previewWorker.moveToThread(self.previewThread)
         self.previewWorker.imageCreated.connect(self.showPreviewImage)
-        self.previewWorker.error.connect(self.cleanUp)
         self.previewThread.start()
 
         self.timer = QtCore.QTimer(self)
@@ -93,6 +121,7 @@ class MainWindow(QtWidgets.QMainWindow):
         self.timer.start(500)
 
         # Begin decorating the window and connecting events
+        self.window.installEventFilter(self)
         componentList = self.window.listWidget_componentList
 
         if sys.platform == 'darwin':
@@ -120,7 +149,7 @@ class MainWindow(QtWidgets.QMainWindow):
 
         window.pushButton_Cancel.clicked.connect(self.stopVideo)
 
-        for i, container in enumerate(self.core.encoder_options['containers']):
+        for i, container in enumerate(Core.encoderOptions['containers']):
             window.comboBox_videoContainer.addItem(container['name'])
             if container['name'] == self.settings.value('outputContainer'):
                 selectedContainer = i
@@ -155,19 +184,13 @@ class MainWindow(QtWidgets.QMainWindow):
 
         window.spinBox_vBitrate.setValue(vBitrate)
         window.spinBox_aBitrate.setValue(aBitrate)
-
         window.spinBox_vBitrate.valueChanged.connect(self.updateCodecSettings)
         window.spinBox_aBitrate.valueChanged.connect(self.updateCodecSettings)
 
-        self.previewWindow = PreviewWindow(self, os.path.join(
-            self.core.wd, "background.png"))
-        window.verticalLayout_previewWrapper.addWidget(self.previewWindow)
-
         # Make component buttons
         self.compMenu = QMenu()
-        self.compActions = []
         for i, comp in enumerate(self.core.modules):
-            action = self.compMenu.addAction(comp.Component.__doc__)
+            action = self.compMenu.addAction(comp.Component.name)
             action.triggered.connect(
                 lambda _, item=i: self.core.insertComponent(0, item, self)
             )
@@ -178,6 +201,9 @@ class MainWindow(QtWidgets.QMainWindow):
         componentList.itemSelectionChanged.connect(
             self.changeComponentWidget
         )
+        componentList.itemSelectionChanged.connect(
+            self.presetManager.clearPresetListSelection
+        )
         self.window.pushButton_removeComponent.clicked.connect(
             lambda: self.removeComponent()
         )
@@ -189,7 +215,7 @@ class MainWindow(QtWidgets.QMainWindow):
 
         currentRes = str(self.settings.value('outputWidth'))+'x' + \
             str(self.settings.value('outputHeight'))
-        for i, res in enumerate(self.resolutions):
+        for i, res in enumerate(Core.resolutions):
             window.comboBox_resolution.addItem(res)
             if res == currentRes:
                 currentRes = i
@@ -288,7 +314,7 @@ class MainWindow(QtWidgets.QMainWindow):
                         ['ffmpeg', '-version'], stderr=f
                     )
                 goodVersion = str(ffmpegVers).split()[2].startswith('3')
-            except:
+            except Exception:
                 goodVersion = False
         else:
             goodVersion = True
@@ -300,22 +326,23 @@ class MainWindow(QtWidgets.QMainWindow):
             )
         self.settings.setValue("ffmpegMsgShown", True)
 
-        # Setup Hotkeys
+        # Hotkeys for projects
         QtWidgets.QShortcut("Ctrl+S", self.window, self.saveCurrentProject)
         QtWidgets.QShortcut("Ctrl+A", self.window, self.openSaveProjectDialog)
         QtWidgets.QShortcut("Ctrl+O", self.window, self.openOpenProjectDialog)
         QtWidgets.QShortcut("Ctrl+N", self.window, self.createNewProject)
-        QtWidgets.QShortcut(
-            "Ctrl+Alt+Shift+R", self.window, self.drawPreview
-        )
-        QtWidgets.QShortcut(
-            "Ctrl+Alt+Shift+F", self.window, self.showFfmpegCommand
-        )
 
-        QtWidgets.QShortcut(
-            "Ctrl+T", self.window,
-            activated=lambda: self.window.pushButton_addComponent.click()
-        )
+        # Hotkeys for component list
+        for inskey in ("Ctrl+T", QtCore.Qt.Key_Insert):
+            QtWidgets.QShortcut(
+                inskey, self.window,
+                activated=lambda: self.window.pushButton_addComponent.click()
+            )
+        for delkey in ("Ctrl+R", QtCore.Qt.Key_Delete):
+            QtWidgets.QShortcut(
+                delkey, self.window.listWidget_componentList,
+                self.removeComponent
+            )
         QtWidgets.QShortcut(
             "Ctrl+Space", self.window,
             activated=lambda: self.window.listWidget_componentList.setFocus()
@@ -329,23 +356,37 @@ class MainWindow(QtWidgets.QMainWindow):
         )
 
         QtWidgets.QShortcut(
-            "Ctrl+Up", self.window,
+            "Ctrl+Up", self.window.listWidget_componentList,
             activated=lambda: self.moveComponent(-1)
         )
         QtWidgets.QShortcut(
-            "Ctrl+Down", self.window,
+            "Ctrl+Down", self.window.listWidget_componentList,
             activated=lambda: self.moveComponent(1)
         )
-        QtWidgets.QShortcut("Ctrl+Home", self.window, self.moveComponentTop)
-        QtWidgets.QShortcut("Ctrl+End", self.window, self.moveComponentBottom)
-        QtWidgets.QShortcut("Ctrl+r", self.window, self.removeComponent)
+        QtWidgets.QShortcut(
+            "Ctrl+Home", self.window.listWidget_componentList,
+            activated=lambda: self.moveComponent('top')
+        )
+        QtWidgets.QShortcut(
+            "Ctrl+End", self.window.listWidget_componentList,
+            activated=lambda: self.moveComponent('bottom')
+        )
+
+        # Debug Hotkeys
+        QtWidgets.QShortcut(
+            "Ctrl+Alt+Shift+R", self.window, self.drawPreview
+        )
+        QtWidgets.QShortcut(
+            "Ctrl+Alt+Shift+F", self.window, self.showFfmpegCommand
+        )
 
     @QtCore.pyqtSlot()
-    def cleanUp(self):
+    def cleanUp(self, *args):
         self.timer.stop()
         self.previewThread.quit()
         self.previewThread.wait()
 
+    @disableWhenOpeningProject
     def updateWindowTitle(self):
         appName = 'Audio Visualizer'
         try:
@@ -389,7 +430,7 @@ class MainWindow(QtWidgets.QMainWindow):
         vCodecWidget.clear()
         aCodecWidget.clear()
 
-        for container in self.core.encoder_options['containers']:
+        for container in Core.encoderOptions['containers']:
             if container['name'] == name:
                 for vCodec in container['video-codecs']:
                     vCodecWidget.addItem(vCodec)
@@ -397,6 +438,7 @@ class MainWindow(QtWidgets.QMainWindow):
                     aCodecWidget.addItem(aCodec)
 
     def updateCodecSettings(self):
+        '''Updates settings.ini to match encoder option widgets'''
         vCodecWidget = self.window.comboBox_videoCodec
         vBitrateWidget = self.window.spinBox_vBitrate
         aBitrateWidget = self.window.spinBox_aBitrate
@@ -412,15 +454,32 @@ class MainWindow(QtWidgets.QMainWindow):
         self.settings.setValue('outputVideoBitrate', currentVideoBitrate)
         self.settings.setValue('outputAudioBitrate', currentAudioBitrate)
 
+    @disableWhenOpeningProject
     def autosave(self, force=False):
         if not self.currentProject:
             if os.path.exists(self.autosavePath):
                 os.remove(self.autosavePath)
-        elif force or time.time() - self.lastAutosave >= 0.1:
+        elif force or time.time() - self.lastAutosave >= self.autosaveCooldown:
             self.core.createProjectFile(self.autosavePath, self.window)
             self.lastAutosave = time.time()
+            if len(self.autosaveTimes) >= 5:
+                # Do some math to reduce autosave spam. This gives a smooth
+                # curve up to 5 seconds cooldown and maintains that for 30 secs
+                # if a component is continuously updated
+                timeDiff = self.lastAutosave - self.autosaveTimes.pop()
+                if not force and timeDiff >= 1.0 \
+                        and timeDiff <= 10.0:
+                    if self.autosaveCooldown / 4.0 < 0.5:
+                        self.autosaveCooldown += 1.0
+                    self.autosaveCooldown = (
+                            5.0 * (self.autosaveCooldown / 5.0)
+                        ) + (self.autosaveCooldown / 5.0) * 2
+                elif force or timeDiff >= self.autosaveCooldown * 5:
+                    self.autosaveCooldown = 0.2
+            self.autosaveTimes.insert(0, self.lastAutosave)
 
     def autosaveExists(self, identical=True):
+        '''Determines if creating the autosave should be blocked.'''
         try:
             if self.currentProject and os.path.exists(self.autosavePath) \
                 and filecmp.cmp(
@@ -432,6 +491,7 @@ class MainWindow(QtWidgets.QMainWindow):
         return False
 
     def saveProjectChanges(self):
+        '''Overwrites project file with autosave file'''
         try:
             os.remove(self.currentProject)
             os.rename(self.autosavePath, self.currentProject)
@@ -447,7 +507,7 @@ class MainWindow(QtWidgets.QMainWindow):
 
         fileName, _ = QtWidgets.QFileDialog.getOpenFileName(
             self.window, "Open Audio File",
-            inputDir, "Audio Files (%s)" % " ".join(self.core.audioFormats))
+            inputDir, "Audio Files (%s)" % " ".join(Core.audioFormats))
 
         if fileName:
             self.settings.setValue("inputDir", os.path.dirname(fileName))
@@ -460,7 +520,7 @@ class MainWindow(QtWidgets.QMainWindow):
             self.window, "Set Output Video File",
             outputDir,
             "Video Files (%s);; All Files (*)" % " ".join(
-                self.core.videoFormats))
+                Core.videoFormats))
 
         if fileName:
             self.settings.setValue("outputDir", os.path.dirname(fileName))
@@ -511,6 +571,19 @@ class MainWindow(QtWidgets.QMainWindow):
         self.videoWorker.encoding.connect(self.changeEncodingStatus)
         self.createVideo.emit()
 
+    @QtCore.pyqtSlot(str, str)
+    def videoThreadError(self, msg, detail):
+        try:
+            self.stopVideo()
+        except AttributeError as e:
+            if 'videoWorker' not in str(e):
+                raise
+        self.showMessage(
+            msg=msg,
+            detail=detail,
+            icon='Warning',
+        )
+
     def changeEncodingStatus(self, status):
         self.encoding = status
         if status:
@@ -570,15 +643,20 @@ class MainWindow(QtWidgets.QMainWindow):
 
     def updateResolution(self):
         resIndex = int(self.window.comboBox_resolution.currentIndex())
-        res = self.resolutions[resIndex].split('x')
+        res = Core.resolutions[resIndex].split('x')
         self.settings.setValue('outputWidth', res[0])
         self.settings.setValue('outputHeight', res[1])
         self.drawPreview()
 
-    def drawPreview(self, force=False):
+    def drawPreview(self, force=False, **kwargs):
+        '''Use autosave keyword arg to force saving or not saving if needed'''
         self.newTask.emit(self.core.selectedComponents)
         # self.processTask.emit()
-        self.autosave(force)
+        if force or 'autosave' in kwargs:
+            if force or kwargs['autosave']:
+                self.autosave(True)
+        else:
+            self.autosave()
         self.updateWindowTitle()
 
     @QtCore.pyqtSlot(QtGui.QImage)
@@ -587,10 +665,11 @@ class MainWindow(QtWidgets.QMainWindow):
 
     def showFfmpegCommand(self):
         from textwrap import wrap
-        command = self.core.createFfmpegCommand(
+        from toolkit.ffmpeg import createFfmpegCommand
+        command = createFfmpegCommand(
             self.window.lineEdit_audioFile.text(),
             self.window.lineEdit_outputFile.text(),
-            self.core.getAudioDuration(self.window.lineEdit_audioFile.text())
+            self.core.selectedComponents
         )
         lines = wrap(" ".join(command), 49)
         self.showMessage(
@@ -603,7 +682,7 @@ class MainWindow(QtWidgets.QMainWindow):
 
         componentList.insertItem(
             index,
-            self.core.selectedComponents[index].__doc__)
+            self.core.selectedComponents[index].name)
         componentList.setCurrentRow(index)
 
         # connect to signal that adds an asterisk when modified
@@ -632,6 +711,10 @@ class MainWindow(QtWidgets.QMainWindow):
     def moveComponent(self, change):
         '''Moves a component relatively from its current position'''
         componentList = self.window.listWidget_componentList
+        if change == 'top':
+            change = -componentList.currentRow()
+        elif change == 'bottom':
+            change = len(componentList)-componentList.currentRow()-1
         stackedWidget = self.window.stackedWidget
 
         row = componentList.currentRow()
@@ -648,23 +731,13 @@ class MainWindow(QtWidgets.QMainWindow):
             stackedWidget.insertWidget(newRow, page)
             componentList.setCurrentRow(newRow)
             stackedWidget.setCurrentIndex(newRow)
-            self.drawPreview()
-
-    @disableWhenEncoding
-    def moveComponentTop(self):
-        componentList = self.window.listWidget_componentList
-        row = -componentList.currentRow()
-        self.moveComponent(row)
-
-    @disableWhenEncoding
-    def moveComponentBottom(self):
-        componentList = self.window.listWidget_componentList
-        row = len(componentList)-componentList.currentRow()-1
-        self.moveComponent(row)
+            self.drawPreview(True)
 
-    @disableWhenEncoding
-    def dragComponent(self, event):
-        '''Drop event for the component listwidget'''
+    def getComponentListMousePos(self, position):
+        '''
+        Given a QPos, returns the component index under the mouse cursor
+        or -1 if no component is there.
+        '''
         componentList = self.window.listWidget_componentList
 
         modelIndexes = [
@@ -675,13 +748,23 @@ class MainWindow(QtWidgets.QMainWindow):
             componentList.visualRect(modelIndex)
             for modelIndex in modelIndexes
         ]
+        mousePos = [rect.contains(position) for rect in rects]
+        if not any(mousePos):
+            # Not clicking a component
+            mousePos = -1
+        else:
+            mousePos = mousePos.index(True)
+        return mousePos
 
-        rowPos = [rect.contains(event.pos()) for rect in rects]
-        if not any(rowPos):
-            return
-
-        i = rowPos.index(True)
-        change = (componentList.currentRow() - i) * -1
+    @disableWhenEncoding
+    def dragComponent(self, event):
+        '''Used as Qt drop event for the component listwidget'''
+        componentList = self.window.listWidget_componentList
+        mousePos = self.getComponentListMousePos(event.pos())
+        if mousePos > -1:
+            change = (componentList.currentRow() - mousePos) * -1
+        else:
+            change = (componentList.count() - componentList.currentRow() - 1)
         self.moveComponent(change)
 
     def changeComponentWidget(self):
@@ -784,9 +867,7 @@ class MainWindow(QtWidgets.QMainWindow):
         self.settings.setValue("projectDir", os.path.dirname(filepath))
         # actually load the project using core method
         self.core.openProject(self, filepath)
-        if self.window.listWidget_componentList.count() == 0:
-            self.drawPreview()
-        self.autosave(True)
+        self.drawPreview(autosave=False)
         self.updateWindowTitle()
 
     def showMessage(self, **kwargs):
@@ -811,47 +892,64 @@ class MainWindow(QtWidgets.QMainWindow):
 
     @disableWhenEncoding
     def componentContextMenu(self, QPos):
-        '''Appears when right-clicking a component in the list'''
+        '''Appears when right-clicking the component list'''
         componentList = self.window.listWidget_componentList
-        if not componentList.selectedItems():
-            return
-
-        # don't show menu if clicking empty space
+        self.menu = QMenu()
         parentPosition = componentList.mapToGlobal(QtCore.QPoint(0, 0))
-        index = componentList.currentRow()
-        modelIndex = componentList.model().index(index)
-        if not componentList.visualRect(modelIndex).contains(QPos):
-            return
 
-        self.presetManager.findPresets()
-        self.menu = QMenu()
-        menuItem = self.menu.addAction("Save Preset")
-        menuItem.triggered.connect(
-            self.presetManager.openSavePresetDialog
-        )
+        index = self.getComponentListMousePos(QPos)
+        if index > -1:
+            # Show preset menu if clicking a component
+            self.presetManager.findPresets()
+            menuItem = self.menu.addAction("Save Preset")
+            menuItem.triggered.connect(
+                self.presetManager.openSavePresetDialog
+            )
 
-        # submenu for opening presets
-        try:
-            presets = self.presetManager.presets[
-                str(self.core.selectedComponents[index])
-            ]
-            self.submenu = QMenu("Open Preset")
-            self.menu.addMenu(self.submenu)
-
-            for version, presetName in presets:
-                menuItem = self.submenu.addAction(presetName)
+            # submenu for opening presets
+            try:
+                presets = self.presetManager.presets[
+                    str(self.core.selectedComponents[index])
+                ]
+                self.presetSubmenu = QMenu("Open Preset")
+                self.menu.addMenu(self.presetSubmenu)
+
+                for version, presetName in presets:
+                    menuItem = self.presetSubmenu.addAction(presetName)
+                    menuItem.triggered.connect(
+                        lambda _, presetName=presetName:
+                            self.presetManager.openPreset(presetName)
+                    )
+            except KeyError:
+                pass
+
+            if self.core.selectedComponents[index].currentPreset:
+                menuItem = self.menu.addAction("Clear Preset")
                 menuItem.triggered.connect(
-                    lambda _, presetName=presetName:
-                        self.presetManager.openPreset(presetName)
+                    self.presetManager.clearPreset
                 )
-        except KeyError:
-            pass
+            self.menu.addSeparator()
 
-        if self.core.selectedComponents[index].currentPreset:
-            menuItem = self.menu.addAction("Clear Preset")
+        # "Add Component" submenu
+        self.submenu = QMenu("Add")
+        self.menu.addMenu(self.submenu)
+        insertCompAtTop = self.settings.value("pref_insertCompAtTop")
+        for i, comp in enumerate(self.core.modules):
+            menuItem = self.submenu.addAction(comp.Component.name)
             menuItem.triggered.connect(
-                self.presetManager.clearPreset
+                lambda _, item=i: self.core.insertComponent(
+                    0 if insertCompAtTop else index, item, self
+                )
             )
 
         self.menu.move(parentPosition + QPos)
         self.menu.show()
+
+    def eventFilter(self, object, event):
+        if event.type() == QtCore.QEvent.WindowActivate \
+                or event.type() == QtCore.QEvent.FocusIn:
+            Core.windowHasFocus = True
+        elif event.type() == QtCore.QEvent.WindowDeactivate \
+                or event.type() == QtCore.QEvent.FocusOut:
+                    Core.windowHasFocus = False
+        return False