diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 09ad84ab3e..67b2acbb63 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -27,6 +27,8 @@ + + @@ -150,6 +152,16 @@ with some more specialized elements. &videoraw; + + GStreamer Autoppluggers + + the autopluggers provide a way to automatically construct elements based on + sink and src capabilities + + &GstStaticAutoplug; + &GstStaticAutoplugRender; + + Index diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index b7ab308338..be501c24dd 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -120,6 +120,7 @@ gst_parse_launch GST_ARCH_CALL GST_ARCH_SET_SP GST_ARCH_SETUP_STACK +GST_ARCH_PRESETJMP
@@ -191,6 +192,7 @@ GST_ELEMENT_IS_COTHREAD_STOPPING GST_ELEMENT_IS_EOS GST_ELEMENT_PARENT GST_ELEMENT_NAME +GST_ELEMENT_PADS GstElement GstElementDetails GstElementFactory @@ -227,8 +229,6 @@ gst_elementfactory_find gst_elementfactory_get_list gst_elementfactory_can_src_caps gst_elementfactory_can_sink_caps -gst_elementfactory_can_src_caps_list -gst_elementfactory_can_sink_caps_list gst_elementfactory_create gst_elementfactory_make gst_elementfactory_save_thyself @@ -243,6 +243,32 @@ GST_IS_ELEMENT_CLASS gst_element_get_type
+
+gstautoplug +GstAutoplug +GstAutoplug +GstAutoplugFlags +GstAutoplugFactory +gst_autoplug_signal_new_object +gst_autoplug_to_caps +gst_autoplug_to_renderers +gst_autoplugfactory_new +gst_autoplugfactory_destroy +gst_autoplugfactory_find +gst_autoplugfactory_get_list +gst_autoplugfactory_create +gst_autoplugfactory_make +gst_autoplugfactory_save_thyself +gst_autoplugfactory_load_thyself + +GST_AUTOPLUG +GST_IS_AUTOPLUG +GST_TYPE_AUTOPLUG +gst_autoplug_get_type +GST_AUTOPLUG_CLASS +GST_IS_AUTOPLUG_CLASS +
+
gstclock GstClockTime @@ -341,6 +367,10 @@ GstPadGetRegionFunction GstPadQoSFunction GstPadEOSFunction +GstPadNegotiateReturn +GstPadNegotiateFunction + + GstPadPushFunction GstPadPullFunction GstRegionType @@ -355,11 +385,11 @@ gst_pad_get_direction gst_pad_set_chain_function gst_pad_set_get_function gst_pad_set_getregion_function +gst_pad_set_negotiate_function gst_pad_set_qos_function gst_pad_set_eos_function -gst_pad_set_caps_list -gst_pad_get_caps_list -gst_pad_get_caps_by_name +gst_pad_set_caps +gst_pad_get_caps gst_pad_check_compatibility gst_pad_set_name gst_pad_get_name @@ -367,6 +397,7 @@ gst_pad_set_element_private gst_pad_get_element_private gst_pad_set_parent gst_pad_get_parent +gst_pad_get_real_parent gst_pad_add_ghost_pad gst_pad_remove_ghost_pad gst_pad_get_ghost_pad_list @@ -380,6 +411,11 @@ gst_pad_set_eos gst_pad_handle_qos gst_pad_eos gst_pad_load_and_connect +gst_pad_negotiate_proxy +gst_pad_renegotiate +gst_pad_get_padtemplate +gst_pad_get_padtemplate_caps + GST_RPAD_LEN GST_RPAD_OFFSET @@ -398,6 +434,7 @@ GST_RPAD_PULLFUNC GST_RPAD_PULLREGIONFUNC GST_RPAD_QOSFUNC GST_RPAD_EOSFUNC +GST_RPAD_NEGOTIATEFUNC GST_GPAD_REALPAD GstGhostPad @@ -414,10 +451,16 @@ GST_PAD_FACTORY_CAPS GstPadPresence GstPadTemplate +GST_PADTEMPLATE_CAPS +GST_PADTEMPLATE_DIRECTION +GST_PADTEMPLATE_NAME_TEMPLATE +GST_PADTEMPLATE_PRESENCE gst_padtemplate_new gst_padtemplate_create gst_padtemplate_load_thyself gst_padtemplate_save_thyself +gst_padtemplate_get_caps +gst_padtemplate_get_caps_by_name GstPadClass @@ -451,6 +494,7 @@ GST_PADTEMPLATE_CLASS GST_IS_PADTEMPLATE GST_IS_PADTEMPLATE_CLASS gst_padtemplate_get_type +GST_PAD_FACTORY_CAPS_ID
@@ -458,9 +502,6 @@ gst_padtemplate_get_type GstPipeline GstPipeline gst_pipeline_new -gst_pipeline_add_sink -gst_pipeline_add_src -gst_pipeline_autoplug gst_pipeline_destroy gst_pipeline_iterate @@ -474,25 +515,6 @@ GST_IS_PIPELINE_CLASS gst_pipeline_details
-
-gstautoplug -GstAutoplug -GST_AUTOPLUG_MAX_COST -GstAutoplugCostFunction -GstAutoplugListFunction -gst_autoplug_caps -gst_autoplug_pads -gst_autoplug_caps_list - -GstAutoplug -GST_AUTOPLUG -GST_IS_AUTOPLUG -GST_TYPE_AUTOPLUG -gst_autoplug_get_type -GST_AUTOPLUG_CLASS -GST_IS_AUTOPLUG_CLASS -
-
gstplugin GstPlugin @@ -513,13 +535,15 @@ gst_plugin_add_path gst_library_load gst_plugin_add_factory gst_plugin_add_type +gst_plugin_add_autoplugger gst_plugin_find gst_plugin_get_list gst_plugin_get_factory_list gst_plugin_get_type_list -gst_plugin_find_elementfactory +gst_plugin_get_autoplug_list gst_plugin_load_elementfactory gst_plugin_load_typefactory +gst_plugin_load_autoplugfactory gst_plugin_load_thyself gst_plugin_save_thyself @@ -596,22 +620,36 @@ gst_typefactory_save_thyself gstcaps GstCaps GstCaps +GstCapsFactory GstCapsFactoryEntry GstCapsFactory[] gst_caps_new gst_caps_new_with_props +gst_caps_destroy +gst_caps_ref +gst_caps_unref gst_caps_register gst_caps_register_count +gst_caps_copy +gst_caps_copy_on_write +gst_caps_append +gst_caps_prepend +gst_caps_set_name gst_caps_get_name -gst_caps_set_mime gst_caps_set_type_id gst_caps_get_type_id +gst_caps_set_mime gst_caps_get_mime -gst_caps_set_name gst_caps_set_props gst_caps_get_props gst_caps_check_compatibility -gst_caps_list_check_compatibility + +gst_caps_set +gst_caps_get_boolean +gst_caps_get_by_name +gst_caps_get_fourcc_int +gst_caps_get_int + gst_caps_save_thyself gst_caps_load_thyself @@ -633,7 +671,16 @@ gst_props_register gst_props_register_count gst_props_new gst_props_merge +gst_props_copy +gst_props_copy_on_write +gst_props_destroy +gst_props_ref +gst_props_unref gst_props_check_compatibility +gst_props_set +gst_props_get_boolean +gst_props_get_fourcc_int +gst_props_get_int gst_props_save_thyself gst_props_load_thyself @@ -652,6 +699,7 @@ GST_PROPS_LAST_ID
gstutils GstUtils +gst_util_set_object_arg gst_util_get_int_arg gst_util_get_bool_arg gst_util_get_long_arg @@ -694,6 +742,32 @@ GstCPUFlags gst_cpu_get_flags
+
+gststaticautoplug +GstStaticAutoplug + +GstStaticAutoplug +GST_STATIC_AUTOPLUG +GST_IS_STATIC_AUTOPLUG +GST_TYPE_STATIC_AUTOPLUG +gst_static_autoplug_get_type +GST_STATIC_AUTOPLUG_CLASS +GST_IS_STATIC_AUTOPLUG_CLASS +
+ +
+gststaticautoplugrender +GstStaticAutoplugRender + +GstStaticAutoplugRender +GST_STATIC_AUTOPLUG_RENDER +GST_IS_STATIC_AUTOPLUG_RENDER +GST_TYPE_STATIC_AUTOPLUG_RENDER +gst_static_autoplug_render_get_type +GST_STATIC_AUTOPLUG_RENDER_CLASS +GST_IS_STATIC_AUTOPLUG_RENDER_CLASS +
+
gstaudiosink GstAudioSink diff --git a/docs/gst/tmpl/gstarch.sgml b/docs/gst/tmpl/gstarch.sgml index c4a89c31ab..c8cc02a96c 100644 --- a/docs/gst/tmpl/gstarch.sgml +++ b/docs/gst/tmpl/gstarch.sgml @@ -38,3 +38,10 @@ gstarch @sp: + + + + + + + diff --git a/docs/gst/tmpl/gstautoplug.sgml b/docs/gst/tmpl/gstautoplug.sgml index 0fe0ed4306..528b68724e 100644 --- a/docs/gst/tmpl/gstautoplug.sgml +++ b/docs/gst/tmpl/gstautoplug.sgml @@ -2,12 +2,12 @@ GstAutoplug -Provide automatic element selection. +Automatically create and connect elements -The autoplugger can select a list of elements that are needed -to convert a certain GstCaps to another one. +GstAutoplug is an abstract class that is used for constructing and +connecting elements. @@ -15,18 +15,134 @@ to convert a certain GstCaps to another one. - + + + + + +@object: + + + + + + +@GST_AUTOPLUG_TO_CAPS: +@GST_AUTOPLUG_TO_RENDERER: +@GST_AUTOPLUG_FLAG_LAST: + + + + + + +@name: +@longdesc: +@type: + + + + + + +@autoplug: +@object: + + + @autoplug: -@srcpad: -@sinkpad: -@Varargs: -@Returns: - @srccaps: @sinkcaps: +@Varargs: +@Returns: + + + + + + + +@autoplug: +@srccaps: +@target: +@Varargs: +@Returns: + + + + + + + +@name: +@longdesc: +@type: +@Returns: + + + + + + + +@factory: + + + + + + + +@name: +@Returns: + + + + + + + +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@factory: +@parent: +@Returns: + + + + + + + +@parent: +@Returns: diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index af2ed33ff3..93ec147feb 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -22,7 +22,15 @@ a mime-type and a set of properties. @name: the name of the capability, for the application @id: the typeid of the capability +@refcount: @properties: the properties of the capability +@next: + + + + + + @@ -57,6 +65,30 @@ a mime-type and a set of properties. @Returns: + + + + + +@caps: + + + + + + + +@caps: + + + + + + + +@caps: + + @@ -78,6 +110,53 @@ a mime-type and a set of properties. @count: + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@capstoadd: +@Returns: + + + + + + + +@caps: +@capstoadd: +@Returns: + + + + + + + +@caps: +@name: + + @@ -87,6 +166,27 @@ a mime-type and a set of properties. @Returns: + + + + + +@caps: +@type_id: + +@Param2: +@typeid: + + + + + + + +@caps: +@Returns: + + @@ -96,26 +196,6 @@ a mime-type and a set of properties. @mime: - - - - - -@caps: -@Param2: - -@typeid: - - - - - - - -@caps: -@Returns: - - @@ -125,15 +205,6 @@ a mime-type and a set of properties. @Returns: - - - - - -@caps: -@name: - - @@ -166,16 +237,53 @@ a mime-type and a set of properties. @caps2: - + -@fromcaps: -@tocaps: +@caps: +@name: +@args...: + + + + + + + +@caps: +@name: + + + + + + + +@caps: +@name: @Returns: + + + + + +@caps: +@name: + + + + + + + +@caps: +@name: + + diff --git a/docs/gst/tmpl/gstcpu.sgml b/docs/gst/tmpl/gstcpu.sgml index 265ecbb5bb..cbf398b4a3 100644 --- a/docs/gst/tmpl/gstcpu.sgml +++ b/docs/gst/tmpl/gstcpu.sgml @@ -25,6 +25,8 @@ features of the CPU. @GST_CPU_FLAG_MMX: @GST_CPU_FLAG_SSE: +@GST_CPU_FLAG_MMXEXT: +@GST_CPU_FLAG_3DNOW: diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 14542ac1f0..05b2defa61 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -174,6 +174,14 @@ Get the name of this element. @obj: The element to query + + +Get the pads of this elements. + + +@obj: The element to query + + @@ -519,26 +527,6 @@ circumstances. @Returns: - - - - - -@factory: -@caps: -@Returns: - - - - - - - -@factory: -@caps: -@Returns: - - diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 5a5dd33144..150a8c893a 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -155,6 +155,26 @@ The function that will be called in an EOS case. @Returns: TRUE if EOS was successful, FALSE otherwise + + +The possible results from padnegotiation. + + +@GST_PAD_NEGOTIATE_FAIL: The pads could not agree about the media type. +@GST_PAD_NEGOTIATE_AGREE: The pads agreed about the media type. +@GST_PAD_NEGOTIATE_TRY: The pad did not agree and suggests another media type. + + + +The function that will be called when negotiating. + + +@pad: The pad that is being negotiated +@caps: The current caps that are being negotiated +@count: A counter to keep track of the negotiation process +@Returns: The result of the negotiation process + + @@ -282,6 +302,15 @@ Destroy the pad. @getregion: + + + + + +@pad: +@nego: + + @@ -300,31 +329,22 @@ Destroy the pad. @eos: - + @pad: @caps: - - - - - - - -@pad: @Returns: - + @pad: -@name: @Returns: @@ -392,6 +412,15 @@ Destroy the pad. @Returns: + + + + + +@pad: +@Returns: + + @@ -435,6 +464,7 @@ Destroy the pad. @srcpad: @sinkpad: +@Returns: @@ -518,6 +548,47 @@ Call the EOS function of the pad @elements: + + + + + +@srcpad: +@destpad: +@caps: +@counter: +@Returns: + +@count: + + + + + + + +@pad: +@Returns: + + + + + + + +@pad: +@Returns: + + + + + + + +@pad: +@Returns: + + @@ -564,6 +635,7 @@ Call the EOS function of the pad @pushfunc: @pullfunc: @pullregionfunc: +@negotiatefunc: @ghostpads: @@ -662,6 +734,14 @@ Get the EOS function of the real pad. @pad: the real pad to query. + + + + + +@pad: + + Get the real pad of this ghost pad. @@ -766,6 +846,38 @@ Indicates when this pad will become available. @presence: @caps: + + + + + +@templ: + + + + + + + +@templ: + + + + + + + +@templ: + + + + + + + +@templ: + + @@ -808,3 +920,22 @@ Indicates when this pad will become available. @pad: + + + + + +@templ: +@Returns: + + + + + + + +@templ: +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index b4b87637e0..ff213c9327 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -170,6 +170,15 @@ by the loader at statup. @factory: + + + + + +@plugin: +@factory: + + @@ -205,6 +214,15 @@ by the loader at statup. @Returns: + + + + + +@plugin: +@Returns: + + @@ -222,6 +240,15 @@ by the loader at statup. @mime: + + + + + +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml index 39a17388b3..2876c163c2 100644 --- a/docs/gst/tmpl/gstprops.sgml +++ b/docs/gst/tmpl/gstprops.sgml @@ -20,6 +20,7 @@ GstCaps +@refcount: @properties: the properties @@ -125,6 +126,48 @@ Create a boolean property. @Returns: + + + + + +@props: +@Returns: + + + + + + + +@props: +@Returns: + + + + + + + +@props: + + + + + + + +@props: + + + + + + + +@props: + + @@ -138,6 +181,50 @@ Create a boolean property. @props2: + + + + + +@props: +@name: +@entry: +@Varargs: +@Returns: + +@value: + + + + + + + +@props: +@name: +@Returns: + + + + + + + +@props: +@name: +@Returns: + + + + + + + +@props: +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 5f5ff9c6ea..d659b0cde0 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -12,19 +12,6 @@ Query the element for the current mime type - - - - - -@Returns: - - - - - - - @@ -52,6 +39,15 @@ Query the element for the current mime type @meta: + + + + + +@fromcaps: +@tocaps: +@Returns: + @@ -65,14 +61,6 @@ Query the element for the current mime type - - - - - -@pad: -@buf: - @@ -81,14 +69,13 @@ Query the element for the current mime type @pad: @parent: - + -This macro usets the given flags. + -@src: -@flag: Flag to set, must be a single bit in guint32. -@obj: GstSrc to unset flag in. +@pad: +@buf: @@ -128,29 +115,15 @@ This macro usets the given flags. @elementfactory: @id: - - - - - -@obj: - - + - - - -@obj: - - - - +The number of channels. @@ -184,18 +157,6 @@ GstEsdSink @parent: @Returns: - - - - - - - - - - - - @@ -210,12 +171,6 @@ GstEsdSink @obj: - - - - - - @@ -223,20 +178,6 @@ GstEsdSink @obj: - - - - - - - - - - - -@esdsink: -@format: - An eos signal is triggered whenever the GstSrc has reached the end of @@ -247,39 +188,6 @@ the stream. @gstsrc: the object which received the signal. @arg1: the object which received the signal - - - - - - - - - - - -@obj: - - - - - - - - - - - - -@Returns: - - - - - - -@obj: - @@ -287,13 +195,6 @@ the stream. @Returns: - - - - - -@obj: - @@ -301,34 +202,6 @@ the stream. @obj: - - - - - -@name: -@Returns: - - - - - - -@pad: -@buf: - - - - - - -@pad: -@Returns: - - -GstSrc - - @@ -355,12 +228,6 @@ GstSrc @obj: - - - - - - @@ -369,12 +236,6 @@ GstSrc @name: @Returns: - - - - - - @@ -395,20 +256,6 @@ GstSrc @klass: - - - - - -@obj: - - - - - - -@arg: - @@ -431,16 +278,6 @@ GstSrc - -GstConnection - - - - - - - - @@ -448,30 +285,12 @@ GstConnection @obj: - - -The frequency. - - - Specify how many bytes to read at a time. - - - - - - - - - - - - @@ -480,20 +299,10 @@ Specify how many bytes to read at a time. @name: @Returns: - - - - - - - - - - @@ -501,12 +310,6 @@ Specify how many bytes to read at a time. @Returns: - - - - - - @@ -520,32 +323,6 @@ subclass use this to start their flag enumeration - -GstElement - - - - - - - -@obj: - - - - - - -@id: -@Returns: - - - - - - -@buf: - @@ -564,12 +341,6 @@ Generic connection between elements. - - - - - - @@ -592,13 +363,6 @@ Generic connection between elements. @format: @args...: - - - - - -@obj: - @@ -606,14 +370,6 @@ Generic connection between elements. @obj: - - -The sink is the end of the filter graph. A typical sink would be an audio -or a video card. - - - - @@ -622,25 +378,18 @@ or a video card. @esdsink: @channels: - + +@autoplug: +@srcpad: +@sinkpad: +@Varargs: @Returns: - - - - - - -@obj: - - - - - - +@srccaps: +@sinkcaps: @@ -649,20 +398,6 @@ or a video card. @obj: - - - - - - - - -Query whether this object has multiple input pads. - - - -@obj: Element to query for multiple input pads. - @@ -682,26 +417,6 @@ Query whether this object has multiple input pads. @fd: @Returns: - - - - - -@format: -@args...: - - - - - - - - - - - - - @@ -715,12 +430,6 @@ Query whether this object has multiple input pads. - - - - - - @@ -780,18 +489,13 @@ Query whether this object has multiple input pads. - - - - - -@src: - - + +@pad: +@caps: @@ -807,12 +511,6 @@ Query whether this object has multiple input pads. @format: @args...: - - - - - - @@ -833,6 +531,1119 @@ Specify the current offset in the file. + + + + + + + + + + + + + + + + + +@klass: + + + + + + +@nextpad: +@Varargs: +@Returns: + + + + + + +@Returns: + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + +@klass: + + + + + + + + + + + + +@name: +@Returns: + + + + + + + + + + + + + + + + + + +@src: + + + + + + +@id: +@sink: + + + + + + +@obj: + + +GstGetbits + + + + + + + +@klass: + + + + + + +@name: +@Returns: + + + + + + +@element: +@parent: +@Returns: + + + + + + +@obj: + + + + + + +@sinkid: +@srcid: +@Returns: + + + + + + + + + + + + + + + + + + +@obj: + + + + + + +@id: +@Returns: + + + + + + +@esdsink: +@frequency: + + + + + + + + + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@obj: + + +GstAsyncDiskSrc + + + +>>>>>>> 1.23.2.3 + + + + + + + + + + +@elementfactory: +@id: + + + + + + +@obj: + + + + + + + + + +The fequency. + + + + + + + + +@Returns: + + + + + + +@name: +@Returns: + + + + + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@pad: +@buf: + + + + + + +@pad: +@Returns: + + + + + + +@factory: +@caps: +@Returns: + + + + + + +@pad: +@buf: + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@cat: +@element: +@format: +@args...: + + + + + + +@klass: + + + + + + + + + + + + +@id: +@src: + + + + + + + + + + + + +@obj: + + + + + + + + + + + + +@obj: + + + + + + +@klass: + + + + + + +@esdsink: + + + + + + +@connection: + + + + + + +@name: +@Returns: + + + + + + +@obj: + + + + + + + + +GstFilter + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@Returns: + + + + + + +@pad: +@Returns: + + + + + + +@thread: + + + +Flags for the GstSrc element + + +@GST_SRC_ASYNC: Indicates that this src is asynchronous +@GST_SRC_FLAG_LAST: subclasses can use this to number their flags + + +GstColorSpace + + + + + + + + +GST_ASYNCDISKSRC_OPEN +the asyncdisksrc is open for reading + + + + + + +@GST_ASYNCDISKSRC_OPEN: +@GST_ASYNCDISKSRC_FLAG_LAST: + + + + + + + + + + + + +@element: +@state: +@Returns: + + + + + + +@pad: +@Returns: + + + + + + + + + + + + +@obj: + + + + + + +@Returns: + + + + + + +@klass: + + + + + + +@klass: + + + + + + + + + + + + +@parent: +@Returns: + + + + + + +@pad: +@Returns: + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@element: +@templ: +@Returns: +@temp: + + + + + + +@obj: + + +The end point of a filter graph + + + + + + + + + + +This macro checks to see if the given state is set. + + +@obj: Element to check for state. +@flag: State to check for, must be a single bit in guint32. + + + + + + +@buffer: +@size: +@root: +@Returns: + + + + + + + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@obj: + + + + + + +@obj: + + + +This macro sets the given flags. + + +@src: +@flag: Flag to set, can by any number of bits in guint32. +@obj: GstSrc to set flag in. + + + + + + + + + + + + +@Returns: + + + + + + +@name: +@Returns: + + + + + + + + +GstSink + + + + +A flag indicating that MMX instructions are supported. + + + + + + + + +@Returns: + + + + + + + + + + + + +@factory: +@caps: +@Returns: + + + +This macro usets the given flags. + + +@src: +@flag: Flag to set, must be a single bit in guint32. +@obj: GstSrc to unset flag in. + + + + + + +@obj: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@pad: +@name: +@Returns: + + + + + + + + + + + + +@esdsink: +@format: + + + + + + + + + + + + +@obj: + + + + + + + + + + + + +@Returns: + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@name: +@Returns: + + +GstSrc + + + + + + + +@pad: +@Returns: + + + + + + +@pad: +@buf: + + + + + + + + + + + + + + + + + + +@obj: + + + + + + +@arg: + + +GstConnection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + +GstElement + + + + + + + +@id: +@Returns: + + + + + + +@buf: + + + + + + + + + + + + +@obj: + + + +The sink is the end of the filter graph. A typical sink would be an audio +or a video card. + + + + + + + + + +@obj: + + + + + + +@Returns: + + + + + + + + + + + + + + + +Query whether this object has multiple input pads. + + + +@obj: Element to query for multiple input pads. + + + + + + + + + + + + +@format: +@args...: + + + + + + + + + + + + + + + + + + +@src: + + + + + + + + + + + + + @@ -855,18 +1666,6 @@ Specify the current offset in the file. @obj: - - - - - - - - - - - - @@ -888,29 +1687,6 @@ Specify the current offset in the file. @name: @Returns: - - - - - -@klass: - - - - - - -@nextpad: -@Varargs: -@Returns: - - - - - - -@Returns: - @@ -918,12 +1694,6 @@ Specify the current offset in the file. @obj: - - - - - - @@ -948,12 +1718,6 @@ Specify the current offset in the file. @Returns: - - - - - - @@ -998,13 +1762,6 @@ on its own. @obj: - - - - - -@obj: - @@ -1012,9 +1769,12 @@ on its own. @klass: - + + + +@obj: @@ -1022,33 +1782,9 @@ on its own. - - - - + - - - - - -@obj: - - - - - - -@pad: -@caps: - - - - - - -@klass: @@ -1057,12 +1793,6 @@ on its own. @obj: - - - - - - @@ -1084,14 +1814,6 @@ on its own. @obj: - - - - - -@name: -@Returns: - @@ -1105,24 +1827,6 @@ on its own. @obj: - - - - - - - - - - - - - - - - - - @@ -1130,6 +1834,12 @@ on its own. @klass: + + + + + + @@ -1137,34 +1847,6 @@ on its own. @obj: - - - - - -@src: - - - - - - -@id: -@sink: - - - - - - -@obj: - - - - - - - This macro returns the entire set of flags for the object. @@ -1172,8 +1854,10 @@ This macro returns the entire set of flags for the object. @obj: GstSrc to return flags for. - -GstGetbits + + + + @@ -1182,21 +1866,6 @@ Get the size of the current file. - - - - - -@klass: - - - - - - -@name: -@Returns: - The start point of a filter graph @@ -1208,31 +1877,6 @@ The start point of a filter graph @src: - - - - - -@element: -@parent: -@Returns: - - - - - - -@obj: - - - - - - -@sinkid: -@srcid: -@Returns: - @@ -1240,18 +1884,6 @@ The start point of a filter graph @obj: - - - - - - - - - - - - @@ -1259,29 +1891,6 @@ The start point of a filter graph @src: - - - - - -@obj: - - - - - - -@id: -@Returns: - - - - - - -@esdsink: -@frequency: - @@ -1289,10 +1898,6 @@ The start point of a filter graph @klass: - - - - @@ -1317,12 +1922,6 @@ The start point of a filter graph - - - - - - @@ -1330,13 +1929,6 @@ The start point of a filter graph @Returns: - - - - - -@obj: - @@ -1344,13 +1936,6 @@ The start point of a filter graph @Returns: - - - - - -@obj: - @@ -1358,40 +1943,12 @@ The start point of a filter graph @klass: - - - - - -@obj: - - - - - - -@obj: - -@klass: - -<<<<<<< gstreamer-unused.sgml - -GstAsyncDiskSrc - - - -======= - ->>>>>>> 1.23.2.3 - - - - +@klass: <<<<<<< gstreamer-unused.sgml @@ -1400,15 +1957,7 @@ GstAsyncDiskSrc @audiosink: - - - - - -@elementfactory: -@id: - - + @@ -1423,13 +1972,6 @@ This macro unsets the given state on the element. @obj: Element to unset state of. @flag: State to unset, can be any number of bits in guint32. - - - - - -@obj: - @@ -1445,19 +1987,6 @@ This macro unsets the given state on the element. @pad: @id: - - - - - - - - - - - -@Returns: - @@ -1466,14 +1995,6 @@ This macro unsets the given state on the element. @pad: @parent: - - - - - -@name: -@Returns: - @@ -1488,12 +2009,6 @@ This macro unsets the given state on the element. - - - - - - @@ -1501,13 +2016,6 @@ This macro unsets the given state on the element. @elementfactory: - - - - - -@obj: - @@ -1523,20 +2031,6 @@ This macro unsets the given state on the element. @obj: - - - - - -@obj: - - - - - - -@Returns: - @@ -1547,6 +2041,13 @@ This macro unsets the given state on the element. @format: @args...: + + + + + +@Returns: + @@ -1574,29 +2075,6 @@ This macro unsets the given state on the element. @obj: - - - - - -@obj: - - - - - - -@pad: -@buf: - - - - - - -@pad: -@Returns: - @@ -1648,20 +2126,6 @@ This macro sets the given state on the element. @obj: Element to set state of. @flag: State to set, can be any number of bits in guint32. - - - - - -@pad: -@buf: - - - - - - - @@ -1682,17 +2146,12 @@ This macro sets the given state on the element. @obj: - - - - - - - + +@Returns: @@ -1703,26 +2162,12 @@ This macro sets the given state on the element. @offset: @size: - - - - - -@Returns: - - - - - - -@obj: - @@ -1739,23 +2184,6 @@ Is trigered whenever the state of an element changes @gstelement: the object which received the signal. @arg1: the new state of the object - - - - - -@obj: - - - - - - -@cat: -@element: -@format: -@args...: - @@ -1771,33 +2199,6 @@ Is trigered whenever the state of an element changes @name: @Returns: - - - - - -@klass: - - - - - - - - - - - - -@id: -@src: - - - - - - - @@ -1805,26 +2206,6 @@ Is trigered whenever the state of an element changes @Returns: - - - - - -@obj: - - - - - - - - - - - - -@obj: - Take data in and spit data out @@ -1842,13 +2223,6 @@ This macro checks to see if the GST_SRC_ASYNC flag is set. - - - - - -@klass: - @@ -1861,13 +2235,6 @@ A flag indicating that SSE instructions are supported. - - - - - -@esdsink: - @@ -1875,12 +2242,11 @@ A flag indicating that SSE instructions are supported. @obj: - + -@connection: @@ -1888,20 +2254,6 @@ A flag indicating that SSE instructions are supported. - - - - - -@name: -@Returns: - - - - - - - @@ -1909,13 +2261,6 @@ A flag indicating that SSE instructions are supported. @Returns: - - - - - -@obj: - @@ -1929,37 +2274,6 @@ A flag indicating that SSE instructions are supported. @obj: - - - - - - - -GstFilter - - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@Returns: - @@ -1972,29 +2286,6 @@ GstFilter @GST_PROPS_FOURCC_ID_NUM: @GST_PROPS_BOOL_ID_NUM: - - - - - -@pad: -@Returns: - - - - - - -@pad: -@Returns: - - - - - - -@thread: - @@ -2010,13 +2301,7 @@ GstFilter <<<<<<< gstreamer-unused.sgml - - -Flags for the GstSrc element - -@GST_SRC_ASYNC: Indicates that this src is asynchronous -@GST_SRC_FLAG_LAST: subclasses can use this to number their flags @@ -2024,17 +2309,6 @@ Flags for the GstSrc element - -======= - - -Flags for the GstSrc element - - -@GST_SRC_ASYNC: Indicates that this src is asynchronous -@GST_SRC_FLAG_LAST: subclasses can use this to number their flags - - >>>>>>> 1.23.2.3 @@ -2043,69 +2317,12 @@ Flags for the GstSrc element @obj: - -GstColorSpace - - - - - - - - -GST_ASYNCDISKSRC_OPEN -the asyncdisksrc is open for reading - - - - - - -@GST_ASYNCDISKSRC_OPEN: -@GST_ASYNCDISKSRC_FLAG_LAST: - - - - - - - - - - - - -@element: -@state: -@Returns: - - - - - - -@pad: -@Returns: - - - - - - - - - - - - -@obj: - @@ -2132,55 +2349,6 @@ Specify the location of the file to read. @Returns: - - - - - -@Returns: - - - - - - -@klass: - - - - - - -@klass: - - - - - - - - - - - - -@parent: -@Returns: - - - - - - - - - - - - -@name: -@Returns: - @@ -2189,16 +2357,6 @@ Specify the location of the file to read. @format: @args...: - - - - - -@element: -@templ: -@Returns: -@temp: - @@ -2207,17 +2365,6 @@ Specify the location of the file to read. @audiosink: @format: - - - - - -@obj: - - -The end point of a filter graph - - @@ -2234,13 +2381,6 @@ the offset. - - - - - -@obj: - @@ -2249,13 +2389,14 @@ the offset. @name: @Returns: - + +@obj: - + @@ -2265,24 +2406,6 @@ the offset. plugin - - -This macro checks to see if the given state is set. - - -@obj: Element to check for state. -@flag: State to check for, must be a single bit in guint32. - - - - - - -@buffer: -@size: -@root: -@Returns: - @@ -2290,33 +2413,6 @@ This macro checks to see if the given state is set. @obj: - - - - - - - - - - - - - - - - - -@name: -@Returns: - - - - - - -@obj: - @@ -2329,22 +2425,6 @@ This macro checks to see if the given state is set. - - - - - -@obj: - - - -This macro sets the given flags. - - -@src: -@flag: Flag to set, can by any number of bits in guint32. -@obj: GstSrc to set flag in. - @@ -2352,6 +2432,13 @@ This macro sets the given flags. @klass: + + + + + +@klass: + @@ -2359,40 +2446,12 @@ This macro sets the given flags. @obj: - - - - - -@klass: - - - - - - - Indicates this pad is active - - - - - -@Returns: - - - - - - -@name: -@Returns: - @@ -2407,19 +2466,3 @@ audio source. It provides data for the next element in the graph. - - - - - - - -GstSink - - - - -A flag indicating that MMX instructions are supported. - - - diff --git a/docs/gst/tmpl/gstsinesrc.sgml b/docs/gst/tmpl/gstsinesrc.sgml index 7768424330..f9259760a1 100644 --- a/docs/gst/tmpl/gstsinesrc.sgml +++ b/docs/gst/tmpl/gstsinesrc.sgml @@ -24,13 +24,23 @@ The volume as a double 0.0 is silent, 1.0 is loudest. The format ad defined in soundcard.h - + -The number of channels. + - + -The fequency. + + + + + +The frequency. + + + + + diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index 2550838846..f4bd0fe58b 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -14,6 +14,16 @@ Some convenience functions + + + + + +@object: +@name: +@value: + + diff --git a/gst/gstautoplug.c b/gst/gstautoplug.c index dc2c0174d0..5294737b40 100644 --- a/gst/gstautoplug.c +++ b/gst/gstautoplug.c @@ -94,6 +94,16 @@ _gst_autoplug_initialize (void) _gst_autoplugfactories = NULL; } +/** + * gst_autoplug_signal_new_object: + * @autoplug: The autoplugger to emit the signal + * @object: The object that is passed to the signal + * + * Emit a new_object signal. autopluggers are supposed to + * emit this signal whenever a new object has been added to + * the autoplugged pipeline. + * + */ void gst_autoplug_signal_new_object (GstAutoplug *autoplug, GstObject *object) { @@ -101,6 +111,18 @@ gst_autoplug_signal_new_object (GstAutoplug *autoplug, GstObject *object) } +/** + * gst_autoplug_to_caps: + * @autoplug: The autoplugger perform the autoplugging + * @srccaps: The source cpabilities + * @sinkcaps: The target capabilities + * @...: more target capabilities + * + * Perform the autoplugging procedure on the given autoplugger. + * The src caps will be connected to the sink caps. + * + * Returns: A new Element that connects the src caps to the sink caps. + */ GstElement* gst_autoplug_to_caps (GstAutoplug *autoplug, GstCaps *srccaps, GstCaps *sinkcaps, ...) { @@ -119,6 +141,18 @@ gst_autoplug_to_caps (GstAutoplug *autoplug, GstCaps *srccaps, GstCaps *sinkcaps return element; } +/** + * gst_autoplug_to_renderers: + * @autoplug: The autoplugger perform the autoplugging + * @srccaps: The source cpabilities + * @target: The target element + * @...: more target elements + * + * Perform the autoplugging procedure on the given autoplugger. + * The src caps will be connected to the target elements. + * + * Returns: A new Element that connects the src caps to the target elements. + */ GstElement* gst_autoplug_to_renderers (GstAutoplug *autoplug, GstCaps *srccaps, GstElement *target, ...) { @@ -168,27 +202,27 @@ gst_autoplugfactory_new (const gchar *name, const gchar *longdesc, GtkType type) /** * gst_autoplugfactory_destroy: - * @autoplug: factory to destroy + * @factory: factory to destroy * * Removes the autoplug from the global list. */ void -gst_autoplugfactory_destroy (GstAutoplugFactory *autoplug) +gst_autoplugfactory_destroy (GstAutoplugFactory *factory) { - g_return_if_fail (autoplug != NULL); + g_return_if_fail (factory != NULL); - _gst_autoplugfactories = g_list_remove (_gst_autoplugfactories, autoplug); + _gst_autoplugfactories = g_list_remove (_gst_autoplugfactories, factory); // we don't free the struct bacause someone might have a handle to it.. } /** - * gst_autoplug_find: - * @name: name of autoplugger to find + * gst_autoplugfactory_find: + * @name: name of autoplugfactory to find * - * Search for an autoplugger of the given name. + * Search for an autoplugfactory of the given name. * - * Returns: #GstAutoplug if found, NULL otherwise + * Returns: #GstAutoplugFactory if found, NULL otherwise */ GstAutoplugFactory* gst_autoplugfactory_find (const gchar *name) @@ -214,9 +248,9 @@ gst_autoplugfactory_find (const gchar *name) /** * gst_autoplugfactory_get_list: * - * Get the global list of elementfactories. + * Get the global list of autoplugfactories. * - * Returns: GList of type #GstElementFactory + * Returns: GList of type #GstAutoplugFactory */ GList* gst_autoplugfactory_get_list (void) @@ -224,6 +258,15 @@ gst_autoplugfactory_get_list (void) return _gst_autoplugfactories; } +/** + * gst_autoplugfactory_create: + * @factory: the factory used to create the instance + * + * Create a new #GstAutoplug instance from the + * given autoplugfactory. + * + * Returns: A new #GstAutoplug instance. + */ GstAutoplug* gst_autoplugfactory_create (GstAutoplugFactory *factory) { @@ -242,6 +285,15 @@ gst_autoplugfactory_create (GstAutoplugFactory *factory) return new; } +/** + * gst_autoplugfactory_make: + * @name: the name of the factory used to create the instance + * + * Create a new #GstAutoplug instance from the + * autoplugfactory with the given name. + * + * Returns: A new #GstAutoplug instance. + */ GstAutoplug* gst_autoplugfactory_make (const gchar *name) { @@ -257,6 +309,15 @@ gst_autoplugfactory_make (const gchar *name) return gst_autoplugfactory_create (factory);; } +/** + * gst_autoplugfactory_save_thyself: + * @factory: The facory to save + * @parent: the parent XML node pointer + * + * Save the autoplugfactory into an XML representation + * + * Returns: The new XML parent. + */ xmlNodePtr gst_autoplugfactory_save_thyself (GstAutoplugFactory *factory, xmlNodePtr parent) { @@ -268,6 +329,14 @@ gst_autoplugfactory_save_thyself (GstAutoplugFactory *factory, xmlNodePtr parent return parent; } +/** + * gst_autoplugfactory_load_thyself: + * @parent: the parent XML node pointer + * + * Load an autoplugfactory from the given XML parent node. + * + * Returns: A new factory based on the XML node. + */ GstAutoplugFactory* gst_autoplugfactory_load_thyself (xmlNodePtr parent) { diff --git a/gst/gstcaps.c b/gst/gstcaps.c index c878915ad8..84e255dda7 100644 --- a/gst/gstcaps.c +++ b/gst/gstcaps.c @@ -214,10 +214,12 @@ gst_caps_ref (GstCaps *caps) } /** - * gst_caps_copy_on_write: + * gst_caps_copy: * @caps: the caps to copy * - * Copies the caps if the refcount is greater than 1 + * Copies the caps. + * + * Returns: a copy of the GstCaps structure. */ GstCaps* gst_caps_copy (GstCaps *caps) @@ -239,6 +241,9 @@ gst_caps_copy (GstCaps *caps) * @caps: the caps to copy * * Copies the caps if the refcount is greater than 1 + * + * Returns: a pointer to a GstCaps strcuture that can + * be safely written to */ GstCaps* gst_caps_copy_on_write (GstCaps *caps) @@ -347,7 +352,7 @@ gst_caps_get_type_id (GstCaps *caps) /** * gst_caps_set_type_id: * @caps: the caps to set the type id to - * @typeid: the type id to set + * @type_id: the type id to set * * Set the type id of the caps. */ @@ -446,6 +451,17 @@ gst_caps_prepend (GstCaps *caps, GstCaps *capstoadd) return orig; } +/** + * gst_caps_get_by_name: + * @caps: a capabilty + * @name: the name of the capability to get + * + * Get the capability with the given name from this + * chain of capabilities. + * + * Returns: the first capability in the chain with the + * given name + */ GstCaps* gst_caps_get_by_name (GstCaps *caps, const gchar *name) { @@ -487,11 +503,11 @@ gst_caps_check_compatibility_func (GstCaps *fromcaps, GstCaps *tocaps) } /** - * gst_caps_list_check_compatibility: + * gst_caps_check_compatibility: * @fromcaps: a capabilty * @tocaps: a capabilty * - * Checks whether two capability lists are compatible. + * Checks whether two capabilities are compatible. * * Returns: TRUE if compatible, FALSE otherwise */ diff --git a/gst/gstpad.c b/gst/gstpad.c index 3aa883816b..69e05a5208 100644 --- a/gst/gstpad.c +++ b/gst/gstpad.c @@ -411,11 +411,11 @@ gst_pad_set_eos_function (GstPad *pad, } /** - * gst_pad_set_eos_function: - * @pad: the pad to set the eos function for - * @eos: the eos function + * gst_pad_set_negotiate_function: + * @pad: the pad to set the negotiate function for + * @nego: the negotiate function * - * Set the given EOS function for the pad. + * Set the given negotiate function for the pad. */ void gst_pad_set_negotiate_function (GstPad *pad, @@ -607,12 +607,12 @@ gst_pad_set_parent (GstPad *pad, } /** - * gst_pad_get_parent: - * @pad: the pad to get the parent from + * gst_pad_get_padtemplate: + * @pad: the pad to get the padtemplate from * - * Get the parent object of this pad. + * Get the padtemplate object of this pad. * - * Returns: the parent object + * Returns: the padtemplate object */ GstPadTemplate* gst_pad_get_padtemplate (GstPad *pad) @@ -726,9 +726,11 @@ gst_pad_get_ghost_pad_list (GstPad *pad) /** * gst_pad_set_caps: * @pad: the pad to set the caps to - * @caps: a GList of the capabilities to attach to this pad + * @caps: the capabilities to attach to this pad * * Set the capabilities of this pad. + * + * Returns: a boolean indicating the caps could be set on the pad */ gboolean gst_pad_set_caps (GstPad *pad, @@ -753,12 +755,12 @@ gst_pad_set_caps (GstPad *pad, } /** - * gst_pad_get_caps_list: + * gst_pad_get_caps: * @pad: the pad to get the capabilities from * * Get the capabilities of this pad. * - * Returns: a list of the capabilities of this pad + * Returns: the capabilities of this pad */ GstCaps* gst_pad_get_caps (GstPad *pad) @@ -774,6 +776,14 @@ gst_pad_get_caps (GstPad *pad) return NULL; } +/** + * gst_pad_get_padtemplate_caps: + * @pad: the pad to get the capabilities from + * + * Get the capabilities of this pad. + * + * Returns: a list of the capabilities of this pad + */ GstCaps* gst_pad_get_padtemplate_caps (GstPad *pad) { @@ -788,11 +798,11 @@ gst_pad_get_padtemplate_caps (GstPad *pad) /** - * gst_pad_get_caps_by_name: - * @pad: the pad to get the capabilities from + * gst_padtemplate_get_caps_by_name: + * @templ: the padtemplate to get the capabilities from * @name: the name of the capability to get * - * Get the capabilities with the given name from this pad. + * Get the capability with the given name from this padtemplate. * * Returns: a capability or NULL if not found */ @@ -1058,7 +1068,18 @@ gst_pad_renegotiate (GstPad *pad) return result; } - +/** + * gst_pad_negotiate_proxy: + * @srcpad: the pad that proxies + * @destpad: the pad to proxy the negotiation to + * @caps: the current caps + * @counter: a counter to keep track of the negotiation process + * + * Proxies the negotiation pad from srcpad to destpad. Further + * negotiation is done on the peers of both pad instead. + * + * Returns: the result of the negotiation preocess. + */ GstPadNegotiateReturn gst_pad_negotiate_proxy (GstPad *srcpad, GstPad *destpad, GstCaps **caps, gint counter) { diff --git a/gst/gstpad.h b/gst/gstpad.h index 55e24a0463..880174c1d6 100644 --- a/gst/gstpad.h +++ b/gst/gstpad.h @@ -309,7 +309,7 @@ gboolean gst_pad_connect (GstPad *srcpad, GstPad *sinkpad); void gst_pad_disconnect (GstPad *srcpad, GstPad *sinkpad); gboolean gst_pad_renegotiate (GstPad *pad); -GstPadNegotiateReturn gst_pad_negotiate_proxy (GstPad *srcpad, GstPad *destpad, GstCaps **caps, gint count); +GstPadNegotiateReturn gst_pad_negotiate_proxy (GstPad *srcpad, GstPad *destpad, GstCaps **caps, gint counter); #if 1 void gst_pad_push (GstPad *pad, GstBuffer *buf); diff --git a/gst/gstplugin.c b/gst/gstplugin.c index edeba3dbc7..8e03ea3aa4 100644 --- a/gst/gstplugin.c +++ b/gst/gstplugin.c @@ -776,11 +776,11 @@ gst_plugin_add_type (GstPlugin *plugin, GstTypeFactory *factory) } /** - * gst_plugin_add_type: - * @plugin: plugin to add type to - * @factory: the typefactory to add + * gst_plugin_add_autoplugger: + * @plugin: plugin to add the autoplugger to + * @factory: the autoplugfactory to add * - * Add a typefactory to the list of those provided by the plugin. + * Add an autoplugfactory to the list of those provided by the plugin. */ void gst_plugin_add_autoplugger (GstPlugin *plugin, GstAutoplugFactory *factory) diff --git a/gst/gstprops.c b/gst/gstprops.c index 211a147236..0db771045d 100644 --- a/gst/gstprops.c +++ b/gst/gstprops.c @@ -239,7 +239,7 @@ end: * * Returns: the new property created from the list of entries */ -GstProps * +GstProps* gst_props_new (GstPropsFactoryEntry entry, ...) { va_list var_args; @@ -307,6 +307,17 @@ gst_props_new (GstPropsFactoryEntry entry, ...) return props; } +/** + * gst_props_set: + * @props: the props to modify + * @name: the name of the entry to modify + * @entry: The new value of the property entry + * @...: More property entries. + * + * Modifies the value of the given entry in the props struct. + * + * Returns: the new modified property structure. + */ GstProps* gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry entry, ...) { @@ -356,6 +367,13 @@ gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry entry, . return props; } +/** + * gst_props_unref: + * @props: the props to unref + * + * Decrease the refcount of the property structure, destroying + * the property if the refcount is 0. + */ void gst_props_unref (GstProps *props) { @@ -367,6 +385,12 @@ gst_props_unref (GstProps *props) gst_props_destroy (props); } +/** + * gst_props_ref: + * @props: the props to ref + * + * Increase the refcount of the property structure. + */ void gst_props_ref (GstProps *props) { @@ -375,6 +399,13 @@ gst_props_ref (GstProps *props) props->refcount++; } +/** + * gst_props_destroy: + * @props: the props to destroy + * + * Destroy the property, freeing all the memory that + * was allocated. + */ void gst_props_destroy (GstProps *props) { @@ -398,6 +429,15 @@ gst_props_destroy (GstProps *props) g_list_free (props->properties); } +/** + * gst_props_copy: + * @props: the props to copy + * + * Copy the property structure. + * + * Returns: the new property that is a copy of the original + * one. + */ GstProps* gst_props_copy (GstProps *props) { @@ -434,6 +474,14 @@ gst_props_copy (GstProps *props) return new; } +/** + * gst_props_copy_on_write: + * @props: the props to copy on write + * + * Copy the property structure if the refcount is >1. + * + * Returns: A new props that can be safely written to. + */ GstProps* gst_props_copy_on_write (GstProps *props) { @@ -449,6 +497,15 @@ gst_props_copy_on_write (GstProps *props) return props; } +/** + * gst_props_get_int: + * @props: the props to get the int value from + * @name: the name of the props entry to get. + * + * Get the named entry as an integer. + * + * Returns: the integer value of the named entry, 0 if not found. + */ gint gst_props_get_int (GstProps *props, const gchar *name) { @@ -470,6 +527,15 @@ gst_props_get_int (GstProps *props, const gchar *name) return 0; } +/** + * gst_props_get_fourcc_int: + * @props: the props to get the fourcc value from + * @name: the name of the props entry to get. + * + * Get the named entry as a gulong fourcc. + * + * Returns: the fourcc value of the named entry, 0 if not found. + */ gulong gst_props_get_fourcc_int (GstProps *props, const gchar *name) { @@ -491,6 +557,15 @@ gst_props_get_fourcc_int (GstProps *props, const gchar *name) return 0; } +/** + * gst_props_get_boolean: + * @props: the props to get the fourcc value from + * @name: the name of the props entry to get. + * + * Get the named entry as a boolean value. + * + * Returns: the boolean value of the named entry, 0 if not found. + */ gboolean gst_props_get_boolean (GstProps *props, const gchar *name) { diff --git a/gst/gstprops.h b/gst/gstprops.h index cc9fe398bd..5da0492a7f 100644 --- a/gst/gstprops.h +++ b/gst/gstprops.h @@ -91,7 +91,7 @@ GstProps* gst_props_merge (GstProps *props, GstProps *tomerge); gboolean gst_props_check_compatibility (GstProps *fromprops, GstProps *toprops); -GstProps* gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry value, ...); +GstProps* gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry entry, ...); gint gst_props_get_int (GstProps *props, const gchar *name); gulong gst_props_get_fourcc_int (GstProps *props, const gchar *name); diff --git a/gst/gstutils.c b/gst/gstutils.c index a7dcf01581..2ade4a5053 100644 --- a/gst/gstutils.c +++ b/gst/gstutils.c @@ -35,7 +35,9 @@ * * Returns: the property of the object */ -gint gst_util_get_int_arg(GtkObject *object,guchar *argname) { +gint +gst_util_get_int_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; @@ -52,7 +54,9 @@ gint gst_util_get_int_arg(GtkObject *object,guchar *argname) { * * Returns: the property of the object */ -gint gst_util_get_bool_arg(GtkObject *object,guchar *argname) { +gint +gst_util_get_bool_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; @@ -69,7 +73,9 @@ gint gst_util_get_bool_arg(GtkObject *object,guchar *argname) { * * Returns: the property of the object */ -glong gst_util_get_long_arg(GtkObject *object,guchar *argname) { +glong +gst_util_get_long_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; @@ -86,7 +92,9 @@ glong gst_util_get_long_arg(GtkObject *object,guchar *argname) { * * Returns: the property of the object */ -gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) { +gfloat +gst_util_get_float_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; @@ -103,7 +111,9 @@ gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) { * * Returns: the property of the object */ -gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) { +gdouble +gst_util_get_double_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; @@ -120,7 +130,9 @@ gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) { * * Returns: the property of the object */ -guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) { +guchar* +gst_util_get_string_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; @@ -137,11 +149,14 @@ guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) { * * Returns: the property of the object */ -gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) { +gpointer +gst_util_get_pointer_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; gtk_object_getv(GTK_OBJECT(object),1,&arg); + return GTK_VALUE_POINTER(arg); } @@ -154,11 +169,14 @@ gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) { * * Returns: the property of the object */ -GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) { +GtkWidget* +gst_util_get_widget_arg (GtkObject *object,guchar *argname) +{ GtkArg arg; arg.name = argname; gtk_object_getv(GTK_OBJECT(object),1,&arg); + return GTK_WIDGET(GTK_VALUE_OBJECT(arg)); } @@ -169,7 +187,9 @@ GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) { * * Dumps the memory block into a hex representation. Useful for debugging. */ -void gst_util_dump_mem(guchar *mem, guint size) { +void +gst_util_dump_mem (guchar *mem, guint size) +{ guint i, j; i = j =0; @@ -187,7 +207,17 @@ void gst_util_dump_mem(guchar *mem, guint size) { g_print("\n"); } -void gst_util_set_object_arg (GtkObject *object, guchar *name, gchar *value) +/** + * gst_util_set_object_arg: + * @object: the object to set the argument of + * @name: the name of the argument to set + * @value: the string value to set + * + * Convertes the string value to the type of the objects argument and + * sets the argument with it. + */ +void +gst_util_set_object_arg (GtkObject *object, guchar *name, gchar *value) { if (name && value) { GtkType type = GTK_OBJECT_TYPE (object);