I've no idea here...
[gtkD.git] / gtkD / wrap / gstreamertypes.d
blob52e26700e87a8e4c2ae87d778c8a855026d238e5
1 /*
2 * This file is part of GStreamerD.
4 * GStreamerD is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published by
6 * the Free Software Foundation; either version 2.1 of the License, or
7 * (at your option) any later version.
9 * GStreamerD is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with GStreamerD; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 // generated automatically - do not change
20 // find conversion definition on APILookup.txt
21 // implement new conversion functionalities on the wrap.utils package
23 module gstreamerc.gstreamertypes;
25 public import gtkc.glibtypes;
26 public import gtkc.gobjecttypes;
27 public import gtkc.gthreadtypes;
30 /***** default padding of structures *****/
31 const long GST_PADDING = 4;
32 //#define GST_PADDING_INIT {0}
34 /***** padding for very extensible base classes *****/
35 const long GST_PADDING_LARGE = 20;
37 //Hand added, these might be clean to define as GstClockTimes:
39 //#define G_USEC_PER_SEC 1000000 //This should be in glib...
40 const ulong G_USEC_PER_SEC = 1000000uL;
41 //#define GST_SECOND (G_USEC_PER_SEC * G_GINT64_CONSTANT (1000))
42 const ulong GST_SECOND = (G_USEC_PER_SEC * 1000uL);
44 public alias GST_SECOND SECOND;
46 //This one is an undefined GstClockTime. How can this be ulong???
47 //I guess it should be long...???
48 //#define GST_CLOCK_TIME_NONE ((GstClockTime) -1)
49 const long GST_CLOCK_TIME_NONE = -1L;
50 public alias GST_CLOCK_TIME_NONE CLOCK_TIME_NONE;
54 /**
55 * typedef guint64 GstClockTime;
56 * A datatype to hold a time, measured in nanoseconds.
58 public alias ulong GstClockTime;
60 /**
61 * typedef gint64 GstClockTimeDiff;
62 * A datatype to hold a timedifference, measured in nanoseconds.
64 public alias long GstClockTimeDiff;
66 /**
67 * typedef gpointer GstClockID;
68 * A datatype to hold the handle to an outstanding sync or async clock callback.
70 public alias void* GstClockID;
72 /**
73 * typedef GstStructure GstTagList;
74 * Opaque GstTagList data structure.
76 public alias GstStructure GstTagList;
78 /**
79 * The standard flags that an gstobject may have.
80 * GST_OBJECT_DISPOSING
82 public enum GstObjectFlags
84 DISPOSING = (1<<0),
85 FLOATING = (1<<1),
86 /+* padding +/
87 FLAG_LAST = (1<<4)
89 alias GstObjectFlags ObjectFlags;
92 /**
93 * The standard flags that an element may have.
94 * GST_ELEMENT_LOCKED_STATE
96 public enum GstElementFlags
98 LOCKED_STATE = (GstObjectFlags.FLAG_LAST << 0),
99 IS_SINK = (GstObjectFlags.FLAG_LAST << 1),
100 UNPARENTING = (GstObjectFlags.FLAG_LAST << 2),
101 /+* padding +/
102 FLAG_LAST = (GstObjectFlags.FLAG_LAST << 16)
104 alias GstElementFlags ElementFlags;
108 * GstBinFlags are a set of flags specific to bins. Most are set/used
109 * internally. They can be checked using the GST_OBJECT_FLAG_IS_SET() macro,
110 * and (un)set using GST_OBJECT_FLAG_SET() and GST_OBJECT_FLAG_UNSET().
111 * GST_BIN_FLAG_LAST
113 public enum GstBinFlags
115 /+* padding +/
116 FLAG_LAST = (GstElementFlags.FLAG_LAST << 5)
118 alias GstBinFlags BinFlags;
121 * Flags for the padtemplate
122 * GST_MINI_OBJECT_FLAG_READONLY
124 public enum GstMiniObjectFlags
126 READONLY = (1<<0),
127 /+* padding +/
128 LAST = (1<<4)
130 alias GstMiniObjectFlags MiniObjectFlags;
133 * A set of buffer flags used to describe properties of a GstBuffer.
134 * GST_BUFFER_FLAG_READONLY
136 public enum GstBufferFlag
138 FLAG_READONLY = GstMiniObjectFlags.READONLY,
139 FLAG_PREROLL = (GstObjectFlags.FLAG_LAST << 0),
140 FLAG_DISCONT = (GstObjectFlags.FLAG_LAST << 1),
141 FLAG_IN_CAPS = (GstObjectFlags.FLAG_LAST << 2),
142 FLAG_GAP = (GstObjectFlags.FLAG_LAST << 3),
143 FLAG_DELTA_UNIT = (GstObjectFlags.FLAG_LAST << 4),
144 /+* padding +/
145 FLAG_LAST = (GstObjectFlags.FLAG_LAST << 8)
147 alias GstBufferFlag BufferFlag;
150 * The standard flags that a bus may have.
151 * GST_BUS_FLUSHING
153 public enum GstBusFlags
155 USHING = (GstObjectFlags.FLAG_LAST << 0),
156 /+* padding +/
157 AG_LAST = (GstObjectFlags.FLAG_LAST << 1)
159 alias GstBusFlags BusFlags;
162 * The result values for a GstBusSyncHandler.
163 * GST_BUS_DROP
165 public enum GstBusSyncReply
167 DROP = 0,
168 PASS = 1,
169 ASYNC = 2,
171 alias GstBusSyncReply BusSyncReply;
174 * Extra flags for a caps.
175 * GST_CAPS_FLAGS_ANY
177 public enum GstCapsFlags
179 ANY = (1 << 0)
181 alias GstCapsFlags CapsFlags;
184 * The type of the clock entry
185 * GST_CLOCK_ENTRY_SINGLE
187 public enum GstClockEntryType
189 SINGLE,
190 PERIODIC
192 alias GstClockEntryType ClockEntryType;
195 * The return value of a clock operation.
196 * GST_CLOCK_OK
198 public enum GstClockReturn
200 OK = 0,
201 EARLY = 1,
202 UNSCHEDULED = 2,
203 BUSY = 3,
204 BADTIME = 4,
205 ERROR = 5,
206 UNSUPPORTED = 6,
208 alias GstClockReturn ClockReturn;
211 * The capabilities of this clock
212 * GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC
214 public enum GstClockFlags
216 CAN_DO_SINGLE_SYNC = (GstObjectFlags.FLAG_LAST << 0),
217 CAN_DO_SINGLE_ASYNC = (GstObjectFlags.FLAG_LAST << 1),
218 CAN_DO_PERIODIC_SYNC = (GstObjectFlags.FLAG_LAST << 2),
219 CAN_DO_PERIODIC_ASYNC = (GstObjectFlags.FLAG_LAST << 3),
220 CAN_SET_RESOLUTION = (GstObjectFlags.FLAG_LAST << 4),
221 CAN_SET_MASTER = (GstObjectFlags.FLAG_LAST << 5),
222 /+* padding +/
223 LAST = (GstObjectFlags.FLAG_LAST << 8),
225 alias GstClockFlags ClockFlags;
228 * The posible states an element can be in.
229 * GST_STATE_VOID_PENDING
231 public enum GstState
233 VOID_PENDING = 0,
234 NULL = 1,
235 READY = 2,
236 PAUSED = 3,
237 PLAYING = 4
239 alias GstState State;
242 * The different (interesting) state changes that are passed to the
243 * state change functions of elements.
244 * GST_STATE_CHANGE_NULL_TO_READY
246 public enum GstStateChange
248 NULL_TO_READY = (GstState.NULL<<3) | GstState.READY,
249 READY_TO_PAUSED = (GstState.READY<<3) | GstState.PAUSED,
250 PAUSED_TO_PLAYING = (GstState.PAUSED<<3) | GstState.PLAYING,
251 PLAYING_TO_PAUSED = (GstState.PLAYING<<3) | GstState.PAUSED,
252 PAUSED_TO_READY = (GstState.PAUSED<<3) | GstState.READY,
253 READY_TO_NULL = (GstState.READY<<3) | GstState.NULL
255 alias GstStateChange StateChange;
258 * the possible return values from a state change function.
259 * GST_STATE_CHANGE_FAILURE
261 public enum GstStateChangeReturn
263 FAILURE = 0,
264 SUCCESS = 1,
265 ASYNC = 2,
266 NO_PREROLL = 3
268 alias GstStateChangeReturn StateChangeReturn;
271 * GstEventTypeFlags indicate the aspects of the different GstEventType
272 * values. You can get the type flags of a GstEventType with the
273 * gst_event_type_get_flags() function.
274 * GST_EVENT_TYPE_UPSTREAM
276 public enum GstEventTypeFlags
278 UPSTREAM = 1 << 0,
279 DOWNSTREAM = 1 << 1,
280 SERIALIZED = 1 << 2,
282 alias GstEventTypeFlags EventTypeFlags;
285 * GstEventType lists the standard event types that can be sent in a pipeline.
286 * The custom event types can be used for private messages between elements
287 * that can't be expressed using normal
288 * GStreamer buffer passing semantics. Custom events carry an arbitrary
289 * GstStructure.
290 * Specific custom events are distinguished by the name of the structure.
291 * GST_EVENT_UNKNOWN
294 public enum GstEventType
296 UNKNOWN = 0,
297 /+* bidirectional events +/
298 FLUSH_START = 16 | GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM,
299 FLUSH_STOP = 32 | GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED,
300 /+* downstream serialized events +/
301 EOS = 80 | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED,
302 NEWSEGMENT = 96 | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED,
303 TAG = 112 | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED,
304 BUFFERSIZE = 128 | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED,
305 /+* upstream events +/
306 QOS = 240 | GstEventTypeFlags.UPSTREAM,
307 SEEK = 256 | GstEventTypeFlags.UPSTREAM,
308 NAVIGATION = 272 | GstEventTypeFlags.UPSTREAM,
309 /+* custom events start here +/
310 CUSTOM_UPSTREAM = 512 | GstEventTypeFlags.UPSTREAM,
311 CUSTOM_DOWNSTREAM = 512 | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED,
312 CUSTOM_DOWNSTREAM_OOB = 512 | GstEventTypeFlags.DOWNSTREAM,
313 CUSTOM_BOTH = 512 | GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED,
314 CUSTOM_BOTH_OOB = 512 | GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM
316 alias GstEventType EventType;
318 /*public enum GstEventType
320 UNKNOWN = GST_EVENT_MAKE_TYPE (0, 0),
321 /+* bidirectional events +/
322 FLUSH_START = GST_EVENT_MAKE_TYPE (1, GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM),
323 FLUSH_STOP = GST_EVENT_MAKE_TYPE (2, GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED),
324 /+* downstream serialized events +/
325 EOS = GST_EVENT_MAKE_TYPE (5, GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED),
326 NEWSEGMENT = GST_EVENT_MAKE_TYPE (6, GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED),
327 TAG = GST_EVENT_MAKE_TYPE (7, GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED),
328 BUFFERSIZE = GST_EVENT_MAKE_TYPE (8, GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED),
329 /+* upstream events +/
330 QOS = GST_EVENT_MAKE_TYPE (15, GstEventTypeFlags.UPSTREAM),
331 SEEK = GST_EVENT_MAKE_TYPE (16, GstEventTypeFlags.UPSTREAM),
332 NAVIGATION = GST_EVENT_MAKE_TYPE (17, GstEventTypeFlags.UPSTREAM),
333 /+* custom events start here +/
334 CUSTOM_UPSTREAM = GST_EVENT_MAKE_TYPE (32, GstEventTypeFlags.UPSTREAM),
335 CUSTOM_DOWNSTREAM = GST_EVENT_MAKE_TYPE (32, GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED),
336 CUSTOM_DOWNSTREAM_OOB = GST_EVENT_MAKE_TYPE (32, GstEventTypeFlags.DOWNSTREAM),
337 CUSTOM_BOTH = GST_EVENT_MAKE_TYPE (32, GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM | GstEventTypeFlags.SERIALIZED),
338 CUSTOM_BOTH_OOB = GST_EVENT_MAKE_TYPE (32, GstEventTypeFlags.UPSTREAM | GstEventTypeFlags.DOWNSTREAM)
340 alias GstEventType EventType;
344 * The different types of seek events. When constructing a seek event, a format,
345 * a seek method and optional flags are to be provided. The seek event is then
346 * inserted into the graph with gst_pad_send_event() or
347 * gst_element_send_event().
348 * GST_SEEK_TYPE_NONE
350 public enum GstSeekType
352 /+* one of these +/
353 NONE = 0,
354 CUR = 1,
355 SET = 2,
356 END = 3
357 /*GST_SEEK_TYPE_NONE = 0,
358 GST_SEEK_TYPE_CUR = 1,
359 GST_SEEK_TYPE_SET = 2,
360 GST_SEEK_TYPE_END = 3*/
362 alias GstSeekType SeekType;
365 * Flags to be used with gst_element_seek() or gst_event_new_seek()
366 * A non flushing seek might take some time to perform as the currently
367 * playing data in the pipeline will not be cleared.
368 * An accurate seek might be slower for formats that don't have any indexes
369 * or timestamp markers in the stream. Specifying this flag might require a
370 * complete scan of the file in those cases.
371 * When performing a segment seek: after the playback of the segment completes,
372 * no EOS will be emmited by the element that performed the seek, but a
373 * SEGMENT_DONE message will be posted on the bus by the element. When this
374 * message is posted, it is possible to send a new seek event to continue
375 * playback. With this seek method it is possible to perform seemless looping
376 * or simple linear editing.
377 * GST_SEEK_FLAG_NONE
379 public enum GstSeekFlags
381 NONE = 0,
382 FLUSH = (1 << 0),
383 ACCURATE = (1 << 1),
384 KEY_UNIT = (1 << 2),
385 SEGMENT = (1 << 3)
387 alias GstSeekFlags SeekFlags;
390 * Standard predefined formats
391 * GST_FORMAT_UNDEFINED
393 public enum GstFormat
395 UNDEFINED = 0, /+* must be first inn list +/
396 DEFAULT = 1,
397 BYTES = 2,
398 TIME = 3,
399 BUFFERS = 4,
400 PERCENT = 5
402 alias GstFormat Format;
405 * Core errors are errors inside the core GStreamer library.
406 * GST_CORE_ERROR_FAILED
408 public enum GstCoreError
410 FAILED = 1,
411 TOO_LAZY,
412 NOT_IMPLEMENTED,
413 STATE_CHANGE,
414 PAD,
415 THREAD,
416 NEGOTIATION,
417 EVENT,
418 SEEK,
419 CAPS,
420 TAG,
421 MISSING_PLUGIN,
422 CLOCK,
423 NUM_ERRORS
425 alias GstCoreError CoreError;
428 * Library errors are for errors from the library being used by elements
429 * (initializing, finalizing, settings, ...)
430 * GST_LIBRARY_ERROR_FAILED
432 public enum GstLibraryError
434 FAILED = 1,
435 TOO_LAZY,
436 INIT,
437 SHUTDOWN,
438 SETTINGS,
439 ENCODE,
440 NUM_ERRORS
442 alias GstLibraryError LibraryError;
445 * Resource errors are for any resource used by an element:
446 * memory, files, network connections, process space, ...
447 * They're typically used by source and sink elements.
448 * GST_RESOURCE_ERROR_FAILED
450 public enum GstResourceError
452 FAILED = 1,
453 TOO_LAZY,
454 NOT_FOUND,
455 BUSY,
456 OPEN_READ,
457 OPEN_WRITE,
458 OPEN_READ_WRITE,
459 CLOSE,
460 READ,
461 WRITE,
462 SEEK,
463 SYNC,
464 SETTINGS,
465 NO_SPACE_LEFT,
466 NUM_ERRORS
468 alias GstResourceError ResourceError;
471 * Stream errors are for anything related to the stream being processed:
472 * format errors, media type errors, ...
473 * They're typically used by decoders, demuxers, converters, ...
474 * GST_STREAM_ERROR_FAILED
476 public enum GstStreamError
478 FAILED = 1,
479 TOO_LAZY,
480 NOT_IMPLEMENTED,
481 TYPE_NOT_FOUND,
482 WRONG_TYPE,
483 CODEC_NOT_FOUND,
484 DECODE,
485 ENCODE,
486 DEMUX,
487 MUX,
488 FORMAT,
489 NUM_ERRORS
491 alias GstStreamError StreamError;
494 * The certainty of a group in the index.
495 * GST_INDEX_UNKNOWN
497 public enum GstIndexCertainty
499 UNKNOWN,
500 CERTAIN,
501 FUZZY
503 alias GstIndexCertainty IndexCertainty;
506 * The different types of entries in the index.
507 * GST_INDEX_ENTRY_ID
509 public enum GstIndexEntryType
512 ASSOCIATION,
513 OBJECT,
514 FORMAT
516 alias GstIndexEntryType IndexEntryType;
519 * Specify the method to find an index entry in the index.
520 * GST_INDEX_LOOKUP_EXACT
522 public enum GstIndexLookupMethod
524 EXACT,
525 BEFORE,
526 AFTER
528 alias GstIndexLookupMethod IndexLookupMethod;
531 * Flags for an association entry.
532 * GST_ASSOCIATION_FLAG_NONE
534 public enum GstAssocFlags
536 IATION_FLAG_NONE = 0,
537 IATION_FLAG_KEY_UNIT = (1 << 0),
538 IATION_FLAG_DELTA_UNIT = (1 << 1),
539 /+* new flags should start here +/
540 IATION_FLAG_LAST = (1 << 8)
542 alias GstAssocFlags AssocFlags;
545 * The method used to resolve index writers
546 * GST_INDEX_RESOLVER_CUSTOM
548 public enum GstIndexResolverMethod
550 CUSTOM,
551 GTYPE,
552 PATH
554 alias GstIndexResolverMethod IndexResolverMethod;
557 * Flags for this index
558 * GST_INDEX_WRITABLE
560 public enum GstIndexFlags
562 WRITABLE = (GstObjectFlags.FLAG_LAST << 0),
563 READABLE = (GstObjectFlags.FLAG_LAST << 1),
564 FLAG_LAST = (GstObjectFlags.FLAG_LAST << 8)
566 alias GstIndexFlags IndexFlags;
569 * The result of a GstIteratorItemFunction.
570 * GST_ITERATOR_ITEM_SKIP
572 public enum GstIteratorItem
574 SKIP = 0,
575 PASS = 1,
576 END = 2,
578 alias GstIteratorItem IteratorItem;
581 * The result of gst_iterator_next().
582 * GST_ITERATOR_DONE
584 public enum GstIteratorResult
586 DONE = 0,
587 OK = 1,
588 RESYNC = 2,
589 ERROR = 3,
591 alias GstIteratorResult IteratorResult;
594 * The different message types that are available.
595 * GST_MESSAGE_UNKNOWN
597 public enum GstMessageType
599 UNKNOWN = 0,
600 EOS = (1 << 0),
601 ERROR = (1 << 1),
602 WARNING = (1 << 2),
603 INFO = (1 << 3),
604 TAG = (1 << 4),
605 BUFFERING = (1 << 5),
606 STATE_CHANGED = (1 << 6),
607 STATE_DIRTY = (1 << 7),
608 STEP_DONE = (1 << 8),
609 CLOCK_PROVIDE = (1 << 9),
610 CLOCK_LOST = (1 << 10),
611 NEW_CLOCK = (1 << 11),
612 STRUCTURE_CHANGE = (1 << 12),
613 STREAM_STATUS = (1 << 13),
614 APPLICATION = (1 << 14),
615 ELEMENT = (1 << 15),
616 SEGMENT_START = (1 << 16),
617 SEGMENT_DONE = (1 << 17),
618 DURATION = (1 << 18),
619 ANY = 0xffffffff
621 //alias GstMessageType MessageType;
624 * The direction of a pad.
625 * GST_PAD_UNKNOWN
627 public enum GstPadDirection
629 UNKNOWN,
630 SRC,
631 SINK
633 alias GstPadDirection PadDirection;
636 * Pad state flags
637 * GST_PAD_BLOCKED
639 public enum GstPadFlags
641 BLOCKED = (GstObjectFlags.FLAG_LAST << 0),
642 FLUSHING = (GstObjectFlags.FLAG_LAST << 1),
643 IN_GETCAPS = (GstObjectFlags.FLAG_LAST << 2),
644 IN_SETCAPS = (GstObjectFlags.FLAG_LAST << 3),
645 /+* padding +/
646 FLAG_LAST = (GstObjectFlags.FLAG_LAST << 8)
648 alias GstPadFlags PadFlags;
651 * Result values from gst_pad_link and friends.
652 * GST_PAD_LINK_OK
654 public enum GstPadLinkReturn
656 OK = 0,
657 WRONG_HIERARCHY = -1,
658 WAS_LINKED = -2,
659 WRONG_DIRECTION = -3,
660 NOFORMAT = -4,
661 NOSCHED = -5,
662 REFUSED = -6,
664 alias GstPadLinkReturn PadLinkReturn;
667 * The result of passing data to a linked pad.
668 * GST_FLOW_RESEND
670 public enum GstFlowReturn
672 SEND = 1,
673 GST_FLOW_OK = 0,
674 /+* expected failures +/
675 GST_FLOW_NOT_LINKED = -1,
676 GST_FLOW_WRONG_STATE = -2,
677 /+* error cases +/
678 GST_FLOW_UNEXPECTED = -3,
679 GST_FLOW_NOT_NEGOTIATED = -4,
680 GST_FLOW_ERROR = -5,
681 GST_FLOW_NOT_SUPPORTED = -6
683 alias GstFlowReturn FlowReturn;
686 * The status of a GstPad. After activating a pad, which usually happens when the
687 * parent element goes from READY to PAUSED, the GstActivateMode defines if the
688 * pad operates in push or pull mode.
689 * GST_ACTIVATE_NONE
691 public enum GstActivateMode
693 NONE,
694 PUSH,
695 PULL,
697 alias GstActivateMode ActivateMode;
700 * Flags for the padtemplate
701 * GST_PAD_TEMPLATE_FIXED
703 public enum GstPadTemplateFlags
705 IXED = (GstObjectFlags.FLAG_LAST << 0),
706 /+* padding +/
707 LAG_LAST = (GstObjectFlags.FLAG_LAST << 4)
709 alias GstPadTemplateFlags PadTemplateFlags;
712 * Indicates when this pad will become available.
713 * GST_PAD_ALWAYS
715 public enum GstPadPresence
717 ALWAYS,
718 SOMETIMES,
719 REQUEST
721 alias GstPadPresence PadPresence;
724 * The different parsing errors that can occur.
725 * GST_PARSE_ERROR_SYNTAX
727 public enum GstParseError
729 SYNTAX,
730 NO_SUCH_ELEMENT,
731 NO_SUCH_PROPERTY,
732 LINK,
733 COULD_NOT_SET_PROPERTY,
734 EMPTY_BIN,
735 EMPTY
737 alias GstParseError ParseError;
740 * Pipeline flags
741 * GST_PIPELINE_FLAG_FIXED_CLOCK
743 public enum GstPipelineFlags
745 FIXED_CLOCK = (GstBinFlags.FLAG_LAST << 0),
746 /+* padding +/
747 LAST = (GstBinFlags.FLAG_LAST << 4)
749 alias GstPipelineFlags PipelineFlags;
752 * The plugin loading errors
753 * GST_PLUGIN_ERROR_MODULE
755 public enum GstPluginError
757 MODULE,
758 DEPENDENCIES,
759 NAME_MISMATCH
761 alias GstPluginError PluginError;
764 * Element priority ranks. Defines the order in which the autoplugger (or
765 * similar rank-picking mechanisms) will choose this element over an alternative
766 * one with the same function.
767 * The rank is a unsigned integer ranging from 0 (GST_RANK_NONE) to 256
768 * (GST_RANK_PRIMARY). These constants serve as a rough guidiance for defining
769 * the rank of a GstPlugin using gst_plugin_feature_set_rank().
770 * GST_RANK_NONE
772 public enum GstRank
774 NONE = 0,
775 MARGINAL = 64,
776 SECONDARY = 128,
777 PRIMARY = 256
779 alias GstRank Rank;
782 * Standard predefined Query types
783 * GST_QUERY_NONE
785 public enum GstQueryType
787 NONE = 0,
788 POSITION,
789 DURATION,
790 LATENCY,
791 JITTER, /+* not inn draft-query, necessary? +/
792 RATE,
793 SEEKING,
794 SEGMENT,
795 CONVERT,
796 FORMATS
798 alias GstQueryType QueryType;
801 * The different tag merging modes.
802 * GST_TAG_MERGE_UNDEFINED
804 public enum GstTagMergeMode
806 UNDEFINED,
807 REPLACE_ALL,
808 REPLACE,
809 APPEND,
810 PREPEND,
811 KEEP,
812 KEEP_ALL,
813 /+* add more +/
814 COUNT
816 alias GstTagMergeMode TagMergeMode;
819 * Extra tag flags used when registering tags.
820 * GST_TAG_FLAG_UNDEFINED
822 public enum GstTagFlag
824 FLAG_UNDEFINED,
825 FLAG_META,
826 FLAG_ENCODED,
827 FLAG_DECODED,
828 FLAG_COUNT
830 alias GstTagFlag TagFlag;
833 * The different states a task can be in
834 * GST_TASK_STARTED
836 public enum GstTaskState
838 RTED,
839 GST_TASK_STOPPED,
840 GST_TASK_PAUSED,
842 alias GstTaskState TaskState;
845 * The probability of the typefind function. Higher values have more certainty
846 * in doing a reliable typefind.
847 * GST_TYPE_FIND_MINIMUM
849 public enum GstTypeFindProbability
851 MINIMUM = 1,
852 POSSIBLE = 50,
853 LIKELY = 80,
854 NEARLY_CERTAIN = 99,
855 MAXIMUM = 100
857 alias GstTypeFindProbability TypeFindProbability;
861 * Main Gtk struct.
862 * The GstBin base class. Subclasses can access these fields provided
863 * the LOCK is taken.
864 * gintnumchildren;
866 public struct GstBin;
867 // /+* our children, subclass are supposed to update these
868 // * fields to reflect their state with _Iterate*() +/
869 // int numchildren;
870 // GList *children;
871 // uint childrenCookie;
872 // GstBus *childBus;
873 // GList *messages;
874 // int polling;
875 // int stateDirty;
876 // int clockDirty;
877 // GstClock *providedClock;
878 // GstElement *clockProvider;
882 * Subclasses can override the add_element and remove_element to
883 * update the list of children in the bin.
884 * The handle_message method can be overriden to implement custom
885 * message handling.
886 * GstElementClassparent_class;
888 public struct GstBinClass;
889 // GstElementClass parentClass;
890 // /+* virtual methods for subclasses +/
891 // int (*addElement) (GstBin *bin, GstElement *element);
892 // int (*removeElement) (GstBin *bin, GstElement *element);
893 // void (*handleMessage) (GstBin *bin, GstMessage *message);
897 * Main Gtk struct.
898 * The structure of a GstBuffer. Use the associated macros to access the public
899 * variables.
900 * GstMiniObjectmini_object;
902 public struct GstBuffer;
903 // GstMiniObject miniObject;
904 // /+* pointer to data and its size +/
905 // byte *data;
906 // uint size;
907 // /+* timestamp +/
908 // GstClockTime timestamp;
909 // GstClockTime duration;
910 // /+* the media type of this buffer +/
911 // GstCaps *caps;
912 // /+* media specific offset +/
913 // ulong offset;
914 // ulong offsetEnd;
915 // byte *mallocData;
919 * Main Gtk struct.
920 * The opaque GstBus data structure.
922 public struct GstBus;
926 * Main Gtk struct.
927 * Object describing media types.
928 * GTypetype;
930 //public struct GstCaps;
931 public struct GstCaps
933 GType type;
935 /*< public >*/ /* with COW */
936 /* refcounting */
937 int refcount;//gint
939 /*< public >*/ /* read only */
940 GstCapsFlags flags;
942 /*< private >*/
943 GPtrArray* structs;
945 /*< private >*/
946 gpointer _gst_reserved[GST_PADDING];
949 // GType type;
950 // /+* refcounting +/
951 // int refcount;
952 // GstCapsFlags flags;
956 * Datastructure to initialize GstCaps from a string description usually
957 * used in conjunction with GST_STATIC_CAPS() and gst_static_caps_get() to
958 * instantiate a GstCaps.
959 * GstCapscaps;
961 public struct GstStaticCaps;
962 // GstCaps caps;
963 // char *string;
967 * Main Gtk struct.
969 public struct GstClock;
973 * All pending timeouts or periodic notifies are converted into
974 * an entry.
975 * gintrefcount;
977 public struct GstClockEntry
979 int refcount;
984 * Main Gtk struct.
985 * GStreamer element abstract base class.
986 * GStaticRecMutex*state_lock;
988 public struct GstElement;
989 // GStaticRecMutex *stateLock;
990 // /+* element state +/
991 // GCond *stateCond;
992 // uint stateCookie;
993 // GstState currentState;
994 // GstState nextState;
995 // GstState pendingState;
996 // GstStateChangeReturn lastReturn;
997 // GstBus *bus;
998 // /+* allocated clock +/
999 // GstClock *clock;
1000 // GstClockTimeDiff baseTime; /+* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock +/
1001 // /+* element pads, these lists can only be iterated while holding
1002 // * the LOCK or checking the cookie after each LOCK. +/
1003 // ushort numpads;
1004 // GList *pads;
1005 // ushort numsrcpads;
1006 // GList *srcpads;
1007 // ushort numsinkpads;
1008 // GList *sinkpads;
1009 // uint padsCookie;
1013 * GStreamer element class. Override the vmethods to implement the element
1014 * functionality.
1015 * GstObjectClassparent_class;
1017 public struct GstElementClass;
1018 // GstObjectClass parentClass;
1019 // /+* the element details +/
1020 // GstElementDetails details;
1021 // /+* factory that the element was created from +/
1022 // GstElementFactory *elementfactory;
1023 // /+* templates for our pads +/
1024 // GList *padtemplates;
1025 // int numpadtemplates;
1026 // uint padTemplCookie;
1027 // /+* virtual methods for subclasses +/
1028 // /+* request/release pads +/
1029 // GstPad* (*requestNewPad) (GstElement *element, GstPadTemplate *templ, char* name);
1030 // void (*releasePad) (GstElement *element, GstPad *pad);
1031 // /+* state changes +/
1032 // GstStateChangeReturn (*getState) (GstElement * element, GstState * state,
1033 // GstState * pending, GstClockTime timeout);
1034 // GstStateChangeReturn (*setState) (GstElement *element, GstState state);
1035 // GstStateChangeReturn (*changeState) (GstElement *element, GstStateChange transition);
1036 // /+* bus +/
1037 // void (*setBus) (GstElement * element, GstBus * bus);
1038 // /+* set/get clocks +/
1039 // GstClock* (*provideClock) (GstElement *element);
1040 // int (*setClock) (GstElement *element, GstClock *clock);
1041 // /+* index +/
1042 // GstIndex* (*getIndex) (GstElement *element);
1043 // void (*setIndex) (GstElement *element, GstIndex *index);
1044 // /+* query functions +/
1045 // int (*sendEvent) (GstElement *element, GstEvent *event);
1046 // GstQueryType* (*getQueryTypes) (GstElement *element);
1047 // int (*query) (GstElement *element, GstQuery *query);
1051 * Main Gtk struct.
1052 * The opaque GstElementFactory data structure.
1054 public struct GstElementFactory;
1058 * This struct defines the public information about a GstElement. It contains
1059 * meta-data about the element that is mostly for the benefit of editors.
1060 * The klass member can be used by applications to filter elements based
1061 * on functionality.
1062 * gchar*longname;
1064 public struct GstElementDetails
1066 char *longname;
1067 char *klass;
1068 char *description;
1069 char *author;
1073 * Main Gtk struct.
1074 * A GstEvent.
1075 * GstMiniObjectmini_object;
1077 public struct GstEvent;
1079 GstMiniObject miniObject;
1080 GstEventType type;
1081 ulong timestamp;
1082 GstObject *src;
1083 GstStructure *structure;
1088 * A format definition
1089 * GstFormatvalue;
1091 public struct GstFormatDefinition;
1092 // GstFormat value;
1093 // char *nick;
1094 // char *description;
1095 // GQuark quark;
1099 * Main Gtk struct.
1100 * Opaque GstGhostPad structure.
1102 public struct GstGhostPad;
1106 * Main Gtk struct.
1107 * Opaque GstIndex structure.
1109 public struct GstIndex;
1113 * The basic element of an index.
1115 public struct GstIndexEntry;
1119 * A group of related entries in an index.
1121 public struct GstIndexGroup;
1125 * An association in an entry.
1126 * GstFormatformat;
1128 public struct GstIndexAssociation;
1129 // GstFormat format;
1130 // long value;
1134 * Main Gtk struct.
1135 * The GstIndexFactory object
1137 public struct GstIndexFactory;
1141 * Main Gtk struct.
1142 * GstIterator base structure. The values of this structure are
1143 * protected for subclasses, use the methods to use the GstIterator.
1145 public struct GstIterator;
1148 * Main Gtk struct.
1149 * Base class for refcounted lightweight objects.
1150 * GTypeInstanceinstance;
1152 public struct GstMiniObject
1154 GTypeInstance instanc;
1155 //< public >// with COW
1156 int refcount;//gint refcount;
1157 uint flags;//guint flags;
1159 //< private >
1160 gpointer _gst_reserved;
1165 * Main Gtk struct.
1166 * GStreamer base object class.
1167 * gintrefcount;
1169 public struct GstObject;
1170 // int refcount;
1171 // GMutex *lock; /+* object LOCK +/
1172 // char *name; /+* object name +/
1173 // char *namePrefix; /+* used for debugging +/
1174 // GstObject *parent; /+* this object's parent, weak ref +/
1175 // uint flags;
1179 * Main Gtk struct.
1180 * The GstPad structure. Use the functions to update the variables.
1181 * gpointerelement_private;
1183 public struct GstPad;
1184 // void* elementPrivate;
1185 // GstPadTemplate *padtemplate;
1186 // GstPadDirection direction;
1187 // /+* streaming recLock +/
1188 // GStaticRecMutex *streamRecLock;
1189 // GstTask *task;
1190 // GMutex *prerollLock;
1191 // GCond *prerollCond;
1192 // /+* block cond, mutex is from the object +/
1193 // GCond *blockCond;
1194 // GstPadBlockCallback blockCallback;
1195 // void* blockData;
1196 // /+* the pad capabilities +/
1197 // GstCaps *caps;
1198 // GstPadGetCapsFunction getcapsfunc;
1199 // GstPadSetCapsFunction setcapsfunc;
1200 // GstPadAcceptCapsFunction acceptcapsfunc;
1201 // GstPadFixateCapsFunction fixatecapsfunc;
1202 // GstPadActivateFunction activatefunc;
1203 // GstPadActivateModeFunction activatepushfunc;
1204 // GstPadActivateModeFunction activatepullfunc;
1205 // /+* pad link +/
1206 // GstPadLinkFunction linkfunc;
1207 // GstPadUnlinkFunction unlinkfunc;
1208 // GstPad *peer;
1209 // void* schedPrivate;
1210 // /+* data transport functions +/
1211 // GstPadChainFunction chainfunc;
1212 // GstPadCheckGetRangeFunction checkgetrangefunc;
1213 // GstPadGetRangeFunction getrangefunc;
1214 // GstPadEventFunction eventfunc;
1215 // GstActivateMode mode;
1216 // /+* generic query method +/
1217 // GstPadQueryTypeFunction querytypefunc;
1218 // GstPadQueryFunction queryfunc;
1219 // /+* internal links +/
1220 // GstPadIntLinkFunction intlinkfunc;
1221 // GstPadBufferAllocFunction bufferallocfunc;
1222 // /+* whether to emit signals for have-data. counts number
1223 // * of handlers attached. +/
1224 // int doBufferSignals;
1225 // int doEventSignals;
1229 * Structure describing the GstStaticPadTemplate.
1230 * gchar*name_template;
1232 public struct GstStaticPadTemplate;
1233 // char *nameTemplate;
1234 // GstPadDirection direction;
1235 // GstPadPresence presence;
1236 // GstStaticCaps staticCaps;
1240 * Main Gtk struct.
1241 * The padtemplate object.
1243 public struct GstPadTemplate;
1247 * Main Gtk struct.
1248 * The GstPipeline structure.
1249 * GstClock*fixed_clock;
1251 public struct GstPipeline;
1252 // GstClock *fixedClock; /+* fixed clock if any +/
1253 // GstClockTime streamTime;
1254 // GstClockTime delay;
1258 * Main Gtk struct.
1259 * The plugin object
1261 public struct GstPlugin;
1265 * A plugins should export a variable of this type called plugin_desc. This plugin
1266 * loaded will use this variable to initialize the plugin.
1267 * gintmajor_version;
1269 public struct GstPluginDesc;
1270 // int majorVersion;
1271 // int minorVersion;
1272 // char *name;
1273 // char *description;
1274 // GstPluginInitFunc pluginInit;
1275 // char *versio;
1276 // char *license;
1277 // char *source;
1278 // char *p;
1279 // char *origin;
1280 // void* _GstReserved[GST_PADDING];
1284 * Main Gtk struct.
1285 * Opaque GstPluginFeature structure.
1287 public struct GstPluginFeature;
1291 * Structure used for filtering based on name and type.
1292 * constgchar*name;
1294 public struct GstTypeNameData;
1295 // char *name;
1296 // GType type;
1300 * Main Gtk struct.
1301 * The GstQuery structure.
1302 * GstMiniObjectmini_object;
1304 public struct GstQuery;
1305 // GstMiniObject miniObject;
1306 // GstQueryType type;
1307 // GstStructure *structure;
1311 * A Query Type definition
1312 * GstQueryTypevalue;
1314 public struct GstQueryTypeDefinition;
1315 // GstQueryType value;
1316 // char *nick;
1317 // char *description;
1318 // GQuark quark;
1322 * Main Gtk struct.
1323 * Opaque GstRegistry structure.
1325 public struct GstRegistry;
1329 * Main Gtk struct.
1330 * A helper structure that holds the configured region of
1331 * interest in a media file.
1332 * gdoublerate;
1334 public struct GstSegment;
1335 // double rate;
1336 // double absRate;
1337 // GstFormat format;
1338 // GstSeekFlags flags;
1339 // long start;
1340 // long stop;
1341 // long time;
1342 // long accum;
1343 // long lastStop;
1344 // long duration;
1345 // /+* API added 0.10.6 +/
1346 // double appliedRate;
1350 * Main Gtk struct.
1351 * The GstStructure object. Most fields are private.
1352 * GTypetype;
1354 public struct GstStructure;
1355 // GType type;
1358 * Main Gtk struct.
1359 * A GstMessage.
1360 * GstMiniObjectmini_object;
1362 /*public struct GstMessage
1364 GstMiniObject mini_object;
1366 GstMessageType type;
1367 //int type;
1368 ulong timestamp;
1369 GstObject* src;
1371 GstStructure* structure;
1374 public struct GstMessage
1376 GstMiniObject mini_object;
1378 GstMessageType type;
1379 long timestamp;
1380 GstObject *src;
1382 GstStructure *structure;
1386 struct GstMessage
1388 GstMiniObject mini_object;
1390 /*< private > *//* with MESSAGE_LOCK */
1391 GMutex* lock; /* lock and cond for async delivery */
1392 GCond* cond;
1394 /*< public > *//* with COW */
1395 GstMessageType type;
1396 ulong timestamp;//guint64 timestamp;
1397 GstObject* src;
1399 GstStructure* structure;
1401 /*< private > */
1402 gpointer _gst_reserved[GST_PADDING];
1406 * Main Gtk struct.
1407 * The default implementation of a GstClock that uses the system time.
1409 public struct GstSystemClock;
1413 * Main Gtk struct.
1414 * Opaque GstTagSetter data structure.
1416 public struct GstTagSetter;
1420 * GstTagSetterIFace interface.
1421 * GTypeInterfaceg_iface;
1423 public struct GstTagSetterIFace;
1424 // GTypeInterface gIface;
1425 // /+* signals +/
1426 // /+* virtual table +/
1430 * Main Gtk struct.
1431 * The GstTask object.
1432 * GstTaskStatestate;
1434 public struct GstTask;
1435 // GstTaskState state;
1436 // GCond *cond;
1437 // GStaticRecMutex *lock;
1438 // GstTaskFunction func;
1439 // void* data;
1440 // int running;
1444 * Main Gtk struct.
1445 * Object that stores typefind callbacks. To use with GstTypeFindFactory.
1446 * peek()
1448 public struct GstTypeFind;
1449 // /+* private to the caller of the typefind funct +/
1450 // byte * (* peek) (void* data,
1451 // long offset,
1452 // uint size);
1453 // void (* suggest) (void* data,
1454 // uint probability,
1455 // GstCaps * caps);
1456 // void* data;
1457 // /+* optional +/
1458 // ulong (* getLength) (void* data);
1462 * Main Gtk struct.
1463 * Object that stores information about a typefind function.
1465 public struct GstTypeFindFactory;
1469 * Main Gtk struct.
1470 * XML parser object
1472 public struct GstXML;
1476 * Gets the list with children in a bin.
1477 * bin:
1478 * a GstBin
1480 // TODO
1481 // #define GST_BIN_CHILDREN(bin) (GST_BIN_CAST(bin)->children)
1484 * Gets the children cookie that watches the children list.
1485 * bin:
1486 * a GstBin
1488 // TODO
1489 // #define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie)
1492 * Gets the number of children in a bin.
1493 * bin:
1494 * a GstBin
1495 * Signal Details
1496 * The "element-added" signal
1497 * void user_function (GstBin *bin,
1498 * GstElement *element,
1499 * gpointer user_data) : Run first
1500 * Will be emitted after the element was added to the bin.
1501 * bin:
1502 * the GstBin
1503 * element:
1504 * the GstElement that was added to the bin
1505 * user_data:
1506 * user data set when the signal handler was connected.
1508 // TODO
1509 // #define GST_BIN_NUMCHILDREN(bin) (GST_BIN_CAST(bin)->numchildren)
1512 * A flags word containing GstBufferFlag flags set on this buffer.
1513 * buf:
1514 * a GstBuffer.
1516 // TODO
1517 // #define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
1520 * Gives the status of a specific flag on a buffer.
1521 * buf:
1522 * a GstBuffer.
1523 * flag:
1524 * the GstBufferFlag to check.
1526 // TODO
1527 // #define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
1530 * Sets a buffer flag on a buffer.
1531 * buf:
1532 * a GstBuffer.
1533 * flag:
1534 * the GstBufferFlag to set.
1536 // TODO
1537 // #define GST_BUFFER_FLAG_SET(buf,flag) GST_MINI_OBJECT_FLAG_SET (buf, flag)
1540 * Clears a buffer flag.
1541 * buf:
1542 * a GstBuffer.
1543 * flag:
1544 * the GstBufferFlag to clear.
1546 // TODO
1547 // #define GST_BUFFER_FLAG_UNSET(buf,flag) GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
1550 * A pointer to the data element of this buffer.
1551 * buf:
1552 * a GstBuffer.
1554 // TODO
1555 // #define GST_BUFFER_DATA(buf) (GST_BUFFER_CAST(buf)->data)
1558 * A pointer to any data allocated for this buffer using malloc(). If this is
1559 * non-NULL, this memory will be freed at the end of the buffer's lifecycle
1560 * (i.e. when its refcount becomes zero).
1561 * buf:
1562 * a GstBuffer.
1564 // TODO
1565 // #define GST_BUFFER_MALLOCDATA(buf) (GST_BUFFER_CAST(buf)->malloc_data)
1568 * The size in bytes of the data in this buffer.
1569 * buf:
1570 * a GstBuffer.
1572 // TODO
1573 // #define GST_BUFFER_SIZE(buf) (GST_BUFFER_CAST(buf)->size)
1576 * The timestamp in nanoseconds (as a GstClockTime) of the data in the buffer.
1577 * Value will be GST_CLOCK_TIME_NONE if the timestamp is unknown.
1578 * buf:
1579 * a GstBuffer.:
1581 // TODO
1582 // #define GST_BUFFER_TIMESTAMP(buf) (GST_BUFFER_CAST(buf)->timestamp)
1585 * The duration in nanoseconds (as a GstClockTime) of the data in the buffer.
1586 * Value will be GST_CLOCK_TIME_NONE if the duration is unknown.
1587 * buf:
1588 * a GstBuffer.
1590 // TODO
1591 // #define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
1594 * The caps for this buffer.
1595 * buf:
1596 * a GstBuffer.
1598 // TODO
1599 // #define GST_BUFFER_CAPS(buf) (GST_BUFFER_CAST(buf)->caps)
1602 * The offset in the source file of the beginning of this buffer.
1603 * buf:
1604 * a GstBuffer.
1606 // TODO
1607 // #define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
1610 * The offset in the source file of the end of this buffer.
1611 * buf:
1612 * a GstBuffer.
1614 // TODO
1615 // #define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
1618 * Tests if the duration is known.
1619 * buffer:
1620 * a GstBuffer
1622 // TODO
1623 // #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
1626 * Tests if the timestamp is known.
1627 * buffer:
1628 * a GstBuffer
1630 // TODO
1631 // #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
1634 * Tests if the start offset is known.
1635 * buffer:
1636 * a GstBuffer
1638 // TODO
1639 // #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
1642 * Tests if the end offset is known.
1643 * buffer:
1644 * a GstBuffer
1646 // TODO
1647 // #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
1650 * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
1651 * will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
1652 * also be freed at this time.
1653 * buf:
1654 * a GstBuffer.
1656 // TODO
1657 // #define gst_buffer_unref(buf) gst_mini_object_unref (GST_MINI_OBJECT (buf))
1660 * A convenience function to set the data and size on a buffer.
1661 * This will replace any existing data pointer set on this buffer, but will
1662 * not change GST_BUFFER_MALLOCDATA(), if any. Callers should ensure that
1663 * GST_BUFFER_MALLOCDATA() is non-NULL, or should free that and set it to NULL.
1664 * No checks are done on the data or size arguments passed.
1665 * buf:
1666 * a GstBuffer
1667 * data:
1668 * The data (a guint8 *) to set on the buffer.
1669 * size:
1670 * The size (in bytes, as a guint) of the data being set.
1672 // TODO
1673 // #define gst_buffer_set_data(buf, data, size)
1676 * Create a copy of the given buffer. This will also make a newly allocated
1677 * copy of the data the source buffer contains.
1678 * buf:
1679 * a GstBuffer.
1681 // TODO
1682 // #define gst_buffer_copy(buf) GST_BUFFER_CAST (gst_mini_object_copy (GST_MINI_OBJECT (buf)))
1685 * Tests if you can safely write data into a buffer's data array or validly
1686 * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
1687 * writable, but it is only safe to change it when there is only one owner
1688 * of the buffer - ie, the refcount is 1.
1689 * buf:
1690 * a GstBuffer
1692 // TODO
1693 // #define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT (buf))
1696 * Makes a writable buffer from the given buffer. If the source buffer is
1697 * already writable, this will simply return the same buffer. A copy will
1698 * otherwise be made using gst_buffer_copy().
1699 * buf:
1700 * a GstBuffer
1702 // TODO
1703 // #define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT (buf)))
1706 * Modifies a pointer to a Gstbuffer to point to a different GstBuffer. The
1707 * modification is done atomically (so this is useful for ensuring thread safety
1708 * in some cases), and the reference counts are updated appropriately (the old
1709 * buffer is unreffed, the new is reffed).
1710 * Either nbuf or the GstBuffer pointed to by obuf may be NULL.
1711 * obuf:
1712 * pointer to a pointer to a GstBuffer to be replaced.
1713 * nbuf:
1714 * pointer to a GstBuffer that will replace the buffer pointed to by
1715 * obuf.
1717 // TODO
1718 // #define gst_buffer_replace(obuf,nbuf) gst_mini_object_replace ((GstMiniObject **)(obuf), GST_MINI_OBJECT (nbuf))
1721 * Get access to the reference count field of the caps
1722 * caps:
1723 * a GstCaps
1725 // TODO
1726 // #define GST_CAPS_REFCOUNT(caps) ((GST_CAPS(caps))->refcount)
1729 * Get the reference count value of the caps.
1730 * caps:
1731 * a GstCaps
1733 // TODO
1734 // #define GST_CAPS_REFCOUNT_VALUE(caps) (g_atomic_int_get ((GST_CAPS(caps))->refcount))
1737 * Convenience macro that checks if the number of structures in the given caps
1738 * is exactly one.
1739 * caps:
1740 * the GstCaps instance to check
1742 // TODO
1743 // #define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1)
1746 * Warning
1747 * GST_DEBUG_CAPS is deprecated and should not be used in newly-written code. do not use anymore
1748 * Convenience macro for printing out the contents of caps with GST_DEBUG().
1749 * string:
1750 * a string that should be prepended to the caps data.
1751 * caps:
1752 * the GstCaps instance to print
1754 // TODO
1755 // #define GST_DEBUG_CAPS(string, caps)
1758 * Creates a new GstCaps static caps from an input string.
1759 * This can be used in pad templates.
1760 * string:
1761 * the string describing the caps
1763 // TODO
1764 // #define GST_STATIC_CAPS(string)
1767 * Tests if a given GstClockTime represents a valid defined time.
1768 * time:
1769 * clock time to validate
1771 // TODO
1772 // #define GST_CLOCK_TIME_IS_VALID(time) (((GstClockTime)(time)) != GST_CLOCK_TIME_NONE)
1775 * Calculate a difference between two clock times as a GstClockTimeDiff.
1776 * The difference is calculated as e - s.
1777 * s:
1778 * the first time
1779 * e:
1780 * the second time
1782 // TODO
1783 // #define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((e) - (s))
1786 * Convert a GTimeVal to a GstClockTime.
1787 * tv:
1788 * the timeval to convert
1790 // TODO
1791 // #define GST_TIMEVAL_TO_TIME(tv) ((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
1794 * Note: on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds,
1795 * which is about 68 years. Expect trouble if you want to schedule stuff
1796 * in your pipeline for 2038.
1797 * Convert a GstClockTime to a GTimeVal
1798 * t:
1799 * The GstClockTime to convert
1800 * tv:
1801 * The target timeval
1803 // TODO
1804 // #define GST_TIME_TO_TIMEVAL(t,tv)
1807 * Convert a struct timespec (see man pselect) to a GstClockTime.
1808 * ts:
1809 * the timespec to convert
1811 // TODO
1812 // #define GST_TIMESPEC_TO_TIME(ts) ((ts).tv_sec * GST_SECOND + (ts).tv_nsec * GST_NSECOND)
1815 * Convert a GstClockTime to a struct timespec (see man pselect)
1816 * t:
1817 * The GstClockTime to convert
1818 * ts:
1819 * The target timespec
1821 // TODO
1822 // #define GST_TIME_TO_TIMESPEC(t,ts)
1825 * Cast to a clock entry
1826 * entry:
1827 * the entry to cast
1829 // TODO
1830 // #define GST_CLOCK_ENTRY(entry) ((GstClockEntry *)(entry))
1833 * Get the owner clock of the entry
1834 * entry:
1835 * the entry to query
1837 // TODO
1838 // #define GST_CLOCK_ENTRY_CLOCK(entry) ((entry)->clock)
1841 * Get the type of the clock entry
1842 * entry:
1843 * the entry to query
1845 // TODO
1846 // #define GST_CLOCK_ENTRY_TYPE(entry) ((entry)->type)
1849 * Get the requested time of this entry
1850 * entry:
1851 * the entry to query
1853 // TODO
1854 // #define GST_CLOCK_ENTRY_TIME(entry) ((entry)->time)
1857 * Get the interval of this periodic entry
1858 * entry:
1859 * the entry to query
1861 // TODO
1862 // #define GST_CLOCK_ENTRY_INTERVAL(entry) ((entry)->interval)
1865 * The status of the entry
1866 * entry:
1867 * the entry to query
1869 // TODO
1870 // #define GST_CLOCK_ENTRY_STATUS(entry) ((entry)->status)
1873 * Gets the GstClockFlags clock flags.
1874 * clock:
1875 * the clock to query
1877 // TODO
1878 // #define GST_CLOCK_FLAGS(clock) (GST_CLOCK(clock)->flags)
1881 * Signal that the entries in the clock have changed.
1882 * clock:
1883 * the clock to broadcast
1885 // TODO
1886 // #define GST_CLOCK_BROADCAST(clock) g_cond_broadcast(GST_CLOCK_COND(clock))
1889 * Gets the GCond that gets signaled when the entries of the clock
1890 * changed.
1891 * clock:
1892 * the clock to query
1894 // TODO
1895 // #define GST_CLOCK_COND(clock) (GST_CLOCK_CAST(clock)->entries_changed)
1898 * Wait on the clock until the entries changed or the specified timeout
1899 * occured.
1900 * clock:
1901 * the clock to wait on
1902 * tv:
1903 * a GTimeVal to wait.
1905 // TODO
1906 // #define GST_CLOCK_TIMED_WAIT(clock,tv) g_cond_timed_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock),tv)
1909 * Wait on the clock until the entries changed.
1910 * clock:
1911 * the clock to wait on
1913 // TODO
1914 // #define GST_CLOCK_WAIT(clock) g_cond_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock))
1917 * This macro returns the current GstState of the element.
1918 * elem:
1919 * a GstElement to return state for.
1921 // TODO
1922 // #define GST_STATE(elem) (GST_ELEMENT_CAST(elem)->current_state)
1925 * Given a current state cur and a target state pending, calculate the next (intermediate)
1926 * GstState.
1927 * cur:
1928 * A starting GstState
1929 * pending:
1930 * A target GstState
1932 // TODO
1933 // #define GST_STATE_GET_NEXT(cur,pending) ((cur) + __GST_SIGN ((gint)(pending) - (gint)(cur)))
1936 * This macro returns the next GstState of the element.
1937 * elem:
1938 * a GstElement to return the next state for.
1940 // TODO
1941 // #define GST_STATE_NEXT(elem) (GST_ELEMENT_CAST(elem)->next_state)
1944 * This macro returns the currently pending GstState of the element.
1945 * elem:
1946 * a GstElement to return the pending state for.
1948 // TODO
1949 // #define GST_STATE_PENDING(elem) (GST_ELEMENT_CAST(elem)->pending_state)
1952 * This macro returns the last GstStateChangeReturn value.
1953 * elem:
1954 * a GstElement to return the last state result for.
1956 // TODO
1957 // #define GST_STATE_RETURN(elem) (GST_ELEMENT_CAST(elem)->last_return)
1960 * Given a current state cur and a next state next, calculate the associated
1961 * GstStateChange transition.
1962 * cur:
1963 * A current state
1964 * next:
1965 * A next state
1967 // TODO
1968 // #define GST_STATE_TRANSITION(cur,next) (((cur)<<3)|(next))
1971 * Given a state transition trans, extract the current GstState.
1972 * trans:
1973 * A GstStateChange
1975 // TODO
1976 // #define GST_STATE_TRANSITION_CURRENT(trans) ((trans)>>3)
1979 * Given a state transition trans, extract the next GstState.
1980 * trans:
1981 * A GstStateChange
1983 // TODO
1984 // #define GST_STATE_TRANSITION_NEXT(trans) ((trans)0x7)
1987 * Get a reference to the state lock of elem.
1988 * This lock is used by the core. It is taken while getting or setting
1989 * the state, during state changes, and while finalizing.
1990 * elem:
1991 * a GstElement
1993 // TODO
1994 // #define GST_STATE_GET_LOCK(elem) (GST_ELEMENT_CAST(elem)->state_lock)
1997 * Get the conditional used to signal the completion of a state change.
1998 * elem:
1999 * a GstElement
2001 // TODO
2002 // #define GST_STATE_GET_COND(elem) (GST_ELEMENT_CAST(elem)->state_cond)
2005 * Gets the name of this element. Use only in core as this is not
2006 * ABI-compatible. Others use gst_element_get_name()
2007 * elem:
2008 * A GstElement to query
2010 // TODO
2011 // #define GST_ELEMENT_NAME(elem) (GST_OBJECT_NAME(elem))
2014 * Get the parent object of this element.
2015 * elem:
2016 * A GstElement to query
2018 // TODO
2019 // #define GST_ELEMENT_PARENT(elem) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
2022 * Get the message bus of this element.
2023 * elem:
2024 * A GstElement to query
2026 // TODO
2027 // #define GST_ELEMENT_BUS(elem) (GST_ELEMENT_CAST(elem)->bus)
2030 * Get the clock of this element
2031 * elem:
2032 * A GstElement to query
2034 // TODO
2035 // #define GST_ELEMENT_CLOCK(elem) (GST_ELEMENT_CAST(elem)->clock)
2038 * Get the pads of this elements.
2039 * elem:
2040 * A GstElement to query
2042 // TODO
2043 // #define GST_ELEMENT_PADS(elem) (GST_ELEMENT_CAST(elem)->pads)
2046 * Utility function that elements can use in case they encountered a fatal
2047 * data processing error. The pipeline will throw an error signal and the
2048 * application will be requested to stop further media processing.
2049 * el:
2050 * the element that throws the error
2051 * domain:
2052 * like CORE, LIBRARY, RESOURCE or STREAM (see GstGError)
2053 * code:
2054 * error code defined for that domain (see GstGError)
2055 * text:
2056 * the message to display (format string and args enclosed in
2057 * parentheses)
2058 * debug:
2059 * debugging information for the message (format string and args
2060 * enclosed in parentheses)
2062 // TODO
2063 // #define GST_ELEMENT_ERROR(el, domain, code, text, debug)
2066 * Utility function that elements can use in case they encountered a non-fatal
2067 * data processing problem. The pipeline will throw a warning signal and the
2068 * application will be informed.
2069 * el:
2070 * the element that throws the error
2071 * domain:
2072 * like CORE, LIBRARY, RESOURCE or STREAM (see GstGError)
2073 * code:
2074 * error code defined for that domain (see GstGError)
2075 * text:
2076 * the message to display (format string and args enclosed in
2077 * parentheses)
2078 * debug:
2079 * debugging information for the message (format string and args
2080 * enclosed in parentheses)
2082 // TODO
2083 // #define GST_ELEMENT_WARNING(el, domain, code, text, debug)
2086 * Check if the element is in the locked state and therefore will ignore state
2087 * changes from its parent object.
2088 * elem:
2089 * A GstElement to query
2091 // TODO
2092 // #define GST_ELEMENT_IS_LOCKED_STATE(elem) (GST_OBJECT_FLAG_IS_SET(elem,GST_ELEMENT_LOCKED_STATE))
2095 * Sets the name of the element, getting rid of the old name if there was one.
2096 * elem:
2097 * a GstElement to set the name of.
2098 * name:
2099 * the new name
2101 // TODO
2102 // #define gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT_CAST(elem),name)
2105 * Gets the name of the element.
2106 * elem:
2107 * a GstElement to set the name of.
2109 // TODO
2110 // #define gst_element_get_name(elem) gst_object_get_name(GST_OBJECT_CAST(elem))
2113 * Sets the parent of an element.
2114 * elem:
2115 * a GstElement to set the parent of.
2116 * parent:
2117 * the new parent GstObject of the element.
2119 // TODO
2120 // #define gst_element_set_parent(elem,parent) gst_object_set_parent(GST_OBJECT_CAST(elem),parent)
2123 * Gets the parent of an element.
2124 * elem:
2125 * a GstElement to get the parent of.
2127 // TODO
2128 // #define gst_element_get_parent(elem) gst_object_get_parent(GST_OBJECT_CAST(elem))
2131 * Macro to initialize GstElementDetails.
2132 * longname:
2133 * long, english name
2134 * klass:
2135 * type of element, as hierarchy
2136 * description:
2137 * what the element is about
2138 * author:
2139 * who wrote this thing?
2141 // TODO
2142 // #define GST_ELEMENT_DETAILS(longname,klass,description,author)
2145 * Tests if element details are initialized.
2146 * details:
2147 * the GstElementDetails to check
2149 // TODO
2150 // #define GST_IS_ELEMENT_DETAILS(details)
2153 * Get the GstEventType of the event.
2154 * event:
2155 * the event to query
2157 // TODO
2158 // #define GST_EVENT_TYPE(event) (GST_EVENT_CAST(event)->type)
2161 * Get a constant string representation of the GstEventType of the event.
2162 * event:
2163 * the event to query
2165 // TODO
2166 // #define GST_EVENT_TYPE_NAME(event) (gst_event_type_get_name(GST_EVENT_TYPE(event)))
2169 * Get the GstClockTime timestamp of the event. This is the time when the event
2170 * was created.
2171 * event:
2172 * the event to query
2174 // TODO
2175 // #define GST_EVENT_TIMESTAMP(event) (GST_EVENT_CAST(event)->timestamp)
2178 * The source GstObject that generated this event.
2179 * event:
2180 * the event to query
2182 // TODO
2183 // #define GST_EVENT_SRC(event) (GST_EVENT_CAST(event)->src)
2186 * Check if an event can travel downstream.
2187 * ev:
2188 * the event to query
2190 // TODO
2191 // #define GST_EVENT_IS_DOWNSTREAM(ev) !!(GST_EVENT_TYPE (ev) GST_EVENT_TYPE_DOWNSTREAM)
2194 * Check if an event is serialized with the data stream.
2195 * ev:
2196 * the event to query
2198 // TODO
2199 // #define GST_EVENT_IS_SERIALIZED(ev) !!(GST_EVENT_TYPE (ev) GST_EVENT_TYPE_SERIALIZED)
2202 * Check if an event can travel upstream.
2203 * ev:
2204 * the event to query
2206 // TODO
2207 // #define GST_EVENT_IS_UPSTREAM(ev) !!(GST_EVENT_TYPE (ev) GST_EVENT_TYPE_UPSTREAM)
2210 * when making custom event types, use this macro with the num and
2211 * the given flags
2212 * num:
2213 * the event number to create
2214 * flags:
2215 * the event flags
2217 // TODO
2218 // #define GST_EVENT_MAKE_TYPE(num,flags)
2220 int GST_EVENT_TYPE_SHIFT = 4;
2223 * GST_EVENT_MAKE_TYPE:
2224 * @num: the event number to create
2225 * @flags: the event flags
2227 * when making custom event types, use this macro with the num and
2228 * the given flags
2230 int GST_EVENT_MAKE_TYPE( int num, int flags )
2232 return (((num) << GST_EVENT_TYPE_SHIFT) | (flags));
2236 * Copy the event using the event specific copy function.
2237 * ev:
2238 * The event to copy
2240 // TODO
2241 // #define gst_event_copy(ev) GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT (ev)))
2244 * Decrease the refcount of an event, freeing it if the refcount reaches 0.
2245 * ev:
2246 * The event to refcount
2248 // TODO
2249 // #define gst_event_unref(ev) gst_mini_object_unref (GST_MINI_OBJECT (ev))
2252 * Modifies a pointer to a GstEvent to point to a different GstEvent. The
2253 * modification is done atomically (so this is useful for ensuring thread safety
2254 * in some cases), and the reference counts are updated appropriately (the old
2255 * event is unreffed, the new one is reffed).
2256 * Either new_event or the GstEvent pointed to by old_event may be NULL.
2257 * old_event:
2258 * pointer to a pointer to a GstEvent to be replaced.
2259 * new_event:
2260 * pointer to a GstEvent that will replace the event pointed to
2261 * by old_event.
2262 * Since 0.10.3
2264 // TODO
2265 // #define gst_event_replace(old_event,new_event)
2268 * Get the number of associations in the entry.
2269 * entry:
2270 * The entry to query
2272 // TODO
2273 // #define GST_INDEX_NASSOCS(entry) ((entry)->data.assoc.nassocs)
2276 * Get the flags for this entry.
2277 * entry:
2278 * The entry to query
2280 // TODO
2281 // #define GST_INDEX_ASSOC_FLAGS(entry) ((entry)->data.assoc.flags)
2284 * Get the i-th format of the entry.
2285 * entry:
2286 * The entry to query
2287 * i:
2288 * The format index
2290 // TODO
2291 // #define GST_INDEX_ASSOC_FORMAT(entry,i) ((entry)->data.assoc.assocs[(i)].format)
2294 * Get the i-th value of the entry.
2295 * entry:
2296 * The entry to query
2297 * i:
2298 * The value index
2300 // TODO
2301 // #define GST_INDEX_ASSOC_VALUE(entry,i) ((entry)->data.assoc.assocs[(i)].value)
2304 * Get the format of the format entry
2305 * entry:
2306 * The entry to query
2308 // TODO
2309 // #define GST_INDEX_FORMAT_FORMAT(entry) ((entry)->data.format.format)
2312 * Get the key of the format entry
2313 * entry:
2314 * The entry to query
2316 // TODO
2317 // #define GST_INDEX_FORMAT_KEY(entry) ((entry)->data.format.key)
2320 * Get the description of the id entry
2321 * entry:
2322 * The entry to query
2324 // TODO
2325 // #define GST_INDEX_ID_DESCRIPTION(entry) ((entry)->data.id.description)
2328 * Check if the index can be read from
2329 * obj:
2330 * The index to check
2332 // TODO
2333 // #define GST_INDEX_IS_READABLE(obj) (GST_OBJECT_FLAG_IS_SET (obj, GST_INDEX_READABLE))
2336 * Check if the index can be written to
2337 * obj:
2338 * The index to check
2340 // TODO
2341 // #define GST_INDEX_IS_WRITABLE(obj) (GST_OBJECT_FLAG_IS_SET (obj, GST_INDEX_WRITABLE))
2344 * Macro to cast to a GstIterator
2345 * it:
2346 * the GstIterator value
2348 // TODO
2349 // #define GST_ITERATOR(it) ((GstIterator*)(it))
2352 * Macro to get the lock protecting the datastructure being iterated.
2353 * it:
2354 * the GstIterator to get the lock of
2356 // TODO
2357 // #define GST_ITERATOR_LOCK(it) (GST_ITERATOR(it)->lock)
2360 * Macro to get the cookie of a GstIterator. The cookie of the
2361 * iterator is the value of the master cookie when the iterator
2362 * was created.
2363 * Whenever the iterator is iterated, the value is compared to the
2364 * value of the master cookie. If they are different, a concurrent
2365 * modification happened to the iterator and a resync is needed.
2366 * it:
2367 * the GstIterator to get the cookie of
2369 // TODO
2370 // #define GST_ITERATOR_COOKIE(it) (GST_ITERATOR(it)->cookie)
2373 * Macro to get a pointer to where the master cookie is stored. The
2374 * master cookie protects the structure being iterated and gets updated
2375 * whenever the datastructure changes.
2376 * it:
2377 * the GstIterator to get the master cookie of
2379 // TODO
2380 // #define GST_ITERATOR_ORIG_COOKIE(it) (GST_ITERATOR(it)->master_cookie)
2383 * Get the object that posted message.
2384 * message:
2385 * a GstMessage
2387 // TODO
2388 // #define GST_MESSAGE_SRC(message) (GST_MESSAGE(message)->src)
2391 * Get the timestamp of message. This is the timestamp when the message
2392 * was created.
2393 * message:
2394 * a GstMessage
2396 // TODO
2397 // #define GST_MESSAGE_TIMESTAMP(message) (GST_MESSAGE(message)->timestamp)
2400 * Get the GstMessageType of message.
2401 * message:
2402 * a GstMessage
2404 // TODO
2405 // #define GST_MESSAGE_TYPE(message) (GST_MESSAGE(message)->type)
2408 * Get a constant string representation of the GstMessageType of message.
2409 * message:
2410 * a GstMessage
2411 * Since 0.10.4
2413 // TODO
2414 // #define GST_MESSAGE_TYPE_NAME(message) gst_message_type_get_name(GST_MESSAGE_TYPE(message))
2417 * Creates a copy of the message. Returns a copy of the message.
2418 * MT safe
2419 * msg:
2420 * the message to copy
2422 // TODO
2423 // #define gst_message_copy(msg) GST_MESSAGE (gst_mini_object_copy (GST_MINI_OBJECT (msg)))
2426 * Checks if a message is writable. If not, a writable copy is made and
2427 * returned. Returns a message (possibly a duplicate) that is writable.
2428 * MT safe
2429 * msg:
2430 * the message to make writable
2432 // TODO
2433 // #define gst_message_make_writable(msg) GST_MESSAGE (gst_mini_object_make_writable (GST_MINI_OBJECT (msg)))
2436 * Convenience macro to decrease the reference count of the message, possibly freeing
2437 * the it.
2438 * msg:
2439 * the message to unref
2440 * See Also
2441 * GstBus, GstMiniObject, GstElement
2443 // TODO
2444 // #define gst_message_unref(msg) gst_mini_object_unref (GST_MINI_OBJECT (msg))
2447 * This macro returns the entire set of flags for the mini-object.
2448 * obj:
2449 * MiniObject to return flags for.
2451 // TODO
2452 // #define GST_MINI_OBJECT_FLAGS(obj) (GST_MINI_OBJECT(obj)->flags)
2455 * This macro checks to see if the given flag is set.
2456 * obj:
2457 * MiniObject to check for flags.
2458 * flag:
2459 * Flag to check for
2461 // TODO
2462 // #define GST_MINI_OBJECT_FLAG_IS_SET(obj,flag) !!(GST_MINI_OBJECT_FLAGS (obj) (flag))
2465 * This macro sets the given bits.
2466 * obj:
2467 * MiniObject to set flag in.
2468 * flag:
2469 * Flag to set, can by any number of bits in guint32.
2471 // TODO
2472 // #define GST_MINI_OBJECT_FLAG_SET(obj,flag) (GST_MINI_OBJECT_FLAGS (obj) |= (flag))
2475 * This macro usets the given bits.
2476 * obj:
2477 * MiniObject to unset flag in.
2478 * flag:
2479 * Flag to set, must be a single bit in guint32.
2481 // TODO
2482 // #define GST_MINI_OBJECT_FLAG_UNSET(obj,flag) (GST_MINI_OBJECT_FLAGS (obj) = ~(flag))
2485 * Get access to the reference count field of the mini-object.
2486 * obj:
2487 * a GstMiniObject
2489 // TODO
2490 // #define GST_MINI_OBJECT_REFCOUNT(obj) ((GST_MINI_OBJECT_CAST(obj))->refcount)
2493 * Get the reference count value of the mini-object.
2494 * obj:
2495 * a GstMiniObject
2497 // TODO
2498 // #define GST_MINI_OBJECT_REFCOUNT_VALUE(obj) (g_atomic_int_get ((GST_MINI_OBJECT_CAST(obj))->refcount))
2501 * This macro returns the entire set of flags for the object.
2502 * obj:
2503 * a GstObject
2505 // TODO
2506 // #define GST_OBJECT_FLAGS(obj) (GST_OBJECT_CAST (obj)->flags)
2509 * This macro checks to see if the given flag is set.
2510 * obj:
2511 * a GstObject
2512 * flag:
2513 * Flag to check for
2515 // TODO
2516 // #define GST_OBJECT_FLAG_IS_SET(obj,flag) ((GST_OBJECT_FLAGS (obj) (flag)) == (flag))
2519 * This macro sets the given bits.
2520 * obj:
2521 * a GstObject
2522 * flag:
2523 * Flag to set
2525 // TODO
2526 // #define GST_OBJECT_FLAG_SET(obj,flag) (GST_OBJECT_FLAGS (obj) |= (flag))
2529 * This macro usets the given bits.
2530 * obj:
2531 * a GstObject
2532 * flag:
2533 * Flag to set
2535 // TODO
2536 // #define GST_OBJECT_FLAG_UNSET(obj,flag) (GST_OBJECT_FLAGS (obj) = ~(flag))
2539 * Get the name of this object
2540 * obj:
2541 * a GstObject
2543 // TODO
2544 // #define GST_OBJECT_NAME(obj) (GST_OBJECT_CAST(obj)->name)
2547 * Get the parent of this object
2548 * obj:
2549 * a GstObject
2551 // TODO
2552 // #define GST_OBJECT_PARENT(obj) (GST_OBJECT_CAST(obj)->parent)
2555 * Check if the given object is beeing destroyed.
2556 * obj:
2557 * a GstObject
2559 // TODO
2560 // #define GST_OBJECT_IS_DISPOSING(obj) (GST_OBJECT_FLAG_IS_SET (obj, GST_OBJECT_DISPOSING))
2563 * Check if the given object is floating (has no owner).
2564 * obj:
2565 * a GstObject
2567 // TODO
2568 // #define GST_OBJECT_IS_FLOATING(obj) (GST_OBJECT_FLAG_IS_SET (obj, GST_OBJECT_FLOATING))
2571 * Get access to the reference count field of the object.
2572 * obj:
2573 * a GstObject
2575 // TODO
2576 // #define GST_OBJECT_REFCOUNT(obj) (((GObject*)(obj))->ref_count)
2579 * Get the reference count value of the object.
2580 * obj:
2581 * a GstObject
2583 // TODO
2584 // #define GST_OBJECT_REFCOUNT_VALUE(obj) g_atomic_int_get (GST_OBJECT_REFCOUNT(obj))
2587 * This macro will return the class lock used to protect deep_notify signal
2588 * emission on thread-unsafe glib versions (glib < 2.8).
2589 * obj:
2590 * a GstObjectClass
2592 // TODO
2593 // #define GST_CLASS_GET_LOCK(obj) (GST_OBJECT_CLASS_CAST(obj)->lock)
2596 * Lock the class.
2597 * obj:
2598 * a GstObjectClass
2600 // TODO
2601 // #define GST_CLASS_LOCK(obj) (g_static_rec_mutex_lock(GST_CLASS_GET_LOCK(obj)))
2604 * Try to lock the class, returns TRUE if class could be locked.
2605 * obj:
2606 * a GstObjectClass
2608 // TODO
2609 // #define GST_CLASS_TRYLOCK(obj) (g_static_rec_mutex_trylock(GST_CLASS_GET_LOCK(obj)))
2612 * Unlock the class.
2613 * obj:
2614 * a GstObjectClass
2616 // TODO
2617 // #define GST_CLASS_UNLOCK(obj) (g_static_rec_mutex_unlock(GST_CLASS_GET_LOCK(obj)))
2620 * This macro will obtain a lock on the object, making serialization possible.
2621 * It blocks until the lock can be obtained.
2622 * obj:
2623 * a GstObject to lock
2625 // TODO
2626 // #define GST_OBJECT_LOCK(obj) g_mutex_lock(GST_OBJECT_GET_LOCK(obj))
2629 * This macro will try to obtain a lock on the object, but will return with
2630 * FALSE if it can't get it immediately.
2631 * obj:
2632 * a Object.
2634 // TODO
2635 // #define GST_OBJECT_TRYLOCK(obj) g_mutex_trylock(GST_OBJECT_GET_LOCK(obj))
2638 * This macro releases a lock on the object.
2639 * obj:
2640 * a GstObject to unlock.
2642 // TODO
2643 // #define GST_OBJECT_UNLOCK(obj) g_mutex_unlock(GST_OBJECT_GET_LOCK(obj))
2646 * Acquire a reference to the mutex of this object.
2647 * obj:
2648 * a GstObject
2650 // TODO
2651 // #define GST_OBJECT_GET_LOCK(obj) (GST_OBJECT_CAST(obj)->lock)
2654 * Macro to test if the given GstPadLinkReturn value indicates a failed
2655 * link step.
2656 * ret:
2657 * the GstPadLinkReturn value
2659 // TODO
2660 // #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
2663 * Macro to test if the given GstPadLinkReturn value indicates a successful
2664 * link step.
2665 * ret:
2666 * the GstPadLinkReturn value
2668 // TODO
2669 // #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
2672 * Get a copy of the name of the pad. g_free() after usage.
2673 * MT safe.
2674 * pad:
2675 * the pad to get the name from
2677 // TODO
2678 // #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
2681 * Get the parent of pad. This function increases the refcount
2682 * of the parent object so you should gst_object_unref() it after usage.
2683 * Can return NULL if the pad did not have a parent.
2684 * MT safe.
2685 * pad:
2686 * the pad to get the parent of
2688 // TODO
2689 // #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
2692 * Get the stream lock of pad. The stream lock is protecting the
2693 * resources used in the data processing functions of pad.
2694 * pad:
2695 * a GstPad
2697 // TODO
2698 // #define GST_PAD_GET_STREAM_LOCK(pad) (GST_PAD_CAST(pad)->stream_rec_lock)
2701 * Lock the stream lock of pad.
2702 * pad:
2703 * a GstPad
2705 // TODO
2706 // #define GST_PAD_STREAM_LOCK(pad) (g_static_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad)))
2709 * Lock the stream lock of pad t times.
2710 * pad:
2711 * a GstPad
2712 * t:
2713 * the number of times to recursively lock
2715 // TODO
2716 // #define GST_PAD_STREAM_LOCK_FULL(pad,t) (g_static_rec_mutex_lock_full(GST_PAD_GET_STREAM_LOCK(pad), t))
2719 * Try to Lock the stream lock of the pad, return TRUE if the lock could be
2720 * taken.
2721 * pad:
2722 * a GstPad
2724 // TODO
2725 // #define GST_PAD_STREAM_TRYLOCK(pad) (g_static_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)))
2728 * Unlock the stream lock of pad.
2729 * pad:
2730 * a GstPad
2732 // TODO
2733 // #define GST_PAD_STREAM_UNLOCK(pad) (g_static_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad)))
2736 * Fully unlock the recursive stream lock of pad, return the number of times
2737 * pad was locked.
2738 * pad:
2739 * a GstPad
2741 // TODO
2742 // #define GST_PAD_STREAM_UNLOCK_FULL(pad) (g_static_rec_mutex_unlock_full(GST_PAD_GET_STREAM_LOCK(pad)))
2745 * Macro to test if the given GstFlowReturn value indicates a fatal
2746 * error. This macro is mainly used in elements to decide when an error
2747 * message should be posted on the bus.
2748 * ret:
2749 * a GstFlowReturn value
2750 * Property Details
2751 * The "caps" property
2752 * "caps" GstCaps : Read
2753 * The capabilities of the pad.
2755 // TODO
2756 // #define GST_FLOW_IS_FATAL(ret) ((ret) <= GST_FLOW_UNEXPECTED)
2759 * Convenience macro to fill the values of a GstStaticPadTemplate
2760 * structure.
2761 * padname:
2762 * the name template of pad
2763 * dir:
2764 * the GstPadDirection of the pad
2765 * pres:
2766 * the GstPadPresence of the pad
2767 * caps:
2768 * the GstStaticCaps of the pad
2770 // TODO
2771 // #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps)
2774 * Get the nametemplate of the padtemplate.
2775 * templ:
2776 * the template to query
2778 // TODO
2779 // #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ) (((GstPadTemplate *)(templ))->name_template)
2782 * Get the direction of the padtemplate.
2783 * templ:
2784 * the template to query
2786 // TODO
2787 // #define GST_PAD_TEMPLATE_DIRECTION(templ) (((GstPadTemplate *)(templ))->direction)
2790 * Get the presence of the padtemplate.
2791 * templ:
2792 * the template to query
2794 // TODO
2795 // #define GST_PAD_TEMPLATE_PRESENCE(templ) (((GstPadTemplate *)(templ))->presence)
2798 * Get a handle to the padtemplate GstCaps
2799 * templ:
2800 * the template to query
2802 // TODO
2803 // #define GST_PAD_TEMPLATE_CAPS(templ) (((GstPadTemplate *)(templ))->caps)
2806 * Check if the properties of the padtemplate are fixed
2807 * templ:
2808 * the template to query
2810 // TODO
2811 // #define GST_PAD_TEMPLATE_IS_FIXED(templ) (GST_OBJECT_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
2814 * This macro needs to be used to define the entry point and meta data of a
2815 * plugin. One would use this macro to export a plugin, so that it can be used
2816 * by other applications
2817 * major:
2818 * major version number of the gstreamer-core that plugin was compiled for
2819 * minor:
2820 * minor version number of the gstreamer-core that plugin was compiled for
2821 * name:
2822 * short, but unique name of the plugin
2823 * description:
2824 * information about the purpose of the plugin
2825 * init:
2826 * function pointer to the plugin_init method with the signature of static gboolean plugin_init (GstPlugin * plugin).
2827 * version:
2828 * full version string (e.g. VERSION from config.h)
2829 * license:
2830 * under which licence the package has been released, e.g. GPL, LGPL.
2831 * package:
2832 * the package-name (e.g. PACKAGE_NAME from config.h)
2833 * origin:
2834 * a description from where the package comes from (e.g. the homepage URL)
2836 // TODO
2837 // #define GST_PLUGIN_DEFINE(major,minor,name,description,init,version,license,package,origin)
2840 * This macro needs to be used to define the entry point and meta data of a
2841 * local plugin. One would use this macro to define a local plugin that can only
2842 * be used by the own application.
2843 * major:
2844 * major version number of the gstreamer-core that plugin was compiled for
2845 * minor:
2846 * minor version number of the gstreamer-core that plugin was compiled for
2847 * name:
2848 * short, but unique name of the plugin
2849 * description:
2850 * information about the purpose of the plugin
2851 * init:
2852 * function pointer to the plugin_init method with the signature of static gboolean plugin_init (GstPlugin * plugin).
2853 * version:
2854 * full version string (e.g. VERSION from config.h)
2855 * license:
2856 * under which licence the package has been released, e.g. GPL, LGPL.
2857 * package:
2858 * the package-name (e.g. PACKAGE_NAME from config.h)
2859 * origin:
2860 * a description from where the package comes from (e.g. the homepage URL)
2862 // TODO
2863 // #define GST_PLUGIN_DEFINE_STATIC(major,minor,name,description,init,version,license,package,origin)
2866 * Get the name of the feature
2867 * feature:
2868 * The feature to query
2870 // TODO
2871 // #define GST_PLUGIN_FEATURE_NAME(feature) (GST_PLUGIN_FEATURE (feature)->name)
2874 * Get the GstQueryType of the query.
2875 * query:
2876 * the query to query
2878 // TODO
2879 // #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
2882 * Get a constant string representation of the GstQueryType of the query.
2883 * query:
2884 * the query to query
2885 * Since 0.10.4
2887 // TODO
2888 // #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
2891 * Increases the refcount of the given query by one.
2892 * q:
2893 * a GstQuery to increase the refcount of.
2895 // TODO
2896 // #define gst_query_ref(q) GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT (q)))
2899 * Decreases the refcount of the query. If the refcount reaches 0, the query
2900 * will be freed.
2901 * q:
2902 * a GstQuery to decrease the refcount of.
2904 // TODO
2905 // #define gst_query_unref(q) gst_mini_object_unref (GST_MINI_OBJECT (q))
2908 * Copies the given query using the copy function of the parent GstData
2909 * structure.
2910 * q:
2911 * a GstQuery to copy.
2913 // TODO
2914 // #define gst_query_copy(q) GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT (q)))
2917 * Makes a writable query from the given query.
2918 * q:
2919 * a GstQuery to make writable
2921 // TODO
2922 // #define gst_query_make_writable(q) GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (q)))
2925 * Get the list of paths for the default registry.
2927 // TODO
2928 // #define gst_default_registry_get_path_list()
2931 * Add the plugin to the default registry.
2932 * The plugin-added signal will be emitted.
2933 * plugin:
2934 * the plugin to add
2936 // TODO
2937 // #define gst_default_registry_add_plugin(plugin)
2940 * Add the given path to the default registry. The syntax of the
2941 * path is specific to the registry. If the path has already been
2942 * added, do nothing.
2943 * path:
2944 * the path to add to the registry
2946 // TODO
2947 // #define gst_default_registry_add_path(path)
2950 * Find the plugin with the given name in the default registry.
2951 * The plugin will be reffed; caller is responsible for unreffing.
2952 * name:
2953 * the plugin name to find
2955 // TODO
2956 // #define gst_default_registry_find_plugin(name)
2959 * Find the pluginfeature with the given name and type in the default registry.
2960 * name:
2961 * the pluginfeature name to find
2962 * type:
2963 * the pluginfeature type to find
2965 // TODO
2966 // #define gst_default_registry_find_feature(name,type)
2969 * Get a copy of all plugins registered in the default registry.
2971 // TODO
2972 // #define gst_default_registry_get_plugin_list()
2975 * Runs a filter against all features of the plugins in the default registry
2976 * and returns a GList with the results.
2977 * If the first flag is set, only the first match is
2978 * returned (as a list with a single object).
2979 * filter:
2980 * the filter to use
2981 * first:
2982 * only return first match
2983 * user_data:
2984 * user data passed to the filter function
2985 * See Also
2986 * GstPlugin, GstPluginFeature
2988 // TODO
2989 // #define gst_default_registry_feature_filter(filter,first,user_data)
2992 * Send a broadcast signal to all waiting task conds
2993 * task:
2994 * Task to broadcast
2996 // TODO
2997 // #define GST_TASK_BROADCAST(task) g_cond_breadcast(GST_TASK_GET_COND (task))
3000 * Get access to the cond of the task.
3001 * task:
3002 * Task to get the cond of
3004 // TODO
3005 // #define GST_TASK_GET_COND(task) (GST_TASK_CAST(task)->cond)
3008 * Get access to the task lock.
3009 * task:
3010 * Task to get the lock of
3012 // TODO
3013 // #define GST_TASK_GET_LOCK(task) (GST_TASK_CAST(task)->lock)
3016 * Signal the task cond
3017 * task:
3018 * Task to signal
3020 // TODO
3021 // #define GST_TASK_SIGNAL(task) g_cond_signal(GST_TASK_GET_COND (task))
3024 * Get access to the state of the task.
3025 * task:
3026 * Task to get the state of
3028 // TODO
3029 // #define GST_TASK_STATE(task) (GST_TASK_CAST(task)->state)
3032 * Wait for the task cond to be signalled
3033 * task:
3034 * Task to wait for
3036 // TODO
3037 // #define GST_TASK_WAIT(task) g_cond_wait(GST_TASK_GET_COND (task), GST_OBJECT_GET_LOCK (task))
3040 * Specifies the type of function passed to gst_bus_add_watch() or
3041 * gst_bus_add_watch_full(), which is called from the mainloop when a message
3042 * is available on the bus.
3043 * The message passed to the function will be unreffed after execution of this
3044 * function so it should not be freed in the function.
3045 * Note that this function is used as a GSourceFunc which means that returning
3046 * FALSE will remove the GSource from the mainloop.
3047 * bus:
3048 * the GstBus that sent the message
3049 * message:
3050 * the GstMessage
3051 * data:
3052 * user data that has been given, when registering the handler
3053 * Returns:
3054 * FALSE if the event source should be removed.
3056 // gboolean (*GstBusFunc) (GstBus *bus, GstMessage *message, gpointer data);
3057 public typedef extern(C) int function (GstBus*, GstMessage*, void*) GstBusFunc;
3060 * Handler will be invoked synchronously, when a new message has been injected
3061 * into the bus. This function is mostly used internally. Only one sync handler
3062 * can be attached to a given bus.
3063 * If the handler returns GST_BUS_DROP, it should unref the message, else the
3064 * message should not be unreffed by the sync handler.
3065 * bus:
3066 * the GstBus that sent the message
3067 * message:
3068 * the GstMessage
3069 * data:
3070 * user data that has been given, when registering the handler
3071 * Returns:
3072 * GstBusSyncReply stating what to do with the message
3074 // GstBusSyncReply (*GstBusSyncHandler) (GstBus *bus, GstMessage *message, gpointer data);
3075 public typedef extern(C) GstBusSyncReply function (GstBus*, GstMessage*, void*) GstBusSyncHandler;
3078 * The function prototype of the callback.
3079 * clock:
3080 * The clock that triggered the callback
3081 * time:
3082 * The time it was triggered
3083 * id:
3084 * The GstClockID that expired
3085 * user_data:
3086 * user data passed in the async_wait call
3087 * Returns:
3088 * TRUE or FALSE (currently unused)
3090 // gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time, GstClockID id, gpointer user_data);
3091 public typedef extern(C) int function (GstClock*, GstClockTime, GstClockID, void*) GstClockCallback;
3094 * Function to filter out entries in the index.
3095 * index:
3096 * The index being queried
3097 * entry:
3098 * The entry to be added.
3099 * user_data:
3100 * User data passed to the function.
3101 * Returns:
3102 * This function should return TRUE if the entry is to be added
3103 * to the index, FALSE otherwise.
3105 // gboolean (*GstIndexFilter) (GstIndex *index, GstIndexEntry *entry, gpointer user_data);
3106 public typedef extern(C) int function (GstIndex*, GstIndexEntry*, void*) GstIndexFilter;
3109 * Function to resolve ids to writer descriptions.
3110 * index:
3111 * the index being queried.
3112 * writer:
3113 * The object that wants to write
3114 * writer_string:
3115 * A description of the writer.
3116 * user_data:
3117 * user_data as registered
3118 * Returns:
3119 * TRUE if an id could be assigned to the writer.
3121 // gboolean (*GstIndexResolver) (GstIndex *index, GstObject *writer, gchar **writer_string, gpointer user_data);
3122 public typedef extern(C) int function (GstIndex*, GstObject*, gchar**, void*) GstIndexResolver;
3125 * The function that will be called when a GList iterator is freed. The
3126 * owner of the GList iterator can then clean up its resources.
3127 * owner:
3128 * the owner of the iterator
3130 // void (*GstIteratorDisposeFunction) (gpointer owner);
3131 public typedef extern(C) void function (void*) GstIteratorDisposeFunction;
3134 * The function that will be called when the next element of the iterator
3135 * should be retrieved.
3136 * Implementors of a GstIterator should implement this
3137 * function and pass it to the constructor of the custom iterator.
3138 * The function will be called with the iterator lock held.
3139 * it:
3140 * the iterator
3141 * result:
3142 * a pointer to hold the next item
3143 * Returns:
3144 * the result of the operation.
3146 // GstIteratorResult (*GstIteratorNextFunction) (GstIterator *it, gpointer *result);
3147 public typedef extern(C) GstIteratorResult function (GstIterator*, gpointer*) GstIteratorNextFunction;
3150 * The function that will be called after the next item of the iterator
3151 * has been retrieved. This function will typically increase the refcount
3152 * of the item or make a copy.
3153 * Implementors of a GstIterator should implement this
3154 * function and pass it to the constructor of the custom iterator.
3155 * The function will be called with the iterator lock held.
3156 * it:
3157 * the iterator
3158 * item:
3159 * the item being retrieved.
3160 * Returns:
3161 * the result of the operation.
3163 // GstIteratorItem (*GstIteratorItemFunction) (GstIterator *it, gpointer item);
3164 public typedef extern(C) GstIteratorItem function (GstIterator*, void*) GstIteratorItemFunction;
3167 * This function will be called whenever a concurrent update happened
3168 * to the iterated datastructure. The implementor of the iterator should
3169 * restart the iterator from the beginning and clean up any state it might
3170 * have.
3171 * Implementors of a GstIterator should implement this
3172 * function and pass it to the constructor of the custom iterator.
3173 * The function will be called with the iterator lock held.
3174 * it:
3175 * the iterator
3177 // void (*GstIteratorResyncFunction) (GstIterator *it);
3178 public typedef extern(C) void function (GstIterator*) GstIteratorResyncFunction;
3181 * This function will be called when the iterator is freed.
3182 * Implementors of a GstIterator should implement this
3183 * function and pass it to the constructor of the custom iterator.
3184 * The function will be called with the iterator lock held.
3185 * it:
3186 * the iterator
3188 // void (*GstIteratorFreeFunction) (GstIterator *it);
3189 public typedef extern(C) void function (GstIterator*) GstIteratorFreeFunction;
3192 * A function to be passed to gst_iterator_fold().
3193 * item:
3194 * the item to fold
3195 * ret:
3196 * a GValue collecting the result
3197 * user_data:
3198 * data passed to gst_iterator_fold()
3199 * Returns:
3200 * TRUE if the fold should continue, FALSE if it should stop.
3202 // gboolean (*GstIteratorFoldFunction) (gpointer item, GValue *ret, gpointer user_data);
3203 public typedef extern(C) int function (void*, GValue*, void*) GstIteratorFoldFunction;
3206 * Virtual function prototype for methods to create copies of instances.
3207 * obj:
3208 * MiniObject to copy
3209 * Returns:
3210 * reference to cloned instance.
3212 // GstMiniObject* (*GstMiniObjectCopyFunction) (const GstMiniObject *obj);
3213 public typedef extern(C) GstMiniObject* function (GstMiniObject*) GstMiniObjectCopyFunction;
3216 * Virtual function prototype for methods to free ressources used by
3217 * mini-objects. Subclasses of the mini object are allowed to revive the
3218 * passed object by doing a gst_mini_object_ref(). If the object is not
3219 * revived after the finalize function, the memory associated with the
3220 * object is freed.
3221 * obj:
3222 * MiniObject to finalize
3224 // void (*GstMiniObjectFinalizeFunction) (GstMiniObject *obj);
3225 public typedef extern(C) void function (GstMiniObject*) GstMiniObjectFinalizeFunction;
3228 * Callback used by gst_pad_set_blocked_async(). Gets called when the blocking
3229 * operation succeeds.
3230 * pad:
3231 * the GstPad that is blockend or unblocked.
3232 * blocked:
3233 * blocking state for the pad
3234 * user_data:
3235 * the gpointer to optional user data.
3237 // void (*GstPadBlockCallback) (GstPad *pad, gboolean blocked, gpointer user_data);
3238 public typedef extern(C) void function (GstPad*, int, void*) GstPadBlockCallback;
3241 * Ask the sinkpad pad to allocate a buffer with offset, size and caps.
3242 * The result will be stored in buf.
3243 * The purpose of this function is to allocate a buffer that is optimal to
3244 * be processed by pad. The function is mostly overridden by elements that can
3245 * provide a hardware buffer in order to avoid additional memcpy operations.
3246 * The function can return a buffer that does not have caps, in which case the
3247 * upstream element requests a format change.
3248 * When this function returns anything else than GST_FLOW_OK, the buffer allocation
3249 * failed and buf does not contain valid data.
3250 * By default this function returns a new buffer of size and with caps containing
3251 * purely malloced data.
3252 * pad:
3253 * a sink GstPad
3254 * offset:
3255 * the desired offset of the buffer
3256 * size:
3257 * the desired size of the buffer
3258 * caps:
3259 * the desired caps of the buffer
3260 * buf:
3261 * pointer to hold the allocated buffer.
3262 * Returns:
3263 * GST_FLOW_OK if buf contains a valid buffer, any other return
3264 * value means buf does not hold a valid buffer.
3266 // GstFlowReturn (*GstPadBufferAllocFunction) (GstPad *pad, guint64 offset, guint size, GstCaps *caps, GstBuffer **buf);
3267 public typedef extern(C) GstFlowReturn function (GstPad*, ulong, uint, GstCaps*, GstBuffer**) GstPadBufferAllocFunction;
3270 * A function that will be called on sinkpads when chaining buffers.
3271 * pad:
3272 * the GstPad that performed the chain.
3273 * buffer:
3274 * the GstBuffer that is chained.
3275 * Returns:
3276 * GST_FLOW_OK for success
3278 // GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstBuffer *buffer);
3279 public typedef extern(C) GstFlowReturn function (GstPad*, GstBuffer*) GstPadChainFunction;
3282 * Check if pad can be activated in pull mode.
3283 * This function will be deprecated after 0.10; use the seeking query to check
3284 * if a pad can support random access.
3285 * pad:
3286 * a GstPad
3287 * Returns:
3288 * TRUE if the pad can operate in pull mode.
3290 // gboolean (*GstPadCheckGetRangeFunction) (GstPad *pad);
3291 public typedef extern(C) int function (GstPad*) GstPadCheckGetRangeFunction;
3294 * This function will be called on sourcepads when a peer element
3295 * request a buffer at the specified offset and length. If this function
3296 * returns GST_FLOW_OK, the result buffer will be stored in buffer. The
3297 * contents of buffer is invalid for any other return value.
3298 * pad:
3299 * the GstPad to perform the getrange on.
3300 * offset:
3301 * the offset of the range
3302 * length:
3303 * the length of the range
3304 * buffer:
3305 * a memory location to hold the result buffer
3306 * Returns:
3307 * GST_FLOW_OK for success
3309 // GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, guint64 offset, guint length, GstBuffer **buffer);
3310 public typedef extern(C) GstFlowReturn function (GstPad*, ulong, uint, GstBuffer**) GstPadGetRangeFunction;
3313 * Function signature to handle an event for the pad.
3314 * pad:
3315 * the GstPad to handle the event.
3316 * event:
3317 * the GstEvent to handle.
3318 * Returns:
3319 * TRUE if the pad could handle the event.
3321 // gboolean (*GstPadEventFunction) (GstPad *pad, GstEvent *event);
3322 public typedef extern(C) int function (GstPad*, GstEvent*) GstPadEventFunction;
3325 * Function signature to handle a new link on the pad.
3326 * pad:
3327 * the GstPad that is linked.
3328 * peer:
3329 * the peer GstPad of the link
3330 * Returns:
3331 * the result of the link with the specified peer.
3333 // GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
3334 public typedef extern(C) GstPadLinkReturn function (GstPad*, GstPad*) GstPadLinkFunction;
3337 * Function signature to handle a unlinking the pad prom its peer.
3338 * pad:
3339 * the GstPad that is linked.
3341 // void (*GstPadUnlinkFunction) (GstPad *pad);
3342 public typedef extern(C) void function (GstPad*) GstPadUnlinkFunction;
3345 * Check if pad can accept caps. By default this function will see if caps
3346 * intersect with the result from gst_pad_get_caps() by can be overridden to
3347 * perform extra checks.
3348 * pad:
3349 * the GstPad to check
3350 * caps:
3351 * the GstCaps to check
3352 * Returns:
3353 * TRUE if the caps can be accepted by the pad.
3355 // gboolean (*GstPadAcceptCapsFunction) (GstPad *pad, GstCaps *caps);
3356 public typedef extern(C) int function (GstPad*, GstCaps*) GstPadAcceptCapsFunction;
3359 * Returns a copy of the capabilities of the specified pad. By default this
3360 * function will return the pad template capabilities, but can optionally
3361 * be overridden by elements.
3362 * pad:
3363 * the GstPad to get the capabilities of.
3364 * Returns:
3365 * a newly allocated copy GstCaps of the pad.
3367 // GstCaps* (*GstPadGetCapsFunction) (GstPad *pad);
3368 public typedef extern(C) GstCaps* function (GstPad*) GstPadGetCapsFunction;
3371 * Set caps on pad. By default this function updates the caps of the
3372 * pad but the function can be overriden by elements to perform extra
3373 * actions or verifications.
3374 * pad:
3375 * the GstPad to set the capabilities of.
3376 * caps:
3377 * the GstCaps to set
3378 * Returns:
3379 * TRUE if the caps could be set on the pad.
3381 // gboolean (*GstPadSetCapsFunction) (GstPad *pad, GstCaps *caps);
3382 public typedef extern(C) int function (GstPad*, GstCaps*) GstPadSetCapsFunction;
3385 * Given possibly unfixed caps caps, let pad use its default prefered
3386 * format to make a fixed caps. caps should be writable. By default this
3387 * function will pick the first value of any ranges or lists in the caps but
3388 * elements can override this function to perform other behaviour.
3389 * pad:
3390 * a GstPad
3391 * caps:
3392 * the GstCaps to fixate
3394 // void (*GstPadFixateCapsFunction) (GstPad *pad, GstCaps *caps);
3395 public typedef extern(C) void function (GstPad*, GstCaps*) GstPadFixateCapsFunction;
3398 * This function is called when the pad is activated during the element
3399 * READY to PAUSED state change. By default this function will call the
3400 * activate function that puts the pad in push mode but elements can
3401 * override this function to activate the pad in pull mode if they wish.
3402 * pad:
3403 * a GstPad
3404 * Returns:
3405 * TRUE if the pad could be activated.
3407 // gboolean (*GstPadActivateFunction) (GstPad *pad);
3408 public typedef extern(C) int function (GstPad*) GstPadActivateFunction;
3411 * The prototype of the push and pull activate functions.
3412 * pad:
3413 * a GstPad
3414 * active:
3415 * activate or deactivate the pad.
3416 * Returns:
3417 * TRUE if the pad could be activated or deactivated.
3419 // gboolean (*GstPadActivateModeFunction) (GstPad *pad, gboolean active);
3420 public typedef extern(C) int function (GstPad*, int) GstPadActivateModeFunction;
3423 * The signature of the query function.
3424 * pad:
3425 * the GstPad to query.
3426 * query:
3427 * the GstQuery object to execute
3428 * Returns:
3429 * TRUE if the query could be performed.
3431 // gboolean (*GstPadQueryFunction) (GstPad *pad, GstQuery *query);
3432 public typedef extern(C) int function (GstPad*, GstQuery*) GstPadQueryFunction;
3435 * The signature of the query types function.
3436 * pad:
3437 * a GstPad to query
3438 * Returns:
3439 * a constant array of query types
3441 // const GstQueryType* (*GstPadQueryTypeFunction) (GstPad *pad);
3442 public typedef extern(C) GstQueryType* function (GstPad*) GstPadQueryTypeFunction;
3445 * The signature of the internal pad link function.
3446 * pad:
3447 * The GstPad to query.
3448 * Returns:
3449 * a newly allocated GList of pads that are linked to the given pad on
3450 * the inside of the parent element.
3451 * The caller must call g_list_free() on it after use.
3453 // GList* (*GstPadIntLinkFunction) (GstPad *pad);
3454 public typedef extern(C) GList* function (GstPad*) GstPadIntLinkFunction;
3457 * A dispatcher function is called for all internally linked pads, see
3458 * gst_pad_dispatcher().
3459 * pad:
3460 * the GstPad that is dispatched.
3461 * data:
3462 * the gpointer to optional user data.
3463 * Returns:
3464 * TRUE if the dispatching procedure has to be stopped.
3466 // gboolean (*GstPadDispatcherFunction) (GstPad *pad, gpointer data);
3467 public typedef extern(C) int function (GstPad*, void*) GstPadDispatcherFunction;
3470 * A plugin should provide a pointer to a function of this type in the
3471 * plugin_desc struct.
3472 * This function will be called by the loader at startup.
3473 * plugin:
3474 * The plugin object that can be used to register GstPluginFeatures for this plugin.
3475 * Returns:
3476 * TRUE if plugin initialised successfully
3478 // gboolean (*GstPluginInitFunc) (GstPlugin *plugin);
3479 public typedef extern(C) int function (GstPlugin*) GstPluginInitFunc;
3482 * A function that can be used with e.g. gst_registry_plugin_filter()
3483 * to get a list of plugins that match certain criteria.
3484 * plugin:
3485 * the plugin to check
3486 * user_data:
3487 * the user_data that has been passed on e.g. gst_registry_plugin_filter()
3488 * Returns:
3489 * TRUE for a positive match, FALSE otherwise
3491 // gboolean (*GstPluginFilter) (GstPlugin *plugin, gpointer user_data);
3492 public typedef extern(C) int function (GstPlugin*, void*) GstPluginFilter;
3495 * A function that can be used with e.g. gst_registry_feature_filter()
3496 * to get a list of pluginfeature that match certain criteria.
3497 * feature:
3498 * the pluginfeature to check
3499 * user_data:
3500 * the user_data that has been passed on e.g.
3501 * gst_registry_feature_filter()
3502 * Returns:
3503 * TRUE for a positive match, FALSE otherwise
3505 // gboolean (*GstPluginFeatureFilter) (GstPluginFeature *feature, gpointer user_data);
3506 public typedef extern(C) int function (GstPluginFeature*, void*) GstPluginFeatureFilter;
3509 * A function that will be called in gst_structure_foreach(). The function may
3510 * not modify value.
3511 * field_id:
3512 * the GQuark of the field name
3513 * value:
3514 * the GValue of the field
3515 * user_data:
3516 * user data
3517 * Returns:
3518 * TRUE if the foreach operation should continue, FALSE if
3519 * the foreach operation should stop with FALSE.
3521 // gboolean (*GstStructureForeachFunc) (GQuark field_id, const GValue *value, gpointer user_data);
3522 public typedef extern(C) int function (GQuark, GValue*, void*) GstStructureForeachFunc;
3525 * A function that will be called in gst_structure_map_in_place(). The function
3526 * may modify value.
3527 * field_id:
3528 * the GQuark of the field name
3529 * value:
3530 * the GValue of the field
3531 * user_data:
3532 * user data
3533 * Returns:
3534 * TRUE if the map operation should continue, FALSE if
3535 * the map operation should stop with FALSE.
3537 // gboolean (*GstStructureMapFunc) (GQuark field_id, GValue *value, gpointer user_data);
3538 public typedef extern(C) int function (GQuark, GValue*, void*) GstStructureMapFunc;
3541 * A function that will be called in gst_tag_list_foreach(). The function may
3542 * not modify the tag list.
3543 * list:
3544 * the GstTagList
3545 * tag:
3546 * a name of a tag in list
3547 * user_data:
3548 * user data
3550 // void (*GstTagForeachFunc) (const GstTagList *list, const gchar *tag, gpointer user_data);
3551 public typedef extern(C) void function (GstTagList*, char[], void*) GstTagForeachFunc;
3554 * A function for merging multiple values of a tag used when registering
3555 * tags.
3556 * dest:
3557 * the destination GValue
3558 * src:
3559 * the source GValue
3561 // void (*GstTagMergeFunc) (GValue *dest, const GValue *src);
3562 public typedef extern(C) void function (GValue*, GValue*) GstTagMergeFunc;
3565 * A function that will repeadedly be called in the thread created by
3566 * a GstTask.
3567 * data:
3568 * user data passed to the function
3570 // void (*GstTaskFunction) (void *data);
3571 public typedef extern(C) void function (void*) GstTaskFunction;
3574 * A function that will be called by typefinding.
3575 * find:
3576 * A GstTypeFind structure
3577 * data:
3578 * optionnal data to pass to the function
3580 // void (*GstTypeFindFunction) (GstTypeFind *find, gpointer data);
3581 public typedef extern(C) void function (GstTypeFind*, void*) GstTypeFindFunction;