Commit b0db2d05 authored by Vladimir Malenovsky's avatar Vladimir Malenovsky
Browse files

modifications to cmd-line parameter descriptions

parent d5d4ccd5

apps/isar_post_rend.c

+4 −4
Original line number Original line Diff line number Diff line
@@ -145,7 +145,7 @@ static const CmdLnParser_Option cliOptions[] = { 
        .match = "input_format",

        .match = "input_format",

        .matchShort = "if",

        .matchShort = "if",

        .placeholder = "<format>",

        .placeholder = "<format>",

        .description = "Audio format of input file (e.g. BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM, ... Use -l for a list)",

        .description = "Audio format of input file (BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM or RTPDUMP)",

        .isMandatory = true,

        .isMandatory = true,

    },

    },

    {

    {
@@ -161,14 +161,14 @@ static const CmdLnParser_Option cliOptions[] = { 
        .match = "input_metadata",

        .match = "input_metadata",

        .matchShort = "im",

        .matchShort = "im",

        .placeholder = "<path>",

        .placeholder = "<path>",

        .description = "Path to the input metadata file for BINAURAL_SPLIT_PCM input format",

        .description = "Path to the input metadata file (mandatory for BINAURAL_SPLIT_PCM input format)",

    },

    },

    {

    {

        .id = CmdLnOptionId_sampleRate,

        .id = CmdLnOptionId_sampleRate,

        .match = "sample_rate",

        .match = "sample_rate",

        .matchShort = "fs",

        .matchShort = "fs",

        .placeholder = "<fs>",

        .placeholder = "<fs>",

        .description = "Input sampling rate in kHz (16, 32, 48) - required only with raw PCM input files",

        .description = "Input sampling rate in kHz (16, 32, 48) (mandatory for raw PCM input files)",

    },

    },

    {

    {

        .id = CmdLnOptionId_trajFile,

        .id = CmdLnOptionId_trajFile,
@@ -214,7 +214,7 @@ static const CmdLnParser_Option cliOptions[] = { 
        .match = "sr_params",

        .match = "sr_params",

        .matchShort = "s",

        .matchShort = "s",

        .placeholder = "<path>",

        .placeholder = "<path>",

        .description = "Path to the split rendering init params file",

        .description = "Path to the split rendering SDP init params file (mandatory for RTPDUMP input format)",

    },

    },

    {

    {

        .id = CmdLnOptionId_help,

        .id = CmdLnOptionId_help,

readme.txt

+11 −12
Original line number Original line Diff line number Diff line
@@ -390,21 +390,20 @@ Usage: ISAR_post_rend [options] -i <path> -if <format> -o <path> 
Mandatory parameters: 

Mandatory parameters: 

--------------------- 

--------------------- 

-i File             : Path to the input file (WAV or raw PCM file with BINAURAL_SPLIT_PCM input format or ISAR bitstream file with BINAURAL_SPLIT_CODED input format) 

-i File             : Path to the input file (WAV or raw PCM file with BINAURAL_SPLIT_PCM input format or ISAR bitstream file with BINAURAL_SPLIT_CODED input format) 

-if Format          : Audio format of input file (e.g. BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM, ... Use -l for a list)

-if Format          : Audio format of input file (BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM or RTPDUMP)

-o File             : Path to the output file 

-o File             : Path to the output file 





Options :

Options :

------- -

------- -

-im File            : Path to the input metadata file for BINAURAL_SPLIT_PCM input format

-im File            : Path to the input metadata file (mandatory for BINAURAL_SPLIT_PCM input format)

-fs                 : Input sampling rate in kHz (16, 32, 48) - required only with raw PCM input files

-fs                 : Input sampling rate in kHz (16, 32, 48) (mandatory for raw PCM input files)

-T File             : Head rotation trajectory file for simulation of head tracking

-T File             : Head rotation trajectory file for simulation of head tracking

-prbfi File         : Split rendering BFI (Bad Frame Indicator) file

-prbfi File         : Split rendering BFI (Bad Frame Indicator) file

-no_delay_cmp  		: Turn off delay compensation

-no_delay_cmp  		: Turn off delay compensation

-level level        : Complexity level (1, 2, 3) - will be defined after characterisation

-q                  : Quiet mode - limit printouts to terminal

-q                  : Quiet mode - limit printouts to terminal

-l                  : List supported audio formats of input file

-l                  : List supported audio formats of input file

-fr L               : Render frame size in ms L=(5, 10, 20), default is 20 

-fr L               : Render frame size in ms L=(5, 10, 20), default is 20 

-s File             : Path to the split rendering init params file

-s File             : Path to the split rendering SDP init params file (mandatory for RTPDUMP input format)

-h                  : Show this help message and exit

-h                  : Show this help message and exit