Commit 6cdea34c authored by vaclav's avatar vaclav
Browse files

issue 247: harmonize command-line options names of external renderer with the... 

issue 247: harmonize command-line options names of external renderer with the decoder; under FIX_247_EXTERNAL_RENDERER_COMMAND_LINE
parent a8f576ed

apps/renderer.c

+20 −0
Original line number Diff line number Diff line
@@ -276,7 +276,11 @@ static const CmdLnParser_Option cliOptions[] = { 
    {

        .id = CmdLnOptionId_trajFile,

        .match = "trajectory_file",

#ifdef FIX_247_EXTERNAL_RENDERER_COMMAND_LINE

        .matchShort = "T",

#else

        .matchShort = "tf",

#endif

        .description = "Head rotation trajectory file for simulation of head tracking (only for binaural outputs)",

    },

#ifdef SPLIT_REND_WITH_HEAD_ROT
@@ -307,14 +311,25 @@ static const CmdLnParser_Option cliOptions[] = { 
    },

    {

        .id = CmdLnOptionId_renderConfigFile,

#ifdef FIX_247_EXTERNAL_RENDERER_COMMAND_LINE

        .match = "render_config_parameters",

        .matchShort = "render_config",

        .description = "Binaural renderer configuration parameters in file (only for binaural outputs)",

#else

        .match = "render_config",

        .matchShort = "rc",

        .description = "Binaural renderer configuration file (only for binaural outputs)",

#endif

    },

    {

        .id = CmdLnOptionId_nonDiegeticPan,

#ifdef FIX_247_EXTERNAL_RENDERER_COMMAND_LINE

        .match = "non_diegetic_panning",

        .matchShort = "non_diegetic_pan",

#else

        .match = "non_diegetic_pan",

        .matchShort = "ndp",

#endif

        .description = "Panning mono non diegetic sound to stereo -90<= pan <= 90\nleft or l or 90->left, right or r or -90->right, center or c or 0 ->middle\n",

    },

    {
@@ -335,8 +350,13 @@ static const CmdLnParser_Option cliOptions[] = { 
      .description = "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). \nIf specified, overrides the output LFE position option and the default behavior which attempts to map input to output LFE channel(s)" },

    {

        .id = CmdLnOptionId_noDelayCmp,

#ifdef FIX_247_EXTERNAL_RENDERER_COMMAND_LINE

        .match = "no_delay_comparison",

        .matchShort = "no_delay_cmp",

#else

        .match = "no_delay_cmp",

        .matchShort = "ndc",

#endif

        .description = "[flag] Turn off delay compensation",

    },

    {

lib_com/options.h

+1 −0
Original line number Diff line number Diff line
@@ -154,6 +154,7 @@ 
#define FIX_814_DOUBLE_PREC_IN_REVERB                   /* Philips: Issue 814: Replace double precision arithmetic in reverb */

#define FIX_866_MOVE_VBAP                               /* Nokia: Issue 866: Move VBAP to lib_rend */

#define FIX_863_REMOVE_REDUNDANCIES_OMASA               /* Nokia/VA: Issue 863: Remove redundancies in stereo_classifier for OMASA */

#define FIX_247_EXTERNAL_RENDERER_COMMAND_LINE          /* VA: issue 247: harmonize command-line options names of external renderer with the decoder */



/* #################### End BE switches ################################## */

readme.txt

+11 −13
Original line number Diff line number Diff line
@@ -276,8 +276,7 @@ Options: 
                      works only in combination with '-otr ref' mode

-rvf File           : Reference vector specified by external trajectory File

                      works only in combination with '-otr ref_vec' and 'ref_vec_lev' modes

-render_config File : Renderer configuration option with parameters specified in File

-om File            : Metadata output File for BINAURAL_SPLIT_PCM OutputConf

-render_config File : Binaural renderer configuration parameters in File (only for binaural outputs)

-non_diegetic_pan P : panning mono non-diegetic sound to stereo -90<= P <=90,

                      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
@@ -303,28 +302,27 @@ Options: 
-of Format          : Audio Format of output file

                      Alternatively, it can be a custom loudspeaker layout File

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

-tf File            : Head rotation trajectory File for simulation of head tracking (only for binaural outputs)

-hrtf File          : Custom HRTF File for binaural rendering (only for binaural outputs)

-T File             : Head rotation trajectory File for simulation of head tracking (only for binaural outputs)

-otr tracking_type  : Head orientation tracking type: 'none', 'ref', 'avg' or `ref_vec` or `ref_vec_lev` (only for binaural outputs)

-rf File           	: Reference rotation trajectory File for simulation of head tracking (only for binaural outputs)

-rvf File           : Reference vector trajectory File for simulation of head tracking (only for binaural outputs)

-hrtf File          : Custom HRTF File for binaural rendering (only for binaural outputs)

-rc File            : Binaural renderer configuration File (only for binaural outputs)

-ndp P              : Panning mono non-diegetic sound to stereo -90<= P <= 90

-render_config File : Binaural renderer configuration parameters in File (only for binaural outputs)

-non_diegetic_pan P : Panning mono non-diegetic sound to stereo -90<= P <= 90

                                            left or l or 90->left, right or r or -90->right, center or c or 0 ->middle

-otr tracking_type  : Head orientation tracking type: 'none', 'ref', 'avg' or `ref_vec` or `ref_vec_lev` (only for binaural outputs)

-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            : Acoustic environment ID (number >= 0) for BINAURAL_ROOM_REVERB output config.										

-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.

                                            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). 

                                            If specified, overrides the output LFE position option and the default behavior which attempts to map input to output LFE channel(s)

-ndc                : Turn off delay compensation

-no_delay_cmp       : Turn off delay compensation

-g                  : Input gain (linear, not in dB) to be applied to input audio file

-l                  : List supported audio formats

-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            : Acoustic environment ID (number >= 0) for BINAURAL_ROOM_REVERB output config.

-fr5                : render audio with 5 ms framing

-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).

tests/renderer/utils.py

+2 −2
Original line number Diff line number Diff line
@@ -181,7 +181,7 @@ def run_renderer( 
        cmd[5:5] = ["-im", *in_meta_files]



    if trj_file is not None:

        cmd.extend(["-tf", str(trj_file)])

        cmd.extend(["-T", str(trj_file)])



    if non_diegetic_pan is not None:

        cmd.extend(["-non_diegetic_pan", str(non_diegetic_pan)])
@@ -198,7 +198,7 @@ def run_renderer( 
        cmd.extend(["-otr", "ref_vec_lev"])



    if config_file is not None:

        cmd.extend(["-rc", str(config_file)])

        cmd.extend(["-render_config", str(config_file)])



    if framing_5ms:

        cmd.extend(["-fr5"])