releasing 0.9.7
[platform/upstream/gstreamer.git] / docs / plugins / gst-plugins-ugly-plugins.args
1 <ARG>
2 <NAME>GstLame::allow-diff-short</NAME>
3 <TYPE>gboolean</TYPE>
4 <RANGE></RANGE>
5 <FLAGS>rw</FLAGS>
6 <NICK>Allow diff short</NICK>
7 <BLURB>Allow diff short.</BLURB>
8 <DEFAULT>TRUE</DEFAULT>
9 </ARG>
10
11 <ARG>
12 <NAME>GstLame::ath-lower</NAME>
13 <TYPE>gint</TYPE>
14 <RANGE></RANGE>
15 <FLAGS>rw</FLAGS>
16 <NICK>ATH lower</NICK>
17 <BLURB>lowers ATH by x dB.</BLURB>
18 <DEFAULT>0</DEFAULT>
19 </ARG>
20
21 <ARG>
22 <NAME>GstLame::ath-only</NAME>
23 <TYPE>gboolean</TYPE>
24 <RANGE></RANGE>
25 <FLAGS>rw</FLAGS>
26 <NICK>ATH only</NICK>
27 <BLURB>Ignore GPSYCHO completely, use ATH only.</BLURB>
28 <DEFAULT>TRUE</DEFAULT>
29 </ARG>
30
31 <ARG>
32 <NAME>GstLame::ath-short</NAME>
33 <TYPE>gboolean</TYPE>
34 <RANGE></RANGE>
35 <FLAGS>rw</FLAGS>
36 <NICK>ATH short</NICK>
37 <BLURB>Ignore GPSYCHO for short blocks, use ATH only.</BLURB>
38 <DEFAULT>TRUE</DEFAULT>
39 </ARG>
40
41 <ARG>
42 <NAME>GstLame::bitrate</NAME>
43 <TYPE>gint</TYPE>
44 <RANGE>[8,320]</RANGE>
45 <FLAGS>rw</FLAGS>
46 <NICK>Bitrate (kb/s)</NICK>
47 <BLURB>Bitrate in kbit/sec.</BLURB>
48 <DEFAULT>128</DEFAULT>
49 </ARG>
50
51 <ARG>
52 <NAME>GstLame::compression-ratio</NAME>
53 <TYPE>gfloat</TYPE>
54 <RANGE>[0,200]</RANGE>
55 <FLAGS>rw</FLAGS>
56 <NICK>Compression Ratio</NICK>
57 <BLURB>let lame choose bitrate to achieve selected compression ratio.</BLURB>
58 <DEFAULT>0</DEFAULT>
59 </ARG>
60
61 <ARG>
62 <NAME>GstLame::copyright</NAME>
63 <TYPE>gboolean</TYPE>
64 <RANGE></RANGE>
65 <FLAGS>rw</FLAGS>
66 <NICK>Copyright</NICK>
67 <BLURB>Mark as copyright.</BLURB>
68 <DEFAULT>TRUE</DEFAULT>
69 </ARG>
70
71 <ARG>
72 <NAME>GstLame::cwlimit</NAME>
73 <TYPE>gint</TYPE>
74 <RANGE>[0,50000]</RANGE>
75 <FLAGS>rw</FLAGS>
76 <NICK>Cwlimit</NICK>
77 <BLURB>Compute tonality up to freq (in kHz) default 8.8717.</BLURB>
78 <DEFAULT>0</DEFAULT>
79 </ARG>
80
81 <ARG>
82 <NAME>GstLame::disable-reservoir</NAME>
83 <TYPE>gboolean</TYPE>
84 <RANGE></RANGE>
85 <FLAGS>rw</FLAGS>
86 <NICK>Disable reservoir</NICK>
87 <BLURB>Disable the bit reservoir.</BLURB>
88 <DEFAULT>TRUE</DEFAULT>
89 </ARG>
90
91 <ARG>
92 <NAME>GstLame::emphasis</NAME>
93 <TYPE>gboolean</TYPE>
94 <RANGE></RANGE>
95 <FLAGS>rw</FLAGS>
96 <NICK>Emphasis</NICK>
97 <BLURB>Emphasis.</BLURB>
98 <DEFAULT>TRUE</DEFAULT>
99 </ARG>
100
101 <ARG>
102 <NAME>GstLame::error-protection</NAME>
103 <TYPE>gboolean</TYPE>
104 <RANGE></RANGE>
105 <FLAGS>rw</FLAGS>
106 <NICK>Error protection</NICK>
107 <BLURB>Adds 16 bit checksum to every frame.</BLURB>
108 <DEFAULT>TRUE</DEFAULT>
109 </ARG>
110
111 <ARG>
112 <NAME>GstLame::extension</NAME>
113 <TYPE>gboolean</TYPE>
114 <RANGE></RANGE>
115 <FLAGS>rw</FLAGS>
116 <NICK>Extension</NICK>
117 <BLURB>Extension.</BLURB>
118 <DEFAULT>TRUE</DEFAULT>
119 </ARG>
120
121 <ARG>
122 <NAME>GstLame::force-ms</NAME>
123 <TYPE>gboolean</TYPE>
124 <RANGE></RANGE>
125 <FLAGS>rw</FLAGS>
126 <NICK>Force ms</NICK>
127 <BLURB>Force ms_stereo on all frames.</BLURB>
128 <DEFAULT>TRUE</DEFAULT>
129 </ARG>
130
131 <ARG>
132 <NAME>GstLame::free-format</NAME>
133 <TYPE>gboolean</TYPE>
134 <RANGE></RANGE>
135 <FLAGS>rw</FLAGS>
136 <NICK>Free format</NICK>
137 <BLURB>Produce a free format bitstream.</BLURB>
138 <DEFAULT>TRUE</DEFAULT>
139 </ARG>
140
141 <ARG>
142 <NAME>GstLame::highpass-freq</NAME>
143 <TYPE>gint</TYPE>
144 <RANGE>[0,50000]</RANGE>
145 <FLAGS>rw</FLAGS>
146 <NICK>Highpass freq</NICK>
147 <BLURB>frequency(kHz), highpass filter cutoff below freq.</BLURB>
148 <DEFAULT>0</DEFAULT>
149 </ARG>
150
151 <ARG>
152 <NAME>GstLame::highpass-width</NAME>
153 <TYPE>gint</TYPE>
154 <RANGE>>= 0</RANGE>
155 <FLAGS>rw</FLAGS>
156 <NICK>Highpass width</NICK>
157 <BLURB>frequency(kHz) - default 15% of highpass freq.</BLURB>
158 <DEFAULT>0</DEFAULT>
159 </ARG>
160
161 <ARG>
162 <NAME>GstLame::lowpass-freq</NAME>
163 <TYPE>gint</TYPE>
164 <RANGE>[0,50000]</RANGE>
165 <FLAGS>rw</FLAGS>
166 <NICK>Lowpass freq</NICK>
167 <BLURB>frequency(kHz), lowpass filter cutoff above freq.</BLURB>
168 <DEFAULT>0</DEFAULT>
169 </ARG>
170
171 <ARG>
172 <NAME>GstLame::lowpass-width</NAME>
173 <TYPE>gint</TYPE>
174 <RANGE>>= 0</RANGE>
175 <FLAGS>rw</FLAGS>
176 <NICK>Lowpass width</NICK>
177 <BLURB>frequency(kHz) - default 15% of lowpass freq.</BLURB>
178 <DEFAULT>0</DEFAULT>
179 </ARG>
180
181 <ARG>
182 <NAME>GstLame::mode</NAME>
183 <TYPE>GstLameMode</TYPE>
184 <RANGE></RANGE>
185 <FLAGS>rw</FLAGS>
186 <NICK>Mode</NICK>
187 <BLURB>Encoding mode.</BLURB>
188 <DEFAULT>Stereo</DEFAULT>
189 </ARG>
190
191 <ARG>
192 <NAME>GstLame::no-ath</NAME>
193 <TYPE>gboolean</TYPE>
194 <RANGE></RANGE>
195 <FLAGS>rw</FLAGS>
196 <NICK>No ath</NICK>
197 <BLURB>turns ATH down to a flat noise floor.</BLURB>
198 <DEFAULT>TRUE</DEFAULT>
199 </ARG>
200
201 <ARG>
202 <NAME>GstLame::no-short-blocks</NAME>
203 <TYPE>gboolean</TYPE>
204 <RANGE></RANGE>
205 <FLAGS>rw</FLAGS>
206 <NICK>No short blocks</NICK>
207 <BLURB>Do not use short blocks.</BLURB>
208 <DEFAULT>TRUE</DEFAULT>
209 </ARG>
210
211 <ARG>
212 <NAME>GstLame::original</NAME>
213 <TYPE>gboolean</TYPE>
214 <RANGE></RANGE>
215 <FLAGS>rw</FLAGS>
216 <NICK>Original</NICK>
217 <BLURB>Mark as non-original.</BLURB>
218 <DEFAULT>TRUE</DEFAULT>
219 </ARG>
220
221 <ARG>
222 <NAME>GstLame::padding-type</NAME>
223 <TYPE>GstLamePadding</TYPE>
224 <RANGE></RANGE>
225 <FLAGS>rw</FLAGS>
226 <NICK>Padding type</NICK>
227 <BLURB>Padding type.</BLURB>
228 <DEFAULT>No Padding</DEFAULT>
229 </ARG>
230
231 <ARG>
232 <NAME>GstLame::preset</NAME>
233 <TYPE>GstLamePreset</TYPE>
234 <RANGE></RANGE>
235 <FLAGS>rw</FLAGS>
236 <NICK>Lame Preset</NICK>
237 <BLURB>Lame Preset.</BLURB>
238 <DEFAULT>None</DEFAULT>
239 </ARG>
240
241 <ARG>
242 <NAME>GstLame::quality</NAME>
243 <TYPE>GstLameQuality</TYPE>
244 <RANGE></RANGE>
245 <FLAGS>rw</FLAGS>
246 <NICK>Quality</NICK>
247 <BLURB>Quality of algorithm used for encoding.</BLURB>
248 <DEFAULT>5 - Default</DEFAULT>
249 </ARG>
250
251 <ARG>
252 <NAME>GstLame::strict-iso</NAME>
253 <TYPE>gboolean</TYPE>
254 <RANGE></RANGE>
255 <FLAGS>rw</FLAGS>
256 <NICK>Strict ISO</NICK>
257 <BLURB>Comply as much as possible to ISO MPEG spec.</BLURB>
258 <DEFAULT>TRUE</DEFAULT>
259 </ARG>
260
261 <ARG>
262 <NAME>GstLame::vbr</NAME>
263 <TYPE>GstLameVbrmode</TYPE>
264 <RANGE></RANGE>
265 <FLAGS>rw</FLAGS>
266 <NICK>VBR</NICK>
267 <BLURB>Specify bitrate mode.</BLURB>
268 <DEFAULT>No VBR (Constant Bitrate)</DEFAULT>
269 </ARG>
270
271 <ARG>
272 <NAME>GstLame::vbr-hard-min</NAME>
273 <TYPE>gint</TYPE>
274 <RANGE>>= 0</RANGE>
275 <FLAGS>rw</FLAGS>
276 <NICK>VBR hard min</NICK>
277 <BLURB>Specify hard min bitrate.</BLURB>
278 <DEFAULT>0</DEFAULT>
279 </ARG>
280
281 <ARG>
282 <NAME>GstLame::vbr-max-bitrate</NAME>
283 <TYPE>gint</TYPE>
284 <RANGE>>= 0</RANGE>
285 <FLAGS>rw</FLAGS>
286 <NICK>VBR max bitrate</NICK>
287 <BLURB>Specify max bitrate.</BLURB>
288 <DEFAULT>0</DEFAULT>
289 </ARG>
290
291 <ARG>
292 <NAME>GstLame::vbr-mean-bitrate</NAME>
293 <TYPE>gint</TYPE>
294 <RANGE>>= 0</RANGE>
295 <FLAGS>rw</FLAGS>
296 <NICK>VBR mean bitrate</NICK>
297 <BLURB>Specify mean bitrate.</BLURB>
298 <DEFAULT>0</DEFAULT>
299 </ARG>
300
301 <ARG>
302 <NAME>GstLame::vbr-min-bitrate</NAME>
303 <TYPE>gint</TYPE>
304 <RANGE>>= 0</RANGE>
305 <FLAGS>rw</FLAGS>
306 <NICK>VBR min bitrate</NICK>
307 <BLURB>Specify min bitrate.</BLURB>
308 <DEFAULT>0</DEFAULT>
309 </ARG>
310
311 <ARG>
312 <NAME>GstLame::vbr-quality</NAME>
313 <TYPE>GstLameQuality</TYPE>
314 <RANGE></RANGE>
315 <FLAGS>rw</FLAGS>
316 <NICK>VBR Quality</NICK>
317 <BLURB>VBR Quality.</BLURB>
318 <DEFAULT>5 - Default</DEFAULT>
319 </ARG>
320
321 <ARG>
322 <NAME>GstLame::xingheader</NAME>
323 <TYPE>gboolean</TYPE>
324 <RANGE></RANGE>
325 <FLAGS>rw</FLAGS>
326 <NICK>Output Xing Header</NICK>
327 <BLURB>Output Xing Header.</BLURB>
328 <DEFAULT>FALSE</DEFAULT>
329 </ARG>
330
331 <ARG>
332 <NAME>GstMad::half</NAME>
333 <TYPE>gboolean</TYPE>
334 <RANGE></RANGE>
335 <FLAGS>rw</FLAGS>
336 <NICK>Half</NICK>
337 <BLURB>Generate PCM at 1/2 sample rate.</BLURB>
338 <DEFAULT>FALSE</DEFAULT>
339 </ARG>
340
341 <ARG>
342 <NAME>GstMad::ignore-crc</NAME>
343 <TYPE>gboolean</TYPE>
344 <RANGE></RANGE>
345 <FLAGS>rw</FLAGS>
346 <NICK>Ignore CRC</NICK>
347 <BLURB>Ignore CRC errors.</BLURB>
348 <DEFAULT>TRUE</DEFAULT>
349 </ARG>
350
351 <ARG>
352 <NAME>GstID3Demux::prefer-v1</NAME>
353 <TYPE>gboolean</TYPE>
354 <RANGE></RANGE>
355 <FLAGS>rwx</FLAGS>
356 <NICK>prefer version 1 tag</NICK>
357 <BLURB>Prefer tags from tag at end of file.</BLURB>
358 <DEFAULT>FALSE</DEFAULT>
359 </ARG>
360
361 <ARG>
362 <NAME>GstID3Mux::v1-tag</NAME>
363 <TYPE>gboolean</TYPE>
364 <RANGE></RANGE>
365 <FLAGS>rwx</FLAGS>
366 <NICK>add version 1 tag</NICK>
367 <BLURB>Add version 1 tag at end of file.</BLURB>
368 <DEFAULT>FALSE</DEFAULT>
369 </ARG>
370
371 <ARG>
372 <NAME>GstID3Mux::v2-tag</NAME>
373 <TYPE>gboolean</TYPE>
374 <RANGE></RANGE>
375 <FLAGS>rwx</FLAGS>
376 <NICK>add version 2 tag</NICK>
377 <BLURB>Add version 2 tag at start of file.</BLURB>
378 <DEFAULT>TRUE</DEFAULT>
379 </ARG>
380
381 <ARG>
382 <NAME>GstID3Tag::prefer-v1</NAME>
383 <TYPE>gboolean</TYPE>
384 <RANGE></RANGE>
385 <FLAGS>rwx</FLAGS>
386 <NICK>prefer version 1 tag</NICK>
387 <BLURB>Prefer tags from tag at end of file.</BLURB>
388 <DEFAULT>FALSE</DEFAULT>
389 </ARG>
390
391 <ARG>
392 <NAME>GstID3Tag::v1-tag</NAME>
393 <TYPE>gboolean</TYPE>
394 <RANGE></RANGE>
395 <FLAGS>rwx</FLAGS>
396 <NICK>add version 1 tag</NICK>
397 <BLURB>Add version 1 tag at end of file.</BLURB>
398 <DEFAULT>FALSE</DEFAULT>
399 </ARG>
400
401 <ARG>
402 <NAME>GstID3Tag::v2-tag</NAME>
403 <TYPE>gboolean</TYPE>
404 <RANGE></RANGE>
405 <FLAGS>rwx</FLAGS>
406 <NICK>add version 2 tag</NICK>
407 <BLURB>Add version 2 tag at start of file.</BLURB>
408 <DEFAULT>TRUE</DEFAULT>
409 </ARG>
410
411 <ARG>
412 <NAME>GstSidDec::blocksize</NAME>
413 <TYPE>gulong</TYPE>
414 <RANGE>>= 1</RANGE>
415 <FLAGS>rw</FLAGS>
416 <NICK>Block size</NICK>
417 <BLURB>Size in bytes to output per buffer.</BLURB>
418 <DEFAULT></DEFAULT>
419 </ARG>
420
421 <ARG>
422 <NAME>GstSidDec::clock</NAME>
423 <TYPE>GstSidClock</TYPE>
424 <RANGE></RANGE>
425 <FLAGS>rw</FLAGS>
426 <NICK>clock</NICK>
427 <BLURB>clock.</BLURB>
428 <DEFAULT>0</DEFAULT>
429 </ARG>
430
431 <ARG>
432 <NAME>GstSidDec::filter</NAME>
433 <TYPE>gboolean</TYPE>
434 <RANGE></RANGE>
435 <FLAGS>rw</FLAGS>
436 <NICK>filter</NICK>
437 <BLURB>filter.</BLURB>
438 <DEFAULT>TRUE</DEFAULT>
439 </ARG>
440
441 <ARG>
442 <NAME>GstSidDec::force-speed</NAME>
443 <TYPE>gboolean</TYPE>
444 <RANGE></RANGE>
445 <FLAGS>rw</FLAGS>
446 <NICK>force_speed</NICK>
447 <BLURB>force_speed.</BLURB>
448 <DEFAULT>TRUE</DEFAULT>
449 </ARG>
450
451 <ARG>
452 <NAME>GstSidDec::measured-volume</NAME>
453 <TYPE>gboolean</TYPE>
454 <RANGE></RANGE>
455 <FLAGS>rw</FLAGS>
456 <NICK>measured_volume</NICK>
457 <BLURB>measured_volume.</BLURB>
458 <DEFAULT>TRUE</DEFAULT>
459 </ARG>
460
461 <ARG>
462 <NAME>GstSidDec::memory</NAME>
463 <TYPE>GstSidMemory</TYPE>
464 <RANGE></RANGE>
465 <FLAGS>rw</FLAGS>
466 <NICK>memory</NICK>
467 <BLURB>memory.</BLURB>
468 <DEFAULT>34</DEFAULT>
469 </ARG>
470
471 <ARG>
472 <NAME>GstSidDec::metadata</NAME>
473 <TYPE>GstCaps</TYPE>
474 <RANGE></RANGE>
475 <FLAGS>r</FLAGS>
476 <NICK>Metadata</NICK>
477 <BLURB>Metadata.</BLURB>
478 <DEFAULT></DEFAULT>
479 </ARG>
480
481 <ARG>
482 <NAME>GstSidDec::mos8580</NAME>
483 <TYPE>gboolean</TYPE>
484 <RANGE></RANGE>
485 <FLAGS>rw</FLAGS>
486 <NICK>mos8580</NICK>
487 <BLURB>mos8580.</BLURB>
488 <DEFAULT>TRUE</DEFAULT>
489 </ARG>
490
491 <ARG>
492 <NAME>GstSidDec::tune</NAME>
493 <TYPE>gint</TYPE>
494 <RANGE>[1,100]</RANGE>
495 <FLAGS>rw</FLAGS>
496 <NICK>tune</NICK>
497 <BLURB>tune.</BLURB>
498 <DEFAULT>1</DEFAULT>
499 </ARG>
500
501 <ARG>
502 <NAME>GstMPEGAudioParse::bitrate</NAME>
503 <TYPE>gint</TYPE>
504 <RANGE></RANGE>
505 <FLAGS>r</FLAGS>
506 <NICK>Bitrate</NICK>
507 <BLURB>Bit Rate.</BLURB>
508 <DEFAULT>0</DEFAULT>
509 </ARG>
510
511 <ARG>
512 <NAME>GstMPEGAudioParse::skip</NAME>
513 <TYPE>gint</TYPE>
514 <RANGE></RANGE>
515 <FLAGS>rw</FLAGS>
516 <NICK>skip</NICK>
517 <BLURB>skip.</BLURB>
518 <DEFAULT>0</DEFAULT>
519 </ARG>
520
521 <ARG>
522 <NAME>GstA52Dec::drc</NAME>
523 <TYPE>gboolean</TYPE>
524 <RANGE></RANGE>
525 <FLAGS>rw</FLAGS>
526 <NICK>Dynamic Range Compression</NICK>
527 <BLURB>Use Dynamic Range Compression.</BLURB>
528 <DEFAULT>FALSE</DEFAULT>
529 </ARG>
530
531 <ARG>
532 <NAME>GstMPEGParse::adjust</NAME>
533 <TYPE>gboolean</TYPE>
534 <RANGE></RANGE>
535 <FLAGS>rw</FLAGS>
536 <NICK>adjust</NICK>
537 <BLURB>Adjust timestamps to smooth discontinuities.</BLURB>
538 <DEFAULT>TRUE</DEFAULT>
539 </ARG>
540
541 <ARG>
542 <NAME>GstMPEGParse::byte-offset</NAME>
543 <TYPE>guint64</TYPE>
544 <RANGE></RANGE>
545 <FLAGS>rw</FLAGS>
546 <NICK>Byte Offset</NICK>
547 <BLURB>Emit reached-offset signal when the byte offset is reached.</BLURB>
548 <DEFAULT>18446744073709551615</DEFAULT>
549 </ARG>
550
551 <ARG>
552 <NAME>GstMPEGParse::max-discont</NAME>
553 <TYPE>gint</TYPE>
554 <RANGE>>= 0</RANGE>
555 <FLAGS>rw</FLAGS>
556 <NICK>Max Discont</NICK>
557 <BLURB>The maximum allowed SCR discontinuity.</BLURB>
558 <DEFAULT>120000</DEFAULT>
559 </ARG>
560
561 <ARG>
562 <NAME>GstMPEGParse::sync</NAME>
563 <TYPE>gboolean</TYPE>
564 <RANGE></RANGE>
565 <FLAGS>rw</FLAGS>
566 <NICK>Sync</NICK>
567 <BLURB>Synchronize on the stream SCR.</BLURB>
568 <DEFAULT>FALSE</DEFAULT>
569 </ARG>
570
571 <ARG>
572 <NAME>GstMPEGParse::time-offset</NAME>
573 <TYPE>guint64</TYPE>
574 <RANGE></RANGE>
575 <FLAGS>r</FLAGS>
576 <NICK>Time Offset</NICK>
577 <BLURB>Time offset in the stream.</BLURB>
578 <DEFAULT>18446744073709551615</DEFAULT>
579 </ARG>
580
581 <ARG>
582 <NAME>GstMPEGParse::max-scr-gap</NAME>
583 <TYPE>gint</TYPE>
584 <RANGE>>= -1</RANGE>
585 <FLAGS>rw</FLAGS>
586 <NICK>Max SCR gap</NICK>
587 <BLURB>Maximum allowed gap between expected and actual SCR values. -1 means never adjust.</BLURB>
588 <DEFAULT>120000</DEFAULT>
589 </ARG>
590