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