]> git.sesse.net Git - mlt/blobdiff - docs/services.txt
services.txt: minor corrections to documentation for producer_avformat
[mlt] / docs / services.txt
index 86a9ab6366be2e2caa36943eb99dc0e73374fa9a..63d6c5a3596cd24dbdeebc01311dfe07434492de 100644 (file)
@@ -1,16 +1,15 @@
 Service Documentation
 
-Copyright (C) 2004 Ushodaya Enterprises Limited
 Authors: Charles Yates <charles.yates@pandora.be>
          Dan Dennedy <dan@dennedy.org>
-Last Revision: 2004-11-07
+Last Revision: $Date$
 
 
 SERVICES
 --------
 
-       Services marked as "(Proprietary)" are not distributed with the GPL version
-       of mlt.
+       Services marked as "(Proprietary)" are not distributed with the LGPL
+       version of mlt.
 
 Producers
 ---------
@@ -48,24 +47,18 @@ Producers
            Read Only Properties
 
                string resource - file location
-               double fps - this is fixed at 25 for PAL currently
                double source_fps - the framerate of the resource
                double aspect_ratio - sample aspect ratio of the resource
                                    - this is determined on every frame read
 
            Dependencies
 
-               ffmpeg must be configured as --enable-shared and installed prior
-               to compilation of mlt.
+               ffmpeg
 
            Known Bugs
 
                Audio sync discrepancy with some content.
                Not all libavformat supported formats are seekable.
-               Ogg Vorbis is currently broken.
-               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).
 
@@ -377,6 +370,8 @@ Producers
 
                int in - in point
                int out - out point
+               int begin  - when using an image sequence, this sets the starting
+                            number.
 
            Mutable Properties
 
@@ -703,7 +698,7 @@ Filters
                Details
                
                        If you are using a consumer that uses ALSA, then you should start
-                       jacks with the dummy driver: jackd -d dummy.
+                       jackd with the dummy driver: jackd -d dummy.
                        I also recommend using a period size of 2048: -p 2048.
                        
                        jackd -ddummy -r48000 -p2048
@@ -732,6 +727,48 @@ Filters
            
                Jack, LADSPA, glib-2.0, libxml2
                
+           Known Bugs
+           
+                       Currently, due to timing and synchronisation issues, the audio
+                       is distorted with repeated samples and latency clicks.
+               no encapsulated resampling and jack runs at a fixed frequency
+           
+       ladspa
+       
+           Description
+           
+               Runs a JackRack project to process audio through a stack of
+                       LADSPA filters without using Jack.
+               
+           Constructor Argument
+           
+               src - a JackRack file
+                       
+               Details
+
+                       Due to audio integrity issues with the jackrack filter, this
+                       filter is better for runtime, while jackrack is more suitable
+                       for prototyping a rack file using the Jack Rack GUI.
+               
+           Initialisation Properties
+           
+               int in - in point
+               int out - out point
+                       
+           Read Only Properties
+           
+               none
+               
+           Mutable Properties
+
+                       none
+               
+           Dependencies
+           
+               Jack, LADSPA, glib-2.0, libxml2
+                       Jack is still required because this coexists with the jackrack 
+                       filter.
+               
            Known Bugs
            
                no encapsulated resampling and jack runs at a fixed frequency
@@ -847,6 +884,38 @@ Filters
                none
 
 
+       mono
+       
+           Description
+           
+               Mix all channels of audio into a mono signal and output it as
+                       N channels.
+
+           Constructor Argument
+           
+               channels - the number of output channels (default 2)
+               
+           Initialisation Properties
+           
+               none
+               
+           Read Only Properties
+           
+               none
+               
+           Mutable Properties
+           
+               none
+
+           Dependencies
+           
+               none
+               
+           Known Bugs
+           
+               none
+
+
        obscure
        
            Description