Commit 37ac09a1 authored by vaclav's avatar vaclav
Browse files

one more update of Readme.txt and usage_[enc/dec]()

parent f80e08d7

apps/decoder.c

+4 −4
Original line number Diff line number Diff line
@@ -1554,8 +1554,6 @@ static void usage_dec( void ) 
#endif

    fprintf( stdout, "-non_diegetic_pan P : panning mono non-diegetic sound to stereo with paning P, -90<= P <=90,\n" );

    fprintf( stdout, "                      left or l or 90->left, right or r or -90->right, center or c or  0->middle\n" );

    fprintf( stdout, "-q                  : Quiet mode, no frame counter\n" );

    fprintf( stdout, "                      default is deactivated\n" );

#ifdef DEBUGGING

    fprintf( stdout, "-FEC X              : Insert frame erasures, X = 0-10 is the percentage\n" );

    fprintf( stdout, "                      of erased frames, or X may be the name of binary file or \n" );
@@ -1563,12 +1561,14 @@ static void usage_dec( void ) 
    fprintf( stdout, "                      containing FEC pattern (short values of 0 (good) or 1 (bad))\n" );

    fprintf( stdout, "                      default is OFF, if this option is not used\n" );

    fprintf( stdout, "-force R            : Force specific binaural rendering mode, R = (TDREND, CLDFBREND),\n" );

    fprintf( stdout, "-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation. \n" );

    fprintf( stdout, "                      Currently, all values default to level 3 (full functionality).\n" );

#endif

    fprintf( stdout, "-exof File          : External orientation file for external orientation trajectory\n" );

    fprintf( stdout, "-dpid ID            : Directivity pattern ID(s) (space-separated list of up to 4 numbers can be specified) for binaural output configuration\n" );

    fprintf( stdout, "-aeid ID            : Acoustic environment ID (number >= 0) for BINAURAL_ROOM_REVERB output configuration\n" );

    fprintf( stdout, "-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation. \n" );

    fprintf( stdout, "                      Currently, all values default to level 3 (full functionality).\n" );

    fprintf( stdout, "-q                  : Quiet mode, no frame counter\n" );

    fprintf( stdout, "                      default is deactivated\n" );

#ifdef DEBUG_MODE_INFO

#ifdef DEBUG_MODE_INFO_TWEAK

    fprintf( stdout, "-info <folder>      : specify subfolder name for debug output\n" );

apps/encoder.c

+9 −17
Original line number Diff line number Diff line
@@ -1912,16 +1912,8 @@ static void usage_enc( void ) 
    fprintf( stdout, "                                                for 2 ISM, 3 ISM and 4 ISM also 160000, 192000, 256000) \n" );

    fprintf( stdout, "                                                for 3 ISM and 4 ISM also 384000 \n" );

    fprintf( stdout, "                                                for 4 ISM also 512000 \n" );

    fprintf( stdout, "                      for IVAS SBA, MASA, MC R=(13200, 16400, 24400, 32000, 48000, 64000, 80000, \n" );

    fprintf( stdout, "                                                96000, 128000, 160000, 192000, 256000, 384000, 512000) \n" );

#ifdef SBA_AND_OBJECTS

    fprintf( stdout, "                      for IVAS objects-SBA R =(13200, 16400, 24400, 32000, 48000, 64000, 96000, 128000, \n" );

    fprintf( stdout, "                                                160000, 192000, 256000, 384000, 512000)\n" );

#endif

#ifdef MASA_AND_OBJECTS

    fprintf( stdout, "                      for IVAS objects-MASA R =(13200, 16400, 24400, 32000, 48000, 64000, 96000, 128000, \n" );

    fprintf( stdout, "                                                160000, 192000, 256000, 384000, 512000)\n" );

#endif

    fprintf( stdout, "                      for IVAS SBA, MASA, MC, ISM-SBA, and ISM-MASA R=(13200, 16400, 24400, 32000, 48000, 64000,\n" );

    fprintf( stdout, "                                                80000, 96000, 128000, 160000, 192000, 256000, 384000, 512000) \n" );

    fprintf( stdout, "                      Alternatively, R can be a bitrate switching file which consists of R values\n" );

    fprintf( stdout, "                      indicating the bitrate for each frame in bps. These values are stored in\n" );

    fprintf( stdout, "                      binary format using 4 bytes per value\n" );
@@ -1932,7 +1924,7 @@ static void usage_enc( void ) 


    fprintf( stdout, "Options:\n" );

    fprintf( stdout, "--------\n" );

    fprintf( stdout, "EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba, -masa, -mc\n" );

    fprintf( stdout, "EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba, -masa, -mc, -ism_sba, -ism_masa\n" );

    fprintf( stdout, "-stereo             : Stereo format \n" );

    fprintf( stdout, "-ism (+)Ch Files    : ISM format \n" );

    fprintf( stdout, "                      where Ch specifies the number of ISMs (1-4)\n" );
@@ -1946,16 +1938,16 @@ static void usage_enc( void ) 
    fprintf( stdout, "                      where Ch specifies the number of MASA input/transport channels (1 or 2): \n" );

    fprintf( stdout, "                      and File specifies input file containing parametric MASA metadata \n" );

#ifdef SBA_AND_OBJECTS

    fprintf( stdout, "-ism_sba IsmChannels SBAorder IsmFiles : SBA and ISM format \n" );

    fprintf( stdout, "                      where IsmChannels specifies the number of ISms (1-4)\n" );

    fprintf( stdout, "                      and SBAorder specifies the SBA order (1 to 3) \n" );

    fprintf( stdout, "                      and IsmFiles specify input files containing metadata, one file per object \n" );

    fprintf( stdout, "-ism_sba IsmCh +/-Order IsmFiles : SBA and ISM combined format\n" );

    fprintf( stdout, "                      where IsmCh specifies the number of ISMs (1-4)\n" );

    fprintf( stdout, "                      and Order specifies the SBA order (1 to 3) \n" );

    fprintf( stdout, "                      and IsmFiles specify input files containing ISM metadata, one file per object \n" );

#endif

#ifdef MASA_AND_OBJECTS

    fprintf( stdout, "-ism_masa IsmCh MasaCh IsmFiles MasaFile : MASA and ISM format \n" );

    fprintf( stdout, "-ism_masa IsmCh MasaCh IsmFiles MasaFile : MASA and ISM combined format \n" );

    fprintf( stdout, "                      where IsmCh specifies the number of ISMs (1-4),\n" );

    fprintf( stdout, "                      MasaCh specifies the number of MASA input/transport channels (1-2), \n" );

    fprintf( stdout, "                      IsmFiles specify input files containing metadata, one file per object, \n" );

    fprintf( stdout, "                      IsmFiles specify input files containing ISM metadata, one file per object, \n" );

    fprintf( stdout, "                      and MasaFile specifies input file containing parametric MASA metadata \n" );

#endif

    fprintf( stdout, "-mc InputConf       : Multi-channel format\n" );

readme.txt

+16 −5
Original line number Diff line number Diff line
@@ -169,7 +169,7 @@ R : Bitrate in bps, 
                                                for 2 ISM, 3 ISM and 4 ISM also 160000, 192000, 256000

                                                for 3 ISM and 4 ISM also 384000

                                                for 4 ISM also 512000

                      for IVAS SBA, MASA, MC, ISM-MASA, and ISM-SBA R=(13200, 16400, 24400, 32000, 

                      for IVAS SBA, MASA, MC, ISM-SBA, and ISM-MASA R=(13200, 16400, 24400, 32000, 

                      48000, 64000, 80000, 96000, 128000, 160000, 192000, 256000, 384000, 512000)

                      Alternatively, R can be a bitrate switching file which consists of R values

                      indicating the bitrate for each frame in bps. These values are stored in
@@ -180,7 +180,7 @@ bitstream_file : Output bitstream filename 


Options:

--------

EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba, -masa, -mc

EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba, -masa, -mc, -ism_sba, -ism_masa

-stereo             : Stereo format

-ism [+]Ch Files    : ISM format

                      where Ch specifies the number of ISMs (1-4)
@@ -193,10 +193,14 @@ EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba, 
-masa Ch File       : MASA format

                      where Ch specifies the number of MASA input/transport channels (1 or 2):

                      and File specifies input file containing parametric MASA metadata

-ism_masa IsmCh MasaCh IsmFiles MasaFile : MASA and ISM format

                      where IsmCh specifies the number of ISMs (1-4),\n" );

-ism_sba IsmCh +/-Order IsmFiles : SBA and ISM combined format

                      where IsmCh specifies the number of ISMs (1-4),

                      Order specifies the Ambisionics order (1-3)

                      and IsmFiles specify input files containing ISM metadata, one file per object

-ism_masa IsmCh MasaCh IsmFiles MasaFile : MASA and ISM combined format

                      where IsmCh specifies the number of ISMs (1-4),

                      MasaCh specifies the number of MASA input/transport channels (1-2),

                      IsmFiles specify input files containing metadata, one file per object,

                      IsmFiles specify input files containing ISM metadata, one file per object,

                      and MasaFile specifies input file containing parametric MASA metadata

-mc InputConf       : Multi-channel format

                      where InputConf specifies the channel configuration: 5_1, 7_1, 5_1_2, 5_1_4, 7_1_4
@@ -215,10 +219,13 @@ EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba, 
                      alternatively, B can be a text file where each line contains "nb_frames B"

-no_delay_cmp       : Turn off delay compensation

-stereo_dmx_evs     : Stereo downmix function for EVS

-binaural           : Optional indication that input is binaural audio (to be used with -stereo or -stereo_dmx_evs)

-mime               : Mime output bitstream file format

                      The encoder produces TS26.445 Annex.2.6 Mime Storage Format, (not RFC4867 Mime Format).

                      default output bitstream file format is G.192

-bypass mode        : SBA PCA by-pass, mode = (1, 2), 1 = PCA off, 2 = signal adaptive, default is 1

-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
@@ -274,6 +281,8 @@ Options: 
-dpid ID            : Directivity pattern ID(s) (space-separated list of up to 4 numbers can be 

                      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.

                      Currently, all values default to level 3 (full functionality).

-q                  : Quiet mode, limit printouts to terminal, default is deactivated
@@ -313,6 +322,8 @@ Options: 
                      specified) for binaural output configuration

-aeid ID            : Acoustic environment ID (number >= 0) for BINAURAL_ROOM_REVERB output config.

-smd                : Metadata Synchronization Delay in ms, Default is 0. Quantized by 5ms subframes.

-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