2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2002 Thomas Vander Stichele <thomas@apestaart.org>
6 * gstutils.h: Header for various utility functions
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
25 #ifndef __GST_UTILS_H__
26 #define __GST_UTILS_H__
29 #include <gst/gstconfig.h>
30 #include <gst/gstbin.h>
31 #include <gst/gstparse.h>
35 void gst_util_set_value_from_string (GValue *value, const gchar *value_str);
36 void gst_util_set_object_arg (GObject *object, const gchar *name, const gchar *value);
37 gboolean gst_util_set_object_array (GObject * object, const gchar * name,
38 const GValueArray * array);
39 gboolean gst_util_get_object_array (GObject * object, const gchar * name,
40 GValueArray ** array);
41 void gst_util_dump_mem (const guchar *mem, guint size);
43 guint64 gst_util_gdouble_to_guint64 (gdouble value) G_GNUC_CONST;
44 gdouble gst_util_guint64_to_gdouble (guint64 value) G_GNUC_CONST;
47 * gst_guint64_to_gdouble:
48 * @value: the #guint64 value to convert
50 * Convert @value to a gdouble.
52 * Returns: @value converted to a #gdouble.
56 * gst_gdouble_to_guint64:
57 * @value: the #gdouble value to convert
59 * Convert @value to a guint64.
61 * Returns: @value converted to a #guint64.
64 #define gst_gdouble_to_guint64(value) gst_util_gdouble_to_guint64(value)
65 #define gst_guint64_to_gdouble(value) gst_util_guint64_to_gdouble(value)
67 #define gst_gdouble_to_guint64(value) ((guint64) (value))
68 #define gst_guint64_to_gdouble(value) ((gdouble) (value))
71 guint64 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom);
72 guint64 gst_util_uint64_scale_round (guint64 val, guint64 num, guint64 denom);
73 guint64 gst_util_uint64_scale_ceil (guint64 val, guint64 num, guint64 denom);
75 guint64 gst_util_uint64_scale_int (guint64 val, gint num, gint denom);
76 guint64 gst_util_uint64_scale_int_round (guint64 val, gint num, gint denom);
77 guint64 gst_util_uint64_scale_int_ceil (guint64 val, gint num, gint denom);
79 guint32 gst_util_seqnum_next (void);
80 gint32 gst_util_seqnum_compare (guint32 s1, guint32 s2);
82 guint gst_util_group_id_next (void);
86 * @parent_class_cast: the name of the class cast macro for the parent type
87 * @name: name of the function to call
88 * @args: arguments enclosed in '( )'
90 * Just call the parent handler. This assumes that there is a variable
91 * named parent_class that points to the (duh!) parent class. Note that
92 * this macro is not to be used with things that return something, use
93 * the _WITH_DEFAULT version for that
95 #define GST_CALL_PARENT(parent_class_cast, name, args) \
96 ((parent_class_cast(parent_class)->name != NULL) ? \
97 parent_class_cast(parent_class)->name args : (void) 0)
100 * GST_CALL_PARENT_WITH_DEFAULT:
101 * @parent_class_cast: the name of the class cast macro for the parent type
102 * @name: name of the function to call
103 * @args: arguments enclosed in '( )'
104 * @def_return: default result
106 * Same as GST_CALL_PARENT(), but in case there is no implementation, it
107 * evaluates to @def_return.
109 #define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, def_return)\
110 ((parent_class_cast(parent_class)->name != NULL) ? \
111 parent_class_cast(parent_class)->name args : def_return)
113 /* Define PUT and GET functions for unaligned memory */
114 #define _GST_GET(__data, __idx, __size, __shift) \
115 (((guint##__size) (((const guint8 *) (__data))[__idx])) << (__shift))
117 #define _GST_PUT(__data, __idx, __size, __shift, __num) \
118 (((guint8 *) (__data))[__idx] = (((guint##__size) (__num)) >> (__shift)) & 0xff)
120 #ifndef __GTK_DOC_IGNORE__
121 #if GST_HAVE_UNALIGNED_ACCESS
122 static inline guint16 __gst_fast_read16(const guint8 *v) {
123 return *(const guint16*)(const void*)(v);
125 static inline guint32 __gst_fast_read32(const guint8 *v) {
126 return *(const guint32*)(const void*)(v);
128 static inline guint64 __gst_fast_read64(const guint8 *v) {
129 return *(const guint64*)(const void*)(v);
131 static inline guint16 __gst_fast_read_swap16(const guint8 *v) {
132 return GUINT16_SWAP_LE_BE(*(const guint16*)(const void*)(v));
134 static inline guint32 __gst_fast_read_swap32(const guint8 *v) {
135 return GUINT32_SWAP_LE_BE(*(const guint32*)(const void*)(v));
137 static inline guint64 __gst_fast_read_swap64(const guint8 *v) {
138 return GUINT64_SWAP_LE_BE(*(const guint64*)(const void*)(v));
140 # define _GST_FAST_READ(s, d) __gst_fast_read##s((const guint8 *)(d))
141 # define _GST_FAST_READ_SWAP(s, d) __gst_fast_read_swap##s((const guint8 *)(d))
143 static inline void __gst_fast_write16 (guint8 *p, guint16 v) {
144 *(guint16*)(void*)(p) = v;
146 static inline void __gst_fast_write32 (guint8 *p, guint32 v) {
147 *(guint32*)(void*)(p) = v;
149 static inline void __gst_fast_write64 (guint8 *p, guint64 v) {
150 *(guint64*)(void*)(p) = v;
152 static inline void __gst_fast_write_swap16 (guint8 *p, guint16 v) {
153 *(guint16*)(void*)(p) = GUINT16_SWAP_LE_BE (v);
155 static inline void __gst_fast_write_swap32 (guint8 *p, guint32 v) {
156 *(guint32*)(void*)(p) = GUINT32_SWAP_LE_BE (v);
158 static inline void __gst_fast_write_swap64 (guint8 *p, guint64 v) {
159 *(guint64*)(void*)(p) = GUINT64_SWAP_LE_BE (v);
161 # define _GST_FAST_WRITE(s, d, v) __gst_fast_write##s((guint8 *)(d), (v))
162 # define _GST_FAST_WRITE_SWAP(s, d, v) __gst_fast_write_swap##s((guint8 *)(d), (v))
168 * GST_READ_UINT64_BE:
169 * @data: memory location
171 * Read a 64 bit unsigned integer value in big endian format from the memory buffer.
175 * GST_READ_UINT64_LE:
176 * @data: memory location
178 * Read a 64 bit unsigned integer value in little endian format from the memory buffer.
180 #if GST_HAVE_UNALIGNED_ACCESS
181 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
182 # define GST_READ_UINT64_BE(data) _GST_FAST_READ (64, data)
183 # define GST_READ_UINT64_LE(data) _GST_FAST_READ_SWAP (64, data)
185 # define GST_READ_UINT64_BE(data) _GST_FAST_READ_SWAP (64, data)
186 # define GST_READ_UINT64_LE(data) _GST_FAST_READ (64, data)
189 #define _GST_READ_UINT64_BE(data) (_GST_GET (data, 0, 64, 56) | \
190 _GST_GET (data, 1, 64, 48) | \
191 _GST_GET (data, 2, 64, 40) | \
192 _GST_GET (data, 3, 64, 32) | \
193 _GST_GET (data, 4, 64, 24) | \
194 _GST_GET (data, 5, 64, 16) | \
195 _GST_GET (data, 6, 64, 8) | \
196 _GST_GET (data, 7, 64, 0))
198 #define _GST_READ_UINT64_LE(data) (_GST_GET (data, 7, 64, 56) | \
199 _GST_GET (data, 6, 64, 48) | \
200 _GST_GET (data, 5, 64, 40) | \
201 _GST_GET (data, 4, 64, 32) | \
202 _GST_GET (data, 3, 64, 24) | \
203 _GST_GET (data, 2, 64, 16) | \
204 _GST_GET (data, 1, 64, 8) | \
205 _GST_GET (data, 0, 64, 0))
207 #define GST_READ_UINT64_BE(data) __gst_slow_read64_be((const guint8 *)(data))
208 static inline guint64 __gst_slow_read64_be (const guint8 * data) {
209 return _GST_READ_UINT64_BE (data);
211 #define GST_READ_UINT64_LE(data) __gst_slow_read64_le((const guint8 *)(data))
212 static inline guint64 __gst_slow_read64_le (const guint8 * data) {
213 return _GST_READ_UINT64_LE (data);
218 * GST_READ_UINT32_BE:
219 * @data: memory location
221 * Read a 32 bit unsigned integer value in big endian format from the memory buffer.
225 * GST_READ_UINT32_LE:
226 * @data: memory location
228 * Read a 32 bit unsigned integer value in little endian format from the memory buffer.
230 #if GST_HAVE_UNALIGNED_ACCESS
231 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
232 # define GST_READ_UINT32_BE(data) _GST_FAST_READ (32, data)
233 # define GST_READ_UINT32_LE(data) _GST_FAST_READ_SWAP (32, data)
235 # define GST_READ_UINT32_BE(data) _GST_FAST_READ_SWAP (32, data)
236 # define GST_READ_UINT32_LE(data) _GST_FAST_READ (32, data)
239 #define _GST_READ_UINT32_BE(data) (_GST_GET (data, 0, 32, 24) | \
240 _GST_GET (data, 1, 32, 16) | \
241 _GST_GET (data, 2, 32, 8) | \
242 _GST_GET (data, 3, 32, 0))
244 #define _GST_READ_UINT32_LE(data) (_GST_GET (data, 3, 32, 24) | \
245 _GST_GET (data, 2, 32, 16) | \
246 _GST_GET (data, 1, 32, 8) | \
247 _GST_GET (data, 0, 32, 0))
249 #define GST_READ_UINT32_BE(data) __gst_slow_read32_be((const guint8 *)(data))
250 static inline guint32 __gst_slow_read32_be (const guint8 * data) {
251 return _GST_READ_UINT32_BE (data);
253 #define GST_READ_UINT32_LE(data) __gst_slow_read32_le((const guint8 *)(data))
254 static inline guint32 __gst_slow_read32_le (const guint8 * data) {
255 return _GST_READ_UINT32_LE (data);
260 * GST_READ_UINT24_BE:
261 * @data: memory location
263 * Read a 24 bit unsigned integer value in big endian format from the memory buffer.
265 #define _GST_READ_UINT24_BE(data) (_GST_GET (data, 0, 32, 16) | \
266 _GST_GET (data, 1, 32, 8) | \
267 _GST_GET (data, 2, 32, 0))
269 #define GST_READ_UINT24_BE(data) __gst_slow_read24_be((const guint8 *)(data))
270 static inline guint32 __gst_slow_read24_be (const guint8 * data) {
271 return _GST_READ_UINT24_BE (data);
275 * GST_READ_UINT24_LE:
276 * @data: memory location
278 * Read a 24 bit unsigned integer value in little endian format from the memory buffer.
280 #define _GST_READ_UINT24_LE(data) (_GST_GET (data, 2, 32, 16) | \
281 _GST_GET (data, 1, 32, 8) | \
282 _GST_GET (data, 0, 32, 0))
284 #define GST_READ_UINT24_LE(data) __gst_slow_read24_le((const guint8 *)(data))
285 static inline guint32 __gst_slow_read24_le (const guint8 * data) {
286 return _GST_READ_UINT24_LE (data);
290 * GST_READ_UINT16_BE:
291 * @data: memory location
293 * Read a 16 bit unsigned integer value in big endian format from the memory buffer.
296 * GST_READ_UINT16_LE:
297 * @data: memory location
299 * Read a 16 bit unsigned integer value in little endian format from the memory buffer.
301 #if GST_HAVE_UNALIGNED_ACCESS
302 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
303 # define GST_READ_UINT16_BE(data) _GST_FAST_READ (16, data)
304 # define GST_READ_UINT16_LE(data) _GST_FAST_READ_SWAP (16, data)
306 # define GST_READ_UINT16_BE(data) _GST_FAST_READ_SWAP (16, data)
307 # define GST_READ_UINT16_LE(data) _GST_FAST_READ (16, data)
310 #define _GST_READ_UINT16_BE(data) (_GST_GET (data, 0, 16, 8) | \
311 _GST_GET (data, 1, 16, 0))
313 #define _GST_READ_UINT16_LE(data) (_GST_GET (data, 1, 16, 8) | \
314 _GST_GET (data, 0, 16, 0))
316 #define GST_READ_UINT16_BE(data) __gst_slow_read16_be((const guint8 *)(data))
317 static inline guint16 __gst_slow_read16_be (const guint8 * data) {
318 return _GST_READ_UINT16_BE (data);
320 #define GST_READ_UINT16_LE(data) __gst_slow_read16_le((const guint8 *)(data))
321 static inline guint16 __gst_slow_read16_le (const guint8 * data) {
322 return _GST_READ_UINT16_LE (data);
328 * @data: memory location
330 * Read an 8 bit unsigned integer value from the memory buffer.
332 #define GST_READ_UINT8(data) (_GST_GET (data, 0, 8, 0))
335 * GST_WRITE_UINT64_BE:
336 * @data: memory location
337 * @val: value to store
339 * Store a 64 bit unsigned integer value in big endian format into the memory buffer.
342 * GST_WRITE_UINT64_LE:
343 * @data: memory location
344 * @val: value to store
346 * Store a 64 bit unsigned integer value in little endian format into the memory buffer.
348 #if GST_HAVE_UNALIGNED_ACCESS
349 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
350 # define GST_WRITE_UINT64_BE(data,val) _GST_FAST_WRITE(64,data,val)
351 # define GST_WRITE_UINT64_LE(data,val) _GST_FAST_WRITE_SWAP(64,data,val)
353 # define GST_WRITE_UINT64_BE(data,val) _GST_FAST_WRITE_SWAP(64,data,val)
354 # define GST_WRITE_UINT64_LE(data,val) _GST_FAST_WRITE(64,data,val)
357 #define GST_WRITE_UINT64_BE(data,val) do { \
358 gpointer __put_data = data; \
359 guint64 __put_val = val; \
360 _GST_PUT (__put_data, 0, 64, 56, __put_val); \
361 _GST_PUT (__put_data, 1, 64, 48, __put_val); \
362 _GST_PUT (__put_data, 2, 64, 40, __put_val); \
363 _GST_PUT (__put_data, 3, 64, 32, __put_val); \
364 _GST_PUT (__put_data, 4, 64, 24, __put_val); \
365 _GST_PUT (__put_data, 5, 64, 16, __put_val); \
366 _GST_PUT (__put_data, 6, 64, 8, __put_val); \
367 _GST_PUT (__put_data, 7, 64, 0, __put_val); \
370 #define GST_WRITE_UINT64_LE(data,val) do { \
371 gpointer __put_data = data; \
372 guint64 __put_val = val; \
373 _GST_PUT (__put_data, 0, 64, 0, __put_val); \
374 _GST_PUT (__put_data, 1, 64, 8, __put_val); \
375 _GST_PUT (__put_data, 2, 64, 16, __put_val); \
376 _GST_PUT (__put_data, 3, 64, 24, __put_val); \
377 _GST_PUT (__put_data, 4, 64, 32, __put_val); \
378 _GST_PUT (__put_data, 5, 64, 40, __put_val); \
379 _GST_PUT (__put_data, 6, 64, 48, __put_val); \
380 _GST_PUT (__put_data, 7, 64, 56, __put_val); \
382 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
385 * GST_WRITE_UINT32_BE:
386 * @data: memory location
387 * @val: value to store
389 * Store a 32 bit unsigned integer value in big endian format into the memory buffer.
392 * GST_WRITE_UINT32_LE:
393 * @data: memory location
394 * @val: value to store
396 * Store a 32 bit unsigned integer value in little endian format into the memory buffer.
398 #if GST_HAVE_UNALIGNED_ACCESS
399 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
400 # define GST_WRITE_UINT32_BE(data,val) _GST_FAST_WRITE(32,data,val)
401 # define GST_WRITE_UINT32_LE(data,val) _GST_FAST_WRITE_SWAP(32,data,val)
403 # define GST_WRITE_UINT32_BE(data,val) _GST_FAST_WRITE_SWAP(32,data,val)
404 # define GST_WRITE_UINT32_LE(data,val) _GST_FAST_WRITE(32,data,val)
407 #define GST_WRITE_UINT32_BE(data,val) do { \
408 gpointer __put_data = data; \
409 guint32 __put_val = val; \
410 _GST_PUT (__put_data, 0, 32, 24, __put_val); \
411 _GST_PUT (__put_data, 1, 32, 16, __put_val); \
412 _GST_PUT (__put_data, 2, 32, 8, __put_val); \
413 _GST_PUT (__put_data, 3, 32, 0, __put_val); \
416 #define GST_WRITE_UINT32_LE(data,val) do { \
417 gpointer __put_data = data; \
418 guint32 __put_val = val; \
419 _GST_PUT (__put_data, 0, 32, 0, __put_val); \
420 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
421 _GST_PUT (__put_data, 2, 32, 16, __put_val); \
422 _GST_PUT (__put_data, 3, 32, 24, __put_val); \
424 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
427 * GST_WRITE_UINT24_BE:
428 * @data: memory location
429 * @num: value to store
431 * Store a 24 bit unsigned integer value in big endian format into the memory buffer.
433 #define GST_WRITE_UINT24_BE(data, num) do { \
434 gpointer __put_data = data; \
435 guint32 __put_val = num; \
436 _GST_PUT (__put_data, 0, 32, 16, __put_val); \
437 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
438 _GST_PUT (__put_data, 2, 32, 0, __put_val); \
442 * GST_WRITE_UINT24_LE:
443 * @data: memory location
444 * @num: value to store
446 * Store a 24 bit unsigned integer value in little endian format into the memory buffer.
448 #define GST_WRITE_UINT24_LE(data, num) do { \
449 gpointer __put_data = data; \
450 guint32 __put_val = num; \
451 _GST_PUT (__put_data, 0, 32, 0, __put_val); \
452 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
453 _GST_PUT (__put_data, 2, 32, 16, __put_val); \
457 * GST_WRITE_UINT16_BE:
458 * @data: memory location
459 * @val: value to store
461 * Store a 16 bit unsigned integer value in big endian format into the memory buffer.
464 * GST_WRITE_UINT16_LE:
465 * @data: memory location
466 * @val: value to store
468 * Store a 16 bit unsigned integer value in little endian format into the memory buffer.
470 #if GST_HAVE_UNALIGNED_ACCESS
471 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
472 # define GST_WRITE_UINT16_BE(data,val) _GST_FAST_WRITE(16,data,val)
473 # define GST_WRITE_UINT16_LE(data,val) _GST_FAST_WRITE_SWAP(16,data,val)
475 # define GST_WRITE_UINT16_BE(data,val) _GST_FAST_WRITE_SWAP(16,data,val)
476 # define GST_WRITE_UINT16_LE(data,val) _GST_FAST_WRITE(16,data,val)
479 #define GST_WRITE_UINT16_BE(data,val) do { \
480 gpointer __put_data = data; \
481 guint16 __put_val = val; \
482 _GST_PUT (__put_data, 0, 16, 8, __put_val); \
483 _GST_PUT (__put_data, 1, 16, 0, __put_val); \
486 #define GST_WRITE_UINT16_LE(data,val) do { \
487 gpointer __put_data = data; \
488 guint16 __put_val = val; \
489 _GST_PUT (__put_data, 0, 16, 0, __put_val); \
490 _GST_PUT (__put_data, 1, 16, 8, __put_val); \
492 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
496 * @data: memory location
497 * @num: value to store
499 * Store an 8 bit unsigned integer value into the memory buffer.
501 #define GST_WRITE_UINT8(data, num) do { \
502 _GST_PUT (data, 0, 8, 0, num); \
505 /* Float endianness conversion macros */
507 /* FIXME: Remove this once we depend on a GLib version with this */
508 #ifndef GFLOAT_FROM_LE
513 * Swap byte order of a 32-bit floating point value (float).
515 * Returns: @in byte-swapped.
518 GFLOAT_SWAP_LE_BE(gfloat in)
527 u.i = GUINT32_SWAP_LE_BE (u.i);
532 * GDOUBLE_SWAP_LE_BE:
535 * Swap byte order of a 64-bit floating point value (double).
537 * Returns: @in byte-swapped.
539 static inline gdouble
540 GDOUBLE_SWAP_LE_BE(gdouble in)
549 u.i = GUINT64_SWAP_LE_BE (u.i);
557 * Convert 64-bit floating point value (double) from native byte order into
558 * little endian byte order.
564 * Convert 64-bit floating point value (double) from native byte order into
565 * big endian byte order.
571 * Convert 64-bit floating point value (double) from little endian byte order
572 * into native byte order.
578 * Convert 64-bit floating point value (double) from big endian byte order
579 * into native byte order.
586 * Convert 32-bit floating point value (float) from native byte order into
587 * little endian byte order.
593 * Convert 32-bit floating point value (float) from native byte order into
594 * big endian byte order.
600 * Convert 32-bit floating point value (float) from little endian byte order
601 * into native byte order.
607 * Convert 32-bit floating point value (float) from big endian byte order
608 * into native byte order.
611 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
612 #define GFLOAT_TO_LE(val) ((gfloat) (val))
613 #define GFLOAT_TO_BE(val) (GFLOAT_SWAP_LE_BE (val))
614 #define GDOUBLE_TO_LE(val) ((gdouble) (val))
615 #define GDOUBLE_TO_BE(val) (GDOUBLE_SWAP_LE_BE (val))
617 #elif G_BYTE_ORDER == G_BIG_ENDIAN
618 #define GFLOAT_TO_LE(val) (GFLOAT_SWAP_LE_BE (val))
619 #define GFLOAT_TO_BE(val) ((gfloat) (val))
620 #define GDOUBLE_TO_LE(val) (GDOUBLE_SWAP_LE_BE (val))
621 #define GDOUBLE_TO_BE(val) ((gdouble) (val))
623 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
624 #error unknown ENDIAN type
625 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
627 #define GFLOAT_FROM_LE(val) (GFLOAT_TO_LE (val))
628 #define GFLOAT_FROM_BE(val) (GFLOAT_TO_BE (val))
629 #define GDOUBLE_FROM_LE(val) (GDOUBLE_TO_LE (val))
630 #define GDOUBLE_FROM_BE(val) (GDOUBLE_TO_BE (val))
632 #endif /* !defined(GFLOAT_FROM_LE) */
636 * @data: memory location
638 * Read a 32 bit float value in little endian format from the memory buffer.
640 * Returns: The floating point value read from @data
643 GST_READ_FLOAT_LE(const guint8 *data)
651 u.i = GST_READ_UINT32_LE (data);
657 * @data: memory location
659 * Read a 32 bit float value in big endian format from the memory buffer.
661 * Returns: The floating point value read from @data
664 GST_READ_FLOAT_BE(const guint8 *data)
672 u.i = GST_READ_UINT32_BE (data);
677 * GST_READ_DOUBLE_LE:
678 * @data: memory location
680 * Read a 64 bit double value in little endian format from the memory buffer.
682 * Returns: The double-precision floating point value read from @data
684 static inline gdouble
685 GST_READ_DOUBLE_LE(const guint8 *data)
693 u.i = GST_READ_UINT64_LE (data);
698 * GST_READ_DOUBLE_BE:
699 * @data: memory location
701 * Read a 64 bit double value in big endian format from the memory buffer.
703 * Returns: The double-precision floating point value read from @data
705 static inline gdouble
706 GST_READ_DOUBLE_BE(const guint8 *data)
714 u.i = GST_READ_UINT64_BE (data);
719 * GST_WRITE_FLOAT_LE:
720 * @data: memory location
721 * @num: value to store
723 * Store a 32 bit float value in little endian format into the memory buffer.
726 GST_WRITE_FLOAT_LE(guint8 *data, gfloat num)
735 GST_WRITE_UINT32_LE (data, u.i);
739 * GST_WRITE_FLOAT_BE:
740 * @data: memory location
741 * @num: value to store
743 * Store a 32 bit float value in big endian format into the memory buffer.
746 GST_WRITE_FLOAT_BE(guint8 *data, gfloat num)
755 GST_WRITE_UINT32_BE (data, u.i);
759 * GST_WRITE_DOUBLE_LE:
760 * @data: memory location
761 * @num: value to store
763 * Store a 64 bit double value in little endian format into the memory buffer.
766 GST_WRITE_DOUBLE_LE(guint8 *data, gdouble num)
775 GST_WRITE_UINT64_LE (data, u.i);
779 * GST_WRITE_DOUBLE_BE:
780 * @data: memory location
781 * @num: value to store
783 * Store a 64 bit double value in big endian format into the memory buffer.
786 GST_WRITE_DOUBLE_BE(guint8 *data, gdouble num)
795 GST_WRITE_UINT64_BE (data, u.i);
798 /* Miscellaneous utility macros */
802 * @num: integer value to round up
804 * Rounds an integer value up to the next multiple of 2.
806 #define GST_ROUND_UP_2(num) (((num)+1)&~1)
809 * @num: integer value to round up
811 * Rounds an integer value up to the next multiple of 4.
813 #define GST_ROUND_UP_4(num) (((num)+3)&~3)
816 * @num: integer value to round up
818 * Rounds an integer value up to the next multiple of 8.
820 #define GST_ROUND_UP_8(num) (((num)+7)&~7)
823 * @num: integer value to round up
825 * Rounds an integer value up to the next multiple of 16.
827 #define GST_ROUND_UP_16(num) (((num)+15)&~15)
830 * @num: integer value to round up
832 * Rounds an integer value up to the next multiple of 32.
834 #define GST_ROUND_UP_32(num) (((num)+31)&~31)
837 * @num: integer value to round up
839 * Rounds an integer value up to the next multiple of 64.
841 #define GST_ROUND_UP_64(num) (((num)+63)&~63)
844 * @num: integer value to round up
846 * Rounds an integer value up to the next multiple of 128.
849 #define GST_ROUND_UP_128(num) (((num)+127)&~127)
852 * @num: integrer value to round up
853 * @align: a power of two to round up to
855 * Rounds an integer value up to the next multiple of @align. @align MUST be a
858 #define GST_ROUND_UP_N(num,align) ((((num) + ((align) - 1)) & ~((align) - 1)))
863 * @num: integer value to round down
865 * Rounds an integer value down to the next multiple of 2.
867 #define GST_ROUND_DOWN_2(num) ((num)&(~1))
870 * @num: integer value to round down
872 * Rounds an integer value down to the next multiple of 4.
874 #define GST_ROUND_DOWN_4(num) ((num)&(~3))
877 * @num: integer value to round down
879 * Rounds an integer value down to the next multiple of 8.
881 #define GST_ROUND_DOWN_8(num) ((num)&(~7))
884 * @num: integer value to round down
886 * Rounds an integer value down to the next multiple of 16.
888 #define GST_ROUND_DOWN_16(num) ((num)&(~15))
891 * @num: integer value to round down
893 * Rounds an integer value down to the next multiple of 32.
895 #define GST_ROUND_DOWN_32(num) ((num)&(~31))
898 * @num: integer value to round down
900 * Rounds an integer value down to the next multiple of 64.
902 #define GST_ROUND_DOWN_64(num) ((num)&(~63))
904 * GST_ROUND_DOWN_128:
905 * @num: integer value to round down
907 * Rounds an integer value down to the next multiple of 128.
910 #define GST_ROUND_DOWN_128(num) ((num)&(~127))
913 * @num: integrer value to round down
914 * @align: a power of two to round down to
916 * Rounds an integer value down to the next multiple of @align. @align MUST be a
919 #define GST_ROUND_DOWN_N(num,align) (((num) & ~((align) - 1)))
922 void gst_object_default_error (GstObject * source,
923 const GError * error,
924 const gchar * debug);
926 /* element functions */
927 void gst_element_create_all_pads (GstElement *element);
928 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad,
931 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
933 const gchar* gst_element_state_get_name (GstState state);
934 const gchar * gst_element_state_change_return_get_name (GstStateChangeReturn state_ret);
936 gboolean gst_element_link (GstElement *src, GstElement *dest);
937 gboolean gst_element_link_many (GstElement *element_1,
938 GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
939 gboolean gst_element_link_filtered (GstElement * src,
942 void gst_element_unlink (GstElement *src, GstElement *dest);
943 void gst_element_unlink_many (GstElement *element_1,
944 GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
946 gboolean gst_element_link_pads (GstElement *src, const gchar *srcpadname,
947 GstElement *dest, const gchar *destpadname);
948 gboolean gst_element_link_pads_full (GstElement *src, const gchar *srcpadname,
949 GstElement *dest, const gchar *destpadname,
950 GstPadLinkCheck flags);
951 void gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
952 GstElement *dest, const gchar *destpadname);
954 gboolean gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
955 GstElement * dest, const gchar * destpadname,
958 gboolean gst_element_seek_simple (GstElement *element,
960 GstSeekFlags seek_flags,
963 /* util elementfactory functions */
964 gboolean gst_element_factory_can_sink_all_caps (GstElementFactory *factory, const GstCaps *caps);
965 gboolean gst_element_factory_can_src_all_caps (GstElementFactory *factory, const GstCaps *caps);
966 gboolean gst_element_factory_can_sink_any_caps (GstElementFactory *factory, const GstCaps *caps);
967 gboolean gst_element_factory_can_src_any_caps (GstElementFactory *factory, const GstCaps *caps);
969 /* util query functions */
970 gboolean gst_element_query_position (GstElement *element, GstFormat format, gint64 *cur);
971 gboolean gst_element_query_duration (GstElement *element, GstFormat format, gint64 *duration);
972 gboolean gst_element_query_convert (GstElement *element, GstFormat src_format, gint64 src_val,
973 GstFormat dest_format, gint64 *dest_val);
974 #ifdef TIZEN_PROFILE_TV
975 gboolean gst_element_query_resource (GstElement *element, GList **resource_list);
980 void gst_pad_use_fixed_caps (GstPad *pad);
981 GstElement* gst_pad_get_parent_element (GstPad *pad);
983 /* util query functions */
984 gboolean gst_pad_proxy_query_accept_caps (GstPad *pad, GstQuery *query);
985 gboolean gst_pad_proxy_query_caps (GstPad *pad, GstQuery *query);
987 gboolean gst_pad_query_position (GstPad *pad, GstFormat format, gint64 *cur);
988 gboolean gst_pad_query_duration (GstPad *pad, GstFormat format, gint64 *duration);
989 gboolean gst_pad_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
990 GstFormat dest_format, gint64 *dest_val);
991 GstCaps * gst_pad_query_caps (GstPad *pad, GstCaps *filter);
992 gboolean gst_pad_query_accept_caps (GstPad *pad, GstCaps *caps);
994 gboolean gst_pad_link_maybe_ghosting (GstPad *src,
996 gboolean gst_pad_link_maybe_ghosting_full (GstPad *src,
998 GstPadLinkCheck flags);
1000 gboolean gst_pad_peer_query_position (GstPad *pad, GstFormat format, gint64 *cur);
1001 gboolean gst_pad_peer_query_duration (GstPad *pad, GstFormat format, gint64 *duration);
1002 gboolean gst_pad_peer_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
1003 GstFormat dest_format, gint64 *dest_val);
1004 GstCaps * gst_pad_peer_query_caps (GstPad * pad, GstCaps *filter);
1005 gboolean gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps *caps);
1007 gchar * gst_pad_create_stream_id (GstPad * pad, GstElement * parent, const gchar *stream_id) G_GNUC_MALLOC;
1008 gchar * gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent, const gchar *stream_id, ...) G_GNUC_PRINTF (3, 4) G_GNUC_MALLOC;
1009 gchar * gst_pad_create_stream_id_printf_valist (GstPad * pad, GstElement * parent, const gchar *stream_id, va_list var_args) G_GNUC_PRINTF (3, 0) G_GNUC_MALLOC;
1011 gchar * gst_pad_get_stream_id (GstPad * pad);
1012 GstStream * gst_pad_get_stream (GstPad * pad);
1015 void gst_bin_add_many (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1016 void gst_bin_remove_many (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1017 GstPad * gst_bin_find_unlinked_pad (GstBin *bin, GstPadDirection direction);
1019 gboolean gst_bin_sync_children_states (GstBin *bin);
1021 /* parse utility functions */
1022 GstElement * gst_parse_bin_from_description (const gchar * bin_description,
1023 gboolean ghost_unlinked_pads,
1026 GstElement * gst_parse_bin_from_description_full (const gchar * bin_description,
1027 gboolean ghost_unlinked_pads,
1028 GstParseContext * context,
1029 GstParseFlags flags,
1032 GstClockTime gst_util_get_timestamp (void);
1036 * @GST_SEARCH_MODE_EXACT : Only search for exact matches.
1037 * @GST_SEARCH_MODE_BEFORE: Search for an exact match or the element just before.
1038 * @GST_SEARCH_MODE_AFTER : Search for an exact match or the element just after.
1040 * The different search modes.
1043 GST_SEARCH_MODE_EXACT = 0,
1044 GST_SEARCH_MODE_BEFORE,
1045 GST_SEARCH_MODE_AFTER
1048 gpointer gst_util_array_binary_search (gpointer array, guint num_elements,
1049 gsize element_size, GCompareDataFunc search_func,
1050 GstSearchMode mode, gconstpointer search_data,
1051 gpointer user_data);
1053 /* fraction operations */
1054 gint gst_util_greatest_common_divisor (gint a, gint b);
1055 gint64 gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b);
1057 void gst_util_fraction_to_double (gint src_n, gint src_d, gdouble *dest);
1058 void gst_util_double_to_fraction (gdouble src, gint *dest_n, gint *dest_d);
1060 gboolean gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
1061 gint *res_n, gint *res_d);
1062 gboolean gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d,
1063 gint *res_n, gint *res_d);
1064 gint gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d);
1066 gboolean gst_calculate_linear_regression (const GstClockTime * xy,
1067 GstClockTime * temp, guint n,
1068 GstClockTime * m_num, GstClockTime * m_denom,
1069 GstClockTime * b, GstClockTime * xbase,
1070 gdouble * r_squared);
1073 #ifdef TIZEN_PROFILE_TV
1074 void gst_set_family_id_to_child (GstElement* child, int id);
1078 #endif /* __GST_UTILS_H__ */