791c5aaba8b6a56392fa366eb62c4e801d19307d
[melted] / docs / services.txt
1 Producers
2 ---------
3
4         ffmpeg
5
6                 Description
7
8                         Test case pipe based producer for video and audio.
9
10                 Constructor Argument
11
12                         'file'  - produce a/v from file
13                         v4l             - produce a/v from video4linux and dsp device
14
15                 Initialisation Properties
16
17                         string video_type - "file" or "v4l"
18                         string video_file - file or v4l device
19                         string video_size - WxH of video to produce (default: "")
20                         int video_loop - loop video until audio exhausted (default: 0)
21                         string audio_type - "file" or "dsp"
22                         string audio_file - file or dsp device
23                         int audio_rate - audio frequency (default: 48000)
24                         int audio_channels - audio channels (default: 2)
25                         int audio_track - audio track to use (default: 0)
26                         int audio_loop - loop audio until video exhausted (default: 0)
27                         timecode in - in point
28                         timecode out - out point
29                         double fps - output frames per second (default: 25)
30                         double aspect_ratio - aspect ratio of video
31
32                 Read Only Properties
33
34                         string resource - file or "v4l"
35                         int end_of_clip - holds 1 when input is exhausted
36
37                 Dependencies
38
39                         ffmpeg executable.
40
41                 Known Bugs
42
43                         in point setting is broken.
44
45                         Implementation does not allow fast random access.
46
47         libdv
48
49                 Description
50
51                         libdv based decoder for video and audio.
52
53                 Constructor Argument
54
55                         'file'  - produce a/v from file
56
57                 Initialisation Properties
58
59                         timecode in - in point
60                         timecode out - out point
61
62                 Read Only Properties
63
64                         string resource - file location
65                         double fps - output frames per second 
66                         double aspect_ratio - aspect ratio of video]
67                         timecode length - duration of resource (in seconds)
68
69                 Dependencies
70
71                         libdv.
72
73                 Known Bugs
74
75                         None.
76
77         mcdv
78
79                 Description
80
81                         Mainconcept based dv decoder for video and audio.
82
83                 Constructor Argument
84
85                         'file'  - produce a/v from file
86
87                 Initialisation Properties
88
89                         timecode in - in point
90                         timecode out - out point
91
92                 Read Only Properties
93
94                         string resource - file location
95                         double fps - output frames per second 
96                         double aspect_ratio - aspect ratio of video
97                         timecode length - duration of resource (in seconds)
98
99                 Dependencies
100
101                         mainconcept dv sdk and libdv.
102
103                 Known Bugs
104
105                         Can be problematic with source NTSC DV files? really? yes - try
106                         playing pond.dv...
107
108         mcmpeg
109
110                 Description
111
112                         Mainconcept based mpeg decoder for video and audio.
113
114                 Constructor Argument
115
116                         'file'  - produce a/v from file
117
118                 Initialisation Properties
119
120                         timecode in - in point
121                         timecode out - out point
122
123                 Read Only Properties
124
125                         string resource - file location
126                         double fps - output frames per second 
127                         double aspect_ratio - aspect ratio of video
128
129                 Dependencies
130
131                         mainconcept mpeg sdk.
132
133                 Known Bugs
134
135                         None.
136
137         pango
138         
139                 Description
140
141                         A title generator that uses the Pango international text layout
142                         and Freetype2 font renderer.
143
144                 Constructor Argument
145
146                         'markup' - a string containing Pango markup see:
147                                    http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
148                                    - requires xml-like encoding special chars: <, > ( and '&' and '"' ?)
149
150                 Initialisation Properties
151
152                         timecode in - in point
153                         timecode out - out point
154                         int video_standard - enum mlt_video_standard from mlt_frame.h
155                                              PAL = 0, NTSC = 1
156                                              this determines proper pixel aspect ratio
157
158                         int fgcolor - an rgba color specification of the text (i.e. 0xrrggbbaa)
159                         int bgcolor - an rgba color of the background rectangle
160                         int align - paragraph alignment: 0 = left, 1 = center, 2 = right
161                         int pad - the number of pixels to pad the background rectangle beyond edges of text
162                                   default 0
163                         string markup - see constructor argument
164                         string text - non-markup text (can contain markup chars un-encoded)
165                         string font - the default typeface to use when not using markup
166                                       default "Sans 48"
167                         int x - the horizontal position of the title on the frame
168                                 default 0
169                         int y - the vertical position of the title on the frame
170                                 default 0
171                         double mix - the overall opacity control of the generated title
172                                      default 1.0
173
174                 Read Only Properties
175
176                         string resource - "pango"
177
178                 Dependencies
179
180                         libpango-1.0, libpangoft2-1.0, libfreetype, libgdk_pixbuf-2.0, libglib-2.0,
181                         libgobject-2.0, libgmodule-2.0, libfontconfig
182
183                 Known Bugs
184
185                         no frame-alignment functionality
186
187         pixbuf
188
189                 Description
190
191                         A graphics overlay generator using gdk-pixbuf
192
193                 Constructor Argument
194
195                         'file' - The name of a graphics file loadable by
196                                  a gdk-pixbuf loader. see /usr/lib/gdk-pixbuf/loaders
197                                  definitely png, jpeg, tiff, pnm, and xpm
198                                - If "%" in filename, the filename is used with sprintf
199                                  generate a filename from a counter for multi-file/flipbook animation.
200                                  The file sequence ends when numeric discontinuity >100.
201                                - If filename contains "/.all.", suffix with an extension to load
202                                  all pictures with matching extension from a directory
203
204                 Initialisation Properties
205
206                         timecode in - in point
207                         timecode out - out point
208                         int video_standard - enum mlt_video_standard from mlt_frame.h
209                                              PAL = 0, NTSC = 1
210                                              this determines proper pixel aspect ratio
211                         double ttl - how long (seconds) to repeat each picture in file sequences
212
213                 Read Only Properties
214
215                         string resource - file location
216
217                 Dependencies
218
219                         libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0
220
221                 Known Bugs
222
223                         none
224
225         ppm
226                 Description
227                 Constructor Argument
228                 Initialisation Properties
229                 Read Only Properties
230                 Dependencies
231                 Known Bugs
232
233
234 Filters
235 -------
236
237         deinterlace
238         
239                 Description
240                 Constructor Argument
241                 Initialisation Properties
242                 Read Only Properties
243                 Dependencies
244                 Known Bugs
245                 
246         ffmpeg_dub
247         
248                 Description
249                 Constructor Argument
250                 Initialisation Properties
251                 Read Only Properties
252                 Dependencies
253                 Known Bugs
254
255         gamma
256         
257                 Description
258                 Constructor Argument
259                 Initialisation Properties
260                 Read Only Properties
261                 Dependencies
262                 Known Bugs
263         
264         greyscale
265         
266                 Description
267                 Constructor Argument
268                 Initialisation Properties
269                 Read Only Properties
270                 Dependencies
271                 Known Bugs
272                 
273         resize
274         
275                 Description
276                 Constructor Argument
277                 Initialisation Properties
278                 Read Only Properties
279                 Dependencies
280                 Known Bugs
281
282 Transitions
283 -----------
284
285         composite
286         
287                 Description
288                 Constructor Argument
289                 Initialisation Properties
290                 Read Only Properties
291                 Dependencies
292                 Known Bugs
293
294         luma
295         
296                 Description
297                 Constructor Argument
298                 Initialisation Properties
299                 Read Only Properties
300                 Dependencies
301                 Known Bugs
302
303 Consumers
304 ---------
305
306         bluefish
307         
308                 Description
309                 Constructor Argument
310                 Initialisation Properties
311                 Read Only Properties
312                 Dependencies
313                 Known Bugs
314                 
315         ffmpeg
316         
317                 Description
318                 Constructor Argument
319                 Initialisation Properties
320                 Read Only Properties
321                 Dependencies
322                 Known Bugs
323
324         sdl
325                 Description
326                 Constructor Argument
327                 Initialisation Properties
328                 Read Only Properties
329                 Dependencies
330                 Known Bugs