gstreamer-unused.sgml 143 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/GstElement.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/GstElement.sgml:Title ##### -->
GstElement


<!-- ##### SECTION ./tmpl/audioraw.sgml:Long_Description ##### -->
<para>
Information about audio buffers.
</para>


<!-- ##### SECTION ./tmpl/audioraw.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/audioraw.sgml:Short_Description ##### -->
Information about audio buffers.


<!-- ##### SECTION ./tmpl/audioraw.sgml:Title ##### -->
audioraw


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<!-- ##### SECTION ./tmpl/cothreads_compat.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/cothreads_compat.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/cothreads_compat.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/cothreads_compat.sgml:Title ##### -->
cothreads_compat


Wim Taymans's avatar
Wim Taymans committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Title ##### -->
GObject


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!-- ##### SECTION ./tmpl/grammar.tab.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/grammar.tab.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/grammar.tab.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/grammar.tab.sgml:Title ##### -->
grammar.tab


<!-- ##### SECTION ./tmpl/gst_private.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gst_private.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gst_private.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gst_private.sgml:Title ##### -->
gst_private


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!-- ##### SECTION ./tmpl/gstaggregator.sgml:Long_Description ##### -->
<para>
The aggregator is mainly used for testing purposes. It has several
methods to request buffers from its pads.
</para>


<!-- ##### SECTION ./tmpl/gstaggregator.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstaggregator.sgml:Short_Description ##### -->
Combine buffers.


<!-- ##### SECTION ./tmpl/gstaggregator.sgml:Title ##### -->
GstAggregator


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:Long_Description ##### -->
<para>
Reads data from a file. You can seek to a specific location by setting
the offset.
</para>


<!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:Title ##### -->
GstAsyncDiskSrc


<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Title ##### -->
GstAudioSink


<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Title ##### -->
GstAudioSrc


199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!-- ##### SECTION ./tmpl/gstautoplug.sgml:Long_Description ##### -->
<para>
GstAutoplug is an abstract class that is used for constructing and 
linking elements. Two types of autopluggers exist: renderer ones and non
renderer ones. The renderer autopluggers will not have any src pads while the
non renderer ones do.
</para>

<para>
You first need to create a suitable autoplugger with gst_autoplug_factory_make() 
(see #GstAutoplugFactory).
The name of the autoplugger must be one of the registered autopluggers 
(see #GstStaticAutoplug and #GstStaticAutoplugRender).
</para>
<para>
If the autoplugger supports the RENDERER API, use gst_autoplug_to_renderers() to
create a bin that links the src caps to the specified renderer elements. You can 
then add the bin to a pipeline and run it.

  <programlisting>
  GstAutoplug *autoplug;
  GstElement  *element;
  GstElement  *sink;

  /* create a static autoplugger */
  autoplug = gst_autoplug_factory_make ("staticrender");

  /* create an osssink */
  sink = gst_element_factory_make ("osssink", "our_sink");

  /* create an element that can play audio/mp3 through osssink */
  element = gst_autoplug_to_renderers (autoplug, 
   				       gst_caps_new (
				         "sink_audio_caps",
				         "audio/mp3",
					 NULL
				       ),
				       sink,
				       NULL);

  /* add the element to a bin and link the sink pad */
  ...
  </programlisting>
</para>
<para>
If the autoplugger supports the CAPS API, use gst_autoplug_to_caps() to
link the src caps to the destination caps. The created bin will have src caps 
compatible with the provided sink caps.

  <programlisting>
  GstAutoplug *autoplug;
  GstElement  *element;

  /* create a static autoplugger */
  autoplug = gst_autoplug_factory_make ("static");

  /* create an element that converts audio/mp3 to audio/raw */
  element = gst_autoplug_to_caps (autoplug, 
   				  gst_caps_new (
				    "sink_audio_caps",
				    "audio/mp3",
				    NULL
				  ),
   				  gst_caps_new (
				    "src_audio_caps",
				    "audio/raw",
				    NULL
				  ),
				  NULL);

  /* add the element to a bin and link the src/sink pads */
  ...
  </programlisting>
</para>

<para>
Optionally you can get a notification when a new object is added to the created
pipeline with a g_signal_connect to the "new_object" signal.
</para>

<para>
Use the regular gst_object_destroy() call to destroy the autoplugger.
</para>


<!-- ##### SECTION ./tmpl/gstautoplug.sgml:See_Also ##### -->
<para>
#GstStaticAutoplug, #GstStaticAutoplugRender
</para>


<!-- ##### SECTION ./tmpl/gstautoplug.sgml:Short_Description ##### -->
Automatically create and link elements


<!-- ##### SECTION ./tmpl/gstautoplug.sgml:Title ##### -->
GstAutoplug


<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:Long_Description ##### -->
<para>
An autoplugfactory is used to create instances of an autoplugger. It
can be added to a #GstPlugin as it extends #GstPluginFeature.
</para>
<para>
Use gst_autoplug_factory_new() to create a new autoplugger which can be registered 
to a plugin with gst_plugin_add_feature().
</para>
<para>
Use gst_autoplug_factory_find() to find the named autoplugfactory.
or use gst_autoplug_factory_get_list() to get a  list of all available autopluggers.
</para>
<para>
Once an autoplugfactory has been obtained use gst_autoplug_factory_create() to
instantiate a real autoplugger. Optionally gst_autoplug_factory_make() to create
a autoplugger from the named factory.
</para>
<para>
Use gst_autoplug_factory_destroy() to remove the factory from the global list.
</para>


<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:See_Also ##### -->
<para>
#GstAutoplug, #GstPlugin, #GstPluginFeature.
</para>


<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:Short_Description ##### -->
Create autopluggers from a factory.


<!-- ##### SECTION ./tmpl/gstautoplugfactory.sgml:Title ##### -->
GstAutoplugFactory


335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstbufferpool-default.sgml:Title ##### -->
gstbufferpool-default


<!-- ##### SECTION ./tmpl/gstcache.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstcache.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstcache.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstcache.sgml:Title ##### -->
GstCacheFactory


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Title ##### -->
GstColorSpace


395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
<!-- ##### SECTION ./tmpl/gstdata_private.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstdata_private.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstdata_private.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstdata_private.sgml:Title ##### -->
gstdata_private


415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
<!-- ##### SECTION ./tmpl/gstdisksink.sgml:Long_Description ##### -->
<para>
The disksink write to a file. The filename can be given as an argument.
</para>


<!-- ##### SECTION ./tmpl/gstdisksink.sgml:See_Also ##### -->
<para>
#GstFdSink
</para>


<!-- ##### SECTION ./tmpl/gstdisksink.sgml:Short_Description ##### -->
Write to a file


<!-- ##### SECTION ./tmpl/gstdisksink.sgml:Title ##### -->
GstDiskSink


435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Long_Description ##### -->
<para>
Asynchonously read buffers from a file. 

</para>


<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Short_Description ##### -->
Asynchronous read from a file (disksrc)


<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Title ##### -->
GstDiskSrc


Wim Taymans's avatar
Wim Taymans committed
456
<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Long_Description ##### -->
457
458
459
460
461
<para>

</para>


Wim Taymans's avatar
Wim Taymans committed
462
<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:See_Also ##### -->
463
<para>
Wim Taymans's avatar
Wim Taymans committed
464

465
466
467
</para>


Wim Taymans's avatar
Wim Taymans committed
468
<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Short_Description ##### -->
469
470


Wim Taymans's avatar
Wim Taymans committed
471
472

<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Title ##### -->
473
474
475
GstElementFactory


476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
<!-- ##### SECTION ./tmpl/gstenumtypes.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstenumtypes.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstenumtypes.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstenumtypes.sgml:Title ##### -->
gstenumtypes


496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstesdsink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Title ##### -->
GstEsdSink


516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
<!-- ##### SECTION ./tmpl/gstextratypes.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstextratypes.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstextratypes.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstextratypes.sgml:Title ##### -->
GstExtraTypes


<!-- ##### SECTION ./tmpl/gstfakesink.sgml:Long_Description ##### -->
<para>
Take a buffer and gst_buffer_unref() it. This element does nothing
with the buffer. (fakesink)

</para>


<!-- ##### SECTION ./tmpl/gstfakesink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfakesink.sgml:Short_Description ##### -->
Sources a buffer without doing anything with it. (fakesink)


<!-- ##### SECTION ./tmpl/gstfakesink.sgml:Title ##### -->
GstFakeSink


<!-- ##### SECTION ./tmpl/gstfakesrc.sgml:Long_Description ##### -->
<para>
The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>


<!-- ##### SECTION ./tmpl/gstfakesrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfakesrc.sgml:Short_Description ##### -->
Generate empty buffers. (fakesrc)


<!-- ##### SECTION ./tmpl/gstfakesrc.sgml:Title ##### -->
GstFakeSrc


<!-- ##### SECTION ./tmpl/gstfdsink.sgml:Long_Description ##### -->
<para>
Write data to a file descriptor.
</para>


<!-- ##### SECTION ./tmpl/gstfdsink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfdsink.sgml:Short_Description ##### -->
Write data to a file descriptor. (fdsink)


<!-- ##### SECTION ./tmpl/gstfdsink.sgml:Title ##### -->
GstFdSink


<!-- ##### SECTION ./tmpl/gstfdsrc.sgml:Long_Description ##### -->
<para>
Read buffers from a file descriptor.
</para>


<!-- ##### SECTION ./tmpl/gstfdsrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfdsrc.sgml:Short_Description ##### -->
Read buffers from a file descriptor. (fdsrc)


<!-- ##### SECTION ./tmpl/gstfdsrc.sgml:Title ##### -->
GstFdSrc


618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
<!-- ##### SECTION ./tmpl/gstfilesink.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfilesink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfilesink.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstfilesink.sgml:Title ##### -->
GstFileSink


638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
<!-- ##### SECTION ./tmpl/gstfilesrc.sgml:Long_Description ##### -->
<para>
FileSrc is used to read buffers from a file. It efficiently uses mmap
and subbuffers.
</para>


<!-- ##### SECTION ./tmpl/gstfilesrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfilesrc.sgml:Short_Description ##### -->
Read data from a file


<!-- ##### SECTION ./tmpl/gstfilesrc.sgml:Title ##### -->
GstFileSrc


659
660
661
<!-- ##### SECTION ./tmpl/gstfilter.sgml:Long_Description ##### -->
<para>
Filters take data in and spit data out. They are the main Element in a filter graph.
662
Filters have zero or more inputs and zero or more outputs. Filters are linked
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
together to form filter graphs. A GstFilter is the base class and is not very usefull
on its own.
</para>


<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstfilter.sgml:Short_Description ##### -->
Take data in and spit data out


<!-- ##### SECTION ./tmpl/gstfilter.sgml:Title ##### -->
GstFilter


<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstgetbits.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Title ##### -->
GstGetbits


<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Long_Description ##### -->
<para>
Reads data from a URL.
</para>


<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Short_Description ##### -->
Reads data from a URL. (httpsrc)


<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Title ##### -->
GstHttpSrc


722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
<!-- ##### SECTION ./tmpl/gstidentity.sgml:Long_Description ##### -->
<para>
Pass data without modification.
</para>


<!-- ##### SECTION ./tmpl/gstidentity.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstidentity.sgml:Short_Description ##### -->
Pass data without modification. (identity)


<!-- ##### SECTION ./tmpl/gstidentity.sgml:Title ##### -->
GstIdentity


742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
<!-- ##### SECTION ./tmpl/gstlink.sgml:Long_Description ##### -->
<para>
A link is a base class for a generic link between
elements. A link is typically a base class for queues.

</para>


<!-- ##### SECTION ./tmpl/gstlink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstlink.sgml:Short_Description ##### -->
Generic link between elements.


<!-- ##### SECTION ./tmpl/gstlink.sgml:Title ##### -->
GstLink


764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
<!-- ##### SECTION ./tmpl/gstmacros.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmacros.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmacros.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstmacros.sgml:Title ##### -->
gstmacros


<!-- ##### SECTION ./tmpl/gstmarshal.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmarshal.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmarshal.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstmarshal.sgml:Title ##### -->
gstmarshal


804
805
<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Long_Description ##### -->
<para>
806

807
808
809
810
811
812
813
814
815
816
</para>


<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Short_Description ##### -->
817

818
819
820
821
822
823


<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Title ##### -->
GstMD5Sink


824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
<!-- ##### SECTION ./tmpl/gstmeta.sgml:Long_Description ##### -->
<para>
The point of the metadata is to provide some context for each buffer.  In
the case of audio data, for instance, it would provide the samplerate, bit
depth, and channel count.
</para>

<para>
The trick is that there may be multiple types of metadata ganged onto a
single buffer.  This is why they're going to be a GList.  This does mean
extra overhead in all cases, but I think it's minimal.  The GList type
uses a chunk allocater so we're not wasting too much memory or time when
adding to the list.
</para>

<para>
The trick is dealing with these structs as they pass through a pipeline,
since they have potentially different mutability properties.  For
842
instance, if you've got a mp3 decoder linked to a tee, which sends the
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
buffers off to both the decoder and a spectrum analyzer (and then a
visualization element).  The preferred setup would be where every time a
audio/raw metadata comes down the pipe (indicating a potential change in
audio format), the audiosink and spectrum would just save off pointers.
</para>

<para>
So when exactly does this metadata go away (deallocated)?  Well, that
means metadata has to be refcounted.  But that gets rather hairy.  OK, in
the simple case you create a metadata struct, it comes with refcount set
to 1.  You pass it through, it stays one, eventually someone drops the
last reference on the buffer it's tied to, you free the metadata too.
Easy.  What if you tee?  You could go through and for every metadata in
the buffer, increment the refcount by the same as the buffer.  So in the
above case (tee'd), the audiosink and spectrum would get the buffer with a
refcount of 2, and it'd have a metadata with refcount 2.  Do they ref it
each themselves, then unref the buffer?  Or do they remove the metadata?
Removing the metadata would require a buffer CoW, which would suck, so
yes, they'd just ref the metadata.
</para>

<para>
But....  what if they're all in different threads?  Then we're off into
the magical world of mutexes.  Everything with a refcount in a threaded
world must be mutexed, else you can do atomic increment and atomic
dec and test.  Can this be done from C easily?  Perhaps it needs to be found
from kernel includes via autoconf?
</para>

<para>
The goal in designing the way metadata will be defined and used is to keep
it as simple as possible.  The basis for accomplishing this is the fact
that in order to actually use (rather than just pass) the metadata, you
have to know what the fields are, which means you have to have compiled in
support for that metadata at build time.  Therefore, if you're using
metadata, you must have build-time access to the necessary include file
that defines it.
</para>

<para>
So, given that you've got an include file, it would be nice if the whole
thing could be contained there.  This would limit the need to be linked
against something, or have load-time requirements as to that has to be
loaded before you are.
</para>

<para>
Given that really all metadata is is a region of memory of a given size
with a certain signature, this isn't all that hard.  First you lay out the
struct that defines the metadata.  Then you set up #defines that expand to
the size of the struct in question, as well as the four-cc code that
defines the type.
</para>

<para>
The work is done by a few #defines, a la the #defines used in all Gtk
objects.  The first is a NEW() method that allocates the memory for the
metadata and fills in all the normal fields (type, size, utility
functions).  Because of the way it's defined (as a #define, no less),
you'll have to invoke it as META_NEW(meta), since it can't return()
anything.
</para>

<para>
Another #define will check to make sure a meta is indeed that type by
verifying the type code and size.  Theoretically, meta types can overlap
with the same fourcc code, as long as they have different sizes.  But I
probably ought to have a global public registry so people writing things
don't conflict.  MSFT got that right, at least.
</para>

<para>
So, a hairy problem is what to do when there are utility functions
associated with one of these things.  One option is to not bother with
them.  This is very likely a possible solution, since metadata is supposed
to be flat memory of a given size.  Not much to do to either free or copy
it, is there?
</para>


<!-- ##### SECTION ./tmpl/gstmeta.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmeta.sgml:Short_Description ##### -->
Provide context for buffers


<!-- ##### SECTION ./tmpl/gstmeta.sgml:Title ##### -->
GstMeta


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstmultidisksrc.sgml:Title ##### -->
GstMultiDiskSrc


<!-- ##### SECTION ./tmpl/gstpipefilter.sgml:Long_Description ##### -->
<para>
A GstPipefilter pipes data to an external program and creates
buffers from its output.
</para>


<!-- ##### SECTION ./tmpl/gstpipefilter.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstpipefilter.sgml:Short_Description ##### -->
A wrapper around every stdin/stdout capable program


<!-- ##### SECTION ./tmpl/gstpipefilter.sgml:Title ##### -->
GstPipefilter


<!-- ##### SECTION ./tmpl/gstqueue.sgml:Long_Description ##### -->
<para>
Simple data queue. Data is queued till max_level buffers any subsequent buffers
sent to this filter will block until free space becomes available in the buffer.
The queue is typically used in conjunction with a thread.
</para>
<para>
You can query how many buffers are queued with the level argument.
</para>
<para>
Wim Taymans's avatar
Wim Taymans committed
988
The default queue length is set to 100.
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
</para>
<para>
The queue blocks by default.
</para>


<!-- ##### SECTION ./tmpl/gstqueue.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstqueue.sgml:Short_Description ##### -->
Simple asynchronous data queue.


<!-- ##### SECTION ./tmpl/gstqueue.sgml:Title ##### -->
GstQueue


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
<!-- ##### SECTION ./tmpl/gstsearchfuncs.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstsearchfuncs.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstsearchfuncs.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstsearchfuncs.sgml:Title ##### -->
gstsearchfuncs


1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:Long_Description ##### -->
<para>
Create a sine wave of a given frequency and volume.
</para>


<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:Short_Description ##### -->
Create a sine wave of a given frequency and volume. (sinesrc)


<!-- ##### SECTION ./tmpl/gstsinesrc.sgml:Title ##### -->
GstSineSrc


<!-- ##### SECTION ./tmpl/gstsink.sgml:Long_Description ##### -->
<para>
The sink is the end of the filter graph. A typical sink would be an audio
or a video card.

</para>


<!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstsink.sgml:Short_Description ##### -->
The end point of a filter graph


<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink


1071
<!-- ##### SECTION ./tmpl/gstspider.sgml:Long_Description ##### -->
1072
1073
1074
1075
1076
<para>

</para>


1077
<!-- ##### SECTION ./tmpl/gstspider.sgml:See_Also ##### -->
1078
1079
1080
1081
1082
<para>

</para>


1083
<!-- ##### SECTION ./tmpl/gstspider.sgml:Short_Description ##### -->
1084
1085
1086



1087
1088
<!-- ##### SECTION ./tmpl/gstspider.sgml:Title ##### -->
GstSpider
1089

1090
1091

<!-- ##### SECTION ./tmpl/gstspideridentity.sgml:Long_Description ##### -->
1092
<para>
1093

1094
1095
1096
</para>


1097
<!-- ##### SECTION ./tmpl/gstspideridentity.sgml:See_Also ##### -->
1098
1099
1100
1101
1102
<para>

</para>


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
<!-- ##### SECTION ./tmpl/gstspideridentity.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstspideridentity.sgml:Title ##### -->
GstSpiderIdentity


<!-- ##### SECTION ./tmpl/gstsrc.sgml:Long_Description ##### -->
<para>
A GstSrc is the start of a filter graph. It typically is a file or an
audio source. It provides data for the next element in the graph.

</para>


<!-- ##### SECTION ./tmpl/gstsrc.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstsrc.sgml:Short_Description ##### -->
The start point of a filter graph


<!-- ##### SECTION ./tmpl/gstsrc.sgml:Title ##### -->
GstSrc


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:Long_Description ##### -->
<para>
This autoplugger will create a non threaded element before running the
pipeline.
</para>


<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:Short_Description ##### -->
A static autoplugger.


<!-- ##### SECTION ./tmpl/gststaticautoplug.sgml:Title ##### -->
GstStaticAutoplug


<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:Long_Description ##### -->
<para>
this autoplugger will create a threaded element that can be used
in media players.
</para>


<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:Short_Description ##### -->
An autoplugger made for media playback


<!-- ##### SECTION ./tmpl/gststaticautoplugrender.sgml:Title ##### -->
GstStaticAutoplugRender


1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
<!-- ##### SECTION ./tmpl/gststatistics.sgml:Long_Description ##### -->
<para>
The plugin doesn't alter the data but provides statistics about
the data stream, such as buffers/bytes/events etc.
</para>


<!-- ##### SECTION ./tmpl/gststatistics.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gststatistics.sgml:Short_Description ##### -->
Provide statistics about data that passes this plugin
1190
1191
1192
1193
1194
1195


<!-- ##### SECTION ./tmpl/gststatistics.sgml:Title ##### -->
GstStatistics


Wim Taymans's avatar
Wim Taymans committed
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
<!-- ##### SECTION ./tmpl/gsttee.sgml:Long_Description ##### -->
<para>
A tee can be used to split out the filter graph.
</para>


<!-- ##### SECTION ./tmpl/gsttee.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gsttee.sgml:Short_Description ##### -->
1-to-N pipe fitting


<!-- ##### SECTION ./tmpl/gsttee.sgml:Title ##### -->
GstTee


<!-- ##### SECTION ./tmpl/gsttimecache.sgml:Long_Description ##### -->
<para>
This class is used by plugins to manage time vs byte offsets. It is mainly
used for efficient seeking.
</para>


<!-- ##### SECTION ./tmpl/gsttimecache.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gsttimecache.sgml:Short_Description ##### -->
Cache time and byteoffsets.


<!-- ##### SECTION ./tmpl/gsttimecache.sgml:Title ##### -->
GstTimeCache


1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
<!-- ##### SECTION ./tmpl/gsttypes.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gsttypes.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gsttypes.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gsttypes.sgml:Title ##### -->
gsttypes


<!-- ##### SECTION ./tmpl/gstversion.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstversion.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstversion.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstversion.sgml:Title ##### -->
gstversion


<!-- ##### SECTION ./tmpl/gstxmlregistry.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstxmlregistry.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gstxmlregistry.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gstxmlregistry.sgml:Title ##### -->
GstXMLRegistry


1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
<!-- ##### SECTION ./tmpl/plugin.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/plugin.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/plugin.sgml:Title ##### -->
plugin


<!-- ##### SECTION ./tmpl/spectrum.sgml:Long_Description ##### -->
<para>
Frequencies of a spectrum analysis.

</para>


<!-- ##### SECTION ./tmpl/spectrum.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/spectrum.sgml:Short_Description ##### -->
Frequencies of a spectrum analysis.


<!-- ##### SECTION ./tmpl/spectrum.sgml:Title ##### -->
spectrum


1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
<!-- ##### SECTION ./tmpl/types.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/types.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/types.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/types.sgml:Title ##### -->
types


1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
<!-- ##### SECTION ./tmpl/videoraw.sgml:Long_Description ##### -->
<para>
Information about video buffers.
</para>


<!-- ##### SECTION ./tmpl/videoraw.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
Information about video buffers.


<!-- ##### SECTION ./tmpl/videoraw.sgml:Title ##### -->
videoraw


1378
<!-- ##### MACRO BLINK ##### -->
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
<para>

</para>


<!-- ##### MACRO COTHREADS_NAME ##### -->
<para>

</para>


<!-- ##### MACRO COTHREADS_NAME_CAPITAL ##### -->
<para>

</para>


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
<!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
<para>
The maximum number of cothreads we are going to support.
</para>


<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
<para>
The default stack size of a cothread.
</para>


1408
1409
1410
1411
1412
1413
<!-- ##### MACRO CURRENT_STACK_FRAME ##### -->
<para>
Get the current stack frame.
</para>


1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
<!-- ##### MACRO DEBUG ##### -->
<para>
Use this macro to show debugging info. This is only usefull when developing new
plugin elements.
If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce
g_print messages.
</para>

@format: the format specification as in g_print
@args...: arguments

<!-- ##### MACRO DEBUG_ENTER ##### -->
<para>

</para>

@format: 
@args...: 

<!-- ##### MACRO DEBUG_ENTER_STRING ##### -->
<para>

</para>


<!-- ##### MACRO DEBUG_LEAVE ##### -->
<para>

</para>

@format: 
@args...: 

<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>

</para>


<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
<para>

</para>

@format: 
@args...: 

<!-- ##### MACRO DEBUG_SET_STRING ##### -->
<para>

</para>

@format: 
@args...: 

<!-- ##### MACRO ERROR ##### -->
<para>

</para>

@element: 
@format: 
@args...: 

<!-- ##### MACRO ERROR_OBJECT ##### -->
<para>

</para>

@element: 
@object: 
@format: 
@args...: 

1488
<!-- ##### MACRO FLINK ##### -->
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
<para>

</para>


<!-- ##### MACRO FUNCTION ##### -->
<para>

</para>


1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
<!-- ##### MACRO GBaseInitFunc ##### -->
<para>

</para>


<!-- ##### MACRO GCallback ##### -->
<para>

</para>


<!-- ##### MACRO GClassInitFunc ##### -->
<para>

</para>


<!-- ##### MACRO GEnumValue ##### -->
<para>

</para>


<!-- ##### MACRO GInstanceInitFunc ##### -->
<para>

</para>


1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
<!-- ##### MACRO GLOBAL_REGISTRY_DIR ##### -->
<para>

</para>


<!-- ##### MACRO GLOBAL_REGISTRY_FILE ##### -->
<para>

</para>


<!-- ##### MACRO GLOBAL_REGISTRY_FILE_TMP ##### -->
<para>

</para>


1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
<!-- ##### STRUCT GObject ##### -->
<para>

</para>


<!-- ##### MACRO GParamFlags ##### -->
<para>

</para>


<!-- ##### STRUCT GParamSpec ##### -->
<para>

</para>

@name: 
@value_type: 
@flags: 

<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
<para>

</para>

@obj: 

<!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### -->
<para>

</para>

@klass: 

Wim Taymans's avatar
Wim Taymans committed
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
<!-- ##### MACRO GST_ATOMIC_INT_ADD ##### -->
<para>
Atomically add a value to a #GstAtomicInt
</para>

@ref: a reference to a #GstAtomicInt
@count: The value to add

<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
<para>
Decrement the value of a #GstAtomicInt atomically and test
for zero.
</para>

@ref: a reference to a #GstAtomicInt
@zero: a gpointer to a gboolean to hold the value of the test

<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
<para>
Free the memory allocated by #GST_ATOMIC_INT_INIT
</para>

@ref: A reference to a #GstAtomicInt

<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
<para>
Increment the value of a #GstAtomicInt atomically
</para>

@ref: a reference to a #GstAtomicInt

<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
<para>
Initialize an atomic int
</para>

@ref: a reference to a #GstAtomicInt
@val: The initial value for the integer

<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
<para>
Get the value of a #GstAtomicInt atomically into a variable
</para>

@ref: a reference to a #GstAtomicInt
@res: a pointer to a gint to hold the value

<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
<para>
Set the value of a #GstAtomicInt atomically
</para>

@ref: a reference to a #GstAtomicInt
@val: The value for the integer

<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
<para>
Get the value of a #GstAtomicInt atomically
</para>

@ref: a reference to a #GstAtomicInt

1645
<!-- ##### MACRO GST_ATOMIC_LOCK ##### -->
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
1646
<para>
1647

Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
1648
1649
1650
</para>


Wim Taymans's avatar
Wim Taymans committed
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
<!-- ##### MACRO GST_ATOMIC_SWAP ##### -->
<para>
Atomically swap the value of the #GstAtomicSwap with a new value
</para>

@swap: a reference to a #GstAtomicSwap
@val: the new value

<!-- ##### MACRO GST_ATOMIC_SWAP_GET ##### -->
<para>
Atomically swap the value of the #GstAtomicSwap with a new value and
get the old value.
</para>

@swap: a reference to a #GstAtomicSwap
@val: the new value
@res: the old value

<!-- ##### MACRO GST_ATOMIC_SWAP_INIT ##### -->
<para>
Initialize an atomic swap structure
</para>

@swap: a reference to a #GstAtomicSwap
@val: the initial value

<!-- ##### MACRO GST_ATOMIC_SWAP_VALUE ##### -->
<para>
Get the value of a #GstAtomicSwap
</para>

@swap: a reference to a #GstAtomicSwap

1684
<!-- ##### MACRO GST_AUDIOSINK ##### -->
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
1685
1686
1687
1688
<para>

</para>

1689
@obj: 
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
1690

1691
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
Wim Taymans's avatar
Wim Taymans committed
1692
<para>
1693

Wim Taymans's avatar
Wim Taymans committed
1694
1695
</para>

1696
@klass: 
Wim Taymans's avatar
Wim Taymans committed
1697

1698
<!-- ##### MACRO GST_AUDIOSRC ##### -->
Wim Taymans's avatar
Wim Taymans committed
1699
<para>
1700

Wim Taymans's avatar
Wim Taymans committed
1701
1702
</para>

1703
@obj: 
Wim Taymans's avatar
Wim Taymans committed
1704

1705
<!-- ##### MACRO GST_AUDIOSRC_CLASS ##### -->
Wim Taymans's avatar
Wim Taymans committed
1706
<para>
1707

Wim Taymans's avatar
Wim Taymans committed
1708
1709
</para>

1710
@klass: 
Wim Taymans's avatar
Wim Taymans committed
1711

1712
<!-- ##### MACRO GST_AUTOPLUG_FACTORY ##### -->
1713
1714
1715
1716
1717
1718
<para>

</para>

@obj: 

1719
<!-- ##### MACRO GST_AUTOPLUG_FACTORY_CLASS ##### -->
1720
1721
1722
1723
1724
1725
<para>

</para>

@klass: 

1726
<!-- ##### MACRO GST_AUTOPLUG_MAX_COST ##### -->
1727
<para>
1728

1729
1730
1731
</para>


1732
<!-- ##### MACRO GST_BIN ##### -->
1733
<para>
1734

1735
1736
</para>

1737
@obj: 
1738

1739
<!-- ##### MACRO GST_BIN_CAST ##### -->
1740
1741
1742
1743
<para>

</para>

1744
@obj: 
1745

1746
<!-- ##### MACRO GST_BIN_CLASS ##### -->
1747
1748
1749
1750
<para>

</para>

1751
@klass: 
1752

1753
<!-- ##### MACRO GST_BIN_CLASS_CAST ##### -->
1754
1755
1756
1757
<para>

</para>

1758
@klass: 
1759

1760
1761
1762
1763
1764
1765
1766
1767
<!-- ##### MACRO GST_BUFFER_BUFFERPOOL ##### -->
<para>
Gets the bufferpool for this buffer.
</para>

@buf: a #GstBuffer to get the bufferpool of.
@Returns: the #GstBufferPool of this buffer.

1768
<!-- ##### MACRO GST_BUFFER_LOCK ##### -->
1769
<para>
1770
Obtains a lock on the object, making serialization possible.
1771
1772
</para>

1773
@buf: a #GstBuffer to lock
1774

1775
<!-- ##### MACRO GST_BUFFER_MAXAGE ##### -->
1776
<para>
1777
Gets the maximum age of a buffer.
1778
1779
</para>

1780
@buf: a #GstBuffer to get maximum age of
1781

1782
<!-- ##### MACRO GST_BUFFER_PARENT ##### -->
1783
<para>
1784
Gets the parent of this buffer. The parent is set on sub-buffers.
1785
1786
</para>

1787
@buf: a #GstBuffer to get parent of
1788

1789
<!-- ##### MACRO GST_BUFFER_POOL_LOCK ##### -->
1790
<para>
1791
Unlock the given bufferpool.
1792
1793
</para>

1794
@pool: the bufferpool to unlock.
1795

1796
1797
1798
1799
1800
1801
1802
<!-- ##### MACRO GST_BUFFER_POOL_PRIVATE ##### -->
<para>
Gets the bufferpool private data.
</para>

@buf: a #GstBuffer to get bufferpool's private data of.

1803
<!-- ##### MACRO GST_BUFFER_POOL_UNLOCK ##### -->
1804
<para>
1805
Lock the given bufferpool.
1806
1807
</para>

1808
@pool: The pool to lock.
1809

1810
<!-- ##### MACRO GST_BUFFER_TRYLOCK ##### -->
1811
<para>
1812
1813
Tries to obtain a lock on the buffer.
If it can't get immediately, will return FALSE.
1814
1815
</para>

1816
@buf: a #GstBuffer to try to lock
1817

1818
<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
1819
<para>
1820
Retrieves the type id of the data in the buffer.
1821
1822
</para>

1823
@buf: GstBuffer
1824

1825
<!-- ##### MACRO GST_BUFFER_UNLOCK ##### -->
1826
<para>
1827
Releases a lock on the buffer.
1828
1829
1830

</para>

1831
@buf: a #GstBuffer to unlock
1832

1833
<!-- ##### MACRO GST_CACHE_ASSOC_FLAGS ##### -->
1834
1835
1836
1837
<para>

</para>

1838
@entry: 
1839

1840
<!-- ##### MACRO GST_CACHE_ASSOC_FORMAT ##### -->
1841
<para>
1842

1843
1844
</para>

1845
1846
@entry: 
@i: 
1847

1848
<!-- ##### MACRO GST_CACHE_ASSOC_VALUE ##### -->
1849
1850
1851
1852
<para>

</para>

1853
1854
@entry: 
@i: 
1855

1856
<!-- ##### MACRO GST_CACHE_FACTORY ##### -->
1857
1858
1859
1860
1861
1862
<para>

</para>

@obj: 

1863
<!-- ##### MACRO GST_CACHE_FACTORY_CLASS ##### -->
1864
1865
1866
1867
<para>

</para>

1868
@klass: 
1869

1870
<!-- ##### MACRO GST_CACHE_FORMAT_FORMAT ##### -->
Wim Taymans's avatar
Wim Taymans committed
1871
<para>
1872

Wim Taymans's avatar
Wim Taymans committed
1873
1874
</para>

1875
@entry: 
Wim Taymans's avatar
Wim Taymans committed
1876

1877
<!-- ##### MACRO GST_CACHE_FORMAT_KEY ##### -->
Wim Taymans's avatar
Wim Taymans committed
1878
<para>
1879

Wim Taymans's avatar
Wim Taymans committed
1880
1881
</para>

1882
@entry: 
Wim Taymans's avatar
Wim Taymans committed
1883

1884
<!-- ##### MACRO GST_CACHE_ID_DESCRIPTION ##### -->
Wim Taymans's avatar
Wim Taymans committed
1885
<para>
1886

Wim Taymans's avatar
Wim Taymans committed
1887
1888
</para>

1889
@entry: 
Wim Taymans's avatar
Wim Taymans committed
1890

1891
<!-- ##### MACRO GST_CACHE_NASSOCS ##### -->
1892
1893
1894
1895
<para>

</para>

1896
@entry: 
1897

1898
<!-- ##### MACRO GST_CAPS ##### -->
1899
1900
1901
1902
<para>

</para>

1903
@caps: 
1904

1905
<!-- ##### MACRO GST_CAPS_LOCK ##### -->
1906
<para>
1907
Lock the caps structure
1908
1909
</para>

1910
@caps: The caps structure to lock
1911

1912
<!-- ##### MACRO GST_CAPS_TRYLOCK ##### -->
1913
<para>
1914
1915
1916
1917
Try to lock the caps structure
</para>

@caps: The caps structure to try to lock
1918

1919
1920
1921
<!-- ##### MACRO GST_CAPS_UNLOCK ##### -->
<para>
Unlock the caps structure
1922
1923
</para>

1924
@caps: The caps structure to unlock
1925

1926
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
1927
<para>
1928
A flag indicating that MMX instructions are supported.
1929
1930
1931
</para>


1932
<!-- ##### MACRO GST_CPU_FLAG_SSE ##### -->
1933
<para>
1934
A flag indicating that SSE instructions are supported.
1935
1936
1937
</para>


1938
1939
1940
1941
1942
1943
1944
<!-- ##### MACRO GST_DATA_IS_READONLY ##### -->
<para>
Query if the GstData is READONLY
</para>

@data: The data to query

Wim Taymans's avatar
Wim Taymans committed
1945
1946
1947
1948
1949
1950
1951
1952
<!-- ##### MACRO GST_DATA_REFCOUNT_READ ##### -->
<para>
Read the current refcount value into the specified value
</para>

@data: The GstData to get the refcount value of
@value: A pointer to a gint to hold the refcount value

1953
<!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
1954
1955
1956
1957
1958
<para>

</para>


1959
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
1960
1961
1962
1963
1964
<para>

</para>


1965
<!-- ##### MACRO GST_DEBUG_ENABLE_CATEGORIES ##### -->
1966
1967
1968
1969
1970
<para>

</para>


1971
<!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
1972
<para>
1973
Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING.
1974
1975
1976
</para>


1977
<!-- ##### MACRO GST_DEBUG_LEAVE_STRING ##### -->
1978
1979
1980
1981
1982
<para>

</para>


1983
<!-- ##### MACRO GST_DEBUG_NOPREFIX ##### -->
1984
1985
1986
1987
<para>

</para>

1988
1989
1990
@cat: 
@format: 
@args...: 
1991

1992
<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
1993
1994
1995
1996
<para>

</para>

1997
1998
1999
@cat: 
@format: 
@args...: 
2000

2001
<!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
2002
<para>
2003
2004
Set the debug string for the current function, typically containing the arguments
to the current function, i.e. "('element')"
2005
2006
</para>

2007
2008
@format: printf-style format string
@args...: printf arguments
2009

2010
2011
2012
2013
2014
2015
<!-- ##### MACRO GST_DISABLE_AUTOPLUG ##### -->
<para>

</para>


Benjamin Otte's avatar
Benjamin Otte committed
2016
2017
2018
2019
2020
2021
<!-- ##### MACRO GST_DISABLE_TYPEFIND ##### -->
<para>

</para>


2022
<!-- ##### MACRO GST_DISKSRC ##### -->
2023
2024
2025
2026
2027
2028
<para>

</para>

@obj: 

2029
<!-- ##### MACRO GST_DISKSRC_CLASS ##### -->
2030
2031
2032
2033
<para>

</para>

2034
@klass: 
2035

2036
<!-- ##### MACRO GST_ELEMENT ##### -->
2037
2038
2039
2040
2041
2042
<para>

</para>

@obj: 

2043
<!-- ##### MACRO GST_ELEMENT_CAST ##### -->
2044
2045
2046
2047
2048
2049
<para>

</para>

@obj: 

2050
<!-- ##### MACRO GST_ELEMENT_CLASS ##### -->
2051
2052
2053
2054
<para>

</para>

2055
@klass: 
2056

2057
<!-- ##### MACRO GST_ELEMENT_CLASS_CAST ##### -->
2058
2059
2060
2061
<para>

</para>

2062
@klass: 
2063

2064
<!-- ##### MACRO GST_ELEMENT_FACTORY ##### -->
2065
2066
2067
2068
2069
2070
<para>

</para>

@obj: 

2071
<!-- ##### MACRO GST_ELEMENT_FACTORY_CLASS ##### -->
2072
2073
2074
2075
<para>

</para>

2076
@klass: 
2077

2078
<!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
2079
<para>
2080
Queries whether the cothread holding this element needs to be stopped.
2081
2082
</para>

2083
@obj: The element to query
2084

Benjamin Otte's avatar
Benjamin Otte committed
2085
2086
2087
2088
2089
2090
2091
<!-- ##### MACRO GST_ELEMENT_IS_EOS ##### -->
<para>
Query wether this element is in the End Of Stream state.
</para>

@obj: a #GstElement to query

2092
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
2093
<para>
2094
Query whether this object has multiple input pads.
2095
2096
2097

</para>

2098
@obj: Element to query for multiple input pads.
2099

Benjamin Otte's avatar
Benjamin Otte committed
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
<!-- ##### MACRO GST_ELEMENT_RANK_MARGINAL ##### -->
<para>
The element is only marginally usefull for autoplugging
</para>


<!-- ##### MACRO GST_ELEMENT_RANK_NONE ##### -->
<para>
The plugin may not be used in autoplugging
</para>


<!-- ##### MACRO GST_ELEMENT_RANK_PRIMARY ##### -->
<para>
The plugin is well suited for autoplugging
</para>


<!-- ##### MACRO GST_ELEMENT_RANK_SECONDARY ##### -->
<para>
The plugin is suited for autoplugging but only as a second
candidate.
</para>


2125
<!-- ##### MACRO GST_ESDSINK ##### -->
2126
2127
2128
2129
2130
2131
<para>

</para>

@obj: 

2132
<!-- ##### MACRO GST_ESDSINK_CLASS ##### -->
Andy Wingo Wingo's avatar