]> git.sesse.net Git - mlt/blobdiff - docs/services.txt
Threading considerations and DVCP WIPE introduced
[mlt] / docs / services.txt
index b69dbb89efe8578a08ead23edf7993f7041ead1a..86a9ab6366be2e2caa36943eb99dc0e73374fa9a 100644 (file)
@@ -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
@@ -146,49 +146,6 @@ Producers
                none
 
        
-       ffmpeg (DEPRECATED)
-
-           Description
-
-               Test case pipe based producer for video and audio.
-
-           Constructor Argument
-
-               'file'    - produce a/v from file
-               v4l        - produce a/v from video4linux and dsp device
-
-           Initialisation Properties
-
-               string video_type - "file" or "v4l"
-               string video_file - file or v4l device
-               string video_size - WxH of video to produce (default: "")
-               int video_loop - loop video until audio exhausted (default: 0)
-               string audio_type - "file" or "dsp"
-               string audio_file - file or dsp device
-               int audio_rate - audio frequency (default: 48000)
-               int audio_channels - audio channels (default: 2)
-               int audio_track - audio track to use (default: 0)
-               int audio_loop - loop audio until video exhausted (default: 0)
-               int in - in point
-               int out - out point
-               double fps - output frames per second (default: 25)
-               double aspect_ratio - aspect ratio of video
-
-           Read Only Properties
-
-               string resource - file or "v4l"
-               int end_of_clip - holds 1 when input is exhausted
-
-           Dependencies
-
-               ffmpeg executable.
-
-           Known Bugs
-
-               in point setting is broken.
-
-               Implementation does not allow fast random access.
-
        libdv
 
            Description
@@ -367,6 +324,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
 
@@ -731,6 +689,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
@@ -1015,7 +1020,8 @@ Filters
 
            Description
 
-               Adjust an audio stream's volume level
+               Adjust an audio stream's volume level 
+                               - based on the 'normalize' utility
                
            Constructor Argument
 
@@ -1121,19 +1127,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
@@ -1144,7 +1141,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.
@@ -1163,6 +1164,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
@@ -1399,6 +1413,41 @@ Consumers
            
                none
 
+       mcmpeg
+       
+           Description
+           
+               Mainconcept MPEG encoder.
+
+           Constructor Argument
+
+               string target - the filename to write to.
+
+           Initialisation Properties
+           
+               int buffer - the number of frames to buffer, minimum 1, default 25.
+               string rescale - a rescale method, see the Filters/rescale.
+               string format - vcd [default], svcd or dvd provide base settings
+               int motion_search_type - 0 to 16 - reduces quality/cpu usage
+               int gop - group of picture size (default: format dependent)
+
+           Mutable Properties
+           
+               int progressive - indicates whether to use progressive or field-
+                                 based rendering, default 0 (off).
+               
+           Read Only Properties
+           
+               none
+               
+           Dependencies
+           
+               Mainconcept MPEG SDK
+               
+           Known Bugs
+           
+               none
+
        sdl
 
            Description
@@ -1420,10 +1469,10 @@ 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)
                
            Read Only Properties