provisional framework docs and corrections

[melted] / docs / services.txt

diff --git a/docs/services.txt b/docs/services.txt
index 23fbf4b..74672b9 100644 (file)
--- a/docs/services.txt
+++ b/docs/services.txt
@@ -15,7 +15,19 @@ Producers
 
                Constructor Argument
 
-                       'file' - producer a/v from file
+                       '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 '\&'
+                                Use 'ffmpeg -formats' to see a list of supported protocols 
+                                and formats.
+                                        
+               Details
+               
+                       Format parameters only appear to be useful with 'video4linux' or
+                       'audio_device' formats. For 'video4linux' the parameters are
+                       width, height, frame_rate, frame_rate_base, and standard (ntsc|pal).
+                       For 'audio_device' the parameters are channels and sample_rate.
 
                Initialisation Properties
 
@@ -54,7 +66,8 @@ Producers
 
                Constructor Argument
 
-                       'file'  - produce a/v from file
+                       'file'  - a filename specification:
+                                 [{mlt-service}:]{resource} | {mlt-service}
                                - can also be the name of a producer service that can
                                          accept the resource specified post construction.
 
@@ -505,6 +518,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
@@ -741,7 +779,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.
 
@@ -764,7 +804,8 @@ Filters
 
                Known Bugs
 
-                       none
+                       Assumes 2 channels during libsamplerate initialisation. Untested
+                       with >2 channels.
 
        rescale
 
@@ -1165,15 +1206,6 @@ Consumers
                        
                        Needs an argument or property for multi-card address.
                
-       ffmpeg
-       
-               Description
-               Constructor Argument
-               Initialisation Properties
-               Read Only Properties
-               Dependencies
-               Known Bugs
-
        libdv
        
                Description
@@ -1182,12 +1214,17 @@ Consumers
 
                Constructor Argument
 
-                       string target
+                       string target - the filename to write to, e.g. /dev/dv1394.
 
                Initialisation Properties
                
-                       int buffer
-                       string rescale
+                       int buffer - the number of frames to buffer, minimum 1, default 25.
+                       string rescale - a rescale method, see the Filters/rescale.
+               
+               Mutable Properties
+               
+                       int progressive - indicates whether to use progressive or field-
+                                         based rendering, default 0 (off).
                        
                Read Only Properties
                
@@ -1211,6 +1248,12 @@ Consumers
 
                        string video_standard - "PAL" (default), "NTSC", or "WxH"
                        
+               Initialisation Properties
+               
+                       int buffer - the number of frames to buffer, minimum 1, default 25.
+                       string rescale - a rescale method, see the Filters/rescale.
+                                      - Hint: "none" works very good with SDL output.
+                       
                Mutable Properties
 
                        double volume - audio level factor
@@ -1218,6 +1261,8 @@ Consumers
                        int audio_off - if 1, disable audio output
                        int scale_overlay - if 1, resample video from source pixel aspect
                                            ratio to square pixels.
+                       int progressive - indicates whether to use progressive or field-
+                                         based rendering, default 0 (off).
                        
                Read Only Properties
 
@@ -1229,8 +1274,7 @@ Consumers
                
                Known Bugs
 
-                       NTSC handling needs tightening up - sdl:NTSC is the only valid
-                       constructor for NTSC playback at the moment.
+                       none
 
        westley
 
@@ -1242,7 +1286,7 @@ Consumers
                Constructor Argument
 
                        resource - the name of a file in which to store the XML.
-                               stdout is used if not supplied.
+                                 - stdout is default.
                        
                Initialisation Properties