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