X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Fservices.txt;h=16c42cc58fba45381f5df7640a2beca8fc6b7885;hb=6336039a203c6496691784682f9ad56eb13abcc3;hp=8118894f98d71e932cd17f98ca892d09e772857f;hpb=9390e8b584f3f717f0a326893c0e37cf187a0a51;p=melted diff --git a/docs/services.txt b/docs/services.txt index 8118894..16c42cc 100644 --- a/docs/services.txt +++ b/docs/services.txt @@ -3,11 +3,11 @@ Producers ffmpeg - Description: + Description Test case pipe based producer for video and audio. - Constructor argument: + Constructor Argument 'file' - produce a/v from file v4l - produce a/v from video4linux and dsp device @@ -46,11 +46,11 @@ Producers libdv - Description: + Description libdv based decoder for video and audio. - Constructor argument: + Constructor Argument 'file' - produce a/v from file @@ -63,7 +63,8 @@ Producers string resource - file location double fps - output frames per second - double aspect_ratio - aspect ratio of video + double aspect_ratio - aspect ratio of video] + timecode length - duration of resource (in seconds) Dependencies @@ -75,11 +76,11 @@ Producers mcdv - Description: + Description Mainconcept based dv decoder for video and audio. - Constructor argument: + Constructor Argument 'file' - produce a/v from file @@ -93,22 +94,25 @@ Producers string resource - file location double fps - output frames per second double aspect_ratio - aspect ratio of video + timecode length - duration of resource (in seconds) Dependencies mainconcept dv sdk and libdv. + "dv_sdk" installed parallel to mlt. Known Bugs - Can be problematic with source NTSC DV files? + Can be problematic with source NTSC DV files? really? yes - try + playing pond.dv... mcmpeg - Description: + Description Mainconcept based mpeg decoder for video and audio. - Constructor argument: + Constructor Argument 'file' - produce a/v from file @@ -126,34 +130,305 @@ Producers Dependencies mainconcept mpeg sdk. + "mpeg_sdk_demo" installed parallel to mlt. Known Bugs None. pango + + Description + + A title generator that uses the Pango international text layout + and Freetype2 font renderer. + + Constructor Argument + + string file - a text file containing Pango markup, see: + http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html + - requires xml-like encoding special chars: <, >, & to <, >, & + + Initialisation Properties + + timecode in - in point + timecode out - out point + + Mutable Properties + + int video_standard - enum mlt_video_standard from mlt_frame.h + PAL = 0, NTSC = 1 + this determines proper pixel aspect ratio + + 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: <, >, & to <, >, & + + int fgcolor - an rgba color specification of the text (i.e. 0xrrggbbaa) + int bgcolor - an rgba color of the background rectangle + int align - paragraph alignment: 0 = left, 1 = center, 2 = right + int pad - the number of pixels to pad the background rectangle beyond edges of text + default 0 + string markup - see constructor argument + string text - non-markup text (can contain markup chars un-encoded) + string font - the default typeface to use when not using markup + default "Sans 48" + int x - the horizontal position of the title on the frame + default 0 + int y - the vertical position of the title on the frame + default 0 + double mix - the overall opacity control of the generated title + default 1.0 + + Read Only Properties + + string resource - the text/markup file or "pango" if no file + + Dependencies + + libpango-1.0, libpangoft2-1.0, libfreetype, libgdk_pixbuf-2.0, libglib-2.0, + libgobject-2.0, libgmodule-2.0, libfontconfig + + Known Bugs + + no frame-alignment functionality + pixbuf + + Description + + A graphics overlay generator using gdk-pixbuf + + Constructor Argument + + 'file' - The name of a graphics file loadable by + a gdk-pixbuf loader. see /usr/lib/gdk-pixbuf/loaders + definitely png, jpeg, tiff, pnm, and xpm + - If "%" in filename, the filename is used with sprintf + generate a filename from a counter for multi-file/flipbook animation. + The file sequence ends when numeric discontinuity >100. + - If filename contains "/.all.", suffix with an extension to load + all pictures with matching extension from a directory + + Initialisation Properties + + timecode in - in point + timecode out - out point + + Mutable Properties + + int video_standard - enum mlt_video_standard from mlt_frame.h + PAL = 0, NTSC = 1 + this determines proper pixel aspect ratio + double ttl - how long (seconds) to repeat each picture in file sequences + 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). + + + Read Only Properties + + string resource - file location + + Dependencies + + libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0 + + Known Bugs + + in/out settings are incorrectly handled. + ppm + Description + Constructor Argument + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs Filters ------- deinterlace + + Description + Constructor Argument + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs + ffmpeg_dub + + Description + Constructor Argument + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs + gamma + + Description + Constructor Argument + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs + greyscale + + Description + Constructor Argument + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs + resize + + Description + Constructor Argument + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs Transitions ----------- composite + + Description + + An alpha-channel based compositor for two frames. + + Constructor Argument + + none + + 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). + + Read Only Properties + + none + + Dependencies + + none + + Known Bugs + + Need to add field-based rendering. + + luma + + Description + + A generic dissolve and wipe transition processor. It 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 only reads PGM + files, but it does handle 16 bit PGM. This performs field-based + rendering. + + Constructor Argument + + string file - the luma map file name. If not supplied, a dissolve. + + Mutable Properties + + string filename - 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. + + Read Only Properties + + none + + Dependencies + + none + + Known Bugs + + The luma map must be the same size as the B frame. Consumers --------- bluefish + + Description + + BlueFish444 audio and video output module. + + Constructor Argument + + string video_standard - "PAL" (default) or "NTSC" + + Initialisation Properties + + int video_standard - 0 = PAL, 1 = NTSC + + Read Only Properties + + none + + Dependencies + + BlueVelvet SDK installed parallel to mlt in "bluefish." + + Known Bugs + + If mlt crashes, you must reload the BlueDriver kernel module + due to unreleased DMA buffers. + Needs an argument or property for multi-card address. + ffmpeg + + Description + Constructor Argument + Initialisation Properties + Read Only Properties + Dependencies + Known Bugs + sdl + Description + + Simple DirectMedia Layer audio and video output module. + + Constructor Argument + + string video_standard - "PAL" (default), "NTSC", or "WxH" + + 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. + + Read Only Properties + + none + + Dependencies + + libSDL-1.2, libasound, libaudio, libXt, libX11, libXext, libSM, libICE + + Known Bugs + + NTSC handling needs tightening up - sdl:NTSC is the only valid + constructor for NTSC playback at the moment.