libs/gst/base/gstbytewriter-docs.h

   1 /* GStreamer byte writer dummy header for gtk-doc
   2  * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /* This header is not installed, it just contains stuff for gtk-doc to parse,
  21  * in particular docs and some dummy function declarations for the static
  22  * inline functions we generate via macros in gstbitreader.h.
  23  */
  24
  25 #error "This header should never be included in code, it is only for gtk-doc"
  26
  27 /**
  28  * gst_byte_writer_put_uint8_unchecked:
  29  * @writer: #GstByteWriter instance
  30  * @val: Value to write
  31  *
  32  * Writes a unsigned 8 bit integer to @writer without checking if there
  33  * is enough free space available in the byte writer.
  34  *
  35  * Since: 0.10.31
  36  */
  37 void gst_byte_writer_put_uint8_unchecked (GstByteWriter *writer, guint8 val);
  38
  39 /**
  40  * gst_byte_writer_put_uint16_be_unchecked:
  41  * @writer: #GstByteWriter instance
  42  * @val: Value to write
  43  *
  44  * Writes a unsigned big endian 16 bit integer to @writer without
  45  * checking if there is enough free space available in the byte writer.
  46  *
  47  * Since: 0.10.31
  48  */
  49 void gst_byte_writer_put_uint16_be_unchecked (GstByteWriter *writer, guint16 val);
  50
  51 /**
  52  * gst_byte_writer_put_uint24_be_unchecked:
  53  * @writer: #GstByteWriter instance
  54  * @val: Value to write
  55  *
  56  * Writes a unsigned big endian 24 bit integer to @writer without
  57  * checking if there is enough free space available in the byte writer.
  58  *
  59  * Since: 0.10.31
  60  */
  61 void gst_byte_writer_put_uint24_be_unchecked (GstByteWriter *writer, guint32 val);
  62
  63 /**
  64  * gst_byte_writer_put_uint32_be_unchecked:
  65  * @writer: #GstByteWriter instance
  66  * @val: Value to write
  67  *
  68  * Writes a unsigned big endian 32 bit integer to @writer without
  69  * checking if there is enough free space available in the byte writer.
  70  *
  71  * Since: 0.10.31
  72  */
  73 void gst_byte_writer_put_uint32_be_unchecked (GstByteWriter *writer, guint32 val);
  74
  75 /**
  76  * gst_byte_writer_put_uint64_be_unchecked:
  77  * @writer: #GstByteWriter instance
  78  * @val: Value to write
  79  *
  80  * Writes a unsigned big endian 64 bit integer to @writer without
  81  * checking if there is enough free space available in the byte writer.
  82  *
  83  * Since: 0.10.31
  84  */
  85 void gst_byte_writer_put_uint64_be_unchecked (GstByteWriter *writer, guint64 val);
  86
  87 /**
  88  * gst_byte_writer_put_uint16_le_unchecked:
  89  * @writer: #GstByteWriter instance
  90  * @val: Value to write
  91  *
  92  * Writes a unsigned little endian 16 bit integer to @writer without
  93  * checking if there is enough free space available in the byte writer.
  94  *
  95  * Since: 0.10.31
  96  */
  97 void gst_byte_writer_put_uint16_le_unchecked (GstByteWriter *writer, guint16 val);
  98
  99 /**
 100  * gst_byte_writer_put_uint24_le_unchecked:
 101  * @writer: #GstByteWriter instance
 102  * @val: Value to write
 103  *
 104  * Writes a unsigned little endian 24 bit integer to @writer without
 105  * checking if there is enough free space available in the byte writer.
 106  *
 107  * Since: 0.10.31
 108  */
 109 void gst_byte_writer_put_uint24_le_unchecked (GstByteWriter *writer, guint32 val);
 110
 111 /**
 112  * gst_byte_writer_put_uint32_le_unchecked:
 113  * @writer: #GstByteWriter instance
 114  * @val: Value to write
 115  *
 116  * Writes a unsigned little endian 32 bit integer to @writer without
 117  * checking if there is enough free space available in the byte writer.
 118  *
 119  * Since: 0.10.31
 120  */
 121 void gst_byte_writer_put_uint32_le_unchecked (GstByteWriter *writer, guint32 val);
 122
 123 /**
 124  * gst_byte_writer_put_uint64_le_unchecked:
 125  * @writer: #GstByteWriter instance
 126  * @val: Value to write
 127  *
 128  * Writes a unsigned little endian 64 bit integer to @writer without
 129  * checking if there is enough free space available in the byte writer.
 130  *
 131  * Since: 0.10.31
 132  */
 133 void gst_byte_writer_put_uint64_le_unchecked (GstByteWriter *writer, guint64 val);
 134
 135 /**
 136  * gst_byte_writer_put_int8:
 137  * @writer: #GstByteWriter instance
 138  * @val: Value to write
 139  *
 140  * Writes a signed 8 bit integer to @writer without
 141  * checking if there is enough free space available in the byte writer.
 142  *
 143  * Since: 0.10.31
 144  */
 145 void gst_byte_writer_put_int8_unchecked (GstByteWriter *writer, gint8 val);
 146
 147 /**
 148  * gst_byte_writer_put_int16_be_unchecked:
 149  * @writer: #GstByteWriter instance
 150  * @val: Value to write
 151  *
 152  * Writes a signed big endian 16 bit integer to @writer without
 153  * checking if there is enough free space available in the byte writer.
 154  *
 155  * Since: 0.10.31
 156  */
 157 void gst_byte_writer_put_int16_be_unchecked (GstByteWriter *writer, gint16 val);
 158
 159 /**
 160  * gst_byte_writer_put_int24_be_unchecked:
 161  * @writer: #GstByteWriter instance
 162  * @val: Value to write
 163  *
 164  * Writes a signed big endian 24 bit integer to @writer without
 165  * checking if there is enough free space available in the byte writer.
 166  *
 167  * Since: 0.10.31
 168  */
 169 void gst_byte_writer_put_int24_be_unchecked (GstByteWriter *writer, gint32 val);
 170
 171 /**
 172  * gst_byte_writer_put_int32_be_unchecked:
 173  * @writer: #GstByteWriter instance
 174  * @val: Value to write
 175  *
 176  * Writes a signed big endian 32 bit integer to @writer without
 177  * checking if there is enough free space available in the byte writer.
 178  *
 179  * Since: 0.10.31
 180  */
 181 void gst_byte_writer_put_int32_be_unchecked (GstByteWriter *writer, gint32 val);
 182
 183 /**
 184  * gst_byte_writer_put_int64_be_unchecked:
 185  * @writer: #GstByteWriter instance
 186  * @val: Value to write
 187  *
 188  * Writes a signed big endian 64 bit integer to @writer without
 189  * checking if there is enough free space available in the byte writer.
 190  *
 191  * Since: 0.10.31
 192  */
 193 void gst_byte_writer_put_int64_be_unchecked (GstByteWriter *writer, gint64 val);
 194
 195 /**
 196  * gst_byte_writer_put_int16_le_unchecked:
 197  * @writer: #GstByteWriter instance
 198  * @val: Value to write
 199  *
 200  * Writes a signed little endian 16 bit integer to @writer without
 201  * checking if there is enough free space available in the byte writer.
 202  *
 203  * Since: 0.10.31
 204  */
 205 void gst_byte_writer_put_int16_le_unchecked (GstByteWriter *writer, gint16 val);
 206
 207 /**
 208  * gst_byte_writer_put_int24_le_unchecked:
 209  * @writer: #GstByteWriter instance
 210  * @val: Value to write
 211  *
 212  * Writes a signed little endian 24 bit integer to @writer without
 213  * checking if there is enough free space available in the byte writer.
 214  *
 215  * Since: 0.10.31
 216  */
 217 void gst_byte_writer_put_int24_le_unchecked (GstByteWriter *writer, gint32 val);
 218
 219 /**
 220  * gst_byte_writer_put_int32_le_unchecked:
 221  * @writer: #GstByteWriter instance
 222  * @val: Value to write
 223  *
 224  * Writes a signed little endian 32 bit integer to @writer without
 225  * checking if there is enough free space available in the byte writer.
 226  *
 227  * Since: 0.10.31
 228  */
 229 void gst_byte_writer_put_int32_le_unchecked (GstByteWriter *writer, gint32 val);
 230
 231 /**
 232  * gst_byte_writer_put_int64_le_unchecked:
 233  * @writer: #GstByteWriter instance
 234  * @val: Value to write
 235  *
 236  * Writes a signed little endian 64 bit integer to @writer without
 237  * checking if there is enough free space available in the byte writer.
 238  *
 239  * Since: 0.10.31
 240  */
 241 void gst_byte_writer_put_int64_le_unchecked (GstByteWriter *writer, gint64 val);
 242
 243 /**
 244  * gst_byte_writer_put_float32_be_unchecked:
 245  * @writer: #GstByteWriter instance
 246  * @val: Value to write
 247  *
 248  * Writes a big endian 32 bit float to @writer without
 249  * checking if there is enough free space available in the byte writer.
 250  *
 251  * Since: 0.10.31
 252  */
 253 void gst_byte_writer_put_float32_be_unchecked (GstByteWriter *writer, gfloat val);
 254
 255 /**
 256  * gst_byte_writer_put_float64_be_unchecked:
 257  * @writer: #GstByteWriter instance
 258  * @val: Value to write
 259  *
 260  * Writes a big endian 64 bit float to @writer without
 261  * checking if there is enough free space available in the byte writer.
 262  *
 263  * Since: 0.10.31
 264  */
 265 void gst_byte_writer_put_float64_be_unchecked (GstByteWriter *writer, gdouble val);
 266
 267 /**
 268  * gst_byte_writer_put_float32_le_unchecked:
 269  * @writer: #GstByteWriter instance
 270  * @val: Value to write
 271  *
 272  * Writes a little endian 32 bit float to @writer without
 273  * checking if there is enough free space available in the byte writer.
 274  *
 275  * Since: 0.10.31
 276  */
 277 void gst_byte_writer_put_float32_le_unchecked (GstByteWriter *writer, gfloat val);
 278
 279 /**
 280  * gst_byte_writer_put_float64_le_unchecked:
 281  * @writer: #GstByteWriter instance
 282  * @val: Value to write
 283  *
 284  * Writes a little endian 64 bit float to @writer without
 285  * checking if there is enough free space available in the byte writer.
 286  *
 287  * Since: 0.10.31
 288  */
 289 void gst_byte_writer_put_float64_le_unchecked (GstByteWriter *writer, gdouble val);
 290
 291 /**
 292  * gst_byte_writer_put_data_unchecked:
 293  * @writer: #GstByteWriter instance
 294  * @data: Data to write
 295  * @size: Size of @data in bytes
 296  *
 297  * Writes @size bytes of @data to @writer without
 298  * checking if there is enough free space available in the byte writer.
 299  *
 300  * Since: 0.10.31
 301  */
 302 void gst_byte_writer_put_data_unchecked (GstByteWriter *writer, const guint8 *data, guint size);
 303
 304 /**
 305  * gst_byte_writer_fill_unchecked:
 306  * @writer: #GstByteWriter instance
 307  * @value: Value to be writen
 308  * @size: Number of bytes to be writen
 309  *
 310  * Writes @size bytes containing @value to @writer without
 311  * checking if there is enough free space available in the byte writer.
 312  *
 313  * Since: 0.10.31
 314  */
 315 void gst_byte_writer_fill_unchecked (GstByteWriter *writer, guint8 value, guint size);
 316