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