summaryrefslogtreecommitdiffstats
path: root/gst
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@circular-chaos.org>2008-12-16 08:35:05 +0000
committerSebastian Dröge <slomo@circular-chaos.org>2008-12-16 08:35:05 +0000
commit1eeb0a3a10343222242a1e904a39f1450584e869 (patch)
treea4ae79de007023e2486a6bcc5cf551cbfaa0e1ff /gst
parent10b91ac09814a0352427e2b1fa341325d23cca10 (diff)
downloadgst-plugins-bad-1eeb0a3a10343222242a1e904a39f1450584e869.tar.gz
gst-plugins-bad-1eeb0a3a10343222242a1e904a39f1450584e869.tar.bz2
gst-plugins-bad-1eeb0a3a10343222242a1e904a39f1450584e869.zip
Add initial documentation for the MXF plugin and mxfdemux.
Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-bad-plugins-docs.sgml: * docs/plugins/gst-plugins-bad-plugins-sections.txt: * docs/plugins/gst-plugins-bad-plugins.args: * docs/plugins/gst-plugins-bad-plugins.hierarchy: * docs/plugins/gst-plugins-bad-plugins.interfaces: * docs/plugins/gst-plugins-bad-plugins.prerequisites: * docs/plugins/inspect/plugin-ladspa.xml: * docs/plugins/inspect/plugin-musepack.xml: * docs/plugins/inspect/plugin-mxf.xml: * gst/mxf/mxfdemux.c: * gst/mxf/mxfdemux.h: Add initial documentation for the MXF plugin and mxfdemux.
Diffstat (limited to 'gst')
-rw-r--r--gst/mxf/mxfdemux.c21
-rw-r--r--gst/mxf/mxfdemux.h2
2 files changed, 19 insertions, 4 deletions
diff --git a/gst/mxf/mxfdemux.c b/gst/mxf/mxfdemux.c
index 42338ca7..b2f43ed8 100644
--- a/gst/mxf/mxfdemux.c
+++ b/gst/mxf/mxfdemux.c
@@ -17,6 +17,19 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-mxfdemux
+ *
+ * mxfdemux demuxes an MXF file into the different contained streams.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/mxf ! mxfdemux ! audioconvert ! autoaudiosink
+ * ]| This pipeline demuxes an MXF file and outputs one of the contained raw audio streams.
+ * </refsect2>
+ */
+
/* TODO:
* - Implement support for DMS-1 and descriptive metadata tracks
* - Differentiate UL and UUIDs, the former can define an object system
@@ -546,11 +559,11 @@ gst_mxf_demux_choose_package (GstMXFDemux * demux)
for (i = 0; i < demux->preface->content_storage->n_packages; i++) {
if (demux->preface->content_storage->packages[i] &&
- MXF_IS_METADATA_MATERIAL_PACKAGE (demux->preface->
- content_storage->packages[i])) {
+ MXF_IS_METADATA_MATERIAL_PACKAGE (demux->preface->content_storage->
+ packages[i])) {
ret =
- MXF_METADATA_GENERIC_PACKAGE (demux->preface->
- content_storage->packages[i]);
+ MXF_METADATA_GENERIC_PACKAGE (demux->preface->content_storage->
+ packages[i]);
break;
}
}
diff --git a/gst/mxf/mxfdemux.h b/gst/mxf/mxfdemux.h
index bb9d5933..1e5bef4d 100644
--- a/gst/mxf/mxfdemux.h
+++ b/gst/mxf/mxfdemux.h
@@ -48,6 +48,8 @@ struct _GstMXFDemux
GstPad *sinkpad;
GPtrArray *src;
+ /* < private > */
+
GstAdapter *adapter;
GstSegment segment;