X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Fservices.txt;h=63d6c5a3596cd24dbdeebc01311dfe07434492de;hb=84425c1be5307863eea88f29e285df38026b6984;hp=f5565a39a02e653e63201cf2bda871c55c2ce3e6;hpb=427b602b441536159d491930d5f28b41bb896664;p=melted

diff --git a/docs/services.txt b/docs/services.txt
index f5565a3..63d6c5a 100644
--- a/docs/services.txt
+++ b/docs/services.txt
@@ -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).
 
@@ -324,6 +317,7 @@ Producers
 	                      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.
+			int weight - the weight of the font (default is 400)
 
 	    Read Only Properties
 
@@ -376,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
 
@@ -688,6 +684,95 @@ Filters
 
 	        none
 
+	jackrack
+	
+	    Description
+	    
+	        Creates Jack ports and runs a JackRack project to process audio
+			through a stack of LADSPA filters.
+	        
+	    Constructor Argument
+	    
+	        src - a JackRack file
+			
+		Details
+		
+			If you are using a consumer that uses ALSA, then you should start
+			jackd with the dummy driver: jackd -d dummy.
+			I also recommend using a period size of 2048: -p 2048.
+			
+			jackd -ddummy -r48000 -p2048
+	        
+	    Initialisation Properties
+	    
+	        int in - in point
+	        int out - out point
+			
+			The following can be used without a rack file in order to connect
+			filter_jackrack to a running instance of JackRack:
+			string out_1 - Jack port to connect MLT's output port (JackRack's input)
+			string out_2 - Jack port to connect MLT's output port (JackRack's input)
+			string in_1 - Jack port to connect MLT's input port (JackRack's output)
+			string in_2 - Jack port to connect MLT's input port (JackRack's output)
+	        
+	    Read Only Properties
+	    
+	        none
+	        
+	    Mutable Properties
+
+			none
+	        
+	    Dependencies
+	    
+	        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
+	    
 	luma
 	
 	    Description
@@ -799,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