Enhance handling of bufferpool allocated by peer
[glsdk/gst-plugin-ducati.git] / src / gstducatividdec.h
1 /*
2  * GStreamer
3  * Copyright (c) 2010, Texas Instruments Incorporated
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation
8  * version 2.1 of the License.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18  */
20 #ifndef __GST_DUCATIVIDDEC_H__
21 #define __GST_DUCATIVIDDEC_H__
23 #include <stdint.h>
24 #include <stddef.h>
25 #include <unistd.h>
26 #include <omap_drm.h>
27 #include <omap_drmif.h>
29 #include "gstducati.h"
30 #include "gstducatibufferpriv.h"
32 #include <gst/drm/gstdrmbufferpool.h>
33 #include <gst/video/video.h>
34 #include <gst/video/gstvideometa.h>
36 G_BEGIN_DECLS
38 #define GST_TYPE_DUCATIVIDDEC               (gst_ducati_viddec_get_type())
39 #define GST_DUCATIVIDDEC(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_DUCATIVIDDEC, GstDucatiVidDec))
40 #define GST_DUCATIVIDDEC_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_DUCATIVIDDEC, GstDucatiVidDecClass))
41 #define GST_IS_DUCATIVIDDEC(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_DUCATIVIDDEC))
42 #define GST_IS_DUCATIVIDDEC_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_DUCATIVIDDEC))
43 #define GST_DUCATIVIDDEC_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), GST_TYPE_DUCATIVIDDEC, GstDucatiVidDecClass))
45 typedef struct _GstDucatiVidDec      GstDucatiVidDec;
46 typedef struct _GstDucatiVidDecClass GstDucatiVidDecClass;
48 /* For re-ordering in normal playback */
49 #define MAX_BACKLOG_FRAMES 16
50 /* For re-ordering in reverse playback */
51 #define MAX_BACKLOG_ARRAY_SIZE 120
53 struct _GstDucatiVidDec
54 {
55   GstElement parent;
57   GstPad *sinkpad, *srcpad;
59   GstDRMBufferPool *pool;
61   /* minimum output size required by the codec: */
62   gint outsize;
64   /* minimum number of buffers required by the codec: */
65   gint min_buffers;
67   /* input (unpadded, unaligned) size of video: */
68   gint input_width, input_height;
70   /* input (unpadded, aligned to MB) size of video: */
71   gint width, height;
73   gint fps_n, fps_d;
75   /* output (padded) size including any codec padding: */
76   gint padded_width, padded_height;
78   /* output stride (>= padded_width) */
79   gint stride;
81   gboolean interlaced;
83   struct omap_bo *input_bo;
84   /* input buffer, allocated when codec is created: */
85   guint8 *input;
87   /* number of bytes pushed to input on current frame: */
88   gint in_size;
90   /* on first output buffer, we need to send crop info to sink.. and some
91    * operations like flushing should be avoided if we haven't sent any
92    * input buffers:
93    */
94   gboolean first_out_buffer, first_in_buffer;
96   GstSegment segment;
97   gdouble qos_proportion;
98   GstClockTime qos_earliest_time;
100   gboolean need_out_buf;
102   /* For storing the external pool query history */
103   gboolean queried_external_pool;
104   GstBufferPool *externalpool;
106   /* by default, codec_data from sinkpad is prepended to first buffer: */
107   GstBuffer *codec_data;
109   guint8 *codecdata;
110   gsize codecdatasize;
112   /* workaround enabled to indicate that timestamp from demuxer is PTS,
113    * not DTS (cough, cough.. avi):
114    */
115   gboolean ts_is_pts;
117   /* auto-detection for ts_is_pts workaround.. if we detect out of order
118    * timestamps from demuxer/parser, then the ts is definitely DTS,
119    * otherwise it may be PTS and out of order timestamps out of decoder
120    * will trigger the ts_is_pts workaround.
121    */
122   gboolean ts_may_be_pts;
124   gboolean wait_keyframe;
126   gboolean needs_flushing;
128   GHashTable *passed_in_bufs;
130   GHashTable *dce_locked_bufs;
132 #define NDTS 32
133   GstClockTime dts_queue[NDTS];
134   gint dts_ridx, dts_widx;
135   GstClockTime last_dts, last_pts;
137   Engine_Handle           engine;
138   VIDDEC3_Handle          codec;
139   VIDDEC3_Params         *params;
140   VIDDEC3_DynamicParams  *dynParams;
141   VIDDEC3_Status         *status;
142   XDM2_BufDesc           *inBufs;
143   XDM2_BufDesc           *outBufs;
144   VIDDEC3_InArgs         *inArgs;
145   VIDDEC3_OutArgs        *outArgs;
147   XDAS_Int16 pageMemType;
148   struct omap_device *device;
150   /* Frames waiting to be reordered */
151   GstBuffer *backlog_frames[MAX_BACKLOG_ARRAY_SIZE + 1];
152   gint backlog_maxframes;
153   gint backlog_nframes;
154   gint backlog_max_maxframes;
156   gboolean codec_debug_info;
158   const char *error_strings[32];
159 };
161 struct _GstDucatiVidDecClass
163   GstElementClass parent_class;
165   const gchar *codec_name;
167   /**
168    * Parse codec specific fields the given caps structure.  The base-
169    * class implementation of this method handles standard stuff like
170    * width/height/framerate/codec_data.
171    */
172   gboolean (*parse_caps) (GstDucatiVidDec * self, GstStructure * s);
174   /**
175    * Called when the input buffer size changes, to recalculate codec required
176    * output buffer size and minimum count
177    */
178   void (*update_buffer_size) (GstDucatiVidDec * self);
180   /**
181    * Called to allocate/initialize  params/dynParams/status/inArgs/outArgs
182    */
183   gboolean (*allocate_params) (GstDucatiVidDec * self, gint params_sz,
184       gint dynparams_sz, gint status_sz, gint inargs_sz, gint outargs_sz);
186   /**
187    * Push input data into codec's input buffer, returning a sub-buffer of
188    * any remaining data, or NULL if none.  Consumes reference to 'buf'
189    */
190   GstBuffer * (*push_input) (GstDucatiVidDec * self, GstBuffer * buf);
192   /**
193    * Called to handle errors returned by VIDDEC3_process.
194    */
195   gint (*handle_error) (GstDucatiVidDec * self, gint ret, gint extended_error,
196       gint status_extended_error);
198   /**
199    * Called to check whether it's a good idea to drop buf or not.
200    */
201   gboolean (*can_drop_frame) (GstDucatiVidDec * self, GstBuffer * buf, gint64 diff);
203   gboolean (*query) (GstDucatiVidDec * self, GstPad * pad, GstQuery * query,
204       gboolean * forward);
206   /**
207    * Called to push a decoder buffer. Consumes reference to 'buf'.
208    */
209   GstFlowReturn (*push_output) (GstDucatiVidDec * self, GstBuffer * buf);
211   /**
212    * Called before a flush happens.
213    */
214   void (*on_flush) (GstDucatiVidDec * self, gboolean eos);
216   /**
217    * Called to set new caps on the sink pad.
218    */
219   gboolean (*set_sink_caps) (GstDucatiVidDec * self, GstCaps *caps);
220 };
222 GType gst_ducati_viddec_get_type (void);
224 /* helper methods for derived classes: */
226 static inline void
227 push_input (GstDucatiVidDec * self, const guint8 *in, gint sz)
229   GST_DEBUG_OBJECT (self, "push: %d bytes)", sz);
230   memcpy (self->input + self->in_size, in, sz);
231   self->in_size += sz;
234 static inline int
235 check_start_code (const guint8 *sc, gint scsize,
236     const guint8 *inbuf, gint insize)
238   if (insize < scsize)
239     return FALSE;
241   while (scsize) {
242     if (*sc != *inbuf)
243       return FALSE;
244     scsize--;
245     sc++;
246     inbuf++;
247   }
249   return TRUE;
252 static inline int
253 find_start_code (const guint8 *sc, gint scsize,
254     const guint8 *inbuf, gint insize)
256   gint size = 0;
257   while (insize) {
258     if (check_start_code (sc, scsize, inbuf, insize))
259       break;
260     insize--;
261     size++;
262     inbuf++;
263   }
264   return size;
267 gboolean
268 gst_ducati_viddec_codec_flush (GstDucatiVidDec * self, gboolean eos);
270 G_END_DECLS
272 #endif /* __GST_DUCATIVIDDEC_H__ */