audio-mon

Author: edwbaker

CMakeLists.txt

@@ -78,6 +78,11 @@ add_executable(audio_consumer
 )
 target_link_libraries(audio_consumer rt pthread)
 
+add_executable(audio_mon
+    examples/audio_mon.cpp
+)
+target_link_libraries(audio_mon rt pthread)
+
 # GNUInstallDirs for proper FHS-compliant paths
 include(GNUInstallDirs)
 
@@ -87,7 +92,7 @@ install(TARGETS ws-audiod
 )
 
 # Install example executables
-install(TARGETS clip_client audio_consumer
+install(TARGETS clip_client audio_consumer audio_mon
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
 )
 

README.md

@@ -62,16 +62,15 @@ infrastructure without reimplementing low-level ALSA capture and distribution lo
   │  (PCM)        │     └──────────────┘
   └──────┬───────┘
          │
-    ┌────┴────┐
-    ▼         ▼
-┌────────┐ ┌──────────┐
-│  SHM   │ │ TCP/HTTP  │
-│Publisher│ │ Streamer  │
-└────────┘ └──────────┘
-    │           │
-    ▼           ▼
- Consumer    Remote
- processes   clients
+         ▼
+    ┌────────┐
+    │  SHM   │
+    │Publisher│
+    └────────┘
+         │
+         ▼
+      Consumer
+      processes
 ```
 
 ## Building from Source
@@ -183,6 +182,17 @@ Shared memory consumer (zero-copy):
 python3 examples/audio_client.py stream
 ```
 
+### Audio Monitor
+
+`audio_mon` provides a live terminal level meter with gain control:
+
+```bash
+./audio_mon              # connect to default shm
+./audio_mon -s /ws_audiod_samples -S /run/ws-audiod/control.sock
+```
+
+Use **UP/+** and **DOWN/-** to adjust mic boost in 1 dB steps, **q** to quit.
+
 ## Configuration
 
 `/etc/ws/audiod/ws-audiod.conf`:

debian/audio_mon.1

@@ -0,0 +1,39 @@
+.TH AUDIO_MON 1 "March 2026" "1.0.0" "ws-audiod"
+.SH NAME
+audio_mon \- real-time terminal audio monitor for ws\-audiod
+.SH SYNOPSIS
+.B audio_mon
+.RB [ \-s
+.IR shm_name ]
+.RB [ \-S
+.IR socket_path ]
+.RB [ \-h ]
+.SH DESCRIPTION
+.B audio_mon
+reads audio samples from the ws\-audiod shared memory region and displays
+a live per-channel level meter in the terminal. It also allows adjusting the
+daemon's mic boost (gain) via keyboard controls.
+.PP
+Requires the daemon to be running with \fBenable_sample_sharing=true\fR.
+.SH OPTIONS
+.TP
+.BR \-s ", " \-\-shm " " \fINAME\fR
+Shared memory segment name (default: /ws_audiod_samples).
+.TP
+.BR \-S ", " \-\-socket " " \fIPATH\fR
+Control socket path (default: /run/ws\-audiod/control.sock).
+.TP
+.BR \-h ", " \-\-help
+Show usage information and exit.
+.SH KEYBOARD CONTROLS
+.TP
+.BR UP " / " +
+Increase mic boost by 1 dB.
+.TP
+.BR DOWN " / " \-
+Decrease mic boost by 1 dB.
+.TP
+.B q
+Quit.
+.SH AUTHOR
+Ed Baker <ed@ebaker.me.uk>

debian/ws-audiod.manpages

@@ -1,3 +1,4 @@
 debian/ws-audiod.1
 debian/clip_client.1
 debian/audio_consumer.1
+debian/audio_mon.1