1 /* GStreamer byte writer
3 * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>.
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.
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.
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., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
21 #ifndef __GST_BYTE_WRITER_H__
22 #define __GST_BYTE_WRITER_H__
25 #include <gst/base/gstbytereader.h>
31 #define GST_BYTE_WRITER(writer) ((GstByteWriter *) (writer))
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
40 * A byte writer instance.
51 gpointer _gst_reserved[GST_PADDING];
54 GstByteWriter * gst_byte_writer_new (void) G_GNUC_MALLOC;
55 GstByteWriter * gst_byte_writer_new_with_size (guint size, gboolean fixed) G_GNUC_MALLOC;
56 GstByteWriter * gst_byte_writer_new_with_data (guint8 *data, guint size, gboolean initialized) G_GNUC_MALLOC;
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);
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) G_GNUC_MALLOC;
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) G_GNUC_MALLOC;
72 * gst_byte_writer_get_pos:
73 * @writer: #GstByteWriter instance
75 * Returns: The current position of the read/write cursor
78 * gst_byte_writer_set_pos:
79 * @writer: #GstByteWriter instance
82 * Sets the current read/write cursor of @writer. The new position
83 * can only be between 0 and the current size.
85 * Returns: %TRUE if the new position could be set
88 * gst_byte_writer_get_size:
89 * @writer: #GstByteWriter instance
91 * Returns: The current, initialized size of the data
94 G_INLINE_FUNC guint gst_byte_writer_get_pos (const GstByteWriter *writer);
95 G_INLINE_FUNC gboolean gst_byte_writer_set_pos (GstByteWriter *writer, guint pos);
96 G_INLINE_FUNC guint gst_byte_writer_get_size (const GstByteWriter *writer);
99 gst_byte_writer_get_pos (const GstByteWriter *writer)
101 return gst_byte_reader_get_pos ((const GstByteReader *) writer);
104 static inline gboolean
105 gst_byte_writer_set_pos (GstByteWriter *writer, guint pos)
107 return gst_byte_reader_set_pos (GST_BYTE_READER (writer), pos);
111 gst_byte_writer_get_size (const GstByteWriter *writer)
113 return gst_byte_reader_get_size ((const GstByteReader *) writer);
117 guint gst_byte_writer_get_remaining (const GstByteWriter *writer);
118 gboolean gst_byte_writer_ensure_free_space (GstByteWriter *writer, guint size);
120 gboolean gst_byte_writer_put_uint8 (GstByteWriter *writer, guint8 val);
121 gboolean gst_byte_writer_put_int8 (GstByteWriter *writer, gint8 val);
122 gboolean gst_byte_writer_put_uint16_be (GstByteWriter *writer, guint16 val);
123 gboolean gst_byte_writer_put_uint16_le (GstByteWriter *writer, guint16 val);
124 gboolean gst_byte_writer_put_int16_be (GstByteWriter *writer, gint16 val);
125 gboolean gst_byte_writer_put_int16_le (GstByteWriter *writer, gint16 val);
126 gboolean gst_byte_writer_put_uint24_be (GstByteWriter *writer, guint32 val);
127 gboolean gst_byte_writer_put_uint24_le (GstByteWriter *writer, guint32 val);
128 gboolean gst_byte_writer_put_int24_be (GstByteWriter *writer, gint32 val);
129 gboolean gst_byte_writer_put_int24_le (GstByteWriter *writer, gint32 val);
130 gboolean gst_byte_writer_put_uint32_be (GstByteWriter *writer, guint32 val);
131 gboolean gst_byte_writer_put_uint32_le (GstByteWriter *writer, guint32 val);
132 gboolean gst_byte_writer_put_int32_be (GstByteWriter *writer, gint32 val);
133 gboolean gst_byte_writer_put_int32_le (GstByteWriter *writer, gint32 val);
134 gboolean gst_byte_writer_put_uint64_be (GstByteWriter *writer, guint64 val);
135 gboolean gst_byte_writer_put_uint64_le (GstByteWriter *writer, guint64 val);
136 gboolean gst_byte_writer_put_int64_be (GstByteWriter *writer, gint64 val);
137 gboolean gst_byte_writer_put_int64_le (GstByteWriter *writer, gint64 val);
139 gboolean gst_byte_writer_put_float32_be (GstByteWriter *writer, gfloat val);
140 gboolean gst_byte_writer_put_float32_le (GstByteWriter *writer, gfloat val);
141 gboolean gst_byte_writer_put_float64_be (GstByteWriter *writer, gdouble val);
142 gboolean gst_byte_writer_put_float64_le (GstByteWriter *writer, gdouble val);
144 gboolean gst_byte_writer_put_data (GstByteWriter *writer, const guint8 *data, guint size);
145 gboolean gst_byte_writer_fill (GstByteWriter *writer, guint8 value, guint size);
146 gboolean gst_byte_writer_put_string_utf8 (GstByteWriter *writer, const gchar *data);
147 gboolean gst_byte_writer_put_string_utf16 (GstByteWriter *writer, const guint16 *data);
148 gboolean gst_byte_writer_put_string_utf32 (GstByteWriter *writer, const guint32 *data);
149 gboolean gst_byte_writer_put_buffer (GstByteWriter *writer, GstBuffer * buffer, gsize offset, gssize size);
152 * gst_byte_writer_put_string:
153 * @writer: #GstByteWriter instance
154 * @data: (in) (array zero-terminated=1): Null terminated string
156 * Write a NUL-terminated string to @writer (including the terminator). The
157 * string is assumed to be in an 8-bit encoding (e.g. ASCII,UTF-8 or
160 * Returns: %TRUE if the string could be written
162 #define gst_byte_writer_put_string(writer, data) \
163 gst_byte_writer_put_string_utf8(writer, data)
166 _gst_byte_writer_next_pow2 (guint n)
170 /* We start with 16, smaller allocations make no sense */
172 while (ret < n && ret > 0)
175 return ret ? ret : n;
178 static inline gboolean
179 _gst_byte_writer_ensure_free_space_inline (GstByteWriter * writer, guint size)
183 if (G_LIKELY (size <= writer->alloc_size - writer->parent.byte))
185 if (G_UNLIKELY (writer->fixed || !writer->owned))
187 if (G_UNLIKELY (writer->parent.byte > G_MAXUINT - size))
190 writer->alloc_size = _gst_byte_writer_next_pow2 (writer->parent.byte + size);
191 data = g_try_realloc ((guint8 *) writer->parent.data, writer->alloc_size);
192 if (G_UNLIKELY (data == NULL))
195 writer->parent.data = (guint8 *) data;
200 #define __GST_BYTE_WRITER_CREATE_WRITE_FUNC(bits,type,name,write_func) \
202 gst_byte_writer_put_##name##_unchecked (GstByteWriter *writer, type val) \
204 guint8 *write_data; \
206 write_data = (guint8 *) writer->parent.data + writer->parent.byte; \
207 write_func (write_data, val); \
208 writer->parent.byte += bits/8; \
209 writer->parent.size = MAX (writer->parent.size, writer->parent.byte); \
212 static inline gboolean \
213 _gst_byte_writer_put_##name##_inline (GstByteWriter *writer, type val) \
215 g_return_val_if_fail (writer != NULL, FALSE); \
217 if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline(writer, bits/8))) \
220 gst_byte_writer_put_##name##_unchecked (writer, val); \
225 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (8, guint8, uint8, GST_WRITE_UINT8)
226 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (8, gint8, int8, GST_WRITE_UINT8)
227 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_le, GST_WRITE_UINT16_LE)
228 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_be, GST_WRITE_UINT16_BE)
229 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_le, GST_WRITE_UINT16_LE)
230 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_be, GST_WRITE_UINT16_BE)
231 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_le, GST_WRITE_UINT24_LE)
232 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_be, GST_WRITE_UINT24_BE)
233 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_le, GST_WRITE_UINT24_LE)
234 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_be, GST_WRITE_UINT24_BE)
235 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_le, GST_WRITE_UINT32_LE)
236 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_be, GST_WRITE_UINT32_BE)
237 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_le, GST_WRITE_UINT32_LE)
238 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_be, GST_WRITE_UINT32_BE)
239 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_le, GST_WRITE_UINT64_LE)
240 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_be, GST_WRITE_UINT64_BE)
241 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_le, GST_WRITE_UINT64_LE)
242 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_be, GST_WRITE_UINT64_BE)
244 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_be, GST_WRITE_FLOAT_BE)
245 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_le, GST_WRITE_FLOAT_LE)
246 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_be, GST_WRITE_DOUBLE_BE)
247 __GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_le, GST_WRITE_DOUBLE_LE)
249 #undef __GST_BYTE_WRITER_CREATE_WRITE_FUNC
252 gst_byte_writer_put_data_unchecked (GstByteWriter * writer, const guint8 * data,
255 memcpy ((guint8 *) & writer->parent.data[writer->parent.byte], data, size);
256 writer->parent.byte += size;
257 writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
260 static inline gboolean
261 _gst_byte_writer_put_data_inline (GstByteWriter * writer, const guint8 * data,
264 g_return_val_if_fail (writer != NULL, FALSE);
266 if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
269 gst_byte_writer_put_data_unchecked (writer, data, size);
275 gst_byte_writer_fill_unchecked (GstByteWriter * writer, guint8 value, guint size)
277 memset ((guint8 *) & writer->parent.data[writer->parent.byte], value, size);
278 writer->parent.byte += size;
279 writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
282 static inline gboolean
283 _gst_byte_writer_fill_inline (GstByteWriter * writer, guint8 value, guint size)
285 g_return_val_if_fail (writer != NULL, FALSE);
287 if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
290 gst_byte_writer_fill_unchecked (writer, value, size);
296 gst_byte_writer_put_buffer_unchecked (GstByteWriter * writer, GstBuffer * buffer,
297 gsize offset, gssize size)
300 size = gst_buffer_get_size (buffer);
302 if (offset >= (gsize) size)
308 gst_buffer_extract (buffer, offset,
309 (guint8 *) & writer->parent.data[writer->parent.byte], size);
310 writer->parent.byte += size;
311 writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
314 static inline gboolean
315 _gst_byte_writer_put_buffer_inline (GstByteWriter * writer, GstBuffer * buffer,
316 gsize offset, gssize size)
318 g_return_val_if_fail (writer != NULL, FALSE);
319 g_return_val_if_fail (size >= -1, FALSE);
322 size = gst_buffer_get_size (buffer);
324 if (offset >= (gsize) size)
330 if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
333 gst_byte_writer_put_buffer_unchecked (writer, buffer, offset, size);
338 #ifndef GST_BYTE_WRITER_DISABLE_INLINES
340 /* we use defines here so we can add the G_LIKELY() */
342 #define gst_byte_writer_ensure_free_space(writer, size) \
343 G_LIKELY (_gst_byte_writer_ensure_free_space_inline (writer, size))
344 #define gst_byte_writer_put_uint8(writer, val) \
345 G_LIKELY (_gst_byte_writer_put_uint8_inline (writer, val))
346 #define gst_byte_writer_put_int8(writer, val) \
347 G_LIKELY (_gst_byte_writer_put_int8_inline (writer, val))
348 #define gst_byte_writer_put_uint16_be(writer, val) \
349 G_LIKELY (_gst_byte_writer_put_uint16_be_inline (writer, val))
350 #define gst_byte_writer_put_uint16_le(writer, val) \
351 G_LIKELY (_gst_byte_writer_put_uint16_le_inline (writer, val))
352 #define gst_byte_writer_put_int16_be(writer, val) \
353 G_LIKELY (_gst_byte_writer_put_int16_be_inline (writer, val))
354 #define gst_byte_writer_put_int16_le(writer, val) \
355 G_LIKELY (_gst_byte_writer_put_int16_le_inline (writer, val))
356 #define gst_byte_writer_put_uint24_be(writer, val) \
357 G_LIKELY (_gst_byte_writer_put_uint24_be_inline (writer, val))
358 #define gst_byte_writer_put_uint24_le(writer, val) \
359 G_LIKELY (_gst_byte_writer_put_uint24_le_inline (writer, val))
360 #define gst_byte_writer_put_int24_be(writer, val) \
361 G_LIKELY (_gst_byte_writer_put_int24_be_inline (writer, val))
362 #define gst_byte_writer_put_int24_le(writer, val) \
363 G_LIKELY (_gst_byte_writer_put_int24_le_inline (writer, val))
364 #define gst_byte_writer_put_uint32_be(writer, val) \
365 G_LIKELY (_gst_byte_writer_put_uint32_be_inline (writer, val))
366 #define gst_byte_writer_put_uint32_le(writer, val) \
367 G_LIKELY (_gst_byte_writer_put_uint32_le_inline (writer, val))
368 #define gst_byte_writer_put_int32_be(writer, val) \
369 G_LIKELY (_gst_byte_writer_put_int32_be_inline (writer, val))
370 #define gst_byte_writer_put_int32_le(writer, val) \
371 G_LIKELY (_gst_byte_writer_put_int32_le_inline (writer, val))
372 #define gst_byte_writer_put_uint64_be(writer, val) \
373 G_LIKELY (_gst_byte_writer_put_uint64_be_inline (writer, val))
374 #define gst_byte_writer_put_uint64_le(writer, val) \
375 G_LIKELY (_gst_byte_writer_put_uint64_le_inline (writer, val))
376 #define gst_byte_writer_put_int64_be(writer, val) \
377 G_LIKELY (_gst_byte_writer_put_int64_be_inline (writer, val))
378 #define gst_byte_writer_put_int64_le(writer, val) \
379 G_LIKELY (_gst_byte_writer_put_int64_le_inline (writer, val))
381 #define gst_byte_writer_put_float32_be(writer, val) \
382 G_LIKELY (_gst_byte_writer_put_float32_be_inline (writer, val))
383 #define gst_byte_writer_put_float32_le(writer, val) \
384 G_LIKELY (_gst_byte_writer_put_float32_le_inline (writer, val))
385 #define gst_byte_writer_put_float64_be(writer, val) \
386 G_LIKELY (_gst_byte_writer_put_float64_be_inline (writer, val))
387 #define gst_byte_writer_put_float64_le(writer, val) \
388 G_LIKELY (_gst_byte_writer_put_float64_le_inline (writer, val))
390 #define gst_byte_writer_put_data(writer, data, size) \
391 G_LIKELY (_gst_byte_writer_put_data_inline (writer, data, size))
392 #define gst_byte_writer_fill(writer, val, size) \
393 G_LIKELY (_gst_byte_writer_fill_inline (writer, val, size))
394 #define gst_byte_writer_put_buffer(writer, buffer, offset, size) \
395 G_LIKELY (_gst_byte_writer_put_buffer_inline (writer, buffer, offset, size))
401 #endif /* __GST_BYTE_WRITER_H__ */