v2.2.4 - Quiet FFmpeg; add "invert" option to Classic Vis; fix CLI parsing for Image component (#96)

* change noisiness of terminal output
ffmpeg no longer prints everything into the terminal unless we're in `--verbose` mode. percentage progress text stays on one line while not in verbose mode.

* Added hint to run `avp --verbose` if `avp --log` is run with no avp_debug.log file present

* Classic Visualizer: add invert option

* Image component: fix path commandline option

* Image component: restrict file formats in CLI to match GUI

* Color component: add tooltip to color2 picker (second color of gradients)

* change tests to work with pytest-xdist
avp core stores its config (location of `settings.ini`) in temp directories if using multiple workers to run tests, so they don't interfere with each other. when using a single worker, the `tests/data/config` directory is still used

* check alt comp names when parsing cmdline

* rename `original.py` to `classic.py`

* move `component.py` into subpackage

* rename comp_original to comp_classic

* show traceback if renderFrame() raises exception

* do not try to insert non-existent components from project files

* add "composite" property for components
if a component returns "composite" then it will receive a frame to draw on during calls to previewRender and frameRender

* more tests of projects, actions, waveform, spectrum, image, color, classic

* do not change presetDir to "projects" within PresetManager

Author: tassaron

.gitignore

@@ -10,6 +10,7 @@ prof/
 .env/
 .vscode/
 tests/data/config/log/
+tests/data/config/presets/
 tests/data/config/settings.ini
 tests/data/config/autosave.avp
 *.mkv

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "uv_build"
 name = "audio-visualizer-python"
 description = "Create audio visualization videos from a GUI or commandline"
 readme = "README.md"
-version = "2.2.3"
+version = "2.2.4"
 requires-python = ">= 3.12"
 license = "MIT"
 classifiers=[

src/avp/__init__.py

@@ -3,7 +3,7 @@
 import logging
 
 
-__version__ = "2.2.3"
+__version__ = "2.2.4"
 
 
 class Logger(logging.getLoggerClass()):

src/avp/cli.py

@@ -40,10 +40,8 @@ def main() -> int:
     screen = app.primaryScreen()
     if screen is None:
         dpi = None
-        log.error("Could not detect DPI")
     else:
         dpi = screen.physicalDotsPerInchX()
-        log.info("Detected screen DPI: %s", dpi)
 
     # Launch program
     if mode == "commandline":
@@ -53,6 +51,8 @@ def main() -> int:
         mode = main.parseArgs()
         log.debug("Finished creating command object")
 
+    log.info(f"QApplication Platform: {QApplication.platformName()}")
+    log.info(f"Detected screen DPI: {dpi}")
     # Both branches here may occur in one execution:
     # Commandline parsing could change mode back to GUI
     if mode == "GUI":

src/avp/command.py

@@ -14,7 +14,8 @@
 import shutil
 import logging
 
-from . import core, __version__
+from . import __version__
+from .core import Core
 
 
 log = logging.getLogger("AVP.Commandline")
@@ -29,11 +30,11 @@ class Command(QtCore.QObject):
 
     def __init__(self):
         super().__init__()
-        self.core = core.Core()
-        core.Core.mode = "commandline"
+        self.core = Core()
+        Core.mode = "commandline"
         self.dataDir = self.core.dataDir
         self.canceled = False
-        self.settings = core.Core.settings
+        self.settings = Core.settings
 
         # ctrl-c stops the export thread
         signal.signal(signal.SIGINT, self.stopVideo)
@@ -71,9 +72,10 @@ def parseArgs(self):
             help="copy and shorten recent log files into ~/avp_log.txt",
         )
         debugCommands.add_argument(
-            "--verbose", "-v",
+            "--verbose",
+            "-v",
             action="store_true",
-            help="create bigger logfiles while program is running",
+            help="send log messages and ffmpeg output to stdout, and create more verbose log files (good to use before --log)",
         )
 
         # project/GUI options
@@ -101,8 +103,8 @@ def parseArgs(self):
         args = parser.parse_args()
 
         if args.verbose:
-            core.STDOUT_LOGLVL = logging.DEBUG
-            core.Core.makeLogger(deleteOldLogs=False, fileLogLvl=logging.DEBUG)
+            Core.stdoutLogLvl = logging.DEBUG
+            Core.makeLogger(deleteOldLogs=False, fileLogLvl=logging.DEBUG)
 
         if args.log:
             self.createLogFile()
@@ -168,7 +170,7 @@ def parseArgs(self):
             return "commandline"
 
         elif args.no_preview:
-            core.Core.previewEnabled = False
+            Core.previewEnabled = False
 
         elif (
             args.projpath is None
@@ -203,27 +205,26 @@ def stopVideo(self, *args):
 
     @QtCore.pyqtSlot(str)
     def progressBarSetText(self, value):
-        if "Export " in value:
-            # Don't duplicate completion/failure messages
+        if "Export " in value or time.time() - self.lastProgressUpdate < 0.1:
+            # Don't duplicate completion/failure messages or send too many messages
             return
-        if (
-            not value.startswith("Exporting")
-            and time.time() - self.lastProgressUpdate >= 0.05
-        ):
+
+        if not value.endswith("%"):
             # Show most messages very often
             print(value)
-        elif time.time() - self.lastProgressUpdate >= 2.0:
-            # Give user time to read ffmpeg's output during the export
-            print("##### %s" % value)
-        else:
-            return
+        elif log.getEffectiveLevel() > logging.INFO:
+            # if ffmpeg isn't printing export progress for us,
+            # then overwrite previous message with the next one
+            # if this text is our main export progress
+            print(f"{value}\r", end="")
         self.lastProgressUpdate = time.time()
 
     @QtCore.pyqtSlot()
     def videoCreated(self):
         self.quit(0)
 
     def quit(self, code):
+        print()
         quit(code)
 
     def showMessage(self, **kwargs):
@@ -242,12 +243,14 @@ def drawPreview(self, *args):
 
     def parseCompName(self, name):
         """Deduces a proper component name out of a commandline arg"""
-
         if name.title() in self.core.compNames:
             return name.title()
         for compName in self.core.compNames:
             if name.capitalize() in compName:
                 return compName
+        for altName, moduleIndex in self.core.altCompNames:
+            if name.title() in altName:
+                return self.core.compNames[moduleIndex]
 
         compFileNames = [
             os.path.splitext(os.path.basename(mod.__file__))[0]
@@ -281,16 +284,17 @@ def getFilename():
             print("Log file could not be created (too many exist).")
             return
         try:
-            shutil.copy(os.path.join(core.Core.logDir, "avp_debug.log"), filename)
+            shutil.copy(os.path.join(Core.logDir, "avp_debug.log"), filename)
             with open(filename, "a") as f:
                 f.write(f"{'='*60} debug log ends {'='*60}\n")
         except FileNotFoundError:
+            print("No debug log was found. Run `avp --verbose` before `avp --log`.")
             with open(filename, "w") as f:
                 f.write(f"{'='*60} no debug log {'='*60}\n")
 
         def concatenateLogs(logPattern):
             nonlocal filename
-            renderLogs = glob.glob(os.path.join(core.Core.logDir, logPattern))
+            renderLogs = glob.glob(os.path.join(Core.logDir, logPattern))
             with open(filename, "a") as fw:
                 for renderLog in renderLogs:
                     with open(renderLog, "r") as fr:

src/avp/components/original.py src/avp/components/classic.pysrc/avp/components/original.py renamed to src/avp/components/classic.py

@@ -1,21 +1,23 @@
 import numpy
 from PIL import Image, ImageDraw
-from copy import copy
 
-from ..component import Component
-from ..toolkit.frame import BlankFrame
+from ..libcomponent import BaseComponent
+from ..toolkit.frame import BlankFrame, FloodFrame
 from ..toolkit.visualizer import createSpectrumArray
 
 
-class Component(Component):
+class Component(BaseComponent):
     name = "Classic Visualizer"
-    version = "1.1.0"
+    version = "1.2.0"
 
     def names(*args):
-        return ["Original Audio Visualization"]
+        return ["Original"]
 
     def properties(self):
-        return ["pcm"]
+        props = ["pcm"]
+        if self.invert:
+            props.append("composite")
+        return props
 
     def widget(self, *args):
         self.scale = 20
@@ -37,6 +39,7 @@ def widget(self, *args):
                 "y": self.page.spinBox_y,
                 "smooth": self.page.spinBox_sensitivity,
                 "bars": self.page.spinBox_bars,
+                "invert": self.page.checkBox_invert,
             },
             colorWidgets={
                 "visColor": self.page.pushButton_visColor,
@@ -46,14 +49,19 @@ def widget(self, *args):
             ],
         )
 
-    def previewRender(self):
+    def previewRender(self, frame=None):
         spectrum = numpy.fromfunction(
             lambda x: float(self.scale) / 2500 * (x - 128) ** 2,
             (255,),
             dtype="int16",
         )
         return self.drawBars(
-            self.width, self.height, spectrum, self.visColor, self.layout
+            self.width,
+            self.height,
+            spectrum,
+            self.visColor,
+            self.layout,
+            frame,
         )
 
     def preFrameRender(self, **kwargs):
@@ -71,17 +79,18 @@ def preFrameRender(self, **kwargs):
             self.progressBarSetText,
         )
 
-    def frameRender(self, frameNo):
+    def frameRender(self, frameNo, frame=None):
         arrayNo = frameNo * self.sampleSize
         return self.drawBars(
             self.width,
             self.height,
             self.spectrumArray[arrayNo],
             self.visColor,
             self.layout,
+            frame,
         )
 
-    def drawBars(self, width, height, spectrum, color, layout):
+    def drawBars(self, width, height, spectrum, color, layout, frame):
         bigYCoord = height - height / 8
         smallYCoord = height / 1200
         bigXCoord = width / (self.bars + 1)
@@ -94,32 +103,44 @@ def drawBars(self, width, height, spectrum, color, layout):
         color2 = (r, g, b, 125)
 
         for i in range(self.bars):
-            x0 = middleXCoord + i * bigXCoord
-            y0 = bigYCoord + smallXCoord
-            y1 = bigYCoord + smallXCoord - spectrum[i * 4] * smallYCoord - middleXCoord
-            x1 = middleXCoord + i * bigXCoord + bigXCoord
-            draw.rectangle(
-                (
+            # draw outline behind rectangles if not inverted
+            if frame is None:
+                x0 = middleXCoord + i * bigXCoord
+                y0 = bigYCoord + smallXCoord
+                x1 = middleXCoord + i * bigXCoord + bigXCoord
+                y1 = (
+                    bigYCoord
+                    + smallXCoord
+                    - spectrum[i * 4] * smallYCoord
+                    - middleXCoord
+                )
+                selection = (
                     x0,
                     y0 if y0 < y1 else y1,
                     x1 if x1 > x0 else x0,
                     y1 if y0 < y1 else y0,
-                ),
-                fill=color2,
-            )
+                )
+                draw.rectangle(
+                    selection,
+                    fill=color2,
+                )
 
             x0 = middleXCoord + smallXCoord + i * bigXCoord
             y0 = bigYCoord
             x1 = middleXCoord + smallXCoord + i * bigXCoord + middleXCoord
             y1 = bigYCoord - spectrum[i * 4] * smallYCoord
+            selection = (
+                x0,
+                y0 if y0 < y1 else y1,
+                x1 if x1 > x0 else x0,
+                y1 if y0 < y1 else y0,
+            )
+            # fill rectangle if not inverted
             draw.rectangle(
-                (
-                    x0,
-                    y0 if y0 < y1 else y1,
-                    x1 if x1 > x0 else x0,
-                    y1 if y0 < y1 else y0,
-                ),
-                fill=color,
+                selection,
+                fill=color if frame is None else (0, 0, 0, 0),
+                outline=color,
+                width=int(x1 - x0),
             )
 
         imBottom = imTop.transpose(Image.Transpose.FLIP_TOP_BOTTOM)
@@ -146,7 +167,11 @@ def drawBars(self, width, height, spectrum, color, layout):
             y = self.y - int(height / 100 * 10)
             im.paste(imBottom, (0, y), mask=imBottom)
 
-        return im
+        if frame is None:
+            return im
+        f = FloodFrame(width, height, color)
+        f.paste(frame, (0, 0), mask=im)
+        return f
 
     def command(self, arg):
         if "=" in arg:

src/avp/components/original.ui src/avp/components/classic.uisrc/avp/components/original.ui renamed to src/avp/components/classic.ui

@@ -86,7 +86,7 @@
      <item>
       <widget class="QLineEdit" name="lineEdit_visColor">
        <property name="text">
-        <string></string>
+        <string/>
        </property>
       </widget>
      </item>
@@ -232,6 +232,13 @@
        </property>
       </widget>
      </item>
+     <item>
+      <widget class="QCheckBox" name="checkBox_invert">
+       <property name="text">
+        <string>Invert</string>
+       </property>
+      </widget>
+     </item>
      <item>
       <spacer name="horizontalSpacer">
        <property name="orientation">

src/avp/components/color.py

@@ -1,14 +1,14 @@
 from PyQt6 import QtGui
 import logging
 
-from ..component import Component
+from ..libcomponent import BaseComponent
 from ..toolkit.frame import BlankFrame, FloodFrame, FramePainter
 
 
 log = logging.getLogger("AVP.Components.Color")
 
 
-class Component(Component):
+class Component(BaseComponent):
     name = "Color"
     version = "1.0.0"
 

src/avp/components/color.ui

@@ -124,6 +124,9 @@
            <height>32</height>
           </size>
          </property>
+         <property name="toolTip">
+          <string>End color of gradient. Disabled if fill is solid.</string>
+         </property>
          <property name="text">
           <string/>
          </property>