gst/matroska/ebml-read.h

   1 /* GStreamer EBML I/O
   2  * (c) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  *
   4  * ebml-read.c: read EBML data from file/stream
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef __GST_EBML_READ_H__
  23 #define __GST_EBML_READ_H__
  24
  25 #include <gst/gst.h>
  26 #include <gst/base/gstbytereader.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define GST_TYPE_EBML_READ \
  31   (gst_ebml_read_get_type ())
  32 #define GST_EBML_READ(obj) \
  33   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_EBML_READ, GstEbmlRead))
  34 #define GST_EBML_READ_CLASS(klass) \
  35   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_EBML_READ, GstEbmlReadClass))
  36 #define GST_IS_EBML_READ(obj) \
  37   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_EBML_READ))
  38 #define GST_IS_EBML_READ_CLASS(klass) \
  39   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_EBML_READ))
  40 #define GST_EBML_READ_GET_CLASS(obj) \
  41   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_EBML_READ, GstEbmlReadClass))
  42
  43 GST_DEBUG_CATEGORY_EXTERN (ebmlread_debug);
  44
  45 /* custom flow return code */
  46 #define  GST_FLOW_PARSE  GST_FLOW_CUSTOM_ERROR
  47
  48 typedef struct _GstEbmlMaster {
  49   guint64       offset;
  50   GstByteReader br;
  51 } GstEbmlMaster;
  52
  53 typedef struct _GstEbmlRead {
  54   GstElement *el;
  55
  56   GstBuffer *buf;
  57   guint64 offset;
  58   GstMapInfo map;
  59
  60   GArray *readers;
  61 } GstEbmlRead;
  62
  63 typedef GstFlowReturn (*GstPeekData) (gpointer * context, guint peek, const guint8 ** data);
  64
  65 /* returns UNEXPECTED if not enough data */
  66 GstFlowReturn gst_ebml_peek_id_length    (guint32 * _id, guint64 * _length,
  67                                           guint * _needed,
  68                                           GstPeekData peek, gpointer * ctx,
  69                                           GstElement * el, guint64 offset);
  70
  71 void          gst_ebml_read_init         (GstEbmlRead * ebml,
  72                                           GstElement * el, GstBuffer * buf,
  73                                           guint64 offset);
  74
  75 void          gst_ebml_read_clear        (GstEbmlRead * ebml);
  76
  77 GstFlowReturn gst_ebml_peek_id           (GstEbmlRead * ebml, guint32 * id);
  78
  79 /* return _PARSE if not enough data to read what is needed, _ERROR or _OK */
  80 GstFlowReturn gst_ebml_read_skip         (GstEbmlRead *ebml);
  81
  82 GstFlowReturn gst_ebml_read_buffer       (GstEbmlRead *ebml,
  83                                           guint32     *id,
  84                                           GstBuffer  **buf);
  85
  86 GstFlowReturn gst_ebml_read_uint         (GstEbmlRead *ebml,
  87                                           guint32     *id,
  88                                           guint64     *num);
  89
  90 GstFlowReturn gst_ebml_read_sint         (GstEbmlRead *ebml,
  91                                           guint32     *id,
  92                                           gint64      *num);
  93
  94 GstFlowReturn gst_ebml_read_float        (GstEbmlRead *ebml,
  95                                           guint32     *id,
  96                                           gdouble     *num);
  97
  98 GstFlowReturn gst_ebml_read_ascii        (GstEbmlRead *ebml,
  99                                           guint32     *id,
 100                                           gchar      **str);
 101
 102 GstFlowReturn gst_ebml_read_utf8         (GstEbmlRead *ebml,
 103                                           guint32     *id,
 104                                           gchar      **str);
 105
 106 GstFlowReturn gst_ebml_read_date         (GstEbmlRead *ebml,
 107                                           guint32     *id,
 108                                           gint64      *date);
 109
 110 GstFlowReturn gst_ebml_read_master       (GstEbmlRead *ebml,
 111                                           guint32     *id);
 112
 113 GstFlowReturn gst_ebml_read_pop_master   (GstEbmlRead *ebml);
 114
 115 GstFlowReturn gst_ebml_read_binary       (GstEbmlRead *ebml,
 116                                           guint32     *id,
 117                                           guint8     **binary,
 118                                           guint64     *length);
 119
 120 GstFlowReturn gst_ebml_read_header       (GstEbmlRead *read,
 121                                           gchar      **doctype,
 122                                           guint       *version);
 123
 124 /* Returns current (absolute) position of Ebml parser,
 125  * i.e. taking into account offset provided at init */
 126 static inline guint64
 127 gst_ebml_read_get_pos (GstEbmlRead * ebml)
 128 {
 129   GstEbmlMaster *m;
 130
 131   g_return_val_if_fail (ebml->readers, 0);
 132   g_return_val_if_fail (ebml->readers->len, 0);
 133
 134   m = &(g_array_index (ebml->readers, GstEbmlMaster, ebml->readers->len - 1));
 135   return m->offset + gst_byte_reader_get_pos (&m->br);
 136 }
 137
 138 /* Returns starting offset of Ebml parser */
 139 static inline guint64
 140 gst_ebml_read_get_offset (GstEbmlRead * ebml)
 141 {
 142   return ebml->offset;
 143 }
 144
 145 static inline GstByteReader *
 146 gst_ebml_read_br (GstEbmlRead * ebml)
 147 {
 148   g_return_val_if_fail (ebml->readers, NULL);
 149   g_return_val_if_fail (ebml->readers->len, NULL);
 150
 151   return &(g_array_index (ebml->readers,
 152           GstEbmlMaster, ebml->readers->len - 1).br);
 153 }
 154
 155 static inline gboolean
 156 gst_ebml_read_has_remaining (GstEbmlRead * ebml, guint64 bytes_needed,
 157     gboolean auto_pop)
 158 {
 159   gboolean res;
 160
 161   res = (gst_byte_reader_get_remaining (gst_ebml_read_br (ebml)) >= bytes_needed);
 162   if (G_LIKELY (!res && auto_pop)) {
 163     gst_ebml_read_pop_master (ebml);
 164   }
 165
 166   return G_LIKELY (res);
 167 }
 168
 169 G_END_DECLS
 170
 171 #endif /* __GST_EBML_READ_H__ */