/* GStreamer

 *

 * Copyright (C) 2008 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., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

#ifdef HAVE_CONFIG_H

#include "config.h"

#endif

#include "gstbytereader.h"

#include <string.h>

/**

 * SECTION:gstbytereader

 * @short_description: Reads different integer, string and floating point

 *     types from a memory buffer

 *

 * #GstByteReader provides a byte reader that can read different integer and

 * floating point types from a memory buffer. It provides functions for reading

 * signed/unsigned, little/big endian integers of 8, 16, 24, 32 and 64 bits

 * and functions for reading little/big endian floating points numbers of

 * 32 and 64 bits. It also provides functions to read NUL-terminated strings

 * in various character encodings.

 */

/**

 * gst_byte_reader_new:

 * @data: Data from which the #GstByteReader should read

 * @size: Size of @data in bytes

 *

 * Create a new #GstByteReader instance, which will read from @data.

 *

 * Returns: a new #GstByteReader instance

 *

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstByteReader *

gst_byte_reader_new (const guint8 * data, guint size)

{

  GstByteReader *ret = g_slice_new0 (GstByteReader);

  ret->data = data;

  ret->size = size;

  return ret;

}

/**

 * gst_byte_reader_new_from_buffer:

 * @buffer: Buffer from which the #GstByteReader should read

 *

 * Create a new #GstByteReader instance, which will read from the

 * #GstBuffer @buffer.

 *

 * Returns: a new #GstByteReader instance

 *

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstByteReader *

gst_byte_reader_new_from_buffer (const GstBuffer * buffer)

{

  g_return_val_if_fail (GST_IS_BUFFER (buffer), NULL);

  return gst_byte_reader_new (GST_BUFFER_DATA (buffer),

      GST_BUFFER_SIZE (buffer));

}

/**

 * gst_byte_reader_free:

 * @reader: a #GstByteReader instance

 *

 * Frees a #GstByteReader instance, which was previously allocated by

 * gst_byte_reader_new() or gst_byte_reader_new_from_buffer().

 * 

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_byte_reader_free (GstByteReader * reader)

{

  g_return_if_fail (reader != NULL);

  g_slice_free (GstByteReader, reader);

}

/**

 * gst_byte_reader_init:

 * @reader: a #GstByteReader instance

 * @data: Data from which the #GstByteReader should read

 * @size: Size of @data in bytes

 *

 * Initializes a #GstByteReader instance to read from @data. This function

 * can be called on already initialized instances.

 * 

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_byte_reader_init (GstByteReader * reader, const guint8 * data, guint size)

{

  g_return_if_fail (reader != NULL);

  reader->data = data;

  reader->size = size;

  reader->byte = 0;

}

/**

 * gst_byte_reader_init_from_buffer:

 * @reader: a #GstByteReader instance

 * @buffer: Buffer from which the #GstByteReader should read

 *

 * Initializes a #GstByteReader instance to read from @buffer. This function

 * can be called on already initialized instances.

 * 

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_byte_reader_init_from_buffer (GstByteReader * reader,

    const GstBuffer * buffer)

{

  g_return_if_fail (GST_IS_BUFFER (buffer));

  gst_byte_reader_init (reader, GST_BUFFER_DATA (buffer),

      GST_BUFFER_SIZE (buffer));

}

/**

 * gst_byte_reader_set_pos:

 * @reader: a #GstByteReader instance

 * @pos: The new position in bytes

 *

 * Sets the new position of a #GstByteReader instance to @pos in bytes.

 *

 * Returns: %TRUE if the position could be set successfully, %FALSE

 * otherwise.

 * 

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

gboolean

gst_byte_reader_set_pos (GstByteReader * reader, guint pos)

{

  g_return_val_if_fail (reader != NULL, FALSE);

  if (pos > reader->size)

    return FALSE;

  reader->byte = pos;

  return TRUE;

}

/**

 * gst_byte_reader_get_pos:

 * @reader: a #GstByteReader instance

 *

 * Returns the current position of a #GstByteReader instance in bytes.

 *

 * Returns: The current position of @reader in bytes.

 * 

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

guint

gst_byte_reader_get_pos (const GstByteReader * reader)

{

  g_return_val_if_fail (reader != NULL, 0);

  return reader->byte;

}

/**

 * gst_byte_reader_get_remaining:

 * @reader: a #GstByteReader instance

 *

 * Returns the remaining number of bytes of a #GstByteReader instance.

 *

 * Returns: The remaining number of bytes of @reader instance.

 * 

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

guint

gst_byte_reader_get_remaining (const GstByteReader * reader)

{

  g_return_val_if_fail (reader != NULL, 0);

  return reader->size - reader->byte;

}

/**

 * gst_byte_reader_skip:

 * @reader: a #GstByteReader instance

 * @nbytes: the number of bytes to skip

 *

 * Skips @nbytes bytes of the #GstByteReader instance.

 *

 * Returns: %TRUE if @nbytes bytes could be skipped, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

gboolean

gst_byte_reader_skip (GstByteReader * reader, guint nbytes)

{

  g_return_val_if_fail (reader != NULL, FALSE);

  if (gst_byte_reader_get_remaining (reader) < nbytes)

    return FALSE;

  reader->byte += nbytes;

  return TRUE;

}

/**

 * gst_byte_reader_get_uint8:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint8 to store the result

 *

 * Read an unsigned 8 bit integer into @val and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_int8:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint8 to store the result

 *

 * Read a signed 8 bit integer into @val and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_uint8:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint8 to store the result

 *

 * Read a signed 8 bit integer into @val but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_int8:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint8 to store the result

 *

 * Read a signed 8 bit integer into @val but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_uint16_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint16 to store the result

 *

 * Read an unsigned 16 bit little endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_int16_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint16 to store the result

 *

 * Read a signed 16 bit little endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_uint16_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint16 to store the result

 *

 * Read a signed 16 bit little endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_int16_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint16 to store the result

 *

 * Read a signed 16 bit little endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_uint16_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint16 to store the result

 *

 * Read an unsigned 16 bit big endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_int16_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint16 to store the result

 *

 * Read a signed 16 bit big endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_uint16_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint16 to store the result

 *

 * Read a signed 16 bit big endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_int16_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint16 to store the result

 *

 * Read a signed 16 bit big endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_uint24_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint32 to store the result

 *

 * Read an unsigned 24 bit little endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_int24_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint32 to store the result

 *

 * Read a signed 24 bit little endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_uint24_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint32 to store the result

 *

 * Read a signed 24 bit little endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_int24_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint32 to store the result

 *

 * Read a signed 24 bit little endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_uint24_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint32 to store the result

 *

 * Read an unsigned 24 bit big endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_int24_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint32 to store the result

 *

 * Read a signed 24 bit big endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_uint24_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint32 to store the result

 *

 * Read a signed 24 bit big endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_peek_int24_be:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #gint32 to store the result

 *

 * Read a signed 24 bit big endian integer into @val

 * but keep the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 * 

 * Since: 0.10.22

 */

/**

 * gst_byte_reader_get_uint32_le:

 * @reader: a #GstByteReader instance

 * @val: Pointer to a #guint32 to store the result

 *

 * Read an unsigned 32 bit little endian integer into @val

 * and update the current position.

 *

 * Returns: %TRUE if successful, %FALSE otherwise.

 *