gst/gsterror.c

   1 /* GStreamer
   2  * Copyright (C) <2003> David A. Schleef <ds@schleef.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 /**
  21  * SECTION:gsterror
  22  * @short_description: Categorized error messages
  23  * @see_also: #GstMessage
  24  *
  25  * GStreamer elements can throw non-fatal warnings and fatal errors.
  26  * Higher-level elements and applications can programatically filter
  27  * the ones they are interested in or can recover from,
  28  * and have a default handler handle the rest of them.
  29  *
  30  * The rest of this section will use the term <quote>error</quote>
  31  * to mean both (non-fatal) warnings and (fatal) errors; they are treated
  32  * similarly.
  33  *
  34  * Errors from elements are the combination of a #GError and a debug string.
  35  * The #GError contains:
  36  * - a domain type: CORE, LIBRARY, RESOURCE or STREAM
  37  * - a code: an enum value specific to the domain
  38  * - a translated, human-readable message
  39  * - a non-translated additional debug string, which also contains
  40  * - file and line information
  41  *
  42  * Elements do not have the context required to decide what to do with
  43  * errors.  As such, they should only inform about errors, and stop their
  44  * processing.  In short, an element doesn't know what it is being used for.
  45  *
  46  * It is the application or compound element using the given element that
  47  * has more context about the use of the element.  The thrown errors should
  48  * be inspected, and filtered if appropriate.
  49  *
  50  * An application is expected to, by default, present the user with a
  51  * dialog box (or an equivalent) showing the error message.  The dialog
  52  * should also allow a way to get at the additional debug information,
  53  * so the user can provide bug reporting information.
  54  *
  55  * A compound element is expected to forward errors by default higher up
  56  * the hierarchy; this is done by default in the same way as for other types
  57  * of #GstMessage.
  58  *
  59  * When applications or compound elements trigger errors that they can
  60  * recover from, they can filter out these errors and take appropriate action.
  61  * For example, an application that gets an error from xvimagesink
  62  * that indicates all XVideo ports are taken, the application can attempt
  63  * to use another sink instead.
  64  *
  65  * Elements throw errors using the #GST_ELEMENT_ERROR convenience macro:
  66  *
  67  * <example>
  68  * <title>Throwing an error</title>
  69  *   <programlisting>
  70  *     GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
  71  *       (_("No file name specified for reading.")), (NULL));
  72  *   </programlisting>
  73  * </example>
  74  *
  75  * Things to keep in mind:
  76  * <itemizedlist>
  77  *   <listitem><para>Don't go off inventing new error codes.  The ones
  78  *     currently provided should be enough.  If you find your type of error
  79  *     does not fit the current codes, you should use FAILED.</para></listitem>
  80  *   <listitem><para>Don't provide a message if the default one suffices.
  81  *     this keeps messages more uniform.  Use (NULL) - not forgetting the
  82  *     parentheses.</para></listitem>
  83  *   <listitem><para>If you do supply a custom message, it should be
  84  *     marked for translation.  The message should start with a capital
  85  *     and end with a period.  The message should describe the error in short,
  86  *     in a human-readable form, and without any complex technical terms.
  87  *     A user interface will present this message as the first thing a user
  88  *     sees.  Details, technical info, ... should go in the debug string.
  89  *   </para></listitem>
  90  *   <listitem><para>The debug string can be as you like.  Again, use (NULL)
  91  *     if there's nothing to add - file and line number will still be
  92  *     passed.  #GST_ERROR_SYSTEM can be used as a shortcut to give
  93  *     debug information on a system call error.</para></listitem>
  94  * </itemizedlist>
  95  */
  96
  97 #ifdef HAVE_CONFIG_H
  98 #include "config.h"
  99 #endif
 100
 101 #include "gst_private.h"
 102 #include <gst/gst.h>
 103 #include "gst-i18n-lib.h"
 104
 105 #define TABLE(t, d, a, b) t[GST_ ## d ## _ERROR_ ## a] = g_strdup (b)
 106 #define QUARK_FUNC(string)                                              \
 107 GQuark gst_ ## string ## _error_quark (void) {                          \
 108   static GQuark quark;                                                  \
 109   if (!quark)                                                           \
 110     quark = g_quark_from_static_string ("gst-" # string "-error-quark"); \
 111   return quark; }
 112
 113 GType
 114 gst_g_error_get_type (void)
 115 {
 116   static GType type = 0;
 117
 118   if (G_UNLIKELY (type == 0))
 119     type = g_boxed_type_register_static ("GstGError",
 120         (GBoxedCopyFunc) g_error_copy, (GBoxedFreeFunc) g_error_free);
 121   return type;
 122 }
 123
 124 #define FILE_A_BUG "  Please file a bug at " PACKAGE_BUGREPORT "."
 125
 126 /* initialize the dynamic table of translated core errors */
 127 static gchar **
 128 _gst_core_errors_init (void)
 129 {
 130   gchar **t = NULL;
 131
 132   t = g_new0 (gchar *, GST_CORE_ERROR_NUM_ERRORS);
 133
 134   TABLE (t, CORE, FAILED,
 135       N_("GStreamer encountered a general core library error."));
 136   TABLE (t, CORE, TOO_LAZY,
 137       N_("GStreamer developers were too lazy to assign an error code "
 138           "to this error." FILE_A_BUG));
 139   TABLE (t, CORE, NOT_IMPLEMENTED,
 140       N_("Internal GStreamer error: code not implemented." FILE_A_BUG));
 141   TABLE (t, CORE, STATE_CHANGE,
 142       N_("Internal GStreamer error: state change failed." FILE_A_BUG));
 143   TABLE (t, CORE, PAD, N_("Internal GStreamer error: pad problem." FILE_A_BUG));
 144   TABLE (t, CORE, THREAD,
 145       N_("Internal GStreamer error: thread problem." FILE_A_BUG));
 146   TABLE (t, CORE, NEGOTIATION,
 147       N_("Internal GStreamer error: negotiation problem." FILE_A_BUG));
 148   TABLE (t, CORE, EVENT,
 149       N_("Internal GStreamer error: event problem." FILE_A_BUG));
 150   TABLE (t, CORE, SEEK,
 151       N_("Internal GStreamer error: seek problem." FILE_A_BUG));
 152   TABLE (t, CORE, CAPS,
 153       N_("Internal GStreamer error: caps problem." FILE_A_BUG));
 154   TABLE (t, CORE, TAG, N_("Internal GStreamer error: tag problem." FILE_A_BUG));
 155   TABLE (t, CORE, MISSING_PLUGIN,
 156       N_("Your GStreamer installation is missing a plug-in."));
 157   TABLE (t, CORE, CLOCK,
 158       N_("Internal GStreamer error: clock problem." FILE_A_BUG));
 159
 160   return t;
 161 }
 162
 163 /* initialize the dynamic table of translated library errors */
 164 static gchar **
 165 _gst_library_errors_init (void)
 166 {
 167   gchar **t = NULL;
 168
 169   t = g_new0 (gchar *, GST_LIBRARY_ERROR_NUM_ERRORS);
 170
 171   TABLE (t, LIBRARY, FAILED,
 172       N_("GStreamer encountered a general supporting library error."));
 173   TABLE (t, LIBRARY, TOO_LAZY,
 174       N_("GStreamer developers were too lazy to assign an error code "
 175           "to this error." FILE_A_BUG));
 176   TABLE (t, LIBRARY, INIT, N_("Could not initialize supporting library."));
 177   TABLE (t, LIBRARY, SHUTDOWN, N_("Could not close supporting library."));
 178   TABLE (t, LIBRARY, SETTINGS, N_("Could not close supporting library."));
 179
 180   return t;
 181 }
 182
 183 /* initialize the dynamic table of translated resource errors */
 184 static gchar **
 185 _gst_resource_errors_init (void)
 186 {
 187   gchar **t = NULL;
 188
 189   t = g_new0 (gchar *, GST_RESOURCE_ERROR_NUM_ERRORS);
 190
 191   TABLE (t, RESOURCE, FAILED,
 192       N_("GStreamer encountered a general resource error."));
 193   TABLE (t, RESOURCE, TOO_LAZY,
 194       N_("GStreamer developers were too lazy to assign an error code "
 195           "to this error." FILE_A_BUG));
 196   TABLE (t, RESOURCE, NOT_FOUND, N_("Resource not found."));
 197   TABLE (t, RESOURCE, BUSY, N_("Resource busy or not available."));
 198   TABLE (t, RESOURCE, OPEN_READ, N_("Could not open resource for reading."));
 199   TABLE (t, RESOURCE, OPEN_WRITE, N_("Could not open resource for writing."));
 200   TABLE (t, RESOURCE, OPEN_READ_WRITE,
 201       N_("Could not open resource for reading and writing."));
 202   TABLE (t, RESOURCE, CLOSE, N_("Could not close resource."));
 203   TABLE (t, RESOURCE, READ, N_("Could not read from resource."));
 204   TABLE (t, RESOURCE, WRITE, N_("Could not write to resource."));
 205   TABLE (t, RESOURCE, SEEK, N_("Could not perform seek on resource."));
 206   TABLE (t, RESOURCE, SYNC, N_("Could not synchronize on resource."));
 207   TABLE (t, RESOURCE, SETTINGS,
 208       N_("Could not get/set settings from/on resource."));
 209   TABLE (t, RESOURCE, NO_SPACE_LEFT, N_("No space left on the resource."));
 210
 211   return t;
 212 }
 213
 214 /* initialize the dynamic table of translated stream errors */
 215 static gchar **
 216 _gst_stream_errors_init (void)
 217 {
 218   gchar **t = NULL;
 219
 220   t = g_new0 (gchar *, GST_STREAM_ERROR_NUM_ERRORS);
 221
 222   TABLE (t, STREAM, FAILED,
 223       N_("GStreamer encountered a general stream error."));
 224   TABLE (t, STREAM, TOO_LAZY,
 225       N_("GStreamer developers were too lazy to assign an error code "
 226           "to this error." FILE_A_BUG));
 227   TABLE (t, STREAM, NOT_IMPLEMENTED,
 228       N_("Element doesn't implement handling of this stream. "
 229           "Please file a bug."));
 230   TABLE (t, STREAM, TYPE_NOT_FOUND, N_("Could not determine type of stream."));
 231   TABLE (t, STREAM, WRONG_TYPE,
 232       N_("The stream is of a different type than handled by this element."));
 233   TABLE (t, STREAM, CODEC_NOT_FOUND,
 234       N_("There is no codec present that can handle the stream's type."));
 235   TABLE (t, STREAM, DECODE, N_("Could not decode stream."));
 236   TABLE (t, STREAM, ENCODE, N_("Could not encode stream."));
 237   TABLE (t, STREAM, DEMUX, N_("Could not demultiplex stream."));
 238   TABLE (t, STREAM, MUX, N_("Could not multiplex stream."));
 239   TABLE (t, STREAM, FORMAT, N_("The stream is in the wrong format."));
 240
 241   return t;
 242 }
 243
 244 QUARK_FUNC (core);
 245 QUARK_FUNC (library);
 246 QUARK_FUNC (resource);
 247 QUARK_FUNC (stream);
 248
 249 /**
 250  * gst_error_get_message:
 251  * @domain: the GStreamer error domain this error belongs to.
 252  * @code: the error code belonging to the domain.
 253  *
 254  * Get a string describing the error message in the current locale.
 255  *
 256  * Returns: a newly allocated string describing the error message in the
 257  * current locale.
 258  */
 259 gchar *
 260 gst_error_get_message (GQuark domain, gint code)
 261 {
 262   static gchar **gst_core_errors = NULL;
 263   static gchar **gst_library_errors = NULL;
 264   static gchar **gst_resource_errors = NULL;
 265   static gchar **gst_stream_errors = NULL;
 266
 267   gchar *message = NULL;
 268
 269   /* initialize error message tables if necessary */
 270   if (gst_core_errors == NULL)
 271     gst_core_errors = _gst_core_errors_init ();
 272   if (gst_library_errors == NULL)
 273     gst_library_errors = _gst_library_errors_init ();
 274   if (gst_resource_errors == NULL)
 275     gst_resource_errors = _gst_resource_errors_init ();
 276   if (gst_stream_errors == NULL)
 277     gst_stream_errors = _gst_stream_errors_init ();
 278
 279
 280   if (domain == GST_CORE_ERROR)
 281     message = gst_core_errors[code];
 282   else if (domain == GST_LIBRARY_ERROR)
 283     message = gst_library_errors[code];
 284   else if (domain == GST_RESOURCE_ERROR)
 285     message = gst_resource_errors[code];
 286   else if (domain == GST_STREAM_ERROR)
 287     message = gst_stream_errors[code];
 288   else {
 289     g_warning ("No error messages for domain %s", g_quark_to_string (domain));
 290     return g_strdup_printf (_("No error message for domain %s."),
 291         g_quark_to_string (domain));
 292   }
 293   if (message)
 294     return g_strdup (_(message));
 295   else
 296     return
 297         g_strdup_printf (_
 298         ("No standard error message for domain %s and code %d."),
 299         g_quark_to_string (domain), code);
 300 }