X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Fservices.txt;h=37b3b9efc34245f591f135c09ad6b65311e11d9a;hb=acebb83a8ead55799505891f9a95be4eead9eb49;hp=0477176507a5b7ac69f7e333b92a4c5774f5f90a;hpb=8691b6464c35a77ae001b9843891a90dd9fd3d50;p=melted diff --git a/docs/services.txt b/docs/services.txt index 0477176..37b3b9e 100644 --- a/docs/services.txt +++ b/docs/services.txt @@ -1,6 +1,51 @@ Producers --------- + avformat + + Description + + ffmpeg libavformat based producer for video and audio. + + Constructor Argument + + 'file' - producer a/v from file + + Initialisation Properties + + int video_index - index of video stream to use (-1 is off) + int audio_index - index of audio stream to use (-1 is off) + int in - in point + int out - out point + + Read Only Properties + + double fps - this is fixed at 25 for PAL currently + double aspect_ratio - this is determined on the first frame read + + Dependencies + + ffmpeg must be configured as --enable-shared and installed prior + to compilation of mlt. + + Oddities + + There seems to be a discrepancy between audio and video pts (time + stamps) which causes audio seeking to be unreliable in some cases. + If audio playback is broken, try adding discrepancy=3 as a + property. + + Not sure of the exact reasons, but am investigating. + + Known Bugs + + Fixed frame rate. + Audio sync discrepancy with some content. + Not all libavformat supported formats are seekable. + ogg is currently broken. + mpeg seeking is inaccurate - doesn't seek to i-frames so you may + get junk for a few frames. + ffmpeg Description @@ -24,7 +69,7 @@ Producers 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) - intint in - in point + int in - in point int out - out point double fps - output frames per second (default: 25) double aspect_ratio - aspect ratio of video @@ -44,6 +89,36 @@ Producers Implementation does not allow fast random access. + fezzik + + Description + + A freindly giant that likes to throw rocks + + Constructor Argument + + 'file' - produce a/v from file + + Initialisation Properties + + int in - in point + int out - out point + + Read Only Properties + + string resource - file location + double fps - output frames per second + double aspect_ratio - aspect ratio of video] + int length - duration of resource (in frames) + + Dependencies + + all. + + Known Bugs + + None. + libdv Description @@ -233,7 +308,7 @@ Producers Dependencies - libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0 + libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0 Known Bugs @@ -266,6 +341,56 @@ Producers Since it uses pipes, it is not compatible with bluefish. + westley + + Description + + Construct a service network from an XML description. + + Constructor Argument + + file - an XML text file containing westley XML (schema pending) + + Read Only Properties + + string resource - file location + + Dependencies + + libxml2 + + Known Bugs + + Non-referenced producers and playlists are not destroyed. + A referenced producer or playlist must appear before the reference. + + vorbis + + Description + + OGG Vorbis file reader. + + Constructor Argument + + 'file' - file to use (only .ogg supported at the moment) + + Initialisation Properties + + int in - in point + int out - out point + + Read Only Properties + + double fps - this is fixed at 25 for PAL currently + + Dependencies + + libvorbisfile + + Known Bugs + + Fixed frame size (PAL audio chunks). + Doesn't cover ogg files with multiple, differing sections. Filters ------- @@ -381,6 +506,35 @@ Filters none + obscure + + Description + + Obscuring filter. + + Constructor Argument + + none + + Initialisation Properties + + string start - in the format X,Y:WxH[:PWxPY] + string end - in the format X,Y:WxH[:PWxPY] + int in - in point + int out - out point + + Read Only Properties + + none + + Dependencies + + none + + Known Bugs + + none + resize Description @@ -417,16 +571,35 @@ Filters Constructor Argument - volume - a floating point value of the factor + gain - a string containing one of: + - a floating point value of the gain adjustment + - a numeric value with the suffix "dB" to adjust in terms of decibels + - "normalise" to normalise the volume to the target amplitude -12dBFS Initialisation Properties int in - in point int out - out point + int window - the number of video frames over which to smooth normalisation. + defaults to 75. Mutable Properties - double volume - the factor applied to each sample + string gain - same as constructor argument above + + string normalise - normalise the volume to the amplitude: + - a numeric value with the suffix "dB" to set amplitude in decibels + - a floating point value of the relative volume + - an unspecified value uses the default -12dBFS + + string limiter - limit all samples above: + - a numeric value with the suffix "dB" + - a floating point value ( dB = 20 * log10(x) ) + - an unspecified value uses the default -6dBFS + + double max_gain - a floating point or decibel value of the maximum gain that + can be applied during normalisation. + - an unspecified value uses the default 20dB Dependencies @@ -463,6 +636,37 @@ Filters none + rescale + + Description + + Scale the producer video frame size to match the consumer. + + Constructor Argument + + interpolation - the rescaling method, one of: + nearest (lowest quality, fastest), + tiles, + bilinear (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 + + Dependencies + + libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0 + + Known Bugs + + none + Transitions ----------- @@ -474,21 +678,14 @@ Transitions Constructor Argument - mix - see below + string start - X,Y:WxH[:mix] Initialisation Properties + string end - X,Y:WxH[:mix] int in - in point int out - out point - - Mutable Properties - - int x - the horizontal offset from the left edge of the frame - int y - the vertical offset from the top edge of the frame - double mix - the opacity factor to apply to the second frame - (used in addition to alpha channel). - - any negative value causes an automatic dissolve - + Read Only Properties none @@ -514,7 +711,7 @@ Transitions Constructor Argument - string file - the luma map file name. If not supplied, a dissolve. + string resource - the luma map file name. If not supplied, a dissolve. Initialisation Properties @@ -523,7 +720,7 @@ Transitions Mutable Properties - string filename - same as above + 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. @@ -539,6 +736,7 @@ Transitions Known Bugs The luma map must be the same size as the B frame. + The PGM parser does not handle comments. mix @@ -615,7 +813,23 @@ Consumers Dependencies Known Bugs + libdv + + Description + + libdv dv producer. + + Constructor Argument + + string video_standard - "PAL" (default) or "NTSC" + + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs + sdl + Description Simple DirectMedia Layer audio and video output module. @@ -645,3 +859,28 @@ Consumers NTSC handling needs tightening up - sdl:NTSC is the only valid constructor for NTSC playback at the moment. + westley + + Description + + Serialise the service network to XML. + + Constructor Argument + + resource - the name of a file in which to store the XML. + stdout is used if not supplied. + + Initialisation Properties + + string resource - same as above. + + Dependencies + + libxml2 + + Known Bugs + + Untested arbitrary nesting of multitracks and playlists. + Property "id" is generated as service type followed by number if + no property named "id" exists, but it fails to guarantee uniqueness. +