Commit 6cbee549 authored by norvell's avatar norvell
Browse files

Merge branch 'main' into rtp-updates-sa4-134

parents 4c69474d e6ca4b24
Loading
Loading
Loading
Loading
Loading
+65 −63
Original line number Diff line number Diff line
@@ -38,6 +38,7 @@ in ISO/IEC C99. The system is implemented as six separate programs:
        IVAS_cod        IVAS Encoder
        IVAS_dec        IVAS Decoder
        IVAS_rend       IVAS External Renderer
        ISAR_post_rend  ISAR Post Renderer
        IVAS_cod_fmtsw  IVAS Encoder with support for format switching
        ambi_converter  example program for Ambisonics format conversion

@@ -135,6 +136,7 @@ should have the following structure:
    |-- lib_lc3plus
    |-- lib_rend
    |-- lib_util
    |-- scripts

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
@@ -322,14 +324,13 @@ Options:
                      left or l or 90->left, right or r or -90->right, center or c or  0->middle
-exof File          : External orientation trajectory File for simulation of external orientations
-dpid ID            : Directivity pattern ID(s) (space-separated list of up to 4 numbers can be 
                      specified) for binaural output configuration
-aeid ID | File     : Acoustic environment ID (number > 0) or
                      alternatively, it can be a text file where each line contains "ID duration"
                      for BINAURAL_ROOM_REVERB output configuration.
                      specified) for binaural output configurations
-aeid ID | File     : Acoustic environment ID (number > 0) or a text file where each line 
                      contains "ID duration" for BINAURAL_ROOM_REVERB output configuration
-obj_edit File      : Object editing instructions file or NULL for built-in example
-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).
-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation
                      Currently, all values default to level 3 (full functionality)
-om File            : Coded metadata File for BINAURAL_SPLIT_PCM output configuration
-q                  : Quiet mode, limit printouts to terminal, default is deactivated


@@ -361,11 +362,11 @@ Options:
                      left or l or 90->left, right or r or -90->right, center or c or 0 ->middle
-exof File          : External orientation trajectory File for simulation of external orientations
-dpid ID            : Directivity pattern ID(s) (space-separated list of up to 4 numbers can be 
                      specified) for binaural outputs
-aeid ID | File     : Acoustic environment ID (number > 0)
                      alternatively, it can be a text file where each line contains "ID duration" for BINAURAL_ROOM_REVERB output.
                      specified) for binaural output configurations
-aeid ID | File     : Acoustic environment ID (number > 0) or a text file where each line 
                      contains "ID duration" for BINAURAL_ROOM_REVERB output configuration
-lp Position        : Output LFE position. Comma-delimited triplet of [gain, azimuth, elevation] where gain is linear 
                      (like --gain, -g) and azimuth, elevation are in degrees.
                      (like --gain, -g) and azimuth, elevation are in degrees
                      If specified, overrides the default behavior which attempts to map input to output LFE channel(s)
-lm File            : LFE panning matrix File (CSV table) containing a matrix of dimensions 
                      [ num_input_lfe x num_output_channels ] with elements specifying linear routing gain (like --gain, -g). 
@@ -374,15 +375,14 @@ 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 (only for BINAURAL_SPLIT_PCM output)
-prbfi File         : BFI File (only for BINAURAL_SPLIT_PCM output)
-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation.
-om File            : Coded metadata File for BINAURAL_SPLIT_PCM output configuration
-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 as follows:
-----------------------------------------------------
The usage of the "ISAR_post_rend" program is as follows:
--------------------------------------------------------

Usage: ISAR_post_rend [options]

@@ -396,6 +396,34 @@ Options:
-prbfi File         : BFI File


The usage of the "ambi_converter" program is as follows:
--------------------------------------------------------

Usage: ambi_converter input_file output_file input_convention output_convention

input_convention and output convention must be an integer number in [0,5]
the following conventions are supported:
0 : ACN-SN3D
1 : ACN-N3D
2 : FuMa-MaxN
3 : FuMa-FuMa
4 : SID-SN3D
5 : SID-N3D

Either the input or the output convention must always be ACN-SN3D.


The usage of the "IVAS_cod_fmtsw" program is as follows:
--------------------------------------------------------

Usage: IVAS_cod_fmtsw format_switching_file

Mandatory parameters:
---------------------
format_switching_file:   Text file containing a valid encoder command line in each line



                       MULTICHANNEL LOUDSPEAKER INPUT / OUTPUT CONFIGURATIONS
                       ======================================================
The loudspeaker positions for each MC layouts are assumed to have the following azimuth and elevation
@@ -423,31 +451,6 @@ omitted, the LFE input is downmixed to all channels with a factor of 1/N. Positi
the LFE channel. Maximum number of supported loudskpeakers N is 16.
An example custom loudspeaker layout file is available: ls_setup_16ch_8+4+4.txt

The usage of the "ambi_converter" program as follows:
-----------------------------------------------------

Usage: ambi_converter input_file output_file input_convention output_convention

input_convention and output convention must be an integer number in [0,5]
the following conventions are supported:
0 : ACN-SN3D
1 : ACN-N3D
2 : FuMa-MaxN
3 : FuMa-FuMa
4 : SID-SN3D
5 : SID-N3D

Either the input or the output convention must always be ACN-SN3D.

The usage of the "IVAS_cod_fmtsw" program is as follows:
--------------------------------------------------------

Usage: IVAS_cod_fmtsw format_switching_file

Mandatory parameters:
---------------------
format_switching_file:   Text file containing a valid encoder command line in each line


                       RUNNING THE SELF TEST
                       =====================
@@ -720,4 +723,3 @@ typedef struct {
  u_int32 length;                   /* size of the RTP packet in bytes  */
  (u_int8 * length) RTP_packet;     /* RTP packet (sized length * byte) */
} RTP_streaming_packet;