Commit be4504e2 authored by Shikha Shetgeri's avatar Shikha Shetgeri
Browse files

Merge branch 'main' into 608-optimise-memory-allocation-in-fastconv-renderer

parents 4c814379 481a7b16

.gitlab-ci.yml

+49 −0
Original line number Diff line number Diff line
@@ -388,6 +388,28 @@ codec-asan: 
      - test_output.txt

    expose_as: "asan selftest results"



# code selftest testvectors with address-sanitizer binaries

codec-usan:

  extends:

    - .test-job-linux

    - .rules-merge-request

  stage: test

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

  script:

    - *print-common-info

    - make clean

    - make -j CLANG=3

    - UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1 python3 scripts/self_test.py --create

    - grep_exit_code=0

    - grep UndefinedBehaviorSanitizer scripts/ref/logs/* || grep_exit_code=$?

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

  artifacts:

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

    expire_in: 1 week

    paths:

      - scripts/ref/logs/

    expose_as: "usan selftest results"



# test renderer executable

renderer-smoke-test:

  extends:
@@ -455,6 +477,33 @@ renderer-msan: 
      junit:

        - report-junit.xml



# test renderer executable with cmake + usan

renderer-usan:

  extends:

    - .test-job-linux

    - .rules-merge-request

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

  stage: test

  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

    - 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



  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



# compare renderer bitexactness between target and source branch

renderer-pytest-on-merge-request:

  extends:

CMakeLists.txt

+14 −2
Original line number Diff line number Diff line
@@ -70,8 +70,20 @@ if(UNIX) 
      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address")

      set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address")

    elseif("${CLANG}" MATCHES "3" OR "${CLANG}" MATCHES "usan")

      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=undefined")

      set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=undefined")

      # NOTE: keep in sync with list in Makefile

      set(USAN_CHECKS_ENABLE

        undefined # Default checks

        # Extra checks

        float-divide-by-zero

        implicit-conversion

        local-bounds

      )

      list(JOIN USAN_CHECKS_ENABLE "," USAN_CHECKS_ENABLE)



      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=${USAN_CHECKS_ENABLE} -fsanitize-recover=${USAN_CHECKS_ENABLE}")

      set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=${USAN_CHECKS_ENABLE} -fsanitize-recover=${USAN_CHECKS_ENABLE}")

    else()

      message(FATAL_ERROR "Unknown CLANG setting: ${CLANG}")

    endif()

  endif()

  # GCOV

Makefile

+6 −2
Original line number Diff line number Diff line
@@ -77,8 +77,12 @@ LDFLAGS += -fsanitize=address 
endif

ifeq "$(CLANG)" "3"

CC       = $(CCCLANG) 

CFLAGS  += -fsanitize=undefined

LDFLAGS += -fsanitize=undefined

# NOTE: keep in sync with list in CMakeLists.txt

usan_checks = undefined,float-divide-by-zero,implicit-conversion,local-bounds

CFLAGS  += -fsanitize=$(usan_checks) 

CFLAGS  += -fsanitize-recover=$(usan_checks) 

LDFLAGS += -fsanitize=$(usan_checks)

LDFLAGS += -fsanitize-recover=$(usan_checks)

endif



ifeq "$(RELEASE)" "1"

apps/renderer.c

+37 −0
Original line number Diff line number Diff line
@@ -175,6 +175,9 @@ typedef struct 
    float lfeConfigElevation;

    bool lfeCustomRoutingEnabled;

    char inLfePanningMatrixFile[RENDERER_MAX_CLI_ARG_LENGTH];

#ifdef FIX_488_SYNC_DELAY

    float syncMdDelay;

#endif

} CmdlnArgs;



typedef enum
@@ -203,6 +206,9 @@ typedef enum 
#endif

    CmdLnOptionId_referenceVectorFile,

    CmdLnOptionId_exteriorOrientationFile,

#ifdef FIX_488_SYNC_DELAY

    CmdLnOptionId_syncMdDelay,

#endif

} CmdLnOptionId;



static const CmdLnParser_Option cliOptions[] = {
@@ -342,6 +348,14 @@ static const CmdLnParser_Option cliOptions[] = { 
        .matchShort = "exof",

        .description = "External orientation trajectory file for simulation of external orientations",

    },

#ifdef FIX_488_SYNC_DELAY

    {

        .id = CmdLnOptionId_syncMdDelay,

        .match = "sync_md_delay",

        .matchShort = "smd",

        .description = "Metadata Synchronization Delay in ms, Default is 0. Quantized by 5ms subframes for TDRenderer (13ms -> 10ms -> 2subframes)",

    },

#endif

};
@@ -1113,6 +1127,9 @@ int main( 
    if ( args.inConfig.numAudioObjects > 0 )

    {

        IVAS_REND_SetTotalNumberOfObjects( hIvasRend, args.inConfig.numAudioObjects );

#ifdef FIX_488_SYNC_DELAY

        IVAS_REND_SetIsmMetadataDelay( hIvasRend, args.syncMdDelay );

#endif

    }



    IVAS_REND_LfePanMtx lfePanMatrix;
@@ -1687,6 +1704,8 @@ int main( 
                }

            }

        }





#ifdef SPLIT_REND_WITH_HEAD_ROT

        for ( i = 0; i < args.inConfig.numBinBuses; ++i )

        {
@@ -1897,6 +1916,13 @@ int main( 
    }

#endif



#ifdef FIX_488_SYNC_DELAY

    if ( args.inConfig.numAudioObjects != 0 && ( args.outConfig.audioConfig == IVAS_REND_AUDIO_CONFIG_BINAURAL || args.outConfig.audioConfig == IVAS_REND_AUDIO_CONFIG_BINAURAL_ROOM_REVERB ) )

    {

        fprintf( stdout, "\n\nMetadata delayed %d subframes\n\n", (int16_t) round( args.syncMdDelay / ( 1000 / FRAMES_PER_SEC / MAX_PARAM_SPATIAL_SUBFRAMES ) ) );

    }

#endif



    if ( !args.quietModeEnabled && args.delayCompensationEnabled )

    {

        fprintf( stdout, "\nRenderer delay:         %-5u [samples] - Timescale: %5u\n", delayNumSamples_orig, delayTimeScale );
@@ -2483,6 +2509,10 @@ static CmdlnArgs defaultArgs( 


    args.lfeCustomRoutingEnabled = false;

    clearString( args.inLfePanningMatrixFile );



#ifdef FIX_488_SYNC_DELAY

    args.syncMdDelay = 0;

#endif

    return args;

}
@@ -2622,6 +2652,13 @@ static void parseOption( 
                exit( -1 );

            }

            break;

#ifdef FIX_488_SYNC_DELAY

        case CmdLnOptionId_syncMdDelay:

            assert( numOptionValues == 1 );

            /* Metadata Delay to sync with audio delay in ms */

            args->syncMdDelay = strtof( optionValues[0], NULL );

            break;

#endif

        default:

            assert( 0 && "This should be unreachable - all command line options should be explicitly handled." );

            break;

lib_com/options.h

100644 → 100755
+21 −0
Original line number Diff line number Diff line
@@ -158,9 +158,26 @@ 
#define FIX_559_EXTL_IGF_MISMATCH                       /* VA: issue 559: fix mismatch between st->extl and st->igf observed as crash in PlanarSBA bitrate switching */

#define FIX_571_REVERB_NOT_ACTIVATED_ISM                /* Philips: Issue 571: Reverb not activated for discrete and parametric ISM */

#define FIX_QMETA_SID_5k2                               /* Nokia: Issue 137: enable using full 5.2k bitrate in MASA SID */



#define FIX_578_PARAMMC_ILD_BS                          /* FhG: Issue 578: transmitt also center ILD in band 0 when LFE is active in 3TC ParamMC */

#define FIX_UNCLR_ISSUE                                 /* VoiceAge: issue 574: Fix UNCLR mis-classifications in noisy speech stereo */

#define FIX_TCX_LOWRATE_LIMITATION                      /* VA: issue 577: TCX bitrate limitation only when DEBUGGING is active */

#define FIX_575_LOW_OVERLAP_PLC_RECOVERY                /* FhG: Issue 575 fix for PLC and transistion to TCX5*/



#define FIX_488_SYNC_DELAY                             /* Eri: Issue 488: Waveform and MD desynchronized in external renderer */



#define FIX_550_FIRST_FRAME_ACCESS                      /* Eri: Issue 550: TD Object renderer: first frame accesses wrong transport channel offsets */

#define FIX_550_FIRST_FRAME_ACCESS_ALT                  /* Eri: Issue 550: Should be merged with FIX_550_FIRST_FRAME_ACCESS above, or accepted at the same time */

#define FIX_569_TD_FILTER_LENGTH                        /* Eri: Issue 569: If an HRTF binary file exceeds the SFX_SPAT_BIN_MAX_FILTER_LENGTH the decoder crashes. This truncates the filter when generated from the model.  */



#define ISM_FB_16k4                                     /* VA: Issue: 579: change BW from SWB to FB in NxISM conditions to match the EVS codec */



#define FIX_580_PARAMMC_ENER_BURSTS                     /* FhG: issue 580: energy bursts due to ILD holding when energy relations change too much */



#define FIX_550_FIRST_FRAME_ACCESS                      /* Eri: Issue 550: TD Object renderer: first frame accesses wrong transport channel offsets */

#define FIX_550_FIRST_FRAME_ACCESS_ALT                  /* Eri: Issue 550: Should be merged with FIX_550_FIRST_FRAME_ACCESS above, or accepted at the same time */

#define FIX_569_TD_FILTER_LENGTH                        /* Eri: Issue 569: If an HRTF binary file exceeds the SFX_SPAT_BIN_MAX_FILTER_LENGTH the decoder crashes. This truncates the filter when generated from the model.  */



#define FIX_595_SHL_NOGLOB                              /* FhG: Issue 595: compilation with BASOP_NOGLOB disabled */

#define UPDATE_FASTCONV_SBA_FILTER                      /* Dlb: Issue 584: Update SBA CLDFB-Domain HRTFs */

#define FIX_570_SF_EXT_ORIENTATION
@@ -171,6 +188,7 @@ 
#define FIX_MEM_REALLOC_IND_LIST                        /* VA: issue 601: failure of the automatic memory re-allocation mechanism when ind_list[] buffer is depleted in MASA mode with 2 TC*/

#define FIX_1720_HRTF_FASTCONV                          /* Dlb : Binaural and Binaural room format RAM saving in SBA mode */

#define JBM_PARAMUPMIX                                  /* Dlb: Issue 471: Integrate the Multichannel Parametric Upmix into the JBM path */

#define FIX_194_LFE_DELAY_EXTREND                       /* FhG: Issue 194: Fix delay alignment of LFE in external renderer */

#define FIX_582_INDEX_OUT_OF_BOUNDS_SNS_AVQ_DEC         /* FhG: fix an undefined behaviour error in SNS AVQ decoding */

#define FIX_614_ADD_TO_NULL_PTR_DIRAC_SETUP             /* FhG: Issue 614: prevent adding to a null pointer in dirac setup code */

#define UPDATE_REVERB_UTILS                             /* Use CLDFB HRTFs of the appropriate SBA order in get_IR_from_filter_taps() */
@@ -190,6 +208,9 @@ 
#define FIX_622_SILENCE_USAN_WARNING                    /* FhG: silenceusan warning in ifft code */



#define FIX_615_UBSAN_SPAR_TO_DIRAC                     /*Dlb : Fix for UBSAN issue 615*/

#define FIX_626_VARIABLE_TYPE_MDCT_CONC                 /* FhG: trivial fix to fix USAN error */

#define FIX_616_DIV_ZERO_MCT                            /*FhG : Fix UBSAN division by zero error of issue 616*/



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