audioparsers: Add bitrate calculation to baseparse
[gstreamer-omap:gstreamer.git] / gst / audioparsers / gstbaseparse.h
1 /* GStreamer
2  * Copyright (C) 2008 Nokia Corporation. All rights reserved.
3  *
4  * Contact: Stefan Kost <stefan.kost@nokia.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 #ifndef __GST_BASE_PARSE_H__
23 #define __GST_BASE_PARSE_H__
24
25 #include <gst/gst.h>
26 #include <gst/base/gstadapter.h>
27
28 G_BEGIN_DECLS
29
30 #define GST_TYPE_BASE_PARSE                (gst_base_parse_get_type())
31 #define GST_BASE_PARSE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_PARSE,GstBaseParse))
32 #define GST_BASE_PARSE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_PARSE,GstBaseParseClass))
33 #define GST_BASE_PARSE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_BASE_PARSE,GstBaseParseClass))
34 #define GST_IS_BASE_PARSE(obj)     (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_PARSE))
35 #define GST_IS_BASE_PARSE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_PARSE))
36 #define GST_BASE_PARSE_CAST(obj)        ((GstBaseParse *)(obj))
37
38 /**
39  * GST_BASE_PARSE_SINK_NAME:
40  *
41  * the name of the templates for the sink pad
42  */
43 #define GST_BASE_PARSE_SINK_NAME        "sink"
44 /**
45  * GST_BASE_PARSE_SRC_NAME:
46  *
47  * the name of the templates for the source pad
48  */
49 #define GST_BASE_PARSE_SRC_NAME "src"
50
51 /**
52  * GST_BASE_PARSE_SRC_PAD:
53  * @obj: base parse instance
54  *
55  * Gives the pointer to the source #GstPad object of the element.
56  *
57  * Since: 0.10.x
58  */
59 #define GST_BASE_PARSE_SRC_PAD(obj)             (GST_BASE_PARSE_CAST (obj)->srcpad)
60
61 /**
62  * GST_BASE_PARSE_SINK_PAD:
63  * @obj: base parse instance
64  *
65  * Gives the pointer to the sink #GstPad object of the element.
66  *
67  * Since: 0.10.x
68  */
69 #define GST_BASE_PARSE_SINK_PAD(obj)    (GST_BASE_PARSE_CAST (obj)->sinkpad)
70
71 /**
72  * GST_BASE_PARSE_FLOW_DROPPED:
73  *
74  * A #GstFlowReturn that can be returned from parse_frame to
75  * indicate that no output buffer was generated.
76  *
77  * Since: 0.10.x
78  */
79 #define GST_BASE_PARSE_FLOW_DROPPED   GST_FLOW_CUSTOM_SUCCESS
80
81 /**
82  * GST_BASE_PARSE_BUFFER_FLAG_NO_FRAME:
83  *
84  * A #GstBufferFlag that can be set to have this buffer not counted as frame,
85  * e.g. if this frame is dependent on a previous one.  As it is not counted as
86  * a frame, bitrate increases but frame to time conversions are maintained.
87  *
88  * Since: 0.10.x
89  */
90 #define GST_BASE_PARSE_BUFFER_FLAG_NO_FRAME     GST_BUFFER_FLAG_LAST
91
92 /**
93  * GST_BASE_PARSE_LOCK:
94  * @obj: base parse instance
95  *
96  * Obtain a lock to protect the parse function from concurrent access.
97  *
98  * Since: 0.10.x
99  */
100 #define GST_BASE_PARSE_LOCK(obj)   g_mutex_lock (GST_BASE_PARSE_CAST (obj)->parse_lock)
101
102 /**
103  * GST_BASE_PARSE_UNLOCK:
104  * @obj: base parse instance
105  *
106  * Release the lock that protects the parse function from concurrent access.
107  *
108  * Since: 0.10.x
109  */
110 #define GST_BASE_PARSE_UNLOCK(obj) g_mutex_unlock (GST_BASE_PARSE_CAST (obj)->parse_lock)
111
112 typedef struct _GstBaseParse GstBaseParse;
113 typedef struct _GstBaseParseClass GstBaseParseClass;
114 typedef struct _GstBaseParsePrivate GstBaseParsePrivate;
115 typedef struct _GstBaseParseClassPrivate GstBaseParseClassPrivate;
116
117 /**
118  * GstBaseParse:
119  * @element: the parent element.
120  *
121  * The opaque #GstBaseParse data structure.
122  */
123 struct _GstBaseParse {
124   GstElement     element;
125   GstAdapter   *adapter;
126
127   /*< protected >*/
128   /* source and sink pads */
129   GstPad        *sinkpad;
130   GstPad        *srcpad;
131
132   /* MT-protected (with STREAM_LOCK) */
133   GstSegment     segment;
134
135   /* Newsegment event to be sent after SEEK */
136   GstEvent       *pending_segment;
137
138   /* Segment event that closes the running segment prior to SEEK */
139   GstEvent       *close_segment;
140
141   /* Caps nego done already? */
142   gboolean   negotiated;
143
144   GMutex        *parse_lock;
145
146   /*< private >*/
147   gpointer       _gst_reserved[GST_PADDING_LARGE];
148   GstBaseParsePrivate *priv;
149 };
150
151 /**
152  * GstBaseParseClass:
153  * @start:          Optional.
154  *                  Called when the element starts processing.
155  *                  Allows opening external resources.
156  * @stop:           Optional.
157  *                  Called when the element stops processing.
158  *                  Allows closing external resources.
159  * @set_sink_caps:  allows the subclass to be notified of the actual caps set.
160  * @check_valid_frame:  Check if the given piece of data contains a valid
161  *                      frame.
162  * @parse_frame:    Parse the already checked frame. Subclass need to
163  *                  set the buffer timestamp, duration, caps and possibly
164  *                  other necessary metadata. This is called with srcpad's
165  *                  STREAM_LOCK held.
166  * @convert:        Optional.
167  *                  Convert between formats.
168  * @find_frame:     Optional.
169  *                  Finds a frame. Gets a position passed and should return
170  *                  TRUE and the offset in bytes where this position is.
171  *                  Will only be called in pull mode and the subclass can pull
172  *                  whatever it wants from upstream. If not implemented,
173  *                  the base class will implement it by calling
174  *                  @check_valid_frame and @parse_frame to find the wanted
175  *                  frame and build a seek table.
176  * @event:          Optional.
177  *                  Event handler on the sink pad. This function should return
178  *                  TRUE if the event was handled and can be dropped.
179  * @src_event:      Optional.
180  *                  Event handler on the source pad. Should return TRUE
181  *                  if the event was handled and can be dropped.
182  * @is_seekable:    Optional.
183  *                  Subclass can override this if it wants to control the
184  *                  seekability of the stream. Otherwise the element assumes
185  *                  that stream is always seekable.
186  *
187  * @get_frame_overhead: Finds the metadata overhead for the given frame. This
188  *                      is used to enable more accurate bitrate computations.
189  *                      If NULL, the per-frame overhead is assumed to be 0. If
190  *                      this returns -1, it is assumed that this frame should
191  *                      be skipped in bitrate calculation.
192  *
193  * Subclasses can override any of the available virtual methods or not, as
194  * needed. At minimum @check_valid_frame and @parse_frame needs to be
195  * overridden.
196  */
197 struct _GstBaseParseClass {
198   GstElementClass parent_class;
199
200   /*< public >*/
201   /* virtual methods for subclasses */
202
203   gboolean      (*start)              (GstBaseParse *parse);
204
205   gboolean      (*stop)               (GstBaseParse *parse);
206
207   gboolean      (*set_sink_caps)      (GstBaseParse *parse,
208                                        GstCaps *caps);
209
210   gboolean      (*check_valid_frame)  (GstBaseParse *parse,
211                                        GstBuffer *buffer,
212                                        guint *framesize,
213                                        gint *skipsize);
214
215   GstFlowReturn (*parse_frame)        (GstBaseParse *parse,
216                                        GstBuffer *buffer);
217
218   gboolean      (*convert)            (GstBaseParse * parse,
219                                        GstFormat src_format,
220                                        gint64 src_value,
221                                        GstFormat dest_format,
222                                        gint64 * dest_value);
223
224   gboolean      (*find_frame)         (GstBaseParse *parse,
225                                        GstFormat src_format,
226                                        gint64 src_value,
227                                        gint64 * dest_value);
228
229   gboolean      (*event)              (GstBaseParse *parse,
230                                        GstEvent *event);
231
232   gboolean      (*src_event)          (GstBaseParse *parse,
233                                        GstEvent *event);
234
235   gboolean      (*is_seekable)        (GstBaseParse *parse);
236
237   gint          (*get_frame_overhead) (GstBaseParse *parse,
238                                        GstBuffer *buf);
239
240   /*< private >*/
241   gpointer       _gst_reserved[GST_PADDING_LARGE];  
242   GstBaseParseClassPrivate *priv;
243 };
244
245 GType           gst_base_parse_get_type         (void);
246
247
248 GstFlowReturn gst_base_parse_push_buffer (GstBaseParse *parse,
249                                           GstBuffer *buffer);
250
251 void gst_base_parse_set_duration (GstBaseParse *parse,
252                                   GstFormat fmt,
253                                   gint64 duration);
254
255 void gst_base_parse_set_min_frame_size (GstBaseParse *parse,
256                                         guint min_size);
257 void gst_base_parse_set_passthrough (GstBaseParse * parse, gboolean passthrough);
258
259 void gst_base_parse_set_frame_props (GstBaseParse * parse, guint fps_num,
260                                      guint fps_den, gint interval);
261
262 gboolean gst_base_parse_get_sync (GstBaseParse * parse);
263
264 gboolean gst_base_parse_get_drain (GstBaseParse * parse);
265
266 G_END_DECLS
267
268 #endif /* __GST_BASE_PARSE_H__ */