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

   1 schema version: 0.1
   2 type: producer # consumer, filter, producer, or transition
   3 identifier: avformat
   4 title: FFmpeg Reader
   5 version: 0.2.5
   6 copyright: Copyright (C) 2003-2008 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 # this may produce audio
  15   - Video # this may produce video
  16 description: Read an audio and/or video file using FFmpeg
  17 icon:
  18   filename: avformat/producer.png # relative to $MLT_DATA/modules/
  19   content-type: image/png
  20   content-encoding: base64 # could also be hex or none if inline SVG
  21   content: |
  22     iVBORw0KGgoAAAANSUhEUgAAABgAAAAPCAYAAAD+pA/bAAAABmJLR0QA/wD/AP+gvaeTAAAACXBI
  23     WXMAAAsSAAALEgHS3X78AAAAB3RJTUUH1gsBEgMLZIL+swAAAB10RVh0Q29tbWVudABDcmVhdGVk
  24     IHdpdGggVGhlIEdJTVDvZCVuAAAEgUlEQVQ4y2VUSWwbZRT+5p/xP4v3eIntceLEThOylKgkB070
  25     UAUOCNFDFYkIVeqBijMHQKiCAwLEDbVIPVQCUalFQggph6pUoWKRWoS6RCGJ04biOG7sOI638TJe
  26     xjM/FwwRfKf3vve99+kd3uNubNxgVb0Km2W7Tbt06fQLpwv4G8u3k6/88nvJcXYhnJ+dGfsRR/Dl
  27     8tqpfKkZJ736d++cf6nU53Nra0utTOarVrMpdCj9XFhJr2C1sQq1pZ6ac8zNAljpi7ezzc+e5Lvx
  28     je29H8rlyk8DA14GAOl05tT1n6tf39uqBM69GFgAsNjvaezsvKVfuyZkKxXIi4tvknn/PCQi4cA4
  29     QMQf+aIv3Nvbm0sVTGe9zfDg8eGxUrk83689eFQcyhStQLluYG+/NNfny6VSsLW5Ge3pOjSHAy2e
  30     /4TwjP84KAfBKRzW99f59G7aAQCVav20SZQAtdlQbfGxteTuNACkd/dsguR8W9NNiKKEVFbjisUi
  31     BQAtnz8rFAq+LgAWDjN/IpEkk97JzYQjAdkhI2fkwtVG9X0AWN+pwTA5iJSH1qEoaMZC8tFjfv3J
  32     IckcdiYNk0GUZVRbXKipt5YAoP7wYZDXNKHOGKR4fCs+NbVGBpwDt3zw3VEUBbqo437qvjuXy7kr
  33     HbtqWQzUJgC8Ar2Dpe1UXpgZC763W+RAOAaR2tAxRTmV3kvsJJPjSrf7umEYqAoC1NnZVCAY3CLD
  34     6nBpfnC+4hJc4B08DGqc1xr1l5126RzAIHAWqCjjj1wb8eHQq9uZ6nS9a4PAmaACD8bLWN16itrG
  35     hoJ8Ptw2TVjRKAZjsWUAIABACHk3RmOQ7BIyegbpg/1oqWGBoAc0U5BFAt20o1CqXSk26YLZM8Aa
  36     u5AEAwKV4XQNLHpGRq5zpRJ0QuCdmUGpUPgGAAQAoKBPJ5wTyDfzKLMyGMGntRZAmIHxMA/TTnDA
  37     e3FvM+siXhfMdgXjIQbmUpCvMjTa7fFG5imUdhtNSYIcCCxHx8Y6/2zgUTwNq2Nd8FIvYAHFch1d
  38     RmHjuhhVfdnjI1LPYVeQaw3gsMZAmYYTk+oT1SdBkiSU6z3U6k30AHR9PrhU9WYoHP7XYHR41Jpw
  39     TxSDQhAuzgXLtIMQG0RioFwuX3IrwiWPnUByDsKyGPxKB5S3Phj0UkgiRdMQ0FYcqBECFgj8GY7F
  40     7vZvg/QDl+S66mg5fg2IATDBC45jkPgOJhODLa8dN4d8BJQKYN06RgfF/eNTibRpWVcdsg2MV1An
  41     FJrbDfXEiWxEVdf/ZxCPxVvTnmkjqgzB4p0gMGGnPUyMjUANupNusXNHpDxYt4wR1XtrKBq9a3W0
  42     B047hSg7ofUIxMlJePz+K0d/FjmahLyh146rzyUNw0Jby8LGWvckSbwcjUayx1RpzWZWELR3jZln
  43     Eh8CwDFVgcLr4HpNVDtMi588ecEbCHx7dKZwNBkODed+W318Zipk3Rx1iTG9GbwYiUQMAAj53Zef
  44     H2u/Ua16L4ZCgykA8A94vn/W1DdH3dK0wIdXwkNDH+E/+Avfv/E5LPIz8wAAAABJRU5ErkJggg==
  45
  46 notes: Implementation or additional usage notes go here.
  47 bugs: # this can be just for documentation, or the tool may disclose it to help user avoid pitfalls
  48   - Audio sync discrepancy with some content.
  49   - Not all libavformat supported formats are seekable.
  50   - >
  51     Seeking is not always accurate. Sometimes it doesn't seek to I-frames so you
  52     may get junk for a few frames.
  53   - >
  54     Fails to play beyond first frame of video of sources with PTS not starting
  55     at 0 (video4linux).
  56
  57 parameters:
  58   - identifier: argument # 'argument' is a reserved name for a value supplied to the factory
  59     title: File  # the title can be used as a label for the widget
  60     type: string
  61     description: |
  62       A file name specification or URL in the form:
  63       [{protocol}|{format}]:{resource}[?{format-parameter}[&{format-parameter}...]]
  64       For example, video4linux:/dev/video1?width:320&height:240
  65       Note: on the bash command line, & must be escaped as '\&'.
  66       Also, note the use of ':' instead of '=' for parameters.
  67       Use 'ffmpeg -formats' to see a list of supported protocols and formats.
  68     readonly: no
  69     required: yes
  70     mutable: no
  71     widget: fileopen # could provide a button to use a file-open dialog
  72
  73   - identifier: audio_index # the name is the mlt_properties name
  74     title: Audio Index
  75     type: integer
  76     # the description can be used in a tool tip
  77     description: Choose the index of audio stream to use (-1 is off)
  78     readonly: no
  79     mutable: no
  80     minimum: -1
  81     # when maximum not specified, the scalar limit is used
  82     default: 0
  83     widget: spinner
  84
  85   - identifier: video_index
  86     title: Video Index
  87     type: integer
  88     description: Choose the index of video stream to use (-1 is off)
  89     readonly: no
  90     mutable: no
  91     minimum: -1
  92     default: 0
  93     widget: spinner
  94
  95   - identifier: in
  96     title: In Point
  97     type: time # time is not implemented, but it will correspond to the mlt_position replacement
  98     description: Set the start time offset to use within the clip
  99     readonly: no
 100     mutable: no
 101     minimum: 0
 102     default: 0
 103     widget: timecode # this is a special form of time value/code entry (e.g. see Kino)
 104
 105   - identifier: out
 106     title: Out Point
 107     type: time
 108     description: Set the ending time offset to use within the clip
 109     readonly: no
 110     minimum: 0
 111     mutable: no
 112     widget: timecode # as opposed to time, which could be confused for a wallclock-style time widget
 113
 114   - identifier: threads
 115     title: Decoding Threads
 116     type: integer
 117     description: Choose the number of threads to use in the decoder(s)
 118     readonly: no
 119     mutable: no
 120     minimum: 0
 121     maximum: 4
 122     default: 1
 123     widget: spinner
 124     unit: threads # the unit is a label that appears after the widget
 125
 126   - identifier: force_aspect_ratio
 127     title: Sample Aspect Ratio
 128     type: float
 129     description: Optionally override a (mis)detected aspect ratio
 130     readonly: no
 131     mutable: yes
 132     minimum: 0.001 # just a UI suggestion
 133     maximum: 9.999 # just a suggestion
 134     # no default property means it should be blank in the UI and not applied unless provided
 135
 136   - identifier: resource
 137     title: File
 138     type: string
 139     description: file or protocol specification
 140     readonly: yes
 141
 142   - identifier: source_fps
 143     title: Frame Rate
 144     type: float
 145     scale: 2 # scale is the number of digits to display after the decimal point
 146     description: the framerate of the resource
 147     readonly: yes
 148     unit: frames/second
 149
 150   - identifier: aspect_ratio
 151     title: Sample Aspect Ratio
 152     type: float
 153     description: >
 154       The sample aspect ratio of the resource.
 155       This is determined on every frame read.
 156     readonly: yes
 157
 158   - identifier: length
 159     title: Duration
 160     type: time
 161     description: duration
 162     readonly: yes
 163     widget: timecode
 164
 165   - identifier: seekable
 166     title: Supports Seek
 167     type: integer
 168     description: if the resource can seek
 169     readonly: yes