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

tmoida · tmoida · commit 2b19003eeb56 · 2025-08-22T11:48:48.000+05:30
Signed-off-by: tmoida &lt;tmoida@qti.qualcomm.com&gt;
diff --git a/Runner/plans/meta-ar-ci-premerge.yaml b/Runner/plans/meta-ar-ci-premerge.yaml
@@ -14,9 +14,13 @@ metadata:
 run:
     steps:
         - cd Runner
-        - $PWD/suites/Multimedia/Audio/AudioPlayback/run.sh || true
-        - $PWD/utils/send-to-lava.sh $PWD/suites/Multimedia/Audio/AudioPlayback/AudioPlayback.res || true  
-        - $PWD/suites/Multimedia/Audio/AudioRecord/run.sh || true
-        - $PWD/utils/send-to-lava.sh $PWD/suites/Multimedia/Audio/AudioRecord/AudioRecord.res || true
+        - AUDIO_BACKEND=pulseaudio $PWD/suites/Multimedia/Audio/AudioPlayback/run.sh || true
+        - AUDIO_BACKEND=pulseaudio $PWD/utils/send-to-lava.sh $PWD/suites/Multimedia/Audio/AudioPlayback/AudioPlayback.res || true
+        - AUDIO_BACKEND=pipewire $PWD/suites/Multimedia/Audio/AudioPlayback/run.sh || true
+        - AUDIO_BACKEND=pipewire $PWD/utils/send-to-lava.sh $PWD/suites/Multimedia/Audio/AudioPlayback/AudioPlayback.res || true
+        - AUDIO_BACKEND=pulseaudio $PWD/suites/Multimedia/Audio/AudioRecord/run.sh || true
+        - AUDIO_BACKEND=pulseaudio $PWD/utils/send-to-lava.sh $PWD/suites/Multimedia/Audio/AudioRecord/AudioRecord.res || true
+        - AUDIO_BACKEND=pipewire $PWD/suites/Multimedia/Audio/AudioRecord/run.sh || true
+        - AUDIO_BACKEND=pipewire $PWD/utils/send-to-lava.sh $PWD/suites/Multimedia/Audio/AudioRecord/AudioRecord.res || true
         - $PWD/utils/result_parse.sh
 
diff --git a/Runner/suites/Multimedia/Audio/AudioPlayback/Read_me.md b/Runner/suites/Multimedia/Audio/AudioPlayback/Read_me.md
@@ -1,19 +1,25 @@
-# Audio playback Validation Script for Qualcomm Linux based platform (Yocto)
+# Audio Playback Validation Script for Qualcomm Linux-based Platform (Yocto)
 
 ## Overview
 
-This script automates the validation of audio playback capabilities on the Qualcomm Linux based platform running a Yocto-based Linux system. It utilizes pulseaudio test app to decode wav file.
+This script automates the validation of audio playback capabilities on the Qualcomm Linux-based platform running a Yocto-based Linux system. It supports both PulseAudio and PipeWire backends for audio playback.
 
 ## 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(available at /usr/bin) 
+- `paplay` binary (for PulseAudio)
+- `pw-play`, `pgrep`, `timeout`, `grep` (for PipeWire)
+- `pulseaudio` or `pipewire` daemon must be running depending on backend
 
 ## Directory Structure
 
@@ -34,7 +40,7 @@ Instructions
 
 1. Copy repo to Target Device: Use scp to transfer the scripts from the host to the target device. The scripts should be copied to any directory on the target device.
 
-2. Verify Transfer: Ensure that the repo have been successfully copied to any directory on the target device.
+2. Verify Transfer: Ensure that the repo has been successfully copied to any directory on the target device.
 
 3. Run Scripts: Navigate to the directory where these files are copied on the target device and execute the scripts as needed.
 
@@ -46,22 +52,36 @@ git clone <this-repo>
 cd <this-repo>
 scp -r Runner user@target_device_ip:<Path in device>
 ssh user@target_device_ip 
-cd <Path in device>/Runner && ./run-test.sh AudioPlayback
+cd <Path in device>/Runner
+**Run with PulseAudio**
+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:
 ```
-sh-5.2# cd <Path in device>/Runner/ && ./run-test.sh AudioPlayback
-[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 - 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, syslog_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#
+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.
 
@@ -76,3 +96,4 @@ sh-5.2#
 
 SPDX-License-Identifier: BSD-3-Clause-Clear  
 (C) Qualcomm Technologies, Inc. and/or its subsidiaries.
+
diff --git a/Runner/suites/Multimedia/Audio/AudioPlayback/run.sh b/Runner/suites/Multimedia/Audio/AudioPlayback/run.sh
@@ -24,31 +24,79 @@ if [ -z "$__INIT_ENV_LOADED" ]; then
     # shellcheck disable=SC1090
     . "$INIT_ENV"
 fi
-# shellcheck disable=SC1090,SC1091
+
+# Source library first
 . "$TOOLS/functestlib.sh"
+
+# Override with BusyBox-compatible version
+check_network_status() {
+    ip addr | awk '/state UP/ {iface=$2} /inet / {if (iface) print iface; iface=""}' | cut -d: -f1 | head -n 1
+}
+
 # ---------------------------------------------------------------
 
 TESTNAME="AudioPlayback"
-TESTBINARY="paplay"
 TAR_URL="https://github.com/qualcomm-linux/qcom-linux-testkit/releases/download/Pulse-Audio-Files-v1.0/AudioClips.tar.gz"
 PLAYBACK_CLIP="AudioClips/yesterday_48KHz.wav"
 AUDIO_DEVICE="low-latency0"
 LOGDIR="results/audioplayback"
 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
+
+# Select playback command based on backend										  
+case "$AUDIO_BACKEND" in
+    pulseaudio)
+        TESTBINARY="paplay"
+        PLAY_CMD="paplay --volume=$PLAYBACK_VOLUME \"$PLAYBACK_CLIP\" -d \"$AUDIO_DEVICE\""
+        ;;
+    pipewire)
+        TESTBINARY="pw-play"
+        PLAY_CMD="pw-play --volume=$PLAYBACK_VOLUME \"$PLAYBACK_CLIP\""
+        ;;
+    *)
+        log_fail "Invalid AUDIO_BACKEND specified: $AUDIO_BACKEND. Use 'pulseaudio' or 'pipewire'."
+        echo "$TESTNAME FAIL" > "$RESULT_FILE"
+        exit 1
+        ;;
+esac
+
 test_path=$(find_test_case_by_name "$TESTNAME")
 cd "$test_path" || exit 1
-
 # Prepare logdir
 mkdir -p "$LOGDIR"
 chmod -R 777 "$LOGDIR"
 
 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
-
+check_dependencies "$TESTBINARY" pgrep grep
 # Download/extract audio if not present
 if [ ! -f "$PLAYBACK_CLIP" ]; then
     log_info "Audio clip not found, downloading..."
@@ -68,27 +116,52 @@ 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 ---
-timeout 15s paplay "$PLAYBACK_CLIP" -d "$AUDIO_DEVICE" > "$LOGDIR/playback_stdout.log" 2>&1
-ret=$?
+PLAYBACK_SUCCESS=0
+
+for i in $(seq 1 "$PLAYBACK_LOOPS"); do
+    log_info "Playback loop $i of $PLAYBACK_LOOPS"
+    # Choose timeout method
+    if command -v timeout >/dev/null 2>&1; then
+        # Use system timeout if available
+        timeout "$PLAYBACK_TIMEOUT" sh -c "$PLAY_CMD" >> "$LOGDIR/playback_stdout.log" 2>&1
+        ret=$?
+    else
+        # Use library fallback if timeout is missing
+        run_with_timeout "$PLAYBACK_TIMEOUT" sh -c "$PLAY_CMD" >> "$LOGDIR/playback_stdout.log" 2>&1
+        ret=$?
+    fi
+
+    if [ "$ret" -eq 0 ]; then
+        log_pass "Playback loop $i: Completed successfully (ret=0)"
+    elif [ "$ret" -eq 1 ] && [ "$AUDIO_BACKEND" = "pipewire" ]; then
+        log_warn "Playback loop $i: Interrupted/timed out for PipeWire (ret=1)"
+    elif [ "$ret" -eq 124 ]; then
+        log_warn "Playback loop $i: Timed out (ret=124)"
+    else
+        log_fail "Playback loop $i: Failed with error code $ret"
+        PLAYBACK_SUCCESS=1
+        break  # Early exit on first true failure
+    fi
+done
 
 # --- 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."
-    log_pass "$TESTNAME : Test Passed"
+# Set final result based on loop outcomes
+if [ "$PLAYBACK_SUCCESS" -eq 0 ]; then
+    log_pass_exit "$TESTNAME" "Audio playback test completed successfully for all loops"
     echo "$TESTNAME PASS" > "$RESULT_FILE"
     exit 0
 else
-    log_fail "$TESTBINARY playback exited with error code $ret"
-    log_fail "$TESTNAME : Test Failed"
+    log_fail_exit "$TESTNAME" "Audio playback test failed in loop $i"
     echo "$TESTNAME FAIL" > "$RESULT_FILE"
     exit 1
 fi
 
-log_info "See $LOGDIR/playback_stdout.log, dmesg_before/after.log, syslog_before/after.log for debug details"
+log_info "See $LOGDIR/playback_stdout.log, dmesg_before/after.log for debug details"
 log_info "------------------- Completed $TESTNAME Testcase -------------"
-exit 0
+exit 0
diff --git a/Runner/suites/Multimedia/Audio/AudioRecord/Read_me.md b/Runner/suites/Multimedia/Audio/AudioRecord/Read_me.md
@@ -1,19 +1,28 @@
-# Audio encode Validation Script for Qualcomm Linux based platform (Yocto)
+# Audio Record Validation Script for Qualcomm Linux-based Platform (Yocto)
 
 ## Overview
 
-This script automates the validation of audio encode capabilities on the Qualcomm Linux based platform running a Yocto-based Linux system. It utilizes pulseaudio test app to encode file.
+This script automates the validation of audio recording capabilities on the Qualcomm Linux-based platform running a Yocto-based Linux system. It supports both PulseAudio and PipeWire backends for audio recording.
 
 ## Features
 
-- Encode PCM clip with --rate=48000 --format=s16le --channels=1 --file-format=wav /tmp/rec1.wav -d regular0
+- 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(available at /usr/bin) 
+- `parec` binary (for PulseAudio)
+- `pw-record`, `wpctl`, `grep`, `sed`, `timeout`, `pgrep` (for PipeWire)
+- `pulseaudio` or `pipewire` daemon must be running depending on backend
+								
 
 ## Directory Structure
 
@@ -34,7 +43,7 @@ Instructions
 
 1. Copy repo to Target Device: Use scp to transfer the scripts from the host to the target device. The scripts should be copied to any directory on the target device.
 
-2. Verify Transfer: Ensure that the repo have been successfully copied to any directory on the target device.
+2. Verify Transfer: Ensure that the repo has been successfully copied to any directory on the target device.
 
 3. Run Scripts: Navigate to the directory where these files are copied on the target device and execute the scripts as needed.
 
@@ -46,22 +55,33 @@ git clone <this-repo>
 cd <this-repo>
 scp -r Runner user@target_device_ip:<Path in device>
 ssh user@target_device_ip 
-cd <Path in device>Runner && ./run-test.sh AudioRecord
+cd <Path in device>Runner
+**Run with PulseAudio**
+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:
 ```
-sh-5.2# cd <Path in device>/Runner/ && ./run-test.sh AudioRecord
-[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 - 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, 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#
+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.
@@ -77,3 +97,4 @@ sh-5.2#
 
 SPDX-License-Identifier: BSD-3-Clause-Clear  
 (C) Qualcomm Technologies, Inc. and/or its subsidiaries.
+
diff --git a/Runner/suites/Multimedia/Audio/AudioRecord/run.sh b/Runner/suites/Multimedia/Audio/AudioRecord/run.sh
