]> git.sesse.net Git - mlt/blobdiff - docs/services.txt
fezzik.dict: prioritize avformat higher than libdv for better quality
[mlt] / docs / services.txt
index 5b9d4af5561d46f070093686ad307844295e82dd..13d3ee6f32d626c50e9c2ddbff9123e2633ea4b9 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-03-20
+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
 ---------
@@ -324,6 +323,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 +376,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 +690,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
+                       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
+           
+                       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 +890,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
@@ -1421,8 +1544,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)