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
  31
  32 typedef enum {
  33   GST_FORMAT_UNDEFINED  =  0,
  34   GST_FORMAT_DEFAULT    =  1,
  35   GST_FORMAT_BYTES      =  2,
  36   GST_FORMAT_TIME       =  3,
  37   GST_FORMAT_BUFFERS    =  4,
  38   GST_FORMAT_PERCENT    =  5,
  39   /* samples for audio, frames/fields for video */
  40   GST_FORMAT_UNITS      =  6
  41 } GstFormat;
  42
  43 typedef struct _GstFormatDefinition GstFormatDefinition;
  44
  45 struct _GstFormatDefinition
  46 {
  47   GstFormat  value;
  48   gchar     *nick;
  49   gchar     *description;
  50 };
  51
  52 #ifdef G_HAVE_ISO_VARARGS
  53 #define GST_FORMATS_FUNCTION(functionname, ...)      \
  54 static const GstFormat*                              \
  55 functionname (GstPad *pad)                           \
  56 {                                                    \
  57   static const GstFormat formats[] = {               \
  58     __VA_ARGS__,                                     \
  59     0                                                \
  60   };                                                 \
  61   return formats;                                    \
  62 }
  63 #elif defined(G_HAVE_GNUC_VARARGS)
  64 #define GST_FORMATS_FUNCTION(functionname, a...)     \
  65 static const GstFormat*                              \
  66 functionname (GstPad *pad)                           \
  67 {                                                    \
  68   static const GstFormat formats[] = {               \
  69     a,                                               \
  70     0                                                \
  71   };                                                 \
  72   return formats;                                    \
  73 }
  74 #endif
  75
  76 void            _gst_format_initialize          (void);
  77
  78 /* register a new format */
  79 GstFormat       gst_format_register             (const gchar *nick,
  80                                                  const gchar *description);
  81 GstFormat       gst_format_get_by_nick          (const gchar *nick);
  82
  83 /* query for format details */
  84 const GstFormatDefinition*
  85                 gst_format_get_details          (GstFormat format);
  86 const GList*    gst_format_get_definitions      (void);
  87
  88 G_END_DECLS
  89
  90 #endif /* __GST_FORMAT_H__ */