wearable/gst-libs/gst/audio/gstaudiofilter.h

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20
  21 #ifndef __GST_AUDIO_FILTER_H__
  22 #define __GST_AUDIO_FILTER_H__
  23
  24 #include <gst/gst.h>
  25 #include <gst/base/gstbasetransform.h>
  26 #include <gst/audio/gstringbuffer.h>
  27
  28 G_BEGIN_DECLS
  29
  30 typedef struct _GstAudioFilter GstAudioFilter;
  31 typedef struct _GstAudioFilterClass GstAudioFilterClass;
  32
  33 #define GST_TYPE_AUDIO_FILTER \
  34   (gst_audio_filter_get_type())
  35 #define GST_AUDIO_FILTER(obj) \
  36   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AUDIO_FILTER,GstAudioFilter))
  37 #define GST_AUDIO_FILTER_CAST(obj) \
  38   ((GstAudioFilter *) (obj))
  39 #define GST_AUDIO_FILTER_CLASS(klass) \
  40   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AUDIO_FILTER,GstAudioFilterClass))
  41 #define GST_AUDIO_FILTER_CLASS_CAST(klass) \
  42   ((GstAudioFilterClass *) (klass))
  43 #define GST_IS_AUDIO_FILTER(obj) \
  44   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AUDIO_FILTER))
  45 #define GST_IS_AUDIO_FILTER_CLASS(klass) \
  46   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AUDIO_FILTER))
  47
  48 /**
  49  * GstAudioFilter:
  50  *
  51  * Base class for audio filters with the same format for input and output.
  52  *
  53  * Since: 0.10.12
  54  */
  55 struct _GstAudioFilter {
  56   GstBaseTransform basetransform;
  57
  58   /*< protected >*/
  59   GstRingBufferSpec format;   /* currently configured format */
  60
  61   /*< private >*/
  62   gpointer _gst_reserved[GST_PADDING];
  63 };
  64
  65 /**
  66  * GstAudioFilterClass:
  67  * @basetransformclass: parent class
  68  * @setup: virtual function called whenever the format changes
  69  *
  70  * In addition to the @setup virtual function, you should also override the
  71  * GstBaseTransform::transform and/or GstBaseTransform::transform_ip virtual
  72  * function.
  73  *
  74  * Since: 0.10.12
  75  */
  76
  77 struct _GstAudioFilterClass {
  78   GstBaseTransformClass basetransformclass;
  79
  80   /* virtual function, called whenever the format changes */
  81   gboolean  (*setup) (GstAudioFilter * filter, GstRingBufferSpec * format);
  82
  83   /*< private >*/
  84   gpointer _gst_reserved[GST_PADDING];
  85 };
  86
  87 GType   gst_audio_filter_get_type (void);
  88
  89 void    gst_audio_filter_class_add_pad_templates (GstAudioFilterClass * klass,
  90                                                   const GstCaps       * allowed_caps);
  91
  92 G_END_DECLS
  93
  94 #endif /* __GST_AUDIO_FILTER_H__ */
  95