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);
100 guint32 gst_util_seqnum_next (void);
103 gint32 gst_util_seqnum_compare (guint32 s1, guint32 s2);
106 guint gst_util_group_id_next (void);
110 * @parent_class_cast: the name of the class cast macro for the parent type
111 * @name: name of the function to call
112 * @args: arguments enclosed in '( )'
114 * Just call the parent handler. This assumes that there is a variable
115 * named parent_class that points to the (duh!) parent class. Note that
116 * this macro is not to be used with things that return something, use
117 * the _WITH_DEFAULT version for that
119 #define GST_CALL_PARENT(parent_class_cast, name, args) \
120 ((parent_class_cast(parent_class)->name != NULL) ? \
121 parent_class_cast(parent_class)->name args : (void) 0)
124 * GST_CALL_PARENT_WITH_DEFAULT:
125 * @parent_class_cast: the name of the class cast macro for the parent type
126 * @name: name of the function to call
127 * @args: arguments enclosed in '( )'
128 * @def_return: default result
130 * Same as GST_CALL_PARENT(), but in case there is no implementation, it
131 * evaluates to @def_return.
133 #define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, def_return)\
134 ((parent_class_cast(parent_class)->name != NULL) ? \
135 parent_class_cast(parent_class)->name args : def_return)
137 /* Define PUT and GET functions for unaligned memory */
138 #define _GST_GET(__data, __idx, __size, __shift) \
139 (((guint##__size) (((const guint8 *) (__data))[__idx])) << (__shift))
141 #define _GST_PUT(__data, __idx, __size, __shift, __num) \
142 (((guint8 *) (__data))[__idx] = (((guint##__size) (__num)) >> (__shift)) & 0xff)
144 #ifndef __GTK_DOC_IGNORE__
145 #if GST_HAVE_UNALIGNED_ACCESS
146 static inline guint16 __gst_fast_read16(const guint8 *v) {
147 return *(const guint16*)(const void*)(v);
149 static inline guint32 __gst_fast_read32(const guint8 *v) {
150 return *(const guint32*)(const void*)(v);
152 static inline guint64 __gst_fast_read64(const guint8 *v) {
153 return *(const guint64*)(const void*)(v);
155 static inline guint16 __gst_fast_read_swap16(const guint8 *v) {
156 return GUINT16_SWAP_LE_BE(*(const guint16*)(const void*)(v));
158 static inline guint32 __gst_fast_read_swap32(const guint8 *v) {
159 return GUINT32_SWAP_LE_BE(*(const guint32*)(const void*)(v));
161 static inline guint64 __gst_fast_read_swap64(const guint8 *v) {
162 return GUINT64_SWAP_LE_BE(*(const guint64*)(const void*)(v));
164 # define _GST_FAST_READ(s, d) __gst_fast_read##s((const guint8 *)(d))
165 # define _GST_FAST_READ_SWAP(s, d) __gst_fast_read_swap##s((const guint8 *)(d))
167 static inline void __gst_fast_write16 (guint8 *p, guint16 v) {
168 *(guint16*)(void*)(p) = v;
170 static inline void __gst_fast_write32 (guint8 *p, guint32 v) {
171 *(guint32*)(void*)(p) = v;
173 static inline void __gst_fast_write64 (guint8 *p, guint64 v) {
174 *(guint64*)(void*)(p) = v;
176 static inline void __gst_fast_write_swap16 (guint8 *p, guint16 v) {
177 *(guint16*)(void*)(p) = GUINT16_SWAP_LE_BE (v);
179 static inline void __gst_fast_write_swap32 (guint8 *p, guint32 v) {
180 *(guint32*)(void*)(p) = GUINT32_SWAP_LE_BE (v);
182 static inline void __gst_fast_write_swap64 (guint8 *p, guint64 v) {
183 *(guint64*)(void*)(p) = GUINT64_SWAP_LE_BE (v);
185 # define _GST_FAST_WRITE(s, d, v) __gst_fast_write##s((guint8 *)(d), (v))
186 # define _GST_FAST_WRITE_SWAP(s, d, v) __gst_fast_write_swap##s((guint8 *)(d), (v))
192 * GST_READ_UINT64_BE:
193 * @data: memory location
195 * Read a 64 bit unsigned integer value in big endian format from the memory buffer.
199 * GST_READ_UINT64_LE:
200 * @data: memory location
202 * Read a 64 bit unsigned integer value in little endian format from the memory buffer.
204 #if GST_HAVE_UNALIGNED_ACCESS
205 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
206 # define GST_READ_UINT64_BE(data) _GST_FAST_READ (64, data)
207 # define GST_READ_UINT64_LE(data) _GST_FAST_READ_SWAP (64, data)
209 # define GST_READ_UINT64_BE(data) _GST_FAST_READ_SWAP (64, data)
210 # define GST_READ_UINT64_LE(data) _GST_FAST_READ (64, data)
213 #define _GST_READ_UINT64_BE(data) (_GST_GET (data, 0, 64, 56) | \
214 _GST_GET (data, 1, 64, 48) | \
215 _GST_GET (data, 2, 64, 40) | \
216 _GST_GET (data, 3, 64, 32) | \
217 _GST_GET (data, 4, 64, 24) | \
218 _GST_GET (data, 5, 64, 16) | \
219 _GST_GET (data, 6, 64, 8) | \
220 _GST_GET (data, 7, 64, 0))
222 #define _GST_READ_UINT64_LE(data) (_GST_GET (data, 7, 64, 56) | \
223 _GST_GET (data, 6, 64, 48) | \
224 _GST_GET (data, 5, 64, 40) | \
225 _GST_GET (data, 4, 64, 32) | \
226 _GST_GET (data, 3, 64, 24) | \
227 _GST_GET (data, 2, 64, 16) | \
228 _GST_GET (data, 1, 64, 8) | \
229 _GST_GET (data, 0, 64, 0))
231 #define GST_READ_UINT64_BE(data) __gst_slow_read64_be((const guint8 *)(data))
232 static inline guint64 __gst_slow_read64_be (const guint8 * data) {
233 return _GST_READ_UINT64_BE (data);
235 #define GST_READ_UINT64_LE(data) __gst_slow_read64_le((const guint8 *)(data))
236 static inline guint64 __gst_slow_read64_le (const guint8 * data) {
237 return _GST_READ_UINT64_LE (data);
242 * GST_READ_UINT32_BE:
243 * @data: memory location
245 * Read a 32 bit unsigned integer value in big endian format from the memory buffer.
249 * GST_READ_UINT32_LE:
250 * @data: memory location
252 * Read a 32 bit unsigned integer value in little endian format from the memory buffer.
254 #if GST_HAVE_UNALIGNED_ACCESS
255 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
256 # define GST_READ_UINT32_BE(data) _GST_FAST_READ (32, data)
257 # define GST_READ_UINT32_LE(data) _GST_FAST_READ_SWAP (32, data)
259 # define GST_READ_UINT32_BE(data) _GST_FAST_READ_SWAP (32, data)
260 # define GST_READ_UINT32_LE(data) _GST_FAST_READ (32, data)
263 #define _GST_READ_UINT32_BE(data) (_GST_GET (data, 0, 32, 24) | \
264 _GST_GET (data, 1, 32, 16) | \
265 _GST_GET (data, 2, 32, 8) | \
266 _GST_GET (data, 3, 32, 0))
268 #define _GST_READ_UINT32_LE(data) (_GST_GET (data, 3, 32, 24) | \
269 _GST_GET (data, 2, 32, 16) | \
270 _GST_GET (data, 1, 32, 8) | \
271 _GST_GET (data, 0, 32, 0))
273 #define GST_READ_UINT32_BE(data) __gst_slow_read32_be((const guint8 *)(data))
274 static inline guint32 __gst_slow_read32_be (const guint8 * data) {
275 return _GST_READ_UINT32_BE (data);
277 #define GST_READ_UINT32_LE(data) __gst_slow_read32_le((const guint8 *)(data))
278 static inline guint32 __gst_slow_read32_le (const guint8 * data) {
279 return _GST_READ_UINT32_LE (data);
284 * GST_READ_UINT24_BE:
285 * @data: memory location
287 * Read a 24 bit unsigned integer value in big endian format from the memory buffer.
289 #define _GST_READ_UINT24_BE(data) (_GST_GET (data, 0, 32, 16) | \
290 _GST_GET (data, 1, 32, 8) | \
291 _GST_GET (data, 2, 32, 0))
293 #define GST_READ_UINT24_BE(data) __gst_slow_read24_be((const guint8 *)(data))
294 static inline guint32 __gst_slow_read24_be (const guint8 * data) {
295 return _GST_READ_UINT24_BE (data);
299 * GST_READ_UINT24_LE:
300 * @data: memory location
302 * Read a 24 bit unsigned integer value in little endian format from the memory buffer.
304 #define _GST_READ_UINT24_LE(data) (_GST_GET (data, 2, 32, 16) | \
305 _GST_GET (data, 1, 32, 8) | \
306 _GST_GET (data, 0, 32, 0))
308 #define GST_READ_UINT24_LE(data) __gst_slow_read24_le((const guint8 *)(data))
309 static inline guint32 __gst_slow_read24_le (const guint8 * data) {
310 return _GST_READ_UINT24_LE (data);
314 * GST_READ_UINT16_BE:
315 * @data: memory location
317 * Read a 16 bit unsigned integer value in big endian format from the memory buffer.
320 * GST_READ_UINT16_LE:
321 * @data: memory location
323 * Read a 16 bit unsigned integer value in little endian format from the memory buffer.
325 #if GST_HAVE_UNALIGNED_ACCESS
326 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
327 # define GST_READ_UINT16_BE(data) _GST_FAST_READ (16, data)
328 # define GST_READ_UINT16_LE(data) _GST_FAST_READ_SWAP (16, data)
330 # define GST_READ_UINT16_BE(data) _GST_FAST_READ_SWAP (16, data)
331 # define GST_READ_UINT16_LE(data) _GST_FAST_READ (16, data)
334 #define _GST_READ_UINT16_BE(data) (_GST_GET (data, 0, 16, 8) | \
335 _GST_GET (data, 1, 16, 0))
337 #define _GST_READ_UINT16_LE(data) (_GST_GET (data, 1, 16, 8) | \
338 _GST_GET (data, 0, 16, 0))
340 #define GST_READ_UINT16_BE(data) __gst_slow_read16_be((const guint8 *)(data))
341 static inline guint16 __gst_slow_read16_be (const guint8 * data) {
342 return _GST_READ_UINT16_BE (data);
344 #define GST_READ_UINT16_LE(data) __gst_slow_read16_le((const guint8 *)(data))
345 static inline guint16 __gst_slow_read16_le (const guint8 * data) {
346 return _GST_READ_UINT16_LE (data);
352 * @data: memory location
354 * Read an 8 bit unsigned integer value from the memory buffer.
356 #define GST_READ_UINT8(data) (_GST_GET (data, 0, 8, 0))
359 * GST_WRITE_UINT64_BE:
360 * @data: memory location
361 * @val: value to store
363 * Store a 64 bit unsigned integer value in big endian format into the memory buffer.
366 * GST_WRITE_UINT64_LE:
367 * @data: memory location
368 * @val: value to store
370 * Store a 64 bit unsigned integer value in little endian format into the memory buffer.
372 #if GST_HAVE_UNALIGNED_ACCESS
373 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
374 # define GST_WRITE_UINT64_BE(data,val) _GST_FAST_WRITE(64,data,val)
375 # define GST_WRITE_UINT64_LE(data,val) _GST_FAST_WRITE_SWAP(64,data,val)
377 # define GST_WRITE_UINT64_BE(data,val) _GST_FAST_WRITE_SWAP(64,data,val)
378 # define GST_WRITE_UINT64_LE(data,val) _GST_FAST_WRITE(64,data,val)
381 #define GST_WRITE_UINT64_BE(data,val) do { \
382 gpointer __put_data = data; \
383 guint64 __put_val = val; \
384 _GST_PUT (__put_data, 0, 64, 56, __put_val); \
385 _GST_PUT (__put_data, 1, 64, 48, __put_val); \
386 _GST_PUT (__put_data, 2, 64, 40, __put_val); \
387 _GST_PUT (__put_data, 3, 64, 32, __put_val); \
388 _GST_PUT (__put_data, 4, 64, 24, __put_val); \
389 _GST_PUT (__put_data, 5, 64, 16, __put_val); \
390 _GST_PUT (__put_data, 6, 64, 8, __put_val); \
391 _GST_PUT (__put_data, 7, 64, 0, __put_val); \
394 #define GST_WRITE_UINT64_LE(data,val) do { \
395 gpointer __put_data = data; \
396 guint64 __put_val = val; \
397 _GST_PUT (__put_data, 0, 64, 0, __put_val); \
398 _GST_PUT (__put_data, 1, 64, 8, __put_val); \
399 _GST_PUT (__put_data, 2, 64, 16, __put_val); \
400 _GST_PUT (__put_data, 3, 64, 24, __put_val); \
401 _GST_PUT (__put_data, 4, 64, 32, __put_val); \
402 _GST_PUT (__put_data, 5, 64, 40, __put_val); \
403 _GST_PUT (__put_data, 6, 64, 48, __put_val); \
404 _GST_PUT (__put_data, 7, 64, 56, __put_val); \
406 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
409 * GST_WRITE_UINT32_BE:
410 * @data: memory location
411 * @val: value to store
413 * Store a 32 bit unsigned integer value in big endian format into the memory buffer.
416 * GST_WRITE_UINT32_LE:
417 * @data: memory location
418 * @val: value to store
420 * Store a 32 bit unsigned integer value in little endian format into the memory buffer.
422 #if GST_HAVE_UNALIGNED_ACCESS
423 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
424 # define GST_WRITE_UINT32_BE(data,val) _GST_FAST_WRITE(32,data,val)
425 # define GST_WRITE_UINT32_LE(data,val) _GST_FAST_WRITE_SWAP(32,data,val)
427 # define GST_WRITE_UINT32_BE(data,val) _GST_FAST_WRITE_SWAP(32,data,val)
428 # define GST_WRITE_UINT32_LE(data,val) _GST_FAST_WRITE(32,data,val)
431 #define GST_WRITE_UINT32_BE(data,val) do { \
432 gpointer __put_data = data; \
433 guint32 __put_val = val; \
434 _GST_PUT (__put_data, 0, 32, 24, __put_val); \
435 _GST_PUT (__put_data, 1, 32, 16, __put_val); \
436 _GST_PUT (__put_data, 2, 32, 8, __put_val); \
437 _GST_PUT (__put_data, 3, 32, 0, __put_val); \
440 #define GST_WRITE_UINT32_LE(data,val) do { \
441 gpointer __put_data = data; \
442 guint32 __put_val = val; \
443 _GST_PUT (__put_data, 0, 32, 0, __put_val); \
444 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
445 _GST_PUT (__put_data, 2, 32, 16, __put_val); \
446 _GST_PUT (__put_data, 3, 32, 24, __put_val); \
448 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
451 * GST_WRITE_UINT24_BE:
452 * @data: memory location
453 * @num: value to store
455 * Store a 24 bit unsigned integer value in big endian format into the memory buffer.
457 #define GST_WRITE_UINT24_BE(data, num) do { \
458 gpointer __put_data = data; \
459 guint32 __put_val = num; \
460 _GST_PUT (__put_data, 0, 32, 16, __put_val); \
461 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
462 _GST_PUT (__put_data, 2, 32, 0, __put_val); \
466 * GST_WRITE_UINT24_LE:
467 * @data: memory location
468 * @num: value to store
470 * Store a 24 bit unsigned integer value in little endian format into the memory buffer.
472 #define GST_WRITE_UINT24_LE(data, num) do { \
473 gpointer __put_data = data; \
474 guint32 __put_val = num; \
475 _GST_PUT (__put_data, 0, 32, 0, __put_val); \
476 _GST_PUT (__put_data, 1, 32, 8, __put_val); \
477 _GST_PUT (__put_data, 2, 32, 16, __put_val); \
481 * GST_WRITE_UINT16_BE:
482 * @data: memory location
483 * @val: value to store
485 * Store a 16 bit unsigned integer value in big endian format into the memory buffer.
488 * GST_WRITE_UINT16_LE:
489 * @data: memory location
490 * @val: value to store
492 * Store a 16 bit unsigned integer value in little endian format into the memory buffer.
494 #if GST_HAVE_UNALIGNED_ACCESS
495 # if (G_BYTE_ORDER == G_BIG_ENDIAN)
496 # define GST_WRITE_UINT16_BE(data,val) _GST_FAST_WRITE(16,data,val)
497 # define GST_WRITE_UINT16_LE(data,val) _GST_FAST_WRITE_SWAP(16,data,val)
499 # define GST_WRITE_UINT16_BE(data,val) _GST_FAST_WRITE_SWAP(16,data,val)
500 # define GST_WRITE_UINT16_LE(data,val) _GST_FAST_WRITE(16,data,val)
503 #define GST_WRITE_UINT16_BE(data,val) do { \
504 gpointer __put_data = data; \
505 guint16 __put_val = val; \
506 _GST_PUT (__put_data, 0, 16, 8, __put_val); \
507 _GST_PUT (__put_data, 1, 16, 0, __put_val); \
510 #define GST_WRITE_UINT16_LE(data,val) do { \
511 gpointer __put_data = data; \
512 guint16 __put_val = val; \
513 _GST_PUT (__put_data, 0, 16, 0, __put_val); \
514 _GST_PUT (__put_data, 1, 16, 8, __put_val); \
516 #endif /* !GST_HAVE_UNALIGNED_ACCESS */
520 * @data: memory location
521 * @num: value to store
523 * Store an 8 bit unsigned integer value into the memory buffer.
525 #define GST_WRITE_UINT8(data, num) do { \
526 _GST_PUT (data, 0, 8, 0, num); \
529 /* Float endianness conversion macros */
531 /* FIXME: Remove this once we depend on a GLib version with this */
532 #ifndef GFLOAT_FROM_LE
537 * Swap byte order of a 32-bit floating point value (float).
539 * Returns: @in byte-swapped.
542 GFLOAT_SWAP_LE_BE(gfloat in)
551 u.i = GUINT32_SWAP_LE_BE (u.i);
556 * GDOUBLE_SWAP_LE_BE:
559 * Swap byte order of a 64-bit floating point value (double).
561 * Returns: @in byte-swapped.
563 static inline gdouble
564 GDOUBLE_SWAP_LE_BE(gdouble in)
573 u.i = GUINT64_SWAP_LE_BE (u.i);
581 * Convert 64-bit floating point value (double) from native byte order into
582 * little endian byte order.
588 * Convert 64-bit floating point value (double) from native byte order into
589 * big endian byte order.
595 * Convert 64-bit floating point value (double) from little endian byte order
596 * into native byte order.
602 * Convert 64-bit floating point value (double) from big endian byte order
603 * into native byte order.
610 * Convert 32-bit floating point value (float) from native byte order into
611 * little endian byte order.
617 * Convert 32-bit floating point value (float) from native byte order into
618 * big endian byte order.
624 * Convert 32-bit floating point value (float) from little endian byte order
625 * into native byte order.
631 * Convert 32-bit floating point value (float) from big endian byte order
632 * into native byte order.
635 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
636 #define GFLOAT_TO_LE(val) ((gfloat) (val))
637 #define GFLOAT_TO_BE(val) (GFLOAT_SWAP_LE_BE (val))
638 #define GDOUBLE_TO_LE(val) ((gdouble) (val))
639 #define GDOUBLE_TO_BE(val) (GDOUBLE_SWAP_LE_BE (val))
641 #elif G_BYTE_ORDER == G_BIG_ENDIAN
642 #define GFLOAT_TO_LE(val) (GFLOAT_SWAP_LE_BE (val))
643 #define GFLOAT_TO_BE(val) ((gfloat) (val))
644 #define GDOUBLE_TO_LE(val) (GDOUBLE_SWAP_LE_BE (val))
645 #define GDOUBLE_TO_BE(val) ((gdouble) (val))
647 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
648 #error unknown ENDIAN type
649 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
651 #define GFLOAT_FROM_LE(val) (GFLOAT_TO_LE (val))
652 #define GFLOAT_FROM_BE(val) (GFLOAT_TO_BE (val))
653 #define GDOUBLE_FROM_LE(val) (GDOUBLE_TO_LE (val))
654 #define GDOUBLE_FROM_BE(val) (GDOUBLE_TO_BE (val))
656 #endif /* !defined(GFLOAT_FROM_LE) */
660 * @data: memory location
662 * Read a 32 bit float value in little endian format from the memory buffer.
664 * Returns: The floating point value read from @data
667 GST_READ_FLOAT_LE(const guint8 *data)
675 u.i = GST_READ_UINT32_LE (data);
681 * @data: memory location
683 * Read a 32 bit float value in big endian format from the memory buffer.
685 * Returns: The floating point value read from @data
688 GST_READ_FLOAT_BE(const guint8 *data)
696 u.i = GST_READ_UINT32_BE (data);
701 * GST_READ_DOUBLE_LE:
702 * @data: memory location
704 * Read a 64 bit double value in little endian format from the memory buffer.
706 * Returns: The double-precision floating point value read from @data
708 static inline gdouble
709 GST_READ_DOUBLE_LE(const guint8 *data)
717 u.i = GST_READ_UINT64_LE (data);
722 * GST_READ_DOUBLE_BE:
723 * @data: memory location
725 * Read a 64 bit double value in big endian format from the memory buffer.
727 * Returns: The double-precision floating point value read from @data
729 static inline gdouble
730 GST_READ_DOUBLE_BE(const guint8 *data)
738 u.i = GST_READ_UINT64_BE (data);
743 * GST_WRITE_FLOAT_LE:
744 * @data: memory location
745 * @num: value to store
747 * Store a 32 bit float value in little endian format into the memory buffer.
750 GST_WRITE_FLOAT_LE(guint8 *data, gfloat num)
759 GST_WRITE_UINT32_LE (data, u.i);
763 * GST_WRITE_FLOAT_BE:
764 * @data: memory location
765 * @num: value to store
767 * Store a 32 bit float value in big endian format into the memory buffer.
770 GST_WRITE_FLOAT_BE(guint8 *data, gfloat num)
779 GST_WRITE_UINT32_BE (data, u.i);
783 * GST_WRITE_DOUBLE_LE:
784 * @data: memory location
785 * @num: value to store
787 * Store a 64 bit double value in little endian format into the memory buffer.
790 GST_WRITE_DOUBLE_LE(guint8 *data, gdouble num)
799 GST_WRITE_UINT64_LE (data, u.i);
803 * GST_WRITE_DOUBLE_BE:
804 * @data: memory location
805 * @num: value to store
807 * Store a 64 bit double value in big endian format into the memory buffer.
810 GST_WRITE_DOUBLE_BE(guint8 *data, gdouble num)
819 GST_WRITE_UINT64_BE (data, u.i);
822 /* Miscellaneous utility macros */
826 * @num: integer value to round up
828 * Rounds an integer value up to the next multiple of 2.
830 #define GST_ROUND_UP_2(num) (((num)+1)&~1)
833 * @num: integer value to round up
835 * Rounds an integer value up to the next multiple of 4.
837 #define GST_ROUND_UP_4(num) (((num)+3)&~3)
840 * @num: integer value to round up
842 * Rounds an integer value up to the next multiple of 8.
844 #define GST_ROUND_UP_8(num) (((num)+7)&~7)
847 * @num: integer value to round up
849 * Rounds an integer value up to the next multiple of 16.
851 #define GST_ROUND_UP_16(num) (((num)+15)&~15)
854 * @num: integer value to round up
856 * Rounds an integer value up to the next multiple of 32.
858 #define GST_ROUND_UP_32(num) (((num)+31)&~31)
861 * @num: integer value to round up
863 * Rounds an integer value up to the next multiple of 64.
865 #define GST_ROUND_UP_64(num) (((num)+63)&~63)
868 * @num: integer value to round up
870 * Rounds an integer value up to the next multiple of 128.
873 #define GST_ROUND_UP_128(num) (((num)+127)&~127)
876 * @num: integrer value to round up
877 * @align: a power of two to round up to
879 * Rounds an integer value up to the next multiple of @align. @align MUST be a
882 #define GST_ROUND_UP_N(num,align) ((((num) + ((align) - 1)) & ~((align) - 1)))
887 * @num: integer value to round down
889 * Rounds an integer value down to the next multiple of 2.
891 #define GST_ROUND_DOWN_2(num) ((num)&(~1))
894 * @num: integer value to round down
896 * Rounds an integer value down to the next multiple of 4.
898 #define GST_ROUND_DOWN_4(num) ((num)&(~3))
901 * @num: integer value to round down
903 * Rounds an integer value down to the next multiple of 8.
905 #define GST_ROUND_DOWN_8(num) ((num)&(~7))
908 * @num: integer value to round down
910 * Rounds an integer value down to the next multiple of 16.
912 #define GST_ROUND_DOWN_16(num) ((num)&(~15))
915 * @num: integer value to round down
917 * Rounds an integer value down to the next multiple of 32.
919 #define GST_ROUND_DOWN_32(num) ((num)&(~31))
922 * @num: integer value to round down
924 * Rounds an integer value down to the next multiple of 64.
926 #define GST_ROUND_DOWN_64(num) ((num)&(~63))
928 * GST_ROUND_DOWN_128:
929 * @num: integer value to round down
931 * Rounds an integer value down to the next multiple of 128.
934 #define GST_ROUND_DOWN_128(num) ((num)&(~127))
937 * @num: integrer value to round down
938 * @align: a power of two to round down to
940 * Rounds an integer value down to the next multiple of @align. @align MUST be a
943 #define GST_ROUND_DOWN_N(num,align) (((num) & ~((align) - 1)))
947 void gst_object_default_error (GstObject * source,
948 const GError * error,
949 const gchar * debug);
951 /* element functions */
954 void gst_element_create_all_pads (GstElement *element);
957 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad,
960 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
963 const gchar* gst_element_state_get_name (GstState state);
966 const gchar * gst_element_state_change_return_get_name (GstStateChangeReturn state_ret);
969 gboolean gst_element_link (GstElement *src, GstElement *dest);
972 gboolean gst_element_link_many (GstElement *element_1,
973 GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
975 gboolean gst_element_link_filtered (GstElement * src,
979 void gst_element_unlink (GstElement *src, GstElement *dest);
982 void gst_element_unlink_many (GstElement *element_1,
983 GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
985 gboolean gst_element_link_pads (GstElement *src, const gchar *srcpadname,
986 GstElement *dest, const gchar *destpadname);
988 gboolean gst_element_link_pads_full (GstElement *src, const gchar *srcpadname,
989 GstElement *dest, const gchar *destpadname,
990 GstPadLinkCheck flags);
992 void gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
993 GstElement *dest, const gchar *destpadname);
995 gboolean gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
996 GstElement * dest, const gchar * destpadname,
999 gboolean gst_element_seek_simple (GstElement *element,
1001 GstSeekFlags seek_flags,
1004 /* util elementfactory functions */
1007 gboolean gst_element_factory_can_sink_all_caps (GstElementFactory *factory, const GstCaps *caps);
1010 gboolean gst_element_factory_can_src_all_caps (GstElementFactory *factory, const GstCaps *caps);
1013 gboolean gst_element_factory_can_sink_any_caps (GstElementFactory *factory, const GstCaps *caps);
1016 gboolean gst_element_factory_can_src_any_caps (GstElementFactory *factory, const GstCaps *caps);
1018 /* util query functions */
1021 gboolean gst_element_query_position (GstElement *element, GstFormat format, gint64 *cur);
1024 gboolean gst_element_query_duration (GstElement *element, GstFormat format, gint64 *duration);
1027 gboolean gst_element_query_convert (GstElement *element, GstFormat src_format, gint64 src_val,
1028 GstFormat dest_format, gint64 *dest_val);
1033 void gst_pad_use_fixed_caps (GstPad *pad);
1036 GstElement* gst_pad_get_parent_element (GstPad *pad);
1038 /* util query functions */
1041 gboolean gst_pad_proxy_query_accept_caps (GstPad *pad, GstQuery *query);
1044 gboolean gst_pad_proxy_query_caps (GstPad *pad, GstQuery *query);
1047 gboolean gst_pad_query_position (GstPad *pad, GstFormat format, gint64 *cur);
1050 gboolean gst_pad_query_duration (GstPad *pad, GstFormat format, gint64 *duration);
1053 gboolean gst_pad_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
1054 GstFormat dest_format, gint64 *dest_val);
1056 GstCaps * gst_pad_query_caps (GstPad *pad, GstCaps *filter);
1059 gboolean gst_pad_query_accept_caps (GstPad *pad, GstCaps *caps);
1062 gboolean gst_pad_link_maybe_ghosting (GstPad *src,
1065 gboolean gst_pad_link_maybe_ghosting_full (GstPad *src,
1067 GstPadLinkCheck flags);
1069 gboolean gst_pad_peer_query_position (GstPad *pad, GstFormat format, gint64 *cur);
1072 gboolean gst_pad_peer_query_duration (GstPad *pad, GstFormat format, gint64 *duration);
1075 gboolean gst_pad_peer_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
1076 GstFormat dest_format, gint64 *dest_val);
1078 GstCaps * gst_pad_peer_query_caps (GstPad * pad, GstCaps *filter);
1081 gboolean gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps *caps);
1084 gchar * gst_pad_create_stream_id (GstPad * pad, GstElement * parent, const gchar *stream_id) G_GNUC_MALLOC;
1087 gchar * gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent, const gchar *stream_id, ...) G_GNUC_PRINTF (3, 4) G_GNUC_MALLOC;
1090 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;
1093 gchar * gst_pad_get_stream_id (GstPad * pad);
1096 GstStream * gst_pad_get_stream (GstPad * pad);
1101 void gst_bin_add_many (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1104 void gst_bin_remove_many (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1107 GstPad * gst_bin_find_unlinked_pad (GstBin *bin, GstPadDirection direction);
1110 gboolean gst_bin_sync_children_states (GstBin *bin);
1112 /* parse utility functions */
1115 GstElement * gst_parse_bin_from_description (const gchar * bin_description,
1116 gboolean ghost_unlinked_pads,
1119 GstElement * gst_parse_bin_from_description_full (const gchar * bin_description,
1120 gboolean ghost_unlinked_pads,
1121 GstParseContext * context,
1122 GstParseFlags flags,
1125 GstClockTime gst_util_get_timestamp (void);
1129 * @GST_SEARCH_MODE_EXACT : Only search for exact matches.
1130 * @GST_SEARCH_MODE_BEFORE: Search for an exact match or the element just before.
1131 * @GST_SEARCH_MODE_AFTER : Search for an exact match or the element just after.
1133 * The different search modes.
1136 GST_SEARCH_MODE_EXACT = 0,
1137 GST_SEARCH_MODE_BEFORE,
1138 GST_SEARCH_MODE_AFTER
1142 gpointer gst_util_array_binary_search (gpointer array, guint num_elements,
1143 gsize element_size, GCompareDataFunc search_func,
1144 GstSearchMode mode, gconstpointer search_data,
1145 gpointer user_data);
1147 /* fraction operations */
1150 gint gst_util_greatest_common_divisor (gint a, gint b);
1153 gint64 gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b);
1156 void gst_util_fraction_to_double (gint src_n, gint src_d, gdouble *dest);
1159 void gst_util_double_to_fraction (gdouble src, gint *dest_n, gint *dest_d);
1162 gboolean gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
1163 gint *res_n, gint *res_d);
1165 gboolean gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d,
1166 gint *res_n, gint *res_d);
1168 gint gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d);
1171 gboolean gst_calculate_linear_regression (const GstClockTime * xy,
1172 GstClockTime * temp, guint n,
1173 GstClockTime * m_num, GstClockTime * m_denom,
1174 GstClockTime * b, GstClockTime * xbase,
1175 gdouble * r_squared);
1180 #endif /* __GST_UTILS_H__ */