X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Fservices.txt;h=a92de21600f6fa9f4c601597874855ad58803bc5;hb=4a39b72c5ac8fd2dd6db81a95eab08adde0491b9;hp=430060db08adf28d2026f493b770f4c48d56bdb5;hpb=0644e02b17da20acc90a42c1da6ceb56b3300de0;p=melted diff --git a/docs/services.txt b/docs/services.txt index 430060d..a92de21 100644 --- a/docs/services.txt +++ b/docs/services.txt @@ -2,7 +2,7 @@ Service Documentation Copyright (C) 2004 Ushodaya Enterprises Limited Authors: Charles Yates - Dan Dennedy + Dan Dennedy Last Revision: 2004-03-20 @@ -95,7 +95,7 @@ Producers Details - This producer is has two roles: + This producer has two roles: 1. it handles the mappings of all file names to the other producers; @@ -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 @@ -636,36 +593,6 @@ Filters Not a bug, but it only provides fair quality. - ffmpeg_dub - - Description - - Use ffmpeg executable to substitute audio stream. - - Constructor Argument - - file - filename of a WAV, Ogg Vorbis (--enable-vorbis), - MP3 (--enable-mp3lame), or AC-3 (--enable-a52) audio file. - - Initialisation Properties - - int in - in point - int out - out point - - Read Only Properties - - string resource - file - - Dependencies - - ffmpeg plus for ffmpeg: - libogg and libvorbis for Ogg Vorbis, libmp3lame for MP3, liba52 for AC-3. - - Known Bugs - - Uses pipes and is therefore not compatible with bluefish. - - gamma Description @@ -721,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 @@ -760,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 @@ -828,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 @@ -894,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 @@ -912,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 @@ -924,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 @@ -973,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 @@ -1357,6 +1357,41 @@ Consumers none + mcmpeg + + Description + + Mainconcept MPEG encoder. + + Constructor Argument + + string target - the filename to write to. + + Initialisation Properties + + int buffer - the number of frames to buffer, minimum 1, default 25. + string rescale - a rescale method, see the Filters/rescale. + string format - vcd [default], svcd or dvd provide base settings + int motion_search_type - 0 to 16 - reduces quality/cpu usage + int gop - group of picture size (default: format dependent) + + Mutable Properties + + int progressive - indicates whether to use progressive or field- + based rendering, default 0 (off). + + Read Only Properties + + none + + Dependencies + + Mainconcept MPEG SDK + + Known Bugs + + none + sdl Description @@ -1382,6 +1417,7 @@ Consumers ratio to square pixels. int progressive - indicates whether to use progressive or field- based rendering, default 0 (off). + int audio_buffer - size of the sdl audio buffer (default: 1024) Read Only Properties