libs/gst/base/gstbytereader-docs.h

   1 /* GStreamer byte reader dummy header for gtk-doc
   2  * Copyright (C) 2009 Tim-Philipp Müller <tim centricular net>
   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 gstbytereader.h.
  23  */
  24
  25 #error "This header should never be included in code, it is only for gtk-doc"
  26
  27 /**
  28  * gst_byte_reader_skip_unchecked:
  29  * @reader: a #GstByteReader instance
  30  * @nbytes: the number of bytes to skip
  31  *
  32  * Skips @nbytes bytes of the #GstByteReader instance without checking if
  33  * there are enough bytes available in the byte reader.
  34  *
  35  * Since: 0.10.25
  36  */
  37 void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
  38
  39 /**
  40  * gst_byte_reader_get_uint8_unchecked:
  41  * @reader: a #GstByteReader instance
  42  *
  43  * Read an unsigned 8 bit integer without checking if there are enough bytes
  44  * available in the byte reader and update the current position.
  45  *
  46  * Returns: unsigned 8 bit integer.
  47  *
  48  * Since: 0.10.25
  49  */
  50 /**
  51  * gst_byte_reader_peek_uint8_unchecked:
  52  * @reader: a #GstByteReader instance
  53  *
  54  * Read an unsigned 8 bit integer without checking if there are enough bytes
  55  * available in the byte reader, but do not advance the current read position.
  56  *
  57  * Returns: unsigned 8 bit integer.
  58  *
  59  * Since: 0.10.25
  60  */
  61 /**
  62  * gst_byte_reader_get_int8_unchecked:
  63  * @reader: a #GstByteReader instance
  64  *
  65  * Read an signed 8 bit integer without checking if there are enough bytes
  66  * available in the byte reader and update the current position.
  67  *
  68  * Returns: signed 8 bit integer.
  69  *
  70  * Since: 0.10.25
  71  */
  72 /**
  73  * gst_byte_reader_peek_int8_unchecked:
  74  * @reader: a #GstByteReader instance
  75  *
  76  * Read an signed 8 bit integer without checking if there are enough bytes
  77  * available in the byte reader, but do not advance the current read position.
  78  *
  79  * Returns: signed 8 bit integer.
  80  *
  81  * Since: 0.10.25
  82  */
  83 guint8  gst_byte_reader_get_uint8_unchecked     (GstByteReader * reader);
  84 guint8  gst_byte_reader_peek_uint8_unchecked    (GstByteReader * reader);
  85 gint8   gst_byte_reader_get_int8_unchecked      (GstByteReader * reader);
  86 gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  87
  88 /**
  89  * gst_byte_reader_get_uint16_le_unchecked:
  90  * @reader: a #GstByteReader instance
  91  *
  92  * Read an unsigned 16 bit integer in little endian format without checking
  93  * if there are enough bytes available in the byte reader and update the
  94  * current position.
  95  *
  96  * Returns: unsigned 16 bit integer.
  97  *
  98  * Since: 0.10.25
  99  */
 100 /**
 101  * gst_byte_reader_peek_uint16_le_unchecked:
 102  * @reader: a #GstByteReader instance
 103  *
 104  * Read an unsigned 16 bit integer in little endian format without checking
 105  * if there are enough bytes available in the byte reader, but do not advance
 106  * the current position.
 107  *
 108  * Returns: unsigned 16 bit integer.
 109  *
 110  * Since: 0.10.25
 111  */
 112 /**
 113  * gst_byte_reader_get_uint16_be_unchecked:
 114  * @reader: a #GstByteReader instance
 115  *
 116  * Read an unsigned 16 bit integer in big endian format without checking
 117  * if there are enough bytes available in the byte reader and update the
 118  * current position.
 119  *
 120  * Returns: unsigned 16 bit integer.
 121  *
 122  * Since: 0.10.25
 123  */
 124 /**
 125  * gst_byte_reader_peek_uint16_be_unchecked:
 126  * @reader: a #GstByteReader instance
 127  *
 128  * Read an unsigned 16 bit integer in big endian format without checking
 129  * if there are enough bytes available in the byte reader, but do not advance
 130  * the current position.
 131  *
 132  * Returns: unsigned 16 bit integer.
 133  *
 134  * Since: 0.10.25
 135  */
 136 /**
 137  * gst_byte_reader_get_int16_le_unchecked:
 138  * @reader: a #GstByteReader instance
 139  *
 140  * Read a signed 16 bit integer in little endian format without checking
 141  * if there are enough bytes available in the byte reader and update the
 142  * current position.
 143  *
 144  * Returns: signed 16 bit integer.
 145  *
 146  * Since: 0.10.25
 147  */
 148 /**
 149  * gst_byte_reader_peek_int16_le_unchecked:
 150  * @reader: a #GstByteReader instance
 151  *
 152  * Read a signed 16 bit integer in little endian format without checking
 153  * if there are enough bytes available in the byte reader, but do not advance
 154  * the current position.
 155  *
 156  * Returns: signed 16 bit integer.
 157  *
 158  * Since: 0.10.25
 159  */
 160 /**
 161  * gst_byte_reader_get_int16_be_unchecked:
 162  * @reader: a #GstByteReader instance
 163  *
 164  * Read a signed 16 bit integer in big endian format without checking
 165  * if there are enough bytes available in the byte reader and update the
 166  * current position.
 167  *
 168  * Returns: signed 16 bit integer.
 169  *
 170  * Since: 0.10.25
 171  */
 172 /**
 173  * gst_byte_reader_peek_int16_be_unchecked:
 174  * @reader: a #GstByteReader instance
 175  *
 176  * Read a signed 16 bit integer in big endian format without checking
 177  * if there are enough bytes available in the byte reader, but do not advance
 178  * the current position.
 179  *
 180  * Returns: signed 16 bit integer.
 181  *
 182  * Since: 0.10.25
 183  */
 184 guint16 gst_byte_reader_get_uint16_le_unchecked  (GstByteReader * reader);
 185 guint16 gst_byte_reader_get_uint16_be_unchecked  (GstByteReader * reader);
 186 guint16 gst_byte_reader_peek_uint16_le_unchecked (GstByteReader * reader);
 187 guint16 gst_byte_reader_peek_uint16_be_unchecked (GstByteReader * reader);
 188 gint16  gst_byte_reader_get_int16_le_unchecked   (GstByteReader * reader);
 189 gint16  gst_byte_reader_get_int16_be_unchecked   (GstByteReader * reader);
 190 gint16  gst_byte_reader_peek_int16_le_unchecked  (GstByteReader * reader);
 191 gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
 192
 193 /**
 194  * gst_byte_reader_get_uint24_le_unchecked:
 195  * @reader: a #GstByteReader instance
 196  *
 197  * Read an unsigned 24 bit integer in little endian format without checking
 198  * if there are enough bytes available in the byte reader and update the
 199  * current position.
 200  *
 201  * Returns: unsigned 24 bit integer (as guint32)
 202  *
 203  * Since: 0.10.25
 204  */
 205 /**
 206  * gst_byte_reader_peek_uint24_le_unchecked:
 207  * @reader: a #GstByteReader instance
 208  *
 209  * Read an unsigned 24 bit integer in little endian format without checking
 210  * if there are enough bytes available in the byte reader, but do not advance
 211  * the current position.
 212  *
 213  * Returns: unsigned 24 bit integer (as guint32)
 214  *
 215  * Since: 0.10.25
 216  */
 217 /**
 218  * gst_byte_reader_get_uint24_be_unchecked:
 219  * @reader: a #GstByteReader instance
 220  *
 221  * Read an unsigned 24 bit integer in big endian format without checking
 222  * if there are enough bytes available in the byte reader and update the
 223  * current position.
 224  *
 225  * Returns: unsigned 24 bit integer (as guint32)
 226  *
 227  * Since: 0.10.25
 228  */
 229 /**
 230  * gst_byte_reader_peek_uint24_be_unchecked:
 231  * @reader: a #GstByteReader instance
 232  *
 233  * Read an unsigned 24 bit integer in big endian format without checking
 234  * if there are enough bytes available in the byte reader, but do not advance
 235  * the current position.
 236  *
 237  * Returns: unsigned 24 bit integer (as guint32)
 238  *
 239  * Since: 0.10.25
 240  */
 241 /**
 242  * gst_byte_reader_get_int24_le_unchecked:
 243  * @reader: a #GstByteReader instance
 244  *
 245  * Read a signed 24 bit integer in little endian format without checking
 246  * if there are enough bytes available in the byte reader and update the
 247  * current position.
 248  *
 249  * Returns: signed 24 bit integer (as gint32)
 250  *
 251  * Since: 0.10.25
 252  */
 253 /**
 254  * gst_byte_reader_peek_int24_le_unchecked:
 255  * @reader: a #GstByteReader instance
 256  *
 257  * Read a signed 24 bit integer in little endian format without checking
 258  * if there are enough bytes available in the byte reader, but do not advance
 259  * the current position.
 260  *
 261  * Returns: signed 24 bit integer (as gint32)
 262  *
 263  * Since: 0.10.25
 264  */
 265 /**
 266  * gst_byte_reader_get_int24_be_unchecked:
 267  * @reader: a #GstByteReader instance
 268  *
 269  * Read a signed 24 bit integer in big endian format without checking
 270  * if there are enough bytes available in the byte reader and update the
 271  * current position.
 272  *
 273  * Returns: signed 24 bit integer (as gint32)
 274  *
 275  * Since: 0.10.25
 276  */
 277 /**
 278  * gst_byte_reader_peek_int24_be_unchecked:
 279  * @reader: a #GstByteReader instance
 280  *
 281  * Read a signed 24 bit integer in big endian format without checking
 282  * if there are enough bytes available in the byte reader, but do not advance
 283  * the current position.
 284  *
 285  * Returns: signed 24 bit integer (as gint32)
 286  *
 287  * Since: 0.10.25
 288  */
 289 guint32 gst_byte_reader_get_uint24_le_unchecked  (GstByteReader * reader);
 290 guint32 gst_byte_reader_get_uint24_be_unchecked  (GstByteReader * reader);
 291 guint32 gst_byte_reader_peek_uint24_le_unchecked (GstByteReader * reader);
 292 guint32 gst_byte_reader_peek_uint24_be_unchecked (GstByteReader * reader);
 293 gint32  gst_byte_reader_get_int24_le_unchecked   (GstByteReader * reader);
 294 gint32  gst_byte_reader_get_int24_be_unchecked   (GstByteReader * reader);
 295 gint32  gst_byte_reader_peek_int24_le_unchecked  (GstByteReader * reader);
 296 gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
 297
 298 /**
 299  * gst_byte_reader_get_uint32_le_unchecked:
 300  * @reader: a #GstByteReader instance
 301  *
 302  * Read an unsigned 32 bit integer in little endian format without checking
 303  * if there are enough bytes available in the byte reader and update the
 304  * current position.
 305  *
 306  * Returns: unsigned 32 bit integer.
 307  *
 308  * Since: 0.10.25
 309  */
 310 /**
 311  * gst_byte_reader_peek_uint32_le_unchecked:
 312  * @reader: a #GstByteReader instance
 313  *
 314  * Read an unsigned 32 bit integer in little endian format without checking
 315  * if there are enough bytes available in the byte reader, but do not advance
 316  * the current position.
 317  *
 318  * Returns: unsigned 32 bit integer.
 319  *
 320  * Since: 0.10.25
 321  */
 322 /**
 323  * gst_byte_reader_get_uint32_be_unchecked:
 324  * @reader: a #GstByteReader instance
 325  *
 326  * Read an unsigned 32 bit integer in big endian format without checking
 327  * if there are enough bytes available in the byte reader and update the
 328  * current position.
 329  *
 330  * Returns: unsigned 32 bit integer.
 331  *
 332  * Since: 0.10.25
 333  */
 334 /**
 335  * gst_byte_reader_peek_uint32_be_unchecked:
 336  * @reader: a #GstByteReader instance
 337  *
 338  * Read an unsigned 32 bit integer in big endian format without checking
 339  * if there are enough bytes available in the byte reader, but do not advance
 340  * the current position.
 341  *
 342  * Returns: unsigned 32 bit integer.
 343  *
 344  * Since: 0.10.25
 345  */
 346 /**
 347  * gst_byte_reader_get_int32_le_unchecked:
 348  * @reader: a #GstByteReader instance
 349  *
 350  * Read a signed 32 bit integer in little endian format without checking
 351  * if there are enough bytes available in the byte reader and update the
 352  * current position.
 353  *
 354  * Returns: signed 32 bit integer.
 355  *
 356  * Since: 0.10.25
 357  */
 358 /**
 359  * gst_byte_reader_peek_int32_le_unchecked:
 360  * @reader: a #GstByteReader instance
 361  *
 362  * Read a signed 32 bit integer in little endian format without checking
 363  * if there are enough bytes available in the byte reader, but do not advance
 364  * the current position.
 365  *
 366  * Returns: signed 32 bit integer.
 367  *
 368  * Since: 0.10.25
 369  */
 370 /**
 371  * gst_byte_reader_get_int32_be_unchecked:
 372  * @reader: a #GstByteReader instance
 373  *
 374  * Read a signed 32 bit integer in big endian format without checking
 375  * if there are enough bytes available in the byte reader and update the
 376  * current position.
 377  *
 378  * Returns: signed 32 bit integer.
 379  *
 380  * Since: 0.10.25
 381  */
 382 /**
 383  * gst_byte_reader_peek_int32_be_unchecked:
 384  * @reader: a #GstByteReader instance
 385  *
 386  * Read a signed 32 bit integer in big endian format without checking
 387  * if there are enough bytes available in the byte reader, but do not advance
 388  * the current position.
 389  *
 390  * Returns: signed 32 bit integer.
 391  *
 392  * Since: 0.10.25
 393  */
 394 guint32 gst_byte_reader_get_uint32_le_unchecked  (GstByteReader * reader);
 395 guint32 gst_byte_reader_get_uint32_be_unchecked  (GstByteReader * reader);
 396 guint32 gst_byte_reader_peek_uint32_le_unchecked (GstByteReader * reader);
 397 guint32 gst_byte_reader_peek_uint32_be_unchecked (GstByteReader * reader);
 398 gint32  gst_byte_reader_get_int32_le_unchecked   (GstByteReader * reader);
 399 gint32  gst_byte_reader_get_int32_be_unchecked   (GstByteReader * reader);
 400 gint32  gst_byte_reader_peek_int32_le_unchecked  (GstByteReader * reader);
 401 gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
 402
 403 /**
 404  * gst_byte_reader_get_uint64_le_unchecked:
 405  * @reader: a #GstByteReader instance
 406  *
 407  * Read an unsigned 64 bit integer in little endian format without checking
 408  * if there are enough bytes available in the byte reader and update the
 409  * current position.
 410  *
 411  * Returns: unsigned 64 bit integer.
 412  *
 413  * Since: 0.10.25
 414  */
 415 /**
 416  * gst_byte_reader_peek_uint64_le_unchecked:
 417  * @reader: a #GstByteReader instance
 418  *
 419  * Read an unsigned 64 bit integer in little endian format without checking
 420  * if there are enough bytes available in the byte reader, but do not advance
 421  * the current position.
 422  *
 423  * Returns: unsigned 64 bit integer.
 424  *
 425  * Since: 0.10.25
 426  */
 427 /**
 428  * gst_byte_reader_get_uint64_be_unchecked:
 429  * @reader: a #GstByteReader instance
 430  *
 431  * Read an unsigned 64 bit integer in big endian format without checking
 432  * if there are enough bytes available in the byte reader and update the
 433  * current position.
 434  *
 435  * Returns: unsigned 64 bit integer.
 436  *
 437  * Since: 0.10.25
 438  */
 439 /**
 440  * gst_byte_reader_peek_uint64_be_unchecked:
 441  * @reader: a #GstByteReader instance
 442  *
 443  * Read an unsigned 64 bit integer in big endian format without checking
 444  * if there are enough bytes available in the byte reader, but do not advance
 445  * the current position.
 446  *
 447  * Returns: unsigned 64 bit integer.
 448  *
 449  * Since: 0.10.25
 450  */
 451 /**
 452  * gst_byte_reader_get_int64_le_unchecked:
 453  * @reader: a #GstByteReader instance
 454  *
 455  * Read a signed 64 bit integer in little endian format without checking
 456  * if there are enough bytes available in the byte reader and update the
 457  * current position.
 458  *
 459  * Returns: signed 64 bit integer.
 460  *
 461  * Since: 0.10.25
 462  */
 463 /**
 464  * gst_byte_reader_peek_int64_le_unchecked:
 465  * @reader: a #GstByteReader instance
 466  *
 467  * Read a signed 64 bit integer in little endian format without checking
 468  * if there are enough bytes available in the byte reader, but do not advance
 469  * the current position.
 470  *
 471  * Returns: signed 64 bit integer.
 472  *
 473  * Since: 0.10.25
 474  */
 475 /**
 476  * gst_byte_reader_get_int64_be_unchecked:
 477  * @reader: a #GstByteReader instance
 478  *
 479  * Read a signed 64 bit integer in big endian format without checking
 480  * if there are enough bytes available in the byte reader and update the
 481  * current position.
 482  *
 483  * Returns: signed 64 bit integer.
 484  *
 485  * Since: 0.10.25
 486  */
 487 /**
 488  * gst_byte_reader_peek_int64_be_unchecked:
 489  * @reader: a #GstByteReader instance
 490  *
 491  * Read a signed 64 bit integer in big endian format without checking
 492  * if there are enough bytes available in the byte reader, but do not advance
 493  * the current position.
 494  *
 495  * Returns: signed 64 bit integer.
 496  *
 497  * Since: 0.10.25
 498  */
 499 guint64 gst_byte_reader_get_uint64_le_unchecked  (GstByteReader * reader);
 500 guint64 gst_byte_reader_get_uint64_be_unchecked  (GstByteReader * reader);
 501 guint64 gst_byte_reader_peek_uint64_le_unchecked (GstByteReader * reader);
 502 guint64 gst_byte_reader_peek_uint64_be_unchecked (GstByteReader * reader);
 503 gint64  gst_byte_reader_get_int64_le_unchecked   (GstByteReader * reader);
 504 gint64  gst_byte_reader_get_int64_be_unchecked   (GstByteReader * reader);
 505 gint64  gst_byte_reader_peek_int64_le_unchecked  (GstByteReader * reader);
 506 gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
 507
 508 /**
 509  * gst_byte_reader_get_float32_le_unchecked:
 510  * @reader: a #GstByteReader instance
 511  *
 512  * Read a 32 bit little endian float without checking if there is enough
 513  * data available and update the current position.
 514  *
 515  * Returns: floating point value read
 516  *
 517  * Since: 0.10.25
 518  */
 519 /**
 520  * gst_byte_reader_peek_float32_le_unchecked:
 521  * @reader: a #GstByteReader instance
 522  *
 523  * Read a 32 bit little endian float without checking if there is enough
 524  * data available, but keep the current position.
 525  *
 526  * Returns: floating point value read
 527  *
 528  * Since: 0.10.25
 529  */
 530 /**
 531  * gst_byte_reader_get_float32_be_unchecked:
 532  * @reader: a #GstByteReader instance
 533  *
 534  * Read a 32 bit big endian float without checking if there is enough
 535  * data available and update the current position.
 536  *
 537  * Returns: floating point value read
 538  *
 539  * Since: 0.10.25
 540  */
 541 /**
 542  * gst_byte_reader_peek_float32_be_unchecked:
 543  * @reader: a #GstByteReader instance
 544  *
 545  * Read a 32 bit big endian float without checking if there is enough
 546  * data available, but keep the current position.
 547  *
 548  * Returns: floating point value read
 549  *
 550  * Since: 0.10.25
 551  */
 552 /**
 553  * gst_byte_reader_get_float64_le_unchecked:
 554  * @reader: a #GstByteReader instance
 555  *
 556  * Read a 64 bit little endian float without checking if there is enough
 557  * data available and update the current position.
 558  *
 559  * Returns: double precision floating point value read
 560  *
 561  * Since: 0.10.25
 562  */
 563 /**
 564  * gst_byte_reader_peek_float64_le_unchecked:
 565  * @reader: a #GstByteReader instance
 566  *
 567  * Read a 64 bit little endian float without checking if there is enough
 568  * data available, but keep the current position.
 569  *
 570  * Returns: double precision floating point value read
 571  *
 572  * Since: 0.10.25
 573  */
 574 /**
 575  * gst_byte_reader_get_float64_be_unchecked:
 576  * @reader: a #GstByteReader instance
 577  *
 578  * Read a 64 bit big endian float without checking if there is enough
 579  * data available and update the current position.
 580  *
 581  * Returns: double precision floating point value read
 582  *
 583  * Since: 0.10.25
 584  */
 585 /**
 586  * gst_byte_reader_peek_float64_be_unchecked:
 587  * @reader: a #GstByteReader instance
 588  *
 589  * Read a 64 bit big endian float without checking if there is enough
 590  * data available, but keep the current position.
 591  *
 592  * Returns: double precision floating point value read
 593  *
 594  * Since: 0.10.25
 595  */
 596
 597 gfloat  gst_byte_reader_get_float32_le_unchecked  (GstByteReader * reader);
 598 gfloat  gst_byte_reader_get_float32_be_unchecked  (GstByteReader * reader);
 599 gdouble gst_byte_reader_get_float64_le_unchecked  (GstByteReader * reader);
 600 gdouble gst_byte_reader_get_float64_be_unchecked  (GstByteReader * reader);
 601
 602 gfloat  gst_byte_reader_peek_float32_le_unchecked (GstByteReader * reader);
 603 gfloat  gst_byte_reader_peek_float32_be_unchecked (GstByteReader * reader);
 604 gdouble gst_byte_reader_peek_float64_le_unchecked (GstByteReader * reader);
 605 gdouble gst_byte_reader_peek_float64_be_unchecked (GstByteReader * reader);
 606
 607 /**
 608  * gst_byte_reader_peek_data_unchecked:
 609  * @reader: a #GstByteReader instance
 610  *
 611  * Returns: (transfer none): a constant pointer to the current data position
 612  *
 613  * Since: 0.10.25
 614  */
 615 const guint8 * gst_byte_reader_peek_data_unchecked (GstByteReader * reader);
 616 /**
 617  * gst_byte_reader_get_data_unchecked:
 618  * @reader: a #GstByteReader instance
 619  * @size: Size in bytes
 620  *
 621  * Returns a constant pointer to the current data position without checking
 622  * if at least @size bytes are left. Advances the current read position by
 623  * @size bytes.
 624  *
 625  * Returns: (transfer none) (array length=size): a constant pointer to the
 626  *     current data position.
 627  *
 628  * Since: 0.10.25
 629  */
 630 const guint8 * gst_byte_reader_get_data_unchecked (GstByteReader * reader, guint size);
 631 /**
 632  * gst_byte_reader_dup_data_unchecked:
 633  * @reader: a #GstByteReader instance
 634  * @size: Size in bytes
 635  *
 636  * Returns a newly-allocated copy of the data at the current data position
 637  * without checking if at least @size bytes are left. Advances the current read
 638  * position by @size bytes.
 639  *
 640  * Free-function: g_free
 641  *
 642  * Returns: (transfer full) (array length=size): a newly-allocated copy of the
 643  *     data @size bytes in size. Free with g_free() when no longer needed.
 644  *
 645  * Since: 0.10.25
 646  */
 647 guint8 * gst_byte_reader_dup_data_unchecked (GstByteReader * reader, guint size);
 648