From 6f89a64207958e8c2f90dd0065f7e5655b5e59b8 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Tue, 6 Sep 2005 22:03:01 +0000 Subject: [PATCH] check/pipelines/simple_launch_lines.c: test for pipe!=NULL Original commit message from CVS: * check/pipelines/simple_launch_lines.c: (run_pipeline): test for pipe!=NULL * docs/gst/tmpl/.cvsignore: * docs/gst/tmpl/gstmemchunk.sgml: * docs/gst/tmpl/gstparse.sgml: * docs/gst/tmpl/gsttaglist.sgml: * docs/gst/tmpl/gsttagsetter.sgml: * docs/gst/tmpl/gsttypefind.sgml: * docs/gst/tmpl/gsttypefindfactory.sgml: * gst/gstmemchunk.c: * gst/gstparse.c: * gst/gsttag.c: * gst/gsttaginterface.c: * gst/gsttypefind.c: * gst/gsttypefind.h: inlined more docs --- ChangeLog | 67 +- check/pipelines/simple_launch_lines.c | 14 +- docs/gst/tmpl/.gitignore | 7 +- docs/gst/tmpl/gstmemchunk.sgml | 79 -- docs/gst/tmpl/gstparse.sgml | 67 -- docs/gst/tmpl/gsttaglist.sgml | 848 -------------------- docs/gst/tmpl/gsttagsetter.sgml | 113 --- docs/gst/tmpl/gsttypefind.sgml | 94 --- docs/gst/tmpl/gsttypefindfactory.sgml | 113 --- gst/gstmemchunk.c | 2 +- gst/gstparse.c | 21 +- gst/gsttag.c | 5 + gst/gsttaginterface.c | 5 + gst/gsttaglist.c | 5 + gst/gsttagsetter.c | 5 + gst/gsttypefind.c | 63 ++ gst/gsttypefind.h | 5 + tests/check/pipelines/simple-launch-lines.c | 14 +- 18 files changed, 172 insertions(+), 1355 deletions(-) delete mode 100644 docs/gst/tmpl/gstmemchunk.sgml delete mode 100644 docs/gst/tmpl/gstparse.sgml delete mode 100644 docs/gst/tmpl/gsttaglist.sgml delete mode 100644 docs/gst/tmpl/gsttagsetter.sgml delete mode 100644 docs/gst/tmpl/gsttypefind.sgml delete mode 100644 docs/gst/tmpl/gsttypefindfactory.sgml diff --git a/ChangeLog b/ChangeLog index af05e9b7fa..bbfc7206c1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,22 @@ +2005-09-07 Stefan Kost + + * check/pipelines/simple_launch_lines.c: (run_pipeline): + test for pipe!=NULL + * docs/gst/tmpl/.cvsignore: + * docs/gst/tmpl/gstmemchunk.sgml: + * docs/gst/tmpl/gstparse.sgml: + * docs/gst/tmpl/gsttaglist.sgml: + * docs/gst/tmpl/gsttagsetter.sgml: + * docs/gst/tmpl/gsttypefind.sgml: + * docs/gst/tmpl/gsttypefindfactory.sgml: + * gst/gstmemchunk.c: + * gst/gstparse.c: + * gst/gsttag.c: + * gst/gsttaginterface.c: + * gst/gsttypefind.c: + * gst/gsttypefind.h: + inlined more docs + === release 0.9.2 === 2005-09-06 Thomas Vander Stichele @@ -80,7 +99,7 @@ * po/vi.po: translation updates -2005-09-03 Tim-Philipp Müller +2005-09-03 Tim-Philipp M??ller * gst/base/gstbasesink.c: (gst_base_sink_pad_buffer_alloc): Add comment. @@ -190,7 +209,7 @@ * gst/gstevent.c: (gst_event_new_newsegment): A newsegment cannot have a start_time of -1 -2005-09-01 Tim-Philipp Müller +2005-09-01 Tim-Philipp M??ller * win32/gstenumtypes.c: * win32/gstenumtypes.h: @@ -254,7 +273,7 @@ * gst/base/gstbasetransform.h: Handle the case where we are not negotiated more gracefully. -2005-08-31 Tim-Philipp Müller +2005-08-31 Tim-Philipp M??ller * gst/elements/gstfilesrc.c: (gst_mmap_buffer_init), (gst_file_src_map_region): @@ -1261,7 +1280,7 @@ * check/gstcheck.h: add ASSERT_BUFFER_REFCOUNT -2005-08-13 Tim-Philipp Müller +2005-08-13 Tim-Philipp M??ller * docs/gst/gstreamer-sections.txt: * gst/gsttag.c: (_gst_tag_initialize), (gst_tag_register): @@ -1271,7 +1290,7 @@ is re-registered, unless it is re-registered with a different type (#308438). -2005-08-12 Tim-Philipp Müller +2005-08-12 Tim-Philipp M??ller * docs/pwg/appendix-porting.xml: * docs/pwg/building-state.xml: @@ -1301,13 +1320,13 @@ Actually implement (re)setting the target on a ghostpad as described in the docs. -2005-08-10 Tim-Philipp Müller +2005-08-10 Tim-Philipp M??ller * gst/gst.c: (gst_init_check_with_popt_table), (init_pre): Check whether GST_DEBUG_NO_COLOR environment variable is set and disable coloured debug output if that is the case. -2005-08-10 Tim-Philipp Müller +2005-08-10 Tim-Philipp M??ller * gst/base/gsttypefindhelper.c: (helper_find_peek), (gst_type_find_helper): @@ -1319,7 +1338,7 @@ returned by _peek() until typefinding is done and only free them then. -2005-08-09 Tim-Philipp Müller +2005-08-09 Tim-Philipp M??ller * docs/gst/gstreamer-sections.txt: * gst/gstutils.h: @@ -1330,7 +1349,7 @@ * gst/base/gstbasetransform.c: (gst_base_transform_buffer_alloc): Fix a pretty good memleak. -2005-08-08 Tim-Philipp Müller +2005-08-08 Tim-Philipp M??ller * gst/gstiterator.h: Fix wrong include and 'make distcheck'. @@ -1340,7 +1359,7 @@ * gst/gstbin.c: (bin_bus_handler): Use gst_element_post_message() instead. -2005-08-08 Tim-Philipp Müller +2005-08-08 Tim-Philipp M??ller * gst/base/gstadapter.h: * gst/base/gstbasesink.h: @@ -1601,7 +1620,7 @@ * tools/gst-xmlinspect.c: (print_element_info), (main): deactivate and remove dparams (libgstcontrol) -2005-08-01 Tim-Philipp Müller +2005-08-01 Tim-Philipp M??ller * gst/elements/gsttypefindelement.c: (gst_type_find_element_have_type), (gst_type_find_element_init), @@ -1610,7 +1629,7 @@ * gst/elements/gsttypefindelement.h: Set caps on all outgoing buffers, not just the first one. -2005-08-01 Tim-Philipp Müller +2005-08-01 Tim-Philipp M??ller * gst/elements/gsttypefindelement.c: (gst_type_find_element_have_type), @@ -1621,7 +1640,7 @@ * gst/elements/gsttypefindelement.h: Set caps on first outgoing buffer when we've found the type. -2005-08-01 Tim-Philipp Müller +2005-08-01 Tim-Philipp M??ller * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: @@ -1629,7 +1648,7 @@ * docs/gst/tmpl/gstschedulerfactory.sgml: Remove some old cruft from docs. -2005-07-31 Tim-Philipp Müller +2005-07-31 Tim-Philipp M??ller * gst/gstpad.h: Fix inline docs for GstPadLinkReturn. @@ -1639,7 +1658,7 @@ * docs/gst/gstreamer-sections.txt: New API: gst_structure_has_name(). -2005-07-30 Tim-Philipp Müller +2005-07-30 Tim-Philipp M??ller * configure.ac: Use AC_SYS_LARGEFILE, which will set _FILE_OFFSET_BITS=64 @@ -2304,7 +2323,7 @@ * gst/gstghostpad.c: (gst_ghost_pad_do_activate_push): Don't hold the lock for too long. -2005-07-16 Tim-Philipp Müller +2005-07-16 Tim-Philipp M??ller * gst/base/gstbasesrc.c: (gst_base_src_default_negotiate): Don't unref the caps we passed to gst_caps_make_writable() after @@ -2330,7 +2349,7 @@ * docs/design/part-gstpipeline.txt: Updated docs, mostly DISCONT related. -2005-07-15 Tim-Philipp Müller +2005-07-15 Tim-Philipp M??ller * docs/pwg/building-pads.xml: s/GST_PAD_LINK_REFUSED/FALSE/ in gst_my_filter_setcaps() @@ -3197,7 +3216,7 @@ * gst/gstpad.c: (_gst_do_pass_data_accumulator): Make work (??). -2005-06-29 Tim-Philipp Müller +2005-06-29 Tim-Philipp M??ller * gst/elements/gstfilesink.c: (gst_filesink_render): Simplify code so that we don't have to handle short @@ -3855,7 +3874,7 @@ (gst_system_clock_obtain): Set the name on object construction. Avoid double-checked locking. -2005-06-20 Tim-Philipp Müller +2005-06-20 Tim-Philipp M??ller * gst/gsturi.c: (gst_element_make_from_uri): Fix potential endless loop. @@ -4465,7 +4484,7 @@ Clear queue when going to READY. Remove IN_SETCAPS flag too. -2005-05-17 Tim-Philipp Müller +2005-05-17 Tim-Philipp M??ller * gst/base/gstbasesrc.c: (gst_basesrc_change_state): Remove implicit cast from gboolean to GstElementStateReturn; @@ -4606,12 +4625,12 @@ (find_common_root, object_has_ancestor, ghost_up, remove_pad): Helpers for pad_link_maybe_ghosting. -2005-05-13 Tim-Philipp Müller +2005-05-13 Tim-Philipp M??ller * configure.ac: Require GLib >= 2.4.0 (for the g_atomic_* funcs) -2005-05-13 Tim-Philipp Müller +2005-05-13 Tim-Philipp M??ller * docs/design/part-element-source.txt: Mention GstPushSrc @@ -4639,7 +4658,7 @@ * gst/gstbin.c: (gst_bin_class_init), (gst_bin_query): Implement _query on a bin, similar to _send_event. -2005-05-12 Tim-Philipp Müller +2005-05-12 Tim-Philipp M??ller * gst/base/gstbasesrc.c: (gst_basesrc_do_seek): Discont event offset format should be GST_FORMAT_BYTES, @@ -4874,7 +4893,7 @@ * gst/gstpad.c: (gst_pad_alloc_buffer), (gst_pad_push): Also set caps if we use the fallback buffer alloc. -2005-05-06 Tim-Philipp Müller +2005-05-06 Tim-Philipp M??ller * docs/gst/Makefile.am: * docs/gst/gstreamer-docs.sgml: diff --git a/check/pipelines/simple_launch_lines.c b/check/pipelines/simple_launch_lines.c index 11c6ed8148..293e887a4c 100644 --- a/check/pipelines/simple_launch_lines.c +++ b/check/pipelines/simple_launch_lines.c @@ -33,8 +33,14 @@ setup_pipeline (gchar * pipe_descr) return pipeline; } -/* events is a mask of expected events. tevent is the expected terminal event. - the poll call will time out after half a second. +/* + * run_pipeline: + * @pipe: the pipeline to run + * @desc: the description for use in messages + * @events: is a mask of expected events + * @tevent: is the expected terminal event. + * + * the poll call will time out after half a second. */ static void run_pipeline (GstElement * pipe, gchar * descr, @@ -43,6 +49,7 @@ run_pipeline (GstElement * pipe, gchar * descr, GstBus *bus; GstMessageType revent; + g_assert (pipe); bus = gst_element_get_bus (pipe); g_assert (bus); if (gst_element_set_state (pipe, @@ -162,8 +169,7 @@ GST_START_TEST (test_stop_from_app) assert_live_count (GST_TYPE_BUFFER, 0); } -GST_END_TEST Suite * -simple_launch_lines_suite (void) +GST_END_TEST Suite * simple_launch_lines_suite (void) { Suite *s = suite_create ("Pipelines"); TCase *tc_chain = tcase_create ("linear"); diff --git a/docs/gst/tmpl/.gitignore b/docs/gst/tmpl/.gitignore index d307f90b47..500d16bd4c 100644 --- a/docs/gst/tmpl/.gitignore +++ b/docs/gst/tmpl/.gitignore @@ -28,9 +28,10 @@ gstformat.sgml gstghostpad.sgml gstiterator.sgml gstmacros.sgml -gstmemchunck.sgml +gstmemchunk.sgml gstmessage.sgml gstminiobject.sgml +gstparse.sgml gstprobe.sgml gstpushsrc.sgml gstqueue.sgml @@ -40,7 +41,11 @@ gstregistry.sgml gstregistrypool.sgml gststructure.sgml gstsystemclock.sgml +gsttaglist.sgml +gsttagsetter.sgml gsttask.sgml +gsttypefind.sgml +gsttypefindfactory.sgml gsturihandler.sgml gsturitype.sgml gstutils.sgml diff --git a/docs/gst/tmpl/gstmemchunk.sgml b/docs/gst/tmpl/gstmemchunk.sgml deleted file mode 100644 index 8ce3af29e1..0000000000 --- a/docs/gst/tmpl/gstmemchunk.sgml +++ /dev/null @@ -1,79 +0,0 @@ - -GstMemChunk - - -Atomic chunk allocator - - - -GstMemChunk is an atomic chunk allocator. It uses atomic operations -to allocate fixed size memory regions and is therefore thread safe -without the overhead of mutexes or other heavyweight locking mechanisms. - - - -The GstMemChunk is used to allocate critical resources for #GstBuffer and -#GstEvent. - - - - -#GstBuffer, #GstEvent, #GstData - - - - - - - -The memchunk structure - - - - - - - - -@name: -@atom_size: -@area_size: -@type: -@Returns: - - - - - - - -@mem_chunk: - - - - - - - -@mem_chunk: -@Returns: - - - - - - - -@mem_chunk: -@Returns: - - - - - - - -@mem_chunk: -@mem: - - diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml deleted file mode 100644 index e43a2dac2c..0000000000 --- a/docs/gst/tmpl/gstparse.sgml +++ /dev/null @@ -1,67 +0,0 @@ - -GstParse - - -get a pipeline from a text pipeline description - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@GST_PARSE_ERROR_SYNTAX: -@GST_PARSE_ERROR_NO_SUCH_ELEMENT: -@GST_PARSE_ERROR_NO_SUCH_PROPERTY: -@GST_PARSE_ERROR_LINK: -@GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY: -@GST_PARSE_ERROR_EMPTY_BIN: -@GST_PARSE_ERROR_EMPTY: - - - - - - -@pipeline_description: -@error: -@Returns: - - - - - - - -@argv: -@error: -@Returns: - - diff --git a/docs/gst/tmpl/gsttaglist.sgml b/docs/gst/tmpl/gsttaglist.sgml deleted file mode 100644 index 50c6f9a937..0000000000 --- a/docs/gst/tmpl/gsttaglist.sgml +++ /dev/null @@ -1,848 +0,0 @@ - -GstTagList - - -List of tags and values used to describe media metadata - - - - - - - - - - - - - - - - - - - - - - - - - -@GST_TAG_MERGE_UNDEFINED: -@GST_TAG_MERGE_REPLACE_ALL: -@GST_TAG_MERGE_REPLACE: -@GST_TAG_MERGE_APPEND: -@GST_TAG_MERGE_PREPEND: -@GST_TAG_MERGE_KEEP: -@GST_TAG_MERGE_KEEP_ALL: -@GST_TAG_MERGE_COUNT: - - - - - - -@GST_TAG_FLAG_UNDEFINED: -@GST_TAG_FLAG_META: -@GST_TAG_FLAG_ENCODED: -@GST_TAG_FLAG_DECODED: -@GST_TAG_FLAG_COUNT: - - - - - - -@list: -@tag: -@user_data: - - - - - - - -@dest: -@src: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@name: -@flag: -@type: -@nick: -@blurb: -@func: - - - - - - - -@dest: -@src: - - - - - - - -@dest: -@src: - - - - - - - -@tag: -@Returns: - - - - - - - -@tag: -@Returns: - - - - - - - -@tag: -@Returns: - - - - - - - -@tag: -@Returns: - - - - - - - -@tag: -@Returns: - - - - - - - -@tag: -@Returns: - - - - - - - -@Returns: - - - - - - - -@p: -@Returns: - - - - - - - -@list: -@Returns: - - - - - - - -@into: -@from: -@mode: - - - - - - - -@list1: -@list2: -@mode: -@Returns: - - - - - - - -@list: - - - - - - - -@list: -@tag: -@Returns: - - - - - - - -@list: -@mode: -@tag: -@Varargs: - - - - - - - -@list: -@mode: -@tag: -@Varargs: - - - - - - - -@list: -@mode: -@tag: -@var_args: - - - - - - - -@list: -@mode: -@tag: -@var_args: - - - - - - - -@list: -@tag: - - - - - - - -@list: -@func: -@user_data: - - - - - - - -@list: -@tag: -@index: -@Returns: - - - - - - - -@dest: -@list: -@tag: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - - - - - - -@list: -@tag: -@value: -@Returns: - - - - - - - -@list: -@tag: -@index: -@value: -@Returns: - - diff --git a/docs/gst/tmpl/gsttagsetter.sgml b/docs/gst/tmpl/gsttagsetter.sgml deleted file mode 100644 index d80b667cf6..0000000000 --- a/docs/gst/tmpl/gsttagsetter.sgml +++ /dev/null @@ -1,113 +0,0 @@ - -GstTagSetter - - -Element interface that allows setting and retrieval of media metadata - - - - - - - - - - - - - - - - - - - - - - - - - -@g_iface: - - - - - - -@setter: -@list: -@mode: - - - - - - - -@setter: -@mode: -@tag: -@Varargs: - - - - - - - -@setter: -@mode: -@tag: -@Varargs: - - - - - - - -@setter: -@mode: -@tag: -@var_args: - - - - - - - -@setter: -@mode: -@tag: -@var_args: - - - - - - - -@setter: -@Returns: - - - - - - - -@setter: -@mode: - - - - - - - -@setter: -@Returns: - - diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml deleted file mode 100644 index eb4ab7eb09..0000000000 --- a/docs/gst/tmpl/gsttypefind.sgml +++ /dev/null @@ -1,94 +0,0 @@ - -GstTypeFindElement - - -typefinding subsystem - - - - - - - - - - - - - - - - - - - -@peek: -@suggest: -@data: -@get_length: - - - - - - -@find: -@data: - - - - - - - -@GST_TYPE_FIND_MINIMUM: -@GST_TYPE_FIND_POSSIBLE: -@GST_TYPE_FIND_LIKELY: -@GST_TYPE_FIND_NEARLY_CERTAIN: -@GST_TYPE_FIND_MAXIMUM: - - - - - - -@find: -@offset: -@size: -@Returns: - - - - - - - -@find: -@probability: -@caps: - - - - - - - -@find: -@Returns: - - - - - - - -@plugin: -@name: -@rank: -@func: -@extensions: -@possible_caps: -@data: -@Returns: - - diff --git a/docs/gst/tmpl/gsttypefindfactory.sgml b/docs/gst/tmpl/gsttypefindfactory.sgml deleted file mode 100644 index 0ec2797535..0000000000 --- a/docs/gst/tmpl/gsttypefindfactory.sgml +++ /dev/null @@ -1,113 +0,0 @@ - -GstTypeFindFactory - - -information about registered typefind functions - - - -These functions allow querying informations about registered typefind -functions. How to create and register these functions is described in -the section -"Writing typefind functions". - - - how to write a simple typefinder - - /* FIXME: compile this? ;) */ - typedef struct { - guint8 *data; - guint size; - guint probability; - GstCaps *data; - } MyTypeFind; - static void - my_peek (gpointer data, gint64 offset, guint size) - { - MyTypeFind *find = (MyTypeFind *) data; - if (offset >= 0 && offset + size <= find->size) { - return find->data + offset; - } - return NULL; - } - static void - my_suggest (gpointer data, guint probability, GstCaps *caps) - { - MyTypeFind *find = (MyTypeFind *) data; - if (probability > find->probability) { - find->probability = probability; - gst_caps_replace (&find->caps, caps); - } - } - static GstCaps * - find_type (guint8 *data, guint size) - { - GList *walk, *type_list; - MyTypeFind find = {data, size, 0, NULL}; - GstTypeFind gst_find = {my_peek, my_suggest, &find, }; - - walk = type_list = gst_type_find_factory_get_list (); - while (walk) { - GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data); - walk = g_list_next (walk) - gst_type_find_factory_call_function (factory, &gst_find); - } - g_list_free (type_list); - return find.caps; - }; - - - -The above example shows how to write a very simple typefinder that identifies -the given data. You can get quite a bit more complicated than that though. - - - - -Writing typefind functions - - - - - - - -Object that stores information about a typefind function - - - - - - - - -@Returns: - - - - - - - -@factory: -@Returns: - - - - - - - -@factory: -@Returns: - - - - - - - -@factory: -@find: - - diff --git a/gst/gstmemchunk.c b/gst/gstmemchunk.c index 7754c2d413..cbe470bb09 100644 --- a/gst/gstmemchunk.c +++ b/gst/gstmemchunk.c @@ -21,7 +21,7 @@ * Boston, MA 02111-1307, USA. */ /** - * SECTION:gstmacros + * SECTION:gstmemchunk * @short_description: Atomic chunk allocator * @see_also: #GstBuffer, #GstEvent, #GstData * diff --git a/gst/gstparse.c b/gst/gstparse.c index 43b35340bd..24ed0caa21 100644 --- a/gst/gstparse.c +++ b/gst/gstparse.c @@ -20,6 +20,13 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstparse + * @short_description: Get a pipeline from a text pipeline description + * + * These function allow to create a pipeline based on the syntax used in the + * gst-launch utillity. + */ #include @@ -69,10 +76,10 @@ _gst_parse_escape (const gchar * str) * @error: pointer to a #GError * * Create a new element based on command line syntax. - * #error will contain an error message if an erroneuos pipeline is specified. + * @error will contain an error message if an erroneuos pipeline is specified. * An error does not mean that the pipeline could not be constructed. * - * Returns: a new element on success and NULL on failure. + * Returns: a new element on success and %NULL on failure. */ GstElement * gst_parse_launchv (const gchar ** argv, GError ** error) @@ -110,13 +117,13 @@ gst_parse_launchv (const gchar ** argv, GError ** error) * @error: the error message in case of an erroneous pipeline. * * Create a new pipeline based on command line syntax. - * Please note that you might get a return value that is not NULL even though - * the error is set. In this case there was a recoverable parsing error and you + * Please note that you might get a return value that is not %NULL even though + * the @error is set. In this case there was a recoverable parsing error and you * can try to play the pipeline. * - * Returns: a new element on success, NULL on failure. If more than one toplevel - * element is specified by the pipeline_description, all elements are put into - * a #GstPipeline ant that is returned. + * Returns: a new element on success, %NULL on failure. If more than one toplevel + * element is specified by the @pipeline_description, all elements are put into + * a #GstPipeline, which than is returned. */ GstElement * gst_parse_launch (const gchar * pipeline_description, GError ** error) diff --git a/gst/gsttag.c b/gst/gsttag.c index b0400980d3..3e541765fd 100644 --- a/gst/gsttag.c +++ b/gst/gsttag.c @@ -18,6 +18,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsttaglist + * @short_description: List of tags and values used to describe media metadata + * + */ #ifdef HAVE_CONFIG_H # include "config.h" diff --git a/gst/gsttaginterface.c b/gst/gsttaginterface.c index b73108f917..2fae2b8ba0 100644 --- a/gst/gsttaginterface.c +++ b/gst/gsttaginterface.c @@ -18,6 +18,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsttagsetter + * @short_description: Element interface that allows setting and retrieval of media metadata + * + */ #ifdef HAVE_CONFIG_H diff --git a/gst/gsttaglist.c b/gst/gsttaglist.c index b0400980d3..3e541765fd 100644 --- a/gst/gsttaglist.c +++ b/gst/gsttaglist.c @@ -18,6 +18,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsttaglist + * @short_description: List of tags and values used to describe media metadata + * + */ #ifdef HAVE_CONFIG_H # include "config.h" diff --git a/gst/gsttagsetter.c b/gst/gsttagsetter.c index b73108f917..2fae2b8ba0 100644 --- a/gst/gsttagsetter.c +++ b/gst/gsttagsetter.c @@ -18,6 +18,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsttagsetter + * @short_description: Element interface that allows setting and retrieval of media metadata + * + */ #ifdef HAVE_CONFIG_H diff --git a/gst/gsttypefind.c b/gst/gsttypefind.c index 1ba77e8ac6..d579e706c6 100644 --- a/gst/gsttypefind.c +++ b/gst/gsttypefind.c @@ -18,6 +18,69 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsttypefind + * @short_description: Stream type detection + * + */ + /** + * SECTION:gsttypefindfactory + * @short_description: Information about registered typefind functions + * + * These functions allow querying informations about registered typefind + * functions. How to create and register these functions is described in + * the section + * "Writing typefind functions". + * + * + * how to write a simple typefinder + * + * typedef struct { + * guint8 *data; + * guint size; + * guint probability; + * GstCaps *data; + * } MyTypeFind; + * static void + * my_peek (gpointer data, gint64 offset, guint size) + * { + * MyTypeFind *find = (MyTypeFind *) data; + * if (offset >= 0 && offset + size <= find->size) { + * return find->data + offset; + * } + * return NULL; + * } + * static void + * my_suggest (gpointer data, guint probability, GstCaps *caps) + * { + * MyTypeFind *find = (MyTypeFind *) data; + * if (probability > find->probability) { + * find->probability = probability; + * gst_caps_replace (&find->caps, caps); + * } + * } + * static GstCaps * + * find_type (guint8 *data, guint size) + * { + * GList *walk, *type_list; + * MyTypeFind find = {data, size, 0, NULL}; + * GstTypeFind gst_find = {my_peek, my_suggest, &find, }; + * + * walk = type_list = gst_type_find_factory_get_list (); + * while (walk) { + * GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data); + * walk = g_list_next (walk) + * gst_type_find_factory_call_function (factory, &gst_find); + * } + * g_list_free (type_list); + * return find.caps; + * }; + * + * + * + * The above example shows how to write a very simple typefinder that identifies + * the given data. You can get quite a bit more complicated than that though. + */ #include "gst_private.h" #include "gstinfo.h" diff --git a/gst/gsttypefind.h b/gst/gsttypefind.h index 7f3471703e..8e321890d4 100644 --- a/gst/gsttypefind.h +++ b/gst/gsttypefind.h @@ -68,6 +68,11 @@ struct _GstTypeFind { gpointer _gst_reserved[GST_PADDING]; }; +/** + * GstTypeFindFactory: + * + * Object that stores information about a typefind function. + */ struct _GstTypeFindFactory { GstPluginFeature feature; /* */ diff --git a/tests/check/pipelines/simple-launch-lines.c b/tests/check/pipelines/simple-launch-lines.c index 11c6ed8148..293e887a4c 100644 --- a/tests/check/pipelines/simple-launch-lines.c +++ b/tests/check/pipelines/simple-launch-lines.c @@ -33,8 +33,14 @@ setup_pipeline (gchar * pipe_descr) return pipeline; } -/* events is a mask of expected events. tevent is the expected terminal event. - the poll call will time out after half a second. +/* + * run_pipeline: + * @pipe: the pipeline to run + * @desc: the description for use in messages + * @events: is a mask of expected events + * @tevent: is the expected terminal event. + * + * the poll call will time out after half a second. */ static void run_pipeline (GstElement * pipe, gchar * descr, @@ -43,6 +49,7 @@ run_pipeline (GstElement * pipe, gchar * descr, GstBus *bus; GstMessageType revent; + g_assert (pipe); bus = gst_element_get_bus (pipe); g_assert (bus); if (gst_element_set_state (pipe, @@ -162,8 +169,7 @@ GST_START_TEST (test_stop_from_app) assert_live_count (GST_TYPE_BUFFER, 0); } -GST_END_TEST Suite * -simple_launch_lines_suite (void) +GST_END_TEST Suite * simple_launch_lines_suite (void) { Suite *s = suite_create ("Pipelines"); TCase *tc_chain = tcase_create ("linear");