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

   1 schema_version: 0.1
   2 type: producer
   3 identifier: avformat
   4 title: FFmpeg Reader
   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: Read an audio and/or video file using FFmpeg
  17 bugs:
  18   - Audio sync discrepancy with some content.
  19   - Not all libavformat supported formats are seekable.
  20   - >
  21     Seeking is not always accurate. Sometimes it doesn't seek to I-frames so you
  22     may get junk for a few frames.
  23   - >
  24     More than 2 channels of audio more than 16 bits is not supported.
  25
  26 parameters:
  27   - identifier: argument # 'argument' is a reserved name for a value supplied to the factory
  28     title: File/URL
  29     type: string
  30     description: |
  31       A file name specification or URL in the form:
  32       [{protocol}|{format}]:{resource}[?{format-parameter}[&{format-parameter}...]]
  33       For example, video4linux2:/dev/video1?width=320&height=240
  34       Note: on the bash command line, & must be escaped as '\&'.
  35       Use 'f-list' to see a list of supported file formats.
  36       Use 'vcodec-list' to see a list of supported video decoders.
  37       Use 'acodec-list' to see a list of supported audio decoders.
  38     readonly: no
  39     required: yes
  40     mutable: no
  41     widget: fileopen # could provide a button to use a file-open dialog
  42
  43   - identifier: audio_index # the name is the mlt_properties name
  44     title: Audio index
  45     type: integer
  46     description: >
  47       Choose the index of audio stream to use (-1 is off).
  48       When this value is equal to the maximum size of a 32-bit signed integer
  49       or the string "all" then all audio tracks are coalesced into a bundle of
  50       channels on one audio track.
  51     readonly: no
  52     mutable: no
  53     minimum: -1
  54     default: 0
  55     widget: spinner
  56
  57   - identifier: video_index
  58     title: Video index
  59     type: integer
  60     description: Choose the index of video stream to use (-1 is off)
  61     readonly: no
  62     mutable: no
  63     minimum: -1
  64     default: 0
  65     widget: spinner
  66
  67   - identifier: in
  68     title: In point
  69     type: time
  70     description: Set the start time offset to use within the clip
  71     readonly: no
  72     mutable: no
  73     minimum: 0
  74     default: 0
  75     widget: timecode # this is a special form of time value/code entry (e.g. see Kino)
  76
  77   - identifier: out
  78     title: Out point
  79     type: time
  80     description: Set the ending time offset to use within the clip
  81     readonly: no
  82     minimum: 0
  83     mutable: no
  84     widget: timecode # as opposed to time, which could be confused for a wallclock-style time widget
  85
  86   - identifier: threads
  87     title: Decoding threads
  88     type: integer
  89     description: Choose the number of threads to use in the decoder(s)
  90     readonly: no
  91     mutable: no
  92     minimum: 0
  93     maximum: 4
  94     default: 1
  95     widget: spinner
  96     unit: threads # the unit is a label that appears after the widget
  97
  98   - identifier: force_aspect_ratio
  99     title: Sample aspect ratio
 100     type: float
 101     description: Optionally override a (mis)detected aspect ratio
 102     readonly: no
 103     mutable: yes
 104     minimum: 0.001 # just a UI suggestion
 105     maximum: 9.999 # just a suggestion
 106     # no default property means it should be blank in the UI and not applied unless provided
 107
 108   - identifier: resource
 109     title: File/URL
 110     type: string
 111     description: file or protocol specification
 112     readonly: yes
 113
 114   - identifier: source_fps
 115     title: Frame rate
 116     type: float
 117     scale: 2 # scale is the number of digits to display after the decimal point
 118     description: the framerate of the resource
 119     readonly: yes
 120     unit: frames/second
 121
 122   - identifier: aspect_ratio
 123     title: Sample aspect ratio
 124     description: >
 125       The sample aspect ratio of the resource.
 126       This is determined on every frame read.
 127     readonly: yes
 128
 129   - identifier: length
 130     title: Duration
 131     type: time
 132     description: duration
 133     widget: timecode
 134
 135   - identifier: seekable
 136     title: Supports seeking
 137     description: if the resource can seek
 138     readonly: yes
 139
 140   - identifier: width
 141     title: Width
 142     type: integer
 143     unit: pixels
 144     readonly: yes
 145
 146   - identifier: height
 147     title: Height
 148     type: integer
 149     unit: pixels
 150     readonly: yes
 151
 152   - identifier: noimagecache
 153     title: Disable image caching
 154     type: integer
 155     minimum: 0
 156     maximum: 0
 157     default: 0
 158     widget: checkbox
 159
 160   - identifier: new_seek
 161     title: Use new seeking
 162     description: >
 163       When this is not provided (recommended), it is enabled only for H.264 in
 164       MPEG-2 Transport Streams.
 165     type: integer
 166     minimum: 0
 167     maximum: 1
 168     widget: checkbox
 169
 170   - identifier: force_progressive
 171     title: Force progressive
 172     description: When provided, this overrides the detection of progressive video.
 173     type: integer
 174     minimum: 0
 175     maximum: 1
 176     widget: checkbox
 177
 178   - identifier: force_tff
 179     title: Force top field first
 180     description: When provided, this overrides the detected field order of interlaced video.
 181     type: integer
 182     minimum: 0
 183     maximum: 1
 184     widget: checkbox
 185
 186   - identifier: force_fps
 187     title: Force frame rate
 188     description: When provided, this attempts to override the detected frame rate of the video.
 189     type: integer
 190     minimum: 0
 191     maximum: 1
 192     widget: checkbox
 193
 194   - identifer: force_colorspace
 195     title: Force colorspace
 196     description: When provided, this overrides the detected colorspace of the video (Y'CbCr only).
 197     type: integer
 198     values:
 199       - 240 # SMPTE 240M
 200       - 601 # ITU-R BT.601
 201       - 709 # ITU-R BT.709
 202
 203   - identifier: video_delay
 204     title: Video delay
 205     description: >
 206       Manually adjust A/V synchronization.
 207       A negative value advances the video instead of delaying it.
 208     type: float
 209     default: 0
 210     unit: seconds
 211     widget: timecode