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

Signed-off-by: tmoida <[email protected]>

Author: tmoida

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
 

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

@@ -1,41 +1,48 @@
-# 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
+- Compatible with Yocto-based root filesystem											 
 
 ## 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
 
 ```bash
 Runner/
-├──suites/
-├   ├── Multimedia/
-│   ├    ├── Audio/
-│   ├    ├    ├── AudioPlayback/
-│   ├    ├    ├    ├    └── run.sh
-├   ├    ├    ├    ├    └── Read_me.md
+├── run-test.sh
+├── utils/
+│   ├── functestlib.sh
+│   └── libaudio.sh
+└── suites/
+    └── Multimedia/
+        └── Audio/
+            ├── AudioPlayback/
+                ├── run.sh
+                └── Read_me.md
 ```
 
 ## Usage
 
-
-Instructions
-
+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.
 
 Run a specific test using:
@@ -46,33 +53,64 @@ 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
+AUDIO_BACKEND=pulseaudio PLAYBACK_TIMEOUT=20s PLAYBACK_LOOPS=2 PLAYBACK_VOLUME=5000 ./run-test.sh AudioPlayback
+cd Runner/suites/Multimedia/Audio/AudioPlayback && ./run.sh --backend pulseaudio --loops 2 --timeout 20s --volume 5000
+
+**Run with PipeWire**
+AUDIO_BACKEND=pipewire ./run-test.sh AudioPlayback
+AUDIO_BACKEND=pipewire PLAYBACK_TIMEOUT=10s PLAYBACK_LOOPS=3 PLAYBACK_VOLUME=0.5 ./run-test.sh AudioPlayback
+cd Runner/suites/Multimedia/Audio/AudioPlayback && ./run.sh --backend pipewire --loops 3 --timeout 10s --volume 0.5
+
+Environment Variables:
+You can customize playback behavior using the following environment variables:
+AUDIO_BACKEND: Selects the audio backend (pulseaudio or pipewire). Default is PipeWire.
+PLAYBACK_TIMEOUT: Timeout duration for playback (e.g., 10s). 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)
+
+CLI Options
+Option		Description
+--backend	Select audio backend: pulseaudio or pipewire
+--loops		Number of playback loops
+--timeout	Playback timeout duration (e.g., 15s)
+--volume	Volume level (PA: 0-65536, PW: 0.0-1.0)
+--help		Show usage instructions
+
 ```
 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-09-04 09:13:06 -
+[INFO] 2025-09-04 09:13:06 - ---------------- Starting AudioPlayback Testcase ----------------
+[INFO] 2025-09-04 09:13:06 - Using audio backend: pipewire
+[INFO] 2025-09-04 09:13:06 - Playback clip present: AudioClips/yesterday_48KHz.wav
+[INFO] 2025-09-04 09:13:06 - Playback loop 1 of 1
+[WARN] 2025-09-04 09:13:21 - Playback loop 1: Timed out (ret=124)
+[INFO] 2025-09-04 09:13:21 - Scanning dmesg for audio: errors & success patterns
+[INFO] 2025-09-04 09:13:21 - No audio-related errors found (no OK pattern requested)
+[PASS] 2025-09-04 09:13:21 - Audio playback test completed successfully
+[PASS] 2025-09-04 09:13:21 - AudioPlayback passed
 ```
-3. Results will be available in the `Runner/suites/Multimedia/Audio/AudioPlayback/AudioPlayback.res` directory.
+
+Results:
+Results are stored in: results/AudioPlayback/
+Summary result file: AudioPlayback.res
 
 
 ## Notes
 
-- The script does not take any arguments.
-- It validates the presence of required libraries before executing tests.
+- The script validates the presence of required libraries before executing tests.
 - If any critical tool is missing, the script exits with an error message.
+- Logs include dmesg_before.log, dmesg_after.log, and playback_stdout.log.
 
 ## License
 
 SPDX-License-Identifier: BSD-3-Clause-Clear  
 (C) Qualcomm Technologies, Inc. and/or its subsidiaries.
+

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

@@ -1,94 +1,66 @@
 #!/bin/sh
-
-# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 # SPDX-License-Identifier: BSD-3-Clause-Clear
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 
-# --------- Robustly source init_env and functestlib.sh ----------
 SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+
+# Locate and source init_env
 INIT_ENV=""
 SEARCH="$SCRIPT_DIR"
 while [ "$SEARCH" != "/" ]; do
-    if [ -f "$SEARCH/init_env" ]; then
-        INIT_ENV="$SEARCH/init_env"
-        break
-    fi
-    SEARCH=$(dirname "$SEARCH")
+  if [ -f "$SEARCH/init_env" ]; then
+    INIT_ENV="$SEARCH/init_env"
+    break
+  fi
+  SEARCH=$(dirname "$SEARCH")
 done
+[ -z "$INIT_ENV" ] && echo "[ERROR] init_env not found" && exit 1
+# shellcheck source=/dev/null
+[ -z "$__INIT_ENV_LOADED" ] && . "$INIT_ENV"
 
-if [ -z "$INIT_ENV" ]; then
-    echo "[ERROR] Could not find init_env (starting at $SCRIPT_DIR)" >&2
-    exit 1
-fi
-
-if [ -z "$__INIT_ENV_LOADED" ]; then
-    # shellcheck disable=SC1090
-    . "$INIT_ENV"
-fi
-# shellcheck disable=SC1090,SC1091
 . "$TOOLS/functestlib.sh"
-# ---------------------------------------------------------------
-
-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"
+. "$TOOLS/libaudio.sh"
 
-test_path=$(find_test_case_by_name "$TESTNAME")
-cd "$test_path" || exit 1
+# 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
+}
 
-# Prepare logdir
-mkdir -p "$LOGDIR"
-chmod -R 777 "$LOGDIR"
-
-log_info "------------------------------------------------------------"
-log_info "------------------- Starting $TESTNAME Testcase ------------"
-
-log_info "Checking if dependency binary is available"
-check_dependencies "$TESTBINARY" pgrep grep timeout
-
-# Download/extract audio if not present
-if [ ! -f "$PLAYBACK_CLIP" ]; then
-    log_info "Audio clip not found, downloading..."
-    extract_tar_from_url "$TAR_URL" || {
-        log_fail "Failed to fetch/extract playback audio tarball"
-        echo "$TESTNAME FAIL" > "$RESULT_FILE"
-        exit 1
-    }
-fi
-
-if [ ! -f "$PLAYBACK_CLIP" ]; then
-    log_fail "Playback clip $PLAYBACK_CLIP not found after extraction."
-    echo "$TESTNAME : FAIL" > "$RESULT_FILE"
-    exit 1
-fi
-
-log_info "Playback clip present: $PLAYBACK_CLIP"
+# Set TESTNAME
+TESTNAME="AudioPlayback"
 
-# --- Capture logs BEFORE playback (for debugging) ---
-dmesg > "$LOGDIR/dmesg_before.log"
+# Usage help
+usage() {
+  cat <<EOF
+Usage: $0 [options]
+
+Options:
+  --backend {pulseaudio|pipewire}
+  --loops N
+  --timeout SECS
+  --volume VAL (PA: 0-65536, PW: 0.0-1.0)
+EOF
+}
+
+# Parse CLI args
+while [ $# -gt 0 ]; do
+  case "$1" in
+    --backend) export AUDIO_BACKEND="$2"; shift 2 ;;
+    --loops) export PLAYBACK_LOOPS="$2"; shift 2 ;;
+    --timeout) export PLAYBACK_TIMEOUT="$2"; shift 2 ;;
+    --volume) export PLAYBACK_VOLUME="$2"; shift 2 ;;
+    --help) usage; exit 0 ;;
+    *) echo "[ERROR] Unknown option: $1"; usage; exit 1 ;;
+  esac
+done
 
-# --- Start the Playback, capture output ---
-timeout 15s paplay "$PLAYBACK_CLIP" -d "$AUDIO_DEVICE" > "$LOGDIR/playback_stdout.log" 2>&1
-ret=$?
+# Fallback to env if not set
+export AUDIO_BACKEND="${AUDIO_BACKEND:-pipewire}"
 
-# --- Capture logs AFTER playback (for debugging) ---
-dmesg > "$LOGDIR/dmesg_after.log"
+log_info "---------------- Starting $TESTNAME Testcase ----------------"
+log_info "Using audio backend: $AUDIO_BACKEND"
 
-if [ "$ret" -eq 0 ] || [ "$ret" -eq 124 ] ; then
-    log_pass "Playback completed or timed out (ret=$ret) as expected."
-    log_pass "$TESTNAME : Test Passed"
-    echo "$TESTNAME PASS" > "$RESULT_FILE"
-    exit 0
-else
-    log_fail "$TESTBINARY playback exited with error code $ret"
-    log_fail "$TESTNAME : Test Failed"
-    echo "$TESTNAME FAIL" > "$RESULT_FILE"
-    exit 1
-fi
+init_audio_env "$TESTNAME" "$AUDIO_BACKEND"
+audio_playback
 
-log_info "See $LOGDIR/playback_stdout.log, dmesg_before/after.log, syslog_before/after.log for debug details"
-log_info "------------------- Completed $TESTNAME Testcase -------------"
-exit 0
+log_info "---------------- Completed $TESTNAME Testcase ----------------"