gstbaseaudiosrc.h 3.37 KB
Newer Older
Wim Taymans's avatar
Wim Taymans committed
1
2
3
4
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2005 Wim Taymans <wim@fluendo.com>
 *
5
 * gstbaseaudiosrc.h:
Wim Taymans's avatar
Wim Taymans committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 *
 * 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.
 */

/* a base class for audio sources.
 */

26
27
#ifndef __GST_BASE_AUDIO_SRC_H__
#define __GST_BASE_AUDIO_SRC_H__
Wim Taymans's avatar
Wim Taymans committed
28
29
30
31
32
33
34
35

#include <gst/gst.h>
#include <gst/base/gstpushsrc.h>
#include "gstringbuffer.h"
#include "gstaudioclock.h"

G_BEGIN_DECLS

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
36
37
38
39
40
#define GST_TYPE_BASE_AUDIO_SRC                 (gst_base_audio_src_get_type())
#define GST_BASE_AUDIO_SRC(obj)                 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_AUDIO_SRC,GstBaseAudioSrc))
#define GST_BASE_AUDIO_SRC_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_AUDIO_SRC,GstBaseAudioSrcClass))
#define GST_BASE_AUDIO_SRC_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASE_AUDIO_SRC, GstBaseAudioSrcClass))
#define GST_IS_BASE_AUDIO_SRC(obj)              (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_AUDIO_SRC))
Stefan Kost's avatar
Stefan Kost committed
41
#define GST_IS_BASE_AUDIO_SRC_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_AUDIO_SRC))
Wim Taymans's avatar
Wim Taymans committed
42

Wim Taymans's avatar
Wim Taymans committed
43
44
45
46
47
48
/**
 * GST_BASE_AUDIO_SRC_CLOCK:
 * @obj: a #GstBaseAudioSrc
 *
 * Get the #GstClock of @obj.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
49
#define GST_BASE_AUDIO_SRC_CLOCK(obj)    (GST_BASE_AUDIO_SRC (obj)->clock)
Wim Taymans's avatar
Wim Taymans committed
50
51
52
53
54
55
/**
 * GST_BASE_AUDIO_SRC_PAD:
 * @obj: a #GstBaseAudioSrc
 *
 * Get the source #GstPad of @obj.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
56
#define GST_BASE_AUDIO_SRC_PAD(obj)      (GST_BASE_SRC (obj)->srcpad)
Wim Taymans's avatar
Wim Taymans committed
57
58
59

typedef struct _GstBaseAudioSrc GstBaseAudioSrc;
typedef struct _GstBaseAudioSrcClass GstBaseAudioSrcClass;
60
typedef struct _GstBaseAudioSrcPrivate GstBaseAudioSrcPrivate;
Wim Taymans's avatar
Wim Taymans committed
61

Wim Taymans's avatar
Wim Taymans committed
62
63
64
65
66
/**
 * GstBaseAudioSrc:
 *
 * Opaque #GstBaseAudioSrc.
 */
Wim Taymans's avatar
Wim Taymans committed
67
struct _GstBaseAudioSrc {
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
68
  GstPushSrc     element;
Wim Taymans's avatar
Wim Taymans committed
69
70
71
72
73
74
75
76
77

  /*< protected >*/ /* with LOCK */
  /* our ringbuffer */
  GstRingBuffer *ringbuffer;

  /* required buffer and latency */
  GstClockTime   buffer_time;
  GstClockTime   latency_time;

78
  /* the next sample to write */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
79
  guint64        next_sample;
80

Wim Taymans's avatar
Wim Taymans committed
81
  /* clock */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
82
  GstClock      *clock;
83
84

  /*< private >*/
85
86
87
  GstBaseAudioSrcPrivate *priv;

  gpointer _gst_reserved[GST_PADDING - 1];
Wim Taymans's avatar
Wim Taymans committed
88
89
};

Wim Taymans's avatar
Wim Taymans committed
90
91
92
93
94
95
96
97
/**
 * GstBaseAudioSrcClass:
 * @parent_class: the parent class.
 * @create_ringbuffer: create and return a #GstRingBuffer to read from.
 *
 * #GstBaseAudioSrc class. Override the vmethod to implement
 * functionality.
 */
Wim Taymans's avatar
Wim Taymans committed
98
99
100
101
102
struct _GstBaseAudioSrcClass {
  GstPushSrcClass parent_class;

  /* subclass ringbuffer allocation */
  GstRingBuffer* (*create_ringbuffer)  (GstBaseAudioSrc *src);
103
104
105

  /*< private >*/
  gpointer _gst_reserved[GST_PADDING];
Wim Taymans's avatar
Wim Taymans committed
106
107
};

108
GType gst_base_audio_src_get_type(void);
Wim Taymans's avatar
Wim Taymans committed
109

110
GstRingBuffer *gst_base_audio_src_create_ringbuffer (GstBaseAudioSrc *src);
Wim Taymans's avatar
Wim Taymans committed
111
112
113

G_END_DECLS

114
#endif /* __GST_BASE_AUDIO_SRC_H__ */