Merge pull request #31 from gituser12981u2/v0.4.0

V0.4.0

Author: gituser12981u2

CONTRIBUTING.md

@@ -0,0 +1,113 @@
+## Contributing
+
+Contribution to are welcome! Here's how you can help.
+
+## Getting Started
+
+1. Fork the repository.
+2. Create a new branch(`git checkout -b feature-branch`).
+3. Commit changes(`git commit -am 'Add new feature'`)
+4. Push to the branch(`git push origin feature-branch`)..
+5. Create a new Pull Request.
+
+## Linting and Formatting
+
+Before submitting a pull request, please ensure that any updates adhere to the project's style guidelines:
+
+### Using Flake8 for Linting
+
+- Run flake8 to check for linting issues:
+```bash
+flake8 audio_visualizer tests
+```
+
+- Run autopep8 to format the code to flake8 standards
+
+```bash
+autopep8 --in-place --aggressive --aggressive audio_visualizer tests
+```
+**Note**: that autopep8 doesn't work 100% so some manual formatting may be necessary
+
+### Setting up Pre-Commit Hooks
+
+One can also set up a pre-commit hook to automate these checks:
+
+1. Install pre-commit:
+```bash
+pip install pre-commit
+```
+
+2. Create a .pre-commit-config.yaml file with the following content:
+```yaml
+repos:
+  - repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v1.5.7
+    hooks:
+      - id: autopep8
+        args: [--aggressive, --aggressive]
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+```
+
+3. Install the pre-commit hooks:
+```bash
+pre-commit install
+```
+
+This will ensure that autopep8 and flake8 run automatically before each commit.
+
+## Testing and CI/CD Integration
+
+Please ensure contributions pass the automated tests which can be run locally using the following command:
+
+```bash
+xvfb-run --auto-servernum python -m unittest discover tests
+```
+
+**Note**: xvfb is a linux program and can these tests must be passed on a linux distribution--though this project is for macOS and Windows too, linux is the only one tested due to audio loop back issues with the former.
+
+The continuous integration (CI) process also includes linting with flake8, so check for linting issues before pushing
+
+```bash
+flake8 audio_visualizer tests
+```
+
+For more details on the CI/CD processes, ses the `.github/workflows/ci.yml` file
+
+## Code Style and Documentation
+
+The code must adhere to the Google style for docstring in this codebase. Please ensure that all public classes and functions include doctrings that follow this format:
+
+```python
+class ClassName:
+    """
+    Short description.
+
+    Attributes:
+        attribute1 (type): Description
+        attribute2 (type): Description
+        ...
+    """
+        
+    def Method(args):
+        """
+            method_name: Description
+
+            Args:
+                arg1 (type): Description
+                arg2 (type): Description
+                ...
+
+            Returns:
+                return1 (type): description 
+                return2 (type): description
+        """
+```
+
+## Using the Issue and Feature Templates
+
+For reporting bugs or requesting new features, please use the predefined templates, or use a custom one if your communication does not fit any template. This ensures that all necessary information is provided and helps to address issues and enhancements efficiently.
+

README.md

@@ -6,6 +6,7 @@ A simple, janky, yet charming terminal-based audio visualizer written in Python.
 
 - Visualize audio data in vertical or horizontal bar charts.
 - Adjustable parameters such as smoothing factor, buffer size, sampling rate, and number of bars.
+- Theme support for customizing the visual output.
 - Works on Linux, macOS, and Windows.
 - Works best in VSC terminal, iterm2, kitty, and alacritty.
 
@@ -22,6 +23,7 @@ A simple, janky, yet charming terminal-based audio visualizer written in Python.
 ```bash
 sudo apt-get update
 ```
+
 ```bash
 sudo apt-get install -y portaudio19-dev
 ```
@@ -55,6 +57,7 @@ Download and install the PortAudio library from [here](https://files.portaudio.c
     ```bash
     python3 -m venv .venv
     ```
+
     ```bash
     source .venv/bin/activate  
     # On Windows, use '.venv\Scripts\activate'
@@ -65,6 +68,7 @@ Download and install the PortAudio library from [here](https://files.portaudio.c
     ```bash
     pip install -r requirements.txt
     ```
+
     ```bash
     pip install .
     ```
@@ -93,15 +97,32 @@ 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)
 
+### 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.
+
+#### Config File Location
+
+- **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.
+
+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 to a different view--mode--while already in a visualization.
+Switch visualization modes dynamically with configured hotkeys.
+For example, the default keybindings are:
 
-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.
+- 'ctrl+h': horizontal ltr mode
+- 'ctrl+l': horizontal rtl mode
+- 'ctrl+j': vertical mode
 
--'ctrl+l': horizontal ltr mode
--'ctrl+r': horizontal rtl mode
--'ctrl+v': vertical mode
+### Themes
+
+Themes allow you to customize the visual appearance of the audio visualizer:
+
+- **background_color**: Set to a 'RGB' value like '255;0;0' for red, or 'default to use the terminal's default color.
+- **bar_color**: Set to a 'RGB' value or 'default' to use the terminal's default color.
 
 ### Command Line Options
 
@@ -127,64 +148,12 @@ 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.
 
-## Contributing
-
-1. Fork the repository.
-2. Create a new branch(`git checkout -b feature-branch`).
-3. Commit your changes(`git commit -am 'Add new feature'`)
-4. Push to the branch(`git push origin feature-branch`)..
-5. Create a new Pull Request.
-
-### Linting and Formatting
-
-Please ensure that any updates adhere to the project's style guidelines before committing.
-
-- Run flake8 to check for linting issues:
-```bash
-flake8 audio_visualizer tests audio_capture.py horizontal_visualizer.py vertical_visualizer.py visualizer.py
-```
-
-- Run autopep8 to format the code to flake8 standards
-    - Note that autopep8 doesn't work 100% so some manual formatting may be necessary
-
-```bash
-autopep8 --in-place --aggressive --aggressive audio_visualizer tests audio_capture.py horizontal_visualizer.py vertical_visualizer.py visualizer.py
-```
-
-One can also set up a pre-commit hook to automate these checks:
-
-1. Install pre-commit:
-```bash
-pip install pre-commit
-```
-
-2. Create a .pre-commit-config.yaml file with the following content:
-```yaml
-repos:
-  - repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.5.7
-    hooks:
-      - id: autopep8
-        args: [--aggressive, --aggressive]
-
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.2
-    hooks:
-      - id: flake8
-```
-
-3. Install the pre-commit hooks:
-```bash
-pre-commit install
-```
-
-This will ensure that autopep8 and flake8 run automatically before each commit.
-
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
 ## Contributors
+
 Thank you to the follow people for their contributions to this project:
 
--[@ohksith](https://github.com/ohksith) - Provided fix for the terminal to clean it self after visualization stopped
+-[@ohksith](https://github.com/ohksith) - Provided fix for the terminal to clean it self after visualization stopped

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,91 @@
                     ])
 
 
+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
+        },
+        'themes': {
+            'background_color': 'default',  # RGB for black
+            'bar_color': 'default'  # RGB for white
+        }
+    }
+
+
 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 +109,8 @@ def main():
         alpha=args.alpha,
         chunk=args.chunk,
         rate=args.rate,
+        config=config['key_binds'],
+        theme=config['themes']
     )
     visualizer.start()