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>
36 void gst_util_set_value_from_string (GValue *value, const gchar *value_str);
39 void gst_util_set_object_arg (GObject *object, const gchar *name, const gchar *value);
42 gboolean gst_util_set_object_array (GObject * object, const gchar * name,
43 const GValueArray * array);
45 gboolean gst_util_get_object_array (GObject * object, const gchar * name,
46 GValueArray ** array);
48 void gst_util_dump_mem (const guchar *mem, guint size);
51 guint64 gst_util_gdouble_to_guint64 (gdouble value) G_GNUC_CONST;
54 gdouble gst_util_guint64_to_gdouble (guint64 value) G_GNUC_CONST;
57 * gst_guint64_to_gdouble:
58 * @value: the #guint64 value to convert
60 * Convert @value to a gdouble.
62 * Returns: @value converted to a #gdouble.
66 * gst_gdouble_to_guint64:
67 * @value: the #gdouble value to convert
69 * Convert @value to a guint64.
71 * Returns: @value converted to a #guint64.
74 #define gst_gdouble_to_guint64(value) gst_util_gdouble_to_guint64(value)
75 #define gst_guint64_to_gdouble(value) gst_util_guint64_to_gdouble(value)
77 #define gst_gdouble_to_guint64(value) ((guint64) (value))
78 #define gst_guint64_to_gdouble(value) ((gdouble) (value))
82 guint64 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom);
85 guint64 gst_util_uint64_scale_round (guint64 val, guint64 num, guint64 denom);
88 guint64 gst_util_uint64_scale_ceil (guint64 val, guint64 num, guint64 denom);
91 guint64 gst_util_uint64_scale_int (guint64 val, gint num, gint denom);
94 guint64 gst_util_uint64_scale_int_round (guint64 val, gint num, gint denom);
97 guint64 gst_util_uint64_scale_int_ceil (guint64 val, gint num, gint denom);
99 #define GST_SEQNUM_INVALID (0)
102 guint32 gst_util_seqnum_next (void);
105 gint32 gst_util_seqnum_compare (guint32 s1, guint32 s2);
108 guint gst_util_group_id_next (void);
112 * @parent_class_cast: the name of the class cast macro for the parent type
113 * @name: name of the function to call
114 * @args: arguments enclosed in '( )'
116 * Just call the parent handler. This assumes that there is a variable
117 * named parent_class that points to the (duh!) parent class. Note that
118 * this macro is not to be used with things that return something, use
119 * the _WITH_DEFAULT version for that
121 #define GST_CALL_PARENT(parent_class_cast, name, args) \
122 ((parent_class_cast(parent_class)->name != NULL) ? \
123 parent_class_cast(parent_class)->name args : (void) 0)
126 * GST_CALL_PARENT_WITH_DEFAULT:
127 * @parent_class_cast: the name of the class cast macro for the parent type
128 * @name: name of the function to call
129 * @args: arguments enclosed in '( )'
130 * @def_return: default result
132 * Same as GST_CALL_PARENT(), but in case there is no implementation, it
133 * evaluates to @def_return.
135 #define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, def_return)\
136 ((parent_class_cast(parent_class)->name != NULL) ? \
137 parent_class_cast(parent_class)->name args : def_return)
139 /* Define PUT and GET functions for unaligned memory */
140 #define _GST_GET(__data, __idx, __size, __shift) \
141 (((guint##__size) (((const guint8 *) (__data))[__idx])) << (__shift))
143 #define _GST_PUT(__data, __idx, __size, __shift, __num) \
144 (((guint8 *) (__data))[__idx] = (((guint##__size) (__num)) >> (__shift)) & 0xff)
146 #ifndef __GTK_DOC_IGNORE__
147 #if GST_HAVE_UNALIGNED_ACCESS
148 static inline guint16 __gst_fast_read16(const guint8 *v) {
149 return *(const guint16*)(const void*)(v);
151 static inline guint32 __gst_fast_read32(const guint8 *v) {
152 return *(const guint32*)(const void*)(v);
154 static inline guint64 __gst_fast_read64(const guint8 *v) {
155 return *(const guint64*)(const void*)(v);
157 static inline guint16 __gst_fast_read_swap16(const guint8 *v) {
158 return GUINT16_SWAP_LE_BE(*(const guint16*)(const void*)(v));
160 static inline guint32 __gst_fast_read_swap32(const guint8 *v) {
161 return GUINT32_SWAP_LE_BE(*(const guint32*)(const void*)(v));
163 static inline guint64 __gst_fast_read_swap64(const guint8 *v) {
164 return GUINT64_SWAP_LE_BE(*(const guint64*)(const void*)(v));
166 # define _GST_FAST_READ(s, d) __gst_fast_read##s((const guint8 *)(d))
167 # define _GST_FAST_READ_SWAP(s, d) __gst_fast_read_swap##s((const guint8 *)(d))
169 static inline void __gst_fast_write16 (guint8 *p, guint16 v) {
170 *(guint16*)(void*)(p) = v;
172 static inline void __gst_fast_write32 (guint8 *p, guint32 v) {
173 *(guint32*)(void*)(p) = v;
175 static inline void __gst_fast_write64 (guint8 *p, guint64 v) {
176 *(guint64*)(void*)(p) = v;
178 static inline void __gst_fast_write_swap16 (guint8 *p, guint16 v) {
179 *(guint16*)(void*)(p) = GUINT16_SWAP_LE_BE (v);
181 static inline void __gst_fast_write_swap32 (guint8 *p, guint32 v) {
182 *(guint32*)(void*)(p) = GUINT32_SWAP_LE_BE (v);
184 static inline void __gst_fast_write_swap64 (guint8 *p, guint64 v) {
185 *(guint64*)(void*)(p) = GUINT64_SWAP_LE_BE (v);
187 # define _GST_FAST_WRITE(s, d, v) __gst_fast_write##s((guint8 *)(d), (v))
188 # define _GST_FAST_WRITE_SWAP(s, d, v) __gst_fast_write_swap##s((guint8 *)(d), (v))
194 * GST_READ_UINT64_BE:
195 * @data: memory location
197 * Read a 64 bit unsigned integer value in big endian format from the memory buffer.
201 * GST_READ_UINT64_LE:
202 * @data: memory location
204 * Read a 64 bit unsigned integer value in little endian format from the memory buffer.
206 #if GST_HAVE_UNALIGNED_ACCESS
207 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
208 # define GST_READ_UINT64_BE(data) _GST_FAST_READ (64, data)
209 # define GST_READ_UINT64_LE(data) _GST_FAST_READ_SWAP (64, data)
211 # define GST_READ_UINT64_BE(data) _GST_FAST_READ_SWAP (64, data)
212 # define GST_READ_UINT64_LE(data) _GST_FAST_READ (64, data)
215 #define _GST_READ_UINT64_BE(data) (_GST_GET (data, 0, 64, 56) | \
216 _GST_GET (data, 1, 64, 48) | \
217 _GST_GET (data, 2, 64, 40) | \
218 _GST_GET (data, 3, 64, 32) | \
219 _GST_GET (data, 4, 64, 24) | \
220 _GST_GET (data, 5, 64, 16) | \
221 _GST_GET (data, 6, 64, 8) | \
222 _GST_GET (data, 7, 64, 0))
224 #define _GST_READ_UINT64_LE(data) (_GST_GET (data, 7, 64, 56) | \
225 _GST_GET (data, 6, 64, 48) | \
226 _GST_GET (data, 5, 64, 40) | \
227 _GST_GET (data, 4, 64, 32) | \
228 _GST_GET (data, 3, 64, 24) | \
229 _GST_GET (data, 2, 64, 16) | \
230 _GST_GET (data, 1, 64, 8) | \
231 _GST_GET (data, 0, 64, 0))
233 #define GST_READ_UINT64_BE(data) __gst_slow_read64_be((const guint8 *)(data))
234 static inline guint64 __gst_slow_read64_be (const guint8 * data) {
235 return _GST_READ_UINT64_BE (data);
237 #define GST_READ_UINT64_LE(data) __gst_slow_read64_le((const guint8 *)(data))
238 static inline guint64 __gst_slow_read64_le (const guint8 * data) {
239 return _GST_READ_UINT64_LE (data);
244 * GST_READ_UINT32_BE:
245 * @data: memory location
247 * Read a 32 bit unsigned integer value in big endian format from the memory buffer.
251 * GST_READ_UINT32_LE:
252 * @data: memory location
254 * Read a 32 bit unsigned integer value in little endian format from the memory buffer.
256 #if GST_HAVE_UNALIGNED_ACCESS
257 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
258 # define GST_READ_UINT32_BE(data) _GST_FAST_READ (32, data)
259 # define GST_READ_UINT32_LE(data) _GST_FAST_READ_SWAP (32, data)
261 # define GST_READ_UINT32_BE(data) _GST_FAST_READ_SWAP (32, data)
262 # define GST_READ_UINT32_LE(data) _GST_FAST_READ (32, data)
265 #define _GST_READ_UINT32_BE(data) (_GST_GET (data, 0, 32, 24) | \
266 _GST_GET (data, 1, 32, 16) | \
267 _GST_GET (data, 2, 32, 8) | \
268 _GST_GET (data, 3, 32, 0))
270 #define _GST_READ_UINT32_LE(data) (_GST_GET (data, 3, 32, 24) | \
271 _GST_GET (data, 2, 32, 16) | \
272 _GST_GET (data, 1, 32, 8) | \
273 _GST_GET (data, 0, 32, 0))
275 #define GST_READ_UINT32_BE(data) __gst_slow_read32_be((const guint8 *)(data))
276 static inline guint32 __gst_slow_read32_be (const guint8 * data) {
277 return _GST_READ_UINT32_BE (data);
279 #define GST_READ_UINT32_LE(data) __gst_slow_read32_le((const guint8 *)(data))
280 static inline guint32 __gst_slow_read32_le (const guint8 * data) {
281 return _GST_READ_UINT32_LE (data);
286 * GST_READ_UINT24_BE:
287 * @data: memory location
289 * Read a 24 bit unsigned integer value in big endian format from the memory buffer.
291 #define _GST_READ_UINT24_BE(data) (_GST_GET (data, 0, 32, 16) | \
292 _GST_GET (data, 1, 32, 8) | \
293 _GST_GET (data, 2, 32, 0))
295 #define GST_READ_UINT24_BE(data) __gst_slow_read24_be((const guint8 *)(data))
296 static inline guint32 __gst_slow_read24_be (const guint8 * data) {
297 return _GST_READ_UINT24_BE (data);
301 * GST_READ_UINT24_LE:
302 * @data: memory location
304 * Read a 24 bit unsigned integer value in little endian format from the memory buffer.
306 #define _GST_READ_UINT24_LE(data) (_GST_GET (data, 2, 32, 16) | \
307 _GST_GET (data, 1, 32, 8) | \
308 _GST_GET (data, 0, 32, 0))
310 #define GST_READ_UINT24_LE(data) __gst_slow_read24_le((const guint8 *)(data))
311 static inline guint32 __gst_slow_read24_le (const guint8 * data) {
312 return _GST_READ_UINT24_LE (data);
316 * GST_READ_UINT16_BE:
317 * @data: memory location
319 * Read a 16 bit unsigned integer value in big endian format from the memory buffer.
322 * GST_READ_UINT16_LE:
323 * @data: memory location
325 * Read a 16 bit unsigned integer value in little endian format from the memory buffer.
327 #if GST_HAVE_UNALIGNED_ACCESS
328 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
329 # define GST_READ_UINT16_BE(data) _GST_FAST_READ (16, data)
330 # define GST_READ_UINT16_LE(data) _GST_FAST_READ_SWAP (16, data)
332 # define GST_READ_UINT16_BE(data) _GST_FAST_READ_SWAP (16, data)
333 # define GST_READ_UINT16_LE(data) _GST_FAST_READ (16, data)
336 #define _GST_READ_UINT16_BE(data) (_GST_GET (data, 0, 16, 8) | \
337 _GST_GET (data, 1, 16, 0))
339 #define _GST_READ_UINT16_LE(data) (_GST_GET (data, 1, 16, 8) | \
340 _GST_GET (data, 0, 16, 0))
342 #define GST_READ_UINT16_BE(data) __gst_slow_read16_be((const guint8 *)(data))
343 static inline guint16 __gst_slow_read16_be (const guint8 * data) {
344 return _GST_READ_UINT16_BE (data);
346 #define GST_READ_UINT16_LE(data) __gst_slow_read16_le((const guint8 *)(data))
347 static inline guint16 __gst_slow_read16_le (const guint8 * data) {
348 return _GST_READ_UINT16_LE (data);
354 * @data: memory location
356 * Read an 8 bit unsigned integer value from the memory buffer.
358 #define GST_READ_UINT8(data) (_GST_GET (data, 0, 8, 0))
361 * GST_WRITE_UINT64_BE:
362 * @data: memory location
363 * @val: value to store
365 * Store a 64 bit unsigned integer value in big endian format into the memory buffer.
368 * GST_WRITE_UINT64_LE:
369 * @data: memory location
370 * @val: value to store
372 * Store a 64 bit unsigned integer value in little endian format into the memory buffer.
374 #if GST_HAVE_UNALIGNED_ACCESS
375 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
376 # define GST_WRITE_UINT64_BE(data,val) _GST_FAST_WRITE(64,data,val)
377 # define GST_WRITE_UINT64_LE(data,val) _GST_FAST_WRITE_SWAP(64,data,val)
379 # define GST_WRITE_UINT64_BE(data,val) _GST_FAST_WRITE_SWAP(64,data,val)
380 # define GST_WRITE_UINT64_LE(data,val) _GST_FAST_WRITE(64,data,val)
383 #define GST_WRITE_UINT64_BE(data,val) do { \
384 gpointer __put_data = data; \
385 guint64 __put_val = val; \
386 _GST_PUT (__put_data, 0, 64, 56, __put_val); \
387 _GST_PUT (__put_data, 1, 64, 48, __put_val); \
388 _GST_PUT (__put_data, 2, 64, 40, __put_val); \
389 _GST_PUT (__put_data, 3, 64, 32, __put_val); \
390 _GST_PUT (__put_data, 4, 64, 24, __put_val); \
391 _GST_PUT (__put_data, 5, 64, 16, __put_val); \
392 _GST_PUT (__put_data, 6, 64, 8, __put_val); \
393 _GST_PUT (__put_data, 7, 64, 0, __put_val); \
396 #define GST_WRITE_UINT64_LE(data,val) do { \
397 gpointer __put_data = data; \
398 guint64 __put_val = val; \
399 _GST_PUT (__put_data, 0, 64, 0, __put_val); \
400 _GST_PUT (__put_data, 1, 64, 8, __put_val); \
401 _GST_PUT (__put_data, 2, 64, 16, __put_val); \
402 _GST_PUT (__put_data, 3, 64, 24, __put_val); \
403 _GST_PUT (__put_data, 4, 64, 32, __put_val); \
404 _GST_PUT (__put_data, 5, 64, 40, __put_val); \
405 _GST_PUT (__put_data, 6, 64, 48, __put_val); \
406 _GST_PUT (__put_data, 7, 64, 56, __put_val); \
408 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
411 * GST_WRITE_UINT32_BE:
412 * @data: memory location
413 * @val: value to store
415 * Store a 32 bit unsigned integer value in big endian format into the memory buffer.
418 * GST_WRITE_UINT32_LE:
419 * @data: memory location
420 * @val: value to store
422 * Store a 32 bit unsigned integer value in little endian format into the memory buffer.
424 #if GST_HAVE_UNALIGNED_ACCESS
425 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
426 # define GST_WRITE_UINT32_BE(data,val) _GST_FAST_WRITE(32,data,val)
427 # define GST_WRITE_UINT32_LE(data,val) _GST_FAST_WRITE_SWAP(32,data,val)
429 # define GST_WRITE_UINT32_BE(data,val) _GST_FAST_WRITE_SWAP(32,data,val)
430 # define GST_WRITE_UINT32_LE(data,val) _GST_FAST_WRITE(32,data,val)
433 #define GST_WRITE_UINT32_BE(data,val) do { \
434 gpointer __put_data = data; \
435 guint32 __put_val = val; \
436 _GST_PUT (__put_data, 0, 32, 24, __put_val); \
437 _GST_PUT (__put_data, 1, 32, 16, __put_val); \
438 _GST_PUT (__put_data, 2, 32, 8, __put_val); \
439 _GST_PUT (__put_data, 3, 32, 0, __put_val); \
442 #define GST_WRITE_UINT32_LE(data,val) do { \
443 gpointer __put_data = data; \
444 guint32 __put_val = val; \
445 _GST_PUT (__put_data, 0, 32, 0, __put_val); \
446 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
447 _GST_PUT (__put_data, 2, 32, 16, __put_val); \
448 _GST_PUT (__put_data, 3, 32, 24, __put_val); \
450 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
453 * GST_WRITE_UINT24_BE:
454 * @data: memory location
455 * @num: value to store
457 * Store a 24 bit unsigned integer value in big endian format into the memory buffer.
459 #define GST_WRITE_UINT24_BE(data, num) do { \
460 gpointer __put_data = data; \
461 guint32 __put_val = num; \
462 _GST_PUT (__put_data, 0, 32, 16, __put_val); \
463 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
464 _GST_PUT (__put_data, 2, 32, 0, __put_val); \
468 * GST_WRITE_UINT24_LE:
469 * @data: memory location
470 * @num: value to store
472 * Store a 24 bit unsigned integer value in little endian format into the memory buffer.
474 #define GST_WRITE_UINT24_LE(data, num) do { \
475 gpointer __put_data = data; \
476 guint32 __put_val = num; \
477 _GST_PUT (__put_data, 0, 32, 0, __put_val); \
478 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
479 _GST_PUT (__put_data, 2, 32, 16, __put_val); \
483 * GST_WRITE_UINT16_BE:
484 * @data: memory location
485 * @val: value to store
487 * Store a 16 bit unsigned integer value in big endian format into the memory buffer.
490 * GST_WRITE_UINT16_LE:
491 * @data: memory location
492 * @val: value to store
494 * Store a 16 bit unsigned integer value in little endian format into the memory buffer.
496 #if GST_HAVE_UNALIGNED_ACCESS
497 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
498 # define GST_WRITE_UINT16_BE(data,val) _GST_FAST_WRITE(16,data,val)
499 # define GST_WRITE_UINT16_LE(data,val) _GST_FAST_WRITE_SWAP(16,data,val)
501 # define GST_WRITE_UINT16_BE(data,val) _GST_FAST_WRITE_SWAP(16,data,val)
502 # define GST_WRITE_UINT16_LE(data,val) _GST_FAST_WRITE(16,data,val)
505 #define GST_WRITE_UINT16_BE(data,val) do { \
506 gpointer __put_data = data; \
507 guint16 __put_val = val; \
508 _GST_PUT (__put_data, 0, 16, 8, __put_val); \
509 _GST_PUT (__put_data, 1, 16, 0, __put_val); \
512 #define GST_WRITE_UINT16_LE(data,val) do { \
513 gpointer __put_data = data; \
514 guint16 __put_val = val; \
515 _GST_PUT (__put_data, 0, 16, 0, __put_val); \
516 _GST_PUT (__put_data, 1, 16, 8, __put_val); \
518 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
522 * @data: memory location
523 * @num: value to store
525 * Store an 8 bit unsigned integer value into the memory buffer.
527 #define GST_WRITE_UINT8(data, num) do { \
528 _GST_PUT (data, 0, 8, 0, num); \
531 /* Float endianness conversion macros */
533 /* FIXME: Remove this once we depend on a GLib version with this */
534 #ifndef GFLOAT_FROM_LE
539 * Swap byte order of a 32-bit floating point value (float).
541 * Returns: @in byte-swapped.
544 GFLOAT_SWAP_LE_BE(gfloat in)
553 u.i = GUINT32_SWAP_LE_BE (u.i);
558 * GDOUBLE_SWAP_LE_BE:
561 * Swap byte order of a 64-bit floating point value (double).
563 * Returns: @in byte-swapped.
565 static inline gdouble
566 GDOUBLE_SWAP_LE_BE(gdouble in)
575 u.i = GUINT64_SWAP_LE_BE (u.i);
583 * Convert 64-bit floating point value (double) from native byte order into
584 * little endian byte order.
590 * Convert 64-bit floating point value (double) from native byte order into
591 * big endian byte order.
597 * Convert 64-bit floating point value (double) from little endian byte order
598 * into native byte order.
604 * Convert 64-bit floating point value (double) from big endian byte order
605 * into native byte order.
612 * Convert 32-bit floating point value (float) from native byte order into
613 * little endian byte order.
619 * Convert 32-bit floating point value (float) from native byte order into
620 * big endian byte order.
626 * Convert 32-bit floating point value (float) from little endian byte order
627 * into native byte order.
633 * Convert 32-bit floating point value (float) from big endian byte order
634 * into native byte order.
637 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
638 #define GFLOAT_TO_LE(val) ((gfloat) (val))
639 #define GFLOAT_TO_BE(val) (GFLOAT_SWAP_LE_BE (val))
640 #define GDOUBLE_TO_LE(val) ((gdouble) (val))
641 #define GDOUBLE_TO_BE(val) (GDOUBLE_SWAP_LE_BE (val))
643 #elif G_BYTE_ORDER == G_BIG_ENDIAN
644 #define GFLOAT_TO_LE(val) (GFLOAT_SWAP_LE_BE (val))
645 #define GFLOAT_TO_BE(val) ((gfloat) (val))
646 #define GDOUBLE_TO_LE(val) (GDOUBLE_SWAP_LE_BE (val))
647 #define GDOUBLE_TO_BE(val) ((gdouble) (val))
649 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
650 #error unknown ENDIAN type
651 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
653 #define GFLOAT_FROM_LE(val) (GFLOAT_TO_LE (val))
654 #define GFLOAT_FROM_BE(val) (GFLOAT_TO_BE (val))
655 #define GDOUBLE_FROM_LE(val) (GDOUBLE_TO_LE (val))
656 #define GDOUBLE_FROM_BE(val) (GDOUBLE_TO_BE (val))
658 #endif /* !defined(GFLOAT_FROM_LE) */
662 * @data: memory location
664 * Read a 32 bit float value in little endian format from the memory buffer.
666 * Returns: The floating point value read from @data
669 GST_READ_FLOAT_LE(const guint8 *data)
677 u.i = GST_READ_UINT32_LE (data);
683 * @data: memory location
685 * Read a 32 bit float value in big endian format from the memory buffer.
687 * Returns: The floating point value read from @data
690 GST_READ_FLOAT_BE(const guint8 *data)
698 u.i = GST_READ_UINT32_BE (data);
703 * GST_READ_DOUBLE_LE:
704 * @data: memory location
706 * Read a 64 bit double value in little endian format from the memory buffer.
708 * Returns: The double-precision floating point value read from @data
710 static inline gdouble
711 GST_READ_DOUBLE_LE(const guint8 *data)
719 u.i = GST_READ_UINT64_LE (data);
724 * GST_READ_DOUBLE_BE:
725 * @data: memory location
727 * Read a 64 bit double value in big endian format from the memory buffer.
729 * Returns: The double-precision floating point value read from @data
731 static inline gdouble
732 GST_READ_DOUBLE_BE(const guint8 *data)
740 u.i = GST_READ_UINT64_BE (data);
745 * GST_WRITE_FLOAT_LE:
746 * @data: memory location
747 * @num: value to store
749 * Store a 32 bit float value in little endian format into the memory buffer.
752 GST_WRITE_FLOAT_LE(guint8 *data, gfloat num)
761 GST_WRITE_UINT32_LE (data, u.i);
765 * GST_WRITE_FLOAT_BE:
766 * @data: memory location
767 * @num: value to store
769 * Store a 32 bit float value in big endian format into the memory buffer.
772 GST_WRITE_FLOAT_BE(guint8 *data, gfloat num)
781 GST_WRITE_UINT32_BE (data, u.i);
785 * GST_WRITE_DOUBLE_LE:
786 * @data: memory location
787 * @num: value to store
789 * Store a 64 bit double value in little endian format into the memory buffer.
792 GST_WRITE_DOUBLE_LE(guint8 *data, gdouble num)
801 GST_WRITE_UINT64_LE (data, u.i);
805 * GST_WRITE_DOUBLE_BE:
806 * @data: memory location
807 * @num: value to store
809 * Store a 64 bit double value in big endian format into the memory buffer.
812 GST_WRITE_DOUBLE_BE(guint8 *data, gdouble num)
821 GST_WRITE_UINT64_BE (data, u.i);
824 /* Miscellaneous utility macros */
828 * @num: integer value to round up
830 * Rounds an integer value up to the next multiple of 2.
832 #define GST_ROUND_UP_2(num) (((num)+1)&~1)
835 * @num: integer value to round up
837 * Rounds an integer value up to the next multiple of 4.
839 #define GST_ROUND_UP_4(num) (((num)+3)&~3)
842 * @num: integer value to round up
844 * Rounds an integer value up to the next multiple of 8.
846 #define GST_ROUND_UP_8(num) (((num)+7)&~7)
849 * @num: integer value to round up
851 * Rounds an integer value up to the next multiple of 16.
853 #define GST_ROUND_UP_16(num) (((num)+15)&~15)
856 * @num: integer value to round up
858 * Rounds an integer value up to the next multiple of 32.
860 #define GST_ROUND_UP_32(num) (((num)+31)&~31)
863 * @num: integer value to round up
865 * Rounds an integer value up to the next multiple of 64.
867 #define GST_ROUND_UP_64(num) (((num)+63)&~63)
870 * @num: integer value to round up
872 * Rounds an integer value up to the next multiple of 128.
875 #define GST_ROUND_UP_128(num) (((num)+127)&~127)
878 * @num: integrer value to round up
879 * @align: a power of two to round up to
881 * Rounds an integer value up to the next multiple of @align. @align MUST be a
884 #define GST_ROUND_UP_N(num,align) ((((num) + ((align) - 1)) & ~((align) - 1)))
889 * @num: integer value to round down
891 * Rounds an integer value down to the next multiple of 2.
893 #define GST_ROUND_DOWN_2(num) ((num)&(~1))
896 * @num: integer value to round down
898 * Rounds an integer value down to the next multiple of 4.
900 #define GST_ROUND_DOWN_4(num) ((num)&(~3))
903 * @num: integer value to round down
905 * Rounds an integer value down to the next multiple of 8.
907 #define GST_ROUND_DOWN_8(num) ((num)&(~7))
910 * @num: integer value to round down
912 * Rounds an integer value down to the next multiple of 16.
914 #define GST_ROUND_DOWN_16(num) ((num)&(~15))
917 * @num: integer value to round down
919 * Rounds an integer value down to the next multiple of 32.
921 #define GST_ROUND_DOWN_32(num) ((num)&(~31))
924 * @num: integer value to round down
926 * Rounds an integer value down to the next multiple of 64.
928 #define GST_ROUND_DOWN_64(num) ((num)&(~63))
930 * GST_ROUND_DOWN_128:
931 * @num: integer value to round down
933 * Rounds an integer value down to the next multiple of 128.
936 #define GST_ROUND_DOWN_128(num) ((num)&(~127))
939 * @num: integrer value to round down
940 * @align: a power of two to round down to
942 * Rounds an integer value down to the next multiple of @align. @align MUST be a
945 #define GST_ROUND_DOWN_N(num,align) (((num) & ~((align) - 1)))
949 void gst_object_default_error (GstObject * source,
950 const GError * error,
951 const gchar * debug);
953 /* element functions */
956 void gst_element_create_all_pads (GstElement *element);
959 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad,
962 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
965 const gchar* gst_element_state_get_name (GstState state);
968 const gchar * gst_element_state_change_return_get_name (GstStateChangeReturn state_ret);
971 const gchar * gst_state_change_get_name (GstStateChange transition);
974 gboolean gst_element_link (GstElement *src, GstElement *dest);
977 gboolean gst_element_link_many (GstElement *element_1,
978 GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
980 gboolean gst_element_link_filtered (GstElement * src,
984 void gst_element_unlink (GstElement *src, GstElement *dest);
987 void gst_element_unlink_many (GstElement *element_1,
988 GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
990 gboolean gst_element_link_pads (GstElement *src, const gchar *srcpadname,
991 GstElement *dest, const gchar *destpadname);
993 gboolean gst_element_link_pads_full (GstElement *src, const gchar *srcpadname,
994 GstElement *dest, const gchar *destpadname,
995 GstPadLinkCheck flags);
997 void gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
998 GstElement *dest, const gchar *destpadname);
1000 gboolean gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1001 GstElement * dest, const gchar * destpadname,
1004 gboolean gst_element_seek_simple (GstElement *element,
1006 GstSeekFlags seek_flags,
1009 /* util elementfactory functions */
1012 gboolean gst_element_factory_can_sink_all_caps (GstElementFactory *factory, const GstCaps *caps);
1015 gboolean gst_element_factory_can_src_all_caps (GstElementFactory *factory, const GstCaps *caps);
1018 gboolean gst_element_factory_can_sink_any_caps (GstElementFactory *factory, const GstCaps *caps);
1021 gboolean gst_element_factory_can_src_any_caps (GstElementFactory *factory, const GstCaps *caps);
1023 /* util query functions */
1026 gboolean gst_element_query_position (GstElement *element, GstFormat format, gint64 *cur);
1029 gboolean gst_element_query_duration (GstElement *element, GstFormat format, gint64 *duration);
1032 gboolean gst_element_query_convert (GstElement *element, GstFormat src_format, gint64 src_val,
1033 GstFormat dest_format, gint64 *dest_val);
1038 void gst_pad_use_fixed_caps (GstPad *pad);
1041 GstElement* gst_pad_get_parent_element (GstPad *pad);
1043 /* util query functions */
1046 gboolean gst_pad_proxy_query_accept_caps (GstPad *pad, GstQuery *query);
1049 gboolean gst_pad_proxy_query_caps (GstPad *pad, GstQuery *query);
1052 gboolean gst_pad_query_position (GstPad *pad, GstFormat format, gint64 *cur);
1055 gboolean gst_pad_query_duration (GstPad *pad, GstFormat format, gint64 *duration);
1058 gboolean gst_pad_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
1059 GstFormat dest_format, gint64 *dest_val);
1061 GstCaps * gst_pad_query_caps (GstPad *pad, GstCaps *filter);
1064 gboolean gst_pad_query_accept_caps (GstPad *pad, GstCaps *caps);
1067 gboolean gst_pad_link_maybe_ghosting (GstPad *src,
1070 gboolean gst_pad_link_maybe_ghosting_full (GstPad *src,
1072 GstPadLinkCheck flags);
1074 gboolean gst_pad_peer_query_position (GstPad *pad, GstFormat format, gint64 *cur);
1077 gboolean gst_pad_peer_query_duration (GstPad *pad, GstFormat format, gint64 *duration);
1080 gboolean gst_pad_peer_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
1081 GstFormat dest_format, gint64 *dest_val);
1083 GstCaps * gst_pad_peer_query_caps (GstPad * pad, GstCaps *filter);
1086 gboolean gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps *caps);
1089 gchar * gst_pad_create_stream_id (GstPad * pad, GstElement * parent, const gchar *stream_id) G_GNUC_MALLOC;
1092 gchar * gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent, const gchar *stream_id, ...) G_GNUC_PRINTF (3, 4) G_GNUC_MALLOC;
1095 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;
1098 gchar * gst_pad_get_stream_id (GstPad * pad);
1101 GstStream * gst_pad_get_stream (GstPad * pad);
1106 void gst_bin_add_many (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1109 void gst_bin_remove_many (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1112 GstPad * gst_bin_find_unlinked_pad (GstBin *bin, GstPadDirection direction);
1115 gboolean gst_bin_sync_children_states (GstBin *bin);
1117 /* parse utility functions */
1120 GstElement * gst_parse_bin_from_description (const gchar * bin_description,
1121 gboolean ghost_unlinked_pads,
1124 GstElement * gst_parse_bin_from_description_full (const gchar * bin_description,
1125 gboolean ghost_unlinked_pads,
1126 GstParseContext * context,
1127 GstParseFlags flags,
1130 GstClockTime gst_util_get_timestamp (void);
1134 * @GST_SEARCH_MODE_EXACT : Only search for exact matches.
1135 * @GST_SEARCH_MODE_BEFORE: Search for an exact match or the element just before.
1136 * @GST_SEARCH_MODE_AFTER : Search for an exact match or the element just after.
1138 * The different search modes.
1141 GST_SEARCH_MODE_EXACT = 0,
1142 GST_SEARCH_MODE_BEFORE,
1143 GST_SEARCH_MODE_AFTER
1147 gpointer gst_util_array_binary_search (gpointer array, guint num_elements,
1148 gsize element_size, GCompareDataFunc search_func,
1149 GstSearchMode mode, gconstpointer search_data,
1150 gpointer user_data);
1152 /* fraction operations */
1155 gint gst_util_greatest_common_divisor (gint a, gint b);
1158 gint64 gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b);
1161 void gst_util_fraction_to_double (gint src_n, gint src_d, gdouble *dest);
1164 void gst_util_double_to_fraction (gdouble src, gint *dest_n, gint *dest_d);
1167 gboolean gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
1168 gint *res_n, gint *res_d);
1170 gboolean gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d,
1171 gint *res_n, gint *res_d);
1173 gint gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d);
1176 gboolean gst_calculate_linear_regression (const GstClockTime * xy,
1177 GstClockTime * temp, guint n,
1178 GstClockTime * m_num, GstClockTime * m_denom,
1179 GstClockTime * b, GstClockTime * xbase,
1180 gdouble * r_squared);
1185 #endif /* __GST_UTILS_H__ */