add filter/jackrack to services.txt and apply a performance tweak to filter_jackrack

[mlt] / docs / services.txt

diff --git a/docs/services.txt b/docs/services.txt
index f5565a39a02e653e63201cf2bda871c55c2ce3e6..b3877490d1cdf1da4eceb37b2f1ddda1141eba65 100644 (file)
--- a/docs/services.txt
+++ b/docs/services.txt
@@ -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