Commit a4ccf058 authored by vaclav's avatar vaclav
Browse files

update readme.txt and encoder/decoder command-line help to match the current...

update readme.txt and encoder/decoder command-line help to match the current status of the framework
parent 47f0d920
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -1178,7 +1178,7 @@ static void usage_dec( void )
    fprintf( stdout, "                      which of the two supported formats is in use.\n" );
    fprintf( stdout, "                      default bitstream file format is G.192\n" );
    fprintf( stdout, "-hrtf File          : HRTF filter File used in BINAURAL output configuration\n" );
    fprintf( stdout, "-T File             : Head rotation specified by external trajectory File\n" );
    fprintf( stdout, "-T File             : Head rotation specified by external trajectory File (only for binaural rendering)\n" );
    fprintf( stdout, "-otr tracking_type  : Head orientation tracking type: 'none', 'ref', 'avg', 'ref_vec' \n" );
    fprintf( stdout, "                      or 'ref_vec_lev' (only for binaural rendering)\n" );
    fprintf( stdout, "-rf File            : Reference rotation specified by external trajectory file\n" );
+11 −6
Original line number Diff line number Diff line
@@ -1640,18 +1640,23 @@ 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" );
#ifdef DEBUGGING
    fprintf( stdout, "-stereo [Mode]      : Stereo format, default is unified stereo \n" );
    fprintf( stdout, "                      optional for Mode: 1: DFT Stereo, 2: TD Stereo, 3: MDCT Stereo\n" );
#else
    fprintf( stdout, "-stereo             : Stereo format \n" );
#endif
    fprintf( stdout, "-ism (+)Ch Files    : ISM format \n" );
    fprintf( stdout, "                      where Ch specifies the number of ISMs (1-4)\n" );
    fprintf( stdout, "                      where positive (+) means extended metadata format is used (including orientation and radius) \n" );
    fprintf( stdout, "                      where positive (+) means extended metadata (including orientation and radius) \n" );
    fprintf( stdout, "                      and Files specify input files containing metadata, one file per object\n" );
    fprintf( stdout, "                      (use NULL for no input metadata)\n" );
    fprintf( stdout, "-sba +/-Order       : Scene Based Audio input format (Ambisonics ACN/SN3D),\n" );
    fprintf( stdout, "                      use NULL for no input metadata; extended metadata supported from 64 kbps up\n" );
    fprintf( stdout, "-sba (+/-)Order     : Scene Based Audio input format (Ambisonics ACN/SN3D),\n" );
    fprintf( stdout, "                      where Order specifies the Ambisionics order (1-3),\n" );
    fprintf( stdout, "                      where positive (+) means full 3D and negative (-) only 2D/planar components to be coded\n" );
    fprintf( stdout, "-masa Channels File : MASA format \n" );
    fprintf( stdout, "                      where Channels specifies the number of input/transport channels (1 or 2): \n" );
    fprintf( stdout, "                      where positive (+) means full 3D and negative (-) only 2D/planar components to be coded,\n" );
    fprintf( stdout, "                      default is full 3D \n" );
    fprintf( stdout, "-masa Ch File       : MASA format \n" );
    fprintf( stdout, "                      where Ch specifies the number of input/transport channels (1 or 2) \n" );
    fprintf( stdout, "                      and File specifies input file containing parametric MASA metadata \n" );
    fprintf( stdout, "-mc InputConf       : Multi-channel format\n" );
    fprintf( stdout, "                      where InputConf specifies the channel configuration: 5_1, 7_1, 5_1_2, 5_1_4, 7_1_4\n" );
+57 −42
Original line number Diff line number Diff line
@@ -126,6 +126,7 @@ should have the following structure:
....|-- lib_debug
    |-- lib_dec
    |-- lib_enc
    |-- lib_rend
    |-- lib_util
    |-- scripts
....|-- work_in_progress
@@ -134,14 +135,15 @@ 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
executables are named "IVAS_cod" and "IVAS_dec". Both reside in the c-code
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.

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 and "decoder" for the decoder executable. The resulting 
encoder/decoder executables are named "IVAS_cod.exe" and "IVAS_dec.exe". Both reside 
"encoder" for the encoder, "decoder" for the decoder executable, and "renderer" 
for the renderer executable. The resulting encoder/decoder/renderer executables 
are named "IVAS_cod.exe", "IVAS_dec.exe", and "IVAS_rend". All reside 
in the c-code directory. 


@@ -149,6 +151,7 @@ in the c-code directory.
                       ====================

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

Usage: IVAS_cod.exe [Options] R Fs input_file bitstream_file

@@ -179,23 +182,24 @@ bitstream_file : Output bitstream filename
Options:
--------
EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba, -masa, -mc
-stereo [Mode]      : Stereo format, default is unified stereo
                      optional for Mode: 1: DFT Stereo, 2: TD Stereo, 3: MDCT Stereo
-ism Channels Files : ISM format
                      where Channels specifies the number of ISMs (1-4)
                      and Files specify input files containing metadata, one file per object
                      (use NULL for no input metadata)
-sba +/-Order       : Scene Based Audio input format (Ambisonics ACN/SN3D),
-stereo             : Stereo format
-ism (+)Ch Files    : ISM format
                      where Ch specifies the number of ISMs (1-4)
					  where positive (+) means extended metadata (including orientation and radius),
                      and Files specify input files containing metadata, one file per object;
                      use NULL for no input metadata; extended metadata supported from 64 kbps up
-sba (+/-)Order     : Scene Based Audio input format (Ambisonics ACN/SN3D),
                      where Order specifies the Ambisionics order (1-3),
                      where positive (+) means full 3D and negative (-) only 2D/planar components to be coded
-masa Channels File : MASA format
                      where Channels specifies the number of input/transport channels (1 or 2):
                      where positive (+) means full 3D and negative (-) only 2D/planar components to be coded,
					  default is full 3D
-masa Ch File       : MASA format
                      where Ch specifies the number of input/transport channels (1 or 2)
                      and File 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
                      Loudspeaker positions are assumed to have azimuth and elevation as per
                      ISO/IEC 23091-3:2018 Table 3. Channel order is as per ISO/IEC 23008-3:2015 Table 95.
                      See readme.txt for details.
                      See below for details.
-dtx D              : Activate DTX mode, D = (0, 3-100) is the SID update rate
                      where 0 = adaptive, 3-100 = fixed in number of frames,
                      default is deactivated
@@ -213,13 +217,13 @@ EVS mono is default, for IVAS choose one of the following: -stereo, -ism, -sba,
-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
-agc op             : SBA Adaptive gain control, op = (0, 1), by default op is 0 or deactivated
-bypass mode        : SBA PCA by-pass, mode = (1, 2), 1 = PCA off, 2 = signal adaptive, default is 1
-q                  : Quiet mode, no frame counters
                      default is deactivated


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

Usage for EVS:   IVAS_dec.exe [Options] Fs bitstream_file output_file
Usage for IVAS:  IVAS_dec.exe [Options] OutputConf Fs bitstream_file output_file
@@ -255,8 +259,8 @@ Options:
                      Format files, the magic word in the mime file is used to determine
                      which of the two supported formats is in use.
                      default bitstream file format is G.192
-hrtf File          : HRTF filter File used in ISm format and BINAURAL output configuration
-T File             : Head rotation specified by external trajectory File
-hrtf File          : HRTF filter File used in BINAURAL output configuration
-T File             : Head rotation specified by external trajectory File (only for binaural rendering)
-otr tracking_type  : Head orientation tracking type: 'none', 'ref', 'avg', 'ref_vec'
                      or 'ref_vec_lev' (only for binaural rendering)
-rf File            : Reference rotation specified by external trajectory file
@@ -268,14 +272,13 @@ Options:
                      left or l or 1->left, right or r or -1->right, center or c or  0->middle
-q                  : Quiet mode, no frame counter
                      default is deactivated
-FEC X              : Insert frame erasures, X = 0-10 is the percentage
                      of erased frames, or X may be the name of binary file or
                      file with G192 headers indicating GOOD FRAME or BAD FRAME
                      containing FEC pattern (short values of 0 (good) or 1 (bad))
                      default is OFF, if this option is not used
-force R            : Force specific binaural rendering mode, R = (TDREND, CLDFBREND),


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

TBD


                       MULTICHANNEL LOUDSPEAKER INPUT / OUTPUT CONFIGURATIONS
                       ======================================================
@@ -302,7 +305,7 @@ The output channel ordering is 0, 1, ... N-1. The third row contains an index "L
specifying the output channel to which the LFE input will be routed if present. If the third row is 
omitted, the LFE input is downmixed to all channels with a factor of 1/N. Position is not considered for
the LFE channel.
An example custom loudspeaker layout file is available: ls_setup_16ch_8+4+4.txt
An example custom loudspeaker layout file is available in scripts/testv/ls_setup_16ch_8+4+4.txt

                       

@@ -358,8 +361,7 @@ stv2MASA1TC48c.wav - 1 channel (1 MASA transport channel), 48000 Hz, 48000 Hz, 2
stv2MASA2TC48c.wav - 2 channels (2 MASA transport channel), 48000 Hz, 48000 Hz, 144000 samples per channel


For the MASA operation modes, in addition the following metadata files
are required:
For the MASA operation modes, in addition the following metadata files are required:

stv1MASA1TC48c.met
stv1MASA1TC48n.met
@@ -374,34 +376,45 @@ latest version of the IVAS MASA C Reference Software, which was made
available at
https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_118-e/Docs/S4-220443.zip

For the ISM operation modes, in addition the following metadata files
are required:
For the ISM format operation, in addition the following metadata files are required:

stvISM1.csv
stvISM2.csv
stvISM3.csv
stvISM4.csv

These are comma separated files (csv) which indicate the per object position
in the format:
frame azimuth, elevation, distance (unit circle), spread, gain

These are comma separated files (csv) which indicate the per object position in the format:
azimuth, elevation, distance, spread, gain (one line per frame)
with the following meaning:

| Parameter   | format, value range | meaning
-----------------------------------------------------------------------------------
| azimuth     | float, [-180,180[   | azimuth; positive indicates left
| azimuth     | float, [-180,180]   | azimuth; positive indicates left
-----------------------------------------------------------------------------------
| elevation   | float, [-90,90]     | elevation; positive indicates up
-----------------------------------------------------------------------------------
| distance    | float, tbd          | distance; default: 1
| radius      | float, [0, 15.75]   | distance (extended metadata)
-----------------------------------------------------------------------------------
| spread      | float, [0,360]      | spread in angles from 0...360 deg; default: 0
-----------------------------------------------------------------------------------
| gain        | float, [0,1]        | gain; default: 1
-----------------------------------------------------------------------------------
| yaw         | float, [-180,180]   | yaw (extended metadata); positive indicates left
-----------------------------------------------------------------------------------
| pitch       | float, [-90,90]     | pitch (extended metadata); positive indicates up
-----------------------------------------------------------------------------------


For the external HRTF filter operation, example Files are available in the folder
scripts/binauralRenderer_interface/binaural_renderers_hrtf_data/:

ivas_binaural_16kHz.bin
ivas_binaural_32kHz.bin
ivas_binaural_48kHz.bin

For the Head rotation operation modes, external trajectory files are available:

For the Head rotation operation, example external trajectory files are available in the folder
scripts/testv:

headrot.csv 
headrot_case00_3000_q.csv 
@@ -410,13 +423,15 @@ headrot_case02_3000_q.csv
headrot_case03_3000_q.csv


For the Renderer configuration option operation modes, external configuration files are available:
For the Renderer configuration option operation, example external configuration files are available
in the folder scripts/testv:

rend_config_hospital_patientroom.cfg
config_recreation.cfg
config_renderer.cfg



                       ADDITIONAL SCRIPTS
                       ==================