libs/gst/base/gstbytewriter.h

   1 /* GStreamer byte writer
   2  *
   3  * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>.
   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_BYTE_WRITER_H__
  22 #define __GST_BYTE_WRITER_H__
  23
  24 #include <gst/gst.h>
  25 #include <gst/base/gstbytereader.h>
  26
  27 #include <string.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_BYTE_WRITER(writer) ((GstByteWriter *) (writer))
  32
  33 /**
  34  * GstByteWriter:
  35  * @parent: #GstByteReader parent
  36  * @alloc_size: Allocation size of the data
  37  * @fixed: If %TRUE no reallocations are allowed
  38  * @owned: If %FALSE no reallocations are allowed and copies of data are returned
  39  *
  40  * A byte writer instance.
  41  */
  42 typedef struct {
  43   GstByteReader parent;
  44
  45   guint alloc_size;
  46
  47   gboolean fixed;
  48   gboolean owned;
  49
  50   /* < private > */
  51   gpointer _gst_reserved[GST_PADDING];
  52 } GstByteWriter;
  53
  54 GstByteWriter * gst_byte_writer_new             (void);
  55 GstByteWriter * gst_byte_writer_new_with_size   (guint size, gboolean fixed);
  56 GstByteWriter * gst_byte_writer_new_with_data   (guint8 *data, guint size, gboolean initialized);
  57
  58 void            gst_byte_writer_init            (GstByteWriter *writer);
  59 void            gst_byte_writer_init_with_size  (GstByteWriter *writer, guint size, gboolean fixed);
  60 void            gst_byte_writer_init_with_data  (GstByteWriter *writer, guint8 *data,
  61                                                  guint size, gboolean initialized);
  62
  63 void            gst_byte_writer_free                    (GstByteWriter *writer);
  64 guint8 *        gst_byte_writer_free_and_get_data       (GstByteWriter *writer);
  65 GstBuffer *     gst_byte_writer_free_and_get_buffer     (GstByteWriter *writer);
  66
  67 void            gst_byte_writer_reset                   (GstByteWriter *writer);
  68 guint8 *        gst_byte_writer_reset_and_get_data      (GstByteWriter *writer);
  69 GstBuffer *     gst_byte_writer_reset_and_get_buffer    (GstByteWriter *writer);
  70
  71 /**
  72  * gst_byte_writer_get_pos:
  73  * @writer: #GstByteWriter instance
  74  *
  75  * Returns: The current position of the read/write cursor
  76  *
  77  * Since: 0.10.26
  78  */
  79 /**
  80  * gst_byte_writer_set_pos:
  81  * @writer: #GstByteWriter instance
  82  * @pos: new position
  83  *
  84  * Sets the current read/write cursor of @writer. The new position
  85  * can only be between 0 and the current size.
  86  *
  87  * Returns: %TRUE if the new position could be set
  88  *
  89  * Since: 0.10.26
  90  */
  91 /**
  92  * gst_byte_writer_get_size:
  93  * @writer: #GstByteWriter instance
  94  *
  95  * Returns: The current, initialized size of the data
  96  *
  97  * Since: 0.10.26
  98  */
  99 #ifdef _FOOL_GTK_DOC_
 100 G_INLINE_FUNC guint     gst_byte_writer_get_pos  (const GstByteWriter *writer);
 101 G_INLINE_FUNC gboolean  gst_byte_writer_set_pos  (GstByteWriter *writer, guint pos);
 102 G_INLINE_FUNC guint     gst_byte_writer_get_size (const GstByteWriter *writer);
 103 #else
 104 static inline guint
 105 gst_byte_writer_get_pos (const GstByteWriter *writer)
 106 {
 107   return gst_byte_reader_get_pos ((const GstByteReader *) writer);
 108 }
 109
 110 static inline gboolean
 111 gst_byte_writer_set_pos (GstByteWriter *writer, guint pos)
 112 {
 113   return gst_byte_reader_set_pos (GST_BYTE_READER (writer), pos);
 114 }
 115
 116 static inline guint
 117 gst_byte_writer_get_size (const GstByteWriter *writer)
 118 {
 119   return gst_byte_reader_get_size ((const GstByteReader *) writer);
 120 }
 121 #endif
 122
 123 guint           gst_byte_writer_get_remaining     (const GstByteWriter *writer);
 124 gboolean        gst_byte_writer_ensure_free_space (GstByteWriter *writer, guint size);
 125
 126 gboolean        gst_byte_writer_put_uint8         (GstByteWriter *writer, guint8 val);
 127 gboolean        gst_byte_writer_put_int8          (GstByteWriter *writer, gint8 val);
 128 gboolean        gst_byte_writer_put_uint16_be     (GstByteWriter *writer, guint16 val);
 129 gboolean        gst_byte_writer_put_uint16_le     (GstByteWriter *writer, guint16 val);
 130 gboolean        gst_byte_writer_put_int16_be      (GstByteWriter *writer, gint16 val);
 131 gboolean        gst_byte_writer_put_int16_le      (GstByteWriter *writer, gint16 val);
 132 gboolean        gst_byte_writer_put_uint24_be     (GstByteWriter *writer, guint32 val);
 133 gboolean        gst_byte_writer_put_uint24_le     (GstByteWriter *writer, guint32 val);
 134 gboolean        gst_byte_writer_put_int24_be      (GstByteWriter *writer, gint32 val);
 135 gboolean        gst_byte_writer_put_int24_le      (GstByteWriter *writer, gint32 val);
 136 gboolean        gst_byte_writer_put_uint32_be     (GstByteWriter *writer, guint32 val);
 137 gboolean        gst_byte_writer_put_uint32_le     (GstByteWriter *writer, guint32 val);
 138 gboolean        gst_byte_writer_put_int32_be      (GstByteWriter *writer, gint32 val);
 139 gboolean        gst_byte_writer_put_int32_le      (GstByteWriter *writer, gint32 val);
 140 gboolean        gst_byte_writer_put_uint64_be     (GstByteWriter *writer, guint64 val);
 141 gboolean        gst_byte_writer_put_uint64_le     (GstByteWriter *writer, guint64 val);
 142 gboolean        gst_byte_writer_put_int64_be      (GstByteWriter *writer, gint64 val);
 143 gboolean        gst_byte_writer_put_int64_le      (GstByteWriter *writer, gint64 val);
 144
 145 gboolean        gst_byte_writer_put_float32_be    (GstByteWriter *writer, gfloat val);
 146 gboolean        gst_byte_writer_put_float32_le    (GstByteWriter *writer, gfloat val);
 147 gboolean        gst_byte_writer_put_float64_be    (GstByteWriter *writer, gdouble val);
 148 gboolean        gst_byte_writer_put_float64_le    (GstByteWriter *writer, gdouble val);
 149
 150 gboolean        gst_byte_writer_put_data          (GstByteWriter *writer, const guint8 *data, guint size);
 151 gboolean        gst_byte_writer_fill              (GstByteWriter *writer, guint8 value, guint size);
 152 gboolean        gst_byte_writer_put_string_utf8   (GstByteWriter *writer, const gchar *data);
 153 gboolean        gst_byte_writer_put_string_utf16  (GstByteWriter *writer, const guint16 *data);
 154 gboolean        gst_byte_writer_put_string_utf32  (GstByteWriter *writer, const guint32 *data);
 155
 156 /**
 157  * gst_byte_writer_put_string:
 158  * @writer: #GstByteWriter instance
 159  * @data: (in) (array zero-terminated=1): Null terminated string
 160  *
 161  * Write a NUL-terminated string to @writer (including the terminator). The
 162  * string is assumed to be in an 8-bit encoding (e.g. ASCII,UTF-8 or
 163  * ISO-8859-1).
 164  *
 165  * Returns: %TRUE if the string could be written
 166  *
 167  * Since: 0.10.26
 168  */
 169 #define gst_byte_writer_put_string(writer, data) \
 170   gst_byte_writer_put_string_utf8(writer, data)
 171
 172 static inline guint
 173 _gst_byte_writer_next_pow2 (guint n)
 174 {
 175   guint ret = 16;
 176
 177   /* We start with 16, smaller allocations make no sense */
 178
 179   while (ret < n && ret > 0)
 180     ret <<= 1;
 181
 182   return ret ? ret : n;
 183 }
 184
 185 static inline gboolean
 186 _gst_byte_writer_ensure_free_space_inline (GstByteWriter * writer, guint size)
 187 {
 188   gpointer data;
 189
 190   if (G_LIKELY (size <= writer->alloc_size - writer->parent.byte))
 191     return TRUE;
 192   if (G_UNLIKELY (writer->fixed || !writer->owned))
 193     return FALSE;
 194   if (G_UNLIKELY (writer->parent.byte > G_MAXUINT - size))
 195     return FALSE;
 196
 197   writer->alloc_size = _gst_byte_writer_next_pow2 (writer->parent.byte + size);
 198   data = g_try_realloc ((guint8 *) writer->parent.data, writer->alloc_size);
 199   if (G_UNLIKELY (data == NULL))
 200     return FALSE;
 201
 202   writer->parent.data = (guint8 *) data;
 203
 204   return TRUE;
 205 }
 206
 207 #define __GST_BYTE_WRITER_CREATE_WRITE_FUNC(bits,type,name,write_func) \
 208 static inline void \
 209 gst_byte_writer_put_##name##_unchecked (GstByteWriter *writer, type val) \
 210 { \
 211   guint8 *write_data; \
 212   \
 213   write_data = (guint8 *) writer->parent.data + writer->parent.byte; \
 214   write_func (write_data, val); \
 215   writer->parent.byte += bits/8; \
 216   writer->parent.size = MAX (writer->parent.size, writer->parent.byte); \
 217 } \
 218 \
 219 static inline gboolean \
 220 _gst_byte_writer_put_##name##_inline (GstByteWriter *writer, type val) \
 221 { \
 222   g_return_val_if_fail (writer != NULL, FALSE); \
 223   \
 224   if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline(writer, bits/8))) \
 225     return FALSE; \
 226   \
 227   gst_byte_writer_put_##name##_unchecked (writer, val); \
 228   \
 229   return TRUE; \
 230 }
 231
 232 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (8, guint8, uint8, GST_WRITE_UINT8)
 233 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (8, gint8, int8, GST_WRITE_UINT8)
 234 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_le, GST_WRITE_UINT16_LE)
 235 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_be, GST_WRITE_UINT16_BE)
 236 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_le, GST_WRITE_UINT16_LE)
 237 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_be, GST_WRITE_UINT16_BE)
 238 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_le, GST_WRITE_UINT24_LE)
 239 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_be, GST_WRITE_UINT24_BE)
 240 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_le, GST_WRITE_UINT24_LE)
 241 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_be, GST_WRITE_UINT24_BE)
 242 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_le, GST_WRITE_UINT32_LE)
 243 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_be, GST_WRITE_UINT32_BE)
 244 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_le, GST_WRITE_UINT32_LE)
 245 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_be, GST_WRITE_UINT32_BE)
 246 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_le, GST_WRITE_UINT64_LE)
 247 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_be, GST_WRITE_UINT64_BE)
 248 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_le, GST_WRITE_UINT64_LE)
 249 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_be, GST_WRITE_UINT64_BE)
 250
 251 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_be, GST_WRITE_FLOAT_BE)
 252 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_le, GST_WRITE_FLOAT_LE)
 253 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_be, GST_WRITE_DOUBLE_BE)
 254 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_le, GST_WRITE_DOUBLE_LE)
 255
 256 #undef __GST_BYTE_WRITER_CREATE_WRITE_FUNC
 257
 258 static inline void
 259 gst_byte_writer_put_data_unchecked (GstByteWriter * writer, const guint8 * data,
 260     guint size)
 261 {
 262   memcpy ((guint8 *) & writer->parent.data[writer->parent.byte], data, size);
 263   writer->parent.byte += size;
 264   writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
 265 }
 266
 267 static inline gboolean
 268 _gst_byte_writer_put_data_inline (GstByteWriter * writer, const guint8 * data,
 269     guint size)
 270 {
 271   g_return_val_if_fail (writer != NULL, FALSE);
 272
 273   if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
 274     return FALSE;
 275
 276   gst_byte_writer_put_data_unchecked (writer, data, size);
 277
 278   return TRUE;
 279 }
 280
 281 static inline void
 282 gst_byte_writer_fill_unchecked (GstByteWriter * writer, guint8 value, guint size)
 283 {
 284   memset ((guint8 *) & writer->parent.data[writer->parent.byte], value, size);
 285   writer->parent.byte += size;
 286   writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
 287 }
 288
 289 static inline gboolean
 290 _gst_byte_writer_fill_inline (GstByteWriter * writer, guint8 value, guint size)
 291 {
 292   g_return_val_if_fail (writer != NULL, FALSE);
 293
 294   if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
 295     return FALSE;
 296
 297   gst_byte_writer_fill_unchecked (writer, value, size);
 298
 299   return TRUE;
 300 }
 301
 302 #ifndef GST_BYTE_WRITER_DISABLE_INLINES
 303
 304 /* we use defines here so we can add the G_LIKELY() */
 305
 306 #define gst_byte_writer_ensure_free_space(writer, size) \
 307     G_LIKELY (_gst_byte_writer_ensure_free_space_inline (writer, size))
 308 #define gst_byte_writer_put_uint8(writer, val) \
 309     G_LIKELY (_gst_byte_writer_put_uint8_inline (writer, val))
 310 #define gst_byte_writer_put_int8(writer, val) \
 311     G_LIKELY (_gst_byte_writer_put_int8_inline (writer, val))
 312 #define gst_byte_writer_put_uint16_be(writer, val) \
 313     G_LIKELY (_gst_byte_writer_put_uint16_be_inline (writer, val))
 314 #define gst_byte_writer_put_uint16_le(writer, val) \
 315     G_LIKELY (_gst_byte_writer_put_uint16_le_inline (writer, val))
 316 #define gst_byte_writer_put_int16_be(writer, val) \
 317     G_LIKELY (_gst_byte_writer_put_int16_be_inline (writer, val))
 318 #define gst_byte_writer_put_int16_le(writer, val) \
 319     G_LIKELY (_gst_byte_writer_put_int16_le_inline (writer, val))
 320 #define gst_byte_writer_put_uint24_be(writer, val) \
 321     G_LIKELY (_gst_byte_writer_put_uint24_be_inline (writer, val))
 322 #define gst_byte_writer_put_uint24_le(writer, val) \
 323     G_LIKELY (_gst_byte_writer_put_uint24_le_inline (writer, val))
 324 #define gst_byte_writer_put_int24_be(writer, val) \
 325     G_LIKELY (_gst_byte_writer_put_int24_be_inline (writer, val))
 326 #define gst_byte_writer_put_int24_le(writer, val) \
 327     G_LIKELY (_gst_byte_writer_put_int24_le_inline (writer, val))
 328 #define gst_byte_writer_put_uint32_be(writer, val) \
 329     G_LIKELY (_gst_byte_writer_put_uint32_be_inline (writer, val))
 330 #define gst_byte_writer_put_uint32_le(writer, val) \
 331     G_LIKELY (_gst_byte_writer_put_uint32_le_inline (writer, val))
 332 #define gst_byte_writer_put_int32_be(writer, val) \
 333     G_LIKELY (_gst_byte_writer_put_int32_be_inline (writer, val))
 334 #define gst_byte_writer_put_int32_le(writer, val) \
 335     G_LIKELY (_gst_byte_writer_put_int32_le_inline (writer, val))
 336 #define gst_byte_writer_put_uint64_be(writer, val) \
 337     G_LIKELY (_gst_byte_writer_put_uint64_be_inline (writer, val))
 338 #define gst_byte_writer_put_uint64_le(writer, val) \
 339     G_LIKELY (_gst_byte_writer_put_uint64_le_inline (writer, val))
 340 #define gst_byte_writer_put_int64_be(writer, val) \
 341     G_LIKELY (_gst_byte_writer_put_int64_be_inline (writer, val))
 342 #define gst_byte_writer_put_int64_le(writer, val) \
 343     G_LIKELY (_gst_byte_writer_put_int64_le_inline (writer, val))
 344
 345 #define gst_byte_writer_put_float32_be(writer, val) \
 346     G_LIKELY (_gst_byte_writer_put_float32_be_inline (writer, val))
 347 #define gst_byte_writer_put_float32_le(writer, val) \
 348     G_LIKELY (_gst_byte_writer_put_float32_le_inline (writer, val))
 349 #define gst_byte_writer_put_float64_be(writer, val) \
 350     G_LIKELY (_gst_byte_writer_put_float64_be_inline (writer, val))
 351 #define gst_byte_writer_put_float64_le(writer, val) \
 352     G_LIKELY (_gst_byte_writer_put_float64_le_inline (writer, val))
 353
 354 #define gst_byte_writer_put_data(writer, data, size) \
 355     G_LIKELY (_gst_byte_writer_put_data_inline (writer, data, size))
 356 #define gst_byte_writer_fill(writer, val, size) \
 357     G_LIKELY (_gst_byte_writer_fill_inline (writer, val, size))
 358
 359 #endif
 360
 361 G_END_DECLS
 362
 363 #endif /* __GST_BYTE_WRITER_H__ */