Commit 72dae489 authored by Jan Kiene's avatar Jan Kiene
Browse files

Merge branch 'main' into... 

Merge branch 'main' into 922-use-precomputed-HRTF-average-LR-energies-and-IAC-in-all-renderers-test-cases
parents d909f586 2ce645cf

.gitlab-ci.yml

+38 −25
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ variables: 
  BUILD_OUTPUT: "build_output.txt"

  EVS_BE_TEST_DIR: "/usr/local/be_2_evs_test"

  EVS_BE_WIN_TEST_DIR: "C:/Users/gitlab-runner/testvec"

  SANITIZER_TESTS: "CLANG1 CLANG2"

  SANITIZER_TESTS: "CLANG1 CLANG2 CLANG3"

  OUT_FORMATS_CHANNEL_BASED: "stereo mono 5_1 5_1_2 5_1_4 7_1 7_1_4"

  OUT_FORMATS_SCENE_BASED: "FOA HOA2 HOA3"

  OUT_FORMATS_BINAURAL: "BINAURAL BINAURAL_ROOM_IR BINAURAL_ROOM_REVERB"
@@ -325,11 +325,12 @@ build-codec-instrumented-linux: 
  extends:

    - .build-job-linux

    - .rules-basis

  timeout: "6 minutes"

  timeout: "7 minutes"

  script:

    - *print-common-info

    - *activate-Werror-linux

    - bash ci/build_codec_instrumented_linux.sh

    - ./scripts/prepare_instrumentation.sh

    - make -j -C scripts/c-code_instrument



# make sure that the codec builds with msan, asan and usan

build-codec-sanitizers-linux:
@@ -514,7 +515,8 @@ renderer-smoke-test: 
  stage: test

  script:

    - make -j IVAS_rend

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py

    - testcase_timeout=60

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py --testcase_timeout=$testcase_timeout

  artifacts:

    name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--job-$CI_JOB_NAME--results"

    expire_in: 1 week
@@ -536,7 +538,8 @@ renderer-asan: 
  script:

    - cmake -B cmake-build -G "Unix Makefiles" -DCLANG=asan -DCOPY_EXECUTABLES_FROM_BUILD_DIR=true

    - cmake --build cmake-build -- -j

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py

    - testcase_timeout=180

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py --testcase_timeout=$testcase_timeout



  artifacts:

    name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--job-$CI_JOB_NAME--results"
@@ -559,7 +562,8 @@ renderer-msan: 
  script:

    - cmake -B cmake-build -G "Unix Makefiles" -DCLANG=msan  -DCOPY_EXECUTABLES_FROM_BUILD_DIR=true

    - cmake --build cmake-build -- -j

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py

    - testcase_timeout=180

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py --testcase_timeout=$testcase_timeout



  artifacts:

    name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--job-$CI_JOB_NAME--results"
@@ -582,7 +586,8 @@ renderer-usan: 
  script:

    - cmake -B cmake-build -G "Unix Makefiles" -DCLANG=usan  -DCOPY_EXECUTABLES_FROM_BUILD_DIR=true

    - cmake --build cmake-build -- -j

    - UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1,log_path=usan_log_catchall python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py

    - testcase_timeout=180

    - UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1,log_path=usan_log_catchall python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/renderer/test_renderer.py --testcase_timeout=$testcase_timeout

    - grep_exit_code=0

    - touch usan_log_empty # Creates an empty file, this is to avoid "grep: usan_log_*: No such file or directory" in case no USAN failures are reported from pytest

    - grep UndefinedBehaviorSanitizer usan_log_* || grep_exit_code=$?
@@ -624,13 +629,14 @@ renderer-pytest-on-merge-request: 
    - if [ $ref_using_main == 0 ]; then git checkout $source_branch_commit_sha; fi



    - exit_code=0

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/renderer/test_renderer.py --create_ref || exit_code=$?

    - testcase_timeout=60

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/renderer/test_renderer.py --create_ref --testcase_timeout=$testcase_timeout || exit_code=$?



    ### Run test using branch scripts and input

    - if [ $ref_using_main == 1 ]; then git checkout $source_branch_commit_sha; fi



    # run test

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/renderer/test_renderer_.py --create_cut || exit_code=$?

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/renderer/test_renderer_.py --create_cut --testcase_timeout=$testcase_timeout || exit_code=$?

    - zero_errors=$(cat report-junit.xml | grep -c 'errors="0"') || true



    - *merge-request-comparison-check
@@ -660,7 +666,8 @@ split-rendering-smoke-test: 
  script:

    - *enable-split-rendering

    - make -j INCLUDE_SPLIT=1

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/split_rendering/test_split_rendering.py

    - testcase_timeout=10

    - python3 -m pytest -q -n auto -rA --junit-xml=report-junit.xml tests/split_rendering/test_split_rendering.py --testcase_timeout=$testcase_timeout

  artifacts:

    name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--job-$CI_JOB_NAME--results"

    expire_in: 1 week
@@ -710,7 +717,8 @@ split-rendering-pytest-on-merge-request: 
    - if [ $ref_using_main == 0 ]; then git restore lib_com/options.h; fi # Revert changes back before checking out another branch to avoid conflicts

    - if [ $ref_using_main == 0 ]; then git checkout $source_branch_commit_sha; fi

    - exit_code=0

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/split_rendering/test_split_rendering.py --create_ref || exit_code=$?

    - testcase_timeout=60

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/split_rendering/test_split_rendering.py --create_ref --testcase_timeout=$testcase_timeout || exit_code=$?



    # back to source branch

    - git restore lib_com/options.h # Revert changes back before checking out another branch to avoid conflicts
@@ -724,7 +732,7 @@ split-rendering-pytest-on-merge-request: 
    - if [ $ref_using_main == 1 ]; then git checkout $source_branch_commit_sha; fi



    # run test

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/split_rendering/test_split_rendering.py --create_cut || exit_code=$?

    - python3 -m pytest -q --log-level ERROR -n auto -rA --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/split_rendering/test_split_rendering.py --create_cut --testcase_timeout=$testcase_timeout || exit_code=$?

    - zero_errors=$(cat report-junit.xml | grep -c 'errors="0"') || true



    - *merge-request-comparison-check
@@ -751,7 +759,7 @@ ivas-pytest-on-merge-request: 
    - .rules-merge-request

  stage: compare

  needs: ["build-codec-linux-cmake", "codec-smoke-test"]

  timeout: "10 minutes"

  timeout: "14 minutes"

  script:

    - *print-common-info

    - *get-commits-behind-count
@@ -779,7 +787,8 @@ ivas-pytest-on-merge-request: 


    ### run pytest

    - exit_code=0

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --html=report.html --self-contained-html --junit-xml=report-junit.xml || exit_code=$?

    - testcase_timeout=60

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --html=report.html --self-contained-html --junit-xml=report-junit.xml --testcase_timeout=$testcase_timeout || exit_code=$?

    - zero_errors=$(cat report-junit.xml | grep -c 'errors="0"') || true



    - *merge-request-comparison-check
@@ -879,14 +888,15 @@ evs-pytest-on-merge-request: 


    ### prepare pytest

    # create references

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --update_ref 1 -m create_ref --param_file scripts/config/self_test_evs.prm

    - testcase_timeout=60

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --update_ref 1 -m create_ref --param_file scripts/config/self_test_evs.prm --testcase_timeout=$testcase_timeout



    ### Run test using branch scripts and input

    - if [ $ref_using_main == 1 ]; then git checkout $source_branch_commit_sha; fi



    ### run pytest for EVS cases

    - exit_code=0

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --param_file scripts/config/self_test_evs.prm --html=report.html --self-contained-html --junit-xml=report-junit-evs.xml || exit_code=$?

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --param_file scripts/config/self_test_evs.prm --html=report.html --self-contained-html --junit-xml=report-junit-evs.xml --testcase_timeout=$testcase_timeout || exit_code=$?

    - zero_errors=$(cat report-junit-evs.xml | grep -c 'errors="0"') || true



    - *merge-request-comparison-check
@@ -988,11 +998,11 @@ check-first-frame-is-sid: 
    # run all modes and cut bitstream to start with an SID. Use stereo output to limit runtime, test is only about decoding

    - ism_md_cmd="--ism_metadata_files /usr/local/ltv/ltvISM1.csv /usr/local/ltv/ltvISM2.csv /usr/local/ltv/ltvISM3.csv /usr/local/ltv/ltvISM4.csv"

    - modes=$(scripts/runIvasCodec.py -l | grep dtx | grep -vE "FOA|HOA" )

    - scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 200 -U 0:20 --oc stereo $ism_md_cmd || exit_code_no_sba=$?

    - scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 200 -U 0:20 --oc stereo $ism_md_cmd --timeout 10 || exit_code_no_sba=$?

    - modes=$(scripts/runIvasCodec.py -l | grep dtx | grep -E "HOA")

    - scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 100 -U 70:80 --oc stereo || exit_code_hoa=$?

    - scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 100 -U 70:80 --oc stereo --timeout 10 || exit_code_hoa=$?

    - modes=$(scripts/runIvasCodec.py -l | grep dtx | grep "FOA")

    - scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 100 -U 75:110 --oc stereo || exit_code_foa=$?

    - scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 100 -U 75:110 --oc stereo timeout 10 || exit_code_foa=$?



    - if [ $exit_code_no_sba -ne 0 ] || [ $exit_code_hoa -ne 0 ] || [ $exit_code_hoa -ne 0 ]; then exit 1; fi

  artifacts:
@@ -1128,15 +1138,16 @@ codec-comparison-on-main-push: 
    - mv IVAS_cod_test IVAS_cod

    - mv IVAS_dec_test IVAS_dec

    # create references

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --update_ref 1 -m create_ref

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --update_ref 1 -m create_ref_part2

    - testcase_timeout=60

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --update_ref 1 -m create_ref --testcase_timeout=$testcase_timeout

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --update_ref 1 -m create_ref_part2 --testcase_timeout=$testcase_timeout



    ### re-checkout the latest commit here, if ref_using_main is set

    - if [ $ref_using_main -eq 1 ]; then git checkout $latest_commit;fi



    ### run pytest

    - exit_code=0

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --html=report.html --self-contained-html --junit-xml=report-junit.xml || exit_code=$?

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR -v --html=report.html --self-contained-html --junit-xml=report-junit.xml --testcase_timeout=$testcase_timeout || exit_code=$?

    - if [ $exit_code -eq 1 ] && [ $non_be_flag == 0 ]; then echo "pytest run had failures and non-BE flag not present"; exit $EXIT_CODE_FAIL; fi

    - zero_errors=$(cat report-junit.xml | grep -c 'errors="0"') || true

    - if [ $exit_code -eq 1 ] && [ $zero_errors == 1 ]; then echo "pytest run had failures, but no errors and non-BE flag present"; exit $EXIT_CODE_NON_BE; fi
@@ -1230,11 +1241,12 @@ test-long-self-test: 


    # create references

    - exit_code_ref=0

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --update_ref 1 -m create_ref --param_file scripts/config/self_test_ltv.prm || exit_code_ref=$?

    - testcase_timeout=300

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --update_ref 1 -m create_ref --param_file scripts/config/self_test_ltv.prm --testcase_timeout=$testcase_timeout || exit_code_ref=$?



    ### run pytest self-test using long test vectors

    - exit_code=0

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --param_file scripts/config/self_test_ltv.prm --html=report-ltv.html --self-contained-html --junit-xml=report-junit-ltv.xml || exit_code=$?

    - python3 -m pytest $TESTS_DIR_CODEC_BE_ON_MR/test_param_file.py -v --param_file scripts/config/self_test_ltv.prm --html=report-ltv.html --self-contained-html --junit-xml=report-junit-ltv.xml --testcase_timeout=$testcase_timeout || exit_code=$?

    - zero_errors=$(cat report-junit-ltv.xml | grep -c 'errors="0"') || true



    - if [ $zero_errors != 1 ]; then echo "Run errors encountered!"; exit $EXIT_CODE_FAIL; fi
@@ -1267,10 +1279,11 @@ test-long-self-test: 
    - ivas-linux-fast

  artifacts:

    name: "$CI_JOB_NAME--main--sha-$CI_COMMIT_SHORT_SHA"

    expire_in: 1 week

    expire_in: 2 weeks

    when: always

    paths:

      - ep_015.g192

      - dly_profile.dat

      - ./LOGS_PLC

      - ./LOGS_noPLC

.gitlab/issue_templates/sanitizer_error.md

+2 −2
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ 


### Bug description



Clang (msan/asan?) sanitizer test in pipeline found an error:

Clang (m,a,u)san sanitizer test in pipeline found an error:



<!--- Copy sanitizer traceback from command line here -->

```
@@ -20,7 +20,7 @@ Using the [scripts](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec/-/wikis/ 
<!--- check correct sanitizer type -->

<!--- add error pattern if needed -->

```

python3 scripts/IvasBuildAndRunChecks.py --checks CLANGX -m MODE -p /path/to/my/local/ci_linux_ltv_local.json

python3 scripts/IvasBuildAndRunChecks.py --checks CLANGX -m MODE -p /path/to/my/local/ci_linux_ltv_local.json --usan_supp_file scripts/ubsan.supp

```

or directly:

apps/decoder.c

+17 −31
Original line number Diff line number Diff line
@@ -722,20 +722,6 @@ int main( 
        }



#ifdef NONBE_FIX_BINARY_BINAURAL_READING

        if ( ( error = load_HRTF_binary( *hHrtfTD, hrtfReader ) ) != IVAS_ERR_OK )

        {

            if ( error != IVAS_ERR_BINARY_FILE_WITHOUT_BINAURAL_RENDERER_DATA )

            {

#ifdef FIX_OLD_BINARY_FORMAT

                hrtfFileReader_close( &hrtfReader );

                strcat( arg.hrtfFileName, "new" );



                if ( hrtfFileReader_open( arg.hrtfFileName, &hrtfReader ) != IVAS_ERR_OK )

                {

                    fprintf( stderr, "\nError in loading HRTF binary file %s \n\n", arg.hrtfFileName );

                    goto cleanup;

                }



        if ( ( error = load_HRTF_binary( *hHrtfTD, hrtfReader ) ) != IVAS_ERR_OK )

        {

            if ( error != IVAS_ERR_BINARY_FILE_WITHOUT_BINAURAL_RENDERER_DATA )
@@ -748,16 +734,6 @@ int main( 
                destroy_td_hrtf( hHrtfTD );

            }

        }

#else

                fprintf( stderr, "\nError in loading HRTF binary file %s \n\n", arg.hrtfFileName );

                goto cleanup;

#endif

            }

            else

            {

                destroy_td_hrtf( hHrtfTD );

            }

        }

#else

        if ( ( error = load_HRTF_binary( hHrtfTD, hrtfReader ) ) != IVAS_ERR_OK )

        {
@@ -807,12 +783,6 @@ int main( 
                destroy_SetOfHRTF( hSetOfHRTF );

            }

        }

#else

        if ( ( error = create_SetOfHRTF_from_binary( hSetOfHRTF, hrtfReader, arg.output_Fs ) ) != IVAS_ERR_OK )

        {

            fprintf( stderr, "\nError in loading HRTF binary file %s for CRend \n\n", arg.hrtfFileName );

            goto cleanup;

        }

#endif



#ifdef NONBE_FIX_BINARY_BINAURAL_READING
@@ -1619,7 +1589,23 @@ static bool parseCmdlIVAS_dec( 
     * Mandatory input arguments

     *-----------------------------------------------------------------*/



    if ( i < argc - 3 )

    if ( i < argc - 4 )

    {

        for ( i = 1; i < argc; i++ )

        {

            if ( argv[i][0] == '-' )

            {

                fprintf( stderr, "Error: Wrong order of command-line arguments (optional arguments are first)\n\n" );

                usage_dec();

                return false;

            }

        }



        fprintf( stderr, "Error: Too many mandatory command-line arguments\n\n" );

        usage_dec();

        return false;

    }

    else if ( i < argc - 3 )

    {

        arg->outputConfig = cmdline2config( argv[i] );

        if ( arg->outputConfig == IVAS_AUDIO_CONFIG_LS_CUSTOM )

apps/renderer.c

+0 −22
Original line number Diff line number Diff line
@@ -1044,18 +1044,6 @@ int main( 
            {

                if ( error != IVAS_ERR_BINARY_FILE_WITHOUT_BINAURAL_RENDERER_DATA )

                {

#ifdef FIX_OLD_BINARY_FORMAT

                    hrtfFileReader_close( &hrtfFileReader );

                    strcat( args.customHrtfFilePath, "new" );

                    if ( hrtfFileReader_open( args.customHrtfFilePath, &hrtfFileReader ) != IVAS_ERR_OK )

                    {

                        fprintf( stderr, "\nError in loading HRTF binary file %s: %s \n\n", args.customHrtfFilePath, ivas_error_to_string( error ) );

                        goto cleanup;

                    }

                    if ( ( error = load_HRTF_binary( *hHrtfTD, hrtfFileReader ) ) != IVAS_ERR_OK )

                    {

                        if ( error != IVAS_ERR_BINARY_FILE_WITHOUT_BINAURAL_RENDERER_DATA )

                        {

                    fprintf( stderr, "\nError in loading HRTF binary file %s: %s \n\n", args.customHrtfFilePath, ivas_error_to_string( error ) );

                    goto cleanup;

                }
@@ -1064,16 +1052,6 @@ int main( 
                    destroy_td_hrtf( hHrtfTD );

                }

            }

#else

                    fprintf( stderr, "\nError in loading HRTF binary file %s: %s \n\n", args.customHrtfFilePath, ivas_error_to_string( error ) );

                    goto cleanup;

#endif

                }

                else

                {

                    destroy_td_hrtf( hHrtfTD );

                }

            }



#ifdef FIX_638_ENERGIE_IAC_ROM_TABLES

            if ( ( hHrtfTD != NULL ) && ( error = load_reverb_binary( *hHrtfTD, hrtfFileReader ) ) != IVAS_ERR_OK )

ci/run_scheduled_sanitizer_test.py

+7 −1
Original line number Diff line number Diff line
@@ -46,7 +46,8 @@ from combine_genpatt_and_jbm_profile import combine_error_profiles 
SCRIPT_DIR = pathlib.Path("./scripts").resolve()

DURATION = "120"

CFG = "ci_linux_ltv.json"

SUPPORTED_TESTS = ["CLANG1", "CLANG2", "CLANG3", "VALGRIND"]

SUPPORTED_TESTS = ["CLANG1", "CLANG2", "CLANG3"]

USAN_SUPP_FILE = str(SCRIPT_DIR.joinpath("ubsan.supp"))

EP_FILE = "ep_015.g192"

DLY_PROFILE_IN = SCRIPT_DIR.joinpath("dly_error_profiles/dly_error_profile_5.dat")

DLY_PROFILE_OUT = "dly_profile.dat"
@@ -54,6 +55,7 @@ N_FRAMES_DLY_PROFILE = 7500 
GENPATT_CMD = f"gen-patt -tailstat -fer -g192 -gamma 0 -rate 0.15 -tol 0.001 -reset -n {N_FRAMES_DLY_PROFILE} {EP_FILE}"

MC_MODES = ["5_1", "5_1_2", "5_1_4", "7_1", "7_1_4"]

AMBISONICS_MODES = ["HOA3", "HOA2", "FOA", "PlanarHOA3", "PlanarHOA2", "PlanarFOA"]

TIMEOUT = 60 * 15 # timeout of 15 minutes per en/decoding to safeguard against endless loops



CONSOLE_OUT_FILE = "output_san.txt"
@@ -145,6 +147,10 @@ def run_check(in_format: str, out_formats: list, tests: list, run_fec: bool = Tr 
        "--oc",

        *out_formats,

        *md_file_command,

        "--usan_supp_file",

        USAN_SUPP_FILE,

        "--timeout",

        str(TIMEOUT),

    ]



    print(