buffer: add pts/dts to buffers
[platform/upstream/gstreamer.git] / gst / gstbuffer.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstbuffer.h: Header for GstBuffer object
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23
24 #ifndef __GST_BUFFER_H__
25 #define __GST_BUFFER_H__
26
27 #include <gst/gstminiobject.h>
28 #include <gst/gstclock.h>
29 #include <gst/gstcaps.h>
30 #include <gst/gstmemory.h>
31
32 G_BEGIN_DECLS
33
34 extern GType _gst_buffer_type;
35
36 typedef struct _GstBuffer GstBuffer;
37 typedef struct _GstBufferPool GstBufferPool;
38
39 /**
40  * GST_BUFFER_TRACE_NAME:
41  *
42  * The name used for tracing memory allocations.
43  */
44 #define GST_BUFFER_TRACE_NAME           "GstBuffer"
45
46 #define GST_TYPE_BUFFER                         (_gst_buffer_type)
47 #define GST_IS_BUFFER(obj)                      (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
48 #define GST_BUFFER_CAST(obj)                    ((GstBuffer *)(obj))
49 #define GST_BUFFER(obj)                         (GST_BUFFER_CAST(obj))
50
51 /**
52  * GST_BUFFER_FLAGS:
53  * @buf: a #GstBuffer.
54  *
55  * A flags word containing #GstBufferFlag flags set on this buffer.
56  */
57 #define GST_BUFFER_FLAGS(buf)                   GST_MINI_OBJECT_FLAGS(buf)
58 /**
59  * GST_BUFFER_FLAG_IS_SET:
60  * @buf: a #GstBuffer.
61  * @flag: the #GstBufferFlag to check.
62  *
63  * Gives the status of a specific flag on a buffer.
64  */
65 #define GST_BUFFER_FLAG_IS_SET(buf,flag)        GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
66 /**
67  * GST_BUFFER_FLAG_SET:
68  * @buf: a #GstBuffer.
69  * @flag: the #GstBufferFlag to set.
70  *
71  * Sets a buffer flag on a buffer.
72  */
73 #define GST_BUFFER_FLAG_SET(buf,flag)           GST_MINI_OBJECT_FLAG_SET (buf, flag)
74 /**
75  * GST_BUFFER_FLAG_UNSET:
76  * @buf: a #GstBuffer.
77  * @flag: the #GstBufferFlag to clear.
78  *
79  * Clears a buffer flag.
80  */
81 #define GST_BUFFER_FLAG_UNSET(buf,flag)         GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
82
83
84 /**
85  * GST_BUFFER_PTS:
86  * @buf: a #GstBuffer.:
87  *
88  * The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
89  * of the data in the buffer. This is the timestamp when the media should be
90  * presented to the user.
91  * Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.
92  */
93 #define GST_BUFFER_PTS(buf)                     (GST_BUFFER_CAST(buf)->pts)
94 /**
95  * GST_BUFFER_DTS:
96  * @buf: a #GstBuffer.:
97  *
98  * The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
99  * of the data in the buffer. This is the timestamp when the media should be
100  * decoded or processed otherwise.
101  * Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.
102  */
103 #define GST_BUFFER_DTS(buf)                     (GST_BUFFER_CAST(buf)->dts)
104 /**
105  * GST_BUFFER_DURATION:
106  * @buf: a #GstBuffer.
107  *
108  * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
109  * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
110  */
111 #define GST_BUFFER_DURATION(buf)                (GST_BUFFER_CAST(buf)->duration)
112 /**
113  * GST_BUFFER_OFFSET:
114  * @buf: a #GstBuffer.
115  *
116  * The offset in the source file of the beginning of this buffer.
117  */
118 #define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
119 /**
120  * GST_BUFFER_OFFSET_END:
121  * @buf: a #GstBuffer.
122  *
123  * The offset in the source file of the end of this buffer.
124  */
125 #define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
126
127 /**
128  * GST_BUFFER_OFFSET_NONE:
129  *
130  * Constant for no-offset return results.
131  */
132 #define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
133
134 /**
135  * GST_BUFFER_DURATION_IS_VALID:
136  * @buffer: a #GstBuffer
137  *
138  * Tests if the duration is known.
139  */
140 #define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
141 /**
142  * GST_BUFFER_PTS_IS_VALID:
143  * @buffer: a #GstBuffer
144  *
145  * Tests if the pts is known.
146  */
147 #define GST_BUFFER_PTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (buffer)))
148 /**
149  * GST_BUFFER_DTS_IS_VALID:
150  * @buffer: a #GstBuffer
151  *
152  * Tests if the dts is known.
153  */
154 #define GST_BUFFER_DTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (buffer)))
155 /**
156  * GST_BUFFER_OFFSET_IS_VALID:
157  * @buffer: a #GstBuffer
158  *
159  * Tests if the start offset is known.
160  */
161 #define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
162 /**
163  * GST_BUFFER_OFFSET_END_IS_VALID:
164  * @buffer: a #GstBuffer
165  *
166  * Tests if the end offset is known.
167  */
168 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
169 /**
170  * GST_BUFFER_IS_DISCONT:
171  * @buffer: a #GstBuffer
172  *
173  * Tests if the buffer marks a discontinuity in the stream.
174  *
175  * Since: 0.10.9
176  */
177 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
178
179 /**
180  * GstBufferFlags:
181  * @GST_BUFFER_FLAG_LIVE:        the buffer is live data and should be discarded in
182  *                               the PAUSED state.
183  * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
184  *                               because it will be clipped against the segment
185  *                               boundaries or because it does not contain data
186  *                               that should be shown to the user.
187  * @GST_BUFFER_FLAG_DISCONT:     the buffer marks a data discontinuity in the stream.
188  *                               This typically occurs after a seek or a dropped buffer
189  *                               from a live or network source.
190  * @GST_BUFFER_FLAG_RESYNC:      the buffer timestamp might have a discontinuity
191  *                               and this buffer is a good point to resynchronize.
192  * @GST_BUFFER_FLAG_CORRUPTED:   the buffer data is corrupted.
193  * @GST_BUFFER_FLAG_MARKER:      the buffer contains a media specific marker. for
194  *                               video this is typically the end of a frame boundary, for audio
195  *                               this is usually the end of a talkspurt.
196  * @GST_BUFFER_FLAG_HEADER:      the buffer contains header information that is
197  *                               needed to decode the following data
198  * @GST_BUFFER_FLAG_GAP:         the buffer has been created to fill a gap in the
199  *                               stream and contains media neutral data (elements can
200  *                               switch to optimized code path that ignores the buffer
201  *                               content).
202  * @GST_BUFFER_FLAG_DROPPABLE:   the buffer can be dropped without breaking the
203  *                               stream, for example to reduce bandwidth.
204  * @GST_BUFFER_FLAG_DELTA_UNIT:  this unit cannot be decoded independently.
205  * @GST_BUFFER_FLAG_IN_CAPS:     the buffer has been added as a field in a #GstCaps.
206  * @GST_BUFFER_FLAG_LAST:        additional media specific flags can be added starting from
207  *                               this flag.
208  *
209  * A set of buffer flags used to describe properties of a #GstBuffer.
210  */
211 typedef enum {
212   GST_BUFFER_FLAG_LIVE        = (GST_MINI_OBJECT_FLAG_LAST << 0),
213   GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
214   GST_BUFFER_FLAG_DISCONT     = (GST_MINI_OBJECT_FLAG_LAST << 2),
215   GST_BUFFER_FLAG_RESYNC      = (GST_MINI_OBJECT_FLAG_LAST << 3),
216   GST_BUFFER_FLAG_CORRUPTED   = (GST_MINI_OBJECT_FLAG_LAST << 4),
217   GST_BUFFER_FLAG_MARKER      = (GST_MINI_OBJECT_FLAG_LAST << 5),
218   GST_BUFFER_FLAG_HEADER      = (GST_MINI_OBJECT_FLAG_LAST << 6),
219   GST_BUFFER_FLAG_GAP         = (GST_MINI_OBJECT_FLAG_LAST << 7),
220   GST_BUFFER_FLAG_DROPPABLE   = (GST_MINI_OBJECT_FLAG_LAST << 8),
221   GST_BUFFER_FLAG_DELTA_UNIT  = (GST_MINI_OBJECT_FLAG_LAST << 9),
222   GST_BUFFER_FLAG_IN_CAPS     = (GST_MINI_OBJECT_FLAG_LAST << 10),
223
224   GST_BUFFER_FLAG_LAST        = (GST_MINI_OBJECT_FLAG_LAST << 20)
225 } GstBufferFlags;
226
227 /**
228  * GstBuffer:
229  * @mini_object: the parent structure
230  * @pool: pointer to the pool owner of the buffer
231  * @timestamp: timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
232  *     timestamp is not known or relevant.
233  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
234  *     when the duration is not known or relevant.
235  * @offset: a media specific offset for the buffer data.
236  *     For video frames, this is the frame number of this buffer.
237  *     For audio samples, this is the offset of the first sample in this buffer.
238  *     For file data or compressed data this is the byte offset of the first
239  *       byte in this buffer.
240  * @offset_end: the last offset contained in this buffer. It has the same
241  *     format as @offset.
242  *
243  * The structure of a #GstBuffer. Use the associated macros to access the public
244  * variables.
245  */
246 struct _GstBuffer {
247   GstMiniObject          mini_object;
248
249   /*< public >*/ /* with COW */
250   GstBufferPool         *pool;
251
252   /* timestamp */
253   GstClockTime           pts;
254   GstClockTime           dts;
255   GstClockTime           duration;
256
257   /* media specific offset */
258   guint64                offset;
259   guint64                offset_end;
260 };
261
262 GType       gst_buffer_get_type            (void);
263
264 /* allocation */
265 GstBuffer * gst_buffer_new                 (void);
266 GstBuffer * gst_buffer_new_allocate        (const GstAllocator * allocator, gsize size, gsize align);
267 GstBuffer * gst_buffer_new_wrapped_full    (gpointer data, GFreeFunc free_func, gsize offset, gsize size);
268 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
269
270 /* memory blocks */
271 guint       gst_buffer_n_memory            (GstBuffer *buffer);
272 void        gst_buffer_take_memory         (GstBuffer *buffer, gint idx, GstMemory *mem);
273 GstMemory * gst_buffer_peek_memory         (GstBuffer *buffer, guint idx, GstMapFlags flags);
274 void        gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, guint length);
275
276 /**
277  * gst_buffer_remove_memory:
278  * @b: a #GstBuffer.
279  * @i: an index
280  *
281  * Remove the memory block in @b at @i.
282  */
283 #define     gst_buffer_remove_memory(b,i)  gst_buffer_remove_memory_range ((b), (i), 1)
284
285 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
286                                             gconstpointer src, gsize size);
287 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
288                                             gpointer dest, gsize size);
289 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
290                                             gconstpointer mem, gsize size);
291 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
292                                             guint8 val, gsize size);
293
294 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
295 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gsize size);
296
297 /**
298  * gst_buffer_get_size:
299  * @b: a #GstBuffer.
300  *
301  * Get the size of @b.
302  */
303 #define     gst_buffer_get_size(b)         gst_buffer_get_sizes ((b), NULL, NULL)
304 /**
305  * gst_buffer_set_size:
306  * @b: a #GstBuffer.
307  * @s: a new size
308  *
309  * Set the size of @b to @s. This will remove or trim the memory blocks
310  * in the buffer.
311  */
312 #define     gst_buffer_set_size(b,s)       gst_buffer_resize ((b), 0, (s))
313
314 /* getting memory */
315 gpointer    gst_buffer_map                 (GstBuffer *buffer, gsize *size, gsize *maxsize,
316                                             GstMapFlags flags);
317 gboolean    gst_buffer_unmap               (GstBuffer *buffer, gpointer data, gsize size);
318
319 /* refcounting */
320 /**
321  * gst_buffer_ref:
322  * @buf: a #GstBuffer.
323  *
324  * Increases the refcount of the given buffer by one.
325  *
326  * Note that the refcount affects the writeability
327  * of @buf and its metadata, see gst_buffer_is_writable() and
328  * gst_buffer_is_metadata_writable(). It is
329  * important to note that keeping additional references to
330  * GstBuffer instances can potentially increase the number
331  * of memcpy operations in a pipeline.
332  *
333  * Returns: (transfer full): @buf
334  */
335 #ifdef _FOOL_GTK_DOC_
336 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
337 #endif
338
339 static inline GstBuffer *
340 gst_buffer_ref (GstBuffer * buf)
341 {
342   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
343 }
344
345 /**
346  * gst_buffer_unref:
347  * @buf: (transfer full): a #GstBuffer.
348  *
349  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
350  * will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
351  * also be freed at this time.
352  */
353 #ifdef _FOOL_GTK_DOC_
354 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
355 #endif
356
357 static inline void
358 gst_buffer_unref (GstBuffer * buf)
359 {
360   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
361 }
362
363 /* copy buffer */
364 /**
365  * gst_buffer_copy:
366  * @buf: a #GstBuffer.
367  *
368  * Create a copy of the given buffer. This will also make a newly allocated
369  * copy of the data the source buffer contains.
370  *
371  * Returns: (transfer full): a new copy of @buf.
372  */
373 #ifdef _FOOL_GTK_DOC_
374 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
375 #endif
376
377 static inline GstBuffer *
378 gst_buffer_copy (const GstBuffer * buf)
379 {
380   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
381 }
382
383
384 /**
385  * GstBufferCopyFlags:
386  * @GST_BUFFER_COPY_NONE: copy nothing
387  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
388  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
389  * duration, offset and offset_end should be copied
390  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
391  * and appended to already existing memory
392  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
393  * merged
394  *
395  * A set of flags that can be provided to the gst_buffer_copy_into()
396  * function to specify which items should be copied.
397  */
398 typedef enum {
399   GST_BUFFER_COPY_NONE           = 0,
400   GST_BUFFER_COPY_FLAGS          = (1 << 0),
401   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
402   GST_BUFFER_COPY_MEMORY         = (1 << 2),
403   GST_BUFFER_COPY_MERGE          = (1 << 3)
404 } GstBufferCopyFlags;
405
406 /**
407  * GST_BUFFER_COPY_METADATA:
408  *
409  * Combination of all possible metadata fields that can be copied with
410  * gst_buffer_copy_into().
411  */
412 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS)
413
414 /**
415  * GST_BUFFER_COPY_ALL:
416  *
417  * Combination of all possible fields that can be copied with
418  * gst_buffer_copy_into().
419  */
420 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
421
422 /* copies memory or metadata into newly allocated buffer */
423 void            gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
424                                                  GstBufferCopyFlags flags,
425                                                  gsize offset, gsize size);
426
427 /**
428  * gst_buffer_is_writable:
429  * @buf: a #GstBuffer
430  *
431  * Tests if you can safely write data into a buffer's data array or validly
432  * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
433  * writable, but it is only safe to change it when there is only one owner
434  * of the buffer - ie, the refcount is 1.
435  */
436 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
437 /**
438  * gst_buffer_make_writable:
439  * @buf: (transfer full): a #GstBuffer
440  *
441  * Makes a writable buffer from the given buffer. If the source buffer is
442  * already writable, this will simply return the same buffer. A copy will
443  * otherwise be made using gst_buffer_copy().
444  *
445  * Returns: (transfer full): a writable buffer which may or may not be the
446  *     same as @buf
447  */
448 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
449
450 /**
451  * gst_buffer_replace:
452  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
453  *     replaced.
454  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
455  *     replace the buffer pointed to by @obuf.
456  *
457  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
458  * modification is done atomically (so this is useful for ensuring thread safety
459  * in some cases), and the reference counts are updated appropriately (the old
460  * buffer is unreffed, the new is reffed).
461  *
462  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
463  */
464 #ifdef _FOOL_GTK_DOC_
465 G_INLINE_FUNC void gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
466 #endif
467
468 static inline void
469 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
470 {
471   gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
472 }
473
474 /* creating a region */
475 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
476                                                  gsize offset, gsize size);
477
478 /* span, two buffers, intelligently */
479 gboolean        gst_buffer_is_span_fast         (GstBuffer *buf1, GstBuffer *buf2);
480 GstBuffer*      gst_buffer_span                 (GstBuffer *buf1, gsize offset, GstBuffer *buf2, gsize size);
481
482 /* metadata */
483 #include <gst/gstmeta.h>
484
485 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, const GstMetaInfo *info);
486 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
487                                                  gpointer params);
488 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
489
490 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
491
492 /**
493  * gst_value_set_buffer:
494  * @v: a #GValue to receive the data
495  * @b: (transfer none): a #GstBuffer to assign to the GstValue
496  *
497  * Sets @b as the value of @v.  Caller retains reference to buffer.
498  */
499 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
500 /**
501  * gst_value_take_buffer:
502  * @v: a #GValue to receive the data
503  * @b: (transfer full): a #GstBuffer to assign to the GstValue
504  *
505  * Sets @b as the value of @v.  Caller gives away reference to buffer.
506  */
507 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
508 /**
509  * gst_value_get_buffer:
510  * @v: a #GValue to query
511  *
512  * Receives a #GstBuffer as the value of @v. Does not return a reference to
513  * the buffer, so the pointer is only valid for as long as the caller owns
514  * a reference to @v.
515  *
516  * Returns: (transfer none): buffer
517  */
518 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
519
520 G_END_DECLS
521
522 #endif /* __GST_BUFFER_H__ */