check-performance.sh

#!/usr/bin/env bash

##
## Case Name: check-performance
## Preconditions:
##    N/A
## Description:
##    Run aplay and arecord to playback and capture
##    pipelines of the benchmark topology:
##        sof-hda-benchmark-generic-PLATFORM.tplg
## Case step:
##    1. Parse TPLG file to get pipeline with type of playback
##       and capture (exclude HDMI pipeline)
##    2. Specify the audio parameters
##    3. Run aplay and arecord on each pipeline with audio parameters
## Expect result:
##    The return value of aplay/arecord is 0
##    Performance statistics are printed
##

set -e

PIPEWIRE_OUTPUTS=("Speaker" "Headphones" "HDMI" "Stereo")
PIPEWIRE_INPUTS=("Digital Microphone" "DMIC" "Headset Microphone" "SoundWire microphone" "Stereo")

# It is pointless to perf component in HDMI pipeline, so filter out HDMI pipelines
# shellcheck disable=SC2034
NO_HDMI_MODE=true

# shellcheck source=case-lib/lib.sh
source "$(dirname "${BASH_SOURCE[0]}")"/../case-lib/lib.sh

OPT_NAME['t']='tplg'     OPT_DESC['t']='tplg file, default value is env TPLG: $''TPLG'
OPT_HAS_ARG['t']=1         OPT_VAL['t']="$TPLG"

OPT_NAME['d']='duration' OPT_DESC['d']='aplay/arecord duration in second'
OPT_HAS_ARG['d']=1         OPT_VAL['d']=30

OPT_NAME['s']='sof-logger'   OPT_DESC['s']="Open sof-logger trace the data will store at $LOG_ROOT"
OPT_HAS_ARG['s']=0             OPT_VAL['s']=1

func_opt_parse_option "$@"

tplg=${OPT_VAL['t']}
duration=${OPT_VAL['d']}


# run aplay for all sink types given as a parameter and save the number of started aplay processes
run_aplays()
{
    local sinks=("$@")

    for sink_type in "${sinks[@]}"
    do
        sink_id=$(get_id_of_pipewire_endpoint "$sink_type")
        if [ -z "$sink_id" ]; then
            dlogi "No $sink_type found, skipping to the next one"
            continue
        fi
        dlogi "Setting default sink to $sink_id: $sink_type"
        wpctl set-default "$sink_id"
        aplay_opts -D pipewire /dev/zero -d "$duration" -q &
        aplay_num=$((aplay_num+1))
    done
}

# run arecord for all source types given as a parameter and save the number of started arecord processes
run_arecords()
{
    local sources=("$@")

    for source_type in "${sources[@]}"
    do
        source_id=$(get_id_of_pipewire_endpoint "$source_type")
        if [ -z "$source_id" ]; then
            dlogi "No $source_type found, skipping to the next one"
            continue
        fi
        dlogi "Setting default source to $source_id: $source_type"
        wpctl set-default "$source_id"
        arecord_opts -D pipewire /dev/null -d "$duration" -q &
        arecord_num=$((arecord_num+1))
    done
}

main()
{
    start_test
    logger_disabled || func_lib_start_log_collect

    func_lib_check_sudo
    func_pipeline_export "$tplg" "type:any"

    aplay_num=0
    arecord_num=0

    if [ "$SOF_TEST_PIPEWIRE" == true ]; then

        dlogi "Running aplays"
        run_aplays "${PIPEWIRE_OUTPUTS[@]}"
        dlogi "Running arecords"
        run_arecords "${PIPEWIRE_INPUTS[@]}"

        if [ "$aplay_num" == 0 ] && [ "$arecord_num" == 0 ]; then
            skip_test "No sinks/sources to be tested found, skipping test"
        fi

    else

        for idx in $(seq 0 $((PIPELINE_COUNT - 1)))
        do
                channel=$(func_pipeline_parse_value "$idx" channel)
                rate=$(func_pipeline_parse_value "$idx" rate)
                dev=$(func_pipeline_parse_value "$idx" dev)
                pcm=$(func_pipeline_parse_value "$idx" pcm)
                type=$(func_pipeline_parse_value "$idx" type)

                # Currently, copier will convert bit depth to S32_LE despite what bit depth
                # is used in aplay, so make S32_LE as base bit depth for performance analysis.
                fmt=S32_LE

                dlogi "Running (PCM: $pcm [$dev]<$type>) in background"
                if [ "$type" == "playback" ]; then
                    aplay_opts -D "$dev" -c "$channel" -r "$rate" -f "$fmt" -d "$duration" /dev/zero -q &
                    aplay_num=$((aplay_num+1))
                else
                    arecord_opts -D "$dev" -c "$channel" -r "$rate" -f "$fmt" -d "$duration" /dev/null -q &
                    arecord_num=$((arecord_num+1))
                fi
        done
    fi

    sleep 1 # waiting stable streaming of aplay/arecord
    dlogi "Number of aplay/arecord process started: $aplay_num, $arecord_num"

    real_aplay_num=$(ps --no-headers -C aplay | wc -l)
    real_arecord_num=$(ps --no-headers -C arecord | wc -l)
    if [ "$real_aplay_num" != "$aplay_num" ] || [ "$real_arecord_num" != "$arecord_num" ];
    then
        dlogi "Number of aplay/arecord process running: $real_aplay_num, $real_arecord_num"
        die "aplay/arecord process exit unexpectedly"
    fi

    dlogi "Waiting for aplay/arecord process to exit"
    sleep $((duration + 2))

    # Enable performance analysis
    # shellcheck disable=SC2034
    DO_PERF_ANALYSIS=1
}

{
  main "$@"; exit "$?"
}