gst-libs/gst/audio/gstbaseaudiosrc.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstbaseaudiosrc.h:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /* a base class for audio sources.
  24  */
  25
  26 #ifndef __GST_BASE_AUDIO_SRC_H__
  27 #define __GST_BASE_AUDIO_SRC_H__
  28
  29 #include <gst/gst.h>
  30 #include <gst/base/gstpushsrc.h>
  31 #include "gstringbuffer.h"
  32 #include "gstaudioclock.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define GST_TYPE_BASE_AUDIO_SRC                 (gst_base_audio_src_get_type())
  37 #define GST_BASE_AUDIO_SRC(obj)                 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_AUDIO_SRC,GstBaseAudioSrc))
  38 #define GST_BASE_AUDIO_SRC_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_AUDIO_SRC,GstBaseAudioSrcClass))
  39 #define GST_BASE_AUDIO_SRC_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASE_AUDIO_SRC, GstBaseAudioSrcClass))
  40 #define GST_IS_BASE_AUDIO_SRC(obj)              (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_AUDIO_SRC))
  41 #define GST_IS_BASE_AUDIO_SRC_CLASS(obj)        (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_AUDIO_SRC))
  42
  43 #define GST_BASE_AUDIO_SRC_CLOCK(obj)    (GST_BASE_AUDIO_SRC (obj)->clock)
  44 #define GST_BASE_AUDIO_SRC_PAD(obj)      (GST_BASE_SRC (obj)->srcpad)
  45
  46 typedef struct _GstBaseAudioSrc GstBaseAudioSrc;
  47 typedef struct _GstBaseAudioSrcClass GstBaseAudioSrcClass;
  48
  49 struct _GstBaseAudioSrc {
  50   GstPushSrc     element;
  51
  52   /*< protected >*/ /* with LOCK */
  53   /* our ringbuffer */
  54   GstRingBuffer *ringbuffer;
  55
  56   /* required buffer and latency */
  57   GstClockTime   buffer_time;
  58   GstClockTime   latency_time;
  59
  60   /* the next sample to write */
  61   guint64        next_sample;
  62
  63   /* clock */
  64   GstClock      *clock;
  65
  66   /*< private >*/
  67   gpointer _gst_reserved[GST_PADDING];
  68 };
  69
  70 struct _GstBaseAudioSrcClass {
  71   GstPushSrcClass parent_class;
  72
  73   /* subclass ringbuffer allocation */
  74   GstRingBuffer* (*create_ringbuffer)  (GstBaseAudioSrc *src);
  75
  76   /*< private >*/
  77   gpointer _gst_reserved[GST_PADDING];
  78 };
  79
  80 GType gst_base_audio_src_get_type(void);
  81
  82 GstRingBuffer *gst_base_audio_src_create_ringbuffer (GstBaseAudioSrc *src);
  83
  84 G_END_DECLS
  85
  86 #endif /* __GST_BASE_AUDIO_SRC_H__ */