minor comments
[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
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 /* VERSION should come from configure */
124 #ifdef VERSION
125 /** The version string of the current library.
126  *
127  * \note
128  * This does not correspond to the shared library version number, which
129  * is used to determine binary compatibility.
130  */
131 #define FLAC__VERSION_STRING VERSION
132 #endif
133
134 /** The byte string representation of the beginning of a FLAC stream. */
135 extern const FLAC__byte FLAC__STREAM_SYNC_STRING[4]; /* = "fLaC" */;
136
137 /** The 32-bit integer big-endian representation of the beginning of
138  *  a FLAC stream.
139  */
140 extern const unsigned FLAC__STREAM_SYNC; /* = 0x664C6143 */;
141
142 /** The length of the FLAC signature in bits. */
143 extern const unsigned FLAC__STREAM_SYNC_LEN; /* = 32 bits */;
144
145 /** The length of the FLAC signature in bytes. */
146 #define FLAC__STREAM_SYNC_LENGTH (4u)
147
148
149 /*****************************************************************************
150  * @@@ REMOVE?
151  * NOTE: Within the bitstream, all fixed-width numbers are big-endian coded.
152  *       All numbers are unsigned unless otherwise noted.
153  *
154  *****************************************************************************/
155
156
157 /*****************************************************************************
158  *
159  * Subframe structures
160  *
161  *****************************************************************************/
162
163 /*****************************************************************************/
164
165 /** An enumeration of the available entropy coding methods. */
166 typedef enum {
167         FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE = 0
168         /**< Residual is coded by partitioning into contexts, each with it's own
169      * Rice parameter. */
170 } FLAC__EntropyCodingMethodType;
171
172 /** Maps a FLAC__EntropyCodingMethodType to a C string.
173  *
174  *  Using a FLAC__EntropyCodingMethodType as the index to this array will
175  *  give the string equivalent.  The contents should not be modified.
176  */
177 extern const char * const FLAC__EntropyCodingMethodTypeString[];
178
179
180 /** Contents of a Rice partitioned residual
181  */
182 typedef struct {
183
184         unsigned *parameters;
185         /**< The Rice parameters for each context. */
186
187         unsigned *raw_bits;
188         /**< Widths for escape-coded partitions. */
189
190         unsigned capacity_by_order;
191         /**< The capacity of the \a parameters and \a raw_bits arrays
192          * specified as an order, i.e. the number of array elements
193          * allocated is 2 ^ \a capacity_by_order.
194          */
195 } FLAC__EntropyCodingMethod_PartitionedRiceContents;
196
197 /** Header for a Rice partitioned residual.  (c.f. <A HREF="../format.html#partitioned_rice">format specification</A>)
198  */
199 typedef struct {
200
201         unsigned order;
202         /**< The partition order, i.e. # of contexts = 2 ^ \a order. */
203
204         const FLAC__EntropyCodingMethod_PartitionedRiceContents *contents;
205         /**< The context's Rice parameters and/or raw bits. */
206
207 } FLAC__EntropyCodingMethod_PartitionedRice;
208
209 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN; /**< == 4 (bits) */
210 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN; /**< == 4 (bits) */
211 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN; /**< == 5 (bits) */
212
213 extern const unsigned FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER;
214 /**< == (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1 */
215
216 /** Header for the entropy coding method.  (c.f. <A HREF="../format.html#residual">format specification</A>)
217  */
218 typedef struct {
219         FLAC__EntropyCodingMethodType type;
220         union {
221                 FLAC__EntropyCodingMethod_PartitionedRice partitioned_rice;
222         } data;
223 } FLAC__EntropyCodingMethod;
224
225 extern const unsigned FLAC__ENTROPY_CODING_METHOD_TYPE_LEN; /**< == 2 (bits) */
226
227 /*****************************************************************************/
228
229 /** An enumeration of the available subframe types. */
230 typedef enum {
231         FLAC__SUBFRAME_TYPE_CONSTANT = 0, /**< constant signal */
232         FLAC__SUBFRAME_TYPE_VERBATIM = 1, /**< uncompressed signal */
233         FLAC__SUBFRAME_TYPE_FIXED = 2, /**< fixed polynomial prediction */
234         FLAC__SUBFRAME_TYPE_LPC = 3 /**< linear prediction */
235 } FLAC__SubframeType;
236
237 /** Maps a FLAC__SubframeType to a C string.
238  *
239  *  Using a FLAC__SubframeType as the index to this array will
240  *  give the string equivalent.  The contents should not be modified.
241  */
242 extern const char * const FLAC__SubframeTypeString[];
243
244
245 /** CONSTANT subframe.  (c.f. <A HREF="../format.html#subframe_constant">format specification</A>)
246  */
247 typedef struct {
248         FLAC__int32 value; /**< The constant signal value. */
249 } FLAC__Subframe_Constant;
250
251
252 /** VERBATIM subframe.  (c.f. <A HREF="../format.html#subframe_verbatim">format specification</A>)
253  */
254 typedef struct {
255         const FLAC__int32 *data; /**< A pointer to verbatim signal. */
256 } FLAC__Subframe_Verbatim;
257
258
259 /** FIXED subframe.  (c.f. <A HREF="../format.html#subframe_fixed">format specification</A>)
260  */
261 typedef struct {
262         FLAC__EntropyCodingMethod entropy_coding_method;
263         /**< The residual coding method. */
264
265         unsigned order;
266         /**< The polynomial order. */
267
268         FLAC__int32 warmup[FLAC__MAX_FIXED_ORDER];
269         /**< Warmup samples to prime the predictor, length == order. */
270
271         const FLAC__int32 *residual;
272         /**< The residual signal, length == (blocksize minus order) samples. */
273 } FLAC__Subframe_Fixed;
274
275
276 /** LPC subframe.  (c.f. <A HREF="../format.html#subframe_lpc">format specification</A>)
277  */
278 typedef struct {
279         FLAC__EntropyCodingMethod entropy_coding_method;
280         /**< The residual coding method. */
281
282         unsigned order;
283         /**< The FIR order. */
284
285         unsigned qlp_coeff_precision;
286         /**< Quantized FIR filter coefficient precision in bits. */
287
288         int quantization_level;
289         /**< The qlp coeff shift needed. */
290
291         FLAC__int32 qlp_coeff[FLAC__MAX_LPC_ORDER];
292         /**< FIR filter coefficients. */
293
294         FLAC__int32 warmup[FLAC__MAX_LPC_ORDER];
295         /**< Warmup samples to prime the predictor, length == order. */
296
297         const FLAC__int32 *residual;
298         /**< The residual signal, length == (blocksize minus order) samples. */
299 } FLAC__Subframe_LPC;
300
301 extern const unsigned FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN; /**< == 4 (bits) */
302 extern const unsigned FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN; /**< == 5 (bits) */
303
304
305 /** FLAC subframe structure.  (c.f. <A HREF="../format.html#subframe">format specification</A>)
306  */
307 typedef struct {
308         FLAC__SubframeType type;
309         union {
310                 FLAC__Subframe_Constant constant;
311                 FLAC__Subframe_Fixed fixed;
312                 FLAC__Subframe_LPC lpc;
313                 FLAC__Subframe_Verbatim verbatim;
314         } data;
315         unsigned wasted_bits;
316 } FLAC__Subframe;
317
318 extern const unsigned FLAC__SUBFRAME_ZERO_PAD_LEN; /**< == 1 (bit) */
319 extern const unsigned FLAC__SUBFRAME_TYPE_LEN; /**< == 6 (bits) */
320 extern const unsigned FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN; /**< == 1 (bit) */
321
322 extern const unsigned FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK; /* = 0x00 */
323 extern const unsigned FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK; /* = 0x02 */
324 extern const unsigned FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK; /* = 0x10 */
325 extern const unsigned FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK; /* = 0x40 */
326
327 /*****************************************************************************/
328
329
330 /*****************************************************************************
331  *
332  * Frame structures
333  *
334  *****************************************************************************/
335
336 /** An enumeration of the available channel assignments. */
337 typedef enum {
338         FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT = 0, /**< independent channels */
339         FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE = 1, /**< left+side stereo */
340         FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE = 2, /**< right+side stereo */
341         FLAC__CHANNEL_ASSIGNMENT_MID_SIDE = 3 /**< mid+side stereo */
342 } FLAC__ChannelAssignment;
343
344 /** Maps a FLAC__ChannelAssignment to a C string.
345  *
346  *  Using a FLAC__ChannelAssignment as the index to this array will
347  *  give the string equivalent.  The contents should not be modified.
348  */
349 extern const char * const FLAC__ChannelAssignmentString[];
350
351 /** An enumeration of the possible frame numbering methods. */
352 typedef enum {
353         FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER, /**< number contains the frame number */
354         FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER /**< number contains the sample number of first sample in frame */
355 } FLAC__FrameNumberType;
356
357 /** Maps a FLAC__FrameNumberType to a C string.
358  *
359  *  Using a FLAC__FrameNumberType as the index to this array will
360  *  give the string equivalent.  The contents should not be modified.
361  */
362 extern const char * const FLAC__FrameNumberTypeString[];
363
364
365 /** FLAC frame header structure.  (c.f. <A HREF="../format.html#frame_header">format specification</A>)
366  */
367 typedef struct {
368         unsigned blocksize;
369         /**< The number of samples per subframe. */
370
371         unsigned sample_rate;
372         /**< The sample rate in Hz. */
373
374         unsigned channels;
375         /**< The number of channels (== number of subframes). */
376
377         FLAC__ChannelAssignment channel_assignment;
378         /**< The channel assignment for the frame. */
379
380         unsigned bits_per_sample;
381         /**< The sample resolution. */
382
383         FLAC__FrameNumberType number_type;
384         /**< The numbering scheme used for the frame. */
385
386         union {
387                 FLAC__uint32 frame_number;
388                 FLAC__uint64 sample_number;
389         } number;
390         /**< The frame number or sample number of first sample in frame;
391          * use the \a number_type value to determine which to use. */
392
393         FLAC__uint8 crc;
394         /**< CRC-8 (polynomial = x^8 + x^2 + x^1 + x^0, initialized with 0)
395          * of the raw frame header bytes, meaning everything before the CRC byte
396          * including the sync code.
397          */
398 } FLAC__FrameHeader;
399
400 extern const unsigned FLAC__FRAME_HEADER_SYNC; /**< == 0x3ffe; the frame header sync code */
401 extern const unsigned FLAC__FRAME_HEADER_SYNC_LEN; /**< == 14 (bits) */
402 extern const unsigned FLAC__FRAME_HEADER_RESERVED_LEN; /**< == 2 (bits) */
403 extern const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN; /**< == 4 (bits) */
404 extern const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN; /**< == 4 (bits) */
405 extern const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN; /**< == 4 (bits) */
406 extern const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN; /**< == 3 (bits) */
407 extern const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN; /**< == 1 (bit) */
408 extern const unsigned FLAC__FRAME_HEADER_CRC_LEN; /**< == 8 (bits) */
409
410
411 /** FLAC frame footer structure.  (c.f. <A HREF="../format.html#frame_footer">format specification</A>)
412  */
413 typedef struct {
414         FLAC__uint16 crc;
415         /**< CRC-16 (polynomial = x^16 + x^15 + x^2 + x^0, initialized with
416          * 0) of the bytes before the crc, back to and including the frame header
417          * sync code.
418          */
419 } FLAC__FrameFooter;
420
421 extern const unsigned FLAC__FRAME_FOOTER_CRC_LEN; /**< == 16 (bits) */
422
423
424 /** FLAC frame structure.  (c.f. <A HREF="../format.html#frame">format specification</A>)
425  */
426 typedef struct {
427         FLAC__FrameHeader header;
428         FLAC__Subframe subframes[FLAC__MAX_CHANNELS];
429         FLAC__FrameFooter footer;
430 } FLAC__Frame;
431
432 /*****************************************************************************/
433
434
435 /*****************************************************************************
436  *
437  * Meta-data structures
438  *
439  *****************************************************************************/
440
441 /** An enumeration of the available metadata block types. */
442 typedef enum {
443
444         FLAC__METADATA_TYPE_STREAMINFO = 0,
445         /**< <A HREF="../format.html#metadata_block_streaminfo">STREAMINFO</A> block */
446
447         FLAC__METADATA_TYPE_PADDING = 1,
448         /**< <A HREF="../format.html#metadata_block_padding"PADDING</A> block */
449
450         FLAC__METADATA_TYPE_APPLICATION = 2,
451         /**< <A HREF="../format.html#metadata_block_application"APPLICATION</A> block */
452
453         FLAC__METADATA_TYPE_SEEKTABLE = 3,
454         /**< <A HREF="../format.html#metadata_block_seektable"SEEKTABLE</A> block */
455
456         FLAC__METADATA_TYPE_VORBIS_COMMENT = 4,
457         /**< <A HREF="../format.html#metadata_block_vorbis_comment"VORBISCOMMENT</A> block */
458
459 } FLAC__MetadataType;
460
461 /** Maps a FLAC__MetadataType to a C string.
462  *
463  *  Using a FLAC__MetadataType as the index to this array will
464  *  give the string equivalent.  The contents should not be modified.
465  */
466 extern const char * const FLAC__MetadataTypeString[];
467
468
469 /** FLAC STREAMINFO structure.  (c.f. <A HREF="../format.html#metadata_block_streaminfo">format specification</A>)
470  */
471 typedef struct {
472         unsigned min_blocksize, max_blocksize;
473         unsigned min_framesize, max_framesize;
474         unsigned sample_rate;
475         unsigned channels;
476         unsigned bits_per_sample;
477         FLAC__uint64 total_samples;
478         FLAC__byte md5sum[16];
479 } FLAC__StreamMetadata_StreamInfo;
480
481 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN; /**< == 16 (bits) */
482 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN; /**< == 16 (bits) */
483 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN; /**< == 24 (bits) */
484 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN; /**< == 24 (bits) */
485 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN; /**< == 20 (bits) */
486 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN; /**< == 3 (bits) */
487 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN; /**< == 5 (bits) */
488 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN; /**< == 36 (bits) */
489 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN; /**< == 128 (bits) */
490
491 /** The total stream length of the STREAMINFO block in bytes. */
492 #define FLAC__STREAM_METADATA_STREAMINFO_LENGTH (34u)
493
494 /** FLAC PADDING structure.  (c.f. <A HREF="../format.html#metadata_block_padding">format specification</A>)
495  */
496 typedef struct {
497         int dummy;
498         /**< Conceptually this is an empty struct since we don't store the
499          * padding bytes.  Empty structs are not allowed by some C compilers,
500          * hence the dummy.
501          */
502 } FLAC__StreamMetadata_Padding;
503
504
505 /** FLAC APPLICATION structure.  (c.f. <A HREF="../format.html#metadata_block_application">format specification</A>)
506  */
507 typedef struct {
508         FLAC__byte id[4];
509         FLAC__byte *data;
510 } FLAC__StreamMetadata_Application;
511
512 extern const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN; /**< == 32 (bits) */
513
514 /** SeekPoint structure used in SEEKTABLE blocks.  (c.f. <A HREF="../format.html#seekpoint">format specification</A>)
515  */
516 typedef struct {
517         FLAC__uint64 sample_number;
518         /**<  The sample number of the target frame. */
519
520         FLAC__uint64 stream_offset;
521         /**< The offset, in bytes, of the target frame with respect to
522          * beginning of the first frame. */
523
524         unsigned frame_samples;
525         /**< The number of samples in the target frame. */
526 } FLAC__StreamMetadata_SeekPoint;
527
528 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN; /**< == 64 (bits) */
529 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN; /**< == 64 (bits) */
530 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN; /**< == 16 (bits) */
531
532 /** The total stream length of a seek point in bytes. */
533 #define FLAC__STREAM_METADATA_SEEKPOINT_LENGTH (18u)
534
535 /** The value used in the \a sample_number field of
536  *  FLAC__StreamMetadataSeekPoint used to indicate a placeholder
537  *  point (== 0xffffffffffffffff).
538  */
539 extern const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
540
541
542 /** FLAC SEEKTABLE structure.  (c.f. <A HREF="../format.html#metadata_block_seektable">format specification</A>)
543  *
544  * \note From the format specification:
545  * - The seek points must be sorted by ascending sample number.
546  * - Each seek point's sample number must be the first sample of the
547  *   target frame.
548  * - Each seek point's sample number must be unique within the table.
549  * - Existence of a SEEKTABLE block implies a correct setting of
550  *   total_samples in the stream_info block.
551  * - Behavior is undefined when more than one SEEKTABLE block is
552  *   present in a stream.
553  */
554 typedef struct {
555         unsigned num_points;
556         FLAC__StreamMetadata_SeekPoint *points;
557 } FLAC__StreamMetadata_SeekTable;
558
559
560 /** Vorbis comment entry structure used in VORBIS_COMMENT blocks.  (c.f. <A HREF="../format.html#metadata_block_vorbis_comment">format specification</A>)
561  */
562 typedef struct {
563         FLAC__uint32 length;
564         FLAC__byte *entry;
565 } FLAC__StreamMetadata_VorbisComment_Entry;
566
567 extern const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN; /**< == 32 (bits) */
568
569
570 /** FLAC VORBIS_COMMENT structure.  (c.f. <A HREF="../format.html#metadata_block_vorbis_comment">format specification</A>)
571  */
572 typedef struct {
573         FLAC__StreamMetadata_VorbisComment_Entry vendor_string;
574         FLAC__uint32 num_comments;
575         FLAC__StreamMetadata_VorbisComment_Entry *comments;
576 } FLAC__StreamMetadata_VorbisComment;
577
578 extern const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN; /**< == 32 (bits) */
579
580
581 /** FLAC metadata block structure.  (c.f. <A HREF="../format.html#metadata_block">format specification</A>)
582  */
583 typedef struct {
584         FLAC__MetadataType type;
585         /**< The type of the metadata block; used determine which member of the
586          * \a data union to dereference. */
587
588         FLAC__bool is_last;
589         /**< \c true if this metadata block is the last, else \a false */
590
591         unsigned length;
592         /**< Length, in bytes, of the block data as it appears in the stream. */
593
594         union {
595                 FLAC__StreamMetadata_StreamInfo stream_info;
596                 FLAC__StreamMetadata_Padding padding;
597                 FLAC__StreamMetadata_Application application;
598                 FLAC__StreamMetadata_SeekTable seek_table;
599                 FLAC__StreamMetadata_VorbisComment vorbis_comment;
600         } data;
601         /**< Polymorphic block data; use the \a type value to determine which
602          * to use. */
603 } FLAC__StreamMetadata;
604
605 extern const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN; /**< == 1 (bit) */
606 extern const unsigned FLAC__STREAM_METADATA_TYPE_LEN; /**< == 7 (bits) */
607 extern const unsigned FLAC__STREAM_METADATA_LENGTH_LEN; /**< == 24 (bits) */
608
609 /** The total stream length of a metadata block header in bytes. */
610 #define FLAC__STREAM_METADATA_HEADER_LENGTH (4u)
611
612 /*****************************************************************************/
613
614
615 /*****************************************************************************
616  *
617  * Utility functions
618  *
619  *****************************************************************************/
620
621 /** Tests that a sample rate is valid for FLAC.  Since the rules for valid
622  *  sample rates are slightly complex, they are encapsulated in this function.
623  *
624  * \param sample_rate  The sample rate to test for compliance.
625  * \retval FLAC__bool
626  *    \c true if the given sample rate conforms to the specification, else
627  *    \c false.
628  */
629 FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate);
630
631 /** Check a seek table to see if it conforms to the FLAC specification.
632  *  See the format specification for limits on the contents of the
633  *  seek table.
634  *
635  * \param seek_table  A pointer to a seek table to be checked.
636  * \assert
637  *    \code seek_table != NULL \endcode
638  * \retval FLAC__bool
639  *    \c false if seek table is illegal, else \c true.
640  */
641 FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table);
642
643 /** Sort a seek table's seek points according to the format specification.
644  *  This includes a "unique-ification" step to remove duplicates, i.e.
645  *  seek points with identical \a sample_number values.  Duplicate seek
646  *  points are converted into placeholder points and sorted to the end of
647  *  the table.
648  *
649  * \param seek_table  A pointer to a seek table to be sorted.
650  * \assert
651  *    \code seek_table != NULL \endcode
652  * \retval unsigned
653  *    The number of duplicate seek points converted into placeholders.
654  */
655 unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table);
656
657 /* \} */
658
659 #ifdef __cplusplus
660 }
661 #endif
662
663 #endif