git.maemo.org Git - mafwsubrenderer/blob - gst-plugins-base-subtitles0.10/gst-libs/gst/tag/gsttagdemux.h

   1 /* GStreamer Base Class for Tag Demuxing
   2  * Copyright (C) 2005  Jan Schmidt <thaytan@mad.scientist.com>
   3  * Copyright (C) 2006  Tim-Philipp Müller <tim centricular net>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GST_TAG_DEMUX_H__
  22 #define __GST_TAG_DEMUX_H__
  23
  24 #include <gst/gst.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define GST_TYPE_TAG_DEMUX            (gst_tag_demux_get_type())
  29 #define GST_TAG_DEMUX(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_TAG_DEMUX,GstTagDemux))
  30 #define GST_TAG_DEMUX_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_TAG_DEMUX,GstTagDemuxClass))
  31 #define GST_IS_TAG_DEMUX(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_TAG_DEMUX))
  32 #define GST_IS_TAG_DEMUX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_TAG_DEMUX))
  33
  34 typedef struct _GstTagDemux        GstTagDemux;
  35 typedef struct _GstTagDemuxClass   GstTagDemuxClass;
  36 typedef struct _GstTagDemuxPrivate GstTagDemuxPrivate;
  37
  38 /**
  39  * GstTagDemuxResult:
  40  * @GST_TAG_DEMUX_RESULT_BROKEN_TAG: cannot parse tag, just skip it
  41  * @GST_TAG_DEMUX_RESULT_AGAIN     : call again with less or more data
  42  * @GST_TAG_DEMUX_RESULT_OK        : parsed tag successfully
  43  *
  44  * Result values from the parse_tag virtual function.
  45  *
  46  * Since: 0.10.15
  47  */
  48 typedef enum {
  49   GST_TAG_DEMUX_RESULT_BROKEN_TAG,
  50   GST_TAG_DEMUX_RESULT_AGAIN,
  51   GST_TAG_DEMUX_RESULT_OK
  52 } GstTagDemuxResult;
  53
  54 GType gst_tag_demux_result_get_type (void);
  55 #define GST_TYPE_TAG_DEMUX_RESULT (gst_tag_demux_result_get_type())
  56
  57 /**
  58  * GstTagDemux:
  59  * @element: parent element
  60  *
  61  * Opaque #GstTagDemux structure.
  62  *
  63  * Since: 0.10.15
  64  */
  65 struct _GstTagDemux
  66 {
  67   GstElement element;
  68
  69   /*< private >*/
  70   GstTagDemuxPrivate  *priv;
  71
  72   gpointer             reserved[GST_PADDING];
  73 };
  74
  75 /**
  76  * GstTagDemuxClass:
  77  * @parent_class: the parent class.
  78  * @min_start_size: minimum size required to identify a tag at the start and
  79  * determine its total size. Set to 0 if not interested in start tags.
  80  * Subclasses should set this in their class_init function.
  81  * @min_end_size: minimum size required to identify a tag at the end and
  82  * determine its total size. Set to 0 if not interested in end tags.
  83  * Subclasses should set this in their class_init function.
  84  * @identify_tag: identify tag and determine the size required to parse the
  85  * tag. Buffer may be larger than the specified minimum size.
  86  * Subclassed MUST override this vfunc in their class_init function.
  87  * @parse_tag: parse the tag. Buffer will be exactly of the size determined by
  88  * the identify_tag vfunc before. The parse_tag vfunc may change the size
  89  * stored in *tag_size and return GST_TAG_DEMUX_RESULT_AGAIN to request a
  90  * larger or smaller buffer. It is also permitted to adjust the tag_size to a
  91  * smaller value and then return GST_TAG_DEMUX_RESULT_OK in one go.
  92  * Subclassed MUST override the parse_tag vfunc in their class_init function.
  93  * @merge_tags: merge start and end tags. Subclasses may want to override this
  94  * vfunc to allow prioritising of start or end tag according to user
  95  * preference.  Note that both start_tags and end_tags may be NULL. By default
  96  * start tags are prefered over end tags.
  97  *
  98  * The #GstTagDemuxClass structure.  See documentation at beginning of section
  99  * for details about what subclasses need to override and do.
 100  *
 101  * Since: 0.10.15
 102  */
 103 struct _GstTagDemuxClass
 104 {
 105   GstElementClass parent_class;
 106
 107   /* minimum size required to identify a tag at the start and determine
 108    * its total size */
 109   guint                  min_start_size;
 110
 111   /* minimum size required to identify a tag at the end and determine
 112    * its total size */
 113   guint                  min_end_size;
 114
 115   /* vtable */
 116
 117   /* identify tag and determine the size required to parse the tag */
 118   gboolean               (*identify_tag)  (GstTagDemux * demux,
 119                                            GstBuffer   * buffer,
 120                                            gboolean      start_tag,
 121                                            guint       * tag_size);
 122
 123   /* parse the tag once it is identified and its size is known */
 124   GstTagDemuxResult      (*parse_tag)     (GstTagDemux * demux,
 125                                            GstBuffer   * buffer,
 126                                            gboolean      start_tag,
 127                                            guint       * tag_size,
 128                                            GstTagList ** tags);
 129
 130   /* merge start and end tags (optional) */
 131   GstTagList *           (*merge_tags)    (GstTagDemux      * demux,
 132                                            const GstTagList * start_tags,
 133                                            const GstTagList * end_tags);
 134
 135   /*< private >*/
 136   gpointer               reserved[GST_PADDING];
 137 };
 138
 139 GType     gst_tag_demux_get_type (void);
 140
 141 G_END_DECLS
 142
 143 #endif /* __GST_TAG_DEMUX_H__ */
 144