git.sesse.net Git - mlt/blob - src/modules/normalize/filter_volume.yml

   1 schema_version: 0.1
   2 type: filter
   3 identifier: volume
   4 title: Volume
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Dan Denneedy
   8 license: GPLv2
   9 language: en
  10 tags:
  11   - Audio
  12 description: >
  13   Adjust an audio stream's volume level. This filter is based on the
  14   'normalize' utility
  15 parameters:
  16   - identifier: argument
  17     title: Gain
  18     type: string
  19     description: >
  20       The gain may be indicated as a floating point value of the gain
  21       adjustment.
  22
  23       The gain may also be indicated as a numeric value with the suffix "dB"
  24       to adjust in terms of decibels.
  25
  26       The gain may also be set to "normalise" to normalise the volume to the
  27       target amplitude -12dBFS.
  28   - identifier: window
  29     title: Window
  30     type: integer
  31     description: >
  32        The number of video frames over which to smooth normalisation.
  33     default: 75
  34     mutable: yes
  35   - identifier: normalise
  36     title: Normalise
  37     type: string
  38     description: >
  39       Normalise the volume to the specified amplitude.
  40
  41       The normalization may be indicated as a floating point value of the
  42       relative volume.
  43
  44       The normalisation may also be indicated as a numeric value with the
  45       suffix "dB" to set the amplitude in decibels.
  46     default: -12dBFS
  47     mutable: yes
  48   - identifier: limiter
  49     title: Limiter
  50     type: string
  51     description: >
  52       Limit all samples above the specified amplitude.
  53
  54       The limiting may be indicated as a floating point value of the
  55       relative volume.
  56
  57       The limiting may also be indicated as a numeric value with the suffix
  58       "dB" to set the limiting amplitude in decibels.
  59     default: -6dBFS
  60     mutable: yes
  61   - identifier: max_gain
  62     title: Max gain
  63     type: string
  64     description: >
  65       A floating point or decibel value of the maximum gain that can be
  66       applied during normalisation.
  67     default: 20dB
  68     mutable: yes
  69   - identifier: end
  70     title: End gain
  71     type: string
  72     description: >
  73       A gain value just like the Gain property. This causes the gain to be
  74       interpolated from 'gain' to 'end' over the duration.
  75     mutable: yes