gst/gsterror.h

   1 /* GStreamer
   2  * Copyright (C) 2004 Thomas Vander Stichele <thomas at apestaart dot org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __GST_ERROR_H__
  21 #define __GST_ERROR_H__
  22
  23 G_BEGIN_DECLS
  24
  25 /*
  26  * we define FIXME error domains:
  27  * GST_CORE_ERROR
  28  * GST_LIBRARY_ERROR
  29  * GST_RESOURCE_ERROR
  30  * GST_STREAM_ERROR
  31  *
  32  * Check GError API docs for rationale for naming.
  33  */
  34
  35 /* Core errors are anything that can go wrong in or using
  36  * the core GStreamer library */
  37 /* FIXME: should we divide in numerical blocks so we can easily add
  38           for example PAD errors later ? */
  39 typedef enum {
  40   GST_CORE_ERROR_FAILED = 1,
  41   GST_CORE_ERROR_TOO_LAZY,
  42   GST_CORE_ERROR_NOT_IMPLEMENTED,
  43   GST_CORE_ERROR_STATE_CHANGE,
  44   GST_CORE_ERROR_PAD,
  45   GST_CORE_ERROR_THREAD,
  46   GST_CORE_ERROR_SCHEDULER,
  47   GST_CORE_ERROR_NEGOTIATION,
  48   GST_CORE_ERROR_EVENT,
  49   GST_CORE_ERROR_SEEK,
  50   GST_CORE_ERROR_CAPS,
  51   GST_CORE_ERROR_TAG,
  52   GST_CORE_ERROR_NUM_ERRORS
  53 }
  54 GstCoreError;
  55
  56 /* Library errors are for errors from the library being used by elements
  57    initializing, closing, ... */
  58 typedef enum {
  59   GST_LIBRARY_ERROR_FAILED = 1,
  60   GST_LIBRARY_ERROR_TOO_LAZY,
  61   GST_LIBRARY_ERROR_INIT,
  62   GST_LIBRARY_ERROR_SHUTDOWN,
  63   GST_LIBRARY_ERROR_SETTINGS,
  64   GST_LIBRARY_ERROR_ENCODE,
  65   GST_LIBRARY_ERROR_NUM_ERRORS
  66 }
  67 GstLibraryError;
  68
  69 /* Resource errors are for anything external used by an element:
  70    memory, files, network connections, process space, ...
  71    They're typically used by source and sink elements */
  72 typedef enum {
  73   GST_RESOURCE_ERROR_FAILED = 1,
  74   GST_RESOURCE_ERROR_TOO_LAZY,
  75   GST_RESOURCE_ERROR_NOT_FOUND,
  76   GST_RESOURCE_ERROR_BUSY,
  77   GST_RESOURCE_ERROR_OPEN_READ,
  78   GST_RESOURCE_ERROR_OPEN_WRITE,
  79   GST_RESOURCE_ERROR_OPEN_READ_WRITE,
  80   GST_RESOURCE_ERROR_CLOSE,
  81   GST_RESOURCE_ERROR_READ,
  82   GST_RESOURCE_ERROR_WRITE,
  83   GST_RESOURCE_ERROR_SEEK,
  84   GST_RESOURCE_ERROR_SYNC,
  85   GST_RESOURCE_ERROR_SETTINGS,
  86   GST_RESOURCE_ERROR_NUM_ERRORS
  87 }
  88 GstResourceError;
  89
  90 /* Stream errors are for anything related to the stream being processed:
  91    format errors, media type errors, ...
  92    They're typically used by decoders, demuxers, converters, ... */
  93 typedef enum {
  94   GST_STREAM_ERROR_FAILED = 1,
  95   GST_STREAM_ERROR_TOO_LAZY,
  96   GST_STREAM_ERROR_NOT_IMPLEMENTED,
  97   GST_STREAM_ERROR_TYPE_NOT_FOUND,
  98   GST_STREAM_ERROR_WRONG_TYPE,
  99   GST_STREAM_ERROR_CODEC_NOT_FOUND,
 100   GST_STREAM_ERROR_DECODE,
 101   GST_STREAM_ERROR_ENCODE,
 102   GST_STREAM_ERROR_DEMUX,
 103   GST_STREAM_ERROR_MUX,
 104   GST_STREAM_ERROR_FORMAT,
 105   GST_STREAM_ERROR_NUM_ERRORS
 106 }
 107 GstStreamError;
 108
 109 /* This should go away once we convinced glib people to register GError */
 110 #define GST_TYPE_G_ERROR    (gst_g_error_get_type ())
 111
 112 #define GST_LIBRARY_ERROR   gst_library_error_quark ()
 113 #define GST_RESOURCE_ERROR  gst_resource_error_quark ()
 114 #define GST_CORE_ERROR      gst_core_error_quark ()
 115 #define GST_STREAM_ERROR    gst_stream_error_quark ()
 116
 117 #define GST_ERROR_SYSTEM    ("system error: %s", g_strerror (errno))
 118
 119 GType   gst_g_error_get_type     (void);
 120 gchar * gst_error_get_message    (GQuark domain, gint code);
 121 GQuark  gst_stream_error_quark   (void);
 122 GQuark  gst_core_error_quark     (void);
 123 GQuark  gst_resource_error_quark (void);
 124 GQuark  gst_library_error_quark  (void);
 125
 126 G_END_DECLS
 127
 128 #endif /* __GST_ERROR_H__ */
 129
 130