Merge branch '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  * GST_BUFFER_DATA:
85  * @buf: a #GstBuffer.
86  *
87  * A pointer to the data element of this buffer.
88  */
89 #define GST_BUFFER_DATA(buf)                    (GST_BUFFER_CAST(buf)->data)
90 /**
91  * GST_BUFFER_SIZE:
92  * @buf: a #GstBuffer.
93  *
94  * The size in bytes of the data in this buffer.
95  */
96 #define GST_BUFFER_SIZE(buf)                    (GST_BUFFER_CAST(buf)->size)
97 /**
98  * GST_BUFFER_TIMESTAMP:
99  * @buf: a #GstBuffer.:
100  *
101  * The timestamp in nanoseconds (as a #GstClockTime) of the data in the buffer.
102  * Value will be %GST_CLOCK_TIME_NONE if the timestamp is unknown.
103  *
104  */
105 #define GST_BUFFER_TIMESTAMP(buf)               (GST_BUFFER_CAST(buf)->timestamp)
106 /**
107  * GST_BUFFER_DURATION:
108  * @buf: a #GstBuffer.
109  *
110  * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
111  * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
112  */
113 #define GST_BUFFER_DURATION(buf)                (GST_BUFFER_CAST(buf)->duration)
114 /**
115  * GST_BUFFER_CAPS:
116  * @buf: a #GstBuffer.
117  *
118  * The caps for this buffer.
119  */
120 #define GST_BUFFER_CAPS(buf)                    (GST_BUFFER_CAST(buf)->caps)
121 /**
122  * GST_BUFFER_OFFSET:
123  * @buf: a #GstBuffer.
124  *
125  * The offset in the source file of the beginning of this buffer.
126  */
127 #define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
128 /**
129  * GST_BUFFER_OFFSET_END:
130  * @buf: a #GstBuffer.
131  *
132  * The offset in the source file of the end of this buffer.
133  */
134 #define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
135 /**
136  * GST_BUFFER_MALLOCDATA:
137  * @buf: a #GstBuffer.
138  *
139  * A pointer to any data allocated for this buffer using g_malloc(). If this is
140  * non-NULL, this memory will be freed at the end of the buffer's lifecycle
141  * (i.e. when its refcount becomes zero).
142  */
143 #define GST_BUFFER_MALLOCDATA(buf)              (GST_BUFFER_CAST(buf)->malloc_data)
144 /**
145  * GST_BUFFER_FREE_FUNC:
146  * @buf: a #GstBuffer.
147  *
148  * A pointer to a function that will be called on the buffer's malloc_data when
149  * this buffer is finalized. Defaults to g_free().
150  *
151  * Note that the free function only affects the buffer's malloc_data; if the
152  * buffer's malloc_data is %NULL, the function will not be called.
153  *
154  * Since: 0.10.22
155  */
156 #define GST_BUFFER_FREE_FUNC(buf)               (GST_BUFFER_CAST(buf)->free_func)
157
158 /**
159  * GST_BUFFER_OFFSET_NONE:
160  *
161  * Constant for no-offset return results.
162  */
163 #define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
164
165 /**
166  * GST_BUFFER_DURATION_IS_VALID:
167  * @buffer: a #GstBuffer
168  *
169  * Tests if the duration is known.
170  */
171 #define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
172 /**
173  * GST_BUFFER_TIMESTAMP_IS_VALID:
174  * @buffer: a #GstBuffer
175  *
176  * Tests if the timestamp is known.
177  */
178 #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
179 /**
180  * GST_BUFFER_OFFSET_IS_VALID:
181  * @buffer: a #GstBuffer
182  *
183  * Tests if the start offset is known.
184  */
185 #define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
186 /**
187  * GST_BUFFER_OFFSET_END_IS_VALID:
188  * @buffer: a #GstBuffer
189  *
190  * Tests if the end offset is known.
191  */
192 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
193 /**
194  * GST_BUFFER_IS_DISCONT:
195  * @buffer: a #GstBuffer
196  *
197  * Tests if the buffer marks a discontinuity in the stream.
198  *
199  * Since: 0.10.9
200  */
201 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
202
203 /**
204  * GstBufferFlag:
205  * the buffer should not be modified. The metadata might still be modified.
206  * @GST_BUFFER_FLAG_PREROLL: the buffer is part of a preroll and should not be
207  * displayed.
208  * @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream.
209  * This typically occurs after a seek or a dropped buffer from a live or
210  * network source.
211  * @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
212  * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
213  * stream and contains media neutral data (elements can switch to optimized code
214  * path that ignores the buffer content).
215  * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
216  * @GST_BUFFER_FLAG_MEDIA1: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
217  * @GST_BUFFER_FLAG_MEDIA2: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
218  * @GST_BUFFER_FLAG_MEDIA3: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
219  * @GST_BUFFER_FLAG_MEDIA4: a flag whose use is specific to the caps of the buffer. Since: 0.10.33.
220  * @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
221  *
222  * A set of buffer flags used to describe properties of a #GstBuffer.
223  */
224 typedef enum {
225   GST_BUFFER_FLAG_PREROLL    = (GST_MINI_OBJECT_FLAG_LAST << 0),
226   GST_BUFFER_FLAG_DISCONT    = (GST_MINI_OBJECT_FLAG_LAST << 1),
227   GST_BUFFER_FLAG_IN_CAPS    = (GST_MINI_OBJECT_FLAG_LAST << 2),
228   GST_BUFFER_FLAG_GAP        = (GST_MINI_OBJECT_FLAG_LAST << 3),
229   GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 4),
230   GST_BUFFER_FLAG_MEDIA1     = (GST_MINI_OBJECT_FLAG_LAST << 5),
231   GST_BUFFER_FLAG_MEDIA2     = (GST_MINI_OBJECT_FLAG_LAST << 6),
232   GST_BUFFER_FLAG_MEDIA3     = (GST_MINI_OBJECT_FLAG_LAST << 7),
233   GST_BUFFER_FLAG_MEDIA4     = (GST_MINI_OBJECT_FLAG_LAST << 8),
234   GST_BUFFER_FLAG_LAST       = (GST_MINI_OBJECT_FLAG_LAST << 16)
235 } GstBufferFlag;
236
237 /**
238  * GstBuffer:
239  * @mini_object: the parent structure
240  * @pool: pointer to the pool owner of the buffer
241  * @caps: the #GstCaps describing the data format in this buffer
242  * @timestamp: timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
243  *     timestamp is not known or relevant.
244  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
245  *     when the duration is not known or relevant.
246  * @offset: a media specific offset for the buffer data.
247  *     For video frames, this is the frame number of this buffer.
248  *     For audio samples, this is the offset of the first sample in this buffer.
249  *     For file data or compressed data this is the byte offset of the first
250  *       byte in this buffer.
251  * @offset_end: the last offset contained in this buffer. It has the same
252  *     format as @offset.
253  *
254  * The structure of a #GstBuffer. Use the associated macros to access the public
255  * variables.
256  */
257 struct _GstBuffer {
258   GstMiniObject          mini_object;
259
260   /*< public >*/ /* with COW */
261   GstBufferPool         *pool;
262   /* the media type of this buffer */
263   GstCaps               *caps;
264
265   /* timestamp */
266   GstClockTime           timestamp;
267   GstClockTime           duration;
268
269   /* media specific offset */
270   guint64                offset;
271   guint64                offset_end;
272 };
273
274 /* allocation */
275 GstBuffer * gst_buffer_new                 (void);
276 GstBuffer * gst_buffer_new_and_alloc       (guint size);
277
278 /* memory blocks */
279 guint       gst_buffer_n_memory            (GstBuffer *buffer);
280 void        gst_buffer_take_memory         (GstBuffer *buffer, GstMemory *mem);
281 GstMemory * gst_buffer_peek_memory         (GstBuffer *buffer, guint idx, GstMapFlags flags);
282 void        gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, guint length);
283
284 /**
285  * gst_buffer_remove_memory:
286  * @b: a #GstBuffer.
287  * @i: an index
288  *
289  * Remove the memory block in @b at @i.
290  */
291 #define     gst_buffer_remove_memory(b,i)  gst_buffer_remove_memory_range ((b), (i), 1)
292
293 void        gst_buffer_fill                (GstBuffer *buffer, gsize offset,
294                                             gconstpointer src, gsize size);
295 void        gst_buffer_extract             (GstBuffer *buffer, gsize offset,
296                                             gpointer dest, gsize size);
297
298 gsize       gst_buffer_get_size            (GstBuffer *buffer);
299 void        gst_buffer_resize              (GstBuffer *buffer, gsize offset, gsize size);
300
301 /**
302  * gst_buffer_remove_memory:
303  * @b: a #GstBuffer.
304  * @s: a new size
305  *
306  * Set the size of @b to @s. This will remove or trim the memory blocks
307  * in the buffer.
308  */
309 #define     gst_buffer_set_size(b,s)       gst_buffer_resize ((b), 0, (s))
310
311 /* getting memory */
312 gpointer    gst_buffer_map                 (GstBuffer *buffer, gsize *size, gsize *maxsize,
313                                             GstMapFlags flags);
314 gboolean    gst_buffer_unmap               (GstBuffer *buffer, gpointer data, gsize size);
315
316 /* refcounting */
317 /**
318  * gst_buffer_ref:
319  * @buf: a #GstBuffer.
320  *
321  * Increases the refcount of the given buffer by one.
322  *
323  * Note that the refcount affects the writeability
324  * of @buf and its metadata, see gst_buffer_is_writable() and
325  * gst_buffer_is_metadata_writable(). It is
326  * important to note that keeping additional references to
327  * GstBuffer instances can potentially increase the number
328  * of memcpy operations in a pipeline.
329  *
330  * Returns: (transfer full): @buf
331  */
332 #ifdef _FOOL_GTK_DOC_
333 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
334 #endif
335
336 static inline GstBuffer *
337 gst_buffer_ref (GstBuffer * buf)
338 {
339   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
340 }
341
342 /**
343  * gst_buffer_unref:
344  * @buf: (transfer full): a #GstBuffer.
345  *
346  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
347  * will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
348  * also be freed at this time.
349  */
350 #ifdef _FOOL_GTK_DOC_
351 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
352 #endif
353
354 static inline void
355 gst_buffer_unref (GstBuffer * buf)
356 {
357   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
358 }
359
360 /* copy buffer */
361 /**
362  * gst_buffer_copy:
363  * @buf: a #GstBuffer.
364  *
365  * Create a copy of the given buffer. This will also make a newly allocated
366  * copy of the data the source buffer contains.
367  *
368  * Returns: (transfer full): a new copy of @buf.
369  */
370 #ifdef _FOOL_GTK_DOC_
371 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
372 #endif
373
374 static inline GstBuffer *
375 gst_buffer_copy (const GstBuffer * buf)
376 {
377   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
378 }
379
380
381 /**
382  * GstBufferCopyFlags:
383  * @GST_BUFFER_COPY_NONE: copy nothing
384  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
385  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer timestamp, duration,
386  * offset and offset_end should be copied
387  * @GST_BUFFER_COPY_CAPS: flag indicating that buffer caps should be copied
388  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
389  * and appended to already existing memory
390  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
391  * merged
392  *
393  * A set of flags that can be provided to the gst_buffer_copy_into()
394  * function to specify which items should be copied.
395  */
396 typedef enum {
397   GST_BUFFER_COPY_NONE           = 0,
398   GST_BUFFER_COPY_FLAGS          = (1 << 0),
399   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
400   GST_BUFFER_COPY_CAPS           = (1 << 2),
401   GST_BUFFER_COPY_MEMORY         = (1 << 3),
402   GST_BUFFER_COPY_MERGE          = (1 << 4)
403 } GstBufferCopyFlags;
404
405 /**
406  * GST_BUFFER_COPY_METADATA:
407  *
408  * Combination of all possible metadata fields that can be copied with
409  * gst_buffer_copy_into().
410  */
411 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS | GST_BUFFER_COPY_CAPS)
412
413 /**
414  * GST_BUFFER_COPY_ALL:
415  *
416  * Combination of all possible fields that can be copied with
417  * gst_buffer_copy_into().
418  */
419 #define GST_BUFFER_COPY_ALL  (GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY)
420
421 /* copies memory or metadata into newly allocated buffer */
422 void            gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
423                                                  GstBufferCopyFlags flags,
424                                                  gsize offset, gsize size);
425
426 /**
427  * gst_buffer_is_writable:
428  * @buf: a #GstBuffer
429  *
430  * Tests if you can safely write data into a buffer's data array or validly
431  * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
432  * writable, but it is only safe to change it when there is only one owner
433  * of the buffer - ie, the refcount is 1.
434  */
435 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
436 /**
437  * gst_buffer_make_writable:
438  * @buf: (transfer full): a #GstBuffer
439  *
440  * Makes a writable buffer from the given buffer. If the source buffer is
441  * already writable, this will simply return the same buffer. A copy will
442  * otherwise be made using gst_buffer_copy().
443  *
444  * Returns: (transfer full): a writable buffer which may or may not be the
445  *     same as @buf
446  */
447 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
448
449 /**
450  * gst_buffer_replace:
451  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
452  *     replaced.
453  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
454  *     replace the buffer pointed to by @obuf.
455  *
456  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
457  * modification is done atomically (so this is useful for ensuring thread safety
458  * in some cases), and the reference counts are updated appropriately (the old
459  * buffer is unreffed, the new is reffed).
460  *
461  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
462  */
463 #define         gst_buffer_replace(obuf,nbuf) \
464 G_STMT_START {                                                                \
465   GstBuffer **___obufaddr = (GstBuffer **)(obuf);         \
466   gst_mini_object_replace ((GstMiniObject **)___obufaddr, \
467       GST_MINI_OBJECT_CAST (nbuf));                       \
468 } G_STMT_END
469
470 GstCaps*        gst_buffer_get_caps             (GstBuffer *buffer);
471 void            gst_buffer_set_caps             (GstBuffer *buffer, GstCaps *caps);
472
473 /* creating a region */
474 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
475                                                  gsize offset, gsize size);
476
477 /* span, two buffers, intelligently */
478 gboolean        gst_buffer_is_span_fast         (GstBuffer *buf1, GstBuffer *buf2);
479 GstBuffer*      gst_buffer_span                 (GstBuffer *buf1, gsize offset, GstBuffer *buf2, gsize size);
480
481 /* metadata */
482 #include <gst/gstmeta.h>
483
484 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, const GstMetaInfo *info);
485 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
486                                                  gpointer params);
487 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
488
489 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
490
491 /**
492  * gst_value_set_buffer:
493  * @v: a #GValue to receive the data
494  * @b: (transfer none): a #GstBuffer to assign to the GstValue
495  *
496  * Sets @b as the value of @v.  Caller retains reference to buffer.
497  */
498 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
499 /**
500  * gst_value_take_buffer:
501  * @v: a #GValue to receive the data
502  * @b: (transfer full): a #GstBuffer to assign to the GstValue
503  *
504  * Sets @b as the value of @v.  Caller gives away reference to buffer.
505  */
506 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
507 /**
508  * gst_value_get_buffer:
509  * @v: a #GValue to query
510  *
511  * Receives a #GstBuffer as the value of @v. Does not return a reference to
512  * the buffer, so the pointer is only valid for as long as the caller owns
513  * a reference to @v.
514  *
515  * Returns: (transfer none): buffer
516  */
517 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
518
519 G_END_DECLS
520
521 #endif /* __GST_BUFFER_H__ */