aiff: add aiff elements to docs
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Sat, 31 Oct 2009 19:42:50 +0000 (19:42 +0000)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Sat, 31 Oct 2009 19:55:26 +0000 (19:55 +0000)
docs/plugins/Makefile.am
docs/plugins/gst-plugins-bad-plugins-docs.sgml
docs/plugins/gst-plugins-bad-plugins-sections.txt
docs/plugins/inspect/plugin-aiff.xml
gst/aiff/aiffmux.h
gst/aiff/aiffparse.h

index a5b2985..61a2ba1 100644 (file)
@@ -122,6 +122,8 @@ EXTRA_HFILES = \
        $(top_srcdir)/ext/timidity/gstwildmidi.h \
        $(top_srcdir)/ext/zbar/gstzbar.h \
        $(top_srcdir)/gst/aacparse/gstaacparse.h \
+       $(top_srcdir)/gst/aiff/aiffparse.h \
+       $(top_srcdir)/gst/aiff/aiffmux.h \
        $(top_srcdir)/gst/amrparse/gstamrparse.h \
        $(top_srcdir)/gst/autoconvert/gstautoconvert.h \
        $(top_srcdir)/gst/camerabin/gstcamerabin.h \
index 0dc6500..47bb3c8 100644 (file)
@@ -18,6 +18,8 @@
   <chapter>
     <title>gst-plugins-bad Elements</title>
     <xi:include href="xml/element-aacparse.xml" />
+    <xi:include href="xml/element-aiffparse.xml" />
+    <xi:include href="xml/element-aiffmux.xml" />
     <xi:include href="xml/element-amrparse.xml" />
     <xi:include href="xml/element-amrwbenc.xml" />
     <xi:include href="xml/element-autoconvert.xml" />
@@ -90,6 +92,7 @@
   <chapter>
     <title>gst-plugins-bad Plugins</title>
     <xi:include href="xml/plugin-aacparse.xml" />
+    <xi:include href="xml/plugin-aiff.xml" />
     <xi:include href="xml/plugin-amrparse.xml" />
     <xi:include href="xml/plugin-autoconvert.xml" />
     <xi:include href="xml/plugin-legacyresample.xml" />
index 6b77f15..c695f94 100644 (file)
@@ -13,6 +13,35 @@ gst_aacparse_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-aiffmux</FILE>
+<TITLE>aiffmux</TITLE>
+GstAiffMux
+<SUBSECTION Standard>
+GST_AIFF_MUX
+GST_AIFF_MUX_CLASS
+GST_IS_AIFF_MUX
+GST_IS_AIFF_MUX_CLASS
+GST_TYPE_AIFF_MUX
+GstAiffMuxClass
+gst_aiff_mux_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-aiffparse</FILE>
+<TITLE>aiffparse</TITLE>
+GstAiffParse
+<SUBSECTION Standard>
+GST_AIFF_PARSE
+GST_AIFF_PARSE_CLASS
+GST_IS_AIFF_PARSE
+GST_IS_AIFF_PARSE_CLASS
+GST_TYPE_AIFF_PARSE
+GstAiffParseClass
+GstAiffParseState
+gst_aiff_parse_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-amrparse</FILE>
 <TITLE>amrparse</TITLE>
 GstAmrParse
index 45c7fa5..b83f90d 100644 (file)
@@ -1,15 +1,36 @@
 <plugin>
   <name>aiff</name>
-  <description>Parse an .aiff file into raw audio</description>
-  <filename>../../gst/aiffparse/.libs/libgstaiff.so</filename>
+  <description>Create and parse Audio Interchange File Format (AIFF) files</description>
+  <filename>../../gst/aiff/.libs/libgstaiff.so</filename>
   <basename>libgstaiff.so</basename>
-  <version>0.10.16</version>
+  <version>0.10.16.1</version>
   <license>LGPL</license>
   <source>gst-plugins-bad</source>
   <package>GStreamer Bad Plug-ins prerelease</package>
   <origin>Unknown package origin</origin>
   <elements>
     <element>
+      <name>aiffmux</name>
+      <longname>AIFF audio muxer</longname>
+      <class>Muxer/Audio</class>
+      <description>Multiplex raw audio into AIFF</description>
+      <author>Robert Swain &lt;robert.swain@gmail.com&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>audio/x-raw-int, width=(int)8, depth=(int)[ 1, 8 ], signed=(boolean)true, endianness=(int)4321, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]; audio/x-raw-int, width=(int)16, depth=(int)[ 9, 16 ], signed=(boolean)true, endianness=(int)4321, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]; audio/x-raw-int, width=(int)24, depth=(int)[ 17, 24 ], signed=(boolean)true, endianness=(int)4321, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]; audio/x-raw-int, width=(int)32, depth=(int)[ 25, 32 ], signed=(boolean)true, endianness=(int)4321, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>audio/x-aiff</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
       <name>aiffparse</name>
       <longname>AIFF audio demuxer</longname>
       <class>Codec/Demuxer/Audio</class>
@@ -31,4 +52,4 @@
       </pads>
     </element>
   </elements>
-</plugin>
+</plugin>
\ No newline at end of file
index cc64586..73c1d89 100644 (file)
@@ -1,5 +1,4 @@
-/*
- * GStreamer
+/* GStreamer AIFF muxer
  * Copyright (C) 2009 Robert Swain <robert.swain@gmail.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
@@ -47,7 +46,7 @@
 #include <gst/gst.h>
 
 G_BEGIN_DECLS
-/* #defines don't like whitespacey bits */
+
 #define GST_TYPE_AIFF_MUX \
   (gst_aiff_mux_get_type())
 #define GST_AIFF_MUX(obj) \
@@ -58,13 +57,20 @@ G_BEGIN_DECLS
   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AIFF_MUX))
 #define GST_IS_AIFF_MUX_CLASS(klass) \
   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AIFF_MUX))
+
 typedef struct _GstAiffMux GstAiffMux;
 typedef struct _GstAiffMuxClass GstAiffMuxClass;
 
+/**
+ * GstAiffMux:
+ *
+ * Opaque data structure.
+ */
 struct _GstAiffMux
 {
   GstElement element;
 
+  /*< private >*/
   GstPad *sinkpad;
   GstPad *srcpad;
 
index 6a391bb..1ffe212 100644 (file)
@@ -55,8 +55,9 @@ typedef struct _GstAiffParseClass GstAiffParseClass;
 struct _GstAiffParse {
   GstElement parent;
 
-  /* pads */
-  GstPad *sinkpad,*srcpad;
+  /*< private >*/
+  GstPad      *sinkpad;
+  GstPad      *srcpad;
 
   GstCaps     *caps;
   GstEvent    *close_segment;