]> git.sesse.net Git - mlt/blobdiff - docs/services.txt
a clarification
[mlt] / docs / services.txt
index c0742065e953e673af4a27ef59d166349fb89c7d..8a235fee015be5bb48b7f6b61818a32a6515be5d 100644 (file)
@@ -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
@@ -691,6 +648,46 @@ Filters
 
                none
            
+       gtkrescale
+
+           Description
+
+               Scale the producer video frame size to match the consumer.
+               This filter is designed for use as a Fezzik normaliser.
+
+           Constructor Argument
+
+               interpolation - the rescaling method, one of:
+                   nearest (lowest quality, fastest),
+                   tiles,
+                   bilinear (default; good quality, moderate speed),
+                   hyper (best quality, slowest).
+
+           Initialisation Properties
+
+               int in - in point
+               int out - out point
+
+           Mutable Properties
+
+               string interpolation - see constructor argument above
+
+               If a property "consumer_aspect_ratio" exists on the frame, then
+               rescaler normalises the producer's aspect ratio and maximises the
+               size of the frame, but may not produce the consumer's requested
+               dimension. Therefore, this option works best in conjunction with the
+               resize filter. This behavior can be disabled by another service by
+               either removing the property, setting it to zero, or setting
+               frame property "distort" to 1.
+
+           Dependencies
+
+               libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0
+
+           Known Bugs
+
+               none
+
        luma
        
            Description
@@ -730,6 +727,44 @@ Filters
            
                none
            
+       mcrescale
+
+           Description
+
+               Scale the producer video frame size to match the consumer.
+               This filter is designed for use as a Fezzik normaliser.
+
+           Constructor Argument
+
+               interpolation - the rescaling method, one of:
+                   nearest (lowest quality, fastest),
+                   bilinear (default; good quality, moderate speed),
+                   hyper (best quality, slowest).
+
+           Initialisation Properties
+
+               int in - in point
+               int out - out point
+
+           Mutable Properties
+
+               string interpolation - see constructor argument above
+
+               If a property "consumer_aspect_ratio" exists on the frame, then
+               rescaler normalises the producer's aspect ratio and maximises the
+               size of the frame, but may not produce the consumer's requested
+               dimension. Therefore, this option works best in conjunction with the
+               resize filter. This behavior can be disabled by another service by
+               either removing the property, setting it to zero, or setting
+               frame property "distort" to 1.
+
+           Dependencies
+
+               the mainconcept rescaling sdk.
+
+           Known Bugs
+
+               none
        
        mirror
        
@@ -798,7 +833,7 @@ Filters
        
            Description
            
-               Apply one or filters to a region of the video image. The region
+               Apply one or more filters to a region of the video image. The region
                can be shaped as well using the alpha channel of another producer.
                
            Constructor Argument
@@ -864,16 +899,11 @@ Filters
            Description
 
                Scale the producer video frame size to match the consumer.
-               This filter is automatically invoked by Fezzik in order to normalise
-               sample aspect ratio.
+               This filter is designed for use as a Fezzik normaliser.
 
            Constructor Argument
 
-               interpolation - the rescaling method, one of:
-                   nearest (lowest quality, fastest),
-                   tiles,
-                   bilinear (default; good quality, moderate speed),
-                   hyper (best quality, slowest).
+               None.
 
            Initialisation Properties
 
@@ -882,8 +912,6 @@ Filters
 
            Mutable Properties
 
-               string interpolation - see constructor argument above
-
                If a property "consumer_aspect_ratio" exists on the frame, then
                rescaler normalises the producer's aspect ratio and maximises the
                size of the frame, but may not produce the consumer's requested
@@ -894,11 +922,12 @@ Filters
 
            Dependencies
 
-               libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0
+               none
 
            Known Bugs
 
-               none
+               none but... it only implements a nearest neighbour scaling - it is
+                       used as the base class for the gtkrescale and mcrescale filters.
 
        resize
        
@@ -943,7 +972,8 @@ Filters
 
            Description
 
-               Adjust an audio stream's volume level
+               Adjust an audio stream's volume level 
+                               - based on the 'normalize' utility
                
            Constructor Argument