Merge pull request #25 from gituser12981u2/feature/hot-switch

Implement hot-switching, threading per visualization, and better logging

Author: gituser12981u2

.github/ISSUE_TEMPLATE/feature_request.md

@@ -13,8 +13,5 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
 **Additional context**
 Add any other context or screenshots about the feature request here.

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Install system dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y portaudio19-dev
+        sudo apt-get install -y portaudio19-dev xvfb
 
     - name: Install dependencies
       run: |
@@ -34,4 +34,4 @@ jobs:
 
     - name: Run tests
       run: |
-        python -m unittest discover tests
+        xvfb-run --auto-servernum python -m unittest discover tests

.gitignore

@@ -29,6 +29,7 @@ nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
+debug.log
 
 # PyCharm
 .idea/

README.md

@@ -21,6 +21,8 @@ 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
 ```
 
@@ -52,13 +54,18 @@ Download and install the PortAudio library from [here](https://files.portaudio.c
 
     ```bash
     python3 -m venv .venv
-    source .venv/bin/activate  # On Windows, use '.venv\Scripts\activate'
+    ```
+    ```bash
+    source .venv/bin/activate  
+    # On Windows, use '.venv\Scripts\activate'
     ```
 
 3. Install the dependencies:
 
     ```bash
     pip install -r requirements.txt
+    ```
+    ```bash
     pip install .
     ```
 
@@ -84,20 +91,29 @@ Or to run in horizontal mode:
 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)
+**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
+
+Switch to a different view--mode--while already in a visualization.
+
+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+l': horizontal ltr mode
+-'ctrl+r': horizontal rtl mode
+-'ctrl+v': vertical mode
 
 ### Command Line Options
 
 - `--mode`: Visualization mode('vertical or horizontal). Default is `vertical`. That is if you put no `--mode` option.
-- `--alpha`: Smoothing factor for FFT. Default is `0.2`.
+- `--alpha`: Smoothing factor for FFT. Default is `0.4`.
 - `--chunk`: Number of frames per buffer. Default is `2048`.
 - `--rate`: Sampling rate Default is `44100`.
-- `--bar_count`: Number of bars in the visualization. Default is `75`.
 
 Example:
 
 ```bash
-audio-visualizer --mode horizontal-rtl --alpha 0.3 --chunk 1024 --rate 48000 -bar_count 100
+audio-visualizer --mode horizontal-rtl --alpha 0.3 --chunk 1024 --rate 48000
 ```
 
 ## Windows Specific Instructions
@@ -167,3 +183,8 @@ 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

ROADMAP.md

@@ -1,12 +1,18 @@
 from audio_visualizer.visualizer import AudioVisualizer
+import argparse
 import logging
+import time
 
-logging.basicConfig(level=logging.DEBUG)
+# Configure logging
+logging.basicConfig(level=logging.DEBUG,
+                    format='%(asctime)s - %(levelname)s - %(message)s',
+                    handlers=[
+                        logging.FileHandler("debug.log"),
+                    ])
 
 
 def main():
     """Entry point for the audio visualizer command line interface."""
-    import argparse
 
     parser = argparse.ArgumentParser(description="Terminal Audio Visualizer")
     parser.add_argument(
@@ -33,23 +39,23 @@ def main():
         default=44100,
         help="Sampling rate; default is 44100",
     )
-    parser.add_argument(
-        "--bar_count",
-        type=int,
-        default=75,
-        help="Number of bars in the visualization; default is 75",
-    )
     args = parser.parse_args()
 
     visualizer = AudioVisualizer(
         mode=args.mode,
         alpha=args.alpha,
         chunk=args.chunk,
         rate=args.rate,
-        bar_count=args.bar_count,
     )
     visualizer.start()
 
+    try:
+        while True:
+            time.sleep(1)  # Keep the main thread active
+    except KeyboardInterrupt:
+        visualizer.stop()
+        print("Visualization stopped by user")
+
 
 if __name__ == '__main__':
     main()

audio_visualizer/__init__.py

@@ -12,11 +12,11 @@
 
 
 def visualize_horizontal_left_to_right(
-        stream, chunk, rate, alpha, bar_count, window, smoothed_fft):
+        stream, chunk, rate, alpha, window, smoothed_fft, stop_event):
     # Initialize smoothed FFT with zeros
     smoothed_fft = np.zeros(chunk // 2 + 1)
 
-    while True:
+    while not stop_event.is_set():
         data = stream.read_data()
         if data is None:
             continue
@@ -44,53 +44,3 @@ def visualize_horizontal_left_to_right(
         print('\n'.join(frame_buffer), end='', flush=True)
 
         time.sleep(0.1)  # control frame rate
-
-
-# def visualize_horizontal(
-#         stream, chunk, rate, alpha, bar_count, window, smoothed_fft):
-#     """
-#     Visualizes audio data in a vertical bar chart from bottom to top.
-#     """
-#     rows, cols = os.get_terminal_size()  # Get terminal size dynamically
-#     bar_count = rows  # Assume bar_count should use all available rows
-
-#     while True:
-#         data = stream.read_data()
-#         if data is None:
-#             break
-#         data = np.frombuffer(data, dtype=np.int16)
-#         data = data.reshape(-1, 2).mean(axis=1)  # Average two channels
-
-#         windowed_data = data * window
-#         fft = np.abs(np.fft.fft(windowed_data).real)
-# [:len(windowed_data) // 2]
-
-#         smoothed_fft = alpha * smoothed_fft + (1 - alpha) * fft
-#         max_fft = max(np.max(smoothed_fft), 1)  # Normalize the max value
-
-#         indices = np.logspace(0, np.log10(len(smoothed_fft)),
-#                               num=bar_count + 1,
-#                               endpoint=True, base=10).astype(int)
-#         indices = np.unique(np.clip(indices, 0, len(smoothed_fft) - 1))
-
-#         current_frame = {}
-#         for i in range(len(indices) - 1):
-#             bar_values = smoothed_fft[indices[i]:indices[i + 1]]
-#             bar_value = np.average(bar_values, weights=np.linspace(
-#                 1, 0.1, num=len(bar_values))) if bar_values.size > 0 else 0
-#             num_chars = int((bar_value / max_fft) * cols)
-
-#             for j in range(cols - num_chars, cols):
-#                 current_frame[(i, j)] = '█'
-
-#         frame_buffer = [' ' * rows for _ in range(cols)]
-#         for x in range(cols):  # Iterate over each bar
-#             for y in range(rows):  # Iterate over each character in the bar
-#                 if (x, y) in current_frame:
-#                     frame_buffer[x] = frame_buffer[x][:y] + \
-#                         current_frame[(x, y)] + frame_buffer[x][y+1:]
-
-#         os.system('cls' if os.name == 'nt' else 'clear')
-#         print('\n'.join(frame_buffer), end="", flush=True)
-
-#         time.sleep(0.1)

audio_visualizer/horizontal_left_to_right_visualizer.py

@@ -13,11 +13,11 @@
 
 
 def visualize_horizontal_right_to_left(
-        stream, chunk, rate, alpha, bar_count, window, smoothed_fft):
+        stream, chunk, rate, alpha, window, smoothed_fft, stop_event):
     # Initialize smoothed FFT with zeros
     smoothed_fft = np.zeros(chunk // 2 + 1)
 
-    while True:
+    while not stop_event.is_set():
         data = stream.read_data()
         if data is None:
             continue

audio_visualizer/horizontal_right_to_left_visualizer.py

@@ -12,11 +12,11 @@
 
 
 def visualize_vertical(
-        stream, chunk, rate, alpha, bar_count, window, smoothed_fft):
+        stream, chunk, rate, alpha, window, smoothed_fft, stop_event):
     # Initialize smoothed FFT with zeros
     smoothed_fft = np.zeros(chunk // 2 + 1)
 
-    while True:
+    while not stop_event.is_set():
         data = stream.read_data()
         if data is None:
             continue
@@ -47,7 +47,7 @@ def visualize_vertical(
 
         time.sleep(0.1)  # control frame rate
 
-
+# Old logic
 # def visualize_vertical(
 #         stream, chunk, rate, alpha, bar_count, window, smoothed_fft):
 #     """