baseparse: introduce a baseparse frame to serve as context
[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_SEGMENT:
73  * @obj: base parse instance
74  *
75  * Gives the segment of the element.
76  *
77  * Since: 0.10.x
78  */
79 #define GST_BASE_PARSE_SEGMENT(obj)     (GST_BASE_PARSE_CAST (obj)->segment)
80
81 /**
82  * GST_BASE_PARSE_FLOW_DROPPED:
83  *
84  * A #GstFlowReturn that can be returned from parse_frame to
85  * indicate that no output buffer was generated, or from pre_push_buffer to
86  * to forego pushing buffer.
87  *
88  * Since: 0.10.x
89  */
90 #define GST_BASE_PARSE_FLOW_DROPPED   GST_FLOW_CUSTOM_SUCCESS
91
92 /**
93  * GstBaseParseFrameFlags:
94  * @GST_BASE_PARSE_FRAME_FLAG_NONE: no flag
95  * @GST_BASE_PARSE_FRAME_FLAG_SYNC: indicates if parsing is 'in sync'
96  * @GST_BASE_PARSE_FRAME_FLAG_DRAIN: indicates if parser is 'draining'.
97  *   That is, leftover data (e.g. in FLUSH or EOS situation) is being parsed.
98  * @GST_BASE_PARSE_FRAME_FLAG_NO_FRAME: set to indicate this buffer should not be
99  *   counted as frame, e.g. if this frame is dependent on a previous one.
100  *   As it is not counted as a frame, bitrate increases but frame to time
101  *   conversions are maintained.
102  * @GST_BASE_PARSE_FRAME_FLAG_CLIP: @pre_push_buffer can set this to indicate
103  *    that regular segment clipping can still be performed (as opposed to
104  *    any custom one having been done).
105  *
106  * Flags to be used in a #GstBaseParseFrame.
107  *
108  * Since: 0.10.x
109  */
110 typedef enum {
111   GST_BASE_PARSE_FRAME_FLAG_NONE         = 0,
112   GST_BASE_PARSE_FRAME_FLAG_SYNC         = (1 << 0),
113   GST_BASE_PARSE_FRAME_FLAG_DRAIN        = (1 << 1),
114   GST_BASE_PARSE_FRAME_FLAG_NO_FRAME     = (1 << 2),
115   GST_BASE_PARSE_FRAME_FLAG_CLIP         = (1 << 3)
116 } GstBaseParseFrameFlags;
117
118 /**
119  * GstBaseParseFrame:
120  * @buffer: data to check for valid frame or parsed frame.
121  *   Subclass is allowed to replace this buffer.
122  * @overhead: subclass can set this to indicates the metadata overhead
123  *   for the given frame, which is then used to enable more accurate bitrate
124  *   computations. If this is -1, it is assumed that this frame should be
125  *   skipped in bitrate calculation.
126  * @flags: a combination of input and output #GstBaseParseFrameFlags that
127  *  convey additional context to subclass or allow subclass to tune
128  *  subsequent #GstBaseParse actions.
129  *
130  * Frame (context) data passed to each frame parsing virtual methods.  In
131  * addition to providing the data to be checked for a valid frame or an already
132  * identified frame, it conveys additional metadata or control information
133  * from and to the subclass w.r.t. the particular frame in question (rather
134  * than global parameters).  Some of these may apply to each parsing stage, others
135  * only to some a particular one.  These parameters are effectively zeroed at start
136  * of each frame's processing, i.e. parsing virtual method invocation sequence.
137  *
138  * Since: 0.10.x
139  */
140 typedef struct {
141   GstBuffer       *buffer;
142   guint           flags;
143   gint            overhead;
144 } GstBaseParseFrame;
145
146 /**
147  * GST_BASE_PARSE_FRAME_SYNC:
148  * @frame: base parse frame instance
149  *
150  * Obtains current sync status indicated in frame.
151  *
152  * Since: 0.10.x
153  */
154 #define GST_BASE_PARSE_FRAME_SYNC(frame)     (!!(frame->flags & GST_BASE_PARSE_FRAME_FLAG_SYNC))
155
156 /**
157  * GST_BASE_PARSE_FRAME_DRAIN:
158  * @frame: base parse frame instance
159  *
160  * Obtains current drain status indicated in frame.
161  *
162  * Since: 0.10.x
163  */
164 #define GST_BASE_PARSE_FRAME_DRAIN(frame)    (!!(frame->flags & GST_BASE_PARSE_FRAME_FLAG_DRAIN))
165
166
167 /**
168  * GstBaseParseSeekable:
169  * @GST_BASE_PARSE_SEEK_NONE: No seeking possible.
170  * GST_BASE_PARSE_SEEK_DEFAULT: Default seeking possible using estimated bitrate.
171  * GST_BASE_PARSE_SEEK_TABLE: Additional metadata provides more accurate seeking.
172  *
173  * Indicates what level (of quality) of seeking is possible.
174  *
175  * Since: 0.10.x
176  */
177 typedef enum _GstBaseParseSeekable {
178   GST_BASE_PARSE_SEEK_NONE,
179   GST_BASE_PARSE_SEEK_DEFAULT,
180   GST_BASE_PARSE_SEEK_TABLE
181 } GstBaseParseSeekable;
182
183 typedef struct _GstBaseParse GstBaseParse;
184 typedef struct _GstBaseParseClass GstBaseParseClass;
185 typedef struct _GstBaseParsePrivate GstBaseParsePrivate;
186
187 /**
188  * GstBaseParse:
189  * @element: the parent element.
190  *
191  * The opaque #GstBaseParse data structure.
192  */
193 struct _GstBaseParse {
194   GstElement     element;
195   GstAdapter    *adapter;
196
197   /*< protected >*/
198   /* source and sink pads */
199   GstPad         *sinkpad;
200   GstPad         *srcpad;
201
202   /* MT-protected (with STREAM_LOCK) */
203   GstSegment      segment;
204
205   /* Newsegment event to be sent after SEEK */
206   GstEvent       *pending_segment;
207
208   /* Segment event that closes the running segment prior to SEEK */
209   GstEvent       *close_segment;
210
211   /*< private >*/
212   gpointer       _gst_reserved[GST_PADDING_LARGE];
213   GstBaseParsePrivate *priv;
214 };
215
216 /**
217  * GstBaseParseClass:
218  * @start:          Optional.
219  *                  Called when the element starts processing.
220  *                  Allows opening external resources.
221  * @stop:           Optional.
222  *                  Called when the element stops processing.
223  *                  Allows closing external resources.
224  * @set_sink_caps:  allows the subclass to be notified of the actual caps set.
225  * @check_valid_frame:  Check if the given piece of data contains a valid
226  *                      frame.
227  * @parse_frame:    Parse the already checked frame. Subclass need to
228  *                  set the buffer timestamp, duration, caps and possibly
229  *                  other necessary metadata. This is called with srcpad's
230  *                  STREAM_LOCK held.
231  * @convert:        Optional.
232  *                  Convert between formats.
233  * @find_frame:     Optional.
234  *                  Finds a frame. Gets a position passed and should return
235  *                  TRUE and the offset in bytes where this position is.
236  *                  Will only be called in pull mode and the subclass can pull
237  *                  whatever it wants from upstream. If not implemented,
238  *                  the base class will implement it by calling
239  *                  @check_valid_frame and @parse_frame to find the wanted
240  *                  frame and build a seek table.
241  * @event:          Optional.
242  *                  Event handler on the sink pad. This function should return
243  *                  TRUE if the event was handled and can be dropped.
244  * @src_event:      Optional.
245  *                  Event handler on the source pad. Should return TRUE
246  *                  if the event was handled and can be dropped.
247  *
248  * @get_frame_overhead: Finds the metadata overhead for the given frame. This
249  *                      is used to enable more accurate bitrate computations.
250  *                      If NULL, the per-frame overhead is assumed to be 0. If
251  *                      this returns -1, it is assumed that this frame should
252  *                      be skipped in bitrate calculation.
253  *
254  * @pre_push_buffer: Optional.
255  *                   Called just prior to pushing a frame (after any pending
256  *                   events have been sent) to give subclass a chance to perform
257  *                   additional actions at this time (e.g. tag sending) or to
258  *                   decide whether this buffer should be dropped or not
259  *                   (e.g. custom segment clipping).
260  *
261  * Subclasses can override any of the available virtual methods or not, as
262  * needed. At minimum @check_valid_frame and @parse_frame needs to be
263  * overridden.
264  */
265 struct _GstBaseParseClass {
266   GstElementClass parent_class;
267
268   /*< public >*/
269   /* virtual methods for subclasses */
270
271   gboolean      (*start)              (GstBaseParse *parse);
272
273   gboolean      (*stop)               (GstBaseParse *parse);
274
275   gboolean      (*set_sink_caps)      (GstBaseParse *parse,
276                                        GstCaps *caps);
277
278   gboolean      (*check_valid_frame)  (GstBaseParse *parse,
279                                        GstBaseParseFrame *frame,
280                                        guint *framesize,
281                                        gint *skipsize);
282
283   GstFlowReturn (*parse_frame)        (GstBaseParse *parse,
284                                        GstBaseParseFrame *frame);
285
286   GstFlowReturn (*pre_push_frame)     (GstBaseParse *parse,
287                                        GstBaseParseFrame *frame);
288
289   gboolean      (*convert)            (GstBaseParse * parse,
290                                        GstFormat src_format,
291                                        gint64 src_value,
292                                        GstFormat dest_format,
293                                        gint64 * dest_value);
294
295   gboolean      (*event)              (GstBaseParse *parse,
296                                        GstEvent *event);
297
298   gboolean      (*src_event)          (GstBaseParse *parse,
299                                        GstEvent *event);
300
301   /*< private >*/
302   gpointer       _gst_reserved[GST_PADDING_LARGE];
303 };
304
305 GType           gst_base_parse_get_type         (void);
306
307 void gst_base_parse_frame_init (GstBaseParse * parse, GstBaseParseFrame * frame);
308
309 GstFlowReturn gst_base_parse_push_frame (GstBaseParse *parse,
310                                           GstBaseParseFrame *frame);
311
312 void gst_base_parse_set_duration (GstBaseParse *parse,
313                                   GstFormat fmt, gint64 duration, gint interval);
314
315 void gst_base_parse_set_seek (GstBaseParse * parse,
316                               GstBaseParseSeekable seek, guint bitrate);
317
318 void gst_base_parse_set_min_frame_size (GstBaseParse *parse, guint min_size);
319
320 void gst_base_parse_set_passthrough (GstBaseParse * parse, gboolean passthrough);
321
322 void gst_base_parse_set_frame_props (GstBaseParse * parse, guint fps_num,
323                                      guint fps_den, guint lead_in, guint lead_out);
324
325 gboolean gst_base_parse_convert_default (GstBaseParse * parse,
326                                          GstFormat src_format, gint64 src_value,
327                                          GstFormat dest_format, gint64 * dest_value);
328
329 gboolean gst_base_parse_add_index_entry (GstBaseParse * parse, guint64 offset,
330                                          GstClockTime ts, gboolean key, gboolean force);
331
332 G_END_DECLS
333
334 #endif /* __GST_BASE_PARSE_H__ */