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., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, 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.
45 #define GST_BASE_PARSE_SRC_PAD(obj) (GST_BASE_PARSE_CAST (obj)->srcpad)
48 * GST_BASE_PARSE_SINK_PAD:
49 * @obj: base parse instance
51 * Gives the pointer to the sink #GstPad object of the element.
55 #define GST_BASE_PARSE_SINK_PAD(obj) (GST_BASE_PARSE_CAST (obj)->sinkpad)
58 * GST_BASE_PARSE_FLOW_DROPPED:
60 * A #GstFlowReturn that can be returned from parse_frame to
61 * indicate that no output buffer was generated, or from pre_push_buffer to
62 * to forego pushing buffer.
66 #define GST_BASE_PARSE_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS
69 * GST_BASE_PARSE_FLOW_QUEUED:
71 * A #GstFlowReturn that can be returned from parse frame to indicate that
72 * the buffer will be queued to be pushed when the next OK
76 #define GST_BASE_PARSE_FLOW_QUEUED GST_FLOW_CUSTOM_SUCCESS_1
78 /* not public API, use accessor macros below */
79 #define GST_BASE_PARSE_FLAG_LOST_SYNC (1 << 0)
80 #define GST_BASE_PARSE_FLAG_DRAINING (1 << 1)
83 * GST_BASE_PARSE_LOST_SYNC:
84 * @parse: base parse instance
86 * Obtains current sync status.
90 #define GST_BASE_PARSE_LOST_SYNC(parse) (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_LOST_SYNC))
93 * GST_BASE_PARSE_DRAINING:
94 * @parse: base parse instance
96 * Obtains current drain status (ie. whether EOS has been received and
97 * the parser is now processing the frames at the end of the stream)
101 #define GST_BASE_PARSE_DRAINING(parse) (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_DRAINING))
104 * GstBaseParseFrameFlags:
105 * @GST_BASE_PARSE_FRAME_FLAG_NONE: no flag
106 * @GST_BASE_PARSE_FRAME_FLAG_NO_FRAME: set to indicate this buffer should not be
107 * counted as frame, e.g. if this frame is dependent on a previous one.
108 * As it is not counted as a frame, bitrate increases but frame to time
109 * conversions are maintained.
110 * @GST_BASE_PARSE_FRAME_FLAG_CLIP: @pre_push_buffer can set this to indicate
111 * that regular segment clipping can still be performed (as opposed to
112 * any custom one having been done).
114 * Flags to be used in a #GstBaseParseFrame.
119 GST_BASE_PARSE_FRAME_FLAG_NONE = 0,
120 GST_BASE_PARSE_FRAME_FLAG_NO_FRAME = (1 << 0),
121 GST_BASE_PARSE_FRAME_FLAG_CLIP = (1 << 1)
122 } GstBaseParseFrameFlags;
126 * @buffer: data to check for valid frame or parsed frame.
127 * Subclass is allowed to replace this buffer.
128 * @overhead: subclass can set this to indicates the metadata overhead
129 * for the given frame, which is then used to enable more accurate bitrate
130 * computations. If this is -1, it is assumed that this frame should be
131 * skipped in bitrate calculation.
132 * @flags: a combination of input and output #GstBaseParseFrameFlags that
133 * convey additional context to subclass or allow subclass to tune
134 * subsequent #GstBaseParse actions.
136 * Frame (context) data passed to each frame parsing virtual methods. In
137 * addition to providing the data to be checked for a valid frame or an already
138 * identified frame, it conveys additional metadata or control information
139 * from and to the subclass w.r.t. the particular frame in question (rather
140 * than global parameters). Some of these may apply to each parsing stage, others
141 * only to some a particular one. These parameters are effectively zeroed at start
142 * of each frame's processing, i.e. parsing virtual method invocation sequence.
151 gint _gst_reserved_i[2];
152 gpointer _gst_reserved_p[2];
155 typedef struct _GstBaseParse GstBaseParse;
156 typedef struct _GstBaseParseClass GstBaseParseClass;
157 typedef struct _GstBaseParsePrivate GstBaseParsePrivate;
161 * @element: the parent element.
163 * The opaque #GstBaseParse data structure.
165 struct _GstBaseParse {
169 /* source and sink pads */
175 /* MT-protected (with STREAM_LOCK) */
179 gpointer _gst_reserved[GST_PADDING_LARGE];
180 GstBaseParsePrivate *priv;
185 * @parent_class: the parent class
187 * Called when the element starts processing.
188 * Allows opening external resources.
190 * Called when the element stops processing.
191 * Allows closing external resources.
192 * @set_sink_caps: allows the subclass to be notified of the actual caps set.
193 * @check_valid_frame: Check if the given piece of data contains a valid
195 * @parse_frame: Parse the already checked frame. Subclass need to
196 * set the buffer timestamp, duration, caps and possibly
197 * other necessary metadata. This is called with srcpad's
199 * @convert: Optional.
200 * Convert between formats.
202 * Event handler on the sink pad. This function should return
203 * TRUE if the event was handled and can be dropped.
204 * @src_event: Optional.
205 * Event handler on the source pad. Should return TRUE
206 * if the event was handled and can be dropped.
207 * @pre_push_frame: Optional.
208 * Called just prior to pushing a frame (after any pending
209 * events have been sent) to give subclass a chance to perform
210 * additional actions at this time (e.g. tag sending) or to
211 * decide whether this buffer should be dropped or not
212 * (e.g. custom segment clipping).
214 * Subclasses can override any of the available virtual methods or not, as
215 * needed. At minimum @check_valid_frame and @parse_frame needs to be
218 struct _GstBaseParseClass {
219 GstElementClass parent_class;
222 /* virtual methods for subclasses */
224 gboolean (*start) (GstBaseParse * parse);
226 gboolean (*stop) (GstBaseParse * parse);
228 gboolean (*set_sink_caps) (GstBaseParse * parse,
231 gboolean (*check_valid_frame) (GstBaseParse * parse,
232 GstBaseParseFrame * frame,
236 GstFlowReturn (*parse_frame) (GstBaseParse * parse,
237 GstBaseParseFrame * frame);
239 GstFlowReturn (*pre_push_frame) (GstBaseParse * parse,
240 GstBaseParseFrame * frame);
242 gboolean (*convert) (GstBaseParse * parse,
243 GstFormat src_format,
245 GstFormat dest_format,
246 gint64 * dest_value);
248 gboolean (*event) (GstBaseParse * parse,
251 gboolean (*src_event) (GstBaseParse * parse,
255 gpointer _gst_reserved[GST_PADDING_LARGE];
258 GType gst_base_parse_get_type (void);
260 void gst_base_parse_frame_init (GstBaseParse * parse,
261 GstBaseParseFrame * frame);
263 GstFlowReturn gst_base_parse_push_frame (GstBaseParse * parse,
264 GstBaseParseFrame * frame);
266 void gst_base_parse_set_duration (GstBaseParse * parse,
271 void gst_base_parse_set_average_bitrate (GstBaseParse * parse,
274 void gst_base_parse_set_min_frame_size (GstBaseParse * parse,
277 void gst_base_parse_set_has_timing_info (GstBaseParse * parse,
278 gboolean has_timing);
280 void gst_base_parse_set_syncable (GstBaseParse * parse,
283 void gst_base_parse_set_passthrough (GstBaseParse * parse,
284 gboolean passthrough);
286 void gst_base_parse_set_frame_rate (GstBaseParse * parse,
292 gboolean gst_base_parse_convert_default (GstBaseParse * parse,
293 GstFormat src_format,
295 GstFormat dest_format,
296 gint64 * dest_value);
298 gboolean gst_base_parse_add_index_entry (GstBaseParse * parse,
306 #endif /* __GST_BASE_PARSE_H__ */