Merge pull request #30 from gituser12981u2/feature/themes-for-background-and-bars

add theming to background and bars

Author: gituser12981u2

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 .
     ```
@@ -109,9 +113,16 @@ If a `config.lua` file is not found in these locations, the program will attempt
 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
+- 'ctrl+h': horizontal ltr mode
+- 'ctrl+l': horizontal rtl mode
+- 'ctrl+j': 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
 
@@ -142,6 +153,7 @@ This will allow for the program to render the audio that is being outputted on t
 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

@@ -65,6 +65,10 @@ def load_config():
             'alpha': 0.4,
             'chunk_size': 2048,
             'sample_rate': 44100
+        },
+        'themes': {
+            'background_color': 'default',  # RGB for black
+            'bar_color': 'default'  # RGB for white
         }
     }
 
@@ -105,7 +109,8 @@ def main():
         alpha=args.alpha,
         chunk=args.chunk,
         rate=args.rate,
-        config=config['key_binds']
+        config=config['key_binds'],
+        theme=config['themes']
     )
     visualizer.start()
 

audio_visualizer/horizontal_left_to_right_visualizer.py

@@ -11,7 +11,8 @@
 
 
 def visualize_horizontal_left_to_right(
-        stream, chunk, rate, alpha, window, smoothed_fft, stop_event):
+    stream, chunk, rate, alpha, window, smoothed_fft,
+        stop_event, theme=None):
     """
     Visualizes audio data in a horizontal left-to-right bar chart.
 
@@ -22,7 +23,8 @@ def visualize_horizontal_left_to_right(
         alpha (float): Smoothing factor for the visualization.
         window (np.array): Window function to apply the audio data.
         smoothed_fft (np.array): Array to store the smoothed FFT values.
-        stop_event (Event): Event to signal when teh visualization should stop.
+        stop_event (Event): Event to signal when the visualization should stop
+        theme (dict, optional): Contains color settings.
     """
     # Initialize smoothed FFT with zeros
     smoothed_fft = np.zeros(chunk // 2 + 1)
@@ -47,11 +49,29 @@ def visualize_horizontal_left_to_right(
         scaled_fft = np.int16((smoothed_fft / max_fft) * cols)
 
         frame_buffer = [' ' * cols for _ in range(rows)]
+
+        # Clear the terminal
+        os.system('cls' if os.name == 'nt' else 'clear')
+
+        if theme:
+            if 'background_color' in theme and (
+                    theme['background_color'] != 'default'):
+                bg_color = tuple(
+                    map(int, theme['background_color'].split(';')))
+                # Set background color
+                print(f"\033[48;2;{bg_color[0]};{
+                    bg_color[1]};{bg_color[2]}m", end='')
+
+            if 'bar_color' in theme and theme['bar_color'] != 'default':
+                bar_color = tuple(map(int, theme['bar_color'].split(';')))
+                # set bar color
+                print(f"\033[38;2;{
+                    bar_color[0]};{bar_color[1]};{bar_color[2]}m", end='')
+
         for row in range(min(rows, len(scaled_fft))):
             bar_width = scaled_fft[row]
             frame_buffer[row] = '█' * bar_width + ' ' * (cols - bar_width)
 
-        os.system('cls' if os.name == 'nt' else 'clear')
-        print('\n'.join(frame_buffer), end='', flush=True)
+        print('\n'.join(frame_buffer), end='\033[0m', flush=True)
 
         time.sleep(0.1)  # control frame rate

audio_visualizer/horizontal_right_to_left_visualizer.py

@@ -11,7 +11,8 @@
 
 
 def visualize_horizontal_right_to_left(
-        stream, chunk, rate, alpha, window, smoothed_fft, stop_event):
+    stream, chunk, rate, alpha, window, smoothed_fft,
+        stop_event, theme=None):
     """
     Visualizes audio data in a horizontal right-to-left bar chart.
 
@@ -22,7 +23,8 @@ def visualize_horizontal_right_to_left(
         alpha (float): Smoothing factor for the visualization.
         window (np.array): Window function to apply the audio data.
         smoothed_fft (np.array): Array to store the smoothed FFT values.
-        stop_event (Event): Event to signal when teh visualization should stop.
+        stop_event (Event): Event to signal when the visualization should stop.
+        theme (dict, optional): Contains color settings.
     """
     # Initialize smoothed FFT with zeros
     smoothed_fft = np.zeros(chunk // 2 + 1)
@@ -47,11 +49,29 @@ def visualize_horizontal_right_to_left(
         scaled_fft = np.int16((smoothed_fft / max_fft) * cols)
 
         frame_buffer = [' ' * cols for _ in range(rows)]
+
+        # Clear the terminal
+        os.system('cls' if os.name == 'nt' else 'clear')
+
+        if theme:
+            if 'background_color' in theme and (
+                    theme['background_color'] != 'default'):
+                bg_color = tuple(
+                    map(int, theme['background_color'].split(';')))
+                # Set background color
+                print(f"\033[48;2;{bg_color[0]};{
+                    bg_color[1]};{bg_color[2]}m", end='')
+
+            if 'bar_color' in theme and theme['bar_color'] != 'default':
+                bar_color = tuple(map(int, theme['bar_color'].split(';')))
+                # set bar color
+                print(f"\033[38;2;{
+                    bar_color[0]};{bar_color[1]};{bar_color[2]}m", end='')
+
         for row in range(min(rows, len(scaled_fft))):
             bar_width = scaled_fft[row]
             frame_buffer[row] = ' ' * (cols - bar_width) + '█' * bar_width
 
-        os.system('cls' if os.name == 'nt' else 'clear')
-        print('\n'.join(frame_buffer), end='', flush=True)
+        print('\n'.join(frame_buffer), end='\033[0m', flush=True)
 
         time.sleep(0.1)  # control frame rate

audio_visualizer/vertical_visualizer.py

@@ -10,7 +10,8 @@
 
 
 def visualize_vertical(
-        stream, chunk, rate, alpha, window, smoothed_fft, stop_event):
+    stream, chunk, rate, alpha, window, smoothed_fft,
+        stop_event, theme=None):
     """
     Visualizes audio data in a horizontal vertical bar chart.
 
@@ -21,7 +22,8 @@ def visualize_vertical(
         alpha (float): Smoothing factor for the visualization.
         window (np.array): Window function to apply the audio data.
         smoothed_fft (np.array): Array to store the smoothed FFT values.
-        stop_event (Event): Event to signal when teh visualization should stop.
+        stop_event (Event): Event to signal when the visualization should stop.
+        theme (dict, optional): Contains color settings.
     """
     # Initialize smoothed FFT with zeros
     smoothed_fft = np.zeros(chunk // 2 + 1)
@@ -46,14 +48,32 @@ def visualize_vertical(
         scaled_fft = np.int16((smoothed_fft / max_fft) * rows)
 
         frame_buffer = [' ' * cols for _ in range(rows)]
+
+        # Clear the terminal
+        os.system('cls' if os.name == 'nt' else 'clear')
+
+        if theme:
+            if 'background_color' in theme and (
+                    theme['background_color'] != 'default'):
+                bg_color = tuple(
+                    map(int, theme['background_color'].split(';')))
+                # Set background color
+                print(f"\033[48;2;{bg_color[0]};{
+                    bg_color[1]};{bg_color[2]}m", end='')
+
+            if 'bar_color' in theme and theme['bar_color'] != 'default':
+                bar_color = tuple(map(int, theme['bar_color'].split(';')))
+                # set bar color
+                print(f"\033[38;2;{
+                    bar_color[0]};{bar_color[1]};{bar_color[2]}m", end='')
+
         for col in range(min(cols, len(scaled_fft))):
             bar_height = scaled_fft[col]
             for row in range(rows - bar_height, rows):
                 frame_buffer[row] = frame_buffer[row][:col] + \
                     '█' + frame_buffer[row][col+1:]
 
-        os.system('cls' if os.name == 'nt' else 'clear')
-        print('\n'.join(frame_buffer), end='', flush=True)
+        print('\n'.join(frame_buffer), end='\033[0m', flush=True)
 
         time.sleep(0.1)  # control frame rate
 

audio_visualizer/visualizer.py

@@ -54,7 +54,7 @@ class AudioVisualizer:
         stop_event (Event): Event to signal the thread to stop.
     """
 
-    def __init__(self, mode, alpha, chunk, rate, config=None):
+    def __init__(self, mode, alpha, chunk, rate, config=None, theme=None):
         """
         Initializes the AudioVisualizer object with default settings
         for audio streaming.
@@ -75,6 +75,7 @@ def __init__(self, mode, alpha, chunk, rate, config=None):
             'keys': {'j': 'vertical', 'h': 'horizontal-ltr',
                      'l': 'horizontal-rtl'}
         }
+        self.theme = theme or None
         self.stream = AudioCapture(
             chunk=self.chunk, rate=self.rate, channels=2)
         self.stream.start_stream()
@@ -168,7 +169,7 @@ def run_visualization(self):
             visualize = get_visualization_function(self.mode)
             visualize(self.stream, self.chunk, self.rate, self.alpha,
                       np.hamming(self.chunk), np.zeros(self.chunk // 2),
-                      self.stop_event)
+                      self.stop_event, self.theme)
         except Exception as e:
             logging.error(f"Error during visualization: {e}")
 

example_config/config.lua

@@ -19,10 +19,12 @@ return {
         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).
+    },
+    themes = {
+        -- Theme settings for the visualization background and bar colors.
+        -- Specify colors in 'RGB' format separated by semicolons (e.g., '255;0;0' for red).
+        -- Use 'default' to utilize the terminal's default color settings.
+        background_color = 'default',  -- Background color of the visualization.
+        bar_color = 'default'  -- Color of the visualization bars.
     }
-    -- Future settings for theming
-    -- themes = {
-    --     background_color = 'black',
-    --     bar_color = 'white'
-    -- }
 }