2004-04-07 Thomas Vander Stichele <thomas at apestaart dot org>
+ * docs/gst/Makefile.am:
+ make docs exit on scanning problems
+ fix nonsrcdir build issues
+ * docs/gst/gstreamer-sections.txt:
+ adding stuff from -unused
+ * gst/gstqueue.h:
+ create GstQueueSize
+ * gst/schedulers/cothreads_compat.h:
+ fix cothread warnings
+
+2004-04-07 Thomas Vander Stichele <thomas at apestaart dot org>
+
* docs/gst/gstreamer-sections.txt:
remove defines deprecated by Benjamin
#### scan ####
-
-# wingo addition
+# in the case of non-srcdir builds, the built gst directory gets added
+# to gtk-doc scanning; but only then, to avoid duplicates
scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
@echo '*** Scanning header files ***'
if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
if test x"$(srcdir)" != x. ; then \
cp $(srcdir)/$(DOC_MODULE).types . ; \
+ chmod u+w $(DOC_MODULE).types ; \
fi ; \
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" --module=$(DOC_MODULE) ; \
else \
test -f $$i || touch $$i ; \
done \
fi
- gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
+ if test "x$(top_srcdir)" != "x$(top_builddir)"; \
+ then \
+ export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
+ fi; \
+ gtkdoc-scan \
+ --module=$(DOC_MODULE) \
+ --source-dir=$(DOC_SOURCE_DIR) \
+ $$BUILT_OPTIONS \
+ --ignore-headers="$(IGNORE_HFILES)" \
+ $(SCAN_OPTIONS) $(EXTRA_HFILES)
touch scan-build.stamp
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
@echo '*** Rebuilding template files ***'
if test x"$(srcdir)" != x. ; then \
- cp $(srcdir)/$(DOC_MODULE)-decl.txt . ; \
cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \
+ touch $(DOC_MODULE)-decl.txt ; \
fi
- gtkdoc-mktmpl --module=$(DOC_MODULE)
+ gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
+ @if grep "WARNING:" tmpl-build.log > /dev/null; then exit 1; fi
+ rm -f tmpl-build.log
touch tmpl-build.stamp
tmpl.stamp: tmpl-build.stamp
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
@echo '*** Building SGML ***'
- gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
+ gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) | tee sgml-build.log
+ @if grep "WARNING:" sgml-build.log > /dev/null; then exit 1; fi
+ rm sgml-build.log
touch sgml-build.stamp
sgml.stamp: sgml-build.stamp
gst_buffer_is_writable
gst_buffer_copy_on_write
gst_buffer_create_sub
+gst_buffer_join
gst_buffer_merge
gst_buffer_is_span_fast
gst_buffer_span
<SECTION>
<FILE>gstclock</FILE>
+GstClock
GstClockTime
GstClockTimeDiff
GstClockID
gst_clock_id_unlock
gst_clock_id_free
<SUBSECTION Standard>
+GstClockClass
GST_CLOCK
GST_IS_CLOCK
GST_TYPE_CLOCK
gst_element_state_get_name
gst_element_get_factory
gst_element_get_managing_bin
-GST_TYPE_ELEMENT_FACTORY
-GST_ELEMENT_FACTORY
-GST_ELEMENT_FACTORY_CLASS
-GST_IS_ELEMENT_FACTORY
-GST_IS_ELEMENT_FACTORY_CLASS
<TITLE>GstElementFactory</TITLE>
gst_element_factory_get_type
gst_element_register
gst_element_factory_make
gst_element_factory_can_src_caps
gst_element_factory_can_sink_caps
+GstElementFactory
+GstElementFactoryClass
+GST_TYPE_ELEMENT_FACTORY
+GST_ELEMENT_FACTORY
+GST_ELEMENT_FACTORY_CLASS
+GST_IS_ELEMENT_FACTORY
+GST_IS_ELEMENT_FACTORY_CLASS
<SUBSECTION Standard>
GST_ELEMENT
GST_IS_ELEMENT
<SECTION>
<FILE>gstindex</FILE>
+GstIndex
GST_TYPE_INDEX_ENTRY
GstIndexEntry
GstIndexGroup
GST_IS_INDEX_FACTORY_CLASS
GST_INDEX_FACTORY_GET_CLASS
<TITLE>GstIndexFactory</TITLE>
+GstIndexFactory
+GstIndexFactoryClass
gst_index_factory_get_type
gst_index_factory_new
gst_index_factory_destroy
gst_index_factory_create
gst_index_factory_make
<SUBSECTION Standard>
+GstIndexClass
GST_INDEX
GST_IS_INDEX
GST_TYPE_INDEX
<SECTION>
<FILE>gstpad</FILE>
+GstRealPad
+GstGhostPad
+GstRealPadClass
+GstGhostPadClass
GST_IS_PAD_FAST
GST_PAD_CLASS
GST_TYPE_REAL_PAD
gst_pad_pull
gst_pad_send_event
gst_pad_event_default
-gst_pad_selectv
gst_pad_select
+gst_pad_selectv
gst_pad_select_valist
+gst_pad_collect
+gst_pad_collectv
+gst_pad_collect_valist
gst_pad_set_formats_function
gst_pad_get_formats
gst_pad_get_formats_default
<SECTION>
<FILE>gstpipeline</FILE>
<TITLE>GstPipeline</TITLE>
+GstPipeline
gst_pipeline_new
<SUBSECTION Standard>
+GstPipelineClass
GST_PIPELINE
GST_IS_PIPELINE
GST_TYPE_PIPELINE
<SECTION>
<FILE>gstpluginfeature</FILE>
-GST_PLUGIN_FEATURE_NAME
<TITLE>GstPluginFeature</TITLE>
+GstPluginFeature
+GST_PLUGIN_FEATURE_NAME
GstTypeNameData
GstPluginFeatureFilter
gst_plugin_feature_ensure_loaded
gst_plugin_feature_get_rank
gst_plugin_feature_get_name
<SUBSECTION Standard>
+GstPluginFeatureClass
GST_PLUGIN_FEATURE
GST_IS_PLUGIN_FEATURE
GST_TYPE_PLUGIN_FEATURE
<SECTION>
<FILE>gstqueue</FILE>
<TITLE>GstQueue</TITLE>
+GstQueue
+GstQueueSize
<SUBSECTION Standard>
+GstQueueClass
GST_QUEUE
GST_IS_QUEUE
GST_TYPE_QUEUE
<SECTION>
<FILE>gstregistry</FILE>
+<TITLE>GstRegistry</TITLE>
+GstRegistry
GLOBAL_REGISTRY_DIR
GLOBAL_REGISTRY_FILE
GLOBAL_REGISTRY_FILE_TMP
REGISTRY_FILE_PERMS
GstRegistryReturn
GstRegistryFlags
-<TITLE>GstRegistry</TITLE>
gst_registry_load
gst_registry_is_loaded
gst_registry_save
gst_registry_unload_plugin
gst_registry_update_plugin
<SUBSECTION Standard>
+GstRegistryClass
GST_REGISTRY
GST_IS_REGISTRY
GST_TYPE_REGISTRY
GST_SCHEDULER_FACTORY_GET_CLASS
GST_SCHEDULER_DEFAULT_NAME
<TITLE>GstSchedulerFactory</TITLE>
+GstSchedulerFactory
+GstSchedulerFactoryClass
gst_scheduler_factory_get_type
gst_scheduler_factory_new
gst_scheduler_factory_destroy
<SECTION>
<FILE>gstsystemclock</FILE>
<TITLE>GstSystemClock</TITLE>
+GstSystemClock
gst_system_clock_obtain
<SUBSECTION Standard>
+GstSystemClockClass
GST_SYSTEM_CLOCK
GST_IS_SYSTEM_CLOCK
GST_TYPE_SYSTEM_CLOCK
<SECTION>
<FILE>gstthread</FILE>
+<TITLE>GstThread</TITLE>
+GstThread
gst_thread_current
GstThreadState
-<TITLE>GstThread</TITLE>
gst_thread_new
gst_thread_set_priority
gst_thread_get_current
<SUBSECTION Standard>
+GstThreadClass
GST_THREAD
GST_IS_THREAD
GST_TYPE_THREAD
GstTypeFindFunction
GstTypeFindProbability
<TITLE>GstTypeFindFactory</TITLE>
+GstTypeFindFactory
gst_type_find_peek
gst_type_find_suggest
gst_type_find_get_length
gst_type_find_factory_get_caps
gst_type_find_factory_call_function
<SUBSECTION Standard>
+GstTypeFindFactoryClass
GST_TYPE_FIND_FACTORY
GST_IS_TYPE_FIND_FACTORY
GST_TYPE_TYPE_FIND_FACTORY
<SECTION>
<FILE>gstxml</FILE>
-GstXMLNs
<TITLE>GstXML</TITLE>
+GstXML
+GstXMLNs
gst_xml_write
gst_xml_write_file
gst_xml_new
gst_xml_get_topelements
gst_xml_make_element
<SUBSECTION Standard>
+GstXMLClass
GST_XML
GST_IS_XML
GST_TYPE_XML
<SECTION>
<FILE>gstspider</FILE>
+GstSpider
GstSpiderConnection
<TITLE>GstSpider</TITLE>
gst_spider_identity_plug
gst_spider_identity_unplug
<SUBSECTION Standard>
+GstSpiderClass
GST_SPIDER
GST_IS_SPIDER
GST_TYPE_SPIDER
<SECTION>
<FILE>gstspideridentity</FILE>
<TITLE>GstSpiderIdentity</TITLE>
+GstSpiderIdentity
gst_spider_identity_new_sink
gst_spider_identity_new_src
gst_spider_identity_request_new_pad
<SUBSECTION Standard>
+GstSpiderIdentityClass
GST_SPIDER_IDENTITY
GST_IS_SPIDER_IDENTITY
GST_TYPE_SPIDER_IDENTITY
<SECTION>
<FILE>gstaggregator</FILE>
-GstAggregatorSchedType
<TITLE>GstAggregator</TITLE>
+GstAggregatorSchedType
+GstAggregator
<SUBSECTION Standard>
+GstAggregatorClass
GST_AGGREGATOR
GST_IS_AGGREGATOR
GST_TYPE_AGGREGATOR
<SECTION>
<FILE>gstbufferstore</FILE>
<TITLE>GstBufferStore</TITLE>
+GstBufferStore
gst_buffer_store_new
gst_buffer_store_clear
gst_buffer_store_add_buffer
gst_buffer_store_get_buffer
gst_buffer_store_get_size
<SUBSECTION Standard>
+GstBufferStoreClass
GST_BUFFER_STORE
GST_IS_BUFFER_STORE
GST_TYPE_BUFFER_STORE
<SECTION>
<FILE>gstfakesink</FILE>
+GstFakeSink
GstFakeSinkStateError
<TITLE>GstFakeSink</TITLE>
<SUBSECTION Standard>
+GstFakeSinkClass
GST_FAKESINK
GST_IS_FAKESINK
GST_TYPE_FAKESINK
<SECTION>
<FILE>gstfakesrc</FILE>
+GstFakeSrc
GstFakeSrcOutputType
GstFakeSrcDataType
GstFakeSrcSizeType
GstFakeSrcFillType
<TITLE>GstFakeSrc</TITLE>
<SUBSECTION Standard>
+GstFakeSrcClass
GST_FAKESRC
GST_IS_FAKESRC
GST_TYPE_FAKESRC
<SECTION>
<FILE>gstfdsink</FILE>
<TITLE>GstFdSink</TITLE>
+GstFdSink
<SUBSECTION Standard>
+GstFdSinkClass
GST_FDSINK
GST_IS_FDSINK
GST_TYPE_FDSINK
<SECTION>
<FILE>gstfdsrc</FILE>
<TITLE>GstFdSrc</TITLE>
+GstFdSrc
<SUBSECTION Standard>
+GstFdSrcClass
GST_FDSRC
GST_IS_FDSRC
GST_TYPE_FDSRC
<SECTION>
<FILE>gstfilesink</FILE>
+GstFileSink
GstFileSinkFlags
<TITLE>GstFileSink</TITLE>
<SUBSECTION Standard>
+GstFileSinkClass
GST_FILESINK
GST_IS_FILESINK
GST_TYPE_FILESINK
<SECTION>
<FILE>gstfilesrc</FILE>
+GstFileSrc
GstFileSrcFlags
<TITLE>GstFileSrc</TITLE>
<SUBSECTION Standard>
+GstFileSrcClass
GST_FILESRC
GST_IS_FILESRC
GST_TYPE_FILESRC
<SECTION>
<FILE>gstidentity</FILE>
<TITLE>GstIdentity</TITLE>
+GstIdentity
<SUBSECTION Standard>
+GstIdentityClass
GST_IDENTITY
GST_IS_IDENTITY
GST_TYPE_IDENTITY
<SECTION>
<FILE>gstmd5sink</FILE>
<TITLE>GstMD5Sink</TITLE>
+GstMD5Sink
<SUBSECTION Standard>
+GstMD5SinkClass
GST_MD5SINK
GST_IS_MD5SINK
GST_TYPE_MD5SINK
<SECTION>
<FILE>gstpipefilter</FILE>
+GstPipefilter
GstPipeFilterFlags
<TITLE>GstPipefilter</TITLE>
<SUBSECTION Standard>
+GstPipefilterClass
GST_PIPEFILTER
GST_IS_PIPEFILTER
GST_TYPE_PIPEFILTER
<SECTION>
<FILE>gstshaper</FILE>
+GstShaper
GstShaperPolicyType
<TITLE>GstShaper</TITLE>
<SUBSECTION Standard>
+GstShaperClass
GST_SHAPER
GST_IS_SHAPER
GST_TYPE_SHAPER
<SECTION>
<FILE>gststatistics</FILE>
+GstStatistics
stats
<TITLE>GstStatistics</TITLE>
<SUBSECTION Standard>
+GstStatisticsClass
GST_STATISTICS
GST_IS_STATISTICS
GST_TYPE_STATISTICS
<SECTION>
<FILE>gsttee</FILE>
<TITLE>GstTee</TITLE>
+GstTee
<SUBSECTION Standard>
+GstTeeClass
GST_TEE
GST_IS_TEE
GST_TYPE_TEE
<SECTION>
<FILE>gstmultifilesrc</FILE>
-GstMultiFileSrcFlags
<TITLE>GstMultiFileSrc</TITLE>
+GstMultiFileSrc
+GstMultiFileSrcFlags
<SUBSECTION Standard>
+GstMultiFileSrcClass
GST_MULTIFILESRC
GST_IS_MULTIFILESRC
GST_TYPE_MULTIFILESRC
<SECTION>
<FILE>gsttypefind</FILE>
<TITLE>GstTypeFindElement</TITLE>
+GstTypeFindElement
<SUBSECTION Standard>
+GstTypeFindElementClass
GST_TYPE_FIND_ELEMENT
GST_IS_TYPE_FIND_ELEMENT
GST_TYPE_TYPE_FIND_ELEMENT
<SECTION>
<FILE>gstxmlregistry</FILE>
+<TITLE>GstXMLRegistry</TITLE>
GstXMLRegistryState
GstXMLRegistryMode
GstXMLRegistryGetPerms
GstXMLRegistryLoad
GstXMLRegistrySave
GstXMLRegistryClose
-<TITLE>GstXMLRegistry</TITLE>
gst_xml_registry_new
<SUBSECTION Standard>
+GstXMLRegistry
+GstXMLRegistryClass
GST_XML_REGISTRY
GST_IS_XML_REGISTRY
GST_TYPE_XML_REGISTRY
gst_debug_category_set_threshold_for_name
gst_debug_category_unset_threshold_for_name
gst_debug_print_stack_trace
+GST_TIME_FORMAT
+GST_TIME_ARGS
</SECTION>
<SECTION>
};
typedef struct _GstQueue GstQueue;
+typedef struct _GstQueueSize GstQueueSize;
typedef struct _GstQueueClass GstQueueClass;
+struct _GstQueueSize {
+ guint buffers; /* no. of buffers */
+ guint bytes; /* no. of bytes */
+ guint64 time; /* amount of time */
+};
+
struct _GstQueue {
GstElement element;
/* the queue of data we're keeping our grubby hands on */
GQueue *queue;
- struct {
- guint buffers; /* no. of buffers */
- guint bytes; /* no. of bytes */
- guint64 time; /* amount of time */
- } cur_level, /* currently in the queue */
+ GstQueueSize
+ cur_level, /* currently in the queue */
max_size, /* max. amount of data allowed in the queue */
min_threshold; /* min. amount of data required to wake reader */
*
* "cothread" and "cothread_context" need to be defined
*/
-typedef cothread_state cothread;
+typedef struct _cothread_state cothread;
/* define functions
* the macros are prepended with "do_"
};
typedef struct _GstQueue GstQueue;
+typedef struct _GstQueueSize GstQueueSize;
typedef struct _GstQueueClass GstQueueClass;
+struct _GstQueueSize {
+ guint buffers; /* no. of buffers */
+ guint bytes; /* no. of bytes */
+ guint64 time; /* amount of time */
+};
+
struct _GstQueue {
GstElement element;
/* the queue of data we're keeping our grubby hands on */
GQueue *queue;
- struct {
- guint buffers; /* no. of buffers */
- guint bytes; /* no. of bytes */
- guint64 time; /* amount of time */
- } cur_level, /* currently in the queue */
+ GstQueueSize
+ cur_level, /* currently in the queue */
max_size, /* max. amount of data allowed in the queue */
min_threshold; /* min. amount of data required to wake reader */