X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Fservices.txt;h=068a79ad39fe4fb9dffa716ed389d137cfe1e33b;hb=1d3ab5568258841b1741b8c2fc88ce4e958e6fc6;hp=10d25a03ba63cdeafe2498f707c7252152e4d597;hpb=b49b8059af440b18c427842272f57808fc465c4f;p=melted diff --git a/docs/services.txt b/docs/services.txt index 10d25a0..068a79a 100644 --- a/docs/services.txt +++ b/docs/services.txt @@ -16,9 +16,10 @@ Producers Constructor Argument 'file' - a filename specification or URL in the form: - [{protocol}|{format}]:{resource}[?{format-parameter}[&{format-parameter}]] - For example, video4linux:/dev/video1?width=320&height=240 - Note: on the bash command line, '&' must be escaped as '\&' + [{protocol}|{format}]:{resource}[?{format-parameter}[&{format-parameter}...]] + For example, video4linux:/dev/video1?width:320&height:240 + Note: on the bash command line, & must be escaped as '\&'. + Also, note the use of ':' instead of '=' for parameters. Use 'ffmpeg -formats' to see a list of supported protocols and formats. @@ -57,6 +58,8 @@ Producers MPEG seeking is inaccurate - doesn't seek to i-frames so you may get junk for a few frames. RAW DV seeking not supported. + Fails to play beyond first frame of video of sources with PTS not + starting at 0 (video4linux). fezzik @@ -295,8 +298,6 @@ Producers pango producer interprets the filename as pango text. This is a shortcut to embed titles in inigo commands. For westley, it is recommended that you embed the title text in the property value. - If you need to embed Pango markup in a westley XML file, then - enclose the value inside "". Pango has builtin scaling. It will rescale the originally rendered title to whatever the consumer requests. Therefore, it will lose @@ -310,7 +311,7 @@ Producers Mutable Properties - string markup - a UTF-8 string containing Pango markup see: + string markup - a string containing Pango markup see: http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html - requires xml-like encoding special chars from: <, >, & -to- <, >, & @@ -326,6 +327,8 @@ Producers markup chars un-encoded) string font - the default typeface to use when not using markup. 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. Read Only Properties @@ -365,9 +368,7 @@ Producers load all pictures with matching extension from a directory. - If filename contains the string ""). + for inigo commands. Details @@ -438,8 +439,18 @@ Producers Constructor Argument - file - an XML text file containing westley XML (schema pending) - + URL - an XML text file containing westley XML (schema/DTD pending) + - Since westley files can be parameterised, the URL syntax is: + {file-name}[?{param-name}{'='|':'}{param-value}[&{param-name}{'='|':'}{param-value}...]] + A colon is allowed instead of an equal sign to pacify inigo, + who tokenises anything with an equal sign as a property + setting. Also, when running inigo from the shell, beware of + the '?' and shell filename expansion. You can surround the URL + with single quotations to prevent expansion. Finally, fezzik + will fail to match the filename when you use parameters, so + preface the url with 'westley:' to force fezzik to load with + the westley service. + Read Only Properties string resource - file location @@ -518,6 +529,31 @@ Filters Known Bugs Does not go completely to black or white. + + + channelcopy + + Description + + Copy audio from one channel to another channel. + + Constructor Argument + + to - the 0-indexed channel to copy into, default is 1. + + Mutable Properties + + int to - see above + int from - the channel from which to copy, default is 0. + + Dependencies + + none + + Known Bugs + + none + deinterlace @@ -687,6 +723,39 @@ Filters none + mirror + + Description + + Provides various mirror and image reversing effects. + + Constructor Argument + + mirror - horizontal, vertical, diagonal, flip, flop + + Initialisation Properties + + int reverse - being 0 or 1 + int in - in point + int out - out point + + Read Only Properties + + none + + Mutable Properties + + none + + Dependencies + + none + + Known Bugs + + none + + obscure Description @@ -754,7 +823,9 @@ Filters Description - Adjust an audio stream's sampling rate. + Adjust an audio stream's sampling rate, and duplicate channels if + producer provides less than consumer requested. + This filter is automatically invoked by Fezzik for the sake of normalisation over inputs and with the consumer. @@ -777,7 +848,8 @@ Filters Known Bugs - none + Assumes 2 channels during libsamplerate initialisation. Untested + with >2 channels. rescale @@ -1057,6 +1129,7 @@ Transitions 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. + int reverse - reverse the direction of the transition. Any property starting with "producer." is passed to the non-PGM luma producer. @@ -1155,11 +1228,18 @@ Consumers Constructor Argument - string video_standard - "PAL" (default) or "NTSC" + card - a numeric card id starting at 1, default is 1. Initialisation Properties - int video_standard - 0 = PAL, 1 = NTSC + 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 8. + 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 @@ -1173,10 +1253,10 @@ Consumers Does not work with any service that uses pipes! - If mlt crashes, you must reload the BlueDriver kernel module - due to unreleased DMA buffers. + If mlt crashes, you might need to reload the BlueDriver kernel + module due to unreleased DMA buffers. - Needs an argument or property for multi-card address. + Only supports 2 channel audio at the moment. libdv