Commit 689f4261 authored by vaclav's avatar vaclav
Browse files

Merge remote-tracking branch 'remotes/origin/main' into... 

Merge remote-tracking branch 'remotes/origin/main' into 880-functions-renaming-after-nonbe_unified_decoding_paths
parents c63648e5 7dc55586

.gitlab-ci.yml

+89 −39
Original line number Diff line number Diff line
@@ -23,7 +23,6 @@ variables: 
      - 'test-long-self-test'

      - 'ivas-conformance'

      - 'ivas-conformance-linux'

      - 'check-float-reference'

      - 'check-clipping'

      - 'test-branch-vs-input-passthrough'
@@ -70,9 +69,6 @@ workflow: 
      variables:

        IVAS_PIPELINE_NAME: 'Draft IVAS Conformance test -- Linux: $CI_COMMIT_BRANCH'        

    - if: $CI_PIPELINE_SOURCE == 'trigger'

    - if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'check-float-reference'

      variables:

        IVAS_PIPELINE_NAME: 'check-float-reference: $CI_COMMIT_BRANCH'

    - if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'check-clipping'

      variables:

        IVAS_PIPELINE_NAME: 'Check core input clipping: $CI_COMMIT_BRANCH'
@@ -179,8 +175,8 @@ stages: 
.merge-request-comparison-check: &merge-request-comparison-check

  - echo "--------------- Running merge-request-comparison-check anchor ---------------"

  - if [ $zero_errors != 1 ]; then echo "Run errors encountered!"; exit $EXIT_CODE_FAIL; fi

  - if [ $exit_code -eq 1 ] && [ $non_be_flag == 0 ]; then echo "Non-bitexact cases without non-BE tag encountered!"; exit $EXIT_CODE_FAIL; fi

  - if [ $exit_code -eq 1 ] && [ $non_be_flag != 0 ]; then echo "Non-bitexact cases with non-BE tag encountered"; exit $EXIT_CODE_NON_BE; fi

  - if [ $exit_code -ne 0 ] && [ $non_be_flag == 0 ]; then echo "Non-bitexact cases without non-BE tag encountered!"; exit $EXIT_CODE_FAIL; fi

  - if [ $exit_code -ne 0 ] && [ $non_be_flag != 0 ]; then echo "Non-bitexact cases with non-BE tag encountered"; exit $EXIT_CODE_NON_BE; fi

  - exit 0



.update-ltv-repo: &update-ltv-repo
@@ -277,9 +273,8 @@ stages: 
      when: never      

    - if: $MANUAL_PIPELINE_TYPE == 'ivas-conformance-linux'

      when: never      

    - if: $MANUAL_PIPELINE_TYPE == 'check-float-reference'

      when: never

    - if: $MANUAL_PIPELINE_TYPE == 'check-clipping'

      when: never

    - if: $MANUAL_PIPELINE_TYPE == 'test-branch-vs-input-passthrough'

      when: never

    - when: on_success
@@ -421,6 +416,16 @@ check-self-test-names-pre: 
  script:

    - python3 ci/check_self_test_names.py scripts/config/self_test.prm 135



check-no-duplicates-in-self-tests:

  extends:

    - .rules-merge-request

  stage: prevalidate

  needs: []

  tags:

    - ivas-linux

  script:

    - python3 ci/find_duplicates_in_prm_files.py



branch-is-up-to-date-with-main-post:

  extends:

    - .rules-merge-request
@@ -432,8 +437,7 @@ branch-is-up-to-date-with-main-post: 
    - echo $commits_behind_count

    - if [ $commits_behind_count -eq 0 ]; then exit 0; else echo "Your branch is behind main, possibly main changed during your pipeline run, run 'git merge origin/main' to update." exit 1; fi;



# for merges to basop-ci-branch, run the long test suite in reference generation mode to catch problems already here and not only in the BASOP repo

check-compatibility-with-basop-reference-branch:

.basop-ci-branch-compat-template:

  extends:

    - .test-job-linux

  rules:
@@ -441,29 +445,24 @@ check-compatibility-with-basop-reference-branch: 
      changes:

        - tests/**/*

        - scripts/**/*

        - ci/**/*

    - if: ($CI_PIPELINE_SOURCE == 'web' || $CI_PIPELINE_SOURCE == 'trigger') && $MANUAL_PIPELINE_TYPE == 'check-float-reference'

    - if: $CI_PIPELINE_SOURCE == 'push'

      when: never

  tags:

    - ivas-linux-fast

  script:

  before_script:

    - git clone -b $BASOP_REFERENCE_BRANCH https://forge.3gpp.org/rep/sa4/audio/ivas-basop.git --single-branch

    - make -j -C ivas-basop

    - cp ivas-basop/IVAS_cod ./IVAS_cod_ref

    - cp ivas-basop/IVAS_dec ./IVAS_dec_ref

    - cp ivas-basop/IVAS_cod ./IVAS_cod # Not used but needed to launch the pytest

    - cp ivas-basop/IVAS_dec ./IVAS_dec # Not used but needed to launch the pytest

    - python3 ci/remove_unsupported_testcases.py scripts/config/self_test.prm

    - python3 ci/remove_unsupported_testcases.py $PARAM_FILE

    - python3 tests/create_short_testvectors.py

    - exit_code1=0

    - exit_code2=0

    - python3 -m pytest tests/codec_be_on_mr_nonselection -v --update_ref 1 --html=report.html --self-contained-html --junit-xml=report-junit.xml || exit_code1=$?

    - *update-ltv-repo

    - *copy-ltv-files-to-testv-dir



    - python3 -m pytest tests/codec_be_on_mr_nonselection --param_file $PARAM_FILE --update_ref 1 --ref_encoder_path ivas-basop/IVAS_cod --ref_decoder_path ivas-basop/IVAS_dec --html=report.html --self-contained-html --junit-xml=report-junit.xml || true

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

    - if [ $zero_errors != 1 ]; then echo "Run errors encountered!"; exit $EXIT_CODE_FAIL; fi

    - exit 0

    - if [ $zero_errors != 1 ]; then echo "Run errors encountered with $PARAM_FILE !"; exit $EXIT_CODE_FAIL; fi



  artifacts:

    name: "check-float-reference--sha-$CI_COMMIT_SHORT_SHA--results"

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

    when: always

    expire_in: 1 month

    paths:
@@ -475,6 +474,38 @@ check-compatibility-with-basop-reference-branch: 
      junit:

        - report-junit.xml



check-compatibility-with-basop-reference-branch-stv:

  extends:

    - .basop-ci-branch-compat-template

  variables:

    PARAM_FILE: scripts/config/self_test.prm

  script:

    - exit 0



check-compatibility-with-basop-reference-branch-ltv:

  extends:

    - .basop-ci-branch-compat-template

  variables:

    PARAM_FILE: scripts/config/self_test_ltv.prm

  script:

    - exit 0



check-compatibility-with-basop-reference-branch-encoder-stv:

  extends:

    - .basop-ci-branch-compat-template

  variables:

    PARAM_FILE: scripts/config/self_test_basop_encoder.prm

  script:

    - exit 0



check-compatibility-with-basop-reference-branch-encoder-ltv:

  extends:

    - .basop-ci-branch-compat-template

  variables:

    PARAM_FILE: scripts/config/self_test_ltv_basop_encoder.prm

  script:

    - exit 0



# ---------------------------------------------------------------

# Build jobs

# ---------------------------------------------------------------
@@ -508,7 +539,6 @@ build-codec-instrumented-linux: 
  timeout: "10 minutes"

  script:

    - *print-common-info

    - *activate-Werror-linux

    - ./scripts/prepare_instrumentation.sh

    - make -j -C scripts/c-code_instrument
@@ -643,9 +673,9 @@ pytest-compare-20ms-and-5ms-rendering: 
    - if [ $zero_errors5 != 1 ]; then echo "run error in with 5ms rendering encountered"; zero_errors=0 ; fi

    - if [ $zero_errors10 != 1 ]; then echo "run error in with 10ms rendering encountered"; zero_errors=0 ; fi

    - if [ $zero_errors != 1 ]; then exit $EXIT_CODE_FAIL; fi

    - if [ $exit_code5 -eq 1 ]; then echo "Non-bitexact cases encountered with 5ms rendering!"; exit_code=1; fi

    - if [ $exit_code10 -eq 1 ]; then echo "Non-bitexact cases encountered with 10ms rendering!"; exit_code=1; fi

    - if [ $exit_code -eq 1 ]; then exit $EXIT_CODE_FAIL; fi

    - if [ $exit_code5 -ne 0 ]; then echo "Non-bitexact cases encountered with 5ms rendering!"; exit_code=1; fi

    - if [ $exit_code10 -ne 0 ]; then echo "Non-bitexact cases encountered with 10ms rendering!"; exit_code=1; fi

    - if [ $exit_code -ne 0 ]; then exit $EXIT_CODE_FAIL; fi

  artifacts:

    name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--stage-$CI_JOB_STAGE--results"

    expire_in: 1 week
@@ -791,7 +821,7 @@ renderer-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/renderer/test_renderer_.py --create_cut --testcase_timeout=$testcase_timeout || 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
@@ -842,7 +872,7 @@ lc3-wrapper-unit-test: 
  script:

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

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

    - scripts/split_rendering/lc3plus/ivas_lc3plus_unit_test

    - scripts/split_rendering/lc3plus_float/ivas_lc3plus_unit_test



# compare split-rendering bitexactness between target and source branch

split-rendering-pytest-on-merge-request:
@@ -1337,9 +1367,9 @@ codec-comparison-on-main-push: 
    ### 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 --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

    - if [ $exit_code -ne 0 ] && [ $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

    - if [ $exit_code -ne 0 ] && [ $zero_errors == 1 ]; then echo "pytest run had failures, but no errors and non-BE flag present"; exit $EXIT_CODE_NON_BE; fi

    - if [ $exit_code -ne 0 ]; then echo "pytest run had errors"; exit $EXIT_CODE_FAIL; fi;

  allow_failure:

    exit_codes:
@@ -1430,6 +1460,7 @@ ivas-conformance: 
    - mkdir testvec/bin    

    - cp    -force -ErrorAction Ignore scripts/testv/* testvec/testv

    - cp -r -force -ErrorAction Ignore scripts/ls_layouts testvec

    - cp -r -force -ErrorAction Ignore scripts/object_edit testvec

    - cp -r -force -ErrorAction Ignore scripts/switchPaths testvec

    - cp -r -force -ErrorAction Ignore scripts/trajectories testvec

    - cp -r -force -ErrorAction Ignore scripts/binauralRenderer_interface/binaural_renderers_hrtf_data testvec/binauralRenderer_interface
@@ -1516,6 +1547,7 @@ ivas-conformance-linux: 
    - mkdir testvec/bin    

    - cp -r scripts/testv/* testvec/testv

    - cp -r scripts/ls_layouts testvec

    - cp -r scripts/object_edit testvec

    - cp -r scripts/switchPaths testvec

    - cp -r scripts/trajectories testvec

    - cp -r scripts/binauralRenderer_interface/binaural_renderers_hrtf_data testvec/binauralRenderer_interface
@@ -1563,7 +1595,7 @@ ivas-conformance-linux: 
    - genhtml coverage.info -o coverage -t "Coverage on main @ $commit_sha"



    # Check for failures

    - if [ $exit_code -eq 1 ]; then echo "Test failures encountered"; exit $EXIT_CODE_FAIL; fi

    - if [ $exit_code -ne 0 ]; then echo "Test failures encountered"; exit $EXIT_CODE_FAIL; fi

    

  artifacts:

    name: "ivas-conformance-linux-$CI_COMMIT_SHORT_SHA"
@@ -1640,7 +1672,7 @@ test-long-self-test: 
    - 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

    - if [ $exit_code -eq 1 ]; then echo "Non-bitexact cases encountered!"; exit $EXIT_CODE_NON_BE; fi

    - if [ $exit_code -ne 0 ]; then echo "Non-bitexact cases encountered!"; exit $EXIT_CODE_NON_BE; fi

    - exit 0
@@ -1705,7 +1737,7 @@ test-branch-vs-input-passthrough: 
    - zero_errors=$(cat report-junit.xml | grep -c 'errors="0"') || true

    - python3 scripts/parse_xml_report.py report-junit.xml report.csv

    - if [ $zero_errors != 1 ]; then echo "Run errors encountered!"; exit $EXIT_CODE_FAIL; fi

    - if [ $exit_code -eq 1 ]; then echo "Differences encountered."; exit $EXIT_CODE_NON_BE; fi

    - if [ $exit_code -ne 0 ]; then echo "Differences encountered."; exit $EXIT_CODE_NON_BE; fi

    - exit 0



  artifacts:
@@ -1721,7 +1753,6 @@ test-branch-vs-input-passthrough: 
      junit:

        - report-junit.xml





# ---------------------------------------------------------------

# Scheduled jobs on main

# ---------------------------------------------------------------
@@ -1787,7 +1818,7 @@ ltv-usan: 
    - ivas-linux-fast

  artifacts:

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

    expire_in: 2 weeks

    expire_in: 4 weeks

    when: always

    paths:

      - ep_015.g192
@@ -2376,8 +2407,27 @@ coverage-test-on-main-scheduled: 
  - unzip artifacts.zip || true # this may fail on first run, when there are no artifacts there and the zip file is actually just "404"-html

  - ls

  - public_dir="$CI_JOB_NAME-public"



  # if is needed to catch case when no artifact is there (first run), similarly as above

  - if [[ -d $public_dir ]]; then mv $public_dir/* wmops/;  fi

  # 1. check for public_dir being there as this might not be the case when artifact download failed

  # 2. check for public dir not being empty - handle job failures in prev job that happen after the dir is created. In that case, the empty dir is in the artifacts

  - if [ -d $public_dir ] && [ ! -z "$( ls -A $public_dir )" ]; then

  -   mv $public_dir/* wmops/

  # check here if we have the split-by-levels files present - if not, fake them up with the existing global one

  # this is needed for the first run with split graphs on a branch where the global version did run previously

  # NOTE: checking only for level_1 file here as this should already be sufficient

  # NOTE2: also not chechking for RAM for same reason

  -   wmops_all_global="wmops/log_wmops_all.txt"

  -   ram_all_global="wmops/log_ram_all.txt"

  -   if [ -f "${wmops_all_global}" ] && [ ! -f "wmops/log_wmops_all_level_1.txt" ]; then

  -     declare -a suffixes=("level_1" "level_2" "level_3" "rate_sw")

  -     for suffix in "${suffixes[@]}"; do

  -       cp ${wmops_all_global} wmops/log_wmops_all_${suffix}.txt

  -       cp ${ram_all_global} wmops/log_ram_all_${suffix}.txt

  -     done

  -   fi

  - fi



  - ls wmops

  - rm artifacts.zip

  - rm -rf $public_dir
@@ -2386,7 +2436,7 @@ coverage-test-on-main-scheduled: 
  &complexity-measurements-prepare-artifacts # prepare artifacts -> move to public directory

  - public_dir="$CI_JOB_NAME-public"

  - mkdir $public_dir

  - mv -f wmops/log_*_all.txt wmops/*.js ${public_dir}/

  - mv -f wmops/log_*_all*.txt ./*.js ${public_dir}/

  # move logfiles for links

  - mkdir $public_dir/logs

  # first move logs

CMakeLists.txt

+2 −2
Original line number Diff line number Diff line
@@ -174,7 +174,7 @@ target_include_directories(lib_util PUBLIC lib_util PRIVATE lib_com lib_enc lib_ 
target_include_directories(lib_util PRIVATE lib_lc3plus lib_isar)



if(NOT WMOPS)

  add_executable(ivas_lc3plus_unit_test scripts/split_rendering/lc3plus/ivas_lc3plus_unit_test.c)

  add_executable(ivas_lc3plus_unit_test scripts/split_rendering/lc3plus_float/ivas_lc3plus_unit_test.c)

  target_link_libraries(ivas_lc3plus_unit_test lib_rend lib_dec lib_util lib_com lib_debug lib_isar)

endif()
@@ -213,7 +213,7 @@ if(COPY_EXECUTABLES_FROM_BUILD_DIR) 
  add_custom_command(TARGET IVAS_rend POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:IVAS_rend>" "${CMAKE_CURRENT_SOURCE_DIR}/")

  add_custom_command(TARGET ISAR_post_rend POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:ISAR_post_rend>" "${CMAKE_CURRENT_SOURCE_DIR}/")

  if (NOT WMOPS)

    add_custom_command(TARGET ivas_lc3plus_unit_test POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:ivas_lc3plus_unit_test>" "${CMAKE_CURRENT_SOURCE_DIR}/scripts/split_rendering/lc3plus")

    add_custom_command(TARGET ivas_lc3plus_unit_test POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:ivas_lc3plus_unit_test>" "${CMAKE_CURRENT_SOURCE_DIR}/scripts/split_rendering/lc3plus_float")

  endif()

endif()

LICENSE.md

+1 −1
Original line number Diff line number Diff line 
/******************************************************************************************************



   (C) 2022-2024 IVAS codec Public Collaboration with portions copyright Dolby International AB, Ericsson AB,

   (C) 2022-2025 IVAS codec Public Collaboration with portions copyright Dolby International AB, Ericsson AB,

   Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V., Huawei Technologies Co. LTD.,

   Koninklijke Philips N.V., Nippon Telegraph and Telephone Corporation, Nokia Technologies Oy, Orange,

   Panasonic Holdings Corporation, Qualcomm Technologies, Inc., VoiceAge Corporation, and other

Workspace_msvc/lib_util.vcxproj

+2 −0
Original line number Diff line number Diff line
@@ -120,6 +120,7 @@ 
    <ClCompile Include="..\lib_util\masa_file_reader.c" />

    <ClCompile Include="..\lib_util\masa_file_writer.c" />

    <ClCompile Include="..\lib_util\mime_io.c" />

    <ClCompile Include="..\lib_util\obj_edit_file_reader.c" />

    <ClCompile Include="..\lib_util\render_config_reader.c" />

    <ClCompile Include="..\lib_util\rotation_file_reader.c" />

    <ClCompile Include="..\lib_util\rtpdump.c" />
@@ -146,6 +147,7 @@ 
    <ClInclude Include="..\lib_util\jbm_file_writer.h" />

    <ClInclude Include="..\lib_util\ls_custom_file_reader.h" />

    <ClInclude Include="..\lib_util\mime_io.h" />

    <ClInclude Include="..\lib_util\obj_edit_file_reader.h" />

    <ClInclude Include="..\lib_util\masa_file_reader.h" />

    <ClInclude Include="..\lib_util\masa_file_writer.h" />

    <ClInclude Include="..\lib_util\render_config_reader.h" />

Workspace_msvc/lib_util.vcxproj.filters

+6 −0
Original line number Diff line number Diff line
@@ -58,6 +58,9 @@ 
    <ClCompile Include="..\lib_util\mime_io.c">

      <Filter>util_c</Filter>

    </ClCompile>

    <ClCompile Include="..\lib_util\obj_edit_file_reader.c">

      <Filter>util_c</Filter>

    </ClCompile>

    <ClCompile Include="..\lib_util\render_config_reader.c">

      <Filter>util_c</Filter>

    </ClCompile>
@@ -138,6 +141,9 @@ 
    <ClInclude Include="..\lib_util\mime_io.h">

      <Filter>util_h</Filter>

    </ClInclude>

    <ClInclude Include="..\lib_util\obj_edit_file_reader.h">

      <Filter>util_h</Filter>

    </ClInclude>

    <ClInclude Include="..\lib_util\render_config_reader.h">

      <Filter>util_h</Filter>

    </ClInclude>