Merge remote-tracking branch 'origin/master' into 0.11
[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 timestamps 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  * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
232  *     pts is not known or relevant. The pts contains the timestamp when the
233  *     media should be presented to the user.
234  * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
235  *     dts is not known or relevant. The dts contains the timestamp when the
236  *     media should be processed.
237  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
238  *     when the duration is not known or relevant.
239  * @offset: a media specific offset for the buffer data.
240  *     For video frames, this is the frame number of this buffer.
241  *     For audio samples, this is the offset of the first sample in this buffer.
242  *     For file data or compressed data this is the byte offset of the first
243  *       byte in this buffer.
244  * @offset_end: the last offset contained in this buffer. It has the same
245  *     format as @offset.
246  *
247  * The structure of a #GstBuffer. Use the associated macros to access the public
248  * variables.
249  */
250 struct _GstBuffer {
251   GstMiniObject          mini_object;
252
253   /*< public >*/ /* with COW */
254   GstBufferPool         *pool;
255
256   /* timestamp */
257   GstClockTime           pts;
258   GstClockTime           dts;
259   GstClockTime           duration;
260
261   /* media specific offset */
262   guint64                offset;
263   guint64                offset_end;
264 };
265
266 GType       gst_buffer_get_type            (void);
267
268 /* allocation */
269 GstBuffer * gst_buffer_new                 (void);
270 GstBuffer * gst_buffer_new_allocate        (const GstAllocator * allocator, gsize size, gsize align);
271 GstBuffer * gst_buffer_new_wrapped_full    (gpointer data, GFreeFunc free_func, gsize offset, gsize size);
272 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
273
274 /* memory blocks */
275 guint       gst_buffer_n_memory            (GstBuffer *buffer);
276 void        gst_buffer_take_memory         (GstBuffer *buffer, gint idx, GstMemory *mem);
277 GstMemory * gst_buffer_peek_memory         (GstBuffer *buffer, guint idx, GstMapFlags flags);
278 void        gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, guint length);
279
280 /**
281  * gst_buffer_remove_memory:
282  * @b: a #GstBuffer.
283  * @i: an index
284  *
285  * Remove the memory block in @b at @i.
286  */
287 #define     gst_buffer_remove_memory(b,i)  gst_buffer_remove_memory_range ((b), (i), 1)
288
289 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
290                                             gconstpointer src, gsize size);
291 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
292                                             gpointer dest, gsize size);
293 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
294                                             gconstpointer mem, gsize size);
295 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
296                                             guint8 val, gsize size);
297
298 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
299 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gsize size);
300
301 /**
302  * gst_buffer_get_size:
303  * @b: a #GstBuffer.
304  *
305  * Get the size of @b.
306  */
307 #define     gst_buffer_get_size(b)         gst_buffer_get_sizes ((b), NULL, NULL)
308 /**
309  * gst_buffer_set_size:
310  * @b: a #GstBuffer.
311  * @s: a new size
312  *
313  * Set the size of @b to @s. This will remove or trim the memory blocks
314  * in the buffer.
315  */
316 #define     gst_buffer_set_size(b,s)       gst_buffer_resize ((b), 0, (s))
317
318 /* getting memory */
319 gpointer    gst_buffer_map                 (GstBuffer *buffer, gsize *size, gsize *maxsize,
320                                             GstMapFlags flags);
321 gboolean    gst_buffer_unmap               (GstBuffer *buffer, gpointer data, gsize size);
322
323 /* refcounting */
324 /**
325  * gst_buffer_ref:
326  * @buf: a #GstBuffer.
327  *
328  * Increases the refcount of the given buffer by one.
329  *
330  * Note that the refcount affects the writeability
331  * of @buf and its metadata, see gst_buffer_is_writable() and
332  * gst_buffer_is_metadata_writable(). It is
333  * important to note that keeping additional references to
334  * GstBuffer instances can potentially increase the number
335  * of memcpy operations in a pipeline.
336  *
337  * Returns: (transfer full): @buf
338  */
339 #ifdef _FOOL_GTK_DOC_
340 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
341 #endif
342
343 static inline GstBuffer *
344 gst_buffer_ref (GstBuffer * buf)
345 {
346   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
347 }
348
349 /**
350  * gst_buffer_unref:
351  * @buf: (transfer full): a #GstBuffer.
352  *
353  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
354  * will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
355  * also be freed at this time.
356  */
357 #ifdef _FOOL_GTK_DOC_
358 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
359 #endif
360
361 static inline void
362 gst_buffer_unref (GstBuffer * buf)
363 {
364   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
365 }
366
367 /* copy buffer */
368 /**
369  * gst_buffer_copy:
370  * @buf: a #GstBuffer.
371  *
372  * Create a copy of the given buffer. This will also make a newly allocated
373  * copy of the data the source buffer contains.
374  *
375  * Returns: (transfer full): a new copy of @buf.
376  */
377 #ifdef _FOOL_GTK_DOC_
378 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
379 #endif
380
381 static inline GstBuffer *
382 gst_buffer_copy (const GstBuffer * buf)
383 {
384   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
385 }
386
387
388 /**
389  * GstBufferCopyFlags:
390  * @GST_BUFFER_COPY_NONE: copy nothing
391  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
392  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
393  * duration, offset and offset_end should be copied
394  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
395  * and appended to already existing memory
396  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
397  * merged
398  *
399  * A set of flags that can be provided to the gst_buffer_copy_into()
400  * function to specify which items should be copied.
401  */
402 typedef enum {
403   GST_BUFFER_COPY_NONE           = 0,
404   GST_BUFFER_COPY_FLAGS          = (1 << 0),
405   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
406   GST_BUFFER_COPY_MEMORY         = (1 << 2),
407   GST_BUFFER_COPY_MERGE          = (1 << 3)
408 } GstBufferCopyFlags;
409
410 /**
411  * GST_BUFFER_COPY_METADATA:
412  *
413  * Combination of all possible metadata fields that can be copied with
414  * gst_buffer_copy_into().
415  */
416 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS)
417
418 /**
419  * GST_BUFFER_COPY_ALL:
420  *
421  * Combination of all possible fields that can be copied with
422  * gst_buffer_copy_into().
423  */
424 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
425
426 /* copies memory or metadata into newly allocated buffer */
427 void            gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
428                                                  GstBufferCopyFlags flags,
429                                                  gsize offset, gsize size);
430
431 /**
432  * gst_buffer_is_writable:
433  * @buf: a #GstBuffer
434  *
435  * Tests if you can safely write data into a buffer's data array or validly
436  * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
437  * writable, but it is only safe to change it when there is only one owner
438  * of the buffer - ie, the refcount is 1.
439  */
440 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
441 /**
442  * gst_buffer_make_writable:
443  * @buf: (transfer full): a #GstBuffer
444  *
445  * Makes a writable buffer from the given buffer. If the source buffer is
446  * already writable, this will simply return the same buffer. A copy will
447  * otherwise be made using gst_buffer_copy().
448  *
449  * Returns: (transfer full): a writable buffer which may or may not be the
450  *     same as @buf
451  */
452 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
453
454 /**
455  * gst_buffer_replace:
456  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
457  *     replaced.
458  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
459  *     replace the buffer pointed to by @obuf.
460  *
461  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
462  * modification is done atomically (so this is useful for ensuring thread safety
463  * in some cases), and the reference counts are updated appropriately (the old
464  * buffer is unreffed, the new is reffed).
465  *
466  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
467  */
468 #ifdef _FOOL_GTK_DOC_
469 G_INLINE_FUNC void gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
470 #endif
471
472 static inline void
473 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
474 {
475   gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
476 }
477
478 /* creating a region */
479 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
480                                                  gsize offset, gsize size);
481
482 /* span, two buffers, intelligently */
483 gboolean        gst_buffer_is_span_fast         (GstBuffer *buf1, GstBuffer *buf2);
484 GstBuffer*      gst_buffer_span                 (GstBuffer *buf1, gsize offset, GstBuffer *buf2, gsize size);
485
486 /* metadata */
487 #include <gst/gstmeta.h>
488
489 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, const GstMetaInfo *info);
490 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
491                                                  gpointer params);
492 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
493
494 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
495
496 /**
497  * gst_value_set_buffer:
498  * @v: a #GValue to receive the data
499  * @b: (transfer none): a #GstBuffer to assign to the GstValue
500  *
501  * Sets @b as the value of @v.  Caller retains reference to buffer.
502  */
503 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
504 /**
505  * gst_value_take_buffer:
506  * @v: a #GValue to receive the data
507  * @b: (transfer full): a #GstBuffer to assign to the GstValue
508  *
509  * Sets @b as the value of @v.  Caller gives away reference to buffer.
510  */
511 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
512 /**
513  * gst_value_get_buffer:
514  * @v: a #GValue to query
515  *
516  * Receives a #GstBuffer as the value of @v. Does not return a reference to
517  * the buffer, so the pointer is only valid for as long as the caller owns
518  * a reference to @v.
519  *
520  * Returns: (transfer none): buffer
521  */
522 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
523
524 G_END_DECLS
525
526 #endif /* __GST_BUFFER_H__ */