+2005-08-26 Stefan Kost <ensonic@users.sf.net>
+
+ * gst/gstbin.h:
+ removed ';' from the end of macro defs
+ * docs/gst/gstreamer-docs.sgml:
+ * docs/gst/gstreamer-sections.txt:
+ * docs/gst/tmpl/.cvsignore:
+ * gst/gstbus.h:
+ * gst/gstelement.c: (gst_element_class_init),
+ (gst_element_set_state), (activate_pads),
+ (gst_element_save_thyself):
+ * gst/gstevent.c: (gst_event_new_newsegment):
+ * gst/gstevent.h:
+ * gst/gstiterator.c:
+ * gst/gstiterator.h:
+ * gst/gstpad.c:
+ * gst/gstprobe.h:
+ * gst/gstutils.c: (gst_pad_query_convert):
+ * gst/gstutils.h:
+ fixed parameter name mismatches between source, header and docs
+ added some more docs, resolved the last batch of unused elements in
+ docs (now someone needs to doc them)
+
2005-08-25 Thomas Vander Stichele <thomas at apestaart dot org>
* gst/registries/gstlibxmlregistry.c: (gst_xml_registry_rebuild):
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
<!ENTITY GstBus SYSTEM "xml/gstbus.xml">
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
+<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
<!ENTITY GstChildProxy SYSTEM "xml/gstchildproxy.xml">
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
<!--
&GstBuffer;
&GstBus;
&GstCaps;
+ &GstCheck;
&GstChildProxy;
&GstClock;
&GstConfig;
# GStreamer API reference sections
# please add sections in alphabetical order using the following template
+# leave two empty lines between sections
# <SECTION>
# <FILE>gstxxx</FILE>
# <TITLE>GstXxx</TITLE>
<INCLUDE>gst/gst.h</INCLUDE>
+
<SECTION>
<FILE>gst</FILE>
<TITLE>Gst</TITLE>
gst_init_get_popt_table
gst_deinit
<SUBSECTION Private>
-#GstPoptOption
+GstPoptOption
+mutex
+start_cond
+sync_cond
+thread_list
</SECTION>
+
<SECTION>
<FILE>gstbin</FILE>
<TITLE>GstBin</TITLE>
<SUBSECTION Private>
gst_bin_get_type
gst_bin_flags_get_type
-
</SECTION>
+
<SECTION>
<FILE>gstbus</FILE>
<TITLE>GstBus</TITLE>
gst_bus_sync_reply_get_type
</SECTION>
+
<SECTION>
<FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE>
gst_buffer_flag_get_type
</SECTION>
+
<SECTION>
<FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE>
gst_caps_get_type
</SECTION>
+
+<SECTION>
+<FILE>gstcheck</FILE>
+<TITLE>GstCheck</TITLE>
+ASSERT_BUFFER_REFCOUNT
+ASSERT_CAPS_REFCOUNT
+ASSERT_CRITICAL
+ASSERT_MINI_OBJECT_REFCOUNT
+ASSERT_OBJECT_REFCOUNT
+ASSERT_OBJECT_REFCOUNT_BETWEEN
+MAIN_INIT
+MAIN_START_THREADS
+MAIN_START_THREAD_FUNCTION
+MAIN_START_THREAD_FUNCTIONS
+MAIN_STOP_THREADS
+MAIN_SYNCHRONIZE
+THREAD_START
+THREAD_STARTED
+THREAD_SWITCH
+THREAD_SYNCHRONIZE
+THREAD_TEST_RUNNING
+GST_START_TEST
+GST_END_TEST
+
+fail_unless_equals_int
+fail_unless_equals_string
+fail_unless_equals_uint64
+fail_unless_message_error
+
+gst_check_chain_func
+gst_check_init
+gst_check_message_error
+gst_check_setup_element
+gst_check_setup_sink_pad
+gst_check_setup_src_pad
+gst_check_teardown_element
+gst_check_teardown_sink_pad
+gst_check_teardown_src_pad
+
+<SUBSECTION Private>
+</SECTION>
+
+
<SECTION>
<FILE>gstchildproxy</FILE>
<TITLE>GstChildProxy</TITLE>
gst_child_proxy_get_type
</SECTION>
+
<SECTION>
<FILE>gstclock</FILE>
<TITLE>GstClock</TITLE>
GST_CLOCK_DIFF
GST_TIMEVAL_TO_TIME
GST_TIME_TO_TIMEVAL
+GST_TIMESPEC_TO_TIME
+GST_TIME_TO_TIMESPEC
GST_CLOCK_ENTRY_TRACE_NAME
GstClockEntry
GstClockCallback
gst_clock_return_get_type
</SECTION>
+
<SECTION>
<FILE>gstcompat</FILE>
<TITLE>GstCompat</TITLE>
<SUBSECTION Private>
</SECTION>
+
<SECTION>
<FILE>gstconfig</FILE>
<SUBSECTION Private>
GST_PLUGIN_EXPORT
</SECTION>
+
<SECTION>
<FILE>gstelement</FILE>
<TITLE>GstElement</TITLE>
GstElement
GstElementClass
+GstElementFlags
GST_NUM_STATES
GST_STATE
GST_STATE_PENDING
GST_STATE_PLAYING_TO_PAUSED
GST_STATE_PAUSED_TO_READY
GST_STATE_READY_TO_NULL
-GstElementFlags
+GST_STATE_BROADCAST
+GST_STATE_ERROR
+GST_STATE_FINAL
+GST_STATE_GET_COND
+GST_STATE_GET_LOCK
+GST_STATE_LOCK
+GST_STATE_NO_PREROLL
+GST_STATE_SIGNAL
+GST_STATE_TIMED_WAIT
+GST_STATE_TRYLOCK
+GST_STATE_UNLOCK
+GST_STATE_WAIT
GST_ELEMENT_NAME
GST_ELEMENT_PARENT
GST_ELEMENT_CLOCK
GST_ELEMENT_PADS
GST_ELEMENT_ERROR
+GST_ELEMENT_BUS
+GST_ELEMENT_WARNING
+GST_ELEMENT_IS_LOCKED_STATE
+
+gst_element_abort_preroll
+gst_element_abort_state
+gst_element_add_pad
gst_element_class_add_pad_template
+gst_element_class_get_pad_template
+gst_element_class_get_pad_template_list
gst_element_class_install_std_props
gst_element_class_set_details
-gst_element_get_name
-gst_element_set_name
-gst_element_get_parent
-gst_element_set_parent
-gst_element_requires_clock
-gst_element_provides_clock
+gst_element_commit_state
+gst_element_create_all_pads
+gst_element_factory_can_sink_caps
+gst_element_factory_can_src_caps
+gst_element_factory_get_static_pad_templates
+gst_element_finish_preroll
+gst_element_found_tags
+gst_element_found_tags_for_pad
+gst_element_get_base_time
+gst_element_get_bus
gst_element_get_clock
-gst_element_set_clock
-gst_element_is_indexable
-gst_element_set_index
+gst_element_get_compatible_pad
+gst_element_get_compatible_pad_template
+gst_element_get_factory
gst_element_get_index
-gst_element_add_pad
-gst_element_remove_pad
+gst_element_get_name
gst_element_get_pad
-gst_element_get_static_pad
+gst_element_get_parent
+gst_element_get_query_types
gst_element_get_request_pad
-gst_element_release_request_pad
-gst_element_get_compatible_pad
-gst_element_get_compatible_pad_template
+gst_element_get_state
+gst_element_get_static_pad
+gst_element_is_indexable
+gst_element_is_locked_state
+gst_element_iterate_pads
+gst_element_iterate_sink_pads
+gst_element_iterate_src_pads
gst_element_link
gst_element_link_many
-gst_element_unlink
-gst_element_unlink_many
gst_element_link_pads
-gst_element_unlink_pads
-gst_element_send_event
-gst_element_seek
-gst_element_get_query_types
+gst_element_link_pads_filtered
+gst_element_lost_state
+gst_element_message_full
+gst_element_no_more_pads
+gst_element_post_message
+gst_element_provides_clock
gst_element_query
-gst_element_is_locked_state
+gst_element_query_convert
+gst_element_query_position
+gst_element_release_request_pad
+gst_element_remove_pad
+gst_element_requires_clock
+gst_element_seek
+gst_element_send_event
+gst_element_set_base_time
+gst_element_set_bus
+gst_element_set_clock
+gst_element_set_index
gst_element_set_locked_state
-gst_element_sync_state_with_parent
-gst_element_get_state
+gst_element_set_name
+gst_element_set_parent
gst_element_set_state
gst_element_state_get_name
-gst_element_get_factory
-gst_element_no_more_pads
+gst_element_sync_state_with_parent
+gst_element_unlink
+gst_element_unlink_many
+gst_element_unlink_pads
<SUBSECTION Standard>
GST_ELEMENT
GST_IS_ELEMENT
gst_element_flags_get_type
</SECTION>
+
<SECTION>
<FILE>gstelementdetails</FILE>
<TITLE>GstElementDetails</TITLE>
GST_IS_ELEMENT_DETAILS
</SECTION>
+
<SECTION>
<FILE>gstelementfactory</FILE>
<TITLE>GstElementFactory</TITLE>
gst_element_factory_get_type
</SECTION>
+
<SECTION>
<FILE>gsterror</FILE>
<TITLE>GstGError</TITLE>
gst_stream_error_get_type
</SECTION>
+
<SECTION>
<FILE>gstevent</FILE>
<TITLE>GstEvent</TITLE>
GstSeekFlags
GST_EVENT_MAKE_TYPE
+GST_EVDIR_BOTH
+GST_EVDIR_DS
+GST_EVDIR_US
gst_event_ref
gst_event_unref
GST_TYPE_SEEK_TYPE
GST_TYPE_SEEK_FLAGS
<SUBSECTION Private>
+GST_EVSER
+GST_EVSHIFT
gst_event_get_type
gst_event_type_get_type
gst_seek_type_get_type
gst_seek_flags_get_type
</SECTION>
+
<SECTION>
<FILE>gstfilter</FILE>
<TITLE>GstFilter</TITLE>
gst_filter_run
</SECTION>
+
<SECTION>
<FILE>gstformat</FILE>
<TITLE>GstFormat</TITLE>
gst_format_get_type
</SECTION>
+
<SECTION>
<FILE>gstghostpad</FILE>
<TITLE>GstGhostPad</TITLE>
gst_ghost_pad_get_type
</SECTION>
+
<SECTION>
<FILE>gstindex</FILE>
<TITLE>GstIndex</TITLE>
gst_index_resolver_method_get_type
</SECTION>
+
<SECTION>
<FILE>gstindexfactory</FILE>
<TITLE>GstIndexFactory</TITLE>
gst_index_factory_get_type
</SECTION>
+
<SECTION>
<FILE>gstinfo</FILE>
<TITLE>GstInfo</TITLE>
GST_DEBUG_PAD_NAME
GST_FUNCTION
GstDebugMessage
+GstDebugFuncPtr
GstLogFunction
gst_debug_log
gst_debug_log_valist
gst_debug_level_get_type
</SECTION>
+
<SECTION>
<FILE>gstimplementsinterface</FILE>
<TITLE>GstImplementsInterface</TITLE>
gst_implements_interface_get_type
</SECTION>
+
<SECTION>
<FILE>gstiterator</FILE>
<TITLE>GstIterator</TITLE>
gst_iterator_foreach
gst_iterator_find_custom
-
<SUBSECTION Standard>
GST_TYPE_ITERATOR_ITEM
GST_TYPE_ITERATOR_RESULT
gst_iterator_result_get_type
</SECTION>
+
<SECTION>
<FILE>gstmacros</FILE>
<TITLE>GstMacros</TITLE>
GST_CAN_INLINE
</SECTION>
+
<SECTION>
<FILE>gstmemchunk</FILE>
<TITLE>GstMemChunk</TITLE>
gst_mem_chunk_free
</SECTION>
+
<SECTION>
<FILE>gstmessage</FILE>
<TITLE>GstMessage</TITLE>
GST_MESSAGE_WAIT
gst_message_copy
gst_message_get_structure
-gst_message_get_type
gst_message_make_writable
gst_message_new_application
gst_message_new_custom
gst_message_get_type
</SECTION>
+
<SECTION>
<FILE>gstminiobject</FILE>
<TITLE>GstMiniObject</TITLE>
gst_mini_object_flags_get_type
</SECTION>
+
<SECTION>
<FILE>gstobject</FILE>
<TITLE>GstObject</TITLE>
GST_OBJECT_IS_FLOATING
GST_OBJECT_REFCOUNT
GST_OBJECT_REFCOUNT_VALUE
+GST_CLASS_GET_LOCK
+GST_CLASS_LOCK
+GST_CLASS_TRYLOCK
+GST_CLASS_UNLOCK
gst_object_set_name
gst_object_get_name
xmlNodePtr
</SECTION>
+
<SECTION>
<FILE>gstpad</FILE>
<TITLE>GstPad</TITLE>
GstPadFlags
GstPadLinkReturn
GstPadPresence
+GstFlowReturn
+GstActivateMode
+
+GST_PREROLL_BROADCAST
+GST_PREROLL_GET_COND
+GST_PREROLL_GET_LOCK
+GST_PREROLL_LOCK
+GST_PREROLL_SIGNAL
+GST_PREROLL_TIMED_WAIT
+GST_PREROLL_TRYLOCK
+GST_PREROLL_UNLOCK
+GST_PREROLL_WAIT
+GST_STREAM_GET_LOCK
+GST_STREAM_LOCK
+GST_STREAM_LOCK_FULL
+GST_STREAM_TRYLOCK
+GST_STREAM_UNLOCK
+GST_STREAM_UNLOCK_FULL
+GST_FLOW_IS_FATAL
gst_pad_new
gst_pad_new_from_template
gst_pad_remove_data_probe
gst_pad_remove_buffer_probe
gst_pad_remove_event_probe
+
<SUBSECTION Standard>
GstPadClass
GST_PAD
GST_TYPE_PAD_FLAGS
GST_TYPE_PAD_LINK_RETURN
GST_TYPE_PAD_PRESENCE
+GST_TYPE_FLOW_RETURN
+GST_TYPE_ACTIVATE_MODE
<SUBSECTION Private>
gst_pad_get_type
gst_pad_flags_get_type
gst_pad_link_return_get_type
gst_pad_presence_get_type
+gst_flow_return_get_type
+gst_activate_mode_get_type
GST_PAD_NAME
GST_PAD_PARENT
GST_PAD_QUERYTYPEFUNC
GST_PAD_SETCAPSFUNC
GST_PAD_UNLINKFUNC
-
</SECTION>
+
<SECTION>
<FILE>gstpadtemplate</FILE>
<TITLE>GstPadTemplate</TITLE>
GstPadTemplateFlags
gst_pad_template_new
gst_static_pad_template_get
+gst_static_pad_template_get_caps
gst_pad_template_get_caps
<SUBSECTION Standard>
GstPadTemplateClass
gst_pad_template_flags_get_type
</SECTION>
+
<SECTION>
<FILE>gstparse</FILE>
<TITLE>GstParse</TITLE>
gst_parse_error_get_type
</SECTION>
+
<SECTION>
<FILE>gstpipeline</FILE>
<TITLE>GstPipeline</TITLE>
gst_pipeline_flags_get_type
</SECTION>
+
<SECTION>
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
gst_plugin_error_get_type
</SECTION>
+
<SECTION>
<FILE>gstpluginfeature</FILE>
<TITLE>GstPluginFeature</TITLE>
gst_plugin_feature_get_type
</SECTION>
+
<SECTION>
<FILE>gstprobe</FILE>
<TITLE>GstProbe</TITLE>
gst_query_type_get_type
</SECTION>
+
<SECTION>
<FILE>gstqueue</FILE>
<TITLE>GstQueue</TITLE>
gst_registry_return_get_type
</SECTION>
+
<SECTION>
<FILE>gstregistrypool</FILE>
<TITLE>GstRegistryPool</TITLE>
gst_registry_pool_get_prefered
</SECTION>
+
<SECTION>
<FILE>gststructure</FILE>
<TITLE>GstStructure</TITLE>
GstStructure
GstStructureForeachFunc
+GstStructureMapFunc
gst_structure_empty_new
gst_structure_id_empty_new
gst_structure_new
gst_structure_get_fourcc
gst_structure_get_double
gst_structure_get_string
+gst_structure_map_in_place
+gst_structure_nth_field_name
+gst_structure_set_parent_refcount
gst_structure_to_string
gst_structure_from_string
gst_caps_structure_fixate_field_nearest_int
gst_structure_get_type
</SECTION>
+
<SECTION>
<FILE>gstsystemclock</FILE>
<TITLE>GstSystemClock</TITLE>
GST_TYPE_SYSTEM_CLOCK
</SECTION>
+
<SECTION>
<FILE>gsttaglist</FILE>
<TITLE>GstTagList</TITLE>
gst_tag_merge_mode_get_type
</SECTION>
+
<SECTION>
<FILE>gsttagsetter</FILE>
<TITLE>GstTagSetter</TITLE>
gst_tag_setter_get_type
</SECTION>
+
<SECTION>
<FILE>gsttask</FILE>
<TITLE>GstTask</TITLE>
GST_TASK_BROADCAST
GST_TASK_GET_COND
GST_TASK_GET_LOCK
-GST_TASK_LOCK
-GST_TASK_LOCK_FULL
GST_TASK_SIGNAL
GST_TASK_STATE
-GST_TASK_UNLOCK
-GST_TASK_UNLOCK_FULL
GST_TASK_WAIT
+gst_task_cleanup_all
gst_task_create
gst_task_get_state
gst_task_get_type
+gst_task_join
gst_task_pause
gst_task_set_lock
gst_task_start
-gst_task_state_get_type
gst_task_stop
+
<SUBSECTION Standard>
GstTaskClass
GST_TASK
GST_TYPE_TASK_STATE
<SUBSECTION Private>
gst_task_get_type
+gst_task_state_get_type
</SECTION>
+
<SECTION>
<FILE>gsttrace</FILE>
<TITLE>GstTrace</TITLE>
gst_alloc_trace_set_flags_all
gst_alloc_trace_get
gst_alloc_trace_print
+gst_alloc_trace_print_live
gst_alloc_trace_set_flags
gst_alloc_trace_register
gst_alloc_trace_new
gst_alloc_trace_flags_get_type
</SECTION>
+
<SECTION>
<FILE>gsttrashstack</FILE>
<TITLE>GstTrashStack</TITLE>
SMP_LOCK
</SECTION>
+
<SECTION>
<FILE>gsttypefind</FILE>
<TITLE>GstTypeFind</TITLE>
gst_type_find_probability_get_type
</SECTION>
+
<SECTION>
<FILE>gsttypefindfactory</FILE>
<TITLE>GstTypeFindFactory</TITLE>
gst_type_find_factory_get_type
</SECTION>
+
<SECTION>
<FILE>gsttypes</FILE>
<TITLE>GstTypes</TITLE>
gst_rank_get_type
</SECTION>
+
<SECTION>
<FILE>gsturihandler</FILE>
<TITLE>GstUriHandler</TITLE>
gst_uri_handler_get_type
</SECTION>
+
<SECTION>
<FILE>gsturitype</FILE>
<TITLE>GstUriType</TITLE>
gst_uri_type_get_type
</SECTION>
+
<SECTION>
<FILE>gstutils</FILE>
<TITLE>GstUtils</TITLE>
GST_ROUND_UP_32
GST_ROUND_UP_64
-gst_util_set_value_from_string
-gst_util_set_object_arg
-gst_util_dump_mem
-gst_print_pad_caps
-gst_print_element_args
+gst_atomic_int_set
gst_bin_watch_for_state_change
+gst_flow_get_name
+gst_print_element_args
+gst_print_pad_caps
+gst_util_dump_mem
+gst_util_set_object_arg
+gst_util_set_value_from_string
<SUBSECTION Private>
GST_HAVE_UNALIGNED_ACCESS
</SECTION>
+
<SECTION>
<FILE>gstvalue</FILE>
<TITLE>GstValue</TITLE>
GST_VALUE_EQUAL
GST_VALUE_GREATER_THAN
GST_VALUE_UNORDERED
+
GstValueCompareFunc
GstValueSerializeFunc
GstValueDeserializeFunc
GstValueIntersectFunc
GstValueSubtractFunc
GstValueTable
+
gst_value_is_fixed
gst_value_register
gst_value_init_and_copy
gst_value_get_fraction_numerator
gst_value_get_fraction_denominator
gst_value_set_fraction
+gst_value_get_buffer
+gst_value_set_buffer
+gst_value_take_buffer
gst_value_fraction_multiply
gst_value_compare
gst_value_can_compare
GST_TYPE_DOUBLE_RANGE
GST_TYPE_LIST
GST_TYPE_FRACTION
+GST_TYPE_ARRAY
</SECTION>
+
<SECTION>
<FILE>gstversion</FILE>
<TITLE>GstVersion</TITLE>
gst_version
</SECTION>
+
<SECTION>
<FILE>gstxml</FILE>
<TITLE>GstXML</TITLE>
gst_xml_get_type
</SECTION>
+
<SECTION>
<FILE>gstxmlregistry</FILE>
<TITLE>GstXMLRegistry</TITLE>
gst_xml_registry_get_type
</SECTION>
+
<SECTION>
<FILE>gstenumtypes</FILE>
<TITLE>GstEnumTypes</TITLE>
</SECTION>
+
# base classes
<SECTION>
gst_fake_src_get_type
</SECTION>
+
<SECTION>
<FILE>gstfakesink</FILE>
<TITLE>GstFakeSink</TITLE>
gst_fake_sink_get_type
</SECTION>
+
<SECTION>
<FILE>gstfilesrc</FILE>
<TITLE>GstFileSrc</TITLE>
gst_file_src_get_type
</SECTION>
+
<SECTION>
<FILE>gstfilesink</FILE>
<TITLE>GstFileSink</TITLE>
gstbin.sgml
gstbuffer.sgml
gstbus.sgml
+gstcheck.sgml
gstcollectpads.sgml
gstevent.sgml
gstfakesrc.sgml
gstfilesrc.sgml
gstfilesink.sgml
gstmessage.sgml
+gstminiobject.sgml
gstprobe.sgml
gstpushsrc.sgml
gsttask.sgml
*
* Returns: the number of child objects
*/
-#define GST_BIN_NUMCHILDREN(bin) (GST_BIN_CAST(bin)->numchildren);
+#define GST_BIN_NUMCHILDREN(bin) (GST_BIN_CAST(bin)->numchildren)
/**
* GST_BIN_CHILDREN:
* @bin: the bin to get the list with children from
*
* Returns: the children list
*/
-#define GST_BIN_CHILDREN(bin) (GST_BIN_CAST(bin)->children);
+#define GST_BIN_CHILDREN(bin) (GST_BIN_CAST(bin)->children)
/**
* GST_BIN_CHILDREN_COOKIE:
* @bin: the bin to get the children cookie from
*
* Returns: the children cookie
*/
-#define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie);
+#define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie)
struct _GstBin {
GstElement element;
GST_BUS_ASYNC = 2, /* pass message to async queue, continue if message is handled */
} GstBusSyncReply;
+/**
+ * GstBusSyncHandler:
+ * @bus: the #GstBus that sent the message
+ * @messages: the #GstMessage
+ * @data: user data that has been given, when registering the handler
+ *
+ * Handler will be invoked synchronously, when a new message has been injected
+ * into the bus.
+ *
+ * Returns: #GstBusSyncReply stating what to do with the message
+ */
typedef GstBusSyncReply (*GstBusSyncHandler) (GstBus * bus, GstMessage * message, gpointer data);
+/**
+ * GstBusHandler:
+ * @bus: the #GstBus that sent the message
+ * @messages: the #GstMessage
+ * @data: user data that has been given, when registering the handler
+ *
+ * Handler will be invoked asynchronously, after a new message has been injected
+ * into the bus.
+ *
+ * Returns: %TRUE if message should be taken from the bus
+ */
typedef gboolean (*GstBusHandler) (GstBus * bus, GstMessage * message, gpointer data);
struct _GstBus
/**
* GstElement::state-changed:
* @gstelement: the object which received the signal
- * @int:
- * @int:
+ * @old_state: the GST_STATE_XXX before the change
+ * @new_state: the GST_STATE_XXX after the change
*
* the #GstElementState of the element has been changed
*/
/**
* GstElement::pad-added:
* @gstelement: the object which received the signal
- * @object:
+ * @new_pad: the pad that has been added
*
* a new #GstPad has been added to the element
*/
/**
* GstElement::pad-removed:
* @gstelement: the object which received the signal
- * @object:
+ * @old_pad: the pad that has been removed
*
* a #GstPad has been removed from the element
*/
* GstElement::no-more-pads:
* @gstelement: the object which received the signal
*
- * ?
+ * This signals that the element will not generate more dynamic pads.
*/
gst_element_signals[NO_MORE_PADS] =
g_signal_new ("no-more-pads", G_TYPE_FROM_CLASS (klass),
/**
* gst_element_seek:
* @element: a #GstElement to send the event to.
- * @seek_method: the method to use for seeking (GST_SEEK_METHOD_*).
- * @seek_format: the #GstFormat to use for seeking (GST_FORMAT_*).
- * @seek_flags: the flags to use for seeking (GST_SEEK_FLAG_*).
- * @offset: the offset to seek to (in the given seek_format).
+ * @rate: The new playback rate
+ * @format: The format of the seek values
+ * @flags: The optional seek flags.
+ * @cur_type: The type and flags for the new current position
+ * @cur: The value of the new current position
+ * @stop_type: The type and flags for the new stop position
+ * @stop: The value of the new stop position
*
* Sends a seek event to an element.
*
- * Returns: TRUE if the event was handled.
+ * Returns: %TRUE if the event was handled.
*
* MT safe.
*/
GstElementState pending;
GTimeVal tv;
+ g_return_val_if_fail (GST_IS_ELEMENT (element), GST_STATE_FAILURE);
/* get current element state, need to call the method so that
* we call the virtual method and subclasses can implement their
GST_STATE_FINAL (element) = state;
if (ret == GST_STATE_ASYNC) {
gst_element_commit_state (element);
+ gst_element_lost_state (element);
}
/* start with the current state */
{
if (!gst_pad_set_active (pad, *active))
g_value_set_boolean (ret, FALSE);
+ else if (!*active)
+ gst_pad_set_caps (pad, NULL);
gst_object_unref (pad);
return TRUE;
(xmlChar *) GST_PLUGIN_FEATURE (factory)->name);
}
-/* FIXME: what is this? */
-/* if (element->manager) */
-/* xmlNewChild(parent, NULL, "manager", GST_ELEMENT_NAME(element->manager)); */
-
/* params */
specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (object), &nspecs);
* gst_event_new_newsegment:
* @rate: a new rate for playback
* @format: The format of the segment values
- * @start_val: the start value of the segment
- * @stop_val: the stop value of the segment
+ * @start_value: the start value of the segment
+ * @stop_value: the stop value of the segment
* @base: base value for buffer timestamps.
*
* Allocate a new newsegment event with the given format/values tripplets.
*/
GstEvent *
gst_event_new_newsegment (gdouble rate, GstFormat format,
- gint64 start_val, gint64 stop_val, gint64 base)
+ gint64 start_value, gint64 stop_value, gint64 base)
{
if (format == GST_FORMAT_TIME) {
GST_CAT_INFO (GST_CAT_EVENT,
"creating newsegment rate %lf, format GST_FORMAT_TIME, "
"start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
", base %" GST_TIME_FORMAT,
- rate, GST_TIME_ARGS (start_val),
- GST_TIME_ARGS (stop_val), GST_TIME_ARGS (base));
+ rate, GST_TIME_ARGS (start_value),
+ GST_TIME_ARGS (stop_value), GST_TIME_ARGS (base));
} else {
GST_CAT_INFO (GST_CAT_EVENT,
"creating newsegment rate %lf, format %d, "
"start %lld, stop %lld, base %lld",
- rate, format, start_val, stop_val, base);
+ rate, format, start_value, stop_value, base);
}
- if (start_val != -1 && stop_val != -1)
- g_return_val_if_fail (start_val < stop_val, NULL);
+ if (start_value != -1 && stop_value != -1)
+ g_return_val_if_fail (start_value < stop_value, NULL);
return gst_event_new_custom (GST_EVENT_NEWSEGMENT,
gst_structure_new ("GstEventNewsegment", "rate", G_TYPE_DOUBLE, rate,
"format", GST_TYPE_FORMAT, format,
- "start_val", G_TYPE_INT64, start_val,
- "stop_val", G_TYPE_INT64, stop_val,
+ "start_val", G_TYPE_INT64, start_value,
+ "stop_val", G_TYPE_INT64, stop_value,
"base", G_TYPE_INT64, base, NULL));
}
GstEvent * gst_event_new_eos (void);
/* newsegment events */
-GstEvent* gst_event_new_newsegment (gdouble rate,
- GstFormat format, gint64 start_value, gint64 stop_value,
+GstEvent* gst_event_new_newsegment (gdouble rate, GstFormat format,
+ gint64 start_value, gint64 stop_value,
gint64 base);
void gst_event_parse_newsegment (GstEvent *event, gdouble *rate, GstFormat *format,
- gint64 *start_value, gint64 *end_value, gint64 *base);
+ gint64 *start_value, gint64 *stop_value, gint64 *base);
/* tag event */
GstEvent* gst_event_new_tag (GstTagList *taglist);
void gst_event_parse_tag (GstEvent *event, GstTagList **taglist);
/**
* gst_iterator_foreach:
- * @it: The #GstIterator to iterate
+ * @iter: The #GstIterator to iterate
* @func: the function to call for each element.
* @user_data: user data passed to the function
*
GstIteratorDisposeFunction free);
/* using iterators */
-GstIteratorResult gst_iterator_next (GstIterator *it, gpointer *result);
+GstIteratorResult gst_iterator_next (GstIterator *it, gpointer *elem);
void gst_iterator_resync (GstIterator *it);
void gst_iterator_free (GstIterator *it);
/**
* gst_pad_set_activate_function:
* @pad: a sink #GstPad.
- * @chain: the #GstPadActivateFunction to set.
+ * @activate: the #GstPadActivateFunction to set.
*
* Sets the given activate function for the pad. The activate function will
* dispatch to activate_push or activate_pull to perform the actual activation.
/**
* gst_pad_set_activatepull_function:
* @pad: a sink #GstPad.
- * @chain: the #GstPadActivateModeFunction to set.
+ * @activatepull: the #GstPadActivateModeFunction to set.
*
* Sets the given activate_pull function for the pad. An activate_pull function
* prepares the element and any upstream connections for pulling. See XXX
/**
* gst_pad_set_activatepush_function:
* @pad: a sink #GstPad.
- * @chain: the #GstPadActivateModeFunction to set.
+ * @activatepush: the #GstPadActivateModeFunction to set.
*
* Sets the given activate_push function for the pad. An activate_push function
* prepares the element for pushing. See XXX part-activation.txt for details.
/**
* gst_pad_get_range:
* @pad: a src #GstPad.
- * @buffer: a pointer to hold the #GstBuffer.
* @offset: The start offset of the buffer
- * @length: The length of the buffer
+ * @size: The length of the buffer
+ * @buffer: a pointer to hold the #GstBuffer.
*
* Calls the getrange function of @pad.
*
/**
* gst_pad_pull_range:
* @pad: a sink #GstPad.
- * @buffer: a pointer to hold the #GstBuffer.
* @offset: The start offset of the buffer
- * @length: The length of the buffer
+ * @size: The length of the buffer
+ * @buffer: a pointer to hold the #GstBuffer.
*
* Pulls a buffer from the peer pad. @pad must be linked.
*
gpointer user_data);
void gst_probe_destroy (GstProbe *probe);
-gboolean gst_probe_perform (GstProbe *probe, GstMiniObject **data);
+gboolean gst_probe_perform (GstProbe *probe, GstMiniObject **mini_object);
typedef struct _GstProbeDispatcher GstProbeDispatcher;
* @srcpadname: the name of the #GstPad in source element or NULL for any pad.
* @dest: the #GstElement containing the destination pad.
* @destpadname: the name of the #GstPad in destination element or NULL for any pad.
- * @caps: the #GstCaps to filter the link, or #NULL for no filter.
+ * @filter: the #GstCaps to filter the link, or #NULL for no filter.
*
* Links the two named pads of the source and destination elements. Side effect
* is that if one of the pads has no parent, it becomes a child of the parent of
/**
* gst_flow_get_name:
- * @state: a #GstFlowReturn to get the name of.
+ * @ret: a #GstFlowReturn to get the name of.
*
* Gets a string representing the given flow return.
*
/**
* gst_object_default_error:
- * @object: a #GObject that signalled the error.
- * @orig: the #GstObject that initiated the error.
+ * @source: the #GstObject that initiated the error.
* @error: the GError.
* @debug: an additional debug information string, or NULL.
*
*/
gboolean
gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
- GstFormat * dest_fmt, gint64 * dest_val)
+ GstFormat * dest_format, gint64 * dest_val)
{
GstQuery *query;
gboolean ret;
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
- g_return_val_if_fail (dest_fmt != NULL, FALSE);
+ g_return_val_if_fail (dest_format != NULL, FALSE);
g_return_val_if_fail (dest_val != NULL, FALSE);
- if (*dest_fmt == src_format) {
+ if (*dest_format == src_format) {
*dest_val = src_val;
return TRUE;
}
- query = gst_query_new_convert (src_format, src_val, *dest_fmt);
+ query = gst_query_new_convert (src_format, src_val, *dest_format);
ret = gst_pad_query (pad, query);
if (ret)
- gst_query_parse_convert (query, NULL, NULL, dest_fmt, dest_val);
+ gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
gst_query_unref (query);
gboolean gst_pad_query_position (GstPad *pad, GstFormat *format,
gint64 *cur, gint64 *end);
gboolean gst_pad_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
- GstFormat *dest_fmt, gint64 *dest_val);
+ GstFormat *dest_format, gint64 *dest_val);
/* bin functions */
void gst_bin_add_many (GstBin *bin, GstElement *element_1, ...);