Add exit_on_disconnect property to avformat producer.

[mlt] / src / modules / avformat / producer_avformat.yml

diff --git a/src/modules/avformat/producer_avformat.yml b/src/modules/avformat/producer_avformat.yml
index cb878530b898fbf2a76656189f781df667644370..c7911b669e93c842b9d5d20ba7c2df047f9e45cb 100644 (file)
--- a/src/modules/avformat/producer_avformat.yml
+++ b/src/modules/avformat/producer_avformat.yml
@@ -2,7 +2,7 @@ schema_version: 0.1
 type: producer
 identifier: avformat
 title: FFmpeg Reader
-version: 1
+version: 2
 copyright: Copyright (C) 2003-2011 Ushodaya Enterprises Limited
 license: LGPL
 language: en
@@ -25,14 +25,13 @@ bugs:
 
 parameters:
   - identifier: argument # 'argument' is a reserved name for a value supplied to the factory
-    title: File/URI
+    title: File/URL
     type: string
     description: |
       A file name specification or URL in the form:
       [{protocol}|{format}]:{resource}[?{format-parameter}[&{format-parameter}...]]
-      For example, video4linux:/dev/video1?width:320&height:240
+      For example, video4linux2:/dev/video1?width=320&height=240
       Note: on the bash command line, & must be escaped as '\&'.
-      Also, note the use of ':' instead of '=' for parameters.
       Use 'f-list' to see a list of supported file formats.
       Use 'vcodec-list' to see a list of supported video decoders.
       Use 'acodec-list' to see a list of supported audio decoders.
@@ -65,25 +64,6 @@ parameters:
     default: 0
     widget: spinner
 
-  - identifier: in
-    title: In point
-    type: time
-    description: Set the start time offset to use within the clip
-    readonly: no
-    mutable: no
-    minimum: 0
-    default: 0
-    widget: timecode # this is a special form of time value/code entry (e.g. see Kino)
-
-  - identifier: out
-    title: Out point
-    type: time
-    description: Set the ending time offset to use within the clip
-    readonly: no
-    minimum: 0
-    mutable: no
-    widget: timecode # as opposed to time, which could be confused for a wallclock-style time widget
-
   - identifier: threads
     title: Decoding threads
     type: integer
@@ -106,12 +86,6 @@ parameters:
     maximum: 9.999 # just a suggestion
     # no default property means it should be blank in the UI and not applied unless provided
 
-  - identifier: resource
-    title: File/URI
-    type: string
-    description: file or protocol specification
-    readonly: yes
-
   - identifier: source_fps
     title: Frame rate
     type: float
@@ -120,19 +94,6 @@ parameters:
     readonly: yes
     unit: frames/second
 
-  - identifier: aspect_ratio
-    title: Sample aspect ratio
-    description: >
-      The sample aspect ratio of the resource.
-      This is determined on every frame read.
-    readonly: yes
-
-  - identifier: length
-    title: Duration
-    type: time
-    description: duration
-    widget: timecode
-
   - identifier: seekable
     title: Supports seeking
     description: if the resource can seek
@@ -158,15 +119,19 @@ parameters:
     default: 0
     widget: checkbox
 
-  - identifier: new_seek
-    title: Use new seeking
-    description: >
-      When this is not provided (recommended), it is enabled only for H.264 in
-      MPEG-2 Transport Streams.
+  - identifier: cache
+    title: Number of images cache
     type: integer
-    minimum: 0
-    maximum: 1
-    widget: checkbox
+    description: >
+      By default, this producer caches images to facilitate YADIF deinterlace,
+      which needs previous and next frames. Also, caching helps with frame-
+      stepping within a player. The default number of images cached is supplied
+      by the MLT framework, which is currently 4, but you can override it
+      with this property. You can also disable caching by setting it to 0.
+      If you are using parallel processing with YADIF deinterlacing, then
+      you might need to increase caching to prevent inadvertent backward seeks.
+      One can also set this value globally for all instances of avformat by
+      setting the environment variable MLT_AVFORMAT_CACHE.
 
   - identifier: force_progressive
     title: Force progressive
@@ -192,7 +157,7 @@ parameters:
     maximum: 1
     widget: checkbox
 
-  - identifer: force_colorspace
+  - identifier: force_colorspace
     title: Force colorspace
     description: When provided, this overrides the detected colorspace of the video (Y'CbCr only).
     type: integer
@@ -200,3 +165,33 @@ parameters:
       - 240 # SMPTE 240M
       - 601 # ITU-R BT.601
       - 709 # ITU-R BT.709
+
+  - identifier: video_delay
+    title: Video delay
+    description: >
+      Manually adjust A/V synchronization.
+      A negative value advances the video instead of delaying it.
+    type: float
+    default: 0
+    unit: seconds
+    widget: timecode
+
+  - identifier: reconnect
+    title: Automatically reconnect?
+    description: >
+      Whether to attempt to automatically reconnect to a live source when a
+      read failure occurs.
+    type: integer
+    minimum: 0
+    maximum: 1
+    widget: checkbox
+
+  - identifier: exit_on_disconnect
+    title: Exit upon disconnection?
+    description: >
+      When this is set, the program will terminate with an error if a live source
+      becomes disconnected.
+    type: integer
+    minimum: 0
+    maximum: 1
+    widget: checkbox