Updated the Audio test scripts to include support for PulseAudio and PipeWire

Signed-off-by: Teja Swaroop Moida <[email protected]>

Author: tmoida

Runner/suites/Multimedia/Audio/AudioPlayback/Read_me.md

@@ -6,16 +6,20 @@ This script automates the validation of audio playback capabilities on the Qualc
 
 ## Features
 
-- Decoding PCM clip
-- Compatible with Yocto-based root filesystem
+- Plays a test audio clip using either `paplay` or `pw-play`
+- Supports configurable playback volume, timeout, and loop count
+- Automatically downloads and extracts audio clip if not present
+- Captures kernel logs before and after playback
+- Scans dmesg logs for audio-related errors
+- Validates presence of required daemons and binaries
 
 ## Prerequisites
 
 Ensure the following components are present in the target Yocto build:
 
 - `paplay` binary (for PulseAudio)
-- `pw-play` binary (for PipeWire)
-- `pgrep`, `grep`, `timeout` utilities
+- `pw-play`, `pgrep`, `timeout`, `grep` (for PipeWire)
+- `pulseaudio` or `pipewire` daemon must be running depending on backend
 
 ## Directory Structure
 
@@ -53,20 +57,31 @@ cd <Path in device>/Runner
 AUDIO_BACKEND=pulseaudio ./run-test.sh AudioPlayback
 **Run with PipeWire**
 AUDIO_BACKEND=pipewire ./run-test.sh AudioPlayback
+
+Environment Variables:
+You can customize playback behavior using the following environment variables:
+AUDIO_BACKEND: Selects the audio backend (pulseaudio or pipewire). Default is pulseaudio.
+PLAYBACK_TIMEOUT: Timeout duration for playback (e.g., 15s). Default is 15s.
+PLAYBACK_LOOPS: Number of times to repeat playback. Default is 1.
+PLAYBACK_VOLUME: Playback volume.
+For paplay: Range is 0–65536 (default: 65536)
+For pw-play: Range is 0.0–1.0 (default: 1.0)
 ```
 Sample Output:
 ```
-[Executing test case: AudioPlayback] 2025-05-28 19:01:59 -
-[INFO] 2025-05-28 19:01:59 - ------------------------------------------------------------
-[INFO] 2025-05-28 19:01:59 - ------------------- Starting AudioPlayback Testcase ------------
-[INFO] 2025-05-28 19:01:59 - Using audio backend: pipewire
-[INFO] 2025-05-28 19:01:59 - Checking if dependency binary is available
-[INFO] 2025-05-28 19:01:59 - Playback clip present: AudioClips/yesterday_48KHz.wav
-[PASS] 2025-05-28 19:02:14 - Playback completed or timed out (ret=124) as expected.
-[PASS] 2025-05-28 19:02:14 - AudioPlayback : Test Passed
-[INFO] 2025-05-28 19:02:14 - See results/audioplayback/playback_stdout.log, dmesg_before/after.log for debug details
-[INFO] 2025-05-28 19:02:14 - ------------------- Completed AudioPlayback Testcase -------------
-[PASS] 2025-05-28 19:02:14 - AudioPlayback passed
+sh-5.2# AUDIO_BACKEND=pipewire ./run-test.sh AudioPlayback
+[Executing test case: AudioPlayback] 2025-08-14 10:17:35 -
+[INFO] 2025-08-14 10:17:35 - ------------------------------------------------------------
+[INFO] 2025-08-14 10:17:35 - ------------------- Starting AudioPlayback Testcase ------------
+[INFO] 2025-08-14 10:17:35 - Using audio backend: pipewire
+[INFO] 2025-08-14 10:17:35 - Checking if dependency binary is available
+[INFO] 2025-08-14 10:17:35 - Playback clip present: AudioClips/yesterday_48KHz.wav
+[INFO] 2025-08-14 10:17:51 - Scanning dmesg for audio: errors & success patterns
+[INFO] 2025-08-14 10:17:51 - No audio-related errors found (no OK pattern requested)
+[PASS] 2025-08-14 10:17:51 - Playback completed or timed out (ret=124) as expected.
+[PASS] 2025-08-14 10:17:51 - AudioPlayback : Test Passed
+[PASS] 2025-08-14 10:17:51 - AudioPlayback passed
+[INFO] 2025-08-14 10:17:51 - ========== Test Summary ==========
 ```
 3. Results will be available in the `Runner/suites/Multimedia/Audio/AudioPlayback/AudioPlayback.res` directory.
 

Runner/suites/Multimedia/Audio/AudioPlayback/run.sh

@@ -38,14 +38,28 @@ RESULT_FILE="$TESTNAME.res"
 # Determine backend and binary
 AUDIO_BACKEND="${AUDIO_BACKEND:-pulseaudio}"  # Default to pulseaudio if not set
 
+# PLAYBACK_VOLUME: 0-65536 for paplay, 0.0-1.0 for pw-play
+# PLAYBACK_TIMEOUT: seconds (default: 15)
+# PLAYBACK_LOOPS: number of times to repeat playback
+PLAYBACK_TIMEOUT="${PLAYBACK_TIMEOUT:-15s}"
+PLAYBACK_LOOPS="${PLAYBACK_LOOPS:-1}"														  
+# Set default volume based on backend
+# paplay volume range: 0–65536
+# pw-play volume range: 0.0–1.0
+if [ "$AUDIO_BACKEND" = "pulseaudio" ]; then
+    PLAYBACK_VOLUME="${PLAYBACK_VOLUME:-65536}"
+elif [ "$AUDIO_BACKEND" = "pipewire" ]; then
+    PLAYBACK_VOLUME="${PLAYBACK_VOLUME:-1.0}"
+fi
+										  
 case "$AUDIO_BACKEND" in
     pulseaudio)
         TESTBINARY="paplay"
-        PLAY_CMD="paplay \"$PLAYBACK_CLIP\" -d \"$AUDIO_DEVICE\""
+        PLAY_CMD="paplay --volume=$PLAYBACK_VOLUME  \"$PLAYBACK_CLIP\" -d \"$AUDIO_DEVICE\""
         ;;
     pipewire)
         TESTBINARY="pw-play"
-        PLAY_CMD="pw-play \"$PLAYBACK_CLIP\""
+        PLAY_CMD="pw-play --volume=$PLAYBACK_VOLUME  \"$PLAYBACK_CLIP\""
         ;;
     *)
         log_fail "Invalid AUDIO_BACKEND specified: $AUDIO_BACKEND. Use 'pulseaudio' or 'pipewire'."
@@ -64,6 +78,15 @@ log_info "------------------------------------------------------------"
 log_info "------------------- Starting $TESTNAME Testcase ------------"
 log_info "Using audio backend: $AUDIO_BACKEND"
 
+# Daemon check
+if [ "$AUDIO_BACKEND" = "pulseaudio" ]; then
+  if ! pgrep pulseaudio > /dev/null && ! pgrep pipewire-pulse > /dev/null; then
+    log_skip_exit "$TESTNAME" "Neither PulseAudio nor pipewire-pulse daemon is running"
+  fi
+elif [ "$AUDIO_BACKEND" = "pipewire" ]; then
+  pgrep pipewire > /dev/null || log_skip_exit "$TESTNAME" "PipeWire daemon not running"
+fi
+	  
 log_info "Checking if dependency binary is available"
 check_dependencies "$TESTBINARY" pgrep grep timeout
 # Download/extract audio if not present
@@ -83,13 +106,19 @@ if [ ! -f "$PLAYBACK_CLIP" ]; then
 fi
 
 log_info "Playback clip present: $PLAYBACK_CLIP"
+
 # --- Capture logs BEFORE playback (for debugging) ---
-dmesg > "$LOGDIR/dmesg_before.log"
+get_kernel_log > "$LOGDIR/dmesg_before.log"
+
 # --- Start the Playback, capture output ---
-eval "timeout 15s $PLAY_CMD" > "$LOGDIR/playback_stdout.log" 2>&1
+for i in $(seq 1 "$PLAYBACK_LOOPS"); do
+   timeout "$PLAYBACK_TIMEOUT" sh -c "$PLAY_CMD" >> "$LOGDIR/playback_stdout.log" 2>&1
+done
 ret=$?
+
 # --- Capture logs AFTER playback (for debugging) ---
-dmesg > "$LOGDIR/dmesg_after.log"
+get_kernel_log > "$LOGDIR/dmesg_after.log"
+scan_dmesg_errors "audio" "$LOGDIR"
 
 if [ "$ret" -eq 0 ] || [ "$ret" -eq 124 ]; then
     log_pass "Playback completed or timed out (ret=$ret) as expected."

Runner/suites/Multimedia/Audio/AudioRecord/Read_me.md

@@ -9,14 +9,20 @@ This script automates the validation of audio recording capabilities on the Qual
 - Records PCM audio to '/tmp/rec1.wav' using either `parec` or `pw-record`
 - Automatically detects and sets PipeWire source ID if PipeWire is used
 - Uses `AUDIO_BACKEND` environment variable to select backend (default: pulseaudio)
+- Captures kernel logs before and after recording
+- Scans dmesg logs for audio-related errors
+- Supports configurable timeout and loop count for recording
+- Validates presence of required daemons and binaries												 
 - Compatible with Yocto-based root filesystem
 
 ## Prerequisites
 
 Ensure the following components are present in the target Yocto build:
 
 - `parec` binary (for PulseAudio)
-- `pw-record`, `wpctl`, `grep`, `sed` (for PipeWire)
+- `pw-record`, `wpctl`, `grep`, `sed`, `timeout`, `pgrep` (for PipeWire)
+- `pulseaudio` or `pipewire` daemon must be running depending on backend
+								
 
 ## Directory Structure
 
@@ -54,20 +60,28 @@ cd <Path in device>Runner
 AUDIO_BACKEND=pulseaudio ./run-test.sh AudioRecord
 **Run with PipeWire**
 AUDIO_BACKEND=pipewire ./run-test.sh AudioRecord
+
+Environment Variables:
+You can customize recording behavior using the following environment variables:
+AUDIO_BACKEND: Selects the audio backend (pulseaudio or pipewire). Default is pulseaudio.
+RECORD_TIMEOUT: Timeout duration for recording (e.g., 12s). Default is 12s.
+RECORD_LOOPS: Number of times to repeat recording. Default is 1.
 ```
 
 Sample Output:
 ```
-[Executing test case: AudioRecord] 2025-05-28 19:03:33 -
-[INFO] 2025-05-28 19:03:33 - ------------------------------------------------------------
-[INFO] 2025-05-28 19:03:33 - ------------------- Starting AudioRecord Testcase ------------
-[INFO] 2025-05-28 19:03:33 - Using audio backend: pulseaudio
-[INFO] 2025-05-28 19:03:33 - Checking if dependency binary is available
-[PASS] 2025-05-28 19:03:45 - Recording completed or timed out (ret=124) as expected and output file exists.
-[PASS] 2025-05-28 19:03:45 - AudioRecord : Test Passed
-[INFO] 2025-05-28 19:03:45 - See results/audiorecord/parec_stdout.log or pw-record_stdout.log, dmesg_before/after.log, syslog_before/after.log for debug details
-[INFO] 2025-05-28 19:03:45 - ------------------- Completed AudioRecord Testcase -------------
-[PASS] 2025-05-28 19:03:45 - AudioRecord passed
+sh-5.2# AUDIO_BACKEND=pipewire ./run-test.sh AudioRecord
+[Executing test case: AudioRecord] 2025-08-14 10:35:43 -
+[INFO] 2025-08-14 10:35:43 - ------------------------------------------------------------
+[INFO] 2025-08-14 10:35:43 - ------------------- Starting AudioRecord Testcase ------------
+[INFO] 2025-08-14 10:35:43 - Using audio backend: pipewire
+[INFO] 2025-08-14 10:35:43 - Checking if dependency binary is available
+[INFO] 2025-08-14 10:35:43 - Detected PipeWire source ID: 50
+[INFO] 2025-08-14 10:35:55 - Scanning dmesg for audio: errors & success patterns
+[INFO] 2025-08-14 10:35:55 - No audio-related errors found (no OK pattern requested)
+[PASS] 2025-08-14 10:35:55 - Recording completed or timed out (ret=124) as expected and output file exists.
+[PASS] 2025-08-14 10:35:55 - AudioRecord : Test Passed
+[PASS] 2025-08-14 10:35:55 - AudioRecord passed
 ```
 
 3. Results will be available in the `Runner/suites/Multimedia/Audio/AudioRecord/AudioRecord.res` directory.

Runner/suites/Multimedia/Audio/AudioRecord/run.sh

@@ -34,7 +34,24 @@ AUDIO_DEVICE="regular0"
 LOGDIR="results/audiorecord"
 RESULT_FILE="$TESTNAME.res"
 
-AUDIO_BACKEND="${AUDIO_BACKEND:-pulseaudio}"  # Default to pulseaudio
+# Determine backend and binary
+AUDIO_BACKEND="${AUDIO_BACKEND:-pulseaudio}"  # Default to pulseaudio if not set
+
+# RECORD_TIMEOUT: seconds (default: 12s)
+# RECORD_LOOPS: number of times to repeat recording
+RECORD_TIMEOUT="${RECORD_TIMEOUT:-12s}"
+RECORD_LOOPS="${RECORD_LOOPS:-1}"
+
+# Set test binary and command
+if [ "$AUDIO_BACKEND" = "pulseaudio" ]; then
+    TESTBINARY="parec"
+elif [ "$AUDIO_BACKEND" = "pipewire" ]; then
+    TESTBINARY="pw-record"
+else
+    log_fail "Invalid AUDIO_BACKEND specified: $AUDIO_BACKEND. Use 'pulseaudio' or 'pipewire'."
+    echo "$TESTNAME FAIL" > "$RESULT_FILE"
+    exit 1
+fi
 
 test_path=$(find_test_case_by_name "$TESTNAME")
 cd "$test_path" || exit 1
@@ -45,12 +62,21 @@ log_info "------------------------------------------------------------"
 log_info "------------------- Starting $TESTNAME Testcase ------------"
 log_info "Using audio backend: $AUDIO_BACKEND"
 
+# Daemon check
+if [ "$AUDIO_BACKEND" = "pulseaudio" ]; then
+  if ! pgrep pulseaudio > /dev/null && ! pgrep pipewire-pulse > /dev/null; then
+    log_skip_exit "$TESTNAME" "Neither PulseAudio nor pipewire-pulse daemon is running"
+  fi
+elif [ "$AUDIO_BACKEND" = "pipewire" ]; then
+  pgrep pipewire > /dev/null || log_skip_exit "$TESTNAME" "PipeWire daemon not running"
+fi
+
+log_info "Checking if dependency binary is available"
 if [ "$AUDIO_BACKEND" = "pulseaudio" ]; then
-    TESTBINARY="parec"
-    RECORD_CMD="$TESTBINARY --rate=48000 --format=s16le --channels=1 --file-format=wav \"$RECORD_FILE\" -d \"$AUDIO_DEVICE\""
     check_dependencies "$TESTBINARY" pgrep timeout
+    RECORD_CMD="$TESTBINARY --rate=48000 --format=s16le --channels=1 --file-format=wav \"$RECORD_FILE\" -d \"$AUDIO_DEVICE\""
 else
-    TESTBINARY="pw-record"
+						  
     check_dependencies "$TESTBINARY" wpctl grep sed timeout
 
     # Extract source ID using sed
@@ -66,13 +92,19 @@ else
     RECORD_CMD="$TESTBINARY \"$RECORD_FILE\" -v"
 fi
 
-dmesg > "$LOGDIR/dmesg_before.log"
+# --- Capture logs BEFORE recording (for debugging) ---
+get_kernel_log > "$LOGDIR/dmesg_before.log"
 rm -f "$RECORD_FILE"
 
-eval "timeout 12s $RECORD_CMD" > "$LOGDIR/${TESTBINARY}_stdout.log" 2>&1
+# --- Start the Recording, capture output ---
+for i in $(seq 1 "$RECORD_LOOPS"); do
+   timeout "$RECORD_TIMEOUT" sh -c "$RECORD_CMD" >> "$LOGDIR/${TESTBINARY}_stdout.log" 2>&1
+done
 ret=$?
 
-dmesg > "$LOGDIR/dmesg_after.log"
+# --- Capture logs AFTER recording (for debugging) ---
+get_kernel_log > "$LOGDIR/dmesg_after.log"
+scan_dmesg_errors "audio" "$LOGDIR"
 
 if ([ "$ret" -eq 0 ] || [ "$ret" -eq 124 ]) && [ -s "$RECORD_FILE" ]; then
     log_pass "Recording completed or timed out (ret=$ret) as expected and output file exists."
@@ -86,6 +118,6 @@ else
     exit 1
 fi
 
-log_info "See $LOGDIR/${TESTBINARY}_stdout.log, dmesg_before/after.log, syslog_before/after.log for debug details"
+log_info "See $LOGDIR/${TESTBINARY}_stdout.log, dmesg_before/after.log for debug details"
 log_info "------------------- Completed $TESTNAME Testcase -------------"
 exit 0