Merge pull request #29 from gituser12981u2/feature/lua-config

Added lua-config file for key bindings and audio-visualizer parameters

Author: gituser12981u2

README.md

@@ -93,15 +93,25 @@ audio-visualizer --mode horizontal-ltr
 
 **Note**: there are two horizontal modes. One that draws bars from left to right (ltr) and one that draws bars from right to left (rtl)
 
-### Hotkey mode switcher
+### Configuration File
+
+Modify `config.lua` to change default settings and key bindings. This file controls various aspects of the Audio Visualizer's behavior, including the visual mode, hotkeys, and audio processing parameters.
 
-Switch to a different view--mode--while already in a visualization.
+#### Config File Location
 
-While running a mode, press **'ctrl+l'** to switch to horizontal ltr mode, **'ctrl+r'** to switch to horizontal rtl mode, or **'ctrl+v'** to switch to vertical mode.
+- **Linux/macOS**: Place your `config.lua` in `~/.config/audio_visualizer/`. This is teh recommended location as it follwos the standard configuration directory structure on Unix-like systems.
+- **Windows**: Place your `config.lua` in `%APPDATA%\audio-visualizer\`. This location is recommended for Windows users as it aligns with the typical application data storage.
 
--'ctrl+l': horizontal ltr mode
--'ctrl+r': horizontal rtl mode
--'ctrl+v': vertical mode
+If a `config.lua` file is not found in these locations, the program will attempt to load it from the directory where the `audio-visualizer` command is executed.
+
+### Hotkey mode switcher
+
+Switch visualization modes dynamically with configured hotkeys.
+For example, the default keybindings are:
+
+-'ctrl+h': horizontal ltr mode
+-'ctrl+l': horizontal rtl mode
+-'ctrl+j': vertical mode
 
 ### Command Line Options
 
@@ -127,7 +137,6 @@ On Windows, audio routing can be tricky. If you want to visualize audio from you
 
 This will allow for the program to render the audio that is being outputted on the device as well as continue to have the user be able to hear the same audio.
 
-
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

audio_visualizer/__init__.py

@@ -2,6 +2,10 @@
 import argparse
 import logging
 import time
+import os
+from sys import platform
+from lupa import LuaRuntime
+
 
 # Configure logging
 logging.basicConfig(level=logging.DEBUG,
@@ -11,32 +15,87 @@
                     ])
 
 
+def load_config():
+    """
+    Dynamically loads configuration settings from a Lua file
+    based on the operating system.
+    The function checks common configuration directories on
+    Linux, macOS, and Windows.
+
+    Returns:
+        dict: A dictionary containing configuration settings loaded
+        from the Lua file.
+    """
+    config_filename = "config.lua"
+    paths = []
+    if platform == "linux" or platform == "linux2" or platform == "darwin":
+        # Unix-like systems: look in the user's home directory config folder
+        paths.append(os.path.join(os.getenv("HOME"), ".config",
+                     "audio_visualizer", config_filename))
+    elif platform == "win32":
+        # Windows: look in AppData folder
+        paths.append(os.path.join(os.getenv("APPDATA"),
+                     "audio_visualizer", config_filename))
+
+    # Check the current directory last
+    paths.append(os.path.join(os.getcwd(), config_filename))
+
+    # Try each path in sequence
+    for path in paths:
+        if os.path.exists(path):
+            with open(path, 'r') as file:
+                lua = LuaRuntime(unpack_returned_tuples=True)
+                config_script = file.read()
+                return lua.execute(config_script)
+
+    # If no config file is found, log the error and return default settings
+    logging.warning(f"No configuration file found in expected locations: {
+                    paths}. Using default settings.")
+    return {
+        'key_binds': {
+            'modifier_key': 'ctrl',
+            'keys': {
+                'v': 'vertical',
+                'l': 'horizontal-ltr',
+                'r': 'horizontal-rtl'
+            }
+        },
+        'settings': {
+            'default_mode': 'vertical',
+            'alpha': 0.4,
+            'chunk_size': 2048,
+            'sample_rate': 44100
+        }
+    }
+
+
 def main():
     """Entry point for the audio visualizer command line interface."""
+    config = load_config()
 
     parser = argparse.ArgumentParser(description="Terminal Audio Visualizer")
     parser.add_argument(
         "--mode",
         choices=["vertical", "horizontal-ltr", "horizontal-rtl"],
-        default="vertical",
+        default=config['settings']['default_mode'],
         help="Choose visualization mode: vertical or horizontal",
     )
     parser.add_argument(
         "--alpha",
         type=float,
-        default=0.4,
+        default=config['settings']['alpha'],
         help="Smoothing factor for FFT; default is 0.4.",
     )
     parser.add_argument(
         "--chunk",
         type=int,
-        default=2048,
+        default=config['settings']['chunk_size'],
         help="Number of frames per buffer; default is 2048",
     )
     parser.add_argument(
         "--rate",
         type=int,
-        default=44100,
+        default=config['settings']['sample_rate'],
         help="Sampling rate; default is 44100",
     )
     args = parser.parse_args()
@@ -46,6 +105,7 @@ def main():
         alpha=args.alpha,
         chunk=args.chunk,
         rate=args.rate,
+        config=config['key_binds']
     )
     visualizer.start()
 

audio_visualizer/visualizer.py

@@ -54,7 +54,7 @@ class AudioVisualizer:
         stop_event (Event): Event to signal the thread to stop.
     """
 
-    def __init__(self, mode='vertical', alpha=0.4, chunk=2048, rate=44100):
+    def __init__(self, mode, alpha, chunk, rate, config=None):
         """
         Initializes the AudioVisualizer object with default settings
         for audio streaming.
@@ -64,60 +64,81 @@ def __init__(self, mode='vertical', alpha=0.4, chunk=2048, rate=44100):
             alpha (float, optional): Smoothing factor for visualization.
             chunk (int, optional): Number of audio samples per buffer.
             rate (int, optional): Sampling rate of the audio in Hz.
+            config (dict): Configuration for key bindings and other settings.
         """
         self.mode = mode
         self.alpha = alpha
         self.chunk = chunk
         self.rate = rate
+        self.config = config or {
+            'modifier_key': 'ctrl',  # Default modifier key and default keys
+            'keys': {'j': 'vertical', 'h': 'horizontal-ltr',
+                     'l': 'horizontal-rtl'}
+        }
         self.stream = AudioCapture(
             chunk=self.chunk, rate=self.rate, channels=2)
         self.stream.start_stream()
         self.thread = None
         self.stop_event = Event()
+        self.modifier_pressed = False  # State flag for modifier key
         self.setup_hotkeys()
-        logging.info("Audio Visualizer initialized")
+        logging.info(
+            f"Audio Visualizer initialized with mode: {self.mode}, alpha: {
+                self.alpha}, chunk: {self.chunk}, rate: {self.rate}"
+        )
 
     def setup_hotkeys(self):
         """
         Sets up the keyboard listener
         for hotkeys to change visualization modes.
         """
-        listener = keyboard.Listener(on_press=self.on_key_press)
+        listener = keyboard.Listener(
+            on_press=self.on_key_press, on_release=self.on_key_release)
         listener.start()
         logging.info("Keyboard listener started")
 
     def on_key_press(self, key):
         """
         Handles key press events to change visualization modes based
-        on Ctrl combinations.
+        on on configured keybindings.
 
         Args:
             key (Key): The key that was pressed.
         """
-        # Check if the 'Ctrl' key is pressed
-        if isinstance(key, keyboard.Key):
-            if key == keyboard.Key.ctrl_l or key == keyboard.Key.ctrl_r:
-                self.ctrl_pressed = True
-
-        # Check for the specific character keys while 'Ctrl' is pressed
-        if isinstance(key, keyboard.KeyCode):
-            char = key.char
-            if self.ctrl_pressed and char in ['v', 'l', 'r']:
-                new_mode = {'v': 'vertical', 'l': 'horizontal-ltr',
-                            'r': 'horizontal-rtl'}.get(char)
-                if new_mode and new_mode != self.mode:
-                    self.change_mode(new_mode)
+        try:
+            if isinstance(key, keyboard.Key):
+                modifier_keys = [getattr(keyboard.Key,
+                                         f'{self.config["modifier_key"]}_l'),
+                                 getattr(keyboard.Key,
+                                         f'{self.config["modifier_key"]}_r')]
+                if key in modifier_keys:
+                    self.modifier_pressed = True
+
+            if isinstance(key, keyboard.KeyCode) and self.modifier_pressed:
+                if key.char in self.config['keys']:
+                    logging.debug(f"{key.char} is pressed")
+                    new_mode = self.config['keys'][key.char]
+                    if new_mode and new_mode != self.mode:
+                        self.change_mode(new_mode)
+        except Exception as e:
+            logging.error(f"Error handling key press: {e}")
 
     def on_key_release(self, key):
         """
-        Handles key release events to manage the state of the Ctrl key.
+        Manages the state of the Ctrl key upon its release.
 
         Args:
             key (Key): The key that was released.
         """
-        # Check if the 'Ctrl' key is released
-        if key == keyboard.Key.ctrl_l or key == keyboard.Key.ctrl_r:
-            self.ctrl_pressed = False
+        try:
+            modifier_keys = [getattr(keyboard.Key,
+                                     f'{self.config["modifier_key"]}_l'),
+                             getattr(keyboard.Key,
+                                     f'{self.config["modifier_key"]}_r')]
+            if key in modifier_keys:
+                self.modifier_pressed = False
+        except Exception as e:
+            logging.error(f"Error handling key release: {e}")
 
     def change_mode(self, new_mode):
         """
@@ -126,7 +147,7 @@ def change_mode(self, new_mode):
         Args:
             new_mode (str): The new visualization mode to set.
         """
-        logging.debug(f"Attempting to change mode from {
+        logging.debug(f"Changing mode from {
                       self.mode} to {new_mode}")
         self.mode = new_mode
         self.restart_visualization()

example_config/config.lua

@@ -0,0 +1,28 @@
+return {
+    key_binds = {
+        -- The modifier key used for hotkeys. Possible values are 'ctrl', 'shift', 'alt'.
+        -- Note: On macOS, using 'shift or 'alt' can alter teh character keys.
+        -- For example, 'shift' + 'l' becomes 'L', and 'alt' + 'l' might result in a non-alphanumeric character '¬'.
+        -- Users should adjust the 'keys' bindings accordingly if using 'shift' or 'alt'.
+        modifier_key = 'ctrl',
+
+        -- Defines the hotkeys for switching visualization modes.
+        -- Ensure these keys match the output when combined with the modifier key, especially on macOS.
+        keys = {  -- Hotkeys for mode-switcher (all are inherently prefaced with the 'ctrl' modifier key)
+            j = 'vertical',  -- Hotkey for vertical visualization mode.
+            h = 'horizontal-ltr',  -- Hotkey for horizonta left-to-right mode.
+            l = 'horizontal-rtl'  -- Hotkey for horizontal right-to-left mode.
+        },
+    },
+    settings = {
+        default_mode = 'vertical',  -- The default visualization mode on startup.
+        alpha = 0.4,  -- Smoothing factor for the Fast Fourier Transform (FFT).
+        chunk_size = 2048,  -- Number of audio samples per buffer.
+        sample_rate = 44100  -- Audio sampling rate in Hertz (samples per second).
+    }
+    -- Future settings for theming
+    -- themes = {
+    --     background_color = 'black',
+    --     bar_color = 'white'
+    -- }
+}

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name="audio_visualizer",
-    version="0.1.0",
+    version="0.4.0",
     packages=find_packages(),
     # List of dependencies installed via pip install -e .[dev]
     install_requires=[