mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-06-26 01:40:38 +00:00
Code Issues 1 Projects Releases Wiki Activity

install style.css along with docs fixing incomplete docs

Browse source 
Original commit message from CVS:
install style.css along with docs
fixing incomplete docs
This commit is contained in:
Stefan Kost 2005-01-24 17:04:08 +00:00
parent 6c51a29b9a
commit c44852739c
10 changed files with 105 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
ChangeLog
View file

@ -1,3 +1,17 @@
2005-01-24 Stefan Kost <ensonic@users.sf.net>
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
install style.css along with docs
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstdata.sgml:
* docs/gst/tmpl/gstelement.sgml:
* gst/gstbin.h:
* gst/gstelement.c: (gst_element_class_init):
* gst/gstelement.h:
fixing incomplete docs
2005-01-24 Tim-Philipp Müller <tim at centricular dot net>
* gst/elements/gstfilesink.c: (gst_filesink_handle_event):

4
docs/gst/Makefile.am
View file

@ -309,6 +309,8 @@ install-data-local:
$(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Installing $(srcdir)/html/style.css' ; \
$(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
fi)
uninstall-local:
(installfiles=`echo ./html/*.html`; \
@ -332,6 +334,8 @@ uninstall-local:
rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
fi)
if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi

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

@ -91,13 +91,13 @@ FALSE.
<!-- ##### ENUM GstBinFlags ##### -->
<para>
Flags for a bin.
</para>
@GST_BIN_FLAG_MANAGER: This bin has a scheduler and can be used as a toplevel bin.
@GST_BIN_SELF_SCHEDULABLE: This bin iterates itself, so no calls to gst_bin_iterate() should be made.
@GST_BIN_FLAG_PREFER_COTHREADS: This bin preferes to have its elements scheduled with cothreads
@GST_BIN_FLAG_FIXED_CLOCK: This bin uses a fixed clock, possibly the one set with gst_bin_use_clock().
@GST_BIN_FLAG_MANAGER:
@GST_BIN_SELF_SCHEDULABLE:
@GST_BIN_FLAG_PREFER_COTHREADS:
@GST_BIN_FLAG_FIXED_CLOCK:
@GST_BIN_FLAG_LAST:
<!-- ##### FUNCTION gst_bin_new ##### -->

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

@ -159,7 +159,7 @@ The function prototype of the callback.
@time: The time it was triggered
@id: The id that expired
@user_data: user data passed in the async_wait call
@Returns:
@Returns: %TRUE or %FALSE (currently unused)
<!-- ##### ENUM GstClockEntryStatus ##### -->

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

@ -67,7 +67,7 @@ The base structure
@flags: The flags of this GstData
@free: A pointer to a custom free function
@copy: A pointer to a custom copy function
@_gst_reserved:
@_gst_reserved: for future extensions
<!-- ##### USER_FUNCTION GstDataFreeFunction ##### -->
<para>

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

@ -76,8 +76,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::error ##### -->
@ -85,11 +83,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
@ -100,10 +93,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
@ -113,9 +102,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@gstelement: the object which received the signal.
@arg1:
@ -124,8 +110,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
@ -133,9 +117,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@gstelement: the object which received the signal.
@arg1:
@ -144,10 +125,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
</para>
@:
@:
@:
@gstelement: the object which received the signal.
@arg1:
@arg2:
@ -336,15 +313,13 @@ Get the pads of this elements.
<!-- ##### MACRO GST_ELEMENT_ERROR ##### -->
<para>
Utility function that elements can use in case they encountered a fatal
data processing error. The pipeline will throw an error signal and the
application will be requested to stop further media processing.
</para>
@el: the element that throws the error
@el:
@domain:
@code:
@message: the message to display
@message:
@debug:

4
docs/libs/Makefile.am
View file

@ -275,6 +275,8 @@ install-data-local:
$(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Installing $(srcdir)/html/style.css' ; \
$(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
fi)
uninstall-local:
(installfiles=`echo ./html/*.html`; \
@ -298,6 +300,8 @@ uninstall-local:
rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
fi)
if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi

17
gst/gstbin.h
View file

@ -37,18 +37,21 @@ GST_EXPORT GType _gst_bin_type;
#define GST_BIN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
#define GST_BIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
/**
* GstBinFlags:
* @GST_BIN_FLAG_MANAGER: This bin has a scheduler and can be used as a toplevel bin.
* @GST_BIN_SELF_SCHEDULABLE: This bin iterates itself, so no calls to gst_bin_iterate() should be made.
* @GST_BIN_FLAG_PREFER_COTHREADS: This bin preferes to have its elements scheduled with cothreads
* @GST_BIN_FLAG_FIXED_CLOCK: This bin uses a fixed clock, possibly the one set with gst_bin_use_clock().
* @GST_BIN_FLAG_LAST: id of last for chaining flsg definitions
*
* Flags for a #GstBin .
*/
typedef enum {
/* this bin is a manager of child elements, i.e. a pipeline or thread */
GST_BIN_FLAG_MANAGER = GST_ELEMENT_FLAG_LAST,
/* this bin iterates itself */
GST_BIN_SELF_SCHEDULABLE,
/* we prefer to have cothreads when its an option, over chain-based */
GST_BIN_FLAG_PREFER_COTHREADS,
GST_BIN_FLAG_FIXED_CLOCK,
/* padding */
GST_BIN_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 5
} GstBinFlags;

51
gst/gstelement.c
View file

@ -124,32 +124,83 @@ gst_element_class_init (GstElementClass * klass)
parent_class = g_type_class_ref (GST_TYPE_OBJECT);
/**
* GstElement::state-change:
* @gstelement: the object which received the signal
* @int:
* @int:
*
* the #GstElementState of the element has been changed
*/
gst_element_signals[STATE_CHANGE] =
g_signal_new ("state-change", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstElementClass, state_change), NULL,
NULL, gst_marshal_VOID__INT_INT, G_TYPE_NONE, 2, G_TYPE_INT, G_TYPE_INT);
/**
* GstElement::new-pad:
* @gstelement: the object which received the signal
* @object:
*
* a new #GstPad has been added to the element
*/
gst_element_signals[NEW_PAD] =
g_signal_new ("new-pad", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GstElementClass, new_pad), NULL, NULL,
gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, G_TYPE_OBJECT);
/**
* GstElement::pad-removed:
* @gstelement: the object which received the signal
* @object:
*
* a #GstPad has been removed from the element
*/
gst_element_signals[PAD_REMOVED] =
g_signal_new ("pad-removed", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GstElementClass, pad_removed), NULL, NULL,
gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, G_TYPE_OBJECT);
/**
* GstElement::error:
* @gstelement: the object which received the signal
* @element:
* @error:
* @message:
*
* a #GstError has occured during data processing
*/
gst_element_signals[ERROR] =
g_signal_new ("error", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GstElementClass, error), NULL, NULL,
gst_marshal_VOID__OBJECT_BOXED_STRING, G_TYPE_NONE, 3, GST_TYPE_ELEMENT,
GST_TYPE_G_ERROR, G_TYPE_STRING);
/**
* GstElement::eos:
* @gstelement: the object which received the signal
*
* the end of the stream has been reached
*/
gst_element_signals[EOS] =
g_signal_new ("eos", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GstElementClass, eos), NULL, NULL,
gst_marshal_VOID__VOID, G_TYPE_NONE, 0);
/**
* GstElement::found-tag:
* @gstelement: the object which received the signal
* @element:
* @tags:
*
* tags for the incomming stream have been received
*/
gst_element_signals[FOUND_TAG] =
g_signal_new ("found-tag", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GstElementClass, found_tag), NULL, NULL,
gst_marshal_VOID__OBJECT_BOXED, G_TYPE_NONE, 2, GST_TYPE_ELEMENT,
GST_TYPE_TAG_LIST);
/**
* GstElement::no-more-pads:
* @gstelement: the object which received the signal
*
* ?
*/
gst_element_signals[NO_MORE_PADS] =
g_signal_new ("no-more-pads", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstElementClass, no_more_pads), NULL,

12
gst/gstelement.h
View file

@ -140,6 +140,18 @@ typedef enum {
#define GST_ELEMENT_CLOCK(obj) (((GstElement*)(obj))->clock)
#define GST_ELEMENT_PADS(obj) ((obj)->pads)
/**
* GST_ELEMENT_ERROR:
* @el: the element that throws the error
* @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstError)
* @code: error code defined for that domain (see #GstError)
* @message: the message to display (format string and args enclosed in round brackets)
* @debug: debugging information for the message (format string and args enclosed in round brackets)
*
* Utility function that elements can use in case they encountered a fatal
* data processing error. The pipeline will throw an error signal and the
* application will be requested to stop further media processing.
*/
#define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
gchar *__msg = _gst_element_error_printf message; \
gchar *__dbg = _gst_element_error_printf debug; \