summaryrefslogtreecommitdiffstats
path: root/gst-libs/gst/audio/multichannel.h
diff options
context:
space:
mode:
Diffstat (limited to 'gst-libs/gst/audio/multichannel.h')
-rw-r--r--gst-libs/gst/audio/multichannel.h86
1 files changed, 86 insertions, 0 deletions
diff --git a/gst-libs/gst/audio/multichannel.h b/gst-libs/gst/audio/multichannel.h
new file mode 100644
index 00000000..5194fffa
--- /dev/null
+++ b/gst-libs/gst/audio/multichannel.h
@@ -0,0 +1,86 @@
+/* GStreamer Multichannel-Audio helper functions
+ * (c) 2004 Ronald Bultje <rbultje@ronald.bitfreak.net>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#ifndef __GST_AUDIO_MULTICHANNEL_H__
+#define __GST_AUDIO_MULTICHANNEL_H__
+
+#include <gst/audio/audio.h>
+#include <gst/audio/multichannel-enumtypes.h>
+
+typedef enum {
+ GST_AUDIO_CHANNEL_POSITION_INVALID = -1,
+
+ /* Main front speakers. Mono and left/right are mututally exclusive! */
+ GST_AUDIO_CHANNEL_POSITION_FRONT_MONO,
+ GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT,
+ GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT,
+
+ /* rear. Left/right and center are mututally exclusive! */
+ GST_AUDIO_CHANNEL_POSITION_REAR_CENTER,
+ GST_AUDIO_CHANNEL_POSITION_REAR_LEFT,
+ GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT,
+
+ /* subwoofer/low-frequency */
+ GST_AUDIO_CHANNEL_POSITION_LFE,
+
+ /* Center front speakers. Center and left/right_of_center cannot be
+ * used together! */
+ GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER,
+ GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER,
+ GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER,
+
+ /* sides */
+ GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT,
+ GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT,
+
+ /* don't use - counter */
+ GST_AUDIO_CHANNEL_POSITION_NUM
+} GstAudioChannelPosition;
+
+/* Retrieves or sets the positions from/to a GstStructure. Only
+ * works with fixed caps, caller should check for that! Caller
+ * g_free()s result of the getter. */
+GstAudioChannelPosition *
+ gst_audio_get_channel_positions (GstStructure *str);
+void gst_audio_set_channel_positions (GstStructure *str,
+ const GstAudioChannelPosition *pos);
+
+/* Sets a (non-fixed) list of possible audio channel positions
+ * on a structure (this requires the "channels" property to
+ * be fixed!) or on a caps (here, the "channels" property may be
+ * unfixed and the caps may even contain multiple structures). */
+void gst_audio_set_structure_channel_positions_list
+ (GstStructure *str,
+ const GstAudioChannelPosition *pos,
+ gint num_positions);
+void gst_audio_set_caps_channel_positions_list
+ (GstCaps *caps,
+ const GstAudioChannelPosition *pos,
+ gint num_positions);
+
+/* Custom fixate function. Elements that implement some sort of
+ * channel conversion algorhithm should use this function for
+ * fixating on GstAudioChannelPosition properties. It will take
+ * care of equal channel positioning (left/right). Caller g_free()s
+ * the return value. The input properties may be (and are supposed
+ * to be) unfixed. */
+GstAudioChannelPosition *
+ gst_audio_fixate_channel_positions (GstStructure *str);
+
+#endif /* __GST_AUDIO_MULTICHANNEL_H__ */