Commit 81526f7f authored by vaclav's avatar vaclav
Browse files

Merge branch 'main' of https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec

parents eac75fee d176c83d

.gitlab-ci.yml

+37 −50
Original line number Diff line number Diff line 
variables:

  # note: GitLab cannot reference variables defined by users in the include ref:, we need to use a YAML anchor for this

  # see https://docs.gitlab.com/ci/yaml/includes/#use-variables-with-include for more information

  IVAS_CODEC_CI_REF: &IVAS_CODEC_CI_REF a31272de16bd1b556269a50bc179321a60f2a500

  IVAS_CODEC_CI_REF: &IVAS_CODEC_CI_REF main



include:

  - local: .gitlab-ci/variables.yml
@@ -544,81 +544,68 @@ renderer-smoke-test: 
      junit:

        - report-junit.xml



# test renderer executable with cmake + asan

renderer-asan:

.renderer-sanitizer-job:

  extends:

    - .test-job-linux

    - .rules-merge-request-to-main

  needs: ["build-codec-linux-cmake"]

  stage: test

  script:

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

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

    - testcase_timeout=180

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



  timeout: "30 minutes"

  artifacts:

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

    expire_in: 1 week

    when: always

    paths:

      - report-junit.xml

    expose_as: "renderer asan pytest results"

      - report.html

    reports:

      junit:

        - report-junit.xml

  before_script:

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

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

    # rename files to fit naming convention

    # en- and decoder needed because of split rendering testcases

    - mv IVAS_cod IVAS_cod_ref

    - mv IVAS_dec IVAS_dec_ref

    - mv IVAS_rend IVAS_rend_ref

    - testcase_timeout=180



# test renderer executable with cmake + asan

renderer-asan:

  extends:

    - .renderer-sanitizer-job

  variables:

    SANITIZER_BUILD_STRING: "asan"

  script:

    - python3 -m pytest -q --tb=no -n auto --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/renderer/test_renderer.py tests/split_rendering/test_split_rendering.py --create_ref --testcase_timeout=$testcase_timeout

  artifacts:

    expose_as: "renderer asan result"





# test renderer executable with cmake + msan

renderer-msan:

  extends:

    - .test-job-linux

    - .rules-merge-request-to-main

  needs: ["build-codec-linux-cmake"]

  stage: test

    - .renderer-sanitizer-job

  variables:

    SANITIZER_BUILD_STRING: "msan"

  script:

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

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

    - testcase_timeout=180

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



    - python3 -m pytest -q --tb=no -n auto --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/renderer/test_renderer.py tests/split_rendering/test_split_rendering.py --create_ref --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

    when: always

    paths:

      - report-junit.xml

    expose_as: "renderer msan pytest results"

    reports:

      junit:

        - report-junit.xml

    expose_as: "renderer msan result"





# test renderer executable with cmake + usan

renderer-usan:

  extends:

    - .test-job-linux

    - .rules-merge-request-to-main

  needs: ["build-codec-linux-cmake"]

  stage: test

    - .renderer-sanitizer-job

  variables:

    SANITIZER_BUILD_STRING: "usan"

  script:

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

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

    - 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=$?

    - if [ $grep_exit_code != 1 ] ; then echo "Run errors in test_renderer.py with Clang undefined-behavior-sanitizer"; exit 1; fi



    - UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1 python3 -m pytest -q --tb=no -n auto --html=report.html --self-contained-html --junit-xml=report-junit.xml tests/renderer/test_renderer.py tests/split_rendering/test_split_rendering.py --create_ref --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

    when: always

    paths:

      - report-junit.xml

    expose_as: "renderer usan pytest results"

    reports:

      junit:

        - report-junit.xml

    expose_as: "renderer usan result"





# compare renderer bitexactness between target and source branch

renderer-pytest-on-merge-request:

apps/isar_post_rend.c

+0 −8
Original line number Diff line number Diff line
@@ -681,9 +681,7 @@ int main( 
    int argc,

    char **argv )

{

#ifdef FIX_1335_EXTREND_RETCODE

    bool mainFailed = true; /* Assume main failed until cleanup is reached without errors */

#endif

    ISAR_POST_REND_HANDLE hIsarPostRend = NULL;

    RotFileReader *headRotReader = NULL;

    RotFileReader *externalOrientationFileReader = NULL;
@@ -1225,10 +1223,8 @@ int main( 
     * Close files and deallocate resources

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



#ifdef FIX_1335_EXTREND_RETCODE

    mainFailed = false; /* This will stay set to true if cleanup is reached via a goto due to an error */



#endif

cleanup:



    free( inpInt16Buffer );
@@ -1259,11 +1255,7 @@ cleanup: 
    print_mem( NULL );

#endif



#ifdef FIX_1335_EXTREND_RETCODE

    return mainFailed ? -1 : 0;

#else

    return 0;

#endif

}

apps/renderer.c

+12 −9
Original line number Diff line number Diff line
@@ -659,9 +659,7 @@ int main( 
    int argc,

    char **argv )

{

#ifdef FIX_1335_EXTREND_RETCODE

    bool mainFailed = true; /* Assume main failed until cleanup is reached without errors */

#endif

    IVAS_REND_HANDLE hIvasRend = NULL;

    RotFileReader *headRotReader = NULL;

    RotFileReader *externalOrientationFileReader = NULL;
@@ -1083,7 +1081,18 @@ int main( 
            fprintf( stderr, "\nFailed to read renderer configuration from file %s\n", args.renderConfigFilePath );

            goto cleanup;

        }



#ifdef NONBE_FIX_1337_MISSING_DIRECTIVITY_DISTATT_EXTREND

        if ( ( error = RenderConfigReader_getDirectivity( renderConfigReader, args.directivityPatternId, renderConfig.directivity ) ) != IVAS_ERR_OK )

        {

            fprintf( stderr, "Failed to get directivity patterns for one or more of IDs: %d %d %d %d\n\n", args.directivityPatternId[0], args.directivityPatternId[1], args.directivityPatternId[2], args.directivityPatternId[3] );

            goto cleanup;

        }

        if ( ( error = RenderConfigReader_getDistanceAttenuation( renderConfigReader, renderConfig.distAtt ) ) != IVAS_ERR_OK )

        {

            fprintf( stderr, "Failed to get Distance Attenuation \n\n" );

            goto cleanup;

        }

#endif

        if ( args.outConfig.audioConfig == IVAS_AUDIO_CONFIG_BINAURAL_ROOM_REVERB )

        {

            aeID = args.aeSequence.count > 0 ? args.aeSequence.pID[0] : 65535;
@@ -1968,10 +1977,8 @@ int main( 
     * Close files and deallocate resources

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



#ifdef FIX_1335_EXTREND_RETCODE

    mainFailed = false; /* This will stay set to true if cleanup is reached via a goto due to an error */



#endif

cleanup:



    free( inpInt16Buffer );
@@ -2028,11 +2035,7 @@ cleanup: 
    print_mem( NULL );

#endif



#ifdef FIX_1335_EXTREND_RETCODE

    return mainFailed ? -1 : 0;

#else

    return 0;

#endif

}

ci/smoke_test.sh

+23 −28
Original line number Diff line number Diff line
@@ -52,7 +52,6 @@ else 
  usage

fi





cfg=./scripts/config/ci_linux.json

dly_profile=./scripts/dly_error_profiles/dly_error_profile_10_smoke_test.dat

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"
@@ -77,10 +76,6 @@ if [ $BUILD -eq 1 ];then 


fi



# prepare combined format test signals

echo -e "\n======================= 0. preparing combined format test inputs =======================\n\n"

./scripts/prepare_combined_format_inputs.py



# run all modes vanilla-fashion

# treat ISM modes separately because passing the metadata files to MASA modes causes crashes

readarray -t ism_modes < <(./scripts/runIvasCodec.py -l | grep ISM)

ci/smoke_test_complexity.sh

+32 −37
Original line number Diff line number Diff line
@@ -61,10 +61,6 @@ duration_arg="" 
complexity_cmd="--checks COMPLEXITY --create_complexity_tables"

max_num_workers="--max_workers $MAX_CORES"



# prepare combined format test signals

echo "\n======================= 0. preparing combined format test inputs =======================\n\n"

./scripts/prepare_combined_format_inputs.py



# Modes

mono_modes=$(./scripts/IvasBuildAndRunChecks.py -l | grep ^mono)

FOA_modes=$(./scripts/IvasBuildAndRunChecks.py -l | grep ^FOA)
@@ -91,7 +87,6 @@ ISM_plus2_modes=$(./scripts/IvasBuildAndRunChecks.py -l | grep ^ISM+2) 
ISM_plus3_modes=$(./scripts/IvasBuildAndRunChecks.py -l | grep ^ISM+3)

ISM_plus4_modes=$(./scripts/IvasBuildAndRunChecks.py -l | grep ^ISM+4)





echo "\n======================= 1. Mono =======================\n\n"

./scripts/IvasBuildAndRunChecks.py $complexity_cmd ltv_complexity_mono_no_fec -m $mono_modes -p $cfg $duration_arg $max_num_workers | tee smoke_test_output_mono.txt

rm -r ./COMPLEXITY/dec/