Skip to content

Commit ee2f9d9

Browse files
committed
Updated readme for Audio_Record_Playback test suite based on comments
Signed-off-by: nitinn <nitinn@qti.qualcomm.com>
1 parent 37ac48e commit ee2f9d9

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

  • Runner/suites/Multimedia/GSTreamer/Audio/Audio_Record_Playback

Runner/suites/Multimedia/GSTreamer/Audio/Audio_Record_Playback/README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ At a high level, the test:
4545
4. **Recording phase (ENCODE - 4 tests)**:
4646
- **audiotestsrc tests**: Generates sine wave at 440Hz, encodes to WAV/FLAC
4747
- **pulsesrc tests**: Captures from hardware audio input, encodes to WAV/FLAC
48-
- Saves recorded files to `logs/Audio_Record_Playback/recorded/`
48+
- Saves recorded files to shared directory (via `AUDIO_SHARED_RECORDED_DIR` / `gstreamer_shared_recorded_dir()`)
49+
- CI/LAVA runs: `<repo_root>/shared/audio-record-playback/`
50+
- Local/manual runs: `logs/Audio_Record_Playback/recorded/` (fallback)
4951
- Duration control:
5052
- audiotestsrc: Buffer count calculated dynamically: `(44100 * duration) / 1024`
5153
- pulsesrc: Uses timeout command to stop recording after specified duration
@@ -94,15 +96,14 @@ By default, the test runs **10 test cases** with 10 second duration:
9496
## PASS / FAIL / SKIP criteria
9597

9698
### PASS
97-
- **Recording**: Output file is created and has size > 1000 bytes
98-
- **Playback**: Pipeline completes successfully with exit code 0 (clean completion)
99-
- **Note**: Timeout (exit code 124) or termination (exit code 143) are treated as **FAIL** for controlled-duration recordings
100-
- This ensures playback completed successfully rather than being interrupted
99+
- **Recording**: Output file is created and has size > 1000 bytes, and no GStreamer errors detected in log
100+
- Exit code is not directly checked - timeout/termination is acceptable if file is valid
101+
- **Playback**: Pipeline completes successfully with exit code 0 and no GStreamer errors detected in log
101102
- **Overall**: At least one test passes and no tests fail
102103

103104
### FAIL
104-
- **Recording**: No output file created or file size too small
105-
- **Playback**: Pipeline exits with non-zero code (including timeout 124 or termination 143) or GStreamer errors detected
105+
- **Recording**: No output file created, file size too small (≤ 1000 bytes), or GStreamer errors detected in log
106+
- **Playback**: Pipeline exits with non-zero code or GStreamer errors detected in log
106107
- **Overall**: One or more tests fail
107108

108109
### SKIP
@@ -554,7 +555,9 @@ fi
554555
- `SKIP` - No tests executed or all skipped
555556
- Test summary is logged showing pass/fail/skip counts
556557
- Individual test logs are available in `logs/Audio_Record_Playback/`
557-
- Recorded files are preserved in `logs/Audio_Record_Playback/recorded/` for debugging
558+
- Recorded files are preserved in the shared recorded directory for debugging:
559+
- CI/LAVA runs: `<repo_root>/shared/audio-record-playback/`
560+
- Local/manual runs: `logs/Audio_Record_Playback/recorded/` (fallback)
558561

559562
### LAVA Environment Variables
560563

@@ -567,6 +570,8 @@ The test supports these environment variables (can be set in LAVA job definition
567570
- `RUNTIMESEC` - Alternative to AUDIO_DURATION (for backward compatibility)
568571
- `AUDIO_GST_DEBUG` - GStreamer debug level (default: 2)
569572
- `GST_DEBUG_LEVEL` - Alternative to AUDIO_GST_DEBUG
573+
- `AUDIO_CLIP_URL` - URL to download test audio files (OGG/MP3) (default: GitHub release URL)
574+
- `AUDIO_CLIP_PATH` - Local path to test audio files (overrides AUDIO_CLIP_URL if files exist)
570575
- `AUDIO_SHARED_RECORDED_DIR` - Shared directory for recorded audio artifacts (optional)
571576
- `REPO_PATH` - Repository root path (set by YAML, used for path resolution)
572577

0 commit comments

Comments
 (0)