X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Fservices.txt;h=b3877490d1cdf1da4eceb37b2f1ddda1141eba65;hb=2d71618ab696a31fabfbc2265b2ad0d5cc9171b2;hp=a92de21600f6fa9f4c601597874855ad58803bc5;hpb=4a39b72c5ac8fd2dd6db81a95eab08adde0491b9;p=melted

diff --git a/docs/services.txt b/docs/services.txt
index a92de21..b387749 100644
--- a/docs/services.txt
+++ b/docs/services.txt
@@ -3,7 +3,7 @@ Service Documentation
 Copyright (C) 2004 Ushodaya Enterprises Limited
 Authors: Charles Yates <charles.yates@pandora.be>
          Dan Dennedy <dan@dennedy.org>
-Last Revision: 2004-03-20
+Last Revision: 2004-11-07
 
 
 SERVICES
@@ -688,6 +688,53 @@ 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
+			jacks 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
+	    
+	        no encapsulated resampling and jack runs at a fixed frequency
+	    
 	luma
 	
 	    Description
@@ -1079,19 +1126,10 @@ Transitions
 	        
 	    Constructor Argument
 
-	        string start - a geometry specification as X,Y:WxH[!][:mix]
-	                     - X, Y, W, H are assumed to pixel units unless they
-	                       have the suffix '%'
-	                     - '!' is a shortcut to specify distort, see below.
-	                     - mix is always a 2 digit percentage, defaults to 100.
-	                     - default is "85%,5%:10%x10%"
+			none[*]
 
 	    Initialisation Properties
 	        
-	        string end - the ending size and position.
-	        string key[F] - X,Y:WxH[:mix] - set a key frame for geometry between
-	                        the in and out. F is a frame number and can be
-	                        negative to make it relative to the out point.
 	        int in - in point
 	        int out - out point
 	        string factory - The name of a factory service used as a non-PGM
@@ -1102,7 +1140,11 @@ Transitions
 	        none
 
 	    Mutable Properties
-	        
+
+
+			string geometry - key frame specification
+							- this is a ; delimited form of the deprecated start,
+							  key[n], end properties
 	        int progressive - set to 1 to disable field-based rendering.
 	        string distort - when set, causes the B frame image to fill the WxH
 	                         completely with no regard to B's aspect ratio.
@@ -1121,6 +1163,19 @@ Transitions
 	        Any property starting with "luma." is passed to the non-PGM luma
 	            producer.
 
+		Deprecated Properties
+
+	        string start - a geometry specification as X,Y:WxH[!][:mix]
+	                     - X, Y, W, H are assumed to pixel units unless they
+	                       have the suffix '%'
+	                     - '!' is a shortcut to specify distort, see below.
+	                     - mix is always a 2 digit percentage, defaults to 100.
+	                     - default is "85%,5%:10%x10%"
+	        string end - the ending size and position.
+	        string key[F] - X,Y:WxH[:mix] - set a key frame for geometry between
+	                        the in and out. F is a frame number and can be
+	                        negative to make it relative to the out point.
+
 	    Dependencies
 
 	        none
@@ -1413,8 +1468,7 @@ Consumers
 	        double volume - audio level factor
 	        int video_off - if 1, disable video output
 	        int audio_off - if 1, disable audio output
-	        int scale_overlay - if 1, resample video from source pixel aspect
-	                            ratio to square pixels.
+			int resize - TODO
 	        int progressive - indicates whether to use progressive or field-
 	                          based rendering, default 0 (off).
 		int audio_buffer - size of the sdl audio buffer (default: 1024)