+ none
+
+Transitions
+-----------
+
+ composite
+
+ Description
+
+ A key-framable alpha-channel compositor for two frames.
+
+ Details
+
+ Performs dissolves and luma wipes in addition to alpha compositing.
+
+ By default, the aspect ratio of the B frame is respected and the
+ size portion of the geometry specification simply defines a
+ bounding rectangle.
+
+ This performs field-based rendering unless the A frame property
+ "progressive" or "consumer_progressive" or the transition property
+ "progressive" is set to 1.
+
+ 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%"
+
+ 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
+ producer loader. The default is fezzik.
+
+ Read Only Properties
+
+ none
+
+ Mutable 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.
+ string halign - when not distorting, set the horizontal alignment
+ of B within the geometry rectangle.
+ - one of: left (0), centre (1), or right (2).
+ - the default is left.
+ string valign - when not distorting, set the vertical alignment of
+ B within the geometry rectangle.
+ - one of: top (0), middle (1), or bottom (2).
+ - the default is top.
+ string luma - the luma map file name. If not supplied, a dissolve.
+ double softness - only when using a luma map, how soft to make the
+ edges between A and B. 0.0 = no softness. 1.0 =
+ too soft.
+ Any property starting with "luma." is passed to the non-PGM luma
+ producer.
+
+ Dependencies
+
+ none
+
+ Known Bugs
+
+ Assumes lower field first during field rendering.
+
+ luma
+
+ Description
+
+ A generic dissolve and wipe transition processor.
+
+ Details
+
+ luma gets its name
+ from how it uses a grayscale "map" file. As the luma value varies
+ over time, a threshold filter is applied to the map to determine
+ what parts of frame A vs. frame B to show. It reads PGM files
+ up to 16 bits! Alternatively, it can use the first frame from any
+ producer that outputs yuv, but it will be limited to the luma
+ gamut of 220 values.
+ This performs field-based rendering unless the A frame property
+ "progressive" or "consumer_progressive" or the transition property
+ "progressive" is set to 1.
+
+ Constructor Argument
+
+ string resource - the luma map file name - either PGM or any other
+ producable video.
+ - If not supplied, a dissolve.
+
+ Initialisation Properties
+
+ int in - in point
+ int out - out point
+ string factory - The name of a factory service used as a non-PGM
+ producer loader. The default is Fezzik.
+
+ Mutable Properties
+
+ string resource - same as above
+ double softness - only when using a luma map, how soft to make the
+ edges between A and B. 0.0 = no softness. 1.0 =
+ too soft.
+ Any property starting with "producer." is passed to the non-PGM luma
+ producer.
+
+ Read Only Properties
+
+ none
+
+ Dependencies
+
+ none
+
+ Known Bugs
+
+ Assumes lower field first output.
+
+ mix
+
+ Description
+
+ An two stream audio mixer.
+
+ Constructor Argument
+
+ start - see below
+
+ Initalisation Properties
+
+ int in - in point
+ int out - out point
+
+ Mutable Properties
+
+ double start - the mix level to apply to the second frame.
+ - any negative value causes an automatic crossfade from 0 to 1.
+ double end - the ending value of the mix level. mix level will be interpolated
+ from start to end over the in-out range.
+ int reverse - set to 1 to reverse the direction of the mix.
+
+ Read Only Properties
+
+ none
+
+ Dependencies
+
+ none
+
+ Known Bugs
+
+ Samples from the longer of the two frames are discarded.
+
+
+ region
+
+ Description
+
+ Apply zero or more filters to B frame as it is composited onto
+ a region of the A frame. The "shape" of the region can be defined
+ by the alpha channel of a third producer.
+
+ Constructor Argument
+
+ resource - a shape producer
+
+ Initialisation Properties
+
+ string resource - nothing is rectangle, "circle" is a pixbuf-
+ generated SVG circle, anything else is loaded by the factory.
+ string factory - the service that creates the shape producer.
+ - the default is fezzik.
+ string filter[N] - one or more filters to apply. All filter
+ properties are passed using the same filter "key"
+ Any property starting with "composite." is passed to the
+ encapsulated composite transition.
+
+ Read Only Properties
+
+ none
+
+ Dependencies
+
+ transition_composite
+
+ Known Bugs
+
+ none
+
+
+Consumers
+---------
+
+ bluefish (Proprietary)
+
+ Description
+
+ BlueFish444 audio and video output module.
+
+ Constructor Argument
+
+ card - a numeric card id starting at 1, default is 1.
+
+ Initialisation Properties
+
+ string standard - "PAL" (default) or "NTSC"
+ - default is based upon MLT_NORMALISATION
+ environment variable, which defaults to PAL.
+ int frames - the number of DMA video frames. default is 4.
+ minimum is 2. maximum on my system is 11.
+ int buffer - the number of frames to buffer within MLT, minimum 1,
+ default 25.
+ string rescale - a rescale method, see the Filters/rescale.
+
+ Read Only Properties
+
+ none
+
+ Dependencies
+
+ BlueVelvet SDK installed parallel to mlt in "bluefish."
+
+ Known Bugs
+
+ Does not work with any service that uses pipes!
+
+ If mlt crashes, you might need to reload the BlueDriver kernel
+ module due to unreleased DMA buffers.
+
+ Only supports 2 channel audio at the moment.
+
+ libdv
+
+ Description
+
+ libdv dv producer.
+
+ Constructor Argument
+
+ string target - the filename to write to, e.g. /dev/dv1394.
+
+ Initialisation Properties
+
+ int buffer - the number of frames to buffer, minimum 1, default 25.
+ string rescale - a rescale method, see the Filters/rescale.
+
+ Mutable Properties
+
+ int progressive - indicates whether to use progressive or field-
+ based rendering, default 0 (off).
+
+ Read Only Properties
+
+ none
+
+ Dependencies
+
+ libdv
+
+ Known Bugs
+
+ none
+
+ sdl
+
+ Description
+
+ Simple DirectMedia Layer audio and video output module.
+
+ Constructor Argument
+
+ string video_standard - "PAL" (default), "NTSC", or "WxH"
+
+ Initialisation Properties
+
+ int buffer - the number of frames to buffer, minimum 1, default 25.
+ string rescale - a rescale method, see the Filters/rescale.
+ - Hint: "none" works very good with SDL output.
+
+ Mutable Properties
+
+ 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 progressive - indicates whether to use progressive or field-
+ based rendering, default 0 (off).
+
+ Read Only Properties
+
+ none
+
+ Dependencies
+
+ libSDL-1.2, libasound, libaudio, libXt, libX11, libXext, libSM, libICE
+
+ Known Bugs
+
+ none
+
+ westley
+
+ Description
+
+ Serialise the service network to XML.
+ See docs/westley.txt for more information.
+
+ Constructor Argument
+
+ resource - the name of a file in which to store the XML.
+ - stdout is default.
+
+ Initialisation Properties
+
+ string resource - same as above.
+
+ Dependencies
+
+ libxml2
+
+ Known Bugs