]> git.sesse.net Git - mlt/commitdiff
Cleanup Brian's service metadata contribution.
authorDan Dennedy <dan@dennedy.org>
Fri, 22 Jul 2011 23:38:28 +0000 (16:38 -0700)
committerDan Dennedy <dan@dennedy.org>
Fri, 22 Jul 2011 23:38:28 +0000 (16:38 -0700)
src/modules/core/filter_mirror.yml
src/modules/core/filter_mono.yml
src/modules/core/filter_obscure.yml
src/modules/core/filter_region.yml
src/modules/core/transition_luma.yml
src/modules/core/transition_mix.yml
src/modules/core/transition_region.yml
src/modules/dv/consumer_libdv.yml
src/modules/normalize/filter_volume.yml
src/modules/sdl/consumer_sdl.yml
src/modules/xml/consumer_xml.yml

index af60464b8d40aecc244de6226383bcbc4e18517f..61bd007f2383ffa8d3c90111931866919c34fbff 100644 (file)
@@ -15,9 +15,19 @@ parameters:
   - identifier: argument
     title: File
     type: string
-    description: one of: horizontal, vertical, diagonal, xdiagonal, flip, flop
+    description: Choose the type of mirror operation.
+    values:
+      - horizontal
+      - vertical
+      - diagonal
+      - xdiagonal
+      - flip
+      - flop
   - identifier: reverse
     title: Reverse
     type: integer
     mutable: no
     default: 0
+    minimum: 0
+    maximum: 1
+    widget: checkbox
index b0cc48d552be681172eac77e1b5d98d303a6573e..a11612b4bf62fd6035666cdeeb9c63d86f890667 100644 (file)
@@ -10,10 +10,13 @@ language: en
 tags:
   - Audio
 description: >
-   Mix all channels of audio into a mono signal and output it as N channels.
+  Mix all channels of audio into a mono signal and output it as N channels.
 parameters:
   - identifier: argument
     title: channels
     type: integer
-    description: the number of output channels (default 2)
\ No newline at end of file
+    description: >
+      Set the number of output channels.
+      The default is automatic based on consumer request.
+    required: no
+    minimum: 1
index c2edae80df3899179cb26e526ec0fa5883c290fb..6d493a8b2030007cef4089ec853ea8a84da54e48 100644 (file)
@@ -16,11 +16,11 @@ parameters:
     title: Start
     type: string
     description: >
-       The starting rectangle is given in the format X/Y:WxH[:PWxPY] where 
-       PWxPY is the size of the averaging region in pixels.
+      The starting rectangle is given in the format X/Y:WxH[:PWxPY] where
+      PWxPY is the size of the averaging region in pixels.
   - identifier: end
     title: End
     type: string
     description: >
-       The ending rectangle is given in the format X/Y:WxH[:PWxPY] where 
-       PWxPY is the size of the averaging region in pixels.
+      The ending rectangle is given in the format X/Y:WxH[:PWxPY] where
+      PWxPY is the size of the averaging region in pixels.
index 5916b0d70df92c8685dececee1856262fe146443..0d901b6c6c1a6e4a866c4ab3e9409824f11f961a 100644 (file)
@@ -4,25 +4,25 @@ identifier: region
 title: Regionalize
 version: 1
 copyright: Ushodaya Enterprises Limited
-creator: CHarles Yates
+creator: Charles Yates
 license: LGPLv2.1
 language: en
 tags:
   - Video
 description: >
-   Apply one or more filters to a region of the video image. The region can be 
-   shaped as well using the alpha channel of another producer.
+  Apply one or more filters to a region of the video image. The region can be
+  shaped as well using the alpha channel of another producer.
 bugs: "circle" is unpredictable in the absence of the librsvg pixbuf loader.
 parameters:
   - identifier: argument
     title: File
     type: string
     description: >
-       A file whose alpha channel will "shape"  the region. The string "circle" 
-       is a shortcut but it requires pixbuf with the librsvg loader. The circle 
-       is automatically stretched to the region to create an ellipse.
+      A file whose alpha channel will "shape"  the region. The string "circle"
+      is a shortcut but it requires pixbuf with the librsvg loader. The circle
+      is automatically stretched to the region to create an ellipse.
   - identifier: region.*
     title: Region
     description: >
-       Properties may be set on the encapsulated region transition.See "region" 
-       transition for details.
+      Properties may be set on the encapsulated region transition.See "region"
+      transition for details.
index cdbc04afa43c44e01dbbe100f7d4f59c6ed0275c..5b084c94e085ebe0df300f9443b5848a694a0da3 100644 (file)
@@ -10,41 +10,42 @@ language: en
 tags:
   - Video
 description: >
-   A generic dissolve and wipe transition processor.
+  A generic dissolve and wipe transition processor.
    
-   "luma" gets its name from how it uses a grayscale "map" file. As the luma 
-   value varies over time, a threshold filter is applied to the map to 
-   determine what parts of frame A vs. frame B to show. It reads PGM files up 
-   to 16 bits! Alternatively, it can use the first frame from any producer that 
-   outputs yuv, but it will be limited to the luma gamut of 220 values. This 
-   performs field-based rendering unless the A frame property "progressive" or 
-   "consumer_progressive" or the transition property "progressive" is set to 1.
-bugs: Assumes lower field first output.
+  "luma" gets its name from how it uses a grayscale "map" file. As the luma
+  value varies over time, a threshold filter is applied to the map to
+  determine what parts of frame A vs. frame B to show. It reads PGM files up
+  to 16 bits! Alternatively, it can use the first frame from any producer that
+  outputs yuv, but it will be limited to the luma gamut of 220 values. This
+  performs field-based rendering unless the A frame property "progressive" or
+  "consumer_progressive" or the transition property "progressive" is set to 1.
+bugs:
+  - Assumes lower field first output.
 parameters:
   - identifier: argument
     title: Luma map file
     type: string
     description: >
-       Either PGM or any other producable video. If not supplied, a dissolve.
+      Either PGM or any other producable video. If not supplied, performs a dissolve.
   - identifier: factory
     title: Factory
     type: string
     description: >
-       The name of a factory service used as a non-PGM producer loader.
-    default: 'loader'
+      The name of a factory service used as a non-PGM producer loader.
+    default: loader
   - identifier: softness
     title: Softness
-    type: double
+    type: float
     mutable: yes
     description: >
-       Only when using a luma map, how soft to make the edges between A and B. 
-       0.0 = no softness. 1.0 = too soft.
+      Only when using a luma map, how soft to make the edges between A and B.
+      0.0 = no softness. 1.0 = too soft.
   - identifier: reverse
     title: Reverse
     type: int
     mutable: yes
     description: >
-       Reverse the direction of the transition.
+      Reverse the direction of the transition.
     default: 0
   - identifier: producer.*
     title: Producer
index fb97862036cd7dc79571e5d33f847d09ab28253b..bb97311a6f45a97d03628f0c7698c10aff09c5ad 100644 (file)
@@ -9,27 +9,31 @@ license: LGPLv2.1
 language: en
 tags:
   - Audio
-description: An two stream audio mixer.
-bugs: Samples from the longer of the two frames are discarded.
+description: Mix two audio tracks.
+bugs:
+  - Samples from the longer of the two frames are discarded.
 parameters:
   - identifier: start
     title: Start
-    type: double
+    type: float
     mutable: yes
     description: >
-       The mix level to apply to the second frame. Any negative value causes an 
-       automatic crossfade from 0 to 1.
+      The mix level to apply to the second frame. Any negative value causes an
+      automatic crossfade from 0 to 1.
   - identifier: end
     title: End
-    type: double
+    type: float
     mutable: yes
     description: >
-       The ending value of the mix level. Mix level will be interpolated from 
-       start to end over the in-out range.
+      The ending value of the mix level. Mix level will be interpolated from
+      start to end over the in-out range.
   - identifier: reverse
     title: Reverse
     type: integer
     mutable: yes
     description: >
-       Set to 1 to reverse the direction of the mix.
+      Set to 1 to reverse the direction of the mix.
     default: 0
+    minimum: 0
+    maximum: 1
+    widget: checkbox
index aea23243ce83906fe3da30d34d441a14709232a3..cf954706eabeb8094b68dce5c7276be683e36439 100644 (file)
@@ -10,30 +10,32 @@ language: en
 tags:
   - Video
 description: >
-   Apply zero or more filters to B frame as it is composited onto a region of 
-   the A frame. The "shape" of the region can be defined by the alpha channel 
-   of a third producer.
+  Apply zero or more filters to B frame as it is composited onto a region of
+  the A frame. The "shape" of the region can be defined by the alpha channel
+  of a third producer.
 parameters:
   - identifier: argument
     title: Shape producer
     type: string
     description: >
-       Nothing (unspecified) is rectangle, "circle" is a pixbuf-generated SVG 
-       circle, anything else is loaded by the factory.
+      The default shape is a rectangle, "circle" is a pixbuf-generated SVG
+      circle, anything else is loaded by the factory.
   - identifier: factory
     title: Factory
     type: string
     description: >
-       The service that creates the shape producer.
-    default: 'loader'
+      The service that creates the shape producer.
+    default: loader
   - identifier: filter[N]
     title: Filter
     type: string
     description: >
-       One or more filters to apply. All filter properties are passed using the 
-       same filter "key".
+      One or more filters to apply. All filter properties are passed using the
+      same filter "key".
   - identifier: composite.*
     title: Composite
+    type: properties
+    service-name: transition.composite
     description: >
       Properties may be set on the encapsulated composite transition.
       
index ae91fb0d1dc16720c3b077dedf703a856de26b04..bd87c62f5532e21f4e0ebe5ec01f6953f03a069f 100644 (file)
@@ -16,40 +16,6 @@ parameters:
   - identifier: argument
     title: File
     type: string
-    description: >
-       The filename to write to.
-       
-       e.g. /dev/dv1394
+    description: The filename to write to, e.g. /dev/dv1394.
     required: yes
     widget: filesave
-  - identifier: buffer
-    title: Buffer
-    type: integer
-    description: >
-      Set the maximum number of frames to buffer - process ahead of the output
-      position.
-    minimum: 1
-    default: 25
-    unit: frames
-  - identifier: rescale
-    title: Image scaler
-    type: string
-    description: Set the pixel interpolation mode.
-    values:
-      - nearest
-      - bilinear
-      - bicubic
-      - bicublin
-      - gauss
-      - sinc
-      - lanczos
-      - spline
-  - identifier: progressive
-    title: Progressive
-    type: integer
-    description: indicates whether to use progressive or field-based rendering.
-    minimum: 0
-    maximum: 1
-    default: 0
-    mutable: yes
-    widget: checkbox
index 68110ddb888699159a3aaf118d92b775a6a6892b..3fc260a53b193e8f1d76d5664c31d354d24dd592 100644 (file)
@@ -10,21 +10,21 @@ language: en
 tags:
   - Audio
 description: >
-   Adjust an audio stream's volume level. This filter is based on the 
-   'normalize' utility
+  Adjust an audio stream's volume level. This filter is based on the
+  'normalize' utility
 parameters:
   - identifier: argument
     title: Gain
     type: string
     description: >
-       The gain may be indicated as a floating point value of the gain 
-       adjustment.
+      The gain may be indicated as a floating point value of the gain
+      adjustment.
        
-       The gain may also be indicated as a numeric value with the suffix "dB" 
-       to adjust in terms of decibels.
+      The gain may also be indicated as a numeric value with the suffix "dB"
+      to adjust in terms of decibels.
        
-       The gain may also be set to "normalise" to normalise the volume to the 
-       target amplitude -12dBFS.
+      The gain may also be set to "normalise" to normalise the volume to the
+      target amplitude -12dBFS.
   - identifier: window
     title: Window
     type: integer
@@ -36,43 +36,40 @@ parameters:
     title: Normalise
     type: string
     description: >
-       Normalise the volume to the specified amplitude.
+      Normalise the volume to the specified amplitude.
        
-       The normalization may be indicated as a floating point value of the 
-       relative volume
+      The normalization may be indicated as a floating point value of the
+      relative volume.
        
-       The normalisation may also be indicated as a numeric value with the 
-       suffix "dB" to set the amplitude in decibels.
+      The normalisation may also be indicated as a numeric value with the
+      suffix "dB" to set the amplitude in decibels.
     default: -12dBFS
     mutable: yes
   - identifier: limiter
     title: Limiter
     type: string
     description: >
-       Limit all samples above the specified amplitude.
+      Limit all samples above the specified amplitude.
        
-       The limiting may be indicated as a floating point value of the 
-       relative volume
+      The limiting may be indicated as a floating point value of the
+      relative volume.
        
-       The limiting may also be indicated as a numeric value with the suffix 
-       "dB" to set the limiting amplitude in decibels.
+      The limiting may also be indicated as a numeric value with the suffix
+      "dB" to set the limiting amplitude in decibels.
     default: -6dBFS
     mutable: yes
   - identifier: max_gain
     title: Max gain
-    type: double
+    type: string
     description: >
-       A floating point or decibel value of the maximum gain that can be 
-       applied during normalisation.
+      A floating point or decibel value of the maximum gain that can be
+      applied during normalisation.
     default: 20dB
     mutable: yes
   - identifier: end
     title: End gain
     type: string
     description: >
-       A gain value just like the Gain property. This causes the gain to be 
-       interpolated from 'gain' to 'end' over the duration.
+      A gain value just like the Gain property. This causes the gain to be
+      interpolated from 'gain' to 'end' over the duration.
     mutable: yes
-
-
-
index a2537ef5677d0b47fb00956506394eb5a293edef..a189a60fad937e2d616a60a52097ee999c1d400b 100644 (file)
@@ -11,33 +11,16 @@ tags:
   - Audio
   - Video
 description: >
-   Simple DirectMedia Layer audio and video output module.
+  Simple DirectMedia Layer audio and video output module.
 parameters:
   - identifier: argument
     title: Video Standard
     type: string
-    description: >
-       "PAL" (default), "NTSC", or "WxH"
-    required: yes
-  - identifier: buffer
-    title: Buffer
-    type: integer
-    description: >
-      Set the maximum number of frames to buffer - process ahead of the output
-      position.
-    minimum: 1
-    default: 25
-    unit: frames
-  - identifier: rescale
-    title: Image scaler
-    type: string
-    description: >
-       A rescale method, see the Filters/rescale.
-       
-       Hint: "none" works very good with SDL output.
+    description: The size of the window as WxH pixels.
+    required: no
   - identifier: volume
     title: Volume
-    type: double
+    type: float
     description: Audio level factor.
     mutable: yes
   - identifier: video_off
@@ -45,23 +28,23 @@ parameters:
     type: integer
     description: If 1, disable video output
     mutable: yes
+    minimum: 0
+    maximum: 1
+    default: 0
+    widget: checkbox
   - identifier: audio_off
     title: Audio off
     type: integer
     description: If 1, disable audio output
     mutable: yes
-  - identifier: progressive
-    title: Progressive
-    type: integer
-    description: indicates whether to use progressive or field-based rendering.
     minimum: 0
     maximum: 1
     default: 0
-    mutable: yes
     widget: checkbox
   - identifier: audio_buffer
     title: Audio buffer
     type: integer
     description: Size of the sdl audio buffer.
     mutable: yes
-    default: 1024
+    default: 2048
+    minimum: 128
index 5046dde79911de67c2eb527bab76c7655e744487..d729dd2ec035acc8198431b8c5b1f2a82ff84b24 100644 (file)
@@ -11,19 +11,20 @@ tags:
   - Audio
   - Video
 description: >
-  Serialise the service network to XML. See docs/mlt-xml.txt for more 
-  information.
-bugs: >
-   Untested arbitrary nesting of multitracks and playlists. Property "id" is 
-   generated as service type followed by number if no property named "id" 
-   exists, but it fails to guarantee uniqueness.
+  Serialise the service network to XML.
+  See docs/mlt-xml.txt for more information.
+bugs:
+   - Untested arbitrary nesting of multitracks and playlists.
+   - >
+     Property "id" is generated as service type followed by number if no
+     property named "id" exists, but it fails to guarantee uniqueness.
 parameters:
   - identifier: argument
     title: File
     type: string
     description: The name of a file in which to store the XML.
     readonly: no
-    required: yes
+    required: no
     mutable: no
     default: stdout
     widget: fileopen