swfdec/swfdec_stream.h

   1 /* Swfdec
   2  * Copyright (C) 2006-2008 Benjamin Otte <otte@gnome.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 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  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301  USA
  18  */
  19
  20 #ifndef _SWFDEC_STREAM_H_
  21 #define _SWFDEC_STREAM_H_
  22
  23 #include <glib-object.h>
  24 #include <swfdec/swfdec_buffer.h>
  25
  26 G_BEGIN_DECLS
  27
  28 typedef struct _SwfdecStream SwfdecStream;
  29 typedef struct _SwfdecStreamClass SwfdecStreamClass;
  30 typedef struct _SwfdecStreamPrivate SwfdecStreamPrivate;
  31
  32 #define SWFDEC_TYPE_STREAM                    (swfdec_stream_get_type())
  33 #define SWFDEC_IS_STREAM(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SWFDEC_TYPE_STREAM))
  34 #define SWFDEC_IS_STREAM_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), SWFDEC_TYPE_STREAM))
  35 #define SWFDEC_STREAM(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), SWFDEC_TYPE_STREAM, SwfdecStream))
  36 #define SWFDEC_STREAM_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), SWFDEC_TYPE_STREAM, SwfdecStreamClass))
  37 #define SWFDEC_STREAM_GET_CLASS(obj)          (G_TYPE_INSTANCE_GET_CLASS ((obj), SWFDEC_TYPE_STREAM, SwfdecStreamClass))
  38
  39 struct _SwfdecStream
  40 {
  41   GObject               object;
  42
  43   /*< private >*/
  44   SwfdecStreamPrivate * priv;
  45 };
  46
  47 struct _SwfdecStreamClass
  48 {
  49   /*< private >*/
  50   GObjectClass          object_class;
  51
  52   /*< public >*/
  53   /* get a nice description string */
  54   const char *          (* describe)            (SwfdecStream *         stream);
  55   /* close the stream. */
  56   void                  (* close)               (SwfdecStream *         stream);
  57 };
  58
  59 GType           swfdec_stream_get_type          (void);
  60
  61 void            swfdec_stream_open              (SwfdecStream *         stream);
  62 gboolean        swfdec_stream_is_open           (SwfdecStream *         stream);
  63 gboolean        swfdec_stream_is_complete       (SwfdecStream *         stream);
  64 void            swfdec_stream_push              (SwfdecStream *         stream,
  65                                                  SwfdecBuffer *         buffer);
  66 void            swfdec_stream_close             (SwfdecStream *         stream);
  67 void            swfdec_stream_error             (SwfdecStream *         stream,
  68                                                  const char *           error,
  69                                                  ...) G_GNUC_PRINTF (2, 3);
  70 void            swfdec_stream_errorv            (SwfdecStream *         stream,
  71                                                  const char *           error,
  72                                                  va_list                args);
  73
  74 G_END_DECLS
  75 #endif