gstreamer/libs/gst/base/gstbytewriter.h
Tim-Philipp Müller 7e2ace8618 base: GST_EXPORT -> GST_BASE_API
We need different export decorators for the different libs.
For now no actual change though, just rename before the release,
and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-13 00:46:00 +00:00

468 lines
16 KiB
C

/* 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 __GST_BYTE_WRITER_H__
#define __GST_BYTE_WRITER_H__
#include <gst/gst.h>
#include <gst/base/gstbytereader.h>
#include <string.h>
G_BEGIN_DECLS
#define GST_BYTE_WRITER(writer) ((GstByteWriter *) (writer))
/**
* GstByteWriter:
* @parent: #GstByteReader 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 {
GstByteReader parent;
guint alloc_size;
gboolean fixed;
gboolean owned;
/* < private > */
gpointer _gst_reserved[GST_PADDING];
} GstByteWriter;
GST_BASE_API
GstByteWriter * gst_byte_writer_new (void) G_GNUC_MALLOC;
GST_BASE_API
GstByteWriter * gst_byte_writer_new_with_size (guint size, gboolean fixed) G_GNUC_MALLOC;
GST_BASE_API
GstByteWriter * gst_byte_writer_new_with_data (guint8 *data, guint size, gboolean initialized) G_GNUC_MALLOC;
GST_BASE_API
void gst_byte_writer_init (GstByteWriter *writer);
GST_BASE_API
void gst_byte_writer_init_with_size (GstByteWriter *writer, guint size, gboolean fixed);
GST_BASE_API
void gst_byte_writer_init_with_data (GstByteWriter *writer, guint8 *data,
guint size, gboolean initialized);
GST_BASE_API
void gst_byte_writer_free (GstByteWriter *writer);
GST_BASE_API
guint8 * gst_byte_writer_free_and_get_data (GstByteWriter *writer);
GST_BASE_API
GstBuffer * gst_byte_writer_free_and_get_buffer (GstByteWriter *writer) G_GNUC_MALLOC;
GST_BASE_API
void gst_byte_writer_reset (GstByteWriter *writer);
GST_BASE_API
guint8 * gst_byte_writer_reset_and_get_data (GstByteWriter *writer);
GST_BASE_API
GstBuffer * gst_byte_writer_reset_and_get_buffer (GstByteWriter *writer) G_GNUC_MALLOC;
/**
* gst_byte_writer_get_pos:
* @writer: #GstByteWriter instance
*
* Returns: The current position of the read/write cursor
*/
/**
* gst_byte_writer_set_pos:
* @writer: #GstByteWriter 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
*/
/**
* gst_byte_writer_get_size:
* @writer: #GstByteWriter instance
*
* Returns: The current, initialized size of the data
*/
static inline guint
gst_byte_writer_get_pos (const GstByteWriter *writer)
{
return gst_byte_reader_get_pos ((const GstByteReader *) writer);
}
static inline gboolean
gst_byte_writer_set_pos (GstByteWriter *writer, guint pos)
{
return gst_byte_reader_set_pos (GST_BYTE_READER (writer), pos);
}
static inline guint
gst_byte_writer_get_size (const GstByteWriter *writer)
{
return gst_byte_reader_get_size ((const GstByteReader *) writer);
}
GST_BASE_API
guint gst_byte_writer_get_remaining (const GstByteWriter *writer);
GST_BASE_API
gboolean gst_byte_writer_ensure_free_space (GstByteWriter *writer, guint size);
GST_BASE_API
gboolean gst_byte_writer_put_uint8 (GstByteWriter *writer, guint8 val);
GST_BASE_API
gboolean gst_byte_writer_put_int8 (GstByteWriter *writer, gint8 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint16_be (GstByteWriter *writer, guint16 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint16_le (GstByteWriter *writer, guint16 val);
GST_BASE_API
gboolean gst_byte_writer_put_int16_be (GstByteWriter *writer, gint16 val);
GST_BASE_API
gboolean gst_byte_writer_put_int16_le (GstByteWriter *writer, gint16 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint24_be (GstByteWriter *writer, guint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint24_le (GstByteWriter *writer, guint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_int24_be (GstByteWriter *writer, gint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_int24_le (GstByteWriter *writer, gint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint32_be (GstByteWriter *writer, guint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint32_le (GstByteWriter *writer, guint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_int32_be (GstByteWriter *writer, gint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_int32_le (GstByteWriter *writer, gint32 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint64_be (GstByteWriter *writer, guint64 val);
GST_BASE_API
gboolean gst_byte_writer_put_uint64_le (GstByteWriter *writer, guint64 val);
GST_BASE_API
gboolean gst_byte_writer_put_int64_be (GstByteWriter *writer, gint64 val);
GST_BASE_API
gboolean gst_byte_writer_put_int64_le (GstByteWriter *writer, gint64 val);
GST_BASE_API
gboolean gst_byte_writer_put_float32_be (GstByteWriter *writer, gfloat val);
GST_BASE_API
gboolean gst_byte_writer_put_float32_le (GstByteWriter *writer, gfloat val);
GST_BASE_API
gboolean gst_byte_writer_put_float64_be (GstByteWriter *writer, gdouble val);
GST_BASE_API
gboolean gst_byte_writer_put_float64_le (GstByteWriter *writer, gdouble val);
GST_BASE_API
gboolean gst_byte_writer_put_data (GstByteWriter *writer, const guint8 *data, guint size);
GST_BASE_API
gboolean gst_byte_writer_fill (GstByteWriter *writer, guint8 value, guint size);
GST_BASE_API
gboolean gst_byte_writer_put_string_utf8 (GstByteWriter *writer, const gchar *data);
GST_BASE_API
gboolean gst_byte_writer_put_string_utf16 (GstByteWriter *writer, const guint16 *data);
GST_BASE_API
gboolean gst_byte_writer_put_string_utf32 (GstByteWriter *writer, const guint32 *data);
gboolean gst_byte_writer_put_buffer (GstByteWriter *writer, GstBuffer * buffer, gsize offset, gssize size);
/**
* gst_byte_writer_put_string:
* @writer: #GstByteWriter 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 gst_byte_writer_put_string(writer, data) \
gst_byte_writer_put_string_utf8(writer, data)
static inline guint
_gst_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
_gst_byte_writer_ensure_free_space_inline (GstByteWriter * 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 = _gst_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 __GST_BYTE_WRITER_CREATE_WRITE_FUNC(bits,type,name,write_func) \
static inline void \
gst_byte_writer_put_##name##_unchecked (GstByteWriter *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 \
_gst_byte_writer_put_##name##_inline (GstByteWriter *writer, type val) \
{ \
g_return_val_if_fail (writer != NULL, FALSE); \
\
if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline(writer, bits/8))) \
return FALSE; \
\
gst_byte_writer_put_##name##_unchecked (writer, val); \
\
return TRUE; \
}
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (8, guint8, uint8, GST_WRITE_UINT8)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (8, gint8, int8, GST_WRITE_UINT8)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_le, GST_WRITE_UINT16_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, guint16, uint16_be, GST_WRITE_UINT16_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_le, GST_WRITE_UINT16_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (16, gint16, int16_be, GST_WRITE_UINT16_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_le, GST_WRITE_UINT24_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, guint32, uint24_be, GST_WRITE_UINT24_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_le, GST_WRITE_UINT24_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (24, gint32, int24_be, GST_WRITE_UINT24_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_le, GST_WRITE_UINT32_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, guint32, uint32_be, GST_WRITE_UINT32_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_le, GST_WRITE_UINT32_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gint32, int32_be, GST_WRITE_UINT32_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_le, GST_WRITE_UINT64_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, guint64, uint64_be, GST_WRITE_UINT64_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_le, GST_WRITE_UINT64_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gint64, int64_be, GST_WRITE_UINT64_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_be, GST_WRITE_FLOAT_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (32, gfloat, float32_le, GST_WRITE_FLOAT_LE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_be, GST_WRITE_DOUBLE_BE)
__GST_BYTE_WRITER_CREATE_WRITE_FUNC (64, gdouble, float64_le, GST_WRITE_DOUBLE_LE)
#undef __GST_BYTE_WRITER_CREATE_WRITE_FUNC
static inline void
gst_byte_writer_put_data_unchecked (GstByteWriter * 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
_gst_byte_writer_put_data_inline (GstByteWriter * writer, const guint8 * data,
guint size)
{
g_return_val_if_fail (writer != NULL, FALSE);
if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
return FALSE;
gst_byte_writer_put_data_unchecked (writer, data, size);
return TRUE;
}
static inline void
gst_byte_writer_fill_unchecked (GstByteWriter * 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
_gst_byte_writer_fill_inline (GstByteWriter * writer, guint8 value, guint size)
{
g_return_val_if_fail (writer != NULL, FALSE);
if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
return FALSE;
gst_byte_writer_fill_unchecked (writer, value, size);
return TRUE;
}
static inline void
gst_byte_writer_put_buffer_unchecked (GstByteWriter * writer, GstBuffer * buffer,
gsize offset, gssize size)
{
if (size == -1) {
size = gst_buffer_get_size (buffer);
if (offset >= (gsize) size)
return;
size -= offset;
}
gst_buffer_extract (buffer, offset,
(guint8 *) & writer->parent.data[writer->parent.byte], size);
writer->parent.byte += size;
writer->parent.size = MAX (writer->parent.size, writer->parent.byte);
}
static inline gboolean
_gst_byte_writer_put_buffer_inline (GstByteWriter * writer, GstBuffer * buffer,
gsize offset, gssize size)
{
g_return_val_if_fail (writer != NULL, FALSE);
g_return_val_if_fail (size >= -1, FALSE);
if (size == -1) {
size = gst_buffer_get_size (buffer);
if (offset >= (gsize) size)
return TRUE;
size -= offset;
}
if (G_UNLIKELY (!_gst_byte_writer_ensure_free_space_inline (writer, size)))
return FALSE;
gst_byte_writer_put_buffer_unchecked (writer, buffer, offset, size);
return TRUE;
}
#ifndef GST_BYTE_WRITER_DISABLE_INLINES
/* we use defines here so we can add the G_LIKELY() */
#define gst_byte_writer_ensure_free_space(writer, size) \
G_LIKELY (_gst_byte_writer_ensure_free_space_inline (writer, size))
#define gst_byte_writer_put_uint8(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint8_inline (writer, val))
#define gst_byte_writer_put_int8(writer, val) \
G_LIKELY (_gst_byte_writer_put_int8_inline (writer, val))
#define gst_byte_writer_put_uint16_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint16_be_inline (writer, val))
#define gst_byte_writer_put_uint16_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint16_le_inline (writer, val))
#define gst_byte_writer_put_int16_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_int16_be_inline (writer, val))
#define gst_byte_writer_put_int16_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_int16_le_inline (writer, val))
#define gst_byte_writer_put_uint24_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint24_be_inline (writer, val))
#define gst_byte_writer_put_uint24_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint24_le_inline (writer, val))
#define gst_byte_writer_put_int24_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_int24_be_inline (writer, val))
#define gst_byte_writer_put_int24_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_int24_le_inline (writer, val))
#define gst_byte_writer_put_uint32_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint32_be_inline (writer, val))
#define gst_byte_writer_put_uint32_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint32_le_inline (writer, val))
#define gst_byte_writer_put_int32_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_int32_be_inline (writer, val))
#define gst_byte_writer_put_int32_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_int32_le_inline (writer, val))
#define gst_byte_writer_put_uint64_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint64_be_inline (writer, val))
#define gst_byte_writer_put_uint64_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_uint64_le_inline (writer, val))
#define gst_byte_writer_put_int64_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_int64_be_inline (writer, val))
#define gst_byte_writer_put_int64_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_int64_le_inline (writer, val))
#define gst_byte_writer_put_float32_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_float32_be_inline (writer, val))
#define gst_byte_writer_put_float32_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_float32_le_inline (writer, val))
#define gst_byte_writer_put_float64_be(writer, val) \
G_LIKELY (_gst_byte_writer_put_float64_be_inline (writer, val))
#define gst_byte_writer_put_float64_le(writer, val) \
G_LIKELY (_gst_byte_writer_put_float64_le_inline (writer, val))
#define gst_byte_writer_put_data(writer, data, size) \
G_LIKELY (_gst_byte_writer_put_data_inline (writer, data, size))
#define gst_byte_writer_fill(writer, val, size) \
G_LIKELY (_gst_byte_writer_fill_inline (writer, val, size))
#define gst_byte_writer_put_buffer(writer, buffer, offset, size) \
G_LIKELY (_gst_byte_writer_put_buffer_inline (writer, buffer, offset, size))
#endif
G_END_DECLS
#endif /* __GST_BYTE_WRITER_H__ */