added track hiding to westley
[melted] / docs / services.txt
index 10d25a0..07b6d01 100644 (file)
@@ -16,9 +16,10 @@ Producers
                Constructor Argument
 
                        'file' - a filename specification or URL in the form:
-                            [{protocol}|{format}]:{resource}[?{format-parameter}[&{format-parameter}]]
-                                For example, video4linux:/dev/video1?width=320&height=240
-                                Note: on the bash command line, '&' must be escaped as '\&'
+                            [{protocol}|{format}]:{resource}[?{format-parameter}[&{format-parameter}...]]
+                                For example, video4linux:/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 'ffmpeg -formats' to see a list of supported protocols 
                                 and formats.
                                         
@@ -57,6 +58,8 @@ Producers
                        MPEG seeking is inaccurate - doesn't seek to i-frames so you may
                        get junk for a few frames.
                        RAW DV seeking not supported.
+                       Fails to play beyond first frame of video of sources with PTS not
+                       starting at 0 (video4linux).
 
        fezzik
 
@@ -295,8 +298,6 @@ Producers
                        pango producer interprets the filename as pango text. This is a
                        shortcut to embed titles in inigo commands. For westley, it is 
                        recommended that you embed the title text in the property value.
-                       If you need to embed Pango markup in a westley XML file, then
-                       enclose the value inside "<![CDATA[ ... ]]>".
                        
                        Pango has builtin scaling. It will rescale the originally rendered
                        title to whatever the consumer requests. Therefore, it will lose
@@ -310,7 +311,7 @@ Producers
 
                Mutable Properties
 
-                       string markup - a UTF-8 string containing Pango markup see:
+                       string markup - a string containing Pango markup see:
                        http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
                                      - requires xml-like encoding special chars from: 
                                        <, >, &   -to-   &lt;, &gt;, &amp;
@@ -326,6 +327,8 @@ Producers
                                      markup chars un-encoded)
                        string font - the default typeface to use when not using markup.
                                      default "Sans 48". FreeType2 renders at 72 dpi.
+                       string encoding - the text encoding type of the input if not UTF-8.
+                                       - see 'iconv --list' for a list of possible inputs.
 
                Read Only Properties
 
@@ -365,9 +368,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 westley XML, set the resource
-                                property value with inline XML embedded using a CDATA node
-                                ("<![CDATA[ ... ]]>").
+                                for inigo commands.
                                         
                Details
                
@@ -518,6 +519,31 @@ Filters
                Known Bugs
                
                        Does not go completely to black or white.
+                       
+       
+       channelcopy
+       
+               Description
+               
+                       Copy audio from one channel to another channel.
+                       
+               Constructor Argument
+               
+                       to - the 0-indexed channel to copy into, default is 1.
+                       
+               Mutable Properties
+               
+                       int to - see above
+                       int from - the channel from which to copy, default is 0.
+                       
+               Dependencies
+               
+                       none
+                       
+               Known Bugs
+               
+                       none
+                       
 
 
        deinterlace
@@ -687,6 +713,39 @@ Filters
                        none
                
        
+       mirror
+       
+               Description
+               
+                       Provides various mirror and image reversing effects.
+
+               Constructor Argument
+               
+                       mirror - horizontal, vertical, diagonal, flip, flop
+                       
+               Initialisation Properties
+               
+                       int reverse - being 0 or 1
+                       int in - in point
+                       int out - out point
+                       
+               Read Only Properties
+               
+                       none
+                       
+               Mutable Properties
+               
+                       none
+
+               Dependencies
+               
+                       none
+                       
+               Known Bugs
+               
+                       none
+
+
        obscure
        
                Description
@@ -754,7 +813,9 @@ Filters
 
                Description
 
-                       Adjust an audio stream's sampling rate.
+                       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.
 
@@ -777,7 +838,8 @@ Filters
 
                Known Bugs
 
-                       none
+                       Assumes 2 channels during libsamplerate initialisation. Untested
+                       with >2 channels.
 
        rescale
 
@@ -1155,11 +1217,18 @@ Consumers
                
                Constructor Argument
 
-                       string video_standard - "PAL" (default) or "NTSC"
+                       card - a numeric card id starting at 1, default is 1.
                        
                Initialisation Properties
 
-                       int video_standard - 0 = PAL, 1 = NTSC
+                       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
 
@@ -1173,10 +1242,10 @@ Consumers
 
                        Does not work with any service that uses pipes!
                        
-                       If mlt crashes, you must reload the BlueDriver kernel module
-                       due to unreleased DMA buffers.
+                       If mlt crashes, you might need to reload the BlueDriver kernel 
+                       module due to unreleased DMA buffers.
                        
-                       Needs an argument or property for multi-card address.
+                       Only supports 2 channel audio at the moment.
                
        libdv