Commit 14f0c622 authored by vaclav's avatar vaclav
Browse files

Merge branch '1706-ref-PortFlpMR1557' into 'ivas-float-update'

Port MR1557 from float to FLP

See merge request !1973
parents f7aeb6f9 aab36f58
Loading
Loading
Loading
Loading
+34 −13
Original line number Diff line number Diff line
@@ -33,11 +33,12 @@

These files represent the 3GPP EVS Codec Extension for Immersive Voice and 
Audio Services (IVAS) floating-point C simulation. All code is writtten
in ISO/IEC C99. The system is implemented as three separate programs:
in ISO/IEC C99. The system is implemented as four separate programs:

        IVAS_cod   Encoder
        IVAS_dec   Decoder
        IVAS_rend  Renderer
        IVAS_cod   	    IVAS Encoder
        IVAS_dec   	    IVAS Decoder
        IVAS_rend  	    IVAS External Renderer
        ISAR_post_rend  ISAR Post Renderer

For encoding using the coder program, the input is a binary
audio file (*.8k, *.16k, *.32k, *.48k) and the output is a binary
@@ -128,6 +129,8 @@ should have the following structure:
    |-- lib_debug
    |-- lib_dec
    |-- lib_enc
    |-- lib_isar
    |-- lib_lc3plus
    |-- lib_rend    
    |-- lib_util
    |-- readme.txt
@@ -135,16 +138,16 @@ should have the following structure:

The package includes a Makefile for gcc, which has been verified on
32-bit Linux systems. The code can be compiled by entering the directory
"c-code" and typing the command: make. The resulting encoder/decoder/renderer
executables are named "IVAS_cod", "IVAS_dec", and "IVAS_rend". All reside 
in the c-code directory.
"c-code" and typing the command: make. The resulting encoder/decoder/renderer/
ISAR_post_renderer executables are named "IVAS_cod", "IVAS_dec", "IVAS_rend",
and "ISAR_post_rend". All reside in the c-code directory.

The package also includes a solution-file for Microsoft Visual Studio 2017 (x86). 
To compile the code, please open "Workspace_msvc\Workspace_msvc.sln" and build 
"encoder" for the encoder, "decoder" for the decoder, and "renderer" for the 
renderer executable. The resulting encoder/decoder/renderer executables are 
"IVAS_cod.exe", "IVAS_dec.exe", and "IVAS_rend.exe". All reside in the c-code 
main directory. 
renderer executable. The resulting encoder/decoder/renderer/ISAR_post_renderer 
executables are "IVAS_cod.exe", "IVAS_dec.exe", "IVAS_rend.exe", and
"ISAR_post_rend.exe". All reside in the c-code main directory. 


                       RUNNING THE SOFTWARE
@@ -239,7 +242,8 @@ Usage for IVAS: IVAS_dec.exe [Options] OutputConf Fs bitstream_file output_file
Mandatory parameters:
---------------------
OutputConf           : Output configuration: MONO, STEREO, 5_1, 7_1, 5_1_2, 5_1_4, 7_1_4, FOA,
                      HOA2, HOA3, BINAURAL, BINAURAL_ROOM_IR, BINAURAL_ROOM_REVERB, EXT
                      HOA2, HOA3, BINAURAL, BINAURAL_ROOM_IR, BINAURAL_ROOM_REVERB, 
                      BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM, EXT
                       By default, channel order and loudspeaker positions are equal to the
                       encoder. For loudspeaker outputs, OutputConf can be a custom loudspeaker
                       layout file. See below for details.
@@ -284,6 +288,7 @@ Options:
                      specified) for binaural output configuration
-aeid ID            : Acoustic environment ID (number >= 0) for BINAURAL_ROOM_REVERB output config.
-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation.
-om File            : Coded metadata File for BINAURAL_SPLIT_PCM OutputConf
                      Currently, all values default to level 3 (full functionality).
-q                  : Quiet mode, limit printouts to terminal, default is deactivated

@@ -329,11 +334,27 @@ Options:
-g                  : Input gain (linear, not in dB) to be applied to input audio file
-l                  : List supported audio formats
-smd                : Metadata Synchronization Delay in ms, Default is 0. Quantized by 5ms subframes.
-om File            : Coded metadata File for BINAURAL_SPLIT_PCM output format
-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation.
                      Currently, all values default to level 3 (full functionality).
-q                  : Quiet mode, limit printouts to terminal, default is deactivated


The usage of the "ISAR_post_rend" program:
------------------------------------------

Usage: ISAR_post_rend [options]

Options:
--------
-i File             : Input File (input file is bitstream if format is BINAURAL_SPLIT_CODED, or PCM/WAV file if format is BINAURAL_SPLIT_PCM)
-if Format          : Input Format of input (BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM)
-im File            : Coded metadata File for BINAURAL_SPLIT_PCM input format
-o File             : Output Audio File in BINAURAL format
-fs                 : Input sampling rate in kHz (48)
-prbfi File         : BFI File


                       MULTICHANNEL LOUDSPEAKER INPUT / OUTPUT CONFIGURATIONS
                       ======================================================
The loudspeaker positions for each MC layouts are assumed to have the following azimuth and elevation