mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 03:35:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

Documentation updates

Browse source 
Original commit message from CVS:
Documentation updates
This commit is contained in:
Wim Taymans 2002-12-14 13:02:16 +00:00
parent b9f62c52c3
commit 29e2850eff
50 changed files with 1445 additions and 1027 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/gst/gstreamer-docs.sgml
View file

@ -12,11 +12,13 @@
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
<!entity GstElementFactory SYSTEM "sgml/gstelementfactory.sgml">
<!entity GstFormat SYSTEM "sgml/gstformat.sgml">
<!entity GstLog SYSTEM "sgml/gstlog.sgml">
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
<!entity GstPadTemplate SYSTEM "sgml/gstpadtemplate.sgml">
<!entity GstParse SYSTEM "sgml/gstparse.sgml">
<!entity GstProbe SYSTEM "sgml/gstprobe.sgml">
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
@ -35,7 +37,8 @@
<!entity GstXML SYSTEM "sgml/gstxml.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity GstTimeCache SYSTEM "sgml/gsttimecache.sgml">
<!entity GstIndex SYSTEM "sgml/gstindex.sgml">
<!entity GstIndexFactory SYSTEM "sgml/gstindexfactory.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
<!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
@ -82,6 +85,7 @@ with some more specialized elements.</para>
&GstElement;
&GstElementFactory;
&GstEvent;
&GstFormat;
&GstInfo;
&GstObject;
&GstPad;
@ -90,6 +94,7 @@ with some more specialized elements.</para>
&GstPipeline;
&GstPlugin;
&GstPluginFeature;
&GstProbe;
&GstProps;
&GstQueue;
&GstRegistry;
@ -97,7 +102,8 @@ with some more specialized elements.</para>
&GstSchedulerFactory;
&GstSystemClock;
&GstThread;
&GstTimeCache;
&GstIndex;
&GstIndexFactory;
&GstType;
&GstTypeFactory;
&GstTypeFind;
@ -115,6 +121,7 @@ with some more specialized elements.</para>
g_object_set() functions and the GStreamer Core Library functions.
</para>
<!--
&GstAggregator;
&GstFakeSrc;
@ -133,6 +140,7 @@ with some more specialized elements.</para>
&GstMD5Sink;
&GstTee;
-->
</chapter>
<chapter id="autopluggers">

311
docs/gst/gstreamer-sections.txt
View file

@ -34,6 +34,8 @@ cothread_current
<TITLE>Gst</TITLE>
gst_init
gst_init_with_popt_table
gst_init_check
gst_init_get_popt_table
gst_version
gst_main
gst_main_quit
@ -104,11 +106,11 @@ GstSchedulerState
GstSchedulerFlags
gst_scheduler_destroy
gst_scheduler_setup
gst_scheduler_get_preferred_stack
gst_scheduler_reset
gst_scheduler_add_element
gst_scheduler_remove_element
gst_scheduler_state_transition
gst_scheduler_scheduling_change
gst_scheduler_lock_element
gst_scheduler_unlock_element
gst_scheduler_yield
@ -135,6 +137,10 @@ GST_IS_SCHEDULER
GST_TYPE_SCHEDULER
GST_SCHEDULER_CLASS
GST_IS_SCHEDULER_CLASS
GST_TYPE_SCHEDULER_FLAGS
gst_scheduler_flags_get_type
GST_TYPE_SCHEDULER_STATE
gst_scheduler_state_get_type
</SECTION>
<SECTION>
@ -148,16 +154,30 @@ gst_scheduler_factory_new
gst_scheduler_factory_get_default_name
gst_scheduler_factory_set_default_name
<SUBSECTION Standard>
gst_scheduler_factory_get_type
GST_IS_SCHEDULER_FACTORY
GST_IS_SCHEDULER_FACTORY_CLASS
GST_SCHEDULER_FACTORY
GST_SCHEDULER_FACTORY_CLASS
GST_TYPE_SCHEDULER_FACTORY
gst_scheduler_factory_get_type
GstSchedulerFactory
GstSchedulerFactoryClass
</SECTION>
<SECTION>
<FILE>gstformat</FILE>
<TITLE>GstFormat</TITLE>
GstFormat
GstFormatDefinition
GST_FORMATS_FUNCTION
gst_format_register
gst_format_get_by_nick
gst_format_get_details
gst_format_get_definitions
<SUBSECTION Standard>
GST_TYPE_FORMAT
gst_format_get_type
</SECTION>
<SECTION>
<FILE>gstbin</FILE>
@ -173,7 +193,6 @@ gst_bin_remove
gst_bin_get_by_name
gst_bin_get_by_name_recurse_up
gst_bin_get_list
gst_bin_set_state_type
gst_bin_iterate
gst_bin_set_post_iterate_function
gst_bin_set_pre_iterate_function
@ -192,6 +211,8 @@ GST_BIN_CLASS_CAST
GST_IS_BIN
GST_IS_BIN_CLASS
gst_bin_details
GST_TYPE_BIN_FLAGS
gst_bin_flags_get_type
</SECTION>
<SECTION>
@ -202,6 +223,9 @@ GST_PARSE_ERROR
gst_parse_error_quark
gst_parse_launch
gst_parse_launchv
<SUBSECTION Standard>
GST_TYPE_PARSE_ERROR
gst_parse_error_get_type
</SECTION>
<SECTION>
@ -236,6 +260,7 @@ gst_data_init
gst_data_dispose
gst_data_copy_into
gst_data_copy
gst_data_needs_copy_on_write
gst_data_copy_on_write
gst_data_free
gst_data_ref
@ -244,6 +269,8 @@ gst_data_unref
<SUBSECTION Standard>
GST_DATA
GST_DATA_TYPE
GST_TYPE_DATA_FLAGS
gst_data_flags_get_type
</SECTION>
<SECTION>
@ -272,6 +299,7 @@ GstBufferFlag
GstBuffer
gst_buffer_new
gst_buffer_new_and_alloc
gst_buffer_set_data
gst_buffer_new_from_pool
gst_buffer_default_free
gst_buffer_default_copy
@ -279,6 +307,7 @@ gst_buffer_ref
gst_buffer_ref_by_count
gst_buffer_unref
gst_buffer_copy
gst_buffer_needs_copy_on_write
gst_buffer_copy_on_write
gst_buffer_free
gst_buffer_create_sub
@ -288,6 +317,8 @@ gst_buffer_span
gst_buffer_print_stats
<SUBSECTION Standard>
GST_TYPE_BUFFER
GST_TYPE_BUFFER_FLAG
gst_buffer_flag_get_type
</SECTION>
<SECTION>
@ -311,7 +342,10 @@ gst_buffer_pool_free
gst_buffer_pool_set_user_data
gst_buffer_pool_get_user_data
gst_buffer_pool_get_default
gst_buffer_pool_default_free
gst_buffer_pool_needs_copy_on_write
<SUBSECTION Standard>
GST_TYPE_BUFFER_POOL
</SECTION>
<SECTION>
@ -321,6 +355,7 @@ GstEventType
GST_EVENT_TYPE
GST_EVENT_SRC
GST_EVENT_TIMESTAMP
GstEventFlag
GstSeekType
GstSeekAccuracy
GST_EVENT_SEEK_TYPE
@ -356,10 +391,19 @@ gst_event_discont_get_value
gst_event_new_filler
gst_event_new_flush
gst_event_print_stats
GST_EVENT_MASK_FUNCTION
<SUBSECTION Standard>
GST_EVENT
GST_IS_EVENT
GST_TYPE_EVENT
GST_TYPE_EVENT_FLAG
gst_event_flag_get_type
GST_TYPE_EVENT_TYPE
gst_event_type_get_type
GST_TYPE_SEEK_ACCURACY
gst_seek_accuracy_get_type
GST_TYPE_SEEK_TYPE
gst_seek_type_get_type
</SECTION>
<SECTION>
@ -411,8 +455,12 @@ gst_element_release_locks
gst_element_get_clock
gst_element_set_clock
gst_element_clock_wait
GstElementGetClockFunction
GstElementSetClockFunction
gst_element_provides_clock
gst_element_requires_clock
gst_element_set_index
gst_element_get_index
gst_element_is_indexable
gst_element_set_loop_function
GstElementLoopFunction
@ -438,6 +486,9 @@ gst_element_set_valist
gst_element_query
gst_element_send_event
gst_element_default_deep_notify
gst_element_default_error
GstElementState
GstElementStateReturn
GST_NUM_STATES
@ -471,7 +522,12 @@ GST_ELEMENT_CLASS_CAST
GST_IS_ELEMENT
GST_IS_ELEMENT_CLASS
gst_element_get_type
gst_element_class_install_std_props
GST_TYPE_ELEMENT_FLAGS
gst_element_flags_get_type
GST_TYPE_ELEMENT_STATE
gst_element_state_get_type
GST_TYPE_ELEMENT_STATE_RETURN
gst_element_state_return_get_type
</SECTION>
<SECTION>
@ -485,6 +541,7 @@ gst_element_factory_can_src_caps
gst_element_factory_can_sink_caps
gst_element_factory_create
gst_element_factory_make
gst_element_factory_make_or_warn
gst_element_factory_set_rank
GST_ELEMENT_RANK_MARGINAL
GST_ELEMENT_RANK_NONE
@ -516,6 +573,8 @@ GST_TYPE_AUTOPLUG
gst_autoplug_get_type
GST_AUTOPLUG_CLASS
GST_IS_AUTOPLUG_CLASS
GST_TYPE_AUTOPLUG_FLAGS
gst_autoplug_flags_get_type
</SECTION>
<SECTION>
@ -539,12 +598,9 @@ GST_IS_AUTOPLUG_FACTORY_CLASS
<SECTION>
<FILE>gstclock</FILE>
<TITLE>GstClock</TITLE>
GstClockTime
GstClockTimeDiff
GstClockCallback
GstClockID
GstClockReturn
GST_CLOCK_TIME_NONE
GST_SECOND
GST_MSECOND
@ -553,35 +609,57 @@ GST_NSECOND
GST_CLOCK_DIFF
GST_TIMEVAL_TO_TIME
GST_TIME_TO_TIMEVAL
GstClockEntry
GstClockCallback
GstClockEntryStatus
GstClockEntryType
GST_CLOCK_ENTRY
GST_CLOCK_ENTRY_CLOCK
GST_CLOCK_ENTRY_TYPE
GST_CLOCK_ENTRY_TIME
GST_CLOCK_ENTRY_INTERVAL
GST_CLOCK_ENTRY_STATUS
GstClockReturn
GstClockFlags
GST_CLOCK_FLAGS
<TITLE>GstClock</TITLE>
GstClock
gst_clock_set_speed
gst_clock_get_speed
gst_clock_set_resolution
gst_clock_get_resolution
gst_clock_set_active
gst_clock_is_active
gst_clock_reset
gst_clock_handle_discont
gst_clock_async_supported
gst_clock_wait
gst_clock_wait_async
gst_clock_cancel_wait_async
gst_clock_notify_async
gst_clock_remove_notify_async
gst_clock_wait_id
gst_clock_get_next_id
gst_clock_unlock_id
gst_clock_get_time
gst_clock_get_next_id
gst_clock_new_single_shot_id
gst_clock_new_periodic_id
gst_clock_id_get_time
gst_clock_get_resolution
gst_clock_set_resolution
gst_clock_id_wait
gst_clock_id_wait_async
gst_clock_id_unschedule
gst_clock_id_unlock
gst_clock_id_free
<SUBSECTION Standard>
gst_clock_get_type
GST_TYPE_CLOCK
GST_CLOCK
GST_CLOCK_CLASS
GST_IS_CLOCK
GST_TYPE_CLOCK
gst_clock_get_type
GST_CLOCK_CLASS
GST_IS_CLOCK_CLASS
GST_TYPE_CLOCK_ENTRY_STATUS
gst_clock_entry_status_get_type
GST_TYPE_CLOCK_ENTRY_TYPE
gst_clock_entry_type_get_type
GST_TYPE_CLOCK_FLAGS
gst_clock_flags_get_type
GST_TYPE_CLOCK_RETURN
gst_clock_return_get_type
</SECTION>
<SECTION>
<FILE>gstregistry</FILE>
<TITLE>GstRegistry</TITLE>
@ -630,6 +708,10 @@ GST_TYPE_REGISTRY
gst_registry_get_type
GST_REGISTRY_CLASS
GST_IS_REGISTRY_CLASS
GST_TYPE_REGISTRY_FLAGS
gst_registry_flags_get_type
GST_TYPE_REGISTRY_RETURN
gst_registry_return_get_type
</SECTION>
<SECTION>
@ -684,6 +766,7 @@ gst_object_destroy
gst_object_save_thyself
gst_object_restore_thyself
gst_object_get_path_string
gst_object_default_deep_notify
gst_class_signal_emit_by_name
gst_class_signal_connect
<SUBSECTION Standard>
@ -696,6 +779,8 @@ GST_IS_OBJECT
GST_IS_OBJECT_CLASS
GST_OBJECT_CAST
GST_OBJECT_CLASS_CAST
GST_TYPE_OBJECT_FLAGS
gst_object_flags_get_type
</SECTION>
<SECTION>
@ -713,6 +798,8 @@ GST_PAD_CAN_PULL
GST_PAD_IS_SINK
GST_PAD_IS_SRC
GST_PAD_IS_CONNECTED
GST_PAD_IS_ACTIVE
GST_PAD_IS_USABLE
GstPad
GstPadChainFunction
@ -729,6 +816,10 @@ GstPadIntConnFunction
GstPadQueryType
GstPadQueryFunction
GstPadEventMaskFunction
GstPadFormatsFunction
GstPadQueryTypeFunction
GST_PAD_QUERY_TYPE_FUNCTION
GstPadDirection
GstPadFlags
@ -753,9 +844,6 @@ gst_pad_set_element_private
gst_pad_get_element_private
gst_pad_set_parent
gst_pad_get_parent
gst_pad_get_scheduler
gst_pad_set_scheduler
gst_pad_unset_scheduler
gst_pad_get_real_parent
gst_pad_add_ghost_pad
gst_pad_remove_ghost_pad
@ -778,8 +866,7 @@ gst_pad_get_pad_template_caps
gst_pad_get_allowed_caps
gst_pad_recalc_allowed_caps
gst_pad_perform_negotiate
gst_pad_ghost_save_thyself
gst_pad_peek
gst_ghost_pad_save_thyself
gst_pad_select
gst_pad_selectv
@ -788,10 +875,18 @@ gst_pad_dispatcher
gst_pad_send_event
gst_pad_event_default
gst_pad_set_event_function
gst_pad_get_event_masks
gst_pad_get_event_masks_default
gst_pad_handles_event
gst_pad_set_event_mask_function
gst_pad_set_convert_function
gst_pad_convert
gst_pad_convert_default
gst_pad_get_formats
gst_pad_get_formats_default
gst_pad_handles_format
gst_pad_set_formats_function
gst_pad_get_internal_connections
gst_pad_get_internal_connections_default
@ -800,14 +895,22 @@ gst_pad_set_internal_connection_function
gst_pad_set_query_function
gst_pad_query
gst_pad_query_default
gst_pad_get_query_types
gst_pad_get_query_types_default
gst_pad_set_query_type_function
gst_pad_add_probe
gst_pad_remove_probe
gst_pad_is_active
gst_pad_set_active
gst_pad_get_scheduler
GstRealPad
GST_RPAD_SCHED
GST_RPAD_DIRECTION
GST_RPAD_CAPS
GST_RPAD_PEER
GST_RPAD_BUFPEN
GST_RPAD_CHAINFUNC
GST_RPAD_FILTER
GST_RPAD_APPFILTER
@ -822,6 +925,9 @@ GST_RPAD_GETCAPSFUNC
GST_RPAD_CONVERTFUNC
GST_RPAD_INTCONNFUNC
GST_RPAD_QUERYFUNC
GST_RPAD_EVENTMASKFUNC
GST_RPAD_FORMATSFUNC
GST_RPAD_QUERYTYPEFUNC
GST_GPAD_REALPAD
GstGhostPad
@ -860,6 +966,34 @@ GST_IS_GHOST_PAD
GST_IS_GHOST_PAD_CLASS
GST_IS_GHOST_PAD_FAST
gst_ghost_pad_get_type
GST_TYPE_PAD_CONNECT_RETURN
gst_pad_connect_return_get_type
GST_TYPE_PAD_DIRECTION
gst_pad_direction_get_type
GST_TYPE_PAD_FLAGS
gst_pad_flags_get_type
GST_TYPE_PAD_PRESENCE
gst_pad_presence_get_type
GST_TYPE_PAD_QUERY_TYPE
gst_pad_query_type_get_type
</SECTION>
<SECTION>
<FILE>gstprobe</FILE>
<TITLE>GstProbe</TITLE>
GstProbe
GstProbeCallback
gst_probe_new
gst_probe_destroy
gst_probe_perform
GstProbeDispatcher
gst_probe_dispatcher_new
gst_probe_dispatcher_destroy
gst_probe_dispatcher_init
gst_probe_dispatcher_set_active
gst_probe_dispatcher_add_probe
gst_probe_dispatcher_remove_probe
gst_probe_dispatcher_dispatch
</SECTION>
<SECTION>
@ -935,6 +1069,8 @@ gst_plugin_load
gst_library_load
<SUBSECTION Standard>
GST_PLUGIN
GST_TYPE_PLUGIN_ERROR
gst_plugin_error_get_type
</SECTION>
<SECTION>
@ -953,22 +1089,6 @@ GST_PLUGIN_FEATURE_CLASS
GST_IS_PLUGIN_FEATURE_CLASS
</SECTION>
<SECTION>
<FILE>gsttee</FILE>
<TITLE>GstTee</TITLE>
<SUBSECTION Standard>
gst_tee_factory_init
GstTee
gst_tee_get_type
gst_tee_details
GstTeeClass
GST_TYPE_TEE
GST_TEE
GST_TEE_CLASS
GST_IS_TEE
GST_IS_TEE_CLASS
</SECTION>
<SECTION>
<FILE>gstthread</FILE>
<TITLE>GstThread</TITLE>
@ -978,12 +1098,15 @@ gst_thread_new
<SUBSECTION Standard>
GstThreadClass
gst_thread_get_type
gst_thread_set_priority
GST_TYPE_THREAD
GST_THREAD
GST_THREAD_CLASS
GST_IS_THREAD
GST_IS_THREAD_CLASS
gst_thread_details
GST_TYPE_THREAD_STATE
gst_thread_state_get_type
</SECTION>
<SECTION>
@ -1096,6 +1219,7 @@ GST_TYPE_PROPS
GST_MAKE_FOURCC
GST_STR_FOURCC
GST_PROPS_LIST
GST_PROPS_GLIST
GST_PROPS_INT
GST_PROPS_INT_ANY
GST_PROPS_INT_RANGE
@ -1146,6 +1270,8 @@ gst_props_entry_get_string
gst_props_entry_get_type
gst_props_entry_is_fixed
<SUBSECTION Standard>
GST_TYPE_PROPS_TYPE
gst_props_type_get_type
</SECTION>
<SECTION>
@ -1197,33 +1323,84 @@ GstXMLClass
<TITLE>GstCpu</TITLE>
GstCPUFlags
gst_cpu_get_flags
<SUBSECTION Standard>
GST_TYPE_CPU_FLAGS
gst_cpu_flags_get_type
</SECTION>
<SECTION>
<FILE>gsttimecache</FILE>
<TITLE>GstTimeCache</TITLE>
GstTimeCacheEntry
GstTimeCacheGroup
GstTimeCacheCertainty
gst_time_cache_new
gst_time_cache_get_group
gst_time_cache_new_group
gst_time_cache_set_group
gst_time_cache_set_certainty
gst_time_cache_get_certainty
gst_time_cache_add_entry
gst_time_cache_find_location
gst_time_cache_find_timestamp
<FILE>gstindex</FILE>
<TITLE>GstIndex</TITLE>
GstIndexEntry
GstIndexGroup
GstIndexCertainty
GstIndexEntryType
GstIndexLookupMethod
GST_INDEX_NASSOCS
GST_INDEX_ASSOC_FLAGS
GST_INDEX_ASSOC_FORMAT
GST_INDEX_ASSOC_VALUE
GstIndexAssociation
GstAssocFlags
GST_INDEX_FORMAT_FORMAT
GST_INDEX_FORMAT_KEY
GST_INDEX_ID_DESCRIPTION
GstIndexFilter
GstIndexResolver
GstIndex
gst_index_new
gst_index_get_group
gst_index_new_group
gst_index_set_group
gst_index_set_certainty
gst_index_get_certainty
gst_index_set_filter
gst_index_set_resolver
gst_index_get_writer_id
gst_index_add_format
gst_index_add_association
gst_index_add_object
gst_index_add_id
gst_index_get_assoc_entry
gst_index_get_assoc_entry_full
gst_index_entry_free
gst_index_entry_assoc_map
<SUBSECTION Standard>
GstTimeCache
GST_TIME_CACHE
GST_IS_TIME_CACHE
GST_TYPE_TIME_CACHE
gst_time_cache_get_type
GST_TIME_CACHE_CLASS
GST_IS_TIME_CACHE_CLASS
GST_INDEX
GST_IS_INDEX
GST_TYPE_INDEX
gst_index_get_type
GST_INDEX_CLASS
GST_IS_INDEX_CLASS
GST_TYPE_ASSOC_FLAGS
gst_assoc_flags_get_type
GST_TYPE_INDEX_CERTAINTY
gst_index_certainty_get_type
GST_TYPE_INDEX_ENTRY_TYPE
gst_index_entry_type_get_type
GST_TYPE_INDEX_LOOKUP_METHOD
gst_index_lookup_method_get_type
</SECTION>
<SECTION>
<FILE>gstindexfactory</FILE>
<TITLE>GstIndexFactory</TITLE>
GstIndexFactory
gst_index_factory_new
gst_index_factory_destroy
gst_index_factory_find
gst_index_factory_create
gst_index_factory_make
<SUBSECTION Standard>
gst_index_factory_get_type
GST_TYPE_INDEX_FACTORY
GST_INDEX_FACTORY
GST_INDEX_FACTORY_CLASS
GST_IS_INDEX_FACTORY
GST_IS_INDEX_FACTORY_CLASS
</SECTION>
<SECTION>
<FILE>gststaticautoplug</FILE>
<TITLE>GstStaticAutoplug</TITLE>

3
docs/gst/gstreamer.types.in
View file

@ -17,5 +17,6 @@ gst_type_factory_get_type
gst_element_factory_get_type
gst_scheduler_factory_get_type
gst_scheduler_get_type
gst_cache_get_type
gst_index_get_type
gst_index_factory_get_type
gst_xml_get_type

4
docs/gst/tmpl/cothreads.sgml
View file

@ -30,7 +30,7 @@ Get the current stack frame.
<!-- ##### STRUCT cothread_state ##### -->
<para>
The cothread state structure
</para>
@ctx:
@ -48,7 +48,7 @@ Get the current stack frame.
<!-- ##### STRUCT cothread_context ##### -->
<para>
The cothread context structure
</para>

20
docs/gst/tmpl/gst.sgml
View file

@ -100,6 +100,24 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
@Returns:
<!-- ##### FUNCTION gst_init_check ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_version ##### -->
<para>
@ -142,7 +160,7 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
<!-- ##### VARIABLE g_log_domain_gstreamer ##### -->
<para>
The variable that holds the GStreamer log domain
</para>

2
docs/gst/tmpl/gstautoplug.sgml
View file

@ -95,7 +95,7 @@ Use the regular gst_object_destroy() call to destroy the autoplugger.
<!-- ##### STRUCT GstAutoplug ##### -->
<para>
The autoplug object
</para>

2
docs/gst/tmpl/gstautoplugfactory.sgml
View file

@ -33,7 +33,7 @@ Use gst_autoplug_factory_destroy() to remove the factory from the global list.
<!-- ##### STRUCT GstAutoplugFactory ##### -->
<para>
The autoplugfactory object
</para>

2
docs/gst/tmpl/gstbin.sgml
View file

@ -63,7 +63,7 @@ Flags for a bin.
<!-- ##### STRUCT GstBin ##### -->
<para>
The GstBin object
</para>

19
docs/gst/tmpl/gstbuffer.sgml
View file

@ -274,6 +274,16 @@ The basic structure of a buffer.
@Returns:
<!-- ##### MACRO gst_buffer_set_data ##### -->
<para>
A convenience function to set the data and size on a buffer
</para>
@buf: The buffer to modify
@data: The data to set on the buffer
@size: The size to set on the buffer
<!-- ##### FUNCTION gst_buffer_new_from_pool ##### -->
<para>
@ -337,6 +347,15 @@ Copies the given buffer using the copy function of the parent GstData structure.
@Returns: a new #GstBuffer copy of the buffer.
<!-- ##### MACRO gst_buffer_needs_copy_on_write ##### -->
<para>
Queries if a copy needs to be ade of the buffer in order to safely write
to its data.
</para>
@buf: The buffer to query.
<!-- ##### MACRO gst_buffer_copy_on_write ##### -->
<para>
This function returns a buffer that is safe to write to.

34
docs/gst/tmpl/gstbufferpool.sgml
View file

@ -76,7 +76,7 @@ Check if the given pointer is a bufferpool
<!-- ##### STRUCT GstBufferPool ##### -->
<para>
The bufferpool structure
</para>
@data:
@ -206,20 +206,18 @@ Free the given pool. This is dangerous, use gst_buffer_pool_unref() instead.
<!-- ##### FUNCTION gst_buffer_pool_set_user_data ##### -->
<para>
Set the specified user data to the bufferpool.
</para>
@pool: The pool to set the user_data of
@user_data: The user data to set on the pool
@pool:
@user_data:
<!-- ##### FUNCTION gst_buffer_pool_get_user_data ##### -->
<para>
Get the user_data of the pool
</para>
@pool: The pool to get the user data of
@Returns: The user data of the pool
@pool:
@Returns:
<!-- ##### FUNCTION gst_buffer_pool_get_default ##### -->
@ -227,8 +225,28 @@ Get the user_data of the pool
</para>
@buffer_size:
@pool_size:
@Returns:
<!-- # Unused Parameters # -->
@size:
@numbuffers:
@Returns:
<!-- ##### FUNCTION gst_buffer_pool_default_free ##### -->
<para>
</para>
@pool:
<!-- ##### MACRO gst_buffer_pool_needs_copy_on_write ##### -->
<para>
Checks if a copy needs to be made of the bufferpool before it can
safely be modified.
</para>
@pool: The pool to query

2
docs/gst/tmpl/gstcaps.sgml
View file

@ -168,7 +168,7 @@ Check if the GstCaps has fixed properties, ie. it has no ranges or lists.
<!-- ##### STRUCT GstCaps ##### -->
<para>
The gstcaps structure
</para>
@name: the name of the capability, for the application

229
docs/gst/tmpl/gstclock.sgml
View file

@ -33,35 +33,12 @@ A datatype to hold a timedifference, measured in nanoseconds.
</para>
<!-- ##### USER_FUNCTION GstClockCallback ##### -->
<para>
The function prototype of the callback.
</para>
@clock: The clock that triggered the callback
@time: The time it was triggered
@id: The id that expired
@user_data: user data passed in the async_wait call
@Returns:
<!-- ##### TYPEDEF GstClockID ##### -->
<para>
A detatype to hold the handle to an outstanding async clock callback
</para>
<!-- ##### ENUM GstClockReturn ##### -->
<para>
The return value of a clock operation.
</para>
@GST_CLOCK_STOPPED: The clock is stopped.
@GST_CLOCK_TIMEOUT: The operation timed out.
@GST_CLOCK_EARLY: The operation was scheduled too late.
@GST_CLOCK_ERROR: An error occured
@GST_CLOCK_UNSUPPORTED:
<!-- ##### MACRO GST_CLOCK_TIME_NONE ##### -->
<para>
Constant to define an undefined clock time
@ -123,9 +100,131 @@ Convert a GstClockTime to a GTimeVal
@tv: The target timeval
<!-- ##### STRUCT GstClockEntry ##### -->
<para>
All pending timeouts or periodic notifies are converted into
an entry.
</para>
@clock:
@type:
@time:
@interval:
@status:
@func:
@user_data:
<!-- ##### USER_FUNCTION GstClockCallback ##### -->
<para>
The function prototype of the callback.
</para>
@clock: The clock that triggered the callback
@time: The time it was triggered
@id: The id that expired
@user_data: user data passed in the async_wait call
@Returns:
<!-- ##### ENUM GstClockEntryStatus ##### -->
<para>
The status of a clock timeout.
</para>
@GST_CLOCK_ENTRY_OK: timeout happened
@GST_CLOCK_ENTRY_EARLY: request for timout that has been passed
@GST_CLOCK_ENTRY_RESTART: need to restart the timeout request
<!-- ##### ENUM GstClockEntryType ##### -->
<para>
The type of the clock entry
</para>
@GST_CLOCK_ENTRY_SINGLE: a single shot timeout
@GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request
<!-- ##### MACRO GST_CLOCK_ENTRY ##### -->
<para>
Cast to a clock entry
</para>
@entry: the entry to cast
<!-- ##### MACRO GST_CLOCK_ENTRY_CLOCK ##### -->
<para>
Get the owner clock of the entry
</para>
@entry: the entry to query
<!-- ##### MACRO GST_CLOCK_ENTRY_TYPE ##### -->
<para>
Get the type of the clock entry
</para>
@entry: the entry to query
<!-- ##### MACRO GST_CLOCK_ENTRY_TIME ##### -->
<para>
Get the requested time of this entry
</para>
@entry: the entry to query
<!-- ##### MACRO GST_CLOCK_ENTRY_INTERVAL ##### -->
<para>
Get the interval of this periodic entry
</para>
@entry: the entry to query
<!-- ##### MACRO GST_CLOCK_ENTRY_STATUS ##### -->
<para>
The status of the entry
</para>
@entry: the entry to query
<!-- ##### ENUM GstClockReturn ##### -->
<para>
The return value of a clock operation.
</para>
@GST_CLOCK_STOPPED: The clock is stopped.
@GST_CLOCK_TIMEOUT: The operation timed out.
@GST_CLOCK_EARLY: The operation was scheduled too late.
@GST_CLOCK_ERROR: An error occured
@GST_CLOCK_UNSUPPORTED: Operation is not supported
<!-- ##### ENUM GstClockFlags ##### -->
<para>
The capabilities of this clock
</para>
@GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: This clock can do a single sync timeut request
@GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: This clock can do a single async timeout request
@GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: This clock can do sync periodic timeout requests
@GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: This clock can do async periodic timeout callbacks
@GST_CLOCK_FLAG_CAN_SET_RESOLUTION: The resolution of this clock can be changed
@GST_CLOCK_FLAG_CAN_SET_SPEED: The speed of this clock can be changed
<!-- ##### MACRO GST_CLOCK_FLAGS ##### -->
<para>
Get the clock flags
</para>
@clock: the clock to query
<!-- ##### STRUCT GstClock ##### -->
<para>
The opaque data structure of the clock.
The GstClock object
</para>
@ -146,8 +245,25 @@ The opaque data structure of the clock.
@clock:
@Returns:
<!-- # Unused Parameters # -->
@speed:
<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
<para>
</para>
@clock:
@resolution:
@Returns:
<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
<para>
</para>
@clock:
@Returns:
<!-- ##### FUNCTION gst_clock_set_active ##### -->
@ -186,6 +302,15 @@ The opaque data structure of the clock.
@Returns:
<!-- ##### FUNCTION gst_clock_get_time ##### -->
<para>
</para>
@clock:
@Returns:
<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
<para>
@ -195,12 +320,24 @@ The opaque data structure of the clock.
@Returns:
<!-- ##### FUNCTION gst_clock_get_time ##### -->
<!-- ##### FUNCTION gst_clock_new_single_shot_id ##### -->
<para>
</para>
@clock:
@time:
@Returns:
<!-- ##### FUNCTION gst_clock_new_periodic_id ##### -->
<para>
</para>
@clock:
@start_time:
@interval:
@Returns:
@ -213,27 +350,53 @@ The opaque data structure of the clock.
@Returns:
<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
<!-- ##### FUNCTION gst_clock_id_wait ##### -->
<para>
</para>
@clock:
@id:
@jitter:
@Returns:
<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
<!-- ##### FUNCTION gst_clock_id_wait_async ##### -->
<para>
</para>
@clock:
@resolution:
@id:
@func:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_clock_id_unschedule ##### -->
<para>
</para>
@id:
<!-- ##### FUNCTION gst_clock_id_unlock ##### -->
<para>
</para>
@id:
<!-- ##### FUNCTION gst_clock_id_free ##### -->
<para>
</para>
@id:
<!-- ##### ARG GstClock:stats ##### -->
<para>
Boolean property to activate stat generation on the clock.
</para>

10
docs/gst/tmpl/gstcpu.sgml
View file

@ -22,13 +22,13 @@ You'll get a bitmask of flags with gst_cpu_get_flags().
<!-- ##### ENUM GstCPUFlags ##### -->
<para>
Flags that represent cpu capabilities
</para>
@GST_CPU_FLAG_MMX:
@GST_CPU_FLAG_SSE:
@GST_CPU_FLAG_MMXEXT:
@GST_CPU_FLAG_3DNOW:
@GST_CPU_FLAG_MMX: The cpu is mmx enabled
@GST_CPU_FLAG_SSE: The cpu is sse enabled
@GST_CPU_FLAG_MMXEXT: The cpu has extended mmx instructions
@GST_CPU_FLAG_3DNOW: The cpu is 3DNOW enabled
<!-- ##### FUNCTION gst_cpu_get_flags ##### -->
<para>

9
docs/gst/tmpl/gstdata.sgml
View file

@ -200,6 +200,15 @@ Get access to the free function of the data
@Returns:
<!-- ##### FUNCTION gst_data_needs_copy_on_write ##### -->
<para>
</para>
@data:
@Returns:
<!-- ##### FUNCTION gst_data_copy_on_write ##### -->
<para>

96
docs/gst/tmpl/gstelement.sgml
View file

@ -67,7 +67,7 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
<!-- ##### STRUCT GstElement ##### -->
<para>
The element object
</para>
@ -81,24 +81,29 @@ of an element he doesn't need anymore.
@element: a #GstElement to destroy
<!-- ##### MACRO gst_element_set_name ##### -->
<para>
Sets the name of the element, getting rid of the old name if there was one.
</para>
@element: a #GstElement to set the name of.
@name: the new name of the element.
<!-- ##### MACRO gst_element_get_name ##### -->
<para>
Gets the name of the element.
</para>
@element: a #GstElement to get the name of.
@elem:
@Returns: the name of the element.
<!-- connection -->
<!-- # Unused Parameters # -->
@element: a #GstElement to get the name of.
<!-- ##### MACRO gst_element_set_name ##### -->
<para>
Sets the name of the element, getting rid of the old name if there was one.
</para>
@elem:
@name: the new name of the element.
<!-- # Unused Parameters # -->
@element: a #GstElement to set the name of.
<!-- ##### FUNCTION gst_element_get_factory ##### -->
@ -469,6 +474,51 @@ Gets the name of the element.
@Returns:
<!-- ##### FUNCTION gst_element_provides_clock ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_requires_clock ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_set_index ##### -->
<para>
</para>
@element:
@index:
<!-- ##### FUNCTION gst_element_get_index ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_is_indexable ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_set_loop_function ##### -->
<para>
@ -511,8 +561,10 @@ circumstances.
Gets the parent of an element.
</para>
@element: a #GstElement to get the parent of.
@elem:
@Returns: the #GstObject parent of the element.
<!-- # Unused Parameters # -->
@element: a #GstElement to get the parent of.
<!-- ##### MACRO gst_element_set_parent ##### -->
@ -520,8 +572,10 @@ Gets the parent of an element.
Sets the parent of an element.
</para>
@element: a #GstElement to set the parent of.
@elem:
@parent: the new #GstObject parent of the object.
<!-- # Unused Parameters # -->
@element: a #GstElement to set the parent of.
<!-- ##### FUNCTION gst_element_get_managing_bin ##### -->
@ -659,6 +713,24 @@ is scheduled.
@Returns:
<!-- ##### MACRO gst_element_default_deep_notify ##### -->
<para>
The default deep notify handler that prints out the property change
notifications to stdout.
</para>
<!-- ##### FUNCTION gst_element_default_error ##### -->
<para>
</para>
@object:
@orig:
@error:
<!-- ##### ENUM GstElementState ##### -->
<para>
This enum defines the standard states an element may be in. You will normally

10
docs/gst/tmpl/gstelementfactory.sgml
View file

@ -137,6 +137,16 @@ describes the element, mostly for the benefit of editors.
@Returns:
<!-- ##### FUNCTION gst_element_factory_make_or_warn ##### -->
<para>
</para>
@factoryname:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_factory_set_rank ##### -->
<para>

23
docs/gst/tmpl/gstevent.sgml
View file

@ -44,8 +44,8 @@ The different major types of events.
@GST_EVENT_SEGMENT_DONE: the event that will be emited when the segment seek has ended
@GST_EVENT_SIZE: a size suggestion for a peer element
@GST_EVENT_RATE: adjust the output rate of an element
@GST_EVENT_FILLER: a dummy element that should be ignored by plugins
@GST_EVENT_TS_OFFSET:
@GST_EVENT_FILLER: a dummy event that should be ignored by plugins
@GST_EVENT_TS_OFFSET: an event to set the time offset on buffers
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
<para>
@ -71,6 +71,14 @@ Get the timestamp of the event.
@event: The event to query.
<!-- ##### ENUM GstEventFlag ##### -->
<para>
Event flags are used when querying for supported events
</para>
@GST_EVENT_FLAG_NONE: no value
@GST_RATE_FLAG_NEGATIVE: indicates negative rates are supported
<!-- ##### ENUM GstSeekType ##### -->
<para>
The different types of seek events.
@ -244,7 +252,7 @@ The value of the size event
<!-- ##### STRUCT GstEvent ##### -->
<para>
The event structure
</para>
@data:
@ -369,3 +377,12 @@ Create a new flush event.
<!-- ##### MACRO GST_EVENT_MASK_FUNCTION ##### -->
<para>
A convenience macro to create event mask functions
</para>
@functionname: the name of the function
@...: event masks, the last element is marked with 0

6
docs/gst/tmpl/gstinfo.sgml
View file

@ -267,7 +267,7 @@ Print out an error condition and abort the application.
<!-- ##### USER_FUNCTION GstDebugHandler ##### -->
<para>
The debug handler
</para>
@category:
@ -311,7 +311,7 @@ Print out an error condition and abort the application.
<!-- ##### USER_FUNCTION GstInfoHandler ##### -->
<para>
The info handler
</para>
@category:
@ -326,7 +326,7 @@ Print out an error condition and abort the application.
<!-- ##### USER_FUNCTION GstErrorHandler ##### -->
<para>
The error handler
</para>
@file:

29
docs/gst/tmpl/gstobject.sgml
View file

@ -27,7 +27,7 @@ object.
<!-- ##### ENUM GstObjectFlags ##### -->
<para>
Flags for an object
</para>
@GST_DESTROYED: The object is flagged for destruction
@ -36,7 +36,7 @@ object.
<!-- ##### STRUCT GstObject ##### -->
<para>
The GstObject
</para>
@ -258,6 +258,17 @@ Check if the object has been destroyed.
@Returns:
<!-- ##### FUNCTION gst_object_default_deep_notify ##### -->
<para>
</para>
@object:
@orig:
@pspec:
@excluded_props:
<!-- ##### FUNCTION gst_class_signal_emit_by_name ##### -->
<para>
@ -282,12 +293,14 @@ Check if the object has been destroyed.
<!-- ##### SIGNAL GstObject::deep-notify ##### -->
<para>
The deep notify signal is used to be notified of property changes.
it is typically attached to the toplevel bin to receive notifications
from all the elements contained in that bin.
</para>
@gstobject: the object which received the signal.
@arg1:
@arg2:
@arg1: the object that originated the signal
@arg2: the property that changed
<!-- ##### SIGNAL GstObject::object-saved ##### -->
<para>
@ -300,7 +313,7 @@ this signal to insert custom XML tags into the core XML.
<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>
Is emitted when the parent of an object is set.
</para>
@gstobject: the object which received the signal.
@ -308,11 +321,11 @@ this signal to insert custom XML tags into the core XML.
<!-- ##### SIGNAL GstObject::parent-unset ##### -->
<para>
Is emitted when the parent of an object is unset.
</para>
@gstobject: the object which received the signal.
@arg1:
@arg1: the old parent
<!-- ##### ARG GstObject:name ##### -->
<para>

259
docs/gst/tmpl/gstpad.sgml
View file

@ -41,8 +41,6 @@ on the pads.
<para>
GstElements will use gst_pad_push() and gst_pad_pull() to push out
or pull in a buffer.
The gst_pad_pullregion() function can be used to request for a buffer
with a specific offset (in time or in bytes).
gst_pad_select() and gst_pad_selectv() are used by plugins to wait for the
first incoming buffer or event on any of the given set of pads.
</para>
@ -51,7 +49,7 @@ To send a #GstEvent on a pad, use gst_pad_send_event().
</para>
<para>
Last reviewed on September 1st, 2002 (0.4.0.1)
Last reviewed on December 13th, 2002 (0.5.0.1)
</para>
<!-- ##### SECTION See_Also ##### -->
@ -165,9 +163,25 @@ Checks if the pad is connected.
@pad: a #GstPad to check.
<!-- ##### MACRO GST_PAD_IS_ACTIVE ##### -->
<para>
Checks if the pad is active.
</para>
@pad: a #GstPad to check
<!-- ##### MACRO GST_PAD_IS_USABLE ##### -->
<para>
Checks if a pad is usable. A usable pad both connected and active.
</para>
@pad: a #GstPad to check
<!-- ##### STRUCT GstPad ##### -->
<para>
The GstPad object
</para>
@ -288,10 +302,10 @@ The different supported query types.
@GST_PAD_QUERY_LATENCY: Query the latency on the pad.
@GST_PAD_QUERY_JITTER: Query the average jitter beteen optimal processing
and current processing.
@GST_PAD_QUERY_START:
@GST_PAD_QUERY_START: Query for the configured start time for segmented seek
@GST_PAD_QUERY_SEGMENT_END: Query the end position of the currently
executing segment.
@GST_PAD_QUERY_RATE:
@GST_PAD_QUERY_RATE: Query at which rate this pad will process data.
<!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
<para>
@ -305,6 +319,42 @@ The signature of the query function.
@Returns: TRUE if the query could be performed.
<!-- ##### USER_FUNCTION GstPadEventMaskFunction ##### -->
<para>
The signature of the eventmask function.
</para>
@pad: the #GstPad to query
@Returns: an array of event masks
<!-- ##### USER_FUNCTION GstPadFormatsFunction ##### -->
<para>
The signature of the formats function.
</para>
@pad: a #GstPad to query
@Returns: an array of formats
<!-- ##### USER_FUNCTION GstPadQueryTypeFunction ##### -->
<para>
The signature of the query types function.
</para>
@pad: a #GstPad to query
@Returns: an array of query types
<!-- ##### MACRO GST_PAD_QUERY_TYPE_FUNCTION ##### -->
<para>
A convenience macro to construct query type functions
</para>
@functionname: the name of the function
@...: query types, 0 to mark the last element
<!-- ##### ENUM GstPadDirection ##### -->
<para>
The direction of a pad.
@ -512,15 +562,6 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_get_scheduler ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
<para>
@ -740,6 +781,16 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_ghost_pad_save_thyself ##### -->
<para>
</para>
@pad:
@parent:
@Returns:
<!-- ##### FUNCTION gst_pad_select ##### -->
<para>
@ -799,6 +850,43 @@ Destroy the pad.
@event:
<!-- ##### FUNCTION gst_pad_get_event_masks ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_event_masks_default ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_handles_event ##### -->
<para>
</para>
@pad:
@mask:
@Returns:
<!-- ##### FUNCTION gst_pad_set_event_mask_function ##### -->
<para>
</para>
@pad:
@mask_func:
<!-- ##### FUNCTION gst_pad_set_convert_function ##### -->
<para>
@ -834,6 +922,45 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_get_formats ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_formats_default ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_handles_format ##### -->
<para>
</para>
@pad:
@format:
@Returns:
<!-- ##### FUNCTION gst_pad_set_formats_function ##### -->
<para>
</para>
@pad:
@formats:
<!-- # Unused Parameters # -->
@format:
<!-- ##### FUNCTION gst_pad_get_internal_connections ##### -->
<para>
@ -894,11 +1021,85 @@ Destroy the pad.
@Returns:
<!-- ##### STRUCT GstRealPad ##### -->
<!-- ##### FUNCTION gst_pad_get_query_types ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_query_types_default ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_query_type_function ##### -->
<para>
</para>
@pad:
@type_func:
<!-- # Unused Parameters # -->
@type_function:
<!-- ##### MACRO gst_pad_add_probe ##### -->
<para>
Adds the probe to the given pad
</para>
@pad: The pad to add the probe to
@probe: The probe to add to the pad
<!-- ##### MACRO gst_pad_remove_probe ##### -->
<para>
Remove the probe from the pad
</para>
@pad: The pad to remove the probe of
@probe: The probe to remove
<!-- ##### FUNCTION gst_pad_is_active ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_active ##### -->
<para>
</para>
@pad:
@active:
<!-- ##### FUNCTION gst_pad_get_scheduler ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### STRUCT GstRealPad ##### -->
<para>
The realpad object
</para>
@pad:
@caps:
@filter:
@ -1060,6 +1261,30 @@ Get the query function of this pad
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_EVENTMASKFUNC ##### -->
<para>
Get the event mask function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_FORMATSFUNC ##### -->
<para>
Get the formats function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_QUERYTYPEFUNC ##### -->
<para>
Get the query types function of this pad
</para>
@pad: the pad to query
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
<para>
Get the real pad of this ghost pad.
@ -1070,7 +1295,7 @@ Get the real pad of this ghost pad.
<!-- ##### STRUCT GstGhostPad ##### -->
<para>
The Ghostpad object
</para>

7
docs/gst/tmpl/gstpadtemplate.sgml
View file

@ -83,7 +83,7 @@ gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
The padtemplate object.
</para>
@ -205,9 +205,10 @@ Check if the properties of the padtemplate are fixed
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
This signal is fired when an element creates a pad from this
template.
</para>
@gstpadtemplate: the object which received the signal.
@arg1:
@arg1: The pad that was created.

4
docs/gst/tmpl/gstparse.sgml
View file

@ -46,7 +46,7 @@ can be made with <option>{}</option>.
<!-- ##### ENUM GstParseError ##### -->
<para>
The parsing errors.
</para>
@GST_PARSE_ERROR_SYNTAX: A syntax error was detected
@ -56,7 +56,7 @@ can be made with <option>{}</option>.
<!-- ##### MACRO GST_PARSE_ERROR ##### -->
<para>
The error querk
The error quark
</para>

2
docs/gst/tmpl/gstpipeline.sgml
View file

@ -23,7 +23,7 @@ the pipeline, use gst_element_unref() to free its resources.
<!-- ##### STRUCT GstPipeline ##### -->
<para>
The pipeline object
</para>

2
docs/gst/tmpl/gstplugin.sgml
View file

@ -59,7 +59,7 @@ The plugin loading errors
<!-- ##### STRUCT GstPlugin ##### -->
<para>
The plugin object
</para>
@name:

19
docs/gst/tmpl/gstprops.sgml
View file

@ -17,7 +17,7 @@ are usually used in conjunction with GstCaps.
<!-- ##### STRUCT GstProps ##### -->
<para>
The props structure
</para>
@refcount: a refcount for this struct
@ -26,7 +26,7 @@ are usually used in conjunction with GstCaps.
<!-- ##### ENUM GstPropsType ##### -->
<para>
The property type
</para>
@GST_PROPS_END_TYPE:
@ -85,9 +85,15 @@ Create a FOURCC value from a string. example:
Create a list of properties.
</para>
@...:
<!-- # Unused Parameters # -->
@a...: the list of GstProps
@...: the list of GstProps
<!-- ##### MACRO GST_PROPS_GLIST ##### -->
<para>
Create a list from a GList of #GstPropsEntry.
</para>
@a: A GList of props entries
<!-- ##### MACRO GST_PROPS_INT ##### -->
@ -263,9 +269,6 @@ An entry hols one key/value pair.
@fromprops:
@toprops:
@Returns:
<!-- # Unused Parameters # -->
@props1:
@props2:
<!-- ##### FUNCTION gst_props_has_property ##### -->

777
docs/gst/tmpl/gstreamer-unused.sgml
View file

File diff suppressed because it is too large Load diff

26
docs/gst/tmpl/gstregistry.sgml
View file

@ -16,29 +16,29 @@ The registry holds the available plugins in the system.
<!-- ##### ENUM GstRegistryReturn ##### -->
<para>
The return value of registry operations
</para>
@GST_REGISTRY_OK:
@GST_REGISTRY_LOAD_ERROR:
@GST_REGISTRY_SAVE_ERROR:
@GST_REGISTRY_PLUGIN_LOAD_ERROR:
@GST_REGISTRY_PLUGIN_SIGNATURE_ERROR:
@GST_REGISTRY_OK: The registry reported no error.
@GST_REGISTRY_LOAD_ERROR: There was a load error
@GST_REGISTRY_SAVE_ERROR: There was an error saving the registry
@GST_REGISTRY_PLUGIN_LOAD_ERROR: There was an error loading a plugin
@GST_REGISTRY_PLUGIN_SIGNATURE_ERROR: There was an error saving a plugin
<!-- ##### ENUM GstRegistryFlags ##### -->
<para>
Flags for the registry
</para>
@GST_REGISTRY_READABLE:
@GST_REGISTRY_WRITABLE:
@GST_REGISTRY_EXISTS:
@GST_REGISTRY_REMOTE:
@GST_REGISTRY_DELAYED_LOADING:
@GST_REGISTRY_READABLE: The registry can be read
@GST_REGISTRY_WRITABLE: The registry can be written to
@GST_REGISTRY_EXISTS: The registry exists
@GST_REGISTRY_REMOTE: The registry is remote and might be slower
@GST_REGISTRY_DELAYED_LOADING: The registry will be loaded on demand.
<!-- ##### STRUCT GstRegistry ##### -->
<para>
The registry object
</para>
@object:

26
docs/gst/tmpl/gstscheduler.sgml
View file

@ -32,21 +32,22 @@ Get the state of the scheduler.
<!-- ##### ENUM GstSchedulerState ##### -->
<para>
The state of the scheduler
</para>
@GST_SCHEDULER_STATE_NONE:
@GST_SCHEDULER_STATE_RUNNING:
@GST_SCHEDULER_STATE_STOPPED:
@GST_SCHEDULER_STATE_ERROR:
@GST_SCHEDULER_STATE_NONE: no state
@GST_SCHEDULER_STATE_RUNNING: the scheduler is running
@GST_SCHEDULER_STATE_STOPPED: the scheduler is stopped
@GST_SCHEDULER_STATE_ERROR: the scheduler is in error
<!-- ##### ENUM GstSchedulerFlags ##### -->
<para>
Flags for the scheduler
</para>
@GST_SCHEDULER_FLAG_FIXED_CLOCK:
@GST_SCHEDULER_FLAG_LAST:
@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
from here.
<!-- ##### MACRO gst_scheduler_destroy ##### -->
<para>
@ -101,6 +102,15 @@ Destroy the scheduler
@Returns:
<!-- ##### FUNCTION gst_scheduler_scheduling_change ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
<para>

9
docs/gst/tmpl/gstthread.sgml
View file

@ -30,7 +30,7 @@ Thread flags:
<!-- ##### STRUCT GstThread ##### -->
<para>
The GstThread object
</para>
@ -50,13 +50,8 @@ Thread flags:
@gstthread: the object which received the signal.
<!-- ##### ARG GstThread:schedpolicy ##### -->
<para>
</para>
<!-- ##### ARG GstThread:priority ##### -->
<para>
The thread priority
</para>

2
docs/gst/tmpl/gsttypefactory.sgml
View file

@ -59,7 +59,7 @@ The struct with the typefactory information.
<!-- ##### STRUCT GstTypeDefinition ##### -->
<para>
The typedefinition structure.
</para>
@name: The name of this factory

10
docs/gst/tmpl/gstxml.sgml
View file

@ -113,17 +113,13 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- # Unused Parameters # -->
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
<para>
</para>
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- # Unused Parameters # -->
@gstelement: the object which received the signal.
@:
@:
@:

12
gst/cothreads.c
View file

@ -308,21 +308,21 @@ cothread_create (cothread_context *ctx)
/**
* cothread_free:
* @cothread: the cothread state
* @thread: the cothread state
*
* Free the given cothread state
*/
void
cothread_free (cothread_state *cothread)
cothread_free (cothread_state *thread)
{
g_return_if_fail (cothread != NULL);
g_return_if_fail (thread != NULL);
GST_INFO (GST_CAT_COTHREADS, "flag cothread %d for destruction",
cothread->cothreadnum);
thread->cothreadnum);
/* we simply flag the cothread for destruction here */
if (cothread)
cothread->flags |= COTHREAD_DESTROYED;
if (thread)
thread->flags |= COTHREAD_DESTROYED;
else
g_warning ("somebody set up us the bomb");
}

5
gst/gst.c
View file

@ -140,8 +140,9 @@ gst_init_get_popt_table (void)
* This function will return %FALSE if GStreamer could not be initialized
* for some reason. If you want your program to fail fatally,
* use gst_init() instead.
*
* Returns: TRUE if GStreamer coul be initialized
*/
gboolean
gst_init_check (int *argc, char **argv[])
{
@ -176,6 +177,8 @@ gst_init (int *argc, char **argv[])
* Initializes the GStreamer library, parsing the options,
* setting up internal path lists,
* registering built-in elements, and loading standard plugins.
*
* Returns: TRUE when the initialization succeeded.
*/
gboolean
gst_init_with_popt_table (int *argc, char **argv[],

6
gst/gstbuffer.c
View file

@ -412,6 +412,12 @@ gst_buffer_span (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len)
return newbuf;
}
/**
* gst_buffer_pool_default_free:
* @pool: a #GstBufferPool to free.
*
* Frees the memory associated with the bufferpool.
*/
void
gst_buffer_pool_default_free (GstBufferPool *pool)
{

4
gst/gstbufferpool-default.c
View file

@ -51,7 +51,7 @@ static GHashTable *_default_pools = NULL;
/**
* _gst_buffer_pool_get_default:
* gst_buffer_pool_get_default:
* @buffer_size: the number of bytes this buffer will store
* @pool_size: the default number of buffers to be preallocated
*
@ -60,7 +60,7 @@ static GHashTable *_default_pools = NULL;
* already exists this will be returned, otherwise a new instance will
* be created.
*
* Returns: an instance of GstBufferPool
* Returns: an instance of #GstBufferPool
*/
GstBufferPool*
gst_buffer_pool_get_default (guint buffer_size, guint pool_size)

2
gst/gstbufferpool-default.h
View file

@ -29,7 +29,7 @@
G_BEGIN_DECLS
/* a default pool */
GstBufferPool* gst_buffer_pool_get_default (guint size, guint numbuffers);
GstBufferPool* gst_buffer_pool_get_default (guint buffer_size, guint pool_size);
G_END_DECLS

23
gst/gstclock.c
View file

@ -92,7 +92,7 @@ gst_clock_new_single_shot_id (GstClock *clock, GstClockTime time)
}
/**
* gst_clock_new_periodic__id
* gst_clock_new_periodic_id
* @clock: The clockid to get a periodic notification id from
* @start_time: the requested start time
* @interval: the requested interval
@ -191,15 +191,13 @@ done:
}
/**
* gst_clock_wait_async
* @clock: a #GstClock to wait on
* @time: The #GstClockTime to wait for
* gst_clock_id_wait_async:
* @id: a #GstClockID to wait on
* @func: The callback function
* @user_data: User data passed in the calback
*
* Register a callback on the given clock that will be triggered
* when the clock has reached the given time. A ClockID is returned
* that can be used to cancel the request.
* Register a callback on the given clockid with the given
* function and user_data.
*
* Returns: the result of the non blocking wait.
*/
@ -230,13 +228,10 @@ gst_clock_id_wait_async (GstClockID id,
}
/**
* gst_clock_remove_id
* @clock: The clock to cancel the request on
* @id: The id to cancel
* gst_clock_id_unschedule:
* @id: The id to unschedule
*
* Cancel an outstanding async notification request with the given ID.
* This can be an ID generated with gst_clock_wait_async() or
* gst_clock_notify_async().
*/
void
gst_clock_id_unschedule (GstClockID id)
@ -254,7 +249,7 @@ gst_clock_id_unschedule (GstClockID id)
}
/**
* gst_clock_id_free
* gst_clock_id_free:
* @id: The clockid to free
*
* Free the resources held by the given id
@ -268,7 +263,7 @@ gst_clock_id_free (GstClockID id)
}
/**
* gst_clock_unlock_id
* gst_clock_id_unlock:
* @id: The clockid to unlock
*
* Unlock the givan ClockID.

9
gst/gstclock.h
View file

@ -61,17 +61,18 @@ typedef struct _GstClockEntry GstClockEntry;
typedef struct _GstClock GstClock;
typedef struct _GstClockClass GstClockClass;
typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time, GstClockID id, gpointer user_data);
typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
GstClockID id, gpointer user_data);
typedef enum {
/*< protected >*/
/* --- protected --- */
GST_CLOCK_ENTRY_OK,
GST_CLOCK_ENTRY_EARLY,
GST_CLOCK_ENTRY_RESTART,
} GstClockEntryStatus;
typedef enum {
/*< protected >*/
/* --- protected --- */
GST_CLOCK_ENTRY_SINGLE,
GST_CLOCK_ENTRY_PERIODIC,
} GstClockEntryType;
@ -84,7 +85,7 @@ typedef enum {
#define GST_CLOCK_ENTRY_STATUS(entry) ((entry)->status)
struct _GstClockEntry {
/*< protected >*/
/* --- protected --- */
GstClock *clock;
GstClockEntryType type;
GstClockTime time;

2
gst/gstdata.c
View file

@ -103,6 +103,8 @@ gst_data_copy (const GstData *data)
* gst_data_needs_copy_on_write:
* @data: a #GstData to copy
*
* Query if the gstdata needs to be copied before it can safely be modified.
*
* Returns: TRUE if the given #GstData is potentially shared and needs to
* be copied before it can be modified safely.
*/

27
gst/gstelement.c
View file

@ -766,14 +766,29 @@ gst_element_clock_wait (GstElement *element, GstClock *clock, GstClockTime time,
return res;
}
/**
* gst_element_is_indexable:
* @element: a #GstElement.
*
* Queries if the element can be indexed/
*
* Returns: TRUE if the element can be indexed.
*/
gboolean
gst_element_is_cachable (GstElement *element)
gst_element_is_indexable (GstElement *element)
{
g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
return (CLASS (element)->set_index != NULL);
}
/**
* gst_element_set_index:
* @element: a #GstElement.
* @index: a #GstIndex.
*
* Set the specified GstIndex on the element.
*/
void
gst_element_set_index (GstElement *element, GstIndex *index)
{
@ -784,6 +799,15 @@ gst_element_set_index (GstElement *element, GstIndex *index)
CLASS (element)->set_index (element, index);
}
/**
* gst_element_get_index:
* @element: a #GstElement.
*
* Gets the index from the element.
*
* Returns: a #GstIndex or NULL when no index was set on the
* element.
*/
GstIndex*
gst_element_get_index (GstElement *element)
{
@ -795,7 +819,6 @@ gst_element_get_index (GstElement *element)
return NULL;
}
/**
* gst_element_release_locks:
* @element: a #GstElement to release all locks on.

2
gst/gstelement.h
View file

@ -224,7 +224,7 @@ void gst_element_set_clock (GstElement *element, GstClock *clock);
GstClockReturn gst_element_clock_wait (GstElement *element, GstClock *clock,
GstClockTime time, GstClockTimeDiff *jitter);
/* indexs */
gboolean gst_element_is_cachable (GstElement *element);
gboolean gst_element_is_indexable (GstElement *element);
void gst_element_set_index (GstElement *element, GstIndex *index);
GstIndex* gst_element_get_index (GstElement *element);

86
gst/gstindex.c
View file

@ -226,6 +226,15 @@ gst_index_get_certainty(GstIndex *index)
return index->curgroup->certainty;
}
/**
* gst_index_set_filter:
* @index: the index to register the filter on
* @filter: the filter to register
* @user_data: data passed to the filter function
*
* Lets the app register a custom filter function so that
* it can select what entries should be stored in the index.
*/
void
gst_index_set_filter (GstIndex *index,
GstIndexFilter filter, gpointer user_data)
@ -236,6 +245,15 @@ gst_index_set_filter (GstIndex *index,
index->filter_user_data = user_data;
}
/**
* gst_index_set_resolver:
* @index: the index to register the resolver on
* @resolver: the resolver to register
* @user_data: data passed to the resolver function
*
* Lets the app register a custom function to map index
* ids to writer descriptions.
*/
void
gst_index_set_resolver (GstIndex *index,
GstIndexResolver resolver, gpointer user_data)
@ -246,6 +264,12 @@ gst_index_set_resolver (GstIndex *index,
index->resolver_user_data = user_data;
}
/**
* gst_index_entry_free:
* @entry: the entry to free
*
* Free the memory used by the given entry.
*/
void
gst_index_entry_free (GstIndexEntry *entry)
{
@ -294,6 +318,8 @@ gst_index_add_format (GstIndex *index, gint id, GstFormat format)
* @id: the id of the index writer
* @description: the description of the index writer
*
* Add an id entry into the index.
*
* Returns: a pointer to the newly added entry in the index.
*/
GstIndexEntry*
@ -371,6 +397,7 @@ gst_index_get_writer_id (GstIndex *index, GstObject *writer, gint *id)
* gst_index_add_association:
* @index: the index to add the entry to
* @id: the id of the index writer
* @flags: optinal flags for this entry
* @format: the format of the value
* @value: the value
* @...: other format/value pairs or 0 to end the list
@ -441,6 +468,25 @@ gst_index_add_association (GstIndex *index, gint id, GstAssocFlags flags,
return entry;
}
/**
* gst_index_add_object:
* @index: the index to add the object to
* @id: the id of the index writer
* @key: a key for the object
* @type: the GType of the object
* @object: a pointer to the object to add
*
* Add the given object to the index with the given key.
*
* Returns: a pointer to the newly added entry in the index.
*/
GstIndexEntry*
gst_index_add_object (GstIndex *index, gint id, gchar *key,
GType type, gpointer object)
{
return NULL;
}
static gint
gst_index_compare_func (gconstpointer a,
gconstpointer b,
@ -449,6 +495,19 @@ gst_index_compare_func (gconstpointer a,
return a - b;
}
/**
* gst_index_get_assoc_entry:
* @index: the index to search
* @id: the id of the index writer
* @method: The lookup method to use
* @format: the format of the value
* @value: the value to find
*
* Finds the given format/value in the index
*
* Returns: the entry associated with the value or NULL if the
* value was not found.
*/
GstIndexEntry*
gst_index_get_assoc_entry (GstIndex *index, gint id,
GstIndexLookupMethod method,
@ -460,6 +519,22 @@ gst_index_get_assoc_entry (GstIndex *index, gint id,
gst_index_compare_func, NULL);
}
/**
* gst_index_get_assoc_entry_full:
* @index: the index to search
* @id: the id of the index writer
* @method: The lookup method to use
* @format: the format of the value
* @value: the value to find
* @func: the function used to compare entries
* @user_data: user data passed to the compare function
*
* Finds the given format/value in the index with the given
* compare function and user_data.
*
* Returns: the entry associated with the value or NULL if the
* value was not found.
*/
GstIndexEntry*
gst_index_get_assoc_entry_full (GstIndex *index, gint id,
GstIndexLookupMethod method,
@ -475,6 +550,17 @@ gst_index_get_assoc_entry_full (GstIndex *index, gint id,
return NULL;
}
/**
* gst_index_entry_assoc_map:
* @entry: the index to search
* @format: the format of the value the find
* @value: a pointer to store the value
*
* Gets alternative formats associated with the indexentry.
*
* Returns: TRUE if there was a value associated with the given
* format.
*/
gboolean
gst_index_entry_assoc_map (GstIndexEntry *entry,
GstFormat format, gint64 *value)

3
gst/gstobject.c
View file

@ -315,7 +315,8 @@ gst_object_dispatch_properties_changed (GObject *object,
* @object: the #GObject that signalled the notify.
* @orig: a #GstObject that initiated the notify.
* @pspec: a #GParamSpec of the property.
* @excluded_props: a set of user-specified properties to exclude.
* @excluded_props: a set of user-specified properties to exclude or
* NULL to show all changes.
*
* Adds a default deep_notify signal callback to an
* element. The user data should contain a pointer to an array of

127
gst/gstpad.c
View file

@ -357,7 +357,6 @@ gst_pad_new_from_template (GstPadTemplate *templ, const gchar *name)
GstPadDirection
gst_pad_get_direction (GstPad *pad)
{
g_return_val_if_fail (pad != NULL, GST_PAD_UNKNOWN);
g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
return GST_PAD_DIRECTION (pad);
@ -366,6 +365,7 @@ gst_pad_get_direction (GstPad *pad)
/**
* gst_pad_set_active:
* @pad: the #GstPad to activate or deactivate.
* @active: TRUE to activate the pad.
*
* Activates or deactivates the given pad.
*/
@ -375,7 +375,6 @@ gst_pad_set_active (GstPad *pad, gboolean active)
GstRealPad *realpad;
gboolean old;
g_return_if_fail (pad != NULL);
g_return_if_fail (GST_IS_PAD (pad));
if (GST_PAD_IS_ACTIVE (pad) == active)
@ -398,6 +397,22 @@ gst_pad_set_active (GstPad *pad, gboolean active)
g_object_notify (G_OBJECT (realpad), "active");
}
/**
* gst_pad_is_active:
* @pad: the #GstPad to query
*
* Query if a pad is active
*
* Returns: TRUE if the pad is active.
*/
gboolean
gst_pad_is_active (GstPad *pad)
{
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
return !GST_FLAG_IS_SET (pad, GST_PAD_DISABLED);
}
/**
* gst_pad_set_name:
* @pad: a #GstPad to set the name of.
@ -409,7 +424,6 @@ gst_pad_set_active (GstPad *pad, gboolean active)
void
gst_pad_set_name (GstPad *pad, const gchar *name)
{
g_return_if_fail (pad != NULL);
g_return_if_fail (GST_IS_PAD (pad));
gst_object_set_name (GST_OBJECT (pad), name);
@ -482,7 +496,6 @@ void
gst_pad_set_event_function (GstPad *pad,
GstPadEventFunction event)
{
g_return_if_fail (pad != NULL);
g_return_if_fail (GST_IS_REAL_PAD (pad));
GST_RPAD_EVENTFUNC (pad) = event;
@ -491,19 +504,34 @@ gst_pad_set_event_function (GstPad *pad,
GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (event));
}
/**
* gst_pad_set_event_mask_function:
* @pad: a #GstPad to set the event mask function for.
* @mask_func: the #GstPadEventMaskFunction to set.
*
* Sets the given event mask function for the pad.
*/
void
gst_pad_set_event_mask_function (GstPad *pad,
GstPadEventMaskFunction mask_function)
GstPadEventMaskFunction mask_func)
{
g_return_if_fail (pad != NULL);
g_return_if_fail (GST_IS_REAL_PAD (pad));
GST_RPAD_EVENTMASKFUNC (pad) = mask_function;
GST_RPAD_EVENTMASKFUNC (pad) = mask_func;
GST_DEBUG (GST_CAT_PADS, "eventmaskfunc for %s:%s set to %s",
GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (mask_function));
GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (mask_func));
}
/**
* gst_pad_get_event_masks:
* @pad: a #GstPad to get the event mask for.
*
* Gets the array of eventmasks from the given pad.
*
* Returns: an array with eventmasks, the list is ended
* with 0
*/
const GstEventMask*
gst_pad_get_event_masks (GstPad *pad)
{
@ -523,13 +551,22 @@ gst_pad_get_event_masks (GstPad *pad)
}
static gboolean
gst_pad_get_event_masks_dispatcher (GstPad *pad, const GstFormat **data)
gst_pad_get_event_masks_dispatcher (GstPad *pad, const GstEventMask **data)
{
*data = gst_pad_get_formats (pad);
*data = gst_pad_get_event_masks (pad);
return TRUE;
}
/**
* gst_pad_get_event_masks_default:
* @pad: a #GstPad to get the event mask for.
*
* Invokes the default event masks dispatcher on the pad.
*
* Returns: an array with eventmasks, the list is ended
* with 0
*/
const GstEventMask*
gst_pad_get_event_masks_default (GstPad *pad)
{
@ -541,6 +578,15 @@ gst_pad_get_event_masks_default (GstPad *pad)
return result;
}
/**
* gst_pad_handles_event:
* @pad: a #GstPad to check
* @mask: the mask to check
*
* Checks if the pad can handle the given eventmask.
*
* Returns: TRUE if the pad can handle the given eventmask
*/
gboolean
gst_pad_handles_event (GstPad *pad, GstEventMask *mask)
{
@ -603,6 +649,13 @@ gst_pad_set_query_function (GstPad *pad, GstPadQueryFunction query)
GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (query));
}
/**
* gst_pad_set_query_type_function:
* @pad: the #GstPad to set the query type function for.
* @type_func: the #GstPadQueryTypeFunction to set.
*
* Set the given query type function for the pad.
*/
void
gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_func)
{
@ -615,6 +668,15 @@ gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_func)
GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (type_func));
}
/**
* gst_pad_get_query_types:
* @pad: the #GstPad to query
*
* Get an array of supported queries that can be performed
* on this pad.
*
* Returns: an array of querytypes anded with 0.
*/
const GstPadQueryType*
gst_pad_get_query_types (GstPad *pad)
{
@ -641,6 +703,15 @@ gst_pad_get_query_types_dispatcher (GstPad *pad, const GstPadQueryType **data)
return TRUE;
}
/**
* gst_pad_get_query_types_default:
* @pad: the #GstPad to query
*
* Invoke the default dispatcher for the query types on
* the pad.
*
* Returns: an array of querytypes anded with 0.
*/
const GstPadQueryType*
gst_pad_get_query_types_default (GstPad *pad)
{
@ -1100,7 +1171,6 @@ gst_pad_get_parent (GstPad *pad)
GstPadTemplate*
gst_pad_get_pad_template (GstPad *pad)
{
g_return_val_if_fail (pad != NULL, NULL);
g_return_val_if_fail (GST_IS_PAD (pad), NULL);
return GST_PAD_PAD_TEMPLATE (pad);
@ -1111,7 +1181,10 @@ gst_pad_get_pad_template (GstPad *pad)
* gst_pad_get_scheduler:
* @pad: a #GstPad to get the scheduler of.
*
* Gets the scheduler of the pad.
* Gets the scheduler of the pad. Since the pad does not
* have a scheduler of its own, the scheduler of the parent
* is taken. For decoupled pads, the scheduler of the peer
* parent is taken.
*
* Returns: the #GstScheduler of the pad.
*/
@ -1121,7 +1194,6 @@ gst_pad_get_scheduler (GstPad *pad)
GstScheduler *scheduler = NULL;
GstElement *parent;
g_return_val_if_fail (pad != NULL, NULL);
g_return_val_if_fail (GST_IS_PAD (pad), NULL);
parent = gst_pad_get_parent (pad);
@ -2041,12 +2113,10 @@ gst_pad_save_thyself (GstObject *object, xmlNodePtr parent)
}
/* FIXME: shouldn't pad and ghost be switched ?
* FIXME: shouldn't the bin argument be dumped ?
*/
/**
* gst_ghost_pad_save_thyself:
* @pad: a ghost #GstPad to save.
* @bin: the #bin
* @parent: the parent #xmlNodePtr to save the description in.
*
* Saves the ghost pad into an xml representation.
@ -2469,7 +2539,7 @@ gst_ghost_pad_init (GstGhostPad *pad)
*
* Creates a new ghost pad associated with the given pad, and names it with
* the given name. If name is NULL, a guaranteed unique name (across all
* ghost pads) will be assigned (most likely of the form ghostpad%d).
* ghost pads) will be assigned (most likely of the form ghostpad&perc;d).
*
* Returns: a new ghost #GstPad, or NULL in case of an error.
*/
@ -2887,6 +2957,15 @@ gst_pad_query (GstPad *pad, GstPadQueryType type,
return FALSE;
}
/**
* gst_pad_handles_format:
* @pad: a #GstPad to check
* @format: the format to check
*
* Checks if the pad can handle the given format.
*
* Returns: TRUE if the pad can handle the given format
*/
gboolean
gst_pad_handles_format (GstPad *pad, GstFormat format)
{
@ -2914,6 +2993,14 @@ gst_pad_get_formats_dispatcher (GstPad *pad, const GstFormat **data)
return TRUE;
}
/**
* gst_pad_get_formats_default:
* @pad: a #GstPad to query
*
* Invoke the default format dispatcher for the pad.
*
* Returns: An array of GstFormats ended with a 0 value.
*/
const GstFormat*
gst_pad_get_formats_default (GstPad *pad)
{
@ -2925,6 +3012,14 @@ gst_pad_get_formats_default (GstPad *pad)
return result;
}
/**
* gst_pad_get_formats:
* @pad: a #GstPad to query
*
* Gets the list of supported formats from the pad.
*
* Returns: An array of GstFormats ended with a 0 value.
*/
const GstFormat*
gst_pad_get_formats (GstPad *pad)
{

13
gst/gstpad.h
View file

@ -285,9 +285,6 @@ struct _GstGhostPadClass {
#define GST_RPAD_QUERYTYPEFUNC(pad) (((GstRealPad *)(pad))->querytypefunc)
#define GST_RPAD_EVENTMASKFUNC(pad) (((GstRealPad *)(pad))->eventmaskfunc)
#define GST_RPAD_EVENT_MASKS(pad) (((GstRealPad *)(pad))->event_masks)
#define GST_RPAD_QUERY_TYPES(pad) (((GstRealPad *)(pad))->query_types)
#define GST_RPAD_CONNECTFUNC(pad) (((GstRealPad *)(pad))->connectfunc)
#define GST_RPAD_GETCAPSFUNC(pad) (((GstRealPad *)(pad))->getcapsfunc)
#define GST_RPAD_BUFFERPOOLFUNC(pad) (((GstRealPad *)(pad))->bufferpoolfunc)
@ -480,7 +477,8 @@ GstPad* gst_pad_selectv (GstPad *pad, ...);
/* convert/query/format functions */
void gst_pad_set_formats_function (GstPad *pad, GstPadFormatsFunction format);
void gst_pad_set_formats_function (GstPad *pad,
GstPadFormatsFunction formats);
gboolean gst_pad_handles_format (GstPad *pad, GstFormat format);
const GstFormat* gst_pad_get_formats (GstPad *pad);
const GstFormat* gst_pad_get_formats_default (GstPad *pad);
@ -494,7 +492,7 @@ gboolean gst_pad_convert_default (GstPad *pad,
GstFormat *dest_format, gint64 *dest_value);
void gst_pad_set_query_function (GstPad *pad, GstPadQueryFunction query);
void gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_function);
void gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_func);
const GstPadQueryType* gst_pad_get_query_types (GstPad *pad);
const GstPadQueryType* gst_pad_get_query_types_default (GstPad *pad);
gboolean gst_pad_query (GstPad *pad, GstPadQueryType type,
@ -511,10 +509,9 @@ gboolean gst_pad_dispatcher (GstPad *pad, GstPadDispatcherFunction dispatch
gpointer data);
#define gst_pad_add_probe(pad, probe) \
(gst_probe_dispatcher_add_probe (&(GST_REAL_PAD (pad)-probedisp), probe))
(gst_probe_dispatcher_add_probe (&(GST_REAL_PAD (pad)-probedisp), probe))
#define gst_pad_remove_probe(pad, probe) \
(gst_probe_dispatcher_remove_probe (&(GST_REAL_PAD (pad)-probedisp), probe))
(gst_probe_dispatcher_remove_probe (&(GST_REAL_PAD (pad)-probedisp), probe))
#ifndef GST_DISABLE_LOADSAVE
void gst_pad_load_and_connect (xmlNodePtr self, GstObject *parent);

82
gst/gstprobe.c
View file

@ -24,7 +24,16 @@
#include "gstlog.h"
#include "gstprobe.h"
/**
* gst_probe_new:
* @single_shot: TRUE if a single shot probe is required
* @callback: the function to call when the probe is triggered
* @user_data: data passed to the callback function
*
* Create a new probe with the specified parameters
*
* Returns: a new #GstProbe.
*/
GstProbe*
gst_probe_new (gboolean single_shot,
GstProbeCallback callback,
@ -43,6 +52,12 @@ gst_probe_new (gboolean single_shot,
return probe;
}
/**
* gst_probe_destroy:
* @probe: The probe to destroy
*
* Free the memeory associated with the probe.
*/
void
gst_probe_destroy (GstProbe *probe)
{
@ -51,6 +66,15 @@ gst_probe_destroy (GstProbe *probe)
g_free (probe);
}
/**
* gst_probe_perform:
* @probe: The probe to trigger
* @data: the GstData that triggered the probe.
*
* Perform the callback associated with the given probe.
*
* Returns: the result of the probe callback function.
*/
gboolean
gst_probe_perform (GstProbe *probe, GstData *data)
{
@ -64,6 +88,13 @@ gst_probe_perform (GstProbe *probe, GstData *data)
return res;
}
/**
* gst_probe_dispatcher_new:
*
* Create a new probe dispatcher
*
* Returns: a new probe dispatcher.
*/
GstProbeDispatcher*
gst_probe_dispatcher_new (void)
{
@ -76,11 +107,29 @@ gst_probe_dispatcher_new (void)
return disp;
}
/**
* gst_probe_dispatcher_destroy:
* @disp: the dispatcher to destroy
*
* Free the memory allocated by the probe dispatcher. All pending
* probes are removed first.
*/
void
gst_probe_dispatcher_destroy (GstProbeDispatcher *disp)
{
g_return_if_fail (disp);
/* FIXME, free pending probes */
g_free (disp);
}
/**
* gst_probe_dispatcher_init:
* @disp: the dispatcher to initialize
*
* Initialize the dispatcher. Useful for statically allocated probe
* dispatchers.
*/
void
gst_probe_dispatcher_init (GstProbeDispatcher *disp)
{
@ -90,6 +139,14 @@ gst_probe_dispatcher_init (GstProbeDispatcher *disp)
disp->probes = NULL;
}
/**
* gst_probe_dispatcher_set_active:
* @disp: the dispatcher to activate
* @active: boolean to indicate activation or deactivation
*
* Activate or deactivate the given dispatcher
* dispatchers.
*/
void
gst_probe_dispatcher_set_active (GstProbeDispatcher *disp, gboolean active)
{
@ -98,6 +155,13 @@ gst_probe_dispatcher_set_active (GstProbeDispatcher *disp, gboolean active)
disp->active = active;
}
/**
* gst_probe_dispatcher_add_probe:
* @disp: the dispatcher to add the probe to
* @probe: the probe to add to the dispatcher
*
* Adds the given probe to the dispatcher.
*/
void
gst_probe_dispatcher_add_probe (GstProbeDispatcher *disp, GstProbe *probe)
{
@ -107,6 +171,13 @@ gst_probe_dispatcher_add_probe (GstProbeDispatcher *disp, GstProbe *probe)
disp->probes = g_slist_prepend (disp->probes, probe);
}
/**
* gst_probe_dispatcher_remove_probe:
* @disp: the dispatcher to remove the probe from
* @probe: the probe to remove from the dispatcher
*
* Removes the given probe from the dispatcher.
*/
void
gst_probe_dispatcher_remove_probe (GstProbeDispatcher *disp, GstProbe *probe)
{
@ -116,6 +187,15 @@ gst_probe_dispatcher_remove_probe (GstProbeDispatcher *disp, GstProbe *probe)
disp->probes = g_slist_remove (disp->probes, probe);
}
/**
* gst_probe_dispatcher_dispatch:
* @disp: the dispatcher to dispatch
* @data: the data that triggered the dispatch
*
* Trigger all registered probes on the given dispatcher.
*
* Returns: TRUE if all callbacks returned TRUE.
*/
gboolean
gst_probe_dispatcher_dispatch (GstProbeDispatcher *disp, GstData *data)
{

6
gst/gstprobe.h
View file

@ -44,12 +44,12 @@ struct _GstProbe {
};
GstProbe* gst_pad_probe_new (gboolean single_shot,
GstProbe* gst_probe_new (gboolean single_shot,
GstProbeCallback callback,
gpointer user_data);
void gst_pad_probe_destroy (GstProbe *probe);
void gst_probe_destroy (GstProbe *probe);
gboolean gst_pad_probe_perform (GstProbe *probe, GstData *data);
gboolean gst_probe_perform (GstProbe *probe, GstData *data);
typedef struct _GstProbeDispatcher GstProbeDispatcher;

12
gst/gstscheduler.c
View file

@ -295,15 +295,13 @@ gst_scheduler_state_transition (GstScheduler *sched, GstElement *element, gint t
}
/**
* gst_scheduler_state_transition:
* gst_scheduler_scheduling_change:
* @sched: the scheduler
* @element: the element with the state transition
* @transition: the state transition
* @element: the element that changed its scheduling strategy
*
* Tell the scheduler that an element changed its state.
*
* Returns: a GstElementStateReturn indicating success or failure
* of the state transition.
* Tell the scheduler that an element changed its scheduling strategy.
* An element could, for example, change its loop function or changes
* from a loop based element to a chain based element.
*/
void
gst_scheduler_scheduling_change (GstScheduler *sched, GstElement *element)

79
gst/gstthread.c
View file

@ -60,7 +60,6 @@ enum {
enum {
ARG_0,
ARG_SCHEDPOLICY,
ARG_PRIORITY,
};
@ -71,9 +70,10 @@ static void gst_thread_init (GstThread *thread);
static void gst_thread_dispose (GObject *object);
static void gst_thread_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
static void gst_thread_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
static void gst_thread_set_property (GObject *object, guint prop_id,
const GValue *value, GParamSpec *pspec);
static void gst_thread_get_property (GObject *object, guint prop_id,
GValue *value, GParamSpec *pspec);
static
GstElementStateReturn gst_thread_change_state (GstElement *element);
@ -86,21 +86,23 @@ static void gst_thread_restore_thyself (GstObject *object,
static void* gst_thread_main_loop (void *arg);
#define GST_TYPE_THREAD_SCHEDPOLICY (gst_thread_schedpolicy_get_type())
#define GST_TYPE_THREAD_PRIORITY (gst_thread_priority_get_type())
static GType
gst_thread_schedpolicy_get_type(void) {
static GType thread_schedpolicy_type = 0;
static GEnumValue thread_schedpolicy[] = {
{G_THREAD_PRIORITY_LOW, "LOW", "Low Priority Scheduling"},
{G_THREAD_PRIORITY_NORMAL, "NORMAL", "Normal Scheduling"},
{G_THREAD_PRIORITY_HIGH, "HIGH", "High Priority Scheduling"},
{G_THREAD_PRIORITY_URGENT, "URGENT", "Urgent Scheduling"},
{0, NULL, NULL},
gst_thread_priority_get_type(void)
{
static GType thread_priority_type = 0;
static GEnumValue thread_priority[] =
{
{ G_THREAD_PRIORITY_LOW, "LOW", "Low Priority Scheduling" },
{ G_THREAD_PRIORITY_NORMAL, "NORMAL", "Normal Scheduling" },
{ G_THREAD_PRIORITY_HIGH, "HIGH", "High Priority Scheduling" },
{ G_THREAD_PRIORITY_URGENT, "URGENT", "Urgent Scheduling" },
{ 0, NULL, NULL },
};
if (!thread_schedpolicy_type) {
thread_schedpolicy_type = g_enum_register_static("GstThreadSchedPolicy", thread_schedpolicy);
if (!thread_priority_type) {
thread_priority_type = g_enum_register_static("GstThreadPriority", thread_priority);
}
return thread_schedpolicy_type;
return thread_priority_type;
}
static GstBinClass *parent_class = NULL;
@ -140,12 +142,9 @@ gst_thread_class_init (GstThreadClass *klass)
parent_class = g_type_class_ref (GST_TYPE_BIN);
g_object_class_install_property(G_OBJECT_CLASS (klass), ARG_SCHEDPOLICY,
g_param_spec_enum("schedpolicy", "Scheduling Policy", "The scheduling policy of the thread",
GST_TYPE_THREAD_SCHEDPOLICY, G_THREAD_PRIORITY_NORMAL, G_PARAM_READWRITE));
g_object_class_install_property(G_OBJECT_CLASS (klass), ARG_PRIORITY,
g_param_spec_int("priority", "Scheduling Priority", "The scheduling priority of the thread",
0, 99, 0, G_PARAM_READWRITE));
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PRIORITY,
g_param_spec_enum ("priority", "Scheduling Policy", "The scheduling priority of the thread",
GST_TYPE_THREAD_PRIORITY, G_THREAD_PRIORITY_NORMAL, G_PARAM_READWRITE));
gst_thread_signals[SHUTDOWN] =
g_signal_new ("shutdown", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
@ -186,8 +185,7 @@ gst_thread_init (GstThread *thread)
thread->ppid = getpid ();
thread->thread_id = (GThread *) NULL; /* set in NULL -> READY */
thread->sched_policy = G_THREAD_PRIORITY_NORMAL;
thread->priority = 0;
thread->priority = G_THREAD_PRIORITY_NORMAL;
thread->stack = NULL;
}
@ -216,22 +214,31 @@ gst_thread_dispose (GObject *object)
}
}
/**
* gst_thread_set_priority:
* @thread: the thread to change
* @priority: the new priority for the thread
*
* change the thread's priority
*/
void
gst_thread_set_priority (GstThread *thread, GThreadPriority priority)
{
g_return_if_fail (GST_IS_THREAD (thread));
thread->priority = priority;
}
static void
gst_thread_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
{
GstThread *thread;
/* it's not null if we got it, but it might not be ours */
g_return_if_fail (GST_IS_THREAD (object));
thread = GST_THREAD (object);
switch (prop_id) {
case ARG_SCHEDPOLICY:
thread->sched_policy = g_value_get_enum (value);
break;
case ARG_PRIORITY:
thread->priority = g_value_get_int (value);
thread->priority = g_value_get_enum (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
@ -244,17 +251,11 @@ gst_thread_get_property (GObject *object, guint prop_id, GValue *value, GParamSp
{
GstThread *thread;
/* it's not null if we got it, but it might not be ours */
g_return_if_fail (GST_IS_THREAD (object));
thread = GST_THREAD (object);
switch (prop_id) {
case ARG_SCHEDPOLICY:
g_value_set_enum (value, thread->sched_policy);
break;
case ARG_PRIORITY:
g_value_set_int (value, thread->priority);
g_value_set_enum (value, thread->priority);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
@ -365,7 +366,7 @@ gst_thread_change_state (GstElement *element)
*/
GST_DEBUG (GST_CAT_THREAD, "going to g_thread_create_full...");
thread->thread_id = g_thread_create_full(gst_thread_main_loop,
thread, STACK_SIZE, TRUE, TRUE, G_THREAD_PRIORITY_NORMAL,
thread, STACK_SIZE, TRUE, TRUE, thread->priority,
&error);
if (!thread->thread_id){

6
gst/gstthread.h
View file

@ -43,7 +43,6 @@ typedef enum {
GST_THREAD_FLAG_LAST = GST_BIN_FLAG_LAST + 4
} GstThreadState;
#define GST_TYPE_THREAD \
(gst_thread_get_type())
#define GST_THREAD(obj) \
@ -62,8 +61,7 @@ struct _GstThread {
GstBin bin;
GThread *thread_id; /* id of the thread, if any */
int sched_policy;
int priority;
GThreadPriority priority;
gpointer *stack;
guint stack_size; /* stack size */
gint pid; /* the pid of the thread */
@ -85,6 +83,8 @@ GType gst_thread_get_type (void);
GstElement* gst_thread_new (const gchar *name);
void gst_thread_set_priority (GstThread *thread, GThreadPriority priority);
G_END_DECLS