Commit a67b7c94 authored by Anika Treffehn's avatar Anika Treffehn
Browse files

updated readme and yml

parent 5d441afa

README.md

+39 −10
Original line number Diff line number Diff line
@@ -104,6 +104,7 @@ conditions_to_generate: 
          bin: ~/git/ivas-codec/IVAS_dec

postprocessing:

    fmt: "BINAURAL"

	fs: 48000

```



</details>
@@ -126,6 +127,8 @@ postprocessing: 
### 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.
@@ -156,13 +159,6 @@ output_path: "./tmp_output" 
### searches for the specified substring in found filenames; default = null

# input_select:

#  - "48kHz"



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

# concatenate_input: true

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

# preamble: 40

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

# pad_noise_preamble: true

```



</details>
@@ -216,6 +212,37 @@ input: 


</details>



### Optional pre-processing on whole signal(s)



<details>

<summary>Click to expand</summary>



```yaml

# 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

    # 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

```



</details>



### Bitstream processing



<details>
@@ -244,6 +271,8 @@ input: 
    # error_pattern: "path/pattern.192"

    ### Error rate in percent

    # error_rate: 5

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

    # prerun_seed: 2

```

</details>
@@ -337,7 +366,7 @@ 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: "CICP19"

          fmt: "7_1_4"

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

          # fs: 48000

          ### Additional commandline options; default = null
@@ -378,8 +407,8 @@ conditions_to_generate: 
postprocessing:

    ### REQUIRED: Target format for output

    fmt: "BINAURAL"

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

    # fs: 16000

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

    fs: 48000

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

    # lp_cutoff: 24000

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

examples/TEMPLATE.yml

+1 −1
Original line number Diff line number Diff line
@@ -104,7 +104,7 @@ input: 
    # background_noise:

        ### REQUIRED: SNR for background noise in dB

        # snr: 10

        ### REQUIRED: Path to background noise

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