]> git.sesse.net Git - mlt/blobdiff - docs/services.txt
Add -query preset to man page.
[mlt] / docs / services.txt
index 63d6c5a3596cd24dbdeebc01311dfe07434492de..dd263c797f45218d1e5031d83013b3fdab7a13c6 100644 (file)
@@ -2,7 +2,7 @@ Service Documentation
 
 Authors: Charles Yates <charles.yates@pandora.be>
          Dan Dennedy <dan@dennedy.org>
-Last Revision: $Date$
+Last Revision: 2009-05-08
 
 
 SERVICES
@@ -62,7 +62,7 @@ Producers
                Fails to play beyond first frame of video of sources with PTS not
                starting at 0 (video4linux).
 
-       fezzik
+       loader
 
            Description
 
@@ -174,67 +174,6 @@ Producers
                DVCPRO is incorrectly identified as 16:9 aspect ratio. You must use
                libdv from CVS or a post 0.101 release. 
 
-       mcdv (Proprietary)
-
-           Description
-
-               MainConcept based dv decoder for video and audio.
-
-           Constructor Argument
-
-               'file'    - produce a/v from file
-
-           Initialisation Properties
-
-               int in - in point
-               int out - out point
-
-           Read Only Properties
-
-               string resource - file location
-               double fps - output frames per second
-               int length - duration of resource (in frames)
-
-           Dependencies
-
-               MainConcept DV or DVCPRO SDK, libdv.
-               "dv_sdk" installed parallel to mlt.
-
-           Known Bugs
-
-               None
-
-       mcmpeg (Proprietary)
-
-           Description
-
-               MainConcept based mpeg decoder for video and audio.
-
-           Constructor Argument
-
-               'file'    - produce a/v from file
-
-           Initialisation Properties
-
-               int in - in point
-               int out - out point
-
-           Read Only Properties
-
-               string resource - file location
-               double fps - output frames per second
-               double aspect_ratio - sample aspect ratio of video
-               int length - duration of resource (in frames)
-               
-           Dependencies
-
-               MainConcept MPEG SDK.
-               "mpeg_sdk_release" installed parallel to mlt.
-
-           Known Bugs
-
-               None.
-
        noise
 
            Description
@@ -281,10 +220,10 @@ Producers
                              
            Details
            
-               Supplying a filename with extension ".txt" causes the Fezzik 
+               Supplying a filename with extension ".txt" causes the loader 
                producer to load with pango. If the filename begins with "+" the 
                pango producer interprets the filename as pango text. This is a
-               shortcut to embed titles in inigo commands. For westley, it is 
+               shortcut to embed titles in melt commands. For MLT XML, it is 
                recommended that you embed the title text in the property value.
                
                Pango has builtin scaling. It will rescale the originally rendered
@@ -357,7 +296,7 @@ Producers
                         load all pictures with matching extension from a directory.
                       - If filename contains the string "<svg", then pixbuf tries
                         to load the filename as inline SVG XML, which is convenient
-                        for inigo commands.
+                        for melt commands.
                         
            Details
            
@@ -421,26 +360,26 @@ Producers
 
                Since it uses pipes, it is not compatible with bluefish.
 
-       westley
+       xml
 
            Description
 
                Construct a service network from an XML description.
-               See docs/westley.txt.
+               See docs/mlt-xml.txt.
 
            Constructor Argument
 
-               URL - an XML text file containing westley XML (schema/DTD pending)
-                   - Since westley files can be parameterised, the URL syntax is:
+               URL - an XML text file containing MLT XML
+                   - Since MLT XML files can be parameterised, the URL syntax is:
                      {file-name}[?{param-name}{'='|':'}{param-value}[&{param-name}{'='|':'}{param-value}...]]
-                     A colon is allowed instead of an equal sign to pacify inigo,
+                     A colon is allowed instead of an equal sign to pacify melt,
                      who tokenises anything with an equal sign as a property 
-                     setting. Also, when running inigo from the shell, beware of
+                     setting. Also, when running melt from the shell, beware of
                      the '?' and shell filename expansion. You can surround the URL
-                     with single quotations to prevent expansion. Finally, fezzik
+                     with single quotations to prevent expansion. Finally, the loader
                      will fail to match the filename when you use parameters, so
-                     preface the url with 'westley:' to force fezzik to load with
-                     the westley service.
+                     preface the url with 'xml:' to force the loader to load with
+                     the xml service.
                      
            Read Only Properties
 
@@ -649,7 +588,7 @@ Filters
            Description
 
                Scale the producer video frame size to match the consumer.
-               This filter is designed for use as a Fezzik normaliser.
+               This filter is designed for use as a normaliser for the loader producer.
 
            Constructor Argument
 
@@ -812,45 +751,6 @@ Filters
            
                none
            
-       mcrescale
-
-           Description
-
-               Scale the producer video frame size to match the consumer.
-               This filter is designed for use as a Fezzik normaliser.
-
-           Constructor Argument
-
-               interpolation - the rescaling method, one of:
-                   nearest (lowest quality, fastest),
-                   bilinear (default; good quality, moderate speed),
-                   hyper (best quality, slowest).
-
-           Initialisation Properties
-
-               int in - in point
-               int out - out point
-
-           Mutable Properties
-
-               string interpolation - see constructor argument above
-
-               If a property "consumer_aspect_ratio" exists on the frame, then
-               rescaler normalises the producer's aspect ratio and maximises the
-               size of the frame, but may not produce the consumer's requested
-               dimension. Therefore, this option works best in conjunction with the
-               resize filter. This behavior can be disabled by another service by
-               either removing the property, setting it to zero, or setting
-               frame property "distort" to 1.
-
-           Dependencies
-
-               the mainconcept rescaling sdk.
-
-           Known Bugs
-
-               none
-       
        mirror
        
            Description
@@ -986,8 +886,8 @@ Filters
                Adjust an audio stream's sampling rate, and duplicate channels if 
                producer provides less than consumer requested.
                
-               This filter is automatically invoked by Fezzik for the sake of
-               normalisation over inputs and with the consumer.
+               This filter is automatically invoked by the loader producer for the
+               sake of normalisation over inputs and with the consumer.
 
            Constructor Argument
 
@@ -1016,7 +916,7 @@ Filters
            Description
 
                Scale the producer video frame size to match the consumer.
-               This filter is designed for use as a Fezzik normaliser.
+               This filter is designed for use as a normaliser for the loader producer.
 
            Constructor Argument
 
@@ -1060,7 +960,7 @@ Filters
                This filter also adjusts the field order to lower field first
                if the frame property "top_field_first" has been set to 1.
                Therefore, when done, it sets the top_field_first to 0.
-               This filter is automatically invoked by Fezzik as part of image
+               This filter is automatically invoked by the loader as part of image
                sample aspect ratio normalisation.
                
            Constructor Argument
@@ -1155,9 +1055,9 @@ Filters
            Initialisation Properties
 
                string resource - the producer to use
-               string factory - producer required for the resource ('fezzik')
-               string geometry - composite geometry
-               string distort - control scaling
+               string factory - producer required for the resource (default: 'loader')
+               string composite.geometry - composite geometry
+               string composite.distort - control scaling
                int in - in point
                int out - out point
 
@@ -1167,7 +1067,7 @@ Filters
 
            Dependencies
 
-               mlt core modules and optionally, fezzik
+               mlt core modules and optionally, loader
 
            Known Bugs
 
@@ -1203,7 +1103,7 @@ Transitions
                int in - in point
                int out - out point
                string factory - The name of a factory service used as a non-PGM
-                                producer loader. The default is fezzik.
+                                producer loader. The default is 'loader'.
        
            Read Only Properties
 
@@ -1284,7 +1184,7 @@ Transitions
                int in - in point
                int out - out point
                string factory - The name of a factory service used as a non-PGM
-                                producer loader. The default is Fezzik.
+                                producer loader. The default is 'loader'.
 
            Mutable Properties
 
@@ -1361,7 +1261,7 @@ Transitions
                string resource - nothing is rectangle, "circle" is a pixbuf-
                    generated SVG circle, anything else is loaded by the factory.
                string factory - the service that creates the shape producer.
-                              - the default is fezzik.
+                              - the default is 'loader'.
                string filter[N] - one or more filters to apply. All filter
                                   properties are passed using the same filter "key"
                Any property starting with "composite." is passed to the 
@@ -1412,44 +1312,6 @@ Consumers
            
                Plenty.
 
-       bluefish (Proprietary)
-       
-           Description
-
-               BlueFish444 audio and video output module.
-           
-           Constructor Argument
-
-               card - a numeric card id starting at 1, default is 1.
-               
-           Initialisation Properties
-
-               string standard - "PAL" (default) or "NTSC"
-                               - default is based upon MLT_NORMALISATION 
-                                 environment variable, which defaults to PAL.
-               int frames - the number of DMA video frames. default is 8.
-                            minimum is 2. maximum on my system is 11.
-               int buffer - the number of frames to buffer within MLT, minimum 1, 
-                            default 25.
-               string rescale - a rescale method, see the Filters/rescale.
-               
-           Read Only Properties
-
-               none
-           
-           Dependencies
-
-               BlueVelvet SDK installed parallel to mlt in "bluefish."
-           
-           Known Bugs
-
-               Does not work with any service that uses pipes!
-               
-               If mlt crashes, you might need to reload the BlueDriver kernel 
-               module due to unreleased DMA buffers.
-               
-               Only supports 2 channel audio at the moment.
-           
        libdv
        
            Description
@@ -1482,41 +1344,6 @@ Consumers
            
                none
 
-       mcmpeg
-       
-           Description
-           
-               Mainconcept MPEG encoder.
-
-           Constructor Argument
-
-               string target - the filename to write to.
-
-           Initialisation Properties
-           
-               int buffer - the number of frames to buffer, minimum 1, default 25.
-               string rescale - a rescale method, see the Filters/rescale.
-               string format - vcd [default], svcd or dvd provide base settings
-               int motion_search_type - 0 to 16 - reduces quality/cpu usage
-               int gop - group of picture size (default: format dependent)
-
-           Mutable Properties
-           
-               int progressive - indicates whether to use progressive or field-
-                                 based rendering, default 0 (off).
-               
-           Read Only Properties
-           
-               none
-               
-           Dependencies
-           
-               Mainconcept MPEG SDK
-               
-           Known Bugs
-           
-               none
-
        sdl
 
            Description
@@ -1555,12 +1382,12 @@ Consumers
 
                none
 
-       westley
+       xml
 
            Description
 
                Serialise the service network to XML.
-               See docs/westley.txt for more information.
+               See docs/mlt-xml.txt for more information.
                
            Constructor Argument