diff options
author | Julien Moutte <julien@moutte.net> | 2005-12-08 16:27:12 +0000 |
---|---|---|
committer | Julien Moutte <julien@moutte.net> | 2005-12-08 16:27:12 +0000 |
commit | 207aced76da0526d2bd60e874896623cf8714423 (patch) | |
tree | 2abfaa52946e25603351177aa783bd46fcba230a /gst | |
parent | 82d3a26a560081a4b23afa7db1cccb1249293835 (diff) |
docs/plugins/Makefile.am: Add multipart elements.
Original commit message from CVS:
2005-12-08 Julien MOUTTE <julien@moutte.net>
* docs/plugins/Makefile.am: Add multipart elements.
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
* docs/plugins/gst-plugins-good-plugins-sections.txt: Fix flac.
* docs/plugins/gst-plugins-good-plugins.hierarchy:
* gst/multipart/multipartdemux.c:
* gst/multipart/multipartmux.c: Add docs.
Diffstat (limited to 'gst')
-rw-r--r-- | gst/multipart/multipartdemux.c | 42 | ||||
-rw-r--r-- | gst/multipart/multipartmux.c | 27 |
2 files changed, 62 insertions, 7 deletions
diff --git a/gst/multipart/multipartdemux.c b/gst/multipart/multipartdemux.c index 89e7954f..389f2393 100644 --- a/gst/multipart/multipartdemux.c +++ b/gst/multipart/multipartdemux.c @@ -19,6 +19,29 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-multipartdemux + * @short_description: Demuxer that takes a multipart digital stream as input + * and demuxes one or many digital streams from it. + * @see_also: #GstMultipartMux + * + * <refsect2> + * <para> + * MultipartDemux uses the Content-type field of incoming buffers to demux and + * push data to dynamic source pads. Most of the time multipart streams are + * sequential JPEG frames. + * </para> + * <title>Sample pipelines</title> + * <para> + * Here is a simple pipeline to demux a multipart file muxed with + * #GstMultipartMux containing JPEG frames at a rate of 5 frames per second : + * <programlisting> + * gst-launch filesrc location=/tmp/test.multipart ! multipartdemux ! jpegdec ! video/x-raw-yuv, framerate=(fraction)5/1 ! ffmpegcolorspace ! ximagesink + * </programlisting> + * </para> + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -27,22 +50,16 @@ #include <string.h> -GST_DEBUG_CATEGORY_STATIC (gst_multipart_demux_debug); -#define GST_CAT_DEFAULT gst_multipart_demux_debug - #define GST_TYPE_MULTIPART_DEMUX (gst_multipart_demux_get_type()) #define GST_MULTIPART_DEMUX(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_MULTIPART_DEMUX, GstMultipartDemux)) #define GST_MULTIPART_DEMUX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_MULTIPART_DEMUX, GstMultipartDemux)) #define GST_IS_MULTIPART_DEMUX(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_MULTIPART_DEMUX)) #define GST_IS_MULTIPART_DEMUX_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_MULTIPART_DEMUX)) -#define MAX_LINE_LEN 500 - typedef struct _GstMultipartDemux GstMultipartDemux; typedef struct _GstMultipartDemuxClass GstMultipartDemuxClass; -static gchar *toFind = "--ThisRandomString\nContent-type: "; -static gint toFindLen; +#define MAX_LINE_LEN 500 /* all information needed for one multipart stream */ typedef struct @@ -58,6 +75,11 @@ typedef struct } GstMultipartPad; +/** + * GstMultipartDemux: + * + * The opaque #GstMultipartDemux structure. + */ struct _GstMultipartDemux { GstElement element; @@ -81,6 +103,12 @@ struct _GstMultipartDemuxClass GstElementClass parent_class; }; +GST_DEBUG_CATEGORY_STATIC (gst_multipart_demux_debug); +#define GST_CAT_DEFAULT gst_multipart_demux_debug + +static gchar *toFind = "--ThisRandomString\nContent-type: "; +static gint toFindLen; + /* elementfactory information */ static GstElementDetails gst_multipart_demux_details = GST_ELEMENT_DETAILS ("multipart demuxer", diff --git a/gst/multipart/multipartmux.c b/gst/multipart/multipartmux.c index 74ee8688..8bcad113 100644 --- a/gst/multipart/multipartmux.c +++ b/gst/multipart/multipartmux.c @@ -17,6 +17,28 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-multipartmux + * @short_description: Muxer that takes one or several digital streams + * and muxes them to a single multipart stream. + * + * <refsect2> + * <para> + * MultipartMux uses the #GstCaps of the sink pad as the Content-type field for + * incoming buffers when muxing them to a multipart stream. Most of the time + * multipart streams are sequential JPEG frames. + * </para> + * <title>Sample pipelines</title> + * <para> + * Here is a simple pipeline to mux 5 JPEG frames per second into a multipart + * stream stored to a file : + * <programlisting> + * gst-launch videotestsrc ! video/x-raw-yuv, framerate=(fraction)5/1 ! jpegenc ! multipartmux ! filesink location=/tmp/test.multipart + * </programlisting> + * </para> + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -47,6 +69,11 @@ typedef struct } GstMultipartPad; +/** + * GstMultipartMux: + * + * The opaque #GstMultipartMux structure. + */ struct _GstMultipartMux { GstElement element; |