gst/gstformat.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstformat.h: Header for GstFormat types used in queries and
   6  *              seeking.
   7  *
   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.
  12  *
  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.
  17  *
  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.
  22  */
  23
  24
  25 #ifndef __GST_FORMAT_H__
  26 #define __GST_FORMAT_H__
  27
  28 #include <glib.h>
  29
  30 G_BEGIN_DECLS typedef enum
  31 {
  32   GST_FORMAT_UNDEFINED = 0,     /* must be first in list */
  33   GST_FORMAT_DEFAULT = 1,       /* samples for audio, frames/fields for video */
  34   GST_FORMAT_BYTES = 2,
  35   GST_FORMAT_TIME = 3,
  36   GST_FORMAT_BUFFERS = 4,
  37   GST_FORMAT_PERCENT = 5
  38 } GstFormat;
  39
  40 /* a percentage is always relative to 1000000 */
  41 #define GST_FORMAT_PERCENT_MAX          G_GINT64_CONSTANT (1000000)
  42 #define GST_FORMAT_PERCENT_SCALE        G_GINT64_CONSTANT (10000)
  43
  44 typedef struct _GstFormatDefinition GstFormatDefinition;
  45
  46 struct _GstFormatDefinition
  47 {
  48   GstFormat value;
  49   gchar *nick;
  50   gchar *description;
  51 };
  52
  53 #ifdef G_HAVE_ISO_VARARGS
  54 #define GST_FORMATS_FUNCTION(type, functionname, ...)   \
  55 static const GstFormat*                                 \
  56 functionname (type object)                              \
  57 {                                                       \
  58   static const GstFormat formats[] = {                  \
  59     __VA_ARGS__,                                        \
  60     0                                                   \
  61   };                                                    \
  62   return formats;                                       \
  63 }
  64 #elif defined(G_HAVE_GNUC_VARARGS)
  65 #define GST_FORMATS_FUNCTION(type, functionname, a...)  \
  66 static const GstFormat*                                 \
  67 functionname (type object)                              \
  68 {                                                       \
  69   static const GstFormat formats[] = {                  \
  70     a,                                                  \
  71     0                                                   \
  72   };                                                    \
  73   return formats;                                       \
  74 }
  75 #endif
  76
  77 void _gst_format_initialize (void);
  78
  79 /* register a new format */
  80 GstFormat gst_format_register (const gchar * nick, const gchar * description);
  81 GstFormat gst_format_get_by_nick (const gchar * nick);
  82
  83 /* check if a format is in an array of formats */
  84 gboolean gst_formats_contains (const GstFormat * formats, GstFormat format);
  85
  86 /* query for format details */
  87 G_CONST_RETURN GstFormatDefinition *gst_format_get_details (GstFormat format);
  88 G_CONST_RETURN GList *gst_format_get_definitions (void);
  89
  90 G_END_DECLS
  91 #endif /* __GST_FORMAT_H__ */