2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
5 * gstformat.h: Header for GstFormat types used in queries and
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., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
25 #ifndef __GST_FORMAT_H__
26 #define __GST_FORMAT_H__
30 #include <gst/gstiterator.h>
35 GST_FORMAT_UNDEFINED = 0, /* must be first in list */
36 GST_FORMAT_DEFAULT = 1, /* samples for audio, frames/fields for video */
39 GST_FORMAT_BUFFERS = 4,
40 GST_FORMAT_PERCENT = 5
43 /* a percentage is always relative to 1000000 */
44 #define GST_FORMAT_PERCENT_MAX G_GINT64_CONSTANT (1000000)
45 #define GST_FORMAT_PERCENT_SCALE G_GINT64_CONSTANT (10000)
47 typedef struct _GstFormatDefinition GstFormatDefinition;
49 struct _GstFormatDefinition
56 #ifdef G_HAVE_ISO_VARARGS
57 #define GST_FORMATS_FUNCTION(type, functionname, ...) \
58 static const GstFormat* \
59 functionname (type object) \
61 static const GstFormat formats[] = { \
67 #elif defined(G_HAVE_GNUC_VARARGS)
68 #define GST_FORMATS_FUNCTION(type, functionname, a...) \
69 static const GstFormat* \
70 functionname (type object) \
72 static const GstFormat formats[] = { \
80 void _gst_format_initialize (void);
82 /* register a new format */
83 GstFormat gst_format_register (const gchar *nick,
84 const gchar *description);
85 GstFormat gst_format_get_by_nick (const gchar *nick);
87 /* check if a format is in an array of formats */
88 gboolean gst_formats_contains (const GstFormat *formats, GstFormat format);
90 /* query for format details */
91 G_CONST_RETURN GstFormatDefinition*
92 gst_format_get_details (GstFormat format);
93 GstIterator* gst_format_iterate_definitions (void);
97 #endif /* __GST_FORMAT_H__ */