git.sesse.net Git - mlt/blob - src/modules/avformat/consumer_avformat.yml

   1 schema_version: 0.1
   2 type: consumer
   3 identifier: avformat
   4 title: FFmpeg Output
   5 version: 1
   6 copyright: Copyright (C) 2003-2011 Ushodaya Enterprises Limited
   7 license: LGPL
   8 language: en
   9 url: http://www.ffmpeg.org/
  10 creator: Charles Yates
  11 contributor:
  12   - Dan Dennedy
  13 tags:
  14   - Audio
  15   - Video
  16 description: Write or stream audio and/or video using FFmpeg
  17 parameters:
  18   - identifier: argument
  19     title: File/URL
  20     type: string
  21     required: yes
  22     widget: filesave
  23
  24   - identifier: target
  25     title: File/URL
  26     type: string
  27     description: This is not the same thing as the ffmpeg -target option!
  28     readonly: yes
  29
  30   - identifier: mlt_profile
  31     title: MLT Profile
  32     type: string
  33     description: >
  34       Choose a MLT basic video settings preset.
  35       This overrides a profile that may have been set elsewhere.
  36
  37 # These override the MLT profile
  38   - identifier: width
  39     title: Width
  40     type: integer
  41     minimum: 0
  42     unit: pixels
  43   - identifier: height
  44     title: Height
  45     type: integer
  46     minimum: 0
  47     unit: pixels
  48   - identifier: display_aspect_num
  49     title: Display aspect ratio numerator
  50     type: integer
  51     minimum: 0
  52   - identifier: display_aspect_den
  53     title: Display aspect ratio denominator
  54     type: integer
  55     minimum: 0
  56   - identifier: display_ratio
  57     title: Display aspect ratio
  58     readonly: yes
  59   - identifier: sample_aspect_num
  60     title: Sample aspect ratio numerator
  61     type: integer
  62     minimum: 0
  63   - identifier: sample_aspect_den
  64     title: Sample aspect ratio denominator
  65     type: integer
  66     minimum: 1
  67   - identifier: progressive
  68     title: Progressive
  69     type: integer
  70     minimum: 0
  71     maximum: 1
  72     widget: checkbox
  73   - identifier: colorspace
  74     title: Colorspace
  75     type: integer
  76     description: Set the video colorspace (Y'CbCr only).
  77     values:
  78       - 240 # SMPTE 240M
  79       - 601 # ITU-R BT.601
  80       - 709 # ITU-R BT.709
  81   - identifier: frame_rate_num
  82     title: Frame rate numerator
  83     type: integer
  84     minimum: 0
  85     unit: frames/second
  86   - identifier: frame_rate_den
  87     title: Frame rate denominator
  88     type: integer
  89     minimum: 1
  90     unit: frames/second
  91   - identifier: fps
  92     title: Frame rate
  93     readonly: yes
  94     unit: frames/second
  95
  96 # These are common to all consumers.
  97   - identifier: deinterlace_method
  98     title: Deinterlacer
  99     type: string
 100     default: yadif
 101     values:
 102       - greedy
 103       - linearblend
 104       - onefield
 105       - yadif
 106       - yadif-nospatial
 107   - identifier: rescale
 108     title: Image scaler
 109     type: string
 110     description: Set the pixel interpolation mode.
 111     values:
 112       - nearest
 113       - bilinear
 114       - bicubic
 115       - bicublin
 116       - gauss
 117       - sinc
 118       - lanczos
 119       - spline
 120   - identifier: frequency
 121     title: Audio sample rate
 122     type: integer
 123     minimum: 0
 124     maximum: 256000
 125     default: 48000
 126     unit: Hz
 127   - identifier: channels
 128     title: Audio channels
 129     type: integer
 130     minimum: 1
 131     maximum: 16
 132     default: 2
 133   - identifier: channels.0
 134     title: Channels on track 1
 135     type: integer
 136     description: Used to map a bundle of channels to multi-track audio.
 137     minimum: 0
 138     maximum: 16
 139     default: 0
 140   - identifier: channels.1
 141     title: Channels on track 2
 142     type: integer
 143     description: Used to map a bundle of channels to multi-track audio.
 144     minimum: 0
 145     maximum: 16
 146     default: 0
 147   - identifier: channels.2
 148     title: Channels on track 3
 149     type: integer
 150     description: Used to map a bundle of channels to multi-track audio.
 151     minimum: 0
 152     maximum: 16
 153     default: 0
 154   - identifier: channels.3
 155     title: Channels on track 4
 156     type: integer
 157     description: Used to map a bundle of channels to multi-track audio.
 158     minimum: 0
 159     maximum: 16
 160     default: 0
 161   - identifier: channels.4
 162     title: Channels on track 5
 163     type: integer
 164     description: Used to map a bundle of channels to multi-track audio.
 165     minimum: 0
 166     maximum: 16
 167     default: 0
 168   - identifier: channels.5
 169     title: Channels on track 6
 170     type: integer
 171     description: Used to map a bundle of channels to multi-track audio.
 172     minimum: 0
 173     maximum: 16
 174     default: 0
 175   - identifier: channels.6
 176     title: Channels on track 7
 177     type: integer
 178     description: Used to map a bundle of channels to multi-track audio.
 179     minimum: 0
 180     maximum: 16
 181     default: 0
 182   - identifier: channels.7
 183     title: Channels on track 8
 184     type: integer
 185     description: Used to map a bundle of channels to multi-track audio.
 186     minimum: 0
 187     maximum: 16
 188     default: 0
 189
 190 # These are common to all consumers and affect runtime behavior
 191   - identifier: terminate_on_pause
 192     title: File output
 193     type: integer
 194     description: Disable this for streaming.
 195     minimum: 0
 196     maximum: 1
 197     default: 1
 198     widget: checkbox
 199   - identifier: real_time
 200     title: Drop frames
 201     type: integer
 202     description: >
 203       Set the number of processing threads and enable frame-dropping (positive)
 204       or disable frame-dropping (negative).
 205     default: -1
 206     widget: spinner
 207     unit: threads
 208   - identifier: prefill
 209     title: Pre-roll
 210     type: integer
 211     description: Set the number of frames to buffer before starting actual output.
 212     minimum: 1
 213     default: 1
 214     unit: frames
 215   - identifier: buffer
 216     title: Buffer
 217     type: integer
 218     description: >
 219       Set the maximum number of frames to buffer - process ahead of the output
 220       position.
 221     minimum: 1
 222     default: 25
 223     unit: frames
 224
 225 # These are ffmpeg-compatible aliases to MLT properties
 226   - identifier: s
 227     title: Size
 228     type: string
 229     description: >
 230       This is a ffmpeg-compatible equivalent to the MLT profile and width and height parameters.
 231     format: WxH
 232     unit: pixels
 233   - identifier: aspect
 234     title: Aspect ratio
 235     type: string
 236     description: >
 237       This is a ffmpeg-compatible equivalent to the MLT profile and other aspect ratio parameters.
 238     format: numerator:denominator
 239   - identifier: deinterlace
 240     title: Deinterlace
 241     type: integer
 242     description: >
 243       This is a ffmpeg-compatible equivalent to the MLT profile and progressive parameter.
 244     minimum: 0
 245     maximum: 1
 246   - identifier: r
 247     title: Frame rate
 248     type: float
 249     description: >
 250       This is a ffmpeg-compatible equivalent to the MLT profile and frame rate parameters.
 251     minimum: 5.0
 252   - identifier: ac
 253     title: Audio channels
 254     type: integer
 255     description: >
 256       This is a ffmpeg-compatible equivalent to the channels parameter.
 257     minimum: 1
 258     maximum: 16
 259     default: 2
 260   - identifier: ar
 261     title: Audio sample rate
 262     type: integer
 263     description: >
 264       This is a ffmpeg-compatible equivalent to the frequency parameter.
 265     minimum: 0
 266     maximum: 256000
 267     default: 48000
 268     unit: Hz
 269
 270 # These are other non-AVOption parameters specific to FFmpeg.
 271   - identifier: threads
 272     title: Encoding threads
 273     type: integer
 274     minimum: 0
 275     maximum: 16
 276     default: 1
 277     widget: spinner
 278     unit: threads
 279   - identifier: aq
 280     title: Audio quality
 281     type: integer
 282     description: The meaning depends upon the codec.
 283   - identifier: dc
 284     title: Intra DC precision
 285     type: integer
 286     default: 8
 287   - identifier: muxdelay
 288     title: Muxer delay
 289     type: float
 290     description: Set the maximum demux-decode delay.
 291     default: 0.7
 292     unit: seconds
 293   - identifier: muxpreload
 294     title: Muxer preload
 295     type: float
 296     description: Set the initial demux-decode delay.
 297     default: 0.5
 298     unit: seconds
 299   - identifier: f
 300     title: Format
 301     type: string
 302     description: Use "list" to see the list of formats.
 303     default: mpeg
 304   - identifier: acodec
 305     title: Audio codec
 306     description: Use "list" to see the list of audio codecs.
 307     default: mp2
 308   - identifier: vcodec
 309     title: Video codec
 310     description: Use "list" to see the list of video codecs.
 311     default: mpeg2video
 312   - identifier: atag
 313     title: Audio FourCC
 314     type: string
 315   - identifier: apre
 316     title: Audio codec preset
 317     type: string
 318   - identifier: vpre
 319     title: Video codec preset
 320     type: string
 321   - identifier: fpre
 322     title: Format preset
 323     type: string
 324   - identifier: alang
 325     title: Audio language
 326     type: string
 327     description: Set the 3-character ISO 639 language code of the current audio stream.
 328   - identifier: pix_fmt
 329     title: Pixel format
 330     type: string
 331     description: >
 332       See 'ffmpeg -pix_fmt list' to see a list of values.
 333       Normally, this is not required, but some codecs support multiple pixel
 334       formats, especially chroma bit-depth.
 335   - identifier: qscale
 336     title: Video quantizer
 337     type: float
 338     description: Set a fixed video quantizer scale for constant quality VBR output.
 339   - identifier: vtag
 340     title: Video FourCC
 341     type: string
 342   - identifier: rc_override
 343     title: Rate control
 344     type: string
 345     format: start_frame,end_frame,qscale/...
 346     description: This is an override for specific intervals.
 347   - identifier: pass
 348     title: Pass
 349     type: integer
 350     description: Select the pass number for two-pass encoding.
 351     minimum: 1
 352     maximum: 2
 353   - identifier: passlogfile
 354     title: Two-pass log file
 355     type: string
 356   - identifier: b
 357     title: Video bitrate
 358     type: string
 359     unit: bits/second
 360     description: >
 361       Normally this is an integer, but you can append a K suffix for convenience.
 362     minimum: 0
 363   - identifier: ab
 364     title: Audio bitrate
 365     type: string
 366     unit: bits/second
 367     description: >
 368       Normally this is an integer, but you can append a K suffix for convenience.
 369   - identifier: an
 370     title: Disable audio
 371     type: integer
 372     minimum: 0
 373     maximum: 1
 374     widget: checkbox
 375   - identifier: vn
 376     title: Disable video
 377     type: integer
 378     minimum: 0
 379     maximum: 1
 380     widget: checkbox