Commit 0e23791a authored by Jan Kiene's avatar Jan Kiene
Browse files

Merge branch 'main' into flaot-1469-test_format_switching-py-doesn-t-run

parents a4f82551 dfed311f

.gitlab/issue_templates/msan_ltv_error.md

+3 −8
Original line number Diff line number Diff line
@@ -16,12 +16,6 @@ Link to test pipeline: XXX 


### Ways to reproduce



Activate [origin-tracking](https://clang.llvm.org/docs/MemorySanitizer.html#msan-origins) (more detailed traceback about where the undefined value came from) by appending

```

 -fsanitize-memory-track-origins

```

in the `Makefile` at lines 71 and 72. Note that this may increase runtime heavily.



Using the [scripts](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec/-/wikis/Software-development/pyivastest-howto#how-to-reproduce-tests):

<!--- check correct sanitizer type -->

<!--- add error pattern if needed -->
@@ -30,11 +24,12 @@ Using the [scripts](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec/-/wikis/ 
```

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

```



or directly:



```

make clean

make -j CLANG=1

make -j CLANG=1 MSAN_TRACK_ORIGINS=1

./IVAS_cod ...

networkSimulator_g192 dly_profile.dat bit bit_err trace_dump 1

./IVAS_dec ...

CMakeLists.txt

+12 −5
Original line number Diff line number Diff line
@@ -37,7 +37,8 @@ set(CMAKE_C_STANDARD 99) 
if(UNIX)

  set(TARGET_PLATFORM ""  CACHE STRING "i686 / x86_64")

  set(CLANG           ""  CACHE STRING "1=msan / 2=asan / 3=usan")

  set(GCOV            OFF CACHE BOOL   "enable GCOV")

  set(MSAN_TRACK_ORIGINS OFF CACHE BOOL "enable origin tracking for Clang MSAN")

  set(COVERAGE            OFF CACHE BOOL   "enable coverage instrumentation")

  set(STRIP           OFF CACHE BOOL   "enable STRIP")



  if(NOT CMAKE_BUILD_TYPE)
@@ -62,13 +63,19 @@ if(UNIX) 
  # to be uncommented in CI

  # set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror")



  # set C compiler

  find_program(cc NAMES clang-18 clang REQUIRED)

  set(CMAKE_C_COMPILER "${cc}" CACHE STRING "")



  # CLANG

  if(CLANG)

    find_program(clangBin NAMES /home/amm-archiv/soft/Linux/clang/current/bin/clang clang REQUIRED)

    set(CMAKE_C_COMPILER "${clangBin}" CACHE STRING "")

    if("${CLANG}" MATCHES "1" OR "${CLANG}" MATCHES "msan")

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

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

      if(MSAN_TRACK_ORIGINS)

        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize-memory-track-origins")

        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize-memory-track-origins")

      endif()

    elseif("${CLANG}" MATCHES "2" OR "${CLANG}" MATCHES "asan")

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

      set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address")
@@ -89,8 +96,8 @@ if(UNIX) 
      message(FATAL_ERROR "Unknown CLANG setting: ${CLANG}")

    endif()

  endif()

  # GCOV

  if(GCOV)

  # COVERAGE

  if(COVERAGE)

    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage -fprofile-update=atomic")

    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fprofile-arcs -ftest-coverage -fprofile-update=atomic")

  endif()

Makefile

+24 −11
Original line number Diff line number Diff line
@@ -31,9 +31,8 @@ LIB_LIBISAR ?= libisar.a 
LIB_LC3PLUS  	?= liblc3plus.a

LIB_LIBUTIL  	?= libivasutil.a





# Default tool settings

CC        ?= gcc

CC        ?= cc

RM        ?= rm -f

AR        ?= ar
@@ -63,30 +62,44 @@ endif 
# C compiler flags

CFLAGS   += -std=c99 -pedantic -Wcast-qual -Wall -W -Wextra -Wno-long-long     \

            -Wpointer-arith -Wstrict-prototypes -Wmissing-prototypes  \

            -Wno-implicit-fallthrough -ffp-contract=off

            -Werror-implicit-function-declaration \

            -Wno-implicit-fallthrough -ffp-contract=off \

            -Winit-self -Wunused-but-set-variable

# to be uncommented in CI

# CFLAGS += -Werror



# libs to link

LDLIBS   += -lm



# Clang sanitizer compiler options

CCCLANG = clang

ifeq "$(CLANG)" "0"

CC       = $(CCCLANG)

# check if clang is available on system and use it if it is there

CLANG_EXISTS := $(shell which clang)



ifneq "$(CLANG_EXISTS)" ""

CC = clang

else

$(warning clang compiler not found - falling back to cc)

endif



# Clang sanitizer compiler options

ifeq "$(CLANG)" "1"

CC       = $(CCCLANG)

CC       = clang

CFLAGS  += -fsanitize=memory

LDFLAGS += -fsanitize=memory



# can be set in call to make, e.g. "make CLANG=1 MSAN_TRACK_ORIGINS=1"

ifeq "$(MSAN_TRACK_ORIGINS)" "1"

CFLAGS  += -fsanitize-memory-track-origins

LDFLAGS += -fsanitize-memory-track-origins

endif



endif

ifeq "$(CLANG)" "2"

CC       = $(CCCLANG)

CC       = clang

CFLAGS  += -fsanitize=address

LDFLAGS += -fsanitize=address

endif

ifeq "$(CLANG)" "3"

CC       = $(CCCLANG) 

CC       = clang

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

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

CFLAGS  += -fsanitize=$(usan_checks)
@@ -105,7 +118,7 @@ CFLAGS += -g3 
LDFLAGS  += -g3

endif



ifeq "$(GCOV)" "1"

ifeq "$(COVERAGE)" "1"

CFLAGS  += -fprofile-arcs -ftest-coverage -fprofile-update=atomic

LDFLAGS += -fprofile-arcs -ftest-coverage -fprofile-update=atomic

endif

Workspace_msvc/lib_rend.vcxproj.filters

+3 −0
Original line number Diff line number Diff line
@@ -122,6 +122,9 @@ 
    <ClCompile Include="..\lib_rend\ivas_cldfb_ring_buffer.c">

      <Filter>rend_c</Filter>

    </ClCompile>

    <ClCompile Include="..\lib_rend\ivas_binRenderer_internal.c">

      <Filter>rend_c</Filter>

    </ClCompile>

  </ItemGroup>

  <ItemGroup>

    <ClInclude Include="..\lib_rend\lib_rend.h" />

apps/decoder.c

+56 −0
Original line number Diff line number Diff line
@@ -175,7 +175,11 @@ typedef struct 


static bool parseCmdlIVAS_dec( int16_t argc, char **argv, DecArguments *arg );

static void usage_dec( void );

#ifdef FIX_FLOAT_1539_G192_FORMAT_SWITCH

static ivas_error decodeG192( DecArguments arg, BS_READER_HANDLE hBsReader, IVAS_DEC_HRTF_BINARY_WRAPPER *hHrtfBinary, RotFileReader *headRotReader, RotFileReader *externalOrientationFileReader, RotFileReader *refRotReader, Vector3PairFileReader *referenceVectorReader, ObjectEditFileReader *objectEditFileReader, ISAR_SPLIT_REND_BITS_DATA *splitRendBits, IVAS_DEC_HANDLE *phIvasDec, int16_t *pcmBuf );

#else

static ivas_error decodeG192( DecArguments arg, BS_READER_HANDLE hBsReader, IVAS_DEC_HRTF_BINARY_WRAPPER *hHrtfBinary, RotFileReader *headRotReader, RotFileReader *externalOrientationFileReader, RotFileReader *refRotReader, Vector3PairFileReader *referenceVectorReader, ObjectEditFileReader *objectEditFileReader, ISAR_SPLIT_REND_BITS_DATA *splitRendBits, IVAS_DEC_HANDLE hIvasDec, int16_t *pcmBuf );

#endif

static ivas_error decodeVoIP( DecArguments arg, BS_READER_HANDLE hBsReader, IVAS_DEC_HRTF_BINARY_WRAPPER *hHrtf, RotFileReader *headRotReader, RotFileReader *externalOrientationFileReader, RotFileReader *refRotReader, Vector3PairFileReader *referenceVectorReader, ObjectEditFileReader *objectEditFileReader, ISAR_SPLIT_REND_BITS_DATA *splitRendBits, IVAS_RENDER_CONFIG_DATA *renderConfig, IVAS_DEC_HANDLE *phIvasDec, int16_t *pcmBuf );

static ivas_error load_hrtf_from_file( IVAS_DEC_HRTF_BINARY_WRAPPER *hHrtfBinary, IVAS_DEC_HANDLE hIvasDec, const IVAS_AUDIO_CONFIG OutputConfig, const int32_t output_Fs );

#ifdef DEBUGGING
@@ -779,7 +783,11 @@ int main( 
    }

    else

    {

#ifdef FIX_FLOAT_1539_G192_FORMAT_SWITCH

        error = decodeG192( arg, hBsReader, &hHrtfBinary, headRotReader, externalOrientationFileReader, refRotReader, referenceVectorReader, objectEditFileReader, &splitRendBits, &hIvasDec, pcmBuf );

#else

        error = decodeG192( arg, hBsReader, &hHrtfBinary, headRotReader, externalOrientationFileReader, refRotReader, referenceVectorReader, objectEditFileReader, &splitRendBits, hIvasDec, pcmBuf );

#endif

    }



    if ( error == IVAS_ERR_OK || error == IVAS_ERR_END_OF_FILE )
@@ -1957,6 +1965,9 @@ static ivas_error initOnFirstGoodFrame( 
        uint16_t rtpDecSeed = RANDOM_INITSEED_DEC;

        uint32_t ssrc = ( (uint32_t) IVAS_RTP_OwnRandom( &rtpDecSeed ) & 0x0000FFFF ) | ( (uint32_t) IVAS_RTP_OwnRandom( &rtpDecSeed ) << 16 );

        uint16_t seqNumInitVal = IVAS_RTP_OwnRandom( &rtpDecSeed );

#ifdef FIX_1540_EXPOSE_PT_IN_RTP_HEADER_API

        uint8_t payloadType = DEFAULT_IVAS_PAYLOAD_TYPE; /* Dynamic PT are in range [96, 127] */

#endif



        if ( ( error = IVAS_DEC_GetDelay( hIvasDec, delayNumSamples_temp, &delayTimeScale_temp ) ) != IVAS_ERR_OK )

        {
@@ -1993,7 +2004,11 @@ static ivas_error initOnFirstGoodFrame( 




            /* Split Rendering RTPDump Output file */

#ifdef FIX_1540_EXPOSE_PT_IN_RTP_HEADER_API

            if ( ( error = IVAS_RTP_WRITER_Init( srRtp, arg.outputWavFilename, 1000 / ( IVAS_NUM_FRAMES_PER_SEC * splitRendCodecFrameSizeMs ), payloadType, ssrc, seqNumInitVal ) ) != IVAS_ERR_OK )

#else

            if ( ( error = IVAS_RTP_WRITER_Init( srRtp, arg.outputWavFilename, 1000 / ( IVAS_NUM_FRAMES_PER_SEC * splitRendCodecFrameSizeMs ), ssrc, seqNumInitVal ) ) != IVAS_ERR_OK )

#endif

            {

                fprintf( stderr, "\nError: Can't open SR output bitstream file for RTP output %s \n\n", arg.outputWavFilename );

                return error;
@@ -2225,7 +2240,11 @@ static ivas_error decodeG192( 
    Vector3PairFileReader *referenceVectorReader,

    ObjectEditFileReader *objectEditFileReader,

    ISAR_SPLIT_REND_BITS_DATA *splitRendBits,

#ifdef FIX_FLOAT_1539_G192_FORMAT_SWITCH

    IVAS_DEC_HANDLE *phIvasDec,

#else

    IVAS_DEC_HANDLE hIvasDec,

#endif

    int16_t *pcmBuf )



{
@@ -2233,6 +2252,9 @@ static ivas_error decodeG192( 
    uint16_t bit_stream[IVAS_MAX_BITS_PER_FRAME + 4 * 8];

    int16_t i, num_bits;

    int16_t bfi = 0;

#ifdef FIX_FLOAT_1539_G192_FORMAT_SWITCH

    IVAS_DEC_HANDLE hIvasDec = *phIvasDec;

#endif

#ifdef DEBUGGING

    int16_t fec_seed = 12558; /* FEC_SEED */

#endif
@@ -2263,6 +2285,9 @@ static ivas_error decodeG192( 
    int16_t vec_pos_update, vec_pos_len;

    SplitFileReadWrite *splitRendWriter = NULL;

    int16_t isSplitRend, isSplitCoded;

#ifdef FIX_FLOAT_1539_G192_FORMAT_SWITCH

    bool restartNeeded;

#endif



#ifdef VARIABLE_SPEED_DECODING

    if ( arg.tsmEnabled )
@@ -2594,6 +2619,37 @@ static ivas_error decodeG192( 
                    return error;

                }



#ifdef FIX_FLOAT_1539_G192_FORMAT_SWITCH

                if ( ( error = IVAS_DEC_isRestartNeeded( hIvasDec, &restartNeeded ) ) != IVAS_ERR_OK )

                {

                    return error;

                }



                if ( restartNeeded )

                {

                    IVAS_DEC_BS_FORMAT tempFormat;

                    if ( ( error = IVAS_DEC_GetFormat( hIvasDec, &tempFormat ) ) != IVAS_ERR_OK )

                    {

                        fprintf( stderr, "\nError in IVAS_DEC_GetFormat, code: %d\n", error );

                        goto cleanup;

                    }

                    IVAS_DEC_MODE codecMode = ( tempFormat == IVAS_DEC_BS_MONO ) ? IVAS_DEC_MODE_EVS : IVAS_DEC_MODE_IVAS;

                    error = restartDecoder(

                        &hIvasDec,

                        codecMode,

                        &arg,

                        NULL, /* ToDo : Provide rendererConfig */

                        NULL  /* ToDo : Provide LS Custom Data */

                    );

                    if ( error != IVAS_ERR_OK )

                    {

                        fprintf( stderr, "\nFailed to restart decoder\n" );

                        goto cleanup;

                    }

                    *phIvasDec = hIvasDec; /* Update for main()' s free */

                }

#endif



                /* Placeholder for memory reallocation */

                /* ... */