gstreamer/gst/gstvalue.h
Tim-Philipp Müller 7390d68eee Add GST_TYPE_DATE, a boxed type that wraps GDate, and the usual bunch of utility functions along with a hack that che...
Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gststructure.c: (gst_structure_set_valist),
(gst_structure_get_date):
* gst/gststructure.h:
* gst/gstvalue.c: (gst_value_set_date), (gst_value_get_date),
(gst_date_copy), (gst_value_compare_date),
(gst_value_serialize_date), (gst_value_deserialize_date),
(gst_value_transform_date_string),
(gst_value_transform_string_date), (_gst_value_initialize):
* gst/gstvalue.h:
Add GST_TYPE_DATE, a boxed type that wraps GDate, and the usual
bunch of utility functions along with a hack that checks that
developers don't accidentally use G_TYPE_DATE where GST_TYPE_DATE
is required. Part of the grand scheme in #170777.
2005-09-22 15:08:02 +00:00

414 lines
12 KiB
C

/* GStreamer
* Copyright (C) <2003> David A. Schleef <ds@schleef.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GST_VALUE_H__
#define __GST_VALUE_H__
#include <gst/gstconfig.h>
#include <gst/gstcaps.h>
G_BEGIN_DECLS
/**
* GST_MAKE_FOURCC:
* @a: the first character
* @b: the second character
* @c: the third character
* @d: the fourth character
*
* Transform four characters into a #guint32 fourcc value with host
* endianness.
* <informalexample>
* <programlisting>
* guint32 fourcc = GST_MAKE_FOURCC ('M', 'J', 'P', 'G');
* </programlisting>
* </informalexample>
*/
#define GST_MAKE_FOURCC(a,b,c,d) (guint32)((a)|(b)<<8|(c)<<16|(d)<<24)
/**
* GST_STR_FOURCC:
* @f: a string with at least four characters
*
* Transform an input string into a #guint32 fourcc value with host
* endianness.
* Caller is responsible for ensuring the input string consists of at least
* four characters.
* <informalexample>
* <programlisting>
* guint32 fourcc = GST_STR_FOURCC ("MJPG");
* </programlisting>
* </informalexample>
*/
#define GST_STR_FOURCC(f) (guint32)(((f)[0])|((f)[1]<<8)|((f)[2]<<16)|((f)[3]<<24))
/**
* GST_FOURCC_FORMAT:
*
* Can be used together with #GST_FOURCC_ARGS to properly output a
* #guint32 fourcc value in a printf()-style text message.
* <informalexample>
* <programlisting>
* printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
* </programlisting>
* </informalexample>
*/
#define GST_FOURCC_FORMAT "%c%c%c%c"
/**
* GST_FOURCC_ARGS:
* @fourcc: a #guint32 fourcc value to output
*
* Can be used together with #GST_FOURCC_FORMAT to properly output a
* #guint32 fourcc value in a printf()-style text message.
*/
#define GST_FOURCC_ARGS(fourcc) \
((gchar) ((fourcc) &0xff)), \
((gchar) (((fourcc)>>8 )&0xff)), \
((gchar) (((fourcc)>>16)&0xff)), \
((gchar) (((fourcc)>>24)&0xff))
/**
* GST_VALUE_HOLDS_FOURCC:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_FOURCC value.
*/
#define GST_VALUE_HOLDS_FOURCC(x) (G_VALUE_HOLDS(x, gst_type_fourcc))
/**
* GST_VALUE_HOLDS_INT_RANGE:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_INT_RANGE value.
*/
#define GST_VALUE_HOLDS_INT_RANGE(x) (G_VALUE_HOLDS(x, gst_type_int_range))
/**
* GST_VALUE_HOLDS_DOUBLE_RANGE:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_DOUBLE_RANGE value.
*/
#define GST_VALUE_HOLDS_DOUBLE_RANGE(x) (G_VALUE_HOLDS(x, gst_type_double_range))
/**
* GST_VALUE_HOLDS_LIST:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_LIST value.
*/
#define GST_VALUE_HOLDS_LIST(x) (G_VALUE_HOLDS(x, gst_type_list))
/**
* GST_VALUE_HOLDS_ARRAY:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_ARRAY value.
*/
#define GST_VALUE_HOLDS_ARRAY(x) (G_VALUE_HOLDS(x, gst_type_array))
/**
* GST_VALUE_HOLDS_CAPS:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_CAPS value.
*/
#define GST_VALUE_HOLDS_CAPS(x) (G_VALUE_HOLDS(x, GST_TYPE_CAPS))
/**
* GST_VALUE_HOLDS_BUFFER:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_BUFFER value.
*/
#define GST_VALUE_HOLDS_BUFFER(x) (G_VALUE_HOLDS(x, GST_TYPE_BUFFER))
/**
* GST_VALUE_HOLDS_FRACTION:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_FRACTION value.
*/
#define GST_VALUE_HOLDS_FRACTION(x) (G_VALUE_HOLDS(x, gst_type_fraction))
/**
* GST_VALUE_HOLDS_DATE:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_DATE value.
*/
#define GST_VALUE_HOLDS_DATE(x) (G_VALUE_HOLDS(x, gst_type_date))
/**
* GST_TYPE_FOURCC:
*
* a #GValue type that represents 4 byte identifier (e.g. used for codecs)
*
* Returns: the #GType of GstFourcc
*/
#define GST_TYPE_FOURCC gst_type_fourcc
/**
* GST_TYPE_INT_RANGE:
*
* a #GValue type that represents an integer range
*
* Returns: the #GType of GstIntRange
*/
#define GST_TYPE_INT_RANGE gst_type_int_range
/**
* GST_TYPE_DOUBLE_RANGE:
*
* a #GValue type that represents a floating point range with double precission
*
* Returns: the #GType of GstIntRange
*/
#define GST_TYPE_DOUBLE_RANGE gst_type_double_range
/**
* GST_TYPE_LIST:
*
* a #GValue type that represents an unordered list of #GValue values
*
* Returns: the #GType of GstValueList (which is not explicitly typed)
*/
#define GST_TYPE_LIST gst_type_list
/**
* GST_TYPE_ARRAY:
*
* a #GValue type that represents an ordered list of #GValue values
*
* Returns: the #GType of GstArrayList (which is not explicitly typed)
*/
#define GST_TYPE_ARRAY gst_type_array
/**
* GST_TYPE_FRACTION:
*
* a #GValue type that represents a fraction of an integer numerator over
* an integer denominator
*
* Returns: the #GType of GstFraction (which is not explicitly typed)
*/
#define GST_TYPE_FRACTION gst_type_fraction
/**
* GST_TYPE_DATE:
*
* a boxed #GValue type for #GDate that represents a date.
*
* Returns: the #GType of GstDate
*/
#define GST_TYPE_DATE gst_type_date
/**
* GST_VALUE_LESS_THAN:
*
* Indicates that the first value provided to a comparison function
* (gst_value_compare()) is lesser than the second one.
*/
#define GST_VALUE_LESS_THAN (-1)
/**
* GST_VALUE_EQUAL:
*
* Indicates that the first value provided to a comparison function
* (gst_value_compare()) is equal to the second one.
*/
#define GST_VALUE_EQUAL 0
/**
* GST_VALUE_GREATER_THAN:
*
* Indicates that the first value provided to a comparison function
* (gst_value_compare()) is greater than the second one.
*/
#define GST_VALUE_GREATER_THAN 1
/**
* GST_VALUE_UNORDERED:
*
* Indicates that the comparison function (gst_value_compare()) can not
* determine a order for the two provided values.
*/
#define GST_VALUE_UNORDERED 2
/**
* GstValueCompareFunc:
* @value1: first value for comparission
* @value2: second value for comparission
*
* Used together with gst_value_compare() to compare #GValues.
*
* Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN
* or GST_VALUE_UNORDERED
*/
typedef int (* GstValueCompareFunc) (const GValue *value1,
const GValue *value2);
typedef char * (* GstValueSerializeFunc) (const GValue *value1);
typedef gboolean (* GstValueDeserializeFunc) (GValue *dest,
const char *s);
typedef int (* GstValueUnionFunc) (GValue *dest,
const GValue *value1,
const GValue *value2);
typedef int (* GstValueIntersectFunc) (GValue *dest,
const GValue *value1,
const GValue *value2);
typedef int (* GstValueSubtractFunc) (GValue *dest,
const GValue *minuend,
const GValue *subtrahend);
typedef struct _GstValueTable GstValueTable;
struct _GstValueTable {
GType type;
GstValueCompareFunc compare;
GstValueSerializeFunc serialize;
GstValueDeserializeFunc deserialize;
/*< private >*/
void *_gst_reserved [GST_PADDING];
};
GST_EXPORT GType gst_type_fourcc;
GST_EXPORT GType gst_type_int_range;
GST_EXPORT GType gst_type_double_range;
GST_EXPORT GType gst_type_list;
GST_EXPORT GType gst_type_array;
GST_EXPORT GType gst_type_fraction;
GST_EXPORT GType gst_type_date;
void gst_value_register (const GstValueTable *table);
void gst_value_init_and_copy (GValue *dest,
const GValue *src);
gchar * gst_value_serialize (const GValue *value);
gboolean gst_value_deserialize (GValue *dest,
const gchar *src);
/* list */
void gst_value_list_append_value (GValue *value,
const GValue *append_value);
void gst_value_list_prepend_value (GValue *value,
const GValue *prepend_value);
void gst_value_list_concat (GValue *dest,
const GValue *value1,
const GValue *value2);
guint gst_value_list_get_size (const GValue *value);
G_CONST_RETURN GValue *
gst_value_list_get_value (const GValue *value,
guint index);
/* fourcc */
void gst_value_set_fourcc (GValue *value,
guint32 fourcc);
guint32 gst_value_get_fourcc (const GValue *value);
/* int range */
void gst_value_set_int_range (GValue *value,
int start,
int end);
int gst_value_get_int_range_min (const GValue *value);
int gst_value_get_int_range_max (const GValue *value);
/* double range */
void gst_value_set_double_range (GValue *value,
double start,
double end);
double gst_value_get_double_range_min (const GValue *value);
double gst_value_get_double_range_max (const GValue *value);
/* caps */
G_CONST_RETURN GstCaps *
gst_value_get_caps (const GValue *value);
void gst_value_set_caps (GValue *value,
const GstCaps *caps);
/* fraction */
void gst_value_set_fraction (GValue *value,
int numerator,
int denominator);
int gst_value_get_fraction_numerator (const GValue *value);
int gst_value_get_fraction_denominator(const GValue *value);
gboolean gst_value_fraction_multiply (GValue *product,
const GValue *factor1,
const GValue *factor2);
/* date */
G_CONST_RETURN GDate *
gst_value_get_date (const GValue *value);
void gst_value_set_date (GValue *value,
const GDate *date);
/* compare */
int gst_value_compare (const GValue *value1,
const GValue *value2);
gboolean gst_value_can_compare (const GValue *value1,
const GValue *value2);
/* union */
gboolean gst_value_union (GValue *dest,
const GValue *value1,
const GValue *value2);
gboolean gst_value_can_union (const GValue *value1,
const GValue *value2);
void gst_value_register_union_func (GType type1,
GType type2,
GstValueUnionFunc func);
/* intersection */
gboolean gst_value_intersect (GValue *dest,
const GValue *value1,
const GValue *value2);
gboolean gst_value_can_intersect (const GValue *value1,
const GValue *value2);
void gst_value_register_intersect_func (GType type1,
GType type2,
GstValueIntersectFunc func);
/* subtraction */
gboolean gst_value_subtract (GValue *dest,
const GValue *minuend,
const GValue *subtrahend);
gboolean gst_value_can_subtract (const GValue *minuend,
const GValue *subtrahend);
void gst_value_register_subtract_func (GType minuend_type,
GType subtrahend_type,
GstValueSubtractFunc func);
/* fixation */
gboolean gst_value_is_fixed (const GValue *value);
/* private */
void _gst_value_initialize (void);
G_END_DECLS
#endif