2 * Copyright (C) 2008 Nokia Corporation. All rights reserved.
4 * Contact: Stefan Kost <stefan.kost@nokia.com>
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.
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.
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., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
22 #ifndef __GST_BASE_PARSE_H__
23 #define __GST_BASE_PARSE_H__
29 #define GST_TYPE_BASE_PARSE (gst_base_parse_get_type())
30 #define GST_BASE_PARSE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_PARSE,GstBaseParse))
31 #define GST_BASE_PARSE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_PARSE,GstBaseParseClass))
32 #define GST_BASE_PARSE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_BASE_PARSE,GstBaseParseClass))
33 #define GST_IS_BASE_PARSE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_PARSE))
34 #define GST_IS_BASE_PARSE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_PARSE))
35 #define GST_BASE_PARSE_CAST(obj) ((GstBaseParse *)(obj))
38 * GST_BASE_PARSE_SRC_PAD:
39 * @obj: base parse instance
41 * Gives the pointer to the source #GstPad object of the element.
43 #define GST_BASE_PARSE_SRC_PAD(obj) (GST_BASE_PARSE_CAST (obj)->srcpad)
46 * GST_BASE_PARSE_SINK_PAD:
47 * @obj: base parse instance
49 * Gives the pointer to the sink #GstPad object of the element.
51 #define GST_BASE_PARSE_SINK_PAD(obj) (GST_BASE_PARSE_CAST (obj)->sinkpad)
54 * GST_BASE_PARSE_FLOW_DROPPED:
56 * A #GstFlowReturn that can be returned from parse_frame to
57 * indicate that no output buffer was generated, or from pre_push_frame to
58 * to forego pushing buffer.
60 #define GST_BASE_PARSE_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS
62 /* not public API, use accessor macros below */
63 #define GST_BASE_PARSE_FLAG_LOST_SYNC (1 << 0)
64 #define GST_BASE_PARSE_FLAG_DRAINING (1 << 1)
67 * GST_BASE_PARSE_LOST_SYNC:
68 * @parse: base parse instance
70 * Obtains current sync status.
72 #define GST_BASE_PARSE_LOST_SYNC(parse) (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_LOST_SYNC))
75 * GST_BASE_PARSE_DRAINING:
76 * @parse: base parse instance
78 * Obtains current drain status (ie. whether EOS has been received and
79 * the parser is now processing the frames at the end of the stream)
81 #define GST_BASE_PARSE_DRAINING(parse) (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_DRAINING))
84 * GstBaseParseFrameFlags:
85 * @GST_BASE_PARSE_FRAME_FLAG_NONE: no flag
86 * @GST_BASE_PARSE_FRAME_FLAG_NEW_FRAME: set by baseclass if current frame
87 * is passed for processing to the subclass for the first time
88 * (and not set on subsequent calls with same data).
89 * @GST_BASE_PARSE_FRAME_FLAG_NO_FRAME: set to indicate this buffer should not be
90 * counted as frame, e.g. if this frame is dependent on a previous one.
91 * As it is not counted as a frame, bitrate increases but frame to time
92 * conversions are maintained.
93 * @GST_BASE_PARSE_FRAME_FLAG_CLIP: @pre_push_frame can set this to indicate
94 * that regular segment clipping can still be performed (as opposed to
95 * any custom one having been done).
96 * @GST_BASE_PARSE_FRAME_FLAG_DROP: indicates to @finish_frame that the
97 * the frame should be dropped (and might be handled internally by subclass)
98 * @GST_BASE_PARSE_FRAME_FLAG_QUEUE: indicates to @finish_frame that the
99 * the frame should be queued for now and processed fully later
100 * when the first non-queued frame is finished
102 * Flags to be used in a #GstBaseParseFrame.
105 GST_BASE_PARSE_FRAME_FLAG_NONE = 0,
106 GST_BASE_PARSE_FRAME_FLAG_NEW_FRAME = (1 << 0),
107 GST_BASE_PARSE_FRAME_FLAG_NO_FRAME = (1 << 1),
108 GST_BASE_PARSE_FRAME_FLAG_CLIP = (1 << 2),
109 GST_BASE_PARSE_FRAME_FLAG_DROP = (1 << 3),
110 GST_BASE_PARSE_FRAME_FLAG_QUEUE = (1 << 4)
111 } GstBaseParseFrameFlags;
115 * @buffer: input data to be parsed for frames.
116 * @out_buffer: output data.
117 * @offset: media specific offset of input frame
118 * Note that a converter may have a different one on the frame's buffer.
119 * @overhead: subclass can set this to indicates the metadata overhead
120 * for the given frame, which is then used to enable more accurate bitrate
121 * computations. If this is -1, it is assumed that this frame should be
122 * skipped in bitrate calculation.
123 * @flags: a combination of input and output #GstBaseParseFrameFlags that
124 * convey additional context to subclass or allow subclass to tune
125 * subsequent #GstBaseParse actions.
127 * Frame (context) data passed to each frame parsing virtual methods. In
128 * addition to providing the data to be checked for a valid frame or an already
129 * identified frame, it conveys additional metadata or control information
130 * from and to the subclass w.r.t. the particular frame in question (rather
131 * than global parameters). Some of these may apply to each parsing stage, others
132 * only to some a particular one. These parameters are effectively zeroed at start
133 * of each frame's processing, i.e. parsing virtual method invocation sequence.
137 GstBuffer * out_buffer;
143 guint _gst_reserved_i[2];
144 gpointer _gst_reserved_p[2];
145 guint _private_flags;
148 typedef struct _GstBaseParse GstBaseParse;
149 typedef struct _GstBaseParseClass GstBaseParseClass;
150 typedef struct _GstBaseParsePrivate GstBaseParsePrivate;
154 * @element: the parent element.
156 * The opaque #GstBaseParse data structure.
158 struct _GstBaseParse {
163 /* source and sink pads */
169 /* MT-protected (with STREAM_LOCK) */
173 gpointer _gst_reserved[GST_PADDING_LARGE];
174 GstBaseParsePrivate *priv;
179 * @parent_class: the parent class
181 * Called when the element starts processing.
182 * Allows opening external resources.
184 * Called when the element stops processing.
185 * Allows closing external resources.
186 * @set_sink_caps: Optional.
187 * Allows the subclass to be notified of the actual caps set.
188 * @get_sink_caps: Optional.
189 * Allows the subclass to do its own sink get caps if needed.
190 * @handle_frame: Parses the input data into valid frames as defined by subclass
191 * which should be passed to gst_base_parse_finish_frame().
192 * The frame's input buffer is guaranteed writable,
193 * whereas the input frame ownership is held by caller
194 * (so subclass should make a copy if it needs to hang on).
195 * Input buffer (data) is provided by baseclass with as much
196 * metadata set as possible by baseclass according to upstream
197 * information and/or subclass settings,
198 * though subclass may still set buffer timestamp and duration
200 * @convert: Optional.
201 * Convert between formats.
202 * @sink_event: Optional.
203 * Event handler on the sink pad. This function should chain
204 * up to the parent implementation to let the default handler
206 * @src_event: Optional.
207 * Event handler on the source pad. Should chain up to the
208 * parent to let the default handler run.
209 * @pre_push_frame: Optional.
210 * Called just prior to pushing a frame (after any pending
211 * events have been sent) to give subclass a chance to perform
212 * additional actions at this time (e.g. tag sending) or to
213 * decide whether this buffer should be dropped or not
214 * (e.g. custom segment clipping).
216 * Called until it doesn't return GST_FLOW_OK anymore for
217 * the first buffers. Can be used by the subclass to detect
219 * @sink_query: Optional.
220 * Query handler on the sink pad. This function should chain
221 * up to the parent implementation to let the default handler
223 * @src_query: Optional.
224 * Query handler on the source pad. Should chain up to the
225 * parent to let the default handler run (Since 1.2)
227 * Subclasses can override any of the available virtual methods or not, as
228 * needed. At minimum @handle_frame needs to be overridden.
230 struct _GstBaseParseClass {
231 GstElementClass parent_class;
234 /* virtual methods for subclasses */
236 gboolean (*start) (GstBaseParse * parse);
238 gboolean (*stop) (GstBaseParse * parse);
240 gboolean (*set_sink_caps) (GstBaseParse * parse,
243 GstFlowReturn (*handle_frame) (GstBaseParse * parse,
244 GstBaseParseFrame * frame,
247 GstFlowReturn (*pre_push_frame) (GstBaseParse * parse,
248 GstBaseParseFrame * frame);
250 gboolean (*convert) (GstBaseParse * parse,
251 GstFormat src_format,
253 GstFormat dest_format,
254 gint64 * dest_value);
256 gboolean (*sink_event) (GstBaseParse * parse,
259 gboolean (*src_event) (GstBaseParse * parse,
262 GstCaps * (*get_sink_caps) (GstBaseParse * parse,
265 GstFlowReturn (*detect) (GstBaseParse * parse,
268 gboolean (*sink_query) (GstBaseParse * parse,
271 gboolean (*src_query) (GstBaseParse * parse,
275 gpointer _gst_reserved[GST_PADDING_LARGE - 2];
278 GType gst_base_parse_get_type (void);
280 GType gst_base_parse_frame_get_type (void);
282 GstBaseParseFrame * gst_base_parse_frame_new (GstBuffer * buffer,
283 GstBaseParseFrameFlags flags,
286 void gst_base_parse_frame_init (GstBaseParseFrame * frame);
288 void gst_base_parse_frame_free (GstBaseParseFrame * frame);
290 GstFlowReturn gst_base_parse_push_frame (GstBaseParse * parse,
291 GstBaseParseFrame * frame);
293 GstFlowReturn gst_base_parse_finish_frame (GstBaseParse * parse,
294 GstBaseParseFrame * frame,
297 void gst_base_parse_set_duration (GstBaseParse * parse,
302 void gst_base_parse_set_average_bitrate (GstBaseParse * parse,
305 void gst_base_parse_set_min_frame_size (GstBaseParse * parse,
308 void gst_base_parse_set_has_timing_info (GstBaseParse * parse,
309 gboolean has_timing);
311 void gst_base_parse_set_syncable (GstBaseParse * parse,
314 void gst_base_parse_set_passthrough (GstBaseParse * parse,
315 gboolean passthrough);
317 void gst_base_parse_set_pts_interpolation (GstBaseParse * parse,
318 gboolean pts_interpolate);
320 void gst_base_parse_set_infer_ts (GstBaseParse * parse,
323 void gst_base_parse_set_frame_rate (GstBaseParse * parse,
329 void gst_base_parse_set_latency (GstBaseParse * parse,
330 GstClockTime min_latency,
331 GstClockTime max_latency);
333 gboolean gst_base_parse_convert_default (GstBaseParse * parse,
334 GstFormat src_format,
336 GstFormat dest_format,
337 gint64 * dest_value);
339 gboolean gst_base_parse_add_index_entry (GstBaseParse * parse,
345 void gst_base_parse_set_ts_at_offset (GstBaseParse *parse,
350 #endif /* __GST_BASE_PARSE_H__ */