fp-byte-writer.h 13.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
/* GStreamer byte writer
 *
 * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __FP_BYTE_WRITER_H__
#define __FP_BYTE_WRITER_H__

#include "fp-byte-reader.h"
#include <string.h>

G_BEGIN_DECLS

#define FP_BYTE_WRITER(writer) ((FpByteWriter *) (writer))

/**
 * FpByteWriter:
 * @parent: #FpByteReader parent
 * @alloc_size: Allocation size of the data
 * @fixed: If %TRUE no reallocations are allowed
 * @owned: If %FALSE no reallocations are allowed and copies of data are returned
 *
 * A byte writer instance.
 */
typedef struct {
  FpByteReader parent;

  guint alloc_size;

  gboolean fixed;
  gboolean owned;

  /* < private > */
} FpByteWriter;


FpByteWriter * fp_byte_writer_new             (void) G_GNUC_MALLOC;


FpByteWriter * fp_byte_writer_new_with_size   (guint size, gboolean fixed) G_GNUC_MALLOC;


FpByteWriter * fp_byte_writer_new_with_data   (guint8 *data, guint size, gboolean initialized) G_GNUC_MALLOC;


void            fp_byte_writer_init            (FpByteWriter *writer);


void            fp_byte_writer_init_with_size  (FpByteWriter *writer, guint size, gboolean fixed);


void            fp_byte_writer_init_with_data  (FpByteWriter *writer, guint8 *data,
                                                 guint size, gboolean initialized);

void            fp_byte_writer_free                    (FpByteWriter *writer);


guint8 *        fp_byte_writer_free_and_get_data       (FpByteWriter *writer);


void            fp_byte_writer_reset                   (FpByteWriter *writer);


guint8 *        fp_byte_writer_reset_and_get_data      (FpByteWriter *writer);

/**
 * fp_byte_writer_get_pos:
 * @writer: #FpByteWriter instance
 *
 * Returns: The current position of the read/write cursor
 */
/**
 * fp_byte_writer_set_pos:
 * @writer: #FpByteWriter instance
 * @pos: new position
 *
 * Sets the current read/write cursor of @writer. The new position
 * can only be between 0 and the current size.
 *
 * Returns: %TRUE if the new position could be set
 */
/**
 * fp_byte_writer_get_size:
 * @writer: #FpByteWriter instance
 *
 * Returns: The current, initialized size of the data
 */
static inline guint
fp_byte_writer_get_pos (const FpByteWriter *writer)
{
  return fp_byte_reader_get_pos ((const FpByteReader *) writer);
}

static inline gboolean
fp_byte_writer_set_pos (FpByteWriter *writer, guint pos)
{
  return fp_byte_reader_set_pos (FP_BYTE_READER (writer), pos);
}

static inline guint
fp_byte_writer_get_size (const FpByteWriter *writer)
{
  return fp_byte_reader_get_size ((const FpByteReader *) writer);
}


guint           fp_byte_writer_get_remaining     (const FpByteWriter *writer);


gboolean        fp_byte_writer_ensure_free_space (FpByteWriter *writer, guint size);


gboolean        fp_byte_writer_put_uint8         (FpByteWriter *writer, guint8 val);


gboolean        fp_byte_writer_put_int8          (FpByteWriter *writer, gint8 val);


gboolean        fp_byte_writer_put_uint16_be     (FpByteWriter *writer, guint16 val);


gboolean        fp_byte_writer_put_uint16_le     (FpByteWriter *writer, guint16 val);


gboolean        fp_byte_writer_put_int16_be      (FpByteWriter *writer, gint16 val);


gboolean        fp_byte_writer_put_int16_le      (FpByteWriter *writer, gint16 val);


gboolean        fp_byte_writer_put_uint24_be     (FpByteWriter *writer, guint32 val);


gboolean        fp_byte_writer_put_uint24_le     (FpByteWriter *writer, guint32 val);


gboolean        fp_byte_writer_put_int24_be      (FpByteWriter *writer, gint32 val);


gboolean        fp_byte_writer_put_int24_le      (FpByteWriter *writer, gint32 val);


gboolean        fp_byte_writer_put_uint32_be     (FpByteWriter *writer, guint32 val);


gboolean        fp_byte_writer_put_uint32_le     (FpByteWriter *writer, guint32 val);


gboolean        fp_byte_writer_put_int32_be      (FpByteWriter *writer, gint32 val);


gboolean        fp_byte_writer_put_int32_le      (FpByteWriter *writer, gint32 val);


gboolean        fp_byte_writer_put_uint64_be     (FpByteWriter *writer, guint64 val);


gboolean        fp_byte_writer_put_uint64_le     (FpByteWriter *writer, guint64 val);


gboolean        fp_byte_writer_put_int64_be      (FpByteWriter *writer, gint64 val);


gboolean        fp_byte_writer_put_int64_le      (FpByteWriter *writer, gint64 val);


gboolean        fp_byte_writer_put_float32_be    (FpByteWriter *writer, gfloat val);


gboolean        fp_byte_writer_put_float32_le    (FpByteWriter *writer, gfloat val);


gboolean        fp_byte_writer_put_float64_be    (FpByteWriter *writer, gdouble val);


gboolean        fp_byte_writer_put_float64_le    (FpByteWriter *writer, gdouble val);


gboolean        fp_byte_writer_put_data          (FpByteWriter *writer, const guint8 *data, guint size);


gboolean        fp_byte_writer_fill              (FpByteWriter *writer, guint8 value, guint size);


gboolean        fp_byte_writer_put_string_utf8   (FpByteWriter *writer, const gchar *data);


gboolean        fp_byte_writer_put_string_utf16  (FpByteWriter *writer, const guint16 *data);


gboolean        fp_byte_writer_put_string_utf32  (FpByteWriter *writer, const guint32 *data);

/**
 * fp_byte_writer_put_string:
 * @writer: #FpByteWriter instance
 * @data: (in) (array zero-terminated=1): Null terminated string
 *
 * Write a NUL-terminated string to @writer (including the terminator). The
 * string is assumed to be in an 8-bit encoding (e.g. ASCII,UTF-8 or
 * ISO-8859-1).
 *
 * Returns: %TRUE if the string could be written
 */
#define fp_byte_writer_put_string(writer, data) \
  fp_byte_writer_put_string_utf8(writer, data)

static inline guint
_fp_byte_writer_next_pow2 (guint n)
{
  guint ret = 16;

  /* We start with 16, smaller allocations make no sense */

  while (ret < n && ret > 0)
    ret <<= 1;

  return ret ? ret : n;
}

static inline gboolean
_fp_byte_writer_ensure_free_space_inline (FpByteWriter * writer, guint size)
{
  gpointer data;

  if (G_LIKELY (size <= writer->alloc_size - writer->parent.byte))
    return TRUE;
  if (G_UNLIKELY (writer->fixed || !writer->owned))
    return FALSE;
  if (G_UNLIKELY (writer->parent.byte > G_MAXUINT - size))
    return FALSE;

  writer->alloc_size = _fp_byte_writer_next_pow2 (writer->parent.byte + size);
  data = g_try_realloc ((guint8 *) writer->parent.data, writer->alloc_size);
  if (G_UNLIKELY (data == NULL))
    return FALSE;

  writer->parent.data = (guint8 *) data;

  return TRUE;
}

#define __FP_BYTE_WRITER_CREATE_WRITE_FUNC(bits,type,name,write_func) \
static inline void \
fp_byte_writer_put_##name##_unchecked (FpByteWriter *writer, type val) \
{ \
  guint8 *write_data; \
  \
  write_data = (guint8 *) writer->parent.data + writer->parent.byte; \
  write_func (write_data, val); \
  writer->parent.byte += bits/8; \
  writer->parent.size = MAX (writer->parent.size, writer->parent.byte); \
} \
\
static inline gboolean \
_fp_byte_writer_put_##name##_inline (FpByteWriter *writer, type val) \
{ \
  g_return_val_if_fail (writer != NULL, FALSE); \
  \
  if (G_UNLIKELY (!_fp_byte_writer_ensure_free_space_inline(writer, bits/8))) \
    return FALSE; \
  \
  fp_byte_writer_put_##name##_unchecked (writer, val); \
  \
  return TRUE; \
}

__FP_BYTE_WRITER_CREATE_WRITE_FUNC (8, guint8, uint8, FP_WRITE_UINT8)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (8, gint8, int8, FP_WRITE_UINT8)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_le, FP_WRITE_UINT16_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_be, FP_WRITE_UINT16_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_le, FP_WRITE_UINT16_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_be, FP_WRITE_UINT16_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_le, FP_WRITE_UINT24_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_be, FP_WRITE_UINT24_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_le, FP_WRITE_UINT24_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_be, FP_WRITE_UINT24_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_le, FP_WRITE_UINT32_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_be, FP_WRITE_UINT32_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_le, FP_WRITE_UINT32_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_be, FP_WRITE_UINT32_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_le, FP_WRITE_UINT64_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_be, FP_WRITE_UINT64_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_le, FP_WRITE_UINT64_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_be, FP_WRITE_UINT64_BE)

__FP_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_be, FP_WRITE_FLOAT_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_le, FP_WRITE_FLOAT_LE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_be, FP_WRITE_DOUBLE_BE)
__FP_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_le, FP_WRITE_DOUBLE_LE)

#undef __FP_BYTE_WRITER_CREATE_WRITE_FUNC

static inline void
fp_byte_writer_put_data_unchecked (FpByteWriter * writer, const guint8 * data,
    guint size)
{
  memcpy ((guint8 *) & writer->parent.data[writer->parent.byte], data, size);
  writer->parent.byte += size;
  writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
}

static inline gboolean
_fp_byte_writer_put_data_inline (FpByteWriter * writer, const guint8 * data,
    guint size)
{
  g_return_val_if_fail (writer != NULL, FALSE);

  if (G_UNLIKELY (!_fp_byte_writer_ensure_free_space_inline (writer, size)))
    return FALSE;

  fp_byte_writer_put_data_unchecked (writer, data, size);

  return TRUE;
}

static inline void
fp_byte_writer_fill_unchecked (FpByteWriter * writer, guint8 value, guint size)
{
  memset ((guint8 *) & writer->parent.data[writer->parent.byte], value, size);
  writer->parent.byte += size;
  writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
}

static inline gboolean
_fp_byte_writer_fill_inline (FpByteWriter * writer, guint8 value, guint size)
{
  g_return_val_if_fail (writer != NULL, FALSE);

  if (G_UNLIKELY (!_fp_byte_writer_ensure_free_space_inline (writer, size)))
    return FALSE;

  fp_byte_writer_fill_unchecked (writer, value, size);

  return TRUE;
}

#ifndef FP_BYTE_WRITER_DISABLE_INLINES

/* we use defines here so we can add the G_LIKELY() */

#define fp_byte_writer_ensure_free_space(writer, size) \
    G_LIKELY (_fp_byte_writer_ensure_free_space_inline (writer, size))
#define fp_byte_writer_put_uint8(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint8_inline (writer, val))
#define fp_byte_writer_put_int8(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int8_inline (writer, val))
#define fp_byte_writer_put_uint16_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint16_be_inline (writer, val))
#define fp_byte_writer_put_uint16_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint16_le_inline (writer, val))
#define fp_byte_writer_put_int16_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int16_be_inline (writer, val))
#define fp_byte_writer_put_int16_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int16_le_inline (writer, val))
#define fp_byte_writer_put_uint24_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint24_be_inline (writer, val))
#define fp_byte_writer_put_uint24_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint24_le_inline (writer, val))
#define fp_byte_writer_put_int24_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int24_be_inline (writer, val))
#define fp_byte_writer_put_int24_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int24_le_inline (writer, val))
#define fp_byte_writer_put_uint32_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint32_be_inline (writer, val))
#define fp_byte_writer_put_uint32_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint32_le_inline (writer, val))
#define fp_byte_writer_put_int32_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int32_be_inline (writer, val))
#define fp_byte_writer_put_int32_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int32_le_inline (writer, val))
#define fp_byte_writer_put_uint64_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint64_be_inline (writer, val))
#define fp_byte_writer_put_uint64_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_uint64_le_inline (writer, val))
#define fp_byte_writer_put_int64_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int64_be_inline (writer, val))
#define fp_byte_writer_put_int64_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_int64_le_inline (writer, val))

#define fp_byte_writer_put_float32_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_float32_be_inline (writer, val))
#define fp_byte_writer_put_float32_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_float32_le_inline (writer, val))
#define fp_byte_writer_put_float64_be(writer, val) \
    G_LIKELY (_fp_byte_writer_put_float64_be_inline (writer, val))
#define fp_byte_writer_put_float64_le(writer, val) \
    G_LIKELY (_fp_byte_writer_put_float64_le_inline (writer, val))

#define fp_byte_writer_put_data(writer, data, size) \
    G_LIKELY (_fp_byte_writer_put_data_inline (writer, data, size))
#define fp_byte_writer_fill(writer, val, size) \
    G_LIKELY (_fp_byte_writer_fill_inline (writer, val, size))

#endif

G_END_DECLS

#endif /* __FP_BYTE_WRITER_H__ */