Commit 0da4804c authored by Anika Treffehn's avatar Anika Treffehn
Browse files

enabled options in the test configs

parent 33d5f13a

examples/TEMPLATE.yml

+2 −2
Original line number Diff line number Diff line
@@ -283,7 +283,7 @@ postprocessing: 
    # bin_dataset: SADIE

    ### Render LFE to binaural output with the specified gain (only valid for channel-based input); default = null

    # bin_lfe_gain: 1

    ### Flag whether output should be limited to avoid clipping (can alter target loudness); default = true

    # limit: false

    ### Flag whether output should be limited to avoid clipping (can alter target loudness); default = false

    # limit: true

    ### Head-tracking trajectory file for binaural output; default = null

    # trajectory: "path/to/file"

tests/data/test_ISM.yml

+127 −70
Original line number Diff line number Diff line
@@ -14,10 +14,13 @@ 
### Deletion of temporary directories containing 

### intermediate processing files, bitstreams etc.; default = false

# delete_tmp: true

### Master seed for random processes like bitstream error pattern generation; default = 0

# master_seed: 5



### Any relative paths will be interpreted relative to the working directory the script is called from!

### Usage of absolute paths is recommended.

### Do not use file names with dots "." in them! This is not supported, use "_" instead

### For Windows user: please use double back slash '\\' in paths and add '.exe' to executable definitions

### REQUIRED: Input path or file

input_path: "./tests/data/pinknoise/pink_noise_4ch_48kHz.wav"

### REQUIRED: Output path or file
@@ -27,19 +30,19 @@ output_path: "./tmp_output_ISM" 
### default = null (for ISM search for item_name.{wav, raw, pcm}.{0-3}.csv in input folder, otherise ignored)

metadata_path:

    ### Path can be set for all items with the 'all_items' key (automatic search for item_name.{wav, raw, pcm}.{0-3}.csv within this folder)

    # all_items: "../path"

    # all_items: ".../metadata_folder"

    ### Path can be set for all items individually with 'item{1-4}' keys

    ### 'item{1-4}' keys can also be renamed to the input file names with extension

    ### 'item{1-4}' keys can also be renamed to the input file names including extension {wav, raw, pcm}

    ### Either list individual files for all objects or name folder for automatic search for one item

    pink_noise_4ch_48kHz.wav:

    ### Either list individual files for all objects or give folder for automatic search

        - "./tests/data/ism_metadata/stvISM1.csv"

        - "./tests/data/ism_metadata/stvISM2.csv"

        - "./tests/data/ism_metadata/stvISM3.csv"

        - "./tests/data/ism_metadata/stvISM4.csv"

    # item2:

        # - ".../meta_name.csv"

        # - ".../different_name.csv"

    # noise:

        # - ".../meta_obj1.csv"

        # - ".../meta_ob2.csv"

    # noise.wav:

        # - ".../metadata_folder_for_noise_item"



### Select only a subset of items
@@ -47,13 +50,6 @@ metadata_path: 
# input_select:

#  - "48kHz"



### Horizontally concatenate input items into one long file; default = false

# concatenate_input: true

### Specify silence duration (ms) to add in between concatenated items; default = null

# concat_silence:

    # pre: 0

    # post: 0



################################################

### Input configuration

################################################
@@ -64,48 +60,87 @@ input: 
    # fs: 32000



################################################

### Pre-processing

### Pre-processing on individual items

################################################

### Pre-processing step performed prior to core processing for all conditions

### If not defined, preprocessing step is skipped

preprocessing:

    ### Target format used in rendering from input format; default = null (no rendering)

    # fmt: "7_1_4"

    ### Flag for application of 50Hz high-pass filter; default = false

    # hp50: true

    ### Target sampling rate in Hz for resampling; default = null (no resampling)

    # fs: 16000

    fs: 48000

    ### Target loudness in LKFS; default = null (no loudness change applied)

    # loudness: -26

    loudness: -26

    ### Spatial audio format in which loudness is adjusted (only used if preprocessing loudness is not null);

    ### default = null (uses preprocessing fmt if possible)

    # loudness_fmt: BINAURAL

    ### Pre-/post-trim signal (ms) (negative values pad silence); default = 0

    trim:

        - 40

        - -60

    ### Flag for using noise instead of silence for padding

    pad_noise: true

    # loudness_fmt: "BINAURAL"

    ### Pre-/post-trim individual signal(s) (ms) (negative values pad silence); default = 0

    # trim:

        # - 50

        # - -50

    ### Flag for using noise (amplitude +-4) instead of silence for padding; default = false (silence)

    # pad_noise: true

    ### Value for application of delay (ms) (negative values advance); default = 0

    # delay: 20

    delay: 20

    ### Length of window used at start/end of signal (ms); default = 0

    # window: 100

    

################################################

### Pre-processing on whole signal(s)

################################################

preprocessing_2:

    ### Options for processing of the concatenated item (concatenate_input: true) or

    ### the individual items (concatenate_input: false) after previous pre-processing step

    ### Horizontally concatenate input items into one long file; default = false

    # concatenate_input: true

    ### Specify the concatenation order in a list of strings. If not specified, the concatenation order would be

    ### as per the filesystem on the users' device

    ### Should only be used if concatenate_input = true

    ### Specify the filename with extension.

    ### For example, concatenation_order: ["file3.wav", "file1.wav", "file4.wav", "file2.wav"]

    # concatenation_order: []

    ### Specify preamble duration in ms; default = 0

    preamble: 10000

    ### Flag wheter to use noise (amplitude +-4) for the preamble or silence; default = false (silence)

    preamble_noise: true

    ### Additive background noise

    # background_noise:

        ### REQUIRED: SNR for background noise in dB

        # snr: 10

        ### REQUIRED: Path to background noise, must have same format and sampling rate as input signal(s)

        # background_noise_path: ".../noise.wav"

        ### Seed for delay offest; default = 0

        # seed_delay: 10



#################################################

### bitstream processing

### Bitstream processing

#################################################

### bistream processing (transport simulation) done after encoding and before decoding

### Bitstream processing (transport simulation) done after encoding and before decoding

### e.g. frame error insertion or transport simulation for JBM testing

# tx:

    ### other options for generating error files,....

    ### maybe directly give something like fer and generate error_pottern and bs_proc_opts internally

    # fer:

    #    error_rate: 5  ### in percent

    ### Path to network simulation binary (mandatory)

    # bs_proc_bin: C:/local/bay/ivas/VR/src/ivas_python_testscripts/networkSimulator_g192.exe

    ### Path to error pattern (mandatory if no information for generating the error pattern is given)

    # error_pattern: C:/local/bay/ivas/VR/src/ivas_python_testscripts/dly_error_profiles/dly_error_profile_6.dat

    ### options for the binary, possible placeholders are {error_pattern} for the error pattern,

    ### {bitstream} for the bitstream to process and {bitstream_processed} for the processed bitstream

    # bs_proc_opts: [ "{error_pattern}",  "{bitstream}",  "{processed_bitstream}",  "{processed_bitstream}_tracefile_sim", "2", "0" ]

### can be given globally here or in individual conditions of type ivas or evs

tx:

    ### REQUIRED: Type of bitstream processing; possible types: "JBM" or "FER"

    type: "JBM"

    

    ### JBM

    ### REQUIRED: either error_pattern or error_profile

    ### delay error profile file

    # error_pattern: ".../dly_error_profile.dat"

    ### Index of one of the existing delay error profile files to use (1-11)

    error_profile: 5

    ## nFramesPerPacket parameter for the network simulator; default = 1

    n_frames_per_packet: 2

    

    ### FER

    ### REQUIRED: either error_pattern or error_rate

    ### Frame error pattern file

    # error_pattern: "path/pattern.192"

    ### Error rate in percent

    # error_rate: 5

    ### Additional seed to specify number of preruns; default = 0

    # prerun_seed: 2

    

################################################

### Configuration for conditions under test
@@ -116,10 +151,13 @@ preprocessing: 
###     ref        generate the reference condition

###     lp3k5      generate a low-pass anchor with cut-off frequency 3.5 kHz

###     lp7k       generate a low-pass anchor with cut-off frequency 7 kHz

###     mnru       generate MNRU condition

###     esdru      generate ESDRU condition

###     mono_dmx   generate mono downmix condition

###     evs        generate an EVS coded condition (see below examples for additional required keys)

###     ivas       generate an IVAS coded condition (see below examples for additional required keys)

conditions_to_generate:

  ### Reference condition ##########################

  ### Reference and anchor conditions ##########################

  c01:

      ### REQUIRED: type of condition

      type: ref
@@ -128,18 +166,28 @@ conditions_to_generate: 
  c02:

      ### REQUIRED: type of condition

      type: lp3k5

      ### optional low-pass cut-off frequency in Hz; default = null

      # out_fc: 22500

  c03:

      ### REQUIRED: type of condition

      type: mnru

      ### REQUIRED: the ratio of speech power to modulated noise power in dB

      q: 20

  c04:

      ### REQUIRED: type of condition

      type: esdru

      ### REQUIRED: spatial degradation value between 0 and 1

      alpha: 0.5

  c05:

      ### REQUIRED: type of condition

      type: mono_dmx

      

  ### IVAS condition ###############################

  c03:

  c06:

      ### REQUIRED: type of condition

      type: ivas

      ### REQUIRED: Bitrates to use for coding

      bitrates:

          - 160000

          # - 32000

      # TODO bitstream corruption

          - 32000

      ### Encoder options

      cod:

          ### Path to encoder binary; default search for IVAS_cod in bin folder (primary) and PATH (secondary)
@@ -153,22 +201,25 @@ conditions_to_generate: 
          ### Path to decoder binary; default search for IVAS_dec in bin folder (primary) and PATH (secondary)

          #bin: ~/git/ivas-codec/IVAS_dec

          ### Decoder output format; default = postprocessing fmt

          #fmt: HOA3

          fmt: "ISM4"

          ### Decoder output sampling rate; default = null (same as input)

          # fs: 48000

          ### Additional commandline options; default = null

          # opts: ["-q", "-no_delay_cmp"]

      ### Bitstream options

      # tx:

          ### For possible arguments see overall bitstream modification



  ### IVAS condition ###############################

  #c04:

  c07:

      ### REQUIRED: type of condition

      #type: ivas

      type: ivas

      ### REQUIRED: Bitrates to use for coding

      #bitrates:

          #- 160000

      bitrates:

          - 160000

          # - 32000

      ### Encoder options

      #cod:

      cod:

          ### Path to encoder binary; default search for IVAS_cod in bin folder (primary) and PATH (secondary)

          #bin: ~/git/ivas-codec/IVAS_cod

          ### Encoder input sampling rate in Hz (resampling performed in case of mismatch); default = null (no resampling)
@@ -176,36 +227,42 @@ conditions_to_generate: 
          ### Additional commandline options; default = null

          # opts: ["-q", "-dtx", 4]

      ### Decoder options

      #dec:

      dec:

          ### Path to decoder binary; default search for IVAS_dec in bin folder (primary) and PATH (secondary)

          #bin: ~/git/ivas-codec/IVAS_dec

          ### Decoder output format; default = postprocessing fmt

          #fmt: CICP19

          #fmt: "7_1_4"

          ### Decoder output sampling rate; default = null (same as input)

          # fs: 48000

          ### Additional commandline options; default = null

          # opts: ["-q", "-no_delay_cmp"]

      ### Bitstream options

      # tx:

          ### For possible arguments see overall bitstream modification

            

  ### EVS condition ################################

  c05:

  c08:

      ### REQUIRED: type of condition

      type: evs

      ### REQUIRED: Bitrates to use for coding

      ### For EVS mono, this may be a per-channel bitrate configuration (must match input/preprocessing format!)

      ### the last value will be repeated if too few are specified

      bitrates:

          - 9600

          #- [13200, 13200, 8000, 13200, 9600]

          # - 9600

          - [13200, 13200, 8000, 13200, 9600]

      cod:

          ### Path to encoder binary; default search for EVS_cod in bin folder (primary) and PATH (secondary)

          #bin: ~/git/ivas-codec/IVAS_cod

          #bin: EVS_cod

          ### Encoder input sampling rate in Hz (resampling performed in case of mismatch); default = null (no resampling)

          # fs: 32000

      dec:

          ### Path to encoder binary; default search for EVS_dec in bin folder (primary) and PATH (secondary)

          #bin: ~/git/ivas-codec/IVAS_dec

          #bin: EVS_dec

          ### Decoder output sampling rate; default = null (same as input)

          # fs: 48000

      ### Bitstream options

      # tx:

          ### For possible arguments see overall bitstream modification



################################################

### Post-processing
@@ -215,21 +272,21 @@ conditions_to_generate: 
postprocessing:

    ### REQUIRED: Target format for output

    fmt: "BINAURAL"

    ### Target sampling rate in Hz for resampling; default = null (no resampling)

    ### REQUIRED: Target sampling rate in Hz for resampling

    fs: 48000

    ### Low-pass cut-off frequency in Hz; default = null (no filtering)

    # lp_cutoff: 24000

    lp_cutoff: 24000

    ### Target loudness in LKFS; default = null (no loudness change applied)

    # loudness: -26

    loudness: -26

    ### Spatial audio format in which loudness is adjusted (only used if preprocessing loudness is not null);

    ### default = null (uses postprocessing fmt if possible)

    # loudness_fmt: null

    ### Name of custom binaural dataset (without prefix or suffix);

    ### default = null (ORANGE53 for BINAURAL, IISofficialMPEG222UC for BINAURAL_ROOM)

    ### default = null (ORANGE53(_Dolby) for BINAURAL, IISofficialMPEG222UC for BINAURAL_ROOM)

    # bin_dataset: SADIE

    ### Render LFE to binaural output with the specified gain (only valid for channel-based input); default = null

    # bin_lfe_gain: 1

    ### Flag whether output should be limited to avoid clipping (can alter target loudness); default = true

    # limit: false

    ### Flag whether output should be limited to avoid clipping (can alter target loudness); default = false

    # limit: true

    ### Head-tracking trajectory file for binaural output; default = null

    # trajectory: path/to/file
 
    # trajectory: "path/to/file"

tests/data/test_MC.yml

+128 −66

File changed.

Preview size limit exceeded, changes collapsed.

tests/data/test_SBA.yml

+127 −65

File changed.

Preview size limit exceeded, changes collapsed.