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