git.maemo.org Git - mafwsubrenderer/blob - gst-plugins-base-subtitles0.10/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(klass)      (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_AUDIO_SRC))
  42
  43 /**
  44  * GST_BASE_AUDIO_SRC_CLOCK:
  45  * @obj: a #GstBaseAudioSrc
  46  *
  47  * Get the #GstClock of @obj.
  48  */
  49 #define GST_BASE_AUDIO_SRC_CLOCK(obj)    (GST_BASE_AUDIO_SRC (obj)->clock)
  50 /**
  51  * GST_BASE_AUDIO_SRC_PAD:
  52  * @obj: a #GstBaseAudioSrc
  53  *
  54  * Get the source #GstPad of @obj.
  55  */
  56 #define GST_BASE_AUDIO_SRC_PAD(obj)      (GST_BASE_SRC (obj)->srcpad)
  57
  58 typedef struct _GstBaseAudioSrc GstBaseAudioSrc;
  59 typedef struct _GstBaseAudioSrcClass GstBaseAudioSrcClass;
  60 typedef struct _GstBaseAudioSrcPrivate GstBaseAudioSrcPrivate;
  61
  62 /**
  63  * GstBaseAudioSrcSlaveMethod:
  64  * @GST_BASE_AUDIO_SRC_SLAVE_RESAMPLE: Resample to match the master clock.
  65  * @GST_BASE_AUDIO_SRC_SLAVE_RETIMESTAMP: Retimestamp output buffers with master
  66  * clock time.
  67  * @GST_BASE_AUDIO_SRC_SLAVE_SKEW: Adjust capture pointer when master clock
  68  * drifts too much.
  69  * @GST_BASE_AUDIO_SRC_SLAVE_NONE: No adjustment is done.
  70  *
  71  * Different possible clock slaving algorithms when the internal audio clock was
  72  * not selected as the pipeline clock.
  73  */
  74 typedef enum
  75 {
  76   GST_BASE_AUDIO_SRC_SLAVE_RESAMPLE,
  77   GST_BASE_AUDIO_SRC_SLAVE_RETIMESTAMP,
  78   GST_BASE_AUDIO_SRC_SLAVE_SKEW,
  79   GST_BASE_AUDIO_SRC_SLAVE_NONE
  80 } GstBaseAudioSrcSlaveMethod;
  81
  82 #define GST_TYPE_BASE_AUDIO_SRC_SLAVE_METHOD (gst_base_audio_src_slave_method_get_type ())
  83
  84 /**
  85  * GstBaseAudioSrc:
  86  *
  87  * Opaque #GstBaseAudioSrc.
  88  */
  89 struct _GstBaseAudioSrc {
  90   GstPushSrc     element;
  91
  92   /*< protected >*/ /* with LOCK */
  93   /* our ringbuffer */
  94   GstRingBuffer *ringbuffer;
  95
  96   /* required buffer and latency */
  97   GstClockTime   buffer_time;
  98   GstClockTime   latency_time;
  99
 100   /* the next sample to write */
 101   guint64        next_sample;
 102
 103   /* clock */
 104   GstClock      *clock;
 105
 106   /*< private >*/
 107   GstBaseAudioSrcPrivate *priv;
 108
 109   gpointer _gst_reserved[GST_PADDING - 1];
 110 };
 111
 112 /**
 113  * GstBaseAudioSrcClass:
 114  * @parent_class: the parent class.
 115  * @create_ringbuffer: create and return a #GstRingBuffer to read from.
 116  *
 117  * #GstBaseAudioSrc class. Override the vmethod to implement
 118  * functionality.
 119  */
 120 struct _GstBaseAudioSrcClass {
 121   GstPushSrcClass parent_class;
 122
 123   /* subclass ringbuffer allocation */
 124   GstRingBuffer* (*create_ringbuffer)  (GstBaseAudioSrc *src);
 125
 126   /*< private >*/
 127   gpointer _gst_reserved[GST_PADDING];
 128 };
 129
 130 GType gst_base_audio_src_get_type(void);
 131 GType gst_base_audio_src_slave_method_get_type (void);
 132
 133 GstRingBuffer *gst_base_audio_src_create_ringbuffer (GstBaseAudioSrc *src);
 134
 135 void       gst_base_audio_src_set_provide_clock        (GstBaseAudioSrc *src, gboolean provide);
 136 gboolean   gst_base_audio_src_get_provide_clock        (GstBaseAudioSrc *src);
 137
 138 void       gst_base_audio_src_set_slave_method         (GstBaseAudioSrc *src,
 139                                                         GstBaseAudioSrcSlaveMethod method);
 140 GstBaseAudioSrcSlaveMethod
 141            gst_base_audio_src_get_slave_method         (GstBaseAudioSrc *src);
 142
 143
 144 G_END_DECLS
 145
 146 #endif /* __GST_BASE_AUDIO_SRC_H__ */