+2004-03-29 David Schleef <ds@schleef.org>
+
+ * docs/gst/Makefile.am: Disable a bunch of headers from being scanned
+ * docs/gst/gstreamer-docs.sgml: More hacking
+ * docs/gst/gstreamer-sections.txt:
+ * docs/gst/tmpl/cothreads_compat.sgml:
+ * docs/gst/tmpl/gstcaps.sgml:
+ * docs/gst/tmpl/gstclock.sgml:
+ * docs/gst/tmpl/gstelement.sgml:
+ * docs/gst/tmpl/gstevent.sgml:
+ * docs/gst/tmpl/gstpad.sgml:
+ * docs/gst/tmpl/gstutils.sgml:
+ * docs/gst/tmpl/gstxml.sgml:
+ * docs/gst/tmpl/gthread-cothreads.sgml:
+ * docs/random/ds/0.9-suggested-changes:
+ * gst/elements/gstfakesink.h: doc fixes
+ * gst/elements/gstfakesrc.h: doc fixes
+ * gst/gstcaps.c: doc fixes
+ * gst/gstcaps.h: doc fixes
+ * gst/gstelement.c: doc fixes
+ * gst/gstelement.h: doc fixes
+ * gst/gstindex.c: doc fixes
+ * gst/gstinfo.c: doc fixes
+ * gst/gstpad.c: doc fixes
+ * gst/gstpad.h: doc fixes
+ * gst/gstplugin.c: doc fixes
+ * gst/gsttypefind.h: doc fixes
+ * gst/gsturi.c: doc fixes
+ * gst/gstvalue.c: doc fixes
+
2004-03-29 Colin Walters <walters@redhat.com>
* gst/registries/gstxmlregistry.c (get_time)
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
# Header files to ignore when scanning.
-IGNORE_HFILES=
+IGNORE_HFILES= \
+ gettext.h \
+ gst-i18n-lib.h \
+ gst-i18n-app.h \
+ gst_private.h \
+ gstatomic_impl.h \
+ gstdata_private.h \
+ gstarch.h \
+ cothreads.h \
+ schedulers/cothreads_compat.h \
+ schedulers/gthread-cothreads.h \
+ parse/types.h \
+ elements/gstaggregator.h \
+ elements/gstbufferstore.h \
+ elements/gstfakesink.h \
+ elements/gstfakesrc.h \
+ elements/gstfdsink.h \
+ elements/gstfdsrc.h \
+ elements/gstfilesink.h \
+ elements/gstfilesrc.h \
+ elements/gstidentity.h \
+ elements/gstmd5sink.h \
+ elements/gstmultifilesrc.h \
+ elements/gstpipefilter.h \
+ elements/gstshaper.h \
+ elements/gststatistics.h \
+ elements/gsttee.h \
+ elements/gsttypefind.h
# Images to copy into HTML directory.
HTML_IMAGES =
<!-- these are elements without API docs
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
-->
-<!ENTITY cothreads SYSTEM "xml/cothreads.xml">
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
<para>
</para>
- &cothreads;
&GstAtomic;
&GstMemChunk;
gst_clock_handle_discont
gst_clock_get_time
gst_clock_get_event_time
+gst_clock_get_event_time_delay
gst_clock_get_next_id
gst_clock_new_single_shot_id
gst_clock_new_periodic_id
gst_element_get_time
gst_element_wait
gst_element_set_time
+gst_element_set_time_delay
gst_element_adjust_time
gst_element_is_indexable
gst_element_set_index
<SECTION>
<FILE>gstevent</FILE>
GstEventType
+GST_EVENT_ANY
GST_EVENT_TRACE_NAME
GST_EVENT_TYPE
GST_EVENT_TIMESTAMP
</SECTION>
<SECTION>
-<FILE>cothreads</FILE>
-cothread_state
-cothread_context
-cothread_func
-COTHREAD_STARTED
-COTHREAD_DESTROYED
-cothread_context_init
-cothread_context_free
-cothread_context_set_data
-cothread_context_get_data
-cothread_create
-cothread_free
-cothread_setfunc
-cothread_stop
-cothread_switch
-cothread_set_private
-cothread_get_private
-cothread_lock
-cothread_trylock
-cothread_unlock
-cothread_main
-cothread_current_main
-cothread_current
-</SECTION>
-
-<SECTION>
<FILE>gst</FILE>
gst_init
gst_init_check
</SECTION>
<SECTION>
-<FILE>gst_private</FILE>
-GST_CAT_GST_INIT
-GST_CAT_COTHREADS
-GST_CAT_COTHREAD_SWITCH
-GST_CAT_AUTOPLUG
-GST_CAT_AUTOPLUG_ATTEMPT
-GST_CAT_PARENTAGE
-GST_CAT_STATES
-GST_CAT_PLANNING
-GST_CAT_SCHEDULING
-GST_CAT_DATAFLOW
-GST_CAT_BUFFER
-GST_CAT_CAPS
-GST_CAT_CLOCK
-GST_CAT_ELEMENT_PADS
-GST_CAT_PADS
-GST_CAT_PIPELINE
-GST_CAT_PLUGIN_LOADING
-GST_CAT_PLUGIN_INFO
-GST_CAT_PROPERTIES
-GST_CAT_THREAD
-GST_CAT_XML
-GST_CAT_NEGOTIATION
-GST_CAT_REFCOUNTING
-GST_CAT_ERROR_SYSTEM
-GST_CAT_EVENT
-GST_CAT_PARAMS
-GST_CAT_CALL_TRACE
-</SECTION>
-
-<SECTION>
-<FILE>gstarch</FILE>
-GST_ARCH_SET_SP
-GST_ARCH_CALL
-GST_ARCH_SETUP_STACK
-GST_ARCH_PRESETJMP
-USE_MAKECONTEXT
-</SECTION>
-
-<SECTION>
<FILE>gstatomic</FILE>
gst_vgint
GstAtomicInt
</SECTION>
<SECTION>
-<FILE>gstatomic_impl</FILE>
-SMP_LOCK
-SMP_SYNC
-SMP_ISYNC
-PPC405_ERR77
-</SECTION>
-
-<SECTION>
<FILE>gstenumtypes</FILE>
gst_object_flags_get_type
GST_TYPE_OBJECT_FLAGS
</SECTION>
<SECTION>
-<FILE>gstdata_private</FILE>
-</SECTION>
-
-<SECTION>
<FILE>gstfilter</FILE>
GstFilterFunc
gst_filter_run
</SECTION>
<SECTION>
-<FILE>gettext</FILE>
-gettext
-dgettext
-dcgettext
-ngettext
-dngettext
-dcngettext
-textdomain
-bindtextdomain
-bind_textdomain_codeset
-gettext_noop
-</SECTION>
-
-<SECTION>
<FILE>gsterror</FILE>
GstCoreError
GstLibraryError
</SECTION>
<SECTION>
-<FILE>gst-i18n-app</FILE>
-_
-N_
-</SECTION>
-
-<SECTION>
-<FILE>gst-i18n-lib</FILE>
-_
-N_
-</SECTION>
-
-<SECTION>
<FILE>gstsearchfuncs</FILE>
GST_AUTOPLUG_MAX_COST
GstAutoplugNode
<SECTION>
<FILE>cothreads_compat</FILE>
+COTHREADS_TYPE
COTHREADS_NAME
COTHREADS_NAME_CAPITAL
cothread
<SECTION>
<FILE>gthread-cothreads</FILE>
+COTHREADS_TYPE
COTHREADS_NAME
COTHREADS_NAME_CAPITAL
cothread_func
do_cothread_unlock
do_cothread_get_current
do_cothread_get_main
+do_cothread_setfunc
</SECTION>
</para>
+<!-- ##### MACRO COTHREADS_TYPE ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### MACRO COTHREADS_NAME ##### -->
<para>
</para>
-@caps:
+@static_caps:
@Returns:
+<!-- # Unused Parameters # -->
+@caps:
<!-- ##### FUNCTION gst_caps_append ##### -->
</para>
-@caps1:
+@caps:
@structure:
+<!-- # Unused Parameters # -->
+@caps1:
<!-- ##### FUNCTION gst_caps_split_one ##### -->
@Returns:
+<!-- ##### FUNCTION gst_clock_get_event_time_delay ##### -->
+<para>
+
+</para>
+
+@clock:
+@delay:
+@Returns:
+
+
<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
<para>
@time:
+<!-- ##### FUNCTION gst_element_set_time_delay ##### -->
+<para>
+
+</para>
+
+@element:
+@time:
+@delay:
+
+
<!-- ##### FUNCTION gst_element_adjust_time ##### -->
<para>
</para>
@plugin:
-@elementname:
+@name:
@rank:
@type:
@Returns:
+<!-- # Unused Parameters # -->
+@elementname:
<!-- ##### FUNCTION gst_element_factory_find ##### -->
@GST_EVENT_NAVIGATION:
@GST_EVENT_TAG:
+<!-- ##### MACRO GST_EVENT_ANY ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### MACRO GST_EVENT_TRACE_NAME ##### -->
<para>
The name used for memory allocation tracing
</para>
@pad:
+@bufalloc:
+<!-- # Unused Parameters # -->
@bufferalloc:
</para>
-@templ:
+@pad_template:
@Returns:
+<!-- # Unused Parameters # -->
+@templ:
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
@\
parent_type_macro:
@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
+ parent_type_macro:
+@\
parent_type_macro:
@additional_initializations:
</para>
+@:
+@:
+@:
+
@gstxml: the object which received the signal.
@arg1:
@arg2:
</para>
-@:
-@:
-@:
+@gstxml: the object which received the signal.
+@arg1:
+@arg2:
</para>
+<!-- ##### MACRO COTHREADS_TYPE ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### MACRO COTHREADS_NAME ##### -->
<para>
</para>
+@Varargs:
+@Param2:
+@Returns:
+<!-- # Unused Parameters # -->
@argc:
@argv:
-@Returns:
<!-- ##### TYPEDEF cothread ##### -->
@context:
+<!-- ##### MACRO do_cothread_setfunc ##### -->
+<para>
+
+</para>
+
+@cothread:
+@context:
+@func:
+@argc:
+@argv:
+
+
- caps should have a flag on fields to indicate that the field is optional
+ - remove gst_pad_select() and add gst_pad_pull_many(), which pulls one
+ buffer from one of many pads
caps:
FAKESINK_STATE_ERROR_PAUSED_PLAYING,
FAKESINK_STATE_ERROR_PLAYING_PAUSED,
FAKESINK_STATE_ERROR_PAUSED_READY,
- FAKESINK_STATE_ERROR_READY_NULL,
+ FAKESINK_STATE_ERROR_READY_NULL
} GstFakeSinkStateError;
typedef struct _GstFakeSink GstFakeSink;
typedef enum {
FAKESRC_DATA_ALLOCATE = 1,
- FAKESRC_DATA_SUBBUFFER,
+ FAKESRC_DATA_SUBBUFFER
} GstFakeSrcDataType;
typedef enum {
/**
* gst_caps_new_simple:
* @media_type: the media type of the structure
+ * @fieldname: first field to set
* @...: additional arguments
*
* Creates a new #GstCaps that contains one #GstStructure. The
/**
* gst_caps_new_full_valist:
- * @struct1: the first structure to add
+ * @structure: the first structure to add
* @var_args: additional structures to add
*
* Creates a new #GstCaps and adds all the structures listed as
* @caps: the #GstCaps that will be appended to
* @structure: the #GstStructure to append
*
- * Appends @structure to @caps1. The structure is not copied; @caps1
+ * Appends @structure to @caps. The structure is not copied; @caps
* becomes the owner of @structure.
*/
void
/**
* gst_caps_from_string:
- * @caps: a string to convert to #GstCaps
+ * @string: a string to convert to #GstCaps
*
* Converts @caps from a string representation.
*
va_list var_args);
GstCaps * gst_caps_copy (const GstCaps *caps);
void gst_caps_free (GstCaps *caps);
-G_CONST_RETURN GstCaps * gst_static_caps_get (GstStaticCaps *caps);
+G_CONST_RETURN GstCaps * gst_static_caps_get (GstStaticCaps *static_caps);
/* manipulation */
void gst_caps_append (GstCaps *caps1,
GstCaps *caps2);
-void gst_caps_append_structure (GstCaps *caps1,
+void gst_caps_append_structure (GstCaps *caps,
GstStructure *structure);
GstCaps * gst_caps_split_one (GstCaps *caps);
int gst_caps_get_size (const GstCaps *caps);
/**
* gst_element_adjust_time:
* @element: element to adjust time on
- * @difference: difference to adjust
+ * @diff: difference to adjust
*
* Adjusts the current time of the element by the specified difference. This
* function can be used when handling discont events. You can only call this
* @code: the error code belonging to the domain
* @message: an allocated message to be used as a replacement for the default
* message connected to code, or NULL
- * debug: an allocated debug message to be used as a replacement for the
+ * @debug: an allocated debug message to be used as a replacement for the
* default debugging information, or NULL
+ * @file: source filename
+ * @function: source function
+ * @line: source line
*
* Signals an error condition on an element.
* This function is used internally by elements.
GType gst_element_factory_get_type (void);
gboolean gst_element_register (GstPlugin *plugin,
- const gchar *elementname,
+ const gchar *name,
guint rank,
GType type);
* @entry: the entry to copy
*
* Copies an entry and returns the result.
+ *
+ * Returns:
*/
GstIndexEntry *
gst_index_entry_copy (GstIndexEntry * entry)
*
* Gets the string representation of a GstDebugMessage. This function is used
* in debug handlers to extract the message.
+ *
+ * Returns: the string representation
*/
const gchar *
gst_debug_message_get (GstDebugMessage * message)
/**
* gst_pad_proxy_pad_link:
* @pad: a #GstPad to proxy.
+ * @caps: the #GstCaps to link with
*
* Calls gst_pad_try_set_caps() for every other pad belonging to the
* same element as @pad. If gst_pad_try_set_caps() fails on any pad,
/**
* gst_pad_proxy_fixate:
* @pad: a #GstPad to proxy.
+ * @caps: the #GstCaps to fixate
*
* Implements a default fixate function based on the caps set on the other
* pads in the element. This function should only be used if every pad
return FALSE;
}
-/* FIXME 0.9: Is it so difficult to write SOURCE? */
/**
* gst_pad_alloc_buffer:
* @pad: a source #GstPad.
+ * @offset: the offset of the new buffer in the stream
+ * @size: the size of the new buffer
*
* Allocates a new, empty buffer optimized to push to pad @pad. This
- * function only works if @pad is a src pad.
+ * function only works if @pad is a source pad.
*
* Returns: a new, empty #GstBuffer, or NULL if there is an error
*/
GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
-void gst_pad_set_bufferalloc_function (GstPad *pad, GstPadBufferAllocFunction bufferalloc);
+void gst_pad_set_bufferalloc_function (GstPad *pad, GstPadBufferAllocFunction bufalloc);
GstBuffer* gst_pad_alloc_buffer (GstPad *pad, guint64 offset, gint size);
/* data passing setup functions */
GstPadDirection direction, GstPadPresence presence,
GstCaps *caps);
-GstPadTemplate * gst_static_pad_template_get (GstStaticPadTemplate *templ);
+GstPadTemplate * gst_static_pad_template_get (GstStaticPadTemplate *pad_template);
const GstCaps* gst_pad_template_get_caps (GstPadTemplate *templ);
const GstCaps* gst_pad_template_get_caps_by_name (GstPadTemplate *templ, const gchar *name);
/**
* gst_plugin_load_file:
- * @plugin: The plugin to load
+ * @filename: The file to load
* @error: Pointer to a NULL-valued GError.
*
* Load the given plugin.
GST_TYPE_FIND_POSSIBLE = 50,
GST_TYPE_FIND_LIKELY = 80,
GST_TYPE_FIND_NEARLY_CERTAIN = 99,
- GST_TYPE_FIND_MAXIMUM = 100,
+ GST_TYPE_FIND_MAXIMUM = 100
} GstTypeFindProbability;
struct _GstTypeFind {
/**
* gst_uri_is_valid:
- * @protocol: string to check
+ * @uri: string to check
*
* Tests if the given string is a valid URI identifier. URIs start with a valid
* protocol followed by "://" and a string identifying the location.
/**
* gst_value_list_append_value:
* @value: a GstValueList to append a value to
- * @apppend_value: the value to append
+ * @append_value: the value to append
*
* Appends @append_value to the GstValueList in @value.
*/
/**
* gst_value_list_get_value:
* @value: a GstValueList
- * @index
+ * @index: the index
*
* Gets the value that is a member of the list contained in @value and
* has the index @index.
/**
* gst_value_can_intersect:
+ * @value1:
+ * @value2:
*
+ * Returns:
*/
gboolean
gst_value_can_intersect (const GValue * value1, const GValue * value2)
/**
* gst_value_register_intersection_func:
+ * @type1:
+ * @type2:
+ * @func:
*
*/
void
/**
* gst_value_register:
+ * @table:
*
*/
void
/**
* gst_value_init_and_copy:
+ * @dest:
+ * @src:
*
*/
void
/**
* gst_value_serialize:
+ * @value:
*
+ * Returns:
*/
gchar *
gst_value_serialize (const GValue * value)
/**
* gst_value_deserialize:
+ * @dest:
+ * @src:
*
+ * Returns:
*/
gboolean
gst_value_deserialize (GValue * dest, const gchar * src)
FAKESINK_STATE_ERROR_PAUSED_PLAYING,
FAKESINK_STATE_ERROR_PLAYING_PAUSED,
FAKESINK_STATE_ERROR_PAUSED_READY,
- FAKESINK_STATE_ERROR_READY_NULL,
+ FAKESINK_STATE_ERROR_READY_NULL
} GstFakeSinkStateError;
typedef struct _GstFakeSink GstFakeSink;
typedef enum {
FAKESRC_DATA_ALLOCATE = 1,
- FAKESRC_DATA_SUBBUFFER,
+ FAKESRC_DATA_SUBBUFFER
} GstFakeSrcDataType;
typedef enum {
projects / platform / upstream / gstreamer.git / commitdiff