include/FLAC/format.h

   1 /* libFLAC - Free Lossless Audio Codec library
   2  * Copyright (C) 2000,2001,2002  Josh Coalson
   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 #ifndef FLAC__FORMAT_H
  21 #define FLAC__FORMAT_H
  22
  23 #include "ordinals.h"
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /** \file include/FLAC/format.h
  30  *
  31  *  \brief
  32  *  This module contains structure definitions for the representation
  33  *  of FLAC format components in memory.  These are the basic
  34  *  structures used by the rest of the interfaces.
  35  *
  36  *  See the detailed documentation in the
  37  *  \link flac_format format \endlink module.
  38  */
  39
  40 /** \defgroup flac_format FLAC/format.h: format components
  41  *  \ingroup flac
  42  *
  43  *  \brief
  44  *  This module contains structure definitions for the representation
  45  *  of FLAC format components in memory.  These are the basic
  46  *  structures used by the rest of the interfaces.
  47  *
  48  *  First, you should be familiar with the
  49  *  <A HREF="../format.html">FLAC format</A>.  Many of the values here
  50  *  follow directly from the specification.  As a user of libFLAC, the
  51  *  interesting parts really are the structures that describe the frame
  52  *  header and metadata blocks.
  53  *
  54  *  The format structures here are very primitive, designed to store
  55  *  information in an efficient way.  Reading information from the
  56  *  structures is easy but creating or modifying them directly is
  57  *  more complex.  For the most part, as a user of a library, editing
  58  *  is not necessary; however, for metadata blocks it is, so there are
  59  *  convenience functions provided in the \link flac_metadata metadata
  60  *  module \endlink to simplify the manipulation of metadata blocks.
  61  *
  62  * \note
  63  * It's not the best convention, but symbols ending in _LEN are in bits
  64  * and _LENGTH are in bytes.  _LENGTH symbols are \#defines instead of
  65  * global variables because they are usually used when declaring byte
  66  * arrays and some compilers require compile-time knowledge of array
  67  * sizes when declared on the stack.
  68  *
  69  * \{
  70  */
  71
  72
  73 /*
  74         Most of the values described in this file are defined by the FLAC
  75         format specification.  There is nothing to tune here.
  76 */
  77
  78 /** The minimum block size, in samples, permitted by the format. */
  79 #define FLAC__MIN_BLOCK_SIZE (16u)
  80
  81 /** The maximum block size, in samples, permitted by the format. */
  82 #define FLAC__MAX_BLOCK_SIZE (65535u)
  83
  84 /** The maximum number of channels permitted by the format. */
  85 #define FLAC__MAX_CHANNELS (8u)
  86
  87 /** The minimum sample resolution permitted by the format. */
  88 #define FLAC__MIN_BITS_PER_SAMPLE (4u)
  89
  90 /** The maximum sample resolution permitted by the format. */
  91 #define FLAC__MAX_BITS_PER_SAMPLE (32u)
  92
  93 /** The maximum sample resolution permitted by libFLAC.
  94  *
  95  * \warning
  96  * FLAC__MAX_BITS_PER_SAMPLE is the limit of the FLAC format.  However,
  97  * the reference encoder/decoder is currently limited to 24 bits because
  98  * of prevalent 32-bit math, so make sure and use this value when
  99  * appropriate.
 100  */
 101 #define FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE (24u)
 102
 103 /** The maximum sample rate permitted by the format.  The value is
 104  *  ((2 ^ 16) - 1) * 10; see <A HREF="../format.html">FLAC format</A>
 105  *  as to why.
 106  */
 107 #define FLAC__MAX_SAMPLE_RATE (655350u)
 108
 109 /** The maximum LPC order permitted by the format. */
 110 #define FLAC__MAX_LPC_ORDER (32u)
 111
 112 /** The minimum quantized linear predictor coefficient precision
 113  *  permitted by the format.
 114  */
 115 #define FLAC__MIN_QLP_COEFF_PRECISION (5u)
 116
 117 /** The maximum order of the fixed predictors permitted by the format. */
 118 #define FLAC__MAX_FIXED_ORDER (4u)
 119
 120 /** The maximum Rice partition order permitted by the format. */
 121 #define FLAC__MAX_RICE_PARTITION_ORDER (15u)
 122
 123 /** The maximum Rice partition order permitted by the FLAC Subset. */
 124 #define FLAC__SUBSET_MAX_RICE_PARTITION_ORDER (8u)
 125
 126 /** The version string of the release, stamped onto the libraries and binaries.
 127  *
 128  * \note
 129  * This does not correspond to the shared library version number, which
 130  * is used to determine binary compatibility.
 131  */
 132 extern const char *FLAC__VERSION_STRING;
 133
 134 /** The vendor string inserted by the encoder into the VORBIS_COMMENT block.
 135  *  This is a nulL-terminated ASCII string; when inserted into the
 136  *  VORBIS_COMMENT the trailing null is stripped.
 137  */
 138 extern const char *FLAC__VENDOR_STRING;
 139
 140 /** The byte string representation of the beginning of a FLAC stream. */
 141 extern const FLAC__byte FLAC__STREAM_SYNC_STRING[4]; /* = "fLaC" */
 142
 143 /** The 32-bit integer big-endian representation of the beginning of
 144  *  a FLAC stream.
 145  */
 146 extern const unsigned FLAC__STREAM_SYNC; /* = 0x664C6143 */
 147
 148 /** The length of the FLAC signature in bits. */
 149 extern const unsigned FLAC__STREAM_SYNC_LEN; /* = 32 bits */
 150
 151 /** The length of the FLAC signature in bytes. */
 152 #define FLAC__STREAM_SYNC_LENGTH (4u)
 153
 154
 155 /*****************************************************************************
 156  *
 157  * Subframe structures
 158  *
 159  *****************************************************************************/
 160
 161 /*****************************************************************************/
 162
 163 /** An enumeration of the available entropy coding methods. */
 164 typedef enum {
 165         FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE = 0
 166         /**< Residual is coded by partitioning into contexts, each with it's own
 167          * Rice parameter. */
 168 } FLAC__EntropyCodingMethodType;
 169
 170 /** Maps a FLAC__EntropyCodingMethodType to a C string.
 171  *
 172  *  Using a FLAC__EntropyCodingMethodType as the index to this array will
 173  *  give the string equivalent.  The contents should not be modified.
 174  */
 175 extern const char * const FLAC__EntropyCodingMethodTypeString[];
 176
 177
 178 /** Contents of a Rice partitioned residual
 179  */
 180 typedef struct {
 181
 182         unsigned *parameters;
 183         /**< The Rice parameters for each context. */
 184
 185         unsigned *raw_bits;
 186         /**< Widths for escape-coded partitions. */
 187
 188         unsigned capacity_by_order;
 189         /**< The capacity of the \a parameters and \a raw_bits arrays
 190          * specified as an order, i.e. the number of array elements
 191          * allocated is 2 ^ \a capacity_by_order.
 192          */
 193 } FLAC__EntropyCodingMethod_PartitionedRiceContents;
 194
 195 /** Header for a Rice partitioned residual.  (c.f. <A HREF="../format.html#partitioned_rice">format specification</A>)
 196  */
 197 typedef struct {
 198
 199         unsigned order;
 200         /**< The partition order, i.e. # of contexts = 2 ^ \a order. */
 201
 202         const FLAC__EntropyCodingMethod_PartitionedRiceContents *contents;
 203         /**< The context's Rice parameters and/or raw bits. */
 204
 205 } FLAC__EntropyCodingMethod_PartitionedRice;
 206
 207 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN; /**< == 4 (bits) */
 208 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN; /**< == 4 (bits) */
 209 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN; /**< == 5 (bits) */
 210
 211 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER;
 212 /**< == (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
 213
 214 /** Header for the entropy coding method.  (c.f. <A HREF="../format.html#residual">format specification</A>)
 215  */
 216 typedef struct {
 217         FLAC__EntropyCodingMethodType type;
 218         union {
 219                 FLAC__EntropyCodingMethod_PartitionedRice partitioned_rice;
 220         } data;
 221 } FLAC__EntropyCodingMethod;
 222
 223 extern const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN; /**< == 2 (bits) */
 224
 225 /*****************************************************************************/
 226
 227 /** An enumeration of the available subframe types. */
 228 typedef enum {
 229         FLAC__SUBFRAME_TYPE_CONSTANT = 0, /**< constant signal */
 230         FLAC__SUBFRAME_TYPE_VERBATIM = 1, /**< uncompressed signal */
 231         FLAC__SUBFRAME_TYPE_FIXED = 2, /**< fixed polynomial prediction */
 232         FLAC__SUBFRAME_TYPE_LPC = 3 /**< linear prediction */
 233 } FLAC__SubframeType;
 234
 235 /** Maps a FLAC__SubframeType to a C string.
 236  *
 237  *  Using a FLAC__SubframeType as the index to this array will
 238  *  give the string equivalent.  The contents should not be modified.
 239  */
 240 extern const char * const FLAC__SubframeTypeString[];
 241
 242
 243 /** CONSTANT subframe.  (c.f. <A HREF="../format.html#subframe_constant">format specification</A>)
 244  */
 245 typedef struct {
 246         FLAC__int32 value; /**< The constant signal value. */
 247 } FLAC__Subframe_Constant;
 248
 249
 250 /** VERBATIM subframe.  (c.f. <A HREF="../format.html#subframe_verbatim">format specification</A>)
 251  */
 252 typedef struct {
 253         const FLAC__int32 *data; /**< A pointer to verbatim signal. */
 254 } FLAC__Subframe_Verbatim;
 255
 256
 257 /** FIXED subframe.  (c.f. <A HREF="../format.html#subframe_fixed">format specification</A>)
 258  */
 259 typedef struct {
 260         FLAC__EntropyCodingMethod entropy_coding_method;
 261         /**< The residual coding method. */
 262
 263         unsigned order;
 264         /**< The polynomial order. */
 265
 266         FLAC__int32 warmup[FLAC__MAX_FIXED_ORDER];
 267         /**< Warmup samples to prime the predictor, length == order. */
 268
 269         const FLAC__int32 *residual;
 270         /**< The residual signal, length == (blocksize minus order) samples. */
 271 } FLAC__Subframe_Fixed;
 272
 273
 274 /** LPC subframe.  (c.f. <A HREF="../format.html#subframe_lpc">format specification</A>)
 275  */
 276 typedef struct {
 277         FLAC__EntropyCodingMethod entropy_coding_method;
 278         /**< The residual coding method. */
 279
 280         unsigned order;
 281         /**< The FIR order. */
 282
 283         unsigned qlp_coeff_precision;
 284         /**< Quantized FIR filter coefficient precision in bits. */
 285
 286         int quantization_level;
 287         /**< The qlp coeff shift needed. */
 288
 289         FLAC__int32 qlp_coeff[FLAC__MAX_LPC_ORDER];
 290         /**< FIR filter coefficients. */
 291
 292         FLAC__int32 warmup[FLAC__MAX_LPC_ORDER];
 293         /**< Warmup samples to prime the predictor, length == order. */
 294
 295         const FLAC__int32 *residual;
 296         /**< The residual signal, length == (blocksize minus order) samples. */
 297 } FLAC__Subframe_LPC;
 298
 299 extern const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN; /**< == 4 (bits) */
 300 extern const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN; /**< == 5 (bits) */
 301
 302
 303 /** FLAC subframe structure.  (c.f. <A HREF="../format.html#subframe">format specification</A>)
 304  */
 305 typedef struct {
 306         FLAC__SubframeType type;
 307         union {
 308                 FLAC__Subframe_Constant constant;
 309                 FLAC__Subframe_Fixed fixed;
 310                 FLAC__Subframe_LPC lpc;
 311                 FLAC__Subframe_Verbatim verbatim;
 312         } data;
 313         unsigned wasted_bits;
 314 } FLAC__Subframe;
 315
 316 extern const unsigned FLAC__SUBFRAME_ZERO_PAD_LEN; /**< == 1 (bit) */
 317 extern const unsigned FLAC__SUBFRAME_TYPE_LEN; /**< == 6 (bits) */
 318 extern const unsigned FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN; /**< == 1 (bit) */
 319
 320 extern const unsigned FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK; /* = 0x00 */
 321 extern const unsigned FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK; /* = 0x02 */
 322 extern const unsigned FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK; /* = 0x10 */
 323 extern const unsigned FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK; /* = 0x40 */
 324
 325 /*****************************************************************************/
 326
 327
 328 /*****************************************************************************
 329  *
 330  * Frame structures
 331  *
 332  *****************************************************************************/
 333
 334 /** An enumeration of the available channel assignments. */
 335 typedef enum {
 336         FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT = 0, /**< independent channels */
 337         FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE = 1, /**< left+side stereo */
 338         FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE = 2, /**< right+side stereo */
 339         FLAC__CHANNEL_ASSIGNMENT_MID_SIDE = 3 /**< mid+side stereo */
 340 } FLAC__ChannelAssignment;
 341
 342 /** Maps a FLAC__ChannelAssignment to a C string.
 343  *
 344  *  Using a FLAC__ChannelAssignment as the index to this array will
 345  *  give the string equivalent.  The contents should not be modified.
 346  */
 347 extern const char * const FLAC__ChannelAssignmentString[];
 348
 349 /** An enumeration of the possible frame numbering methods. */
 350 typedef enum {
 351         FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER, /**< number contains the frame number */
 352         FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER /**< number contains the sample number of first sample in frame */
 353 } FLAC__FrameNumberType;
 354
 355 /** Maps a FLAC__FrameNumberType to a C string.
 356  *
 357  *  Using a FLAC__FrameNumberType as the index to this array will
 358  *  give the string equivalent.  The contents should not be modified.
 359  */
 360 extern const char * const FLAC__FrameNumberTypeString[];
 361
 362
 363 /** FLAC frame header structure.  (c.f. <A HREF="../format.html#frame_header">format specification</A>)
 364  */
 365 typedef struct {
 366         unsigned blocksize;
 367         /**< The number of samples per subframe. */
 368
 369         unsigned sample_rate;
 370         /**< The sample rate in Hz. */
 371
 372         unsigned channels;
 373         /**< The number of channels (== number of subframes). */
 374
 375         FLAC__ChannelAssignment channel_assignment;
 376         /**< The channel assignment for the frame. */
 377
 378         unsigned bits_per_sample;
 379         /**< The sample resolution. */
 380
 381         FLAC__FrameNumberType number_type;
 382         /**< The numbering scheme used for the frame. */
 383
 384         union {
 385                 FLAC__uint32 frame_number;
 386                 FLAC__uint64 sample_number;
 387         } number;
 388         /**< The frame number or sample number of first sample in frame;
 389          * use the \a number_type value to determine which to use. */
 390
 391         FLAC__uint8 crc;
 392         /**< CRC-8 (polynomial = x^8 + x^2 + x^1 + x^0, initialized with 0)
 393          * of the raw frame header bytes, meaning everything before the CRC byte
 394          * including the sync code.
 395          */
 396 } FLAC__FrameHeader;
 397
 398 extern const unsigned FLAC__FRAME_HEADER_SYNC; /**< == 0x3ffe; the frame header sync code */
 399 extern const unsigned FLAC__FRAME_HEADER_SYNC_LEN; /**< == 14 (bits) */
 400 extern const unsigned FLAC__FRAME_HEADER_RESERVED_LEN; /**< == 2 (bits) */
 401 extern const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN; /**< == 4 (bits) */
 402 extern const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN; /**< == 4 (bits) */
 403 extern const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN; /**< == 4 (bits) */
 404 extern const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN; /**< == 3 (bits) */
 405 extern const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN; /**< == 1 (bit) */
 406 extern const unsigned FLAC__FRAME_HEADER_CRC_LEN; /**< == 8 (bits) */
 407
 408
 409 /** FLAC frame footer structure.  (c.f. <A HREF="../format.html#frame_footer">format specification</A>)
 410  */
 411 typedef struct {
 412         FLAC__uint16 crc;
 413         /**< CRC-16 (polynomial = x^16 + x^15 + x^2 + x^0, initialized with
 414          * 0) of the bytes before the crc, back to and including the frame header
 415          * sync code.
 416          */
 417 } FLAC__FrameFooter;
 418
 419 extern const unsigned FLAC__FRAME_FOOTER_CRC_LEN; /**< == 16 (bits) */
 420
 421
 422 /** FLAC frame structure.  (c.f. <A HREF="../format.html#frame">format specification</A>)
 423  */
 424 typedef struct {
 425         FLAC__FrameHeader header;
 426         FLAC__Subframe subframes[FLAC__MAX_CHANNELS];
 427         FLAC__FrameFooter footer;
 428 } FLAC__Frame;
 429
 430 /*****************************************************************************/
 431
 432
 433 /*****************************************************************************
 434  *
 435  * Meta-data structures
 436  *
 437  *****************************************************************************/
 438
 439 /** An enumeration of the available metadata block types. */
 440 typedef enum {
 441
 442         FLAC__METADATA_TYPE_STREAMINFO = 0,
 443         /**< <A HREF="../format.html#metadata_block_streaminfo">STREAMINFO</A> block */
 444
 445         FLAC__METADATA_TYPE_PADDING = 1,
 446         /**< <A HREF="../format.html#metadata_block_padding"PADDING</A> block */
 447
 448         FLAC__METADATA_TYPE_APPLICATION = 2,
 449         /**< <A HREF="../format.html#metadata_block_application"APPLICATION</A> block */
 450
 451         FLAC__METADATA_TYPE_SEEKTABLE = 3,
 452         /**< <A HREF="../format.html#metadata_block_seektable"SEEKTABLE</A> block */
 453
 454         FLAC__METADATA_TYPE_VORBIS_COMMENT = 4,
 455         /**< <A HREF="../format.html#metadata_block_vorbis_comment"VORBISCOMMENT</A> block */
 456
 457 } FLAC__MetadataType;
 458
 459 /** Maps a FLAC__MetadataType to a C string.
 460  *
 461  *  Using a FLAC__MetadataType as the index to this array will
 462  *  give the string equivalent.  The contents should not be modified.
 463  */
 464 extern const char * const FLAC__MetadataTypeString[];
 465
 466
 467 /** FLAC STREAMINFO structure.  (c.f. <A HREF="../format.html#metadata_block_streaminfo">format specification</A>)
 468  */
 469 typedef struct {
 470         unsigned min_blocksize, max_blocksize;
 471         unsigned min_framesize, max_framesize;
 472         unsigned sample_rate;
 473         unsigned channels;
 474         unsigned bits_per_sample;
 475         FLAC__uint64 total_samples;
 476         FLAC__byte md5sum[16];
 477 } FLAC__StreamMetadata_StreamInfo;
 478
 479 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN; /**< == 16 (bits) */
 480 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN; /**< == 16 (bits) */
 481 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN; /**< == 24 (bits) */
 482 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN; /**< == 24 (bits) */
 483 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN; /**< == 20 (bits) */
 484 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN; /**< == 3 (bits) */
 485 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN; /**< == 5 (bits) */
 486 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN; /**< == 36 (bits) */
 487 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN; /**< == 128 (bits) */
 488
 489 /** The total stream length of the STREAMINFO block in bytes. */
 490 #define FLAC__STREAM_METADATA_STREAMINFO_LENGTH (34u)
 491
 492 /** FLAC PADDING structure.  (c.f. <A HREF="../format.html#metadata_block_padding">format specification</A>)
 493  */
 494 typedef struct {
 495         int dummy;
 496         /**< Conceptually this is an empty struct since we don't store the
 497          * padding bytes.  Empty structs are not allowed by some C compilers,
 498          * hence the dummy.
 499          */
 500 } FLAC__StreamMetadata_Padding;
 501
 502
 503 /** FLAC APPLICATION structure.  (c.f. <A HREF="../format.html#metadata_block_application">format specification</A>)
 504  */
 505 typedef struct {
 506         FLAC__byte id[4];
 507         FLAC__byte *data;
 508 } FLAC__StreamMetadata_Application;
 509
 510 extern const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN; /**< == 32 (bits) */
 511
 512 /** SeekPoint structure used in SEEKTABLE blocks.  (c.f. <A HREF="../format.html#seekpoint">format specification</A>)
 513  */
 514 typedef struct {
 515         FLAC__uint64 sample_number;
 516         /**<  The sample number of the target frame. */
 517
 518         FLAC__uint64 stream_offset;
 519         /**< The offset, in bytes, of the target frame with respect to
 520          * beginning of the first frame. */
 521
 522         unsigned frame_samples;
 523         /**< The number of samples in the target frame. */
 524 } FLAC__StreamMetadata_SeekPoint;
 525
 526 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN; /**< == 64 (bits) */
 527 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN; /**< == 64 (bits) */
 528 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN; /**< == 16 (bits) */
 529
 530 /** The total stream length of a seek point in bytes. */
 531 #define FLAC__STREAM_METADATA_SEEKPOINT_LENGTH (18u)
 532
 533 /** The value used in the \a sample_number field of
 534  *  FLAC__StreamMetadataSeekPoint used to indicate a placeholder
 535  *  point (== 0xffffffffffffffff).
 536  */
 537 extern const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
 538
 539
 540 /** FLAC SEEKTABLE structure.  (c.f. <A HREF="../format.html#metadata_block_seektable">format specification</A>)
 541  *
 542  * \note From the format specification:
 543  * - The seek points must be sorted by ascending sample number.
 544  * - Each seek point's sample number must be the first sample of the
 545  *   target frame.
 546  * - Each seek point's sample number must be unique within the table.
 547  * - Existence of a SEEKTABLE block implies a correct setting of
 548  *   total_samples in the stream_info block.
 549  * - Behavior is undefined when more than one SEEKTABLE block is
 550  *   present in a stream.
 551  */
 552 typedef struct {
 553         unsigned num_points;
 554         FLAC__StreamMetadata_SeekPoint *points;
 555 } FLAC__StreamMetadata_SeekTable;
 556
 557
 558 /** Vorbis comment entry structure used in VORBIS_COMMENT blocks.  (c.f. <A HREF="../format.html#metadata_block_vorbis_comment">format specification</A>)
 559  */
 560 typedef struct {
 561         FLAC__uint32 length;
 562         FLAC__byte *entry;
 563 } FLAC__StreamMetadata_VorbisComment_Entry;
 564
 565 extern const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN; /**< == 32 (bits) */
 566
 567
 568 /** FLAC VORBIS_COMMENT structure.  (c.f. <A HREF="../format.html#metadata_block_vorbis_comment">format specification</A>)
 569  */
 570 typedef struct {
 571         FLAC__StreamMetadata_VorbisComment_Entry vendor_string;
 572         FLAC__uint32 num_comments;
 573         FLAC__StreamMetadata_VorbisComment_Entry *comments;
 574 } FLAC__StreamMetadata_VorbisComment;
 575
 576 extern const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN; /**< == 32 (bits) */
 577
 578
 579 /** FLAC metadata block structure.  (c.f. <A HREF="../format.html#metadata_block">format specification</A>)
 580  */
 581 typedef struct {
 582         FLAC__MetadataType type;
 583         /**< The type of the metadata block; used determine which member of the
 584          * \a data union to dereference. */
 585
 586         FLAC__bool is_last;
 587         /**< \c true if this metadata block is the last, else \a false */
 588
 589         unsigned length;
 590         /**< Length, in bytes, of the block data as it appears in the stream. */
 591
 592         union {
 593                 FLAC__StreamMetadata_StreamInfo stream_info;
 594                 FLAC__StreamMetadata_Padding padding;
 595                 FLAC__StreamMetadata_Application application;
 596                 FLAC__StreamMetadata_SeekTable seek_table;
 597                 FLAC__StreamMetadata_VorbisComment vorbis_comment;
 598         } data;
 599         /**< Polymorphic block data; use the \a type value to determine which
 600          * to use. */
 601 } FLAC__StreamMetadata;
 602
 603 extern const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN; /**< == 1 (bit) */
 604 extern const unsigned FLAC__STREAM_METADATA_TYPE_LEN; /**< == 7 (bits) */
 605 extern const unsigned FLAC__STREAM_METADATA_LENGTH_LEN; /**< == 24 (bits) */
 606
 607 /** The total stream length of a metadata block header in bytes. */
 608 #define FLAC__STREAM_METADATA_HEADER_LENGTH (4u)
 609
 610 /*****************************************************************************/
 611
 612
 613 /*****************************************************************************
 614  *
 615  * Utility functions
 616  *
 617  *****************************************************************************/
 618
 619 /** Tests that a sample rate is valid for FLAC.  Since the rules for valid
 620  *  sample rates are slightly complex, they are encapsulated in this function.
 621  *
 622  * \param sample_rate  The sample rate to test for compliance.
 623  * \retval FLAC__bool
 624  *    \c true if the given sample rate conforms to the specification, else
 625  *    \c false.
 626  */
 627 FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate);
 628
 629 /** Check a seek table to see if it conforms to the FLAC specification.
 630  *  See the format specification for limits on the contents of the
 631  *  seek table.
 632  *
 633  * \param seek_table  A pointer to a seek table to be checked.
 634  * \assert
 635  *    \code seek_table != NULL \endcode
 636  * \retval FLAC__bool
 637  *    \c false if seek table is illegal, else \c true.
 638  */
 639 FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table);
 640
 641 /** Sort a seek table's seek points according to the format specification.
 642  *  This includes a "unique-ification" step to remove duplicates, i.e.
 643  *  seek points with identical \a sample_number values.  Duplicate seek
 644  *  points are converted into placeholder points and sorted to the end of
 645  *  the table.
 646  *
 647  * \param seek_table  A pointer to a seek table to be sorted.
 648  * \assert
 649  *    \code seek_table != NULL \endcode
 650  * \retval unsigned
 651  *    The number of duplicate seek points converted into placeholders.
 652  */
 653 unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table);
 654
 655 /* \} */
 656
 657 #ifdef __cplusplus
 658 }
 659 #endif
 660
 661 #endif