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