Commit c8a81fee authored by emerit's avatar emerit
Browse files

Merge branch 'main' into 744-fix-sofa-to-rom-tables-and-binaural-binary-files

parents 13afda5e eb137f09

.gitlab-ci.yml

+54 −73
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ variables: 
  EXIT_CODE_FAIL: 1

  PROCESSING_SCRIPTS_BIN_DIR: "/test-bin"

  TESTS_DIR_CODEC_BE_ON_MR: "tests/codec_be_on_mr_nonselection"

  IVAS_PIPELINE_NAME: ''

  MANUAL_PIPELINE_TYPE:

    description: "Type for the manual pipeline run. Use 'test-be-release' to run BE test against release codec."

    value: 'default'
@@ -25,23 +26,36 @@ default: 


# This sets when pipelines are created. Jobs have more specific rules to restrict them.

workflow:

  name: '$IVAS_PIPELINE_NAME'

  rules:

    # see https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines

    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"

      when: never

    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'

      variables:

        IVAS_PIPELINE_NAME: 'MR pipeline: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME'

    - if: $CI_PIPELINE_SOURCE == 'push' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH # Pushes to main

      variables:

        IVAS_PIPELINE_NAME: 'Push pipeline: $CI_COMMIT_BRANCH'

    - if: $CI_PIPELINE_SOURCE == 'schedule' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH # Scheduled in main

    - if: $CI_PIPELINE_SOURCE == 'web' # for testing

      variables:

        IVAS_PIPELINE_NAME: 'Scheduled pipeline: $CI_COMMIT_BRANCH'

    - if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'default' # for testing

      variables:

        IVAS_PIPELINE_NAME: 'Web run pipeline: $CI_COMMIT_BRANCH'

    - if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'test-be-release'

      variables:

        IVAS_PIPELINE_NAME: 'Test BE to release pipeline: $CI_COMMIT_BRANCH'

    - if: $CI_PIPELINE_SOURCE == 'trigger'



stages:

  - .pre

  - maintenance

  - prevalidate

  - build

  - test

  - compare

  - validate

  - postvalidate

  - deploy



# ---------------------------------------------------------------
@@ -133,6 +147,14 @@ stages: 
  - sed -i.bak -e "s/\/\*[[:space:]]*\(#define[[:space:]]*SPLIT_REND_WITH_HEAD_ROT\)[[:space:]]*\*\//\1/g" ./lib_com/options.h

  - sed -i.bak -e "s/\/\/[[:space:]]*\(#define[[:space:]]*SPLIT_REND_WITH_HEAD_ROT\)/\1/g"        ./lib_com/options.h



.get-commits-behind-count: &get-commits-behind-count

  - echo $CI_COMMIT_SHA

  - echo $CI_MERGE_REQUEST_TARGET_BRANCH_NAME

  - commits_behind_count=$(git rev-list --count $CI_COMMIT_SHA..origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME)



.check-commits-behind-count-in-compare-jobs: &check-commits-behind-count-in-compare-jobs

  - if [ $commits_behind_count -ne 0 ]; then echo "Your branch is not up-to-date with main -> Compare tests will not run as they can contain false negatives this way.\nMain might have changed during your pipeline run. Run 'git merge origin/main' to update."; exit 1; fi



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

# Job templates

# ---------------------------------------------------------------
@@ -179,11 +201,13 @@ stages: 
.build-job-linux:

  stage: build

  timeout: "4 minutes"

  needs: []

  tags:

    - ivas-linux



.build-job-windows:

  stage: build

  needs: []

  timeout: "4 minutes"

  tags:

    - ivas-windows
@@ -236,19 +260,28 @@ uninterruptible: 
# Validation jobs

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



check-if-branch-is-up-to-date-with-main:

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

  extends:

    - .rules-merge-request

  stage: validate

  stage: prevalidate

  needs: []

  tags:

    - ivas-linux

  script:

    - echo $CI_COMMIT_SHA

    - echo $CI_MERGE_REQUEST_TARGET_BRANCH_NAME

    - commits_behind_count=$(git rev-list --count $CI_COMMIT_SHA..origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME)

    - *get-commits-behind-count

    - echo $commits_behind_count

    - if [ $commits_behind_count -eq 0 ]; then exit 0; else exit 1; fi;

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



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

  extends:

    - .rules-merge-request

  stage: postvalidate

  tags:

    - ivas-linux

  script:

    - *get-commits-behind-count

    - 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;



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

# Build jobs
@@ -530,6 +563,8 @@ renderer-pytest-on-merge-request: 
  stage: compare

  script:

    - *print-common-info

    - *get-commits-behind-count

    - *check-commits-behind-count-in-compare-jobs



    # some helper variables - "|| true" to prevent failures from grep not finding anything

    # write to temporary file as workaround for failures observed with piping echo
@@ -611,6 +646,8 @@ split-rendering-pytest-on-merge-request: 
  stage: compare

  script:

    - *print-common-info

    - *get-commits-behind-count

    - *check-commits-behind-count-in-compare-jobs



    # some helper variables - "|| true" to prevent failures from grep not finding anything

    # write to temporary file as workaround for failures observed with piping echo
@@ -674,6 +711,8 @@ ivas-pytest-on-merge-request: 
  timeout: "10 minutes"

  script:

    - *print-common-info

    - *get-commits-behind-count

    - *check-commits-behind-count-in-compare-jobs

    - *merge-request-comparison-setup-codec



    # some helper variables - "|| true" to prevent failures from grep not finding anything
@@ -726,6 +765,8 @@ evs-pytest-on-merge-request: 
  timeout: "10 minutes"

  script:

    - *print-common-info

    - *get-commits-behind-count

    - *check-commits-behind-count-in-compare-jobs

    - *merge-request-comparison-setup-codec



    # some helper variables - "|| true" to prevent failures from grep not finding anything
@@ -770,8 +811,8 @@ voip-be-on-merge-request: 
  extends:

    - .test-job-linux-needs-testv-dir

    - .rules-merge-request

  stage: compare # Or should it be test? Comparison is done within one git revision

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

  stage: test

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

  timeout: "10 minutes"

  script:

    - *print-common-info
@@ -783,7 +824,7 @@ clang-format-check: 
    - .rules-merge-request

  variables:

    ARTIFACT_BASE_NAME: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--formatting-fix"

  stage: validate

  stage: prevalidate

  needs: []

  timeout: "5 minutes"

  script:
@@ -830,7 +871,7 @@ check-first-frame-is-sid: 
  tags:

    - ivas-linux

  stage: test

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

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

  script:

    - *print-common-info

    - *update-ltv-repo
@@ -860,50 +901,11 @@ check-first-frame-is-sid: 
    expose_as: "logs-sidstart"

    expire_in: "5 days"



selection-test-processing:

  extends:

    - .test-job-linux-needs-testv-dir

    - .rules-merge-request

  tags:

    - processing-scripts-linux

  stage: test

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

  script:

    # get processing script code

    - git clone https://forge.3gpp.org/rep/ivas-codec-pc/ivas-processing-scripts.git --single-branch -b main



    - mkdir -p ivas-processing-scripts/tests/data/testv

    - cp -r scripts/testv/* ivas-processing-scripts/tests/data/testv/



    # copy binaries into local bin dir, those should take precendence over PATH

    - cp $PROCESSING_SCRIPTS_BIN_DIR/* ivas-processing-scripts/ivas_processing_scripts/bin/

    # for testing with native binaries

    - rm ivas-processing-scripts/ivas_processing_scripts/bin/IVAS*.exe

    - rm ivas-processing-scripts/ivas_processing_scripts/bin/EVS*.exe



    # build codec and put into bin dir

    - make -j

    - cp ./IVAS_* ivas-processing-scripts/ivas_processing_scripts/bin/



    # patch the use_windows_codec_binaries key (weird folding is needed so colons are accepted)

    - >

      sed -i "s/use_windows_codec_binaries: true/use_windows_codec_binaries: false/" ivas-processing-scripts/experiments/selection/*/config/*.yml



    # run experiments test

    - cd ivas-processing-scripts

    - python3 -m pytest tests/test_experiments.py::test_generate_test_items -n auto | tee log.txt

  artifacts:

    paths:

      - ivas-processing-scripts/experiments/selection/*/proc_output/*.log

      - log.txt

    when: on_failure

    expire_in: 1 week



lc3plus-ensure-no-code-changes:

  extends:

    - .test-job-linux

    - .rules-merge-request

  stage: validate

  stage: postvalidate

  needs: []

  timeout: "5 minutes"

  script:
@@ -1525,27 +1527,6 @@ complexity-StereoDmxEVS-stereo-in-mono-out: 
# Other jobs

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



upload-selection-BE-log:

  rules:

    - if: $UPLOAD_SELECTION_BE_RESULTS && $CI_PIPELINE_SOURCE == 'trigger'

      when: always

  timeout: 5 minutes

  tags:

    - ericsson-windows-runner

  script:

    - cp -r $SELECTION_BE_RESULT ./selection-BE-result

    - Get-Content -Path selection-BE-result/public_log--sha-*.txt

    - $has_failed_debugging_active = (Select-String -Path selection-BE-result/public_log--sha-*.txt -Pattern '^FAILED tests' -CaseSensitive).Line

    - Get-Content -Path selection-BE-result/public_log_DEBUGGING_inactive--sha-*.txt

    - $has_failed_debugging_inactive = (Select-String -Path selection-BE-result/public_log_DEBUGGING_inactive--sha-*.txt -Pattern '^FAILED tests' -CaseSensitive).Line

    - If($has_failed_debugging_active -or $has_failed_debugging_inactive) {exit -1}

  artifacts:

    paths:

      - selection-BE-result/public_log--sha-*.txt

      - selection-BE-result/public_log_DEBUGGING_inactive--sha-*.txt

    when: always

    expire_in: 1 week



# job that sets up gitlab pages website

pages:

  stage: deploy

lib_com/bits_alloc.c

+14 −7
Original line number Diff line number Diff line
@@ -476,6 +476,10 @@ static ivas_error acelp_FCB_allocator( 
        }



        /* try to increase the FCB of the first subframe in cases when the next step is lower than the current step */

#ifdef NONBE_FIX_694_OMASA_ACELP

        if ( fixed_cdk_index[sfr] < ACELP_FIXED_CDK_NB - 1 )

        {

#endif

            step = fcb_table( fixed_cdk_index[sfr] + 1, L_subfr ) - fcb_table( fixed_cdk_index[sfr], L_subfr );

            if ( *nBits >= step && cdbk >= 0 )

            {
@@ -489,6 +493,9 @@ static ivas_error acelp_FCB_allocator( 
                    *nBits -= step;

                }

            }

#ifdef NONBE_FIX_694_OMASA_ACELP

        }

#endif

    }

    /* TRANSITION coding: allocate highest FCBQ bit-budget to the subframe with the glottal-shape codebook */

    if ( tc_subfr >= L_SUBFR )

lib_com/ivas_cnst.h

+4 −0
Original line number Diff line number Diff line
@@ -1190,7 +1190,11 @@ enum 


#define QMETADATA_MAXBIT_REQ_MASA               900                         /* max bit-bit/direction for avoiding requantization in MASA path */

#define QMETADATA_MAXBIT_REQ_SBA                400                         /* max bit-bit/direction for avoiding requantization in SBA path */

#ifdef NONBE_FIX_760_COHERENCE_MASA

#define MASA_COH_LIMIT_2IDX                     96                          /* limit for sum of values across components for having two joint indexes */

#else

#define MASA_COH_LIMIT_2IDX                     144                         /* limit for sum of values across components for having two joint indexes */

#endif

#define QMETADATA_MAX_NO_DIRECTIONS             2

#define MASA_MAX_BITS                           1300                        /* max. bit-budget for MASA metadata */

lib_com/ivas_stereo_td_bit_alloc.c

+11 −0
Original line number Diff line number Diff line
@@ -308,7 +308,18 @@ void tdm_bit_alloc( 
    {

        *total_brate_sec = min( *total_brate_sec, element_brate_wo_meta - ( 5900 + BWE_brate ) );



#ifdef NONBE_FIX_694_OMASA_ACELP

        if ( coder_type == INACTIVE )

        {

            *total_brate_sec = max( *total_brate_sec, tdm_bit_allc_tbl[0][0] ); /* sanity check to ensure the secondary channel always gets the minimal bitrate it needs */

        }

        else

        {

            *total_brate_sec = max( *total_brate_sec, 3500 ); /* sanity check to ensure the secondary channel always gets the minimal bitrate it needs */

        }

#else

        *total_brate_sec = max( *total_brate_sec, tdm_bit_allc_tbl[idx][coder_type] ); /* sanity check to ensure the secondary channel always gets the minimal bitrate it needs */

#endif

    }



    /* Secondary channel bitrate adjusment                                                      */

lib_com/options.h

+6 −3
Original line number Diff line number Diff line
@@ -160,15 +160,18 @@ 


/* #################### End BE switches ################################## */



#define FIX_INV_DIFFUSE_WEIGHT                          /* Orange : Fix error in energy compensation in late binaural reverb*/

#define FIX_638_ENERGIE_IAC_ROM_TABLES                  /* Missing left/right and coherence late reverb tables in binary format*/



/* #################### Start NON-BE switches ############################ */

/* any switch which is non-be wrt selection floating point code */

/* all switches in this category should start with "NONBE_" */



#define NONBE_FIX_736_FOA_BR_SWITCH                           /* FhG/Dlb : Issue 736: FOA bitrate switching decoding crashes in in ivas_spar_to_dirac */

#define NONBE_FIX_746_NONDIEGETIC_MD                          /* Eri: Issue 746: The non-diegetic panning flag affects the encoder bitstream even if extended metadata is not enabled. Crashes the decoder.*/



#define FIX_INV_DIFFUSE_WEIGHT                          /* Orange : Fix error in energy compensation in late binaural reverb*/

#define FIX_638_ENERGIE_IAC_ROM_TABLES                  /* Missing left/right and coherence late reverb tables in binary format*/

#define NONBE_FIX_729_ASAN_2ISM_ACELP                         /* VA: issue 729: fix ASAN ACELP errors with 2 ISM coding using LTV */

#define NONBE_FIX_694_OMASA_ACELP                             /* Nokia: Issue #694: OMASA crash in ACELP with extreme item */

#define NONBE_FIX_760_COHERENCE_MASA                          /* Nokia: Issue 760: fixes decoder crash for some cases when all energy ratios are 1 */

/* ##################### End NON-BE switches ############################# */



/* ################## End DEVELOPMENT switches ######################### */