git.sesse.net Git - mlt/blob - src/modules/sox/filter_sox.yml

   1 schema_version: 0.1
   2 type: filter
   3 identifier: sox
   4 title: SoX
   5 version: 2
   6 copyright: Copyright (C) 2003-2011 Ushodaya Enterprises Limited
   7 license: LGPL
   8 language: en
   9 url: http://sox.sourceforge.net/
  10 creator: Dan Dennedy
  11 tags:
  12   - Audio
  13 description: Process audio using a SoX effect.
  14 bugs:
  15   - Some effects are stereo only, but MLT processes each channel separately.
  16   - Some effects have a temporal side-effect that do not work well.
  17
  18 parameters:
  19   - identifier: argument
  20     title: Effect name and options
  21     type: string
  22     format: effect [options]
  23     description: >
  24       If the effect name is "analysis" then it does not run any effect.
  25       Instead, it analyzes the audio to determine a normalized gain level.
  26       The results are put into the level, peak, and gain properties as well
  27       as this effect property as the parameter to the vol effect.
  28
  29   - identifier: level
  30     title; Signal power level (RMS)
  31     type: double
  32     readonly: yes
  33
  34   - identifier: peak
  35     title: Peak signal level
  36     type: double
  37     readonly: yes
  38
  39   - identifier: gain
  40     title: Gain to normalize
  41     type: double
  42     readonly: yes
  43
  44   - identifier: use_peak
  45     title: Use peak
  46     description: >
  47       Use peak signal level instead of RMS (root mean square) power level to
  48       compute gain for normalization.
  49     type: integer
  50     minimum: 0
  51     maximum: 1
  52     default: 0
  53     widget: checkbox
  54
  55   - identifier: normalise
  56     title: Dynamic normalization
  57     description: >
  58       This computes the gain for normalization dynamically per frame, but it
  59       uses a sliding smoothing window to prevent the gain from fluctuating wildly.
  60       Currently, this must be used in combination with some SoX effect.
  61     type: integer
  62     minimum: 0
  63     maximum: 1
  64     default: 0
  65     widget: checkbox
  66
  67   - identifier: window
  68     title: Smoothing window size
  69     type: integer
  70     minimum: 0
  71     default: 75
  72     unit: frames
  73     widget: spinner
  74
  75   - identifier: max_gain
  76     title: Maximum gain
  77     description: >
  78       With dynamic normalization, this puts a maximum limit on the amount of gain.
  79     type: float
  80     minimum: 0
  81     maximum: 20
  82     default: 10