more doxygen docs
[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; /**< constant signal value */
233 } FLAC__Subframe_Constant;
234
235
236 /** VERBATIM subframe.  (XXX format XXX)
237  */
238 typedef struct {
239         const FLAC__int32 *data; /**< 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         /**< residual coding method */
248
249         unsigned order;
250         /**< polynomial order */
251
252         FLAC__int32 warmup[FLAC__MAX_FIXED_ORDER];
253         /**< warmup samples to prime the predictor, length is order */
254
255         const FLAC__int32 *residual;
256         /**< residual signal, length is (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         /**< residual coding method */
265
266         unsigned order;
267         /**< FIR order */
268
269         unsigned qlp_coeff_precision;
270         /**< quantized FIR filter coefficient precision in bits
271
272         int quantization_level;
273         /**< 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 is order */
280
281         const FLAC__int32 *residual;
282         /**< residual signal, length is (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         /**< number of samples per subframe */
354
355         unsigned sample_rate;
356         /**< sample rate in Hz */
357
358         unsigned channels;
359         /**< number of channels == number of subframes */
360
361         FLAC__ChannelAssignment channel_assignment;
362         /**< channel assignment for the frame */
363
364         unsigned bits_per_sample;
365         /**< sample resolution */
366
367         FLAC__FrameNumberType number_type;
368         /**< numbering scheme used for the frame */
369
370         union {
371                 FLAC__uint32 frame_number;
372                 FLAC__uint64 sample_number;
373         } number;
374         /**< frame number or sample number of first sample in frame; check number_type */
375
376         FLAC__uint8 crc;
377         /**< CRC-8 (polynomial = x^8 + x^2 + x^1 + x^0, initialized with 0) of the
378          * raw frame header bytes, meaning everything before the CRC byte including
379          * the sync code
380          */
381 } FLAC__FrameHeader;
382
383 extern const unsigned FLAC__FRAME_HEADER_SYNC; /**< == 0x3ffe; the frame header sync code */
384 extern const unsigned FLAC__FRAME_HEADER_SYNC_LEN; /**< == 14 (bits) */
385 extern const unsigned FLAC__FRAME_HEADER_RESERVED_LEN; /**< == 2 (bits) */
386 extern const unsigned FLAC__FRAME_HEADER_BLOCK_SIZE_LEN; /**< == 4 (bits) */
387 extern const unsigned FLAC__FRAME_HEADER_SAMPLE_RATE_LEN; /**< == 4 (bits) */
388 extern const unsigned FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN; /**< == 4 (bits) */
389 extern const unsigned FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN; /**< == 3 (bits) */
390 extern const unsigned FLAC__FRAME_HEADER_ZERO_PAD_LEN; /**< == 1 (bit) */
391 extern const unsigned FLAC__FRAME_HEADER_CRC_LEN; /**< == 8 (bits) */
392
393
394 /** FLAC frame footer structure.  (XXX format XXX)
395  */
396 typedef struct {
397         FLAC__uint16 crc;
398         /**< CRC-16 (polynomial = x^16 + x^15 + x^2 + x^0, initialized with 0)
399          * of the bytes before the crc, back to and including the frame header
400          * sync code
401          */
402 } FLAC__FrameFooter;
403
404 extern const unsigned FLAC__FRAME_FOOTER_CRC_LEN; /**< == 16 (bits) */
405
406
407 /** FLAC frame structure.  (XXX format XXX)
408  */
409 typedef struct {
410         FLAC__FrameHeader header;
411         FLAC__Subframe subframes[FLAC__MAX_CHANNELS];
412         FLAC__FrameFooter footer;
413 } FLAC__Frame;
414
415 /*****************************************************************************/
416
417
418 /*****************************************************************************
419  *
420  * Meta-data structures
421  *
422  *****************************************************************************/
423
424 typedef enum {
425         FLAC__METADATA_TYPE_STREAMINFO = 0,
426         FLAC__METADATA_TYPE_PADDING = 1,
427         FLAC__METADATA_TYPE_APPLICATION = 2,
428         FLAC__METADATA_TYPE_SEEKTABLE = 3,
429         FLAC__METADATA_TYPE_VORBIS_COMMENT = 4
430 } FLAC__MetadataType;
431 extern const char * const FLAC__MetadataTypeString[];
432
433 /*****************************************************************************
434  *
435  * 16: minimum blocksize (in samples) of all blocks in the stream
436  * 16: maximum blocksize (in samples) of all blocks in the stream
437  * 24: minimum framesize (in bytes) of all frames in the stream; 0 => unknown
438  * 24: maximum framesize (in bytes) of all frames in the stream; 0 => unknown
439  * 20: sample rate in Hz, 0 is invalid
440  *  3: (number of channels)-1
441  *  5: (bits per sample)-1
442  * 36: total samples, 0 => unknown
443  *128: MD5 digest of the original unencoded audio data
444  *---- -----------------
445  * 34  bytes total
446  */
447 typedef struct {
448         unsigned min_blocksize, max_blocksize;
449         unsigned min_framesize, max_framesize;
450         unsigned sample_rate;
451         unsigned channels;
452         unsigned bits_per_sample;
453         FLAC__uint64 total_samples;
454         FLAC__byte md5sum[16];
455 } FLAC__StreamMetadata_StreamInfo;
456
457 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN; /**< == 16 (bits) */
458 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN; /**< == 16 (bits) */
459 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN; /**< == 24 (bits) */
460 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN; /**< == 24 (bits) */
461 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN; /**< == 20 (bits) */
462 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN; /**< == 3 (bits) */
463 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN; /**< == 5 (bits) */
464 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN; /**< == 36 (bits) */
465 extern const unsigned FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN; /**< == 128 (bits) */
466
467 #define FLAC__STREAM_METADATA_STREAMINFO_LENGTH (34u)
468
469 /*****************************************************************************
470  *
471  *   n: '0' bits
472  *----- -----------------
473  * n/8  bytes total
474  */
475 typedef struct {
476         int dummy; /* conceptually this is an empty struct since we don't store the padding bytes */
477                    /* empty structs are allowed by C++ but not C, hence the 'dummy' */
478 } FLAC__StreamMetadata_Padding;
479
480 /*****************************************************************************
481  *
482  *    32: Registered application ID
483  *     n: Application data
484  *------- -----------------
485  * 4+n/8  bytes total
486  */
487 typedef struct {
488         FLAC__byte id[4];
489         FLAC__byte *data;
490 } FLAC__StreamMetadata_Application;
491
492 extern const unsigned FLAC__STREAM_METADATA_APPLICATION_ID_LEN; /**< == 32 (bits) */
493
494 /*****************************************************************************
495  *
496  *  64: sample number of target frame
497  *  64: offset, in bytes, of target frame with respect to beginning of first frame
498  *  16: number of samples in the target frame
499  *----- -----------------
500  *  18  bytes total
501  */
502 typedef struct {
503         FLAC__uint64 sample_number;
504         FLAC__uint64 stream_offset;
505         unsigned frame_samples;
506 } FLAC__StreamMetadata_SeekPoint;
507
508 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN; /**< == 64 (bits) */
509 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN; /**< == 64 (bits) */
510 extern const unsigned FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN; /**< == 16 (bits) */
511
512 #define FLAC__STREAM_METADATA_SEEKPOINT_LENGTH (18u)
513
514 extern const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER; /* = 0xffffffffffffffff */
515
516 /*****************************************************************************
517  *
518  *      0: num_points is implied by the metadata block 'length' field (i.e. num_points = length / 18)
519  * n*18*8: seek points (n = num_points, 18 is the size of a seek point in bytes)
520  * ------- -----------------
521  *   n*18  bytes total
522  *
523  * NOTE: the seek points must be sorted by ascending sample number.
524  * NOTE: each seek point's sample number must be the first sample of the target frame.
525  * NOTE: each seek point's sample number must be unique within the table.
526  * NOTE: existence of a SEEKTABLE block implies a correct setting of total_samples in the stream_info block.
527  * NOTE: behavior is undefined when more than one SEEKTABLE block is present in a stream.
528  */
529 typedef struct {
530         unsigned num_points;
531         FLAC__StreamMetadata_SeekPoint *points;
532 } FLAC__StreamMetadata_SeekTable;
533
534 /*****************************************************************************
535  *
536  *     32: Entry length in bytes (WATCHOUT: this is little-endian coded)
537  *      n: Entry (n = 8 * length)
538  *-------- -----------------
539  * 32+n/8  bytes total
540  */
541 typedef struct {
542         FLAC__uint32 length;
543         FLAC__byte *entry;
544 } FLAC__StreamMetadata_VorbisComment_Entry;
545
546 extern const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN; /**< == 32 (bits) */
547
548 /*****************************************************************************
549  *
550  *          n: Vendor string entry
551  *         32: Number of comment fields (WATCHOUT: this is little-endian coded)
552  *          m: Comment entries
553  *------------ -----------------
554  * (32+m+n)/8  bytes total
555  */
556 typedef struct {
557         FLAC__StreamMetadata_VorbisComment_Entry vendor_string;
558         FLAC__uint32 num_comments;
559         FLAC__StreamMetadata_VorbisComment_Entry *comments;
560 } FLAC__StreamMetadata_VorbisComment;
561
562 extern const unsigned FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN; /**< == 32 (bits) */
563
564 /*****************************************************************************
565  *
566  *  1: =1 if this is the last meta-data block, else =0
567  *  7: meta-data type (c.f. FLAC__MetadataType)
568  * 24: length (in bytes) of the block-specific data to follow
569  *---- -----------------
570  *  4  bytes total
571  */
572 typedef struct {
573         FLAC__MetadataType type;
574         FLAC__bool is_last;
575         unsigned length; /* in bytes */
576         union {
577                 FLAC__StreamMetadata_StreamInfo stream_info;
578                 FLAC__StreamMetadata_Padding padding;
579                 FLAC__StreamMetadata_Application application;
580                 FLAC__StreamMetadata_SeekTable seek_table;
581                 FLAC__StreamMetadata_VorbisComment vorbis_comment;
582         } data;
583 } FLAC__StreamMetadata;
584
585 extern const unsigned FLAC__STREAM_METADATA_IS_LAST_LEN; /**< == 1 (bit) */
586 extern const unsigned FLAC__STREAM_METADATA_TYPE_LEN; /**< == 7 (bits) */
587 extern const unsigned FLAC__STREAM_METADATA_LENGTH_LEN; /**< == 24 (bits) */
588
589 #define FLAC__STREAM_METADATA_HEADER_LENGTH (4u)
590
591 /*****************************************************************************/
592
593
594 /*****************************************************************************
595  *
596  * Utility functions
597  *
598  *****************************************************************************/
599
600 /*
601  * Since the rules for valid sample rates are slightly complex, they are
602  * encapsulated here:
603  */
604 FLAC__bool FLAC__format_is_valid_sample_rate(unsigned sample_rate);
605
606 /* \} */
607
608 #ifdef __cplusplus
609 }
610 #endif
611
612 #endif
613 #if 0
614
615
616 /** \defgroup flac_metadata_level0 FLAC/metadata.h: metadata level 0 interface
617  *  \ingroup flac_metadata
618  * 
619  *  \brief
620  *  The level 0 interface consists of a single routine to read the
621  *  STREAMINFO block.
622  *
623  *  It skips any ID3v2 tag at the head of the file.
624  *
625  * \{
626  */
627
628 /** Read the STREAMINFO metadata block of the given FLAC file.  This function
629  *  will skip any ID3v2 tag at the head of the file.
630  *
631  * \param filename    The path to the FLAC file to read.
632  * \param streaminfo  A pointer to space for the STREAMINFO block.
633  * \assert
634  *    \code filename != NULL \endcode
635  *    \code streaminfo != NULL \endcode
636  * \retval FLAC__bool
637  *    \c true if a valid STREAMINFO block was read from \a filename.  Returns
638  *    \c false if there was a memory allocation error, a file decoder error,
639  *    or the file contained no STREAMINFO block.
640  */
641 FLAC__bool FLAC__metadata_get_streaminfo(const char *filename, FLAC__StreamMetadata *streaminfo);
642
643 /* \} */
644
645
646 /** \defgroup flac_metadata_level1 FLAC/metadata.h: metadata level 1 interface
647  *  \ingroup flac_metadata
648  * 
649  * \brief
650  * The level 1 interface provides read-write access to FLAC file metadata and
651  * operates directly on the FLAC file.
652  *
653  * The general usage of this interface is:
654  *
655  * - Create an iterator using FLAC__metadata_simple_iterator_new()
656  * - Attach it to a file using FLAC__metadata_simple_iterator_init() and check
657  *   the exit code.  Call FLAC__metadata_simple_iterator_is_writable() to
658  *   see if the file is writable, or read-only access is allowed.
659  * - Use FLAC__metadata_simple_iterator_next() and
660  *   FLAC__metadata_simple_iterator_prev() to move around the blocks.
661  *   This is does not read the actual blocks themselves.
662  *   FLAC__metadata_simple_iterator_next() is relatively fast.
663  *   FLAC__metadata_simple_iterator_prev() is slower since it needs to search
664  *   forward from the front of the file.
665  * - Use FLAC__metadata_simple_iterator_get_block_type() or
666  *   FLAC__metadata_simple_iterator_get_block() to access the actual data at
667  *   the current iterator position.  The returned object is yours to modify
668  *   and free.
669  * - Use FLAC__metadata_simple_iterator_set_block() to write a modified block
670  *   back.  You must have write permission to the original file.  Make sure to
671  *   read the whole comment to FLAC__metadata_simple_iterator_set_block()
672  *   below.
673  * - Use FLAC__metadata_simple_iterator_insert_block_after() to add new blocks.
674  *   Use the object creation functions from
675  *   \link flac_metadata_object here \endlink to generate new objects.
676  * - Use FLAC__metadata_simple_iterator_delete_block() to remove the block
677  *   currently referred to by the iterator, or replace it with padding.
678  * - Destroy the iterator with FLAC__metadata_simple_iterator_delete() when
679  *   finished.
680  *
681  * \note
682  * The FLAC file remains open the whole time between
683  * FLAC__metadata_simple_iterator_init() and
684  * FLAC__metadata_simple_iterator_delete(), so make sure you are not altering
685  * the file during this time.
686  *
687  * \note
688  * Do not modify the \a is_last, \a length, or \a type fields of returned
689  * FLAC__MetadataType objects.  These are managed automatically.
690  *
691  * \note
692  * If any of the modification functions
693  * (FLAC__metadata_simple_iterator_set_block(),
694  * FLAC__metadata_simple_iterator_delete_block(),
695  * FLAC__metadata_simple_iterator_insert_block_after(), etc.) return \c false,
696  * you should delete the iterator as it may no longer be valid.
697  *
698  * \{
699  */
700
701 /** \typedef FLAC__Metadata_SimpleIterator
702  *  The opaque structure definition for the level 1 iterator type.
703  */
704 struct FLAC__Metadata_SimpleIterator;
705 typedef struct FLAC__Metadata_SimpleIterator FLAC__Metadata_SimpleIterator;
706
707 /** Status type for FLAC__Metadata_SimpleIterator.
708  *
709  *  The iterator's current status can be obtained by calling FLAC__metadata_simple_iterator_status().
710  */
711 typedef enum {
712
713         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK = 0,
714         /**< The iterator is in the normal OK state */
715
716         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT,
717         /**< The data passed into a function violated the function's usage criteria */
718
719         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE,
720         /**< The iterator could not open the target file */
721
722         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE,
723         /**< The iterator could not find the FLAC signature at the start of the file */
724
725         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE,
726         /**< The iterator tried to write to a file that was not writable */
727
728         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA,
729         /**< The iterator encountered input that does not conform to the FLAC metadata specification */
730
731         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR,
732         /**< The iterator encountered an error while reading the FLAC file */
733
734         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR,
735         /**< The iterator encountered an error while seeking in the FLAC file */
736
737         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR,
738         /**< The iterator encountered an error while writing the FLAC file */
739
740         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR,
741         /**< The iterator encountered an error renaming the FLAC file */
742
743         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR,
744         /**< The iterator encountered an error removing the temporary file */
745
746         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR,
747         /**< Memory allocation failed */
748
749         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR
750         /**< The caller violated an assertion or an unexpected error occurred */
751
752 } FLAC__Metadata_SimpleIteratorStatus;
753
754 /** Maps a FLAC__Metadata_SimpleIteratorStatus to a C string.
755  *
756  *  Using a FLAC__Metadata_SimpleIteratorStatus as the index to this array
757  *  will give the string equivalent.  The contents should not be modified.
758  */
759 extern const char * const FLAC__Metadata_SimpleIteratorStatusString[];
760
761
762 /** Create a new iterator instance.
763  *
764  * \retval FLAC__Metadata_SimpleIterator*
765  *    \c NULL if there was an error allocating memory, else the new instance.
766  */
767 FLAC__Metadata_SimpleIterator *FLAC__metadata_simple_iterator_new();
768
769 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
770  *
771  * \param iterator  A pointer to an existing iterator.
772  * \assert
773  *    \code iterator != NULL \endcode
774  */
775 void FLAC__metadata_simple_iterator_delete(FLAC__Metadata_SimpleIterator *iterator);
776
777 /** Get the current status of the iterator.  Call this after a function
778  *  returns \c false to get the reason for the error.  Also resets the status
779  *  to FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK.
780  *
781  * \param iterator  A pointer to an existing iterator.
782  * \assert
783  *    \code iterator != NULL \endcode
784  * \retval FLAC__Metadata_SimpleIteratorStatus
785  *    The current status of the iterator.
786  */
787 FLAC__Metadata_SimpleIteratorStatus FLAC__metadata_simple_iterator_status(FLAC__Metadata_SimpleIterator *iterator);
788
789 /** Initialize the iterator to point to the first metadata block in the
790  *  given FLAC file.  If \a preserve_file_stats is \c true, the owner and
791  *  modification time will be preserved even if the FLAC file is written.
792  *
793  * \param iterator             A pointer to an existing iterator.
794  * \param filename             The path to the FLAC file.
795  * \param preserve_file_stats  See above.
796  * \assert
797  *    \code iterator != NULL \endcode
798  *    \code filename != NULL \endcode
799  * \retval FLAC__bool
800  *    \c false if a memory allocation error occurs, the file can't be
801  *    opened, or another error occurs, else \c true.
802  */
803 FLAC__bool FLAC__metadata_simple_iterator_init(FLAC__Metadata_SimpleIterator *iterator, const char *filename, FLAC__bool preserve_file_stats);
804
805 /** Returns \c true if the FLAC file is writable.  If \c false, calls to
806  *  FLAC__metadata_simple_iterator_set_block() and
807  *  FLAC__metadata_simple_iterator_insert_block_after() will fail.
808  *
809  * \param iterator             A pointer to an existing iterator.
810  * \assert
811  *    \code iterator != NULL \endcode
812  * \retval FLAC__bool
813  *    See above.
814  */
815 FLAC__bool FLAC__metadata_simple_iterator_is_writable(const FLAC__Metadata_SimpleIterator *iterator);
816
817 /** Moves the iterator forward one metadata block, returning \c false if
818  *  already at the end.
819  *
820  * \param iterator  A pointer to an existing initialized iterator.
821  * \assert
822  *    \code iterator != NULL \endcode
823  *    \a iterator has been successfully initialized with
824  *    FLAC__metadata_simple_iterator_init()
825  * \retval FLAC__bool
826  *    \c false if already at the last metadata block of the chain, else
827  *    \c true.
828  */
829 FLAC__bool FLAC__metadata_simple_iterator_next(FLAC__Metadata_SimpleIterator *iterator);
830
831 /** Moves the iterator backward one metadata block, returning \c false if
832  *  already at the beginning.
833  *
834  * \param iterator  A pointer to an existing initialized iterator.
835  * \assert
836  *    \code iterator != NULL \endcode
837  *    \a iterator has been successfully initialized with
838  *    FLAC__metadata_simple_iterator_init()
839  * \retval FLAC__bool
840  *    \c false if already at the first metadata block of the chain, else
841  *    \c true.
842  */
843 FLAC__bool FLAC__metadata_simple_iterator_prev(FLAC__Metadata_SimpleIterator *iterator);
844
845 /** Get the type of the metadata block at the current position.  This
846  *  avoids reading the actual block data which can save time for large
847  *  blocks.
848  *
849  * \param iterator  A pointer to an existing initialized iterator.
850  * \assert
851  *    \code iterator != NULL \endcode
852  *    \a iterator has been successfully initialized with
853  *    FLAC__metadata_simple_iterator_init()
854  * \retval FLAC__MetadataType
855  *    The type of the metadata block at the current iterator position.
856  */
857
858 FLAC__MetadataType FLAC__metadata_simple_iterator_get_block_type(const FLAC__Metadata_SimpleIterator *iterator);
859
860 /** Get the metadata block at the current position.  You can modify the
861  *  block but must use FLAC__metadata_simple_iterator_set_block() to
862  *  write it back to the FLAC file.
863  *
864  *  You must call FLAC__metadata_object_delete() on the returned object
865  *  when you are finished with it.
866  *
867  * \param iterator  A pointer to an existing initialized iterator.
868  * \assert
869  *    \code iterator != NULL \endcode
870  *    \a iterator has been successfully initialized with
871  *    FLAC__metadata_simple_iterator_init()
872  * \retval FLAC__StreamMetadata*
873  *    The current metadata block.
874  */
875 FLAC__StreamMetadata *FLAC__metadata_simple_iterator_get_block(FLAC__Metadata_SimpleIterator *iterator);
876
877 /** Write a block back to the FLAC file.  This function tries to be
878  *  as efficient as possible; how the block is actually written is
879  *  shown by the following:
880  *
881  *  Existing block is a STREAMINFO block and the new block is a
882  *  STREAMINFO block: the new block is written in place.  Make sure
883  *  you know what you're doing when changing the values of a
884  *  STREAMINFO block.
885  *
886  *  Existing block is a STREAMINFO block and the new block is a
887  *  not a STREAMINFO block: this is an error since the first block
888  *  must be a STREAMINFO block.  Returns \c false without altering the
889  *  file.
890  *
891  *  Existing block is not a STREAMINFO block and the new block is a
892  *  STREAMINFO block: this is an error since there may be only one
893  *  STREAMINFO block.  Returns \c false without altering the file.
894  *
895  *  Existing block and new block are the same length: the existing
896  *  block will be replaced by the new block, written in place.
897  *
898  *  Existing block is longer than new block: if use_padding is \c true,
899  *  the existing block will be overwritten in place with the new
900  *  block followed by a PADDING block, if possible, to make the total
901  *  size the same as the existing block.  Remember that a padding
902  *  block requires at least four bytes so if the difference in size
903  *  between the new block and existing block is less than that, the
904  *  entire file will have to be rewritten, using the new block's
905  *  exact size.  If use_padding is \c false, the entire file will be
906  *  rewritten, replacing the existing block by the new block.
907  *
908  *  Existing block is shorter than new block: if use_padding is \c true,
909  *  the function will try and expand the new block into the following
910  *  PADDING block, if it exists and doing so won't shrink the PADDING
911  *  block to less than 4 bytes.  If there is no following PADDING
912  *  block, or it will shrink to less than 4 bytes, or use_padding is
913  *  \c false, the entire file is rewritten, replacing the existing block
914  *  with the new block.  Note that in this case any following PADDING
915  *  block is preserved as is.
916  *
917  *  After writing the block, the iterator will remain in the same
918  *  place, i.e. pointing to the new block.
919  *
920  * \param iterator     A pointer to an existing initialized iterator.
921  * \param block        The block to set.
922  * \param use_padding  See above.
923  * \assert
924  *    \code iterator != NULL \endcode
925  *    \a iterator has been successfully initialized with
926  *    FLAC__metadata_simple_iterator_init()
927  *    \code block != NULL \endcode
928  * \retval FLAC__bool
929  *    \c true if successful, else \c false.
930  */
931 FLAC__bool FLAC__metadata_simple_iterator_set_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
932
933 /** This is similar to FLAC__metadata_simple_iterator_set_block()
934  *  except that instead of writing over an existing block, it appends
935  *  a block after the existing block.  \a use_padding is again used to
936  *  tell the function to try an expand into following padding in an
937  *  attempt to avoid rewriting the entire file.
938  *
939  *  This function will fail and return \c false if given a STREAMINFO
940  *  block.
941  *
942  *  After writing the block, the iterator will be pointing to the
943  *  new block.
944  *
945  * \param iterator     A pointer to an existing initialized iterator.
946  * \param block        The block to set.
947  * \param use_padding  See above.
948  * \assert
949  *    \code iterator != NULL \endcode
950  *    \a iterator has been successfully initialized with
951  *    FLAC__metadata_simple_iterator_init()
952  *    \code block != NULL \endcode
953  * \retval FLAC__bool
954  *    \c true if successful, else \c false.
955  */
956 FLAC__bool FLAC__metadata_simple_iterator_insert_block_after(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
957
958 /** Deletes the block at the current position.  This will cause the
959  *  entire FLAC file to be rewritten, unless \a use_padding is \c true,
960  *  in which case the block will be replaced by an equal-sized PADDING
961  *  block.  The iterator will be left pointing to the block before the
962  *  one just deleted.
963  *
964  *  You may not delete the STREAMINFO block.
965  *
966  * \param iterator     A pointer to an existing initialized iterator.
967  * \param use_padding  See above.
968  * \assert
969  *    \code iterator != NULL \endcode
970  *    \a iterator has been successfully initialized with
971  *    FLAC__metadata_simple_iterator_init()
972  * \retval FLAC__bool
973  *    \c true if successful, else \c false.
974  */
975 FLAC__bool FLAC__metadata_simple_iterator_delete_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__bool use_padding);
976
977 /* \} */
978
979
980 /** \defgroup flac_metadata_level2 FLAC/metadata.h: metadata level 2 interface
981  *  \ingroup flac_metadata
982  * 
983  * \brief
984  * The level 2 interface provides read-write access to FLAC file metadata;
985  * all metadata is read into memory, operated on in memory, and then written
986  * to file, which is more efficient than level 1 when editing multiple blocks.
987  *
988  * The general usage of this interface is:
989  *
990  * - Create a new chain using FLAC__metadata_chain_new().  A chain is a
991  *   linked list of FLAC metadata blocks.
992  * - Read all metadata into the the chain from a FLAC file using
993  *   FLAC__metadata_chain_read() and check the status.
994  * - Optionally, consolidate the padding using
995  *   FLAC__metadata_chain_merge_padding() or
996  *   FLAC__metadata_chain_sort_padding().
997  * - Create a new iterator using FLAC__metadata_iterator_new()
998  * - Initialize the iterator to point to the first element in the chain
999  *   using FLAC__metadata_iterator_init()
1000  * - Traverse the chain using FLAC__metadata_iterator_next and
1001  *   FLAC__metadata_iterator_prev().
1002  * - Get a block for reading or modification using
1003  *   FLAC__metadata_iterator_get_block().  The pointer to the object
1004  *   inside the chain is returned, so the block is yours to modify.
1005  *   Changes will be reflected in the FLAC file when you write the
1006  *   chain.  You can also add and delete blocks (see functions below).
1007  * - When done, write out the chain using FLAC__metadata_chain_write().
1008  *   Make sure to read the whole comment to the function below.
1009  * - Delete the chain using FLAC__metadata_chain_delete().
1010  *
1011  * \note
1012  * Even though the FLAC file is not open while the chain is being
1013  * manipulated, you must not alter the file externally during
1014  * this time.  The chain assumes the FLAC file will not change
1015  * between the time of FLAC__metadata_chain_read() and
1016  * FLAC__metadata_chain_write().
1017  *
1018  * \note
1019  * Do not modify the is_last, length, or type fields of returned
1020  * FLAC__MetadataType objects.  These are managed automatically.
1021  *
1022  * \note
1023  * The metadata objects returned by FLAC__metadata_iterator_get_block()
1024  * are owned by the chain; do not FLAC__metadata_object_delete() them.
1025  * In the same way, blocks passed to FLAC__metadata_iterator_set_block()
1026  * become owned by the chain and they will be deleted when the chain is
1027  * deleted.
1028  *
1029  * \{
1030  */
1031
1032 /** \typedef FLAC__Metadata_Chain
1033  *  The opaque structure definition for the level 2 chain type.
1034  */
1035 struct FLAC__Metadata_Chain;
1036 typedef struct FLAC__Metadata_Chain FLAC__Metadata_Chain;
1037
1038 /** \typedef FLAC__Metadata_Iterator
1039  *  The opaque structure definition for the level 2 iterator type.
1040  */
1041 struct FLAC__Metadata_Iterator;
1042 typedef struct FLAC__Metadata_Iterator FLAC__Metadata_Iterator;
1043
1044 typedef enum {
1045         FLAC__METADATA_CHAIN_STATUS_OK = 0,
1046         /**< The chain is in the normal OK state */
1047
1048         FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT,
1049         /**< The data passed into a function violated the function's usage criteria */
1050
1051         FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE,
1052         /**< The chain could not open the target file */
1053
1054         FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE,
1055         /**< The chain could not find the FLAC signature at the start of the file */
1056
1057         FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE,
1058         /**< The chain tried to write to a file that was not writable */
1059
1060         FLAC__METADATA_CHAIN_STATUS_BAD_METADATA,
1061         /**< The chain encountered input that does not conform to the FLAC metadata specification */
1062
1063         FLAC__METADATA_CHAIN_STATUS_READ_ERROR,
1064         /**< The chain encountered an error while reading the FLAC file */
1065
1066         FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR,
1067         /**< The chain encountered an error while seeking in the FLAC file */
1068
1069         FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR,
1070         /**< The chain encountered an error while writing the FLAC file */
1071
1072         FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR,
1073         /**< The chain encountered an error renaming the FLAC file */
1074
1075         FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR,
1076         /**< The chain encountered an error removing the temporary file */
1077
1078         FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR,
1079         /**< Memory allocation failed */
1080
1081         FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR
1082         /**< The caller violated an assertion or an unexpected error occurred */
1083
1084 } FLAC__Metadata_ChainStatus;
1085
1086 /** Maps a FLAC__Metadata_ChainStatus to a C string.
1087  *
1088  *  Using a FLAC__Metadata_ChainStatus as the index to this array
1089  *  will give the string equivalent.  The contents should not be modified.
1090  */
1091 extern const char * const FLAC__Metadata_ChainStatusString[];
1092
1093 /*********** FLAC__Metadata_Chain ***********/
1094
1095 /** Create a new chain instance.
1096  *
1097  * \retval FLAC__Metadata_Chain*
1098  *    \c NULL if there was an error allocating memory, else the new instance.
1099  */
1100 FLAC__Metadata_Chain *FLAC__metadata_chain_new();
1101
1102 /** Free a chain instance.  Deletes the object pointed to by \a chain.
1103  *
1104  * \param chain  A pointer to an existing chain.
1105  * \assert
1106  *    \code chain != NULL \endcode
1107  */
1108 void FLAC__metadata_chain_delete(FLAC__Metadata_Chain *chain);
1109
1110 /** Get the current status of the chain.  Call this after a function
1111  *  returns \c false to get the reason for the error.  Also resets the
1112  *  status to FLAC__METADATA_CHAIN_STATUS_OK.
1113  *
1114  * \param chain    A pointer to an existing chain.
1115  * \assert
1116  *    \code chain != NULL \endcode
1117  * \retval FLAC__Metadata_ChainStatus
1118  *    The current status of the chain.
1119  */
1120 FLAC__Metadata_ChainStatus FLAC__metadata_chain_status(FLAC__Metadata_Chain *chain);
1121
1122 /** Read all metadata from a FLAC file into the chain.
1123  *
1124  * \param chain    A pointer to an existing chain.
1125  * \param filename The path to the FLAC file to read.
1126  * \assert
1127  *    \code chain != NULL \endcode
1128  *    \code filename != NULL \endcode
1129  * \retval FLAC__bool
1130  *    \c true if a valid list of metadata blocks was read from
1131  *    \a filename, else \c false.  On failure, check the status with
1132  *    FLAC__metadata_chain_status().
1133  */
1134 FLAC__bool FLAC__metadata_chain_read(FLAC__Metadata_Chain *chain, const char *filename);
1135
1136 /** Write all metadata out to the FLAC file.  This function tries to be as
1137  *  efficient as possible; how the metadata is actually written is shown by
1138  *  the following:
1139  *
1140  *  If the current chain is the same size as the existing metadata, the new
1141  *  data is written in place.
1142  *
1143  *  If the current chain is longer than the existing metadata, and
1144  *  \a use_padding is \c true, and the last block is a PADDING block of
1145  *  sufficient length, the function will truncate the final padding block
1146  *  so that the overall size of the metadata is the same as the existing
1147  *  metadata, and then just rewrite the metadata.  Otherwise, if not all of
1148  *  the above conditions are met, the entire FLAC file must be rewritten.
1149  *  If you want to use padding this way it is a good idea to call
1150  *  FLAC__metadata_chain_sort_padding() first so that you have the maximum
1151  *  amount of padding to work with, unless you need to preserve ordering
1152  *  of the PADDING blocks for some reason.
1153  *
1154  *  If the current chain is shorter than the existing metadata, and
1155  *  \a use_padding is \c true, and the final block is a PADDING block, the padding
1156  *  is extended to make the overall size the same as the existing data.  If
1157  *  \a use_padding is \c true and the last block is not a PADDING block, a new
1158  *  PADDING block is added to the end of the new data to make it the same
1159  *  size as the existing data (if possible, see the note to
1160  *  FLAC__metadata_simple_iterator_set_block() about the four byte limit)
1161  *  and the new data is written in place.  If none of the above apply or
1162  *  \a use_padding is \c false, the entire FLAC file is rewritten.
1163  *
1164  *  If \a preserve_file_stats is \c true, the owner and modification time will
1165  *  be preserved even if the FLAC file is written.
1166  *
1167  * \param chain               A pointer to an existing chain.
1168  * \param use_padding         See above.
1169  * \param preserve_file_stats See above.
1170  * \assert
1171  *    \code chain != NULL \endcode
1172  * \retval FLAC__bool
1173  *    \c true if the write succeeded, else \c false.  On failure,
1174  *    check the status with FLAC__metadata_chain_status().
1175  */
1176 FLAC__bool FLAC__metadata_chain_write(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__bool preserve_file_stats);
1177
1178 /** Merge adjacent PADDING blocks into a single block.
1179  *
1180  * \note This function does not write to the FLAC file, it only
1181  * modifies the chain.
1182  *
1183  * \warning Any iterator on the current chain will become invalid after this
1184  * call.  You should delete the iterator and get a new one.
1185  *
1186  * \param chain               A pointer to an existing chain.
1187  * \assert
1188  *    \code chain != NULL \endcode
1189  */
1190 void FLAC__metadata_chain_merge_padding(FLAC__Metadata_Chain *chain);
1191
1192 /** This function will move all PADDING blocks to the end on the metadata,
1193  *  then merge them into a single block.
1194  *
1195  * \note This function does not write to the FLAC file, it only
1196  * modifies the chain.
1197  *
1198  * \warning Any iterator on the current chain will become invalid after this
1199  * call.  You should delete the iterator and get a new one.
1200  *
1201  * \param chain  A pointer to an existing chain.
1202  * \assert
1203  *    \code chain != NULL \endcode
1204  */
1205 void FLAC__metadata_chain_sort_padding(FLAC__Metadata_Chain *chain);
1206
1207
1208 /*********** FLAC__Metadata_Iterator ***********/
1209
1210 /** Create a new iterator instance.
1211  *
1212  * \retval FLAC__Metadata_Iterator*
1213  *    \c NULL if there was an error allocating memory, else the new instance.
1214  */
1215 FLAC__Metadata_Iterator *FLAC__metadata_iterator_new();
1216
1217 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
1218  *
1219  * \param iterator  A pointer to an existing iterator.
1220  * \assert
1221  *    \code iterator != NULL \endcode
1222  */
1223 void FLAC__metadata_iterator_delete(FLAC__Metadata_Iterator *iterator);
1224
1225 /** Initialize the iterator to point to the first metadata block in the
1226  *  given chain.
1227  *
1228  * \param iterator  A pointer to an existing iterator.
1229  * \param chain     A pointer to an existing and initialized (read) chain.
1230  * \assert
1231  *    \code iterator != NULL \endcode
1232  *    \code chain != NULL \endcode
1233  */
1234 void FLAC__metadata_iterator_init(FLAC__Metadata_Iterator *iterator, FLAC__Metadata_Chain *chain);
1235
1236 /** Moves the iterator forward one metadata block, returning \c false if
1237  *  already at the end.
1238  *
1239  * \param iterator  A pointer to an existing initialized iterator.
1240  * \assert
1241  *    \code iterator != NULL \endcode
1242  *    \a iterator has been successfully initialized with
1243  *    FLAC__metadata_iterator_init()
1244  * \retval FLAC__bool
1245  *    \c false if already at the last metadata block of the chain, else
1246  *    \c true.
1247  */
1248 FLAC__bool FLAC__metadata_iterator_next(FLAC__Metadata_Iterator *iterator);
1249
1250 /** Moves the iterator backward one metadata block, returning \c false if
1251  *  already at the beginning.
1252  *
1253  * \param iterator  A pointer to an existing initialized iterator.
1254  * \assert
1255  *    \code iterator != NULL \endcode
1256  *    \a iterator has been successfully initialized with
1257  *    FLAC__metadata_iterator_init()
1258  * \retval FLAC__bool
1259  *    \c false if already at the first metadata block of the chain, else
1260  *    \c true.
1261  */
1262 FLAC__bool FLAC__metadata_iterator_prev(FLAC__Metadata_Iterator *iterator);
1263
1264 /** Get the type of the metadata block at the current position.
1265  *
1266  * \param iterator  A pointer to an existing initialized iterator.
1267  * \assert
1268  *    \code iterator != NULL \endcode
1269  *    \a iterator has been successfully initialized with
1270  *    FLAC__metadata_iterator_init()
1271  * \retval FLAC__MetadataType
1272  *    The type of the metadata block at the current iterator position.
1273  */
1274 FLAC__MetadataType FLAC__metadata_iterator_get_block_type(const FLAC__Metadata_Iterator *iterator);
1275
1276 /** Get the metadata block at the current position.  You can modify
1277  *  the block in place but must write the chain before the changes
1278  *  are reflected to the FLAC file.  You do not need to call
1279  *  FLAC__metadata_iterator_set_block() to reflect the changes;
1280  *  the pointer returned by FLAC__metadata_iterator_get_block()
1281  *  points directly into the chain.
1282  *
1283  * \warning
1284  * Do not call FLAC__metadata_object_delete() on the returned object;
1285  * to delete a block use FLAC__metadata_iterator_delete_block().
1286  *
1287  * \param iterator  A pointer to an existing initialized iterator.
1288  * \assert
1289  *    \code iterator != NULL \endcode
1290  *    \a iterator has been successfully initialized with
1291  *    FLAC__metadata_iterator_init()
1292  * \retval FLAC__StreamMetadata*
1293  *    The current metadata block.
1294  */
1295 FLAC__StreamMetadata *FLAC__metadata_iterator_get_block(FLAC__Metadata_Iterator *iterator);
1296
1297 /** Set the metadata block at the current position, replacing the existing
1298  *  block.  The new block passed in becomes owned by the chain and it will be
1299  *  deleted when the chain is deleted.
1300  *
1301  * \param iterator  A pointer to an existing initialized iterator.
1302  * \param block     A pointer to a metadata block.
1303  * \assert
1304  *    \code iterator != NULL \endcode
1305  *    \a iterator has been successfully initialized with
1306  *    FLAC__metadata_iterator_init()
1307  *    \code block != NULL \endcode
1308  * \retval FLAC__bool
1309  *    \c false if the conditions in the above description are not met, or
1310  *    a memory allocation error occurs, otherwise \c true.
1311  */
1312 FLAC__bool FLAC__metadata_iterator_set_block(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
1313
1314 /** Removes the current block from the chain.  If \a replace_with_padding is
1315  *  \c true, the block will instead be replaced with a padding block of equal
1316  *  size.  You can not delete the STREAMINFO block.  The iterator will be
1317  *  left pointing to the block before the one just "deleted", even if
1318  *  \a replace_with_padding is \c true.
1319  *
1320  * \param iterator              A pointer to an existing initialized iterator.
1321  * \param replace_with_padding  See above.
1322  * \assert
1323  *    \code iterator != NULL \endcode
1324  *    \a iterator has been successfully initialized with
1325  *    FLAC__metadata_iterator_init()
1326  * \retval FLAC__bool
1327  *    \c false if the conditions in the above description are not met,
1328  *    otherwise \c true.
1329  */
1330 FLAC__bool FLAC__metadata_iterator_delete_block(FLAC__Metadata_Iterator *iterator, FLAC__bool replace_with_padding);
1331
1332 /** Insert a new block before the current block.  You cannot insert a block
1333  *  before the first STREAMINFO block.  You cannot insert a STREAMINFO block
1334  *  as there can be only one, the one that already exists at the head when you
1335  *  read in a chain.  The chain takes ownership of the new block and it will be
1336  *  deleted when the chain is deleted.  The iterator will be left pointing to
1337  *  the new block.
1338  *
1339  * \param iterator  A pointer to an existing initialized iterator.
1340  * \param block     A pointer to a metadata block to insert.
1341  * \assert
1342  *    \code iterator != NULL \endcode
1343  *    \a iterator has been successfully initialized with
1344  *    FLAC__metadata_iterator_init()
1345  * \retval FLAC__bool
1346  *    \c false if the conditions in the above description are not met, or
1347  *    a memory allocation error occurs, otherwise \c true.
1348  */
1349 FLAC__bool FLAC__metadata_iterator_insert_block_before(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
1350
1351 /** Insert a new block after the current block.  You cannot insert a STREAMINFO
1352  *  block as there can be only one, the one that already exists at the head when
1353  *  you read in a chain.  The chain takes ownership of the new block and it will
1354  *  be deleted when the chain is deleted.  The iterator will be left pointing to
1355  *  the new block.
1356  *
1357  * \param iterator  A pointer to an existing initialized iterator.
1358  * \param block     A pointer to a metadata block to insert.
1359  * \assert
1360  *    \code iterator != NULL \endcode
1361  *    \a iterator has been successfully initialized with
1362  *    FLAC__metadata_iterator_init()
1363  * \retval FLAC__bool
1364  *    \c false if the conditions in the above description are not met, or
1365  *    a memory allocation error occurs, otherwise \c true.
1366  */
1367 FLAC__bool FLAC__metadata_iterator_insert_block_after(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
1368
1369 /* \} */
1370
1371
1372 /** \defgroup flac_metadata_object FLAC/metadata.h: metadata object methods
1373  *  \ingroup flac_metadata
1374  *
1375  * \brief
1376  * This module contains methods for manipulating FLAC metadata objects.
1377  *
1378  * Since many are variable length we have to be careful about the memory
1379  * management.  We decree that all pointers to data in the object are
1380  * owned by the object and memory-managed by the object.
1381  *
1382  * Use the FLAC__metadata_object_new() and FLAC__metadata_object_delete()
1383  * functions to create all instances.  When using the
1384  * FLAC__metadata_object_set_*() functions to set pointers to data, set
1385  * \a copy to \c true to have the function make it's own copy of the data, or
1386  * to \c false to give the object ownership of your data.  In the latter case
1387  * your pointer must be freeable by free() and will be free()d when the object
1388  * is FLAC__metadata_object_delete()d.  It is legal to pass a null pointer as
1389  * the data pointer to a FLAC__metadata_object_set_*() function as long as
1390  * the length argument is 0 and the \a copy argument is \c false.
1391  *
1392  * The FLAC__metadata_object_new() and FLAC__metadata_object_clone() function
1393  * will return \c NULL in the case of a memory allocation error, otherwise a new
1394  * object.  The FLAC__metadata_object_set_*() functions return \c false in the
1395  * case of a memory allocation error.
1396  *
1397  * We don't have the convenience of C++ here, so note that the library relies
1398  * on you to keep the types straight.  In other words, if you pass, for
1399  * example, a FLAC__StreamMetadata* that represents a STREAMINFO block to
1400  * FLAC__metadata_object_application_set_data(), you will get an assertion
1401  * failure.
1402  *
1403  * There is no need to recalculate the length field on metadata blocks you
1404  * have modified.  They will be calculated automatically before they  are
1405  * written back to a file.
1406  *
1407  * \{
1408  */
1409
1410
1411 /** Create a new metadata object instance of the given type.
1412  *
1413  *  The object will be "empty"; i.e. values and data pointers will be \c 0.
1414  *
1415  * \param type  Type of object to create
1416  * \retval FLAC__StreamMetadata*
1417  *    \c NULL if there was an error allocating memory, else the new instance.
1418  */
1419 FLAC__StreamMetadata *FLAC__metadata_object_new(FLAC__MetadataType type);
1420
1421 /** Create a copy of an existing metadata object.
1422  *
1423  *  The copy is a "deep" copy, i.e. dynamically allocated data within the
1424  *  object is also copied.  The caller takes ownership of the new block and
1425  *  is responsible for freeing it with FLAC__metadata_object_delete().
1426  *
1427  * \param object  Pointer to object to copy.
1428  * \assert
1429  *    \code object != NULL \endcode
1430  * \retval FLAC__StreamMetadata*
1431  *    \c NULL if there was an error allocating memory, else the new instance.
1432  */
1433 FLAC__StreamMetadata *FLAC__metadata_object_clone(const FLAC__StreamMetadata *object);
1434
1435 /** Free a metadata object.  Deletes the object pointed to by \a object.
1436  *
1437  *  The delete is a "deep" delete, i.e. dynamically allocated data within the
1438  *  object is also deleted.
1439  *
1440  * \param object  A pointer to an existing object.
1441  * \assert
1442  *    \code object != NULL \endcode
1443  */
1444 void FLAC__metadata_object_delete(FLAC__StreamMetadata *object);
1445
1446 /* Does a deep comparison of the block data */
1447 /** Compares two metadata objects.
1448  *
1449  *  The compare is "deep", i.e. dynamically allocated data within the
1450  *  object is also compared.
1451  *
1452  * \param block1  A pointer to an existing object.
1453  * \param block2  A pointer to an existing object.
1454  * \assert
1455  *    \code block1 != NULL \endcode
1456  *    \code block2 != NULL \endcode
1457  * \retval FLAC__bool
1458  *    \c true if objects are identical, else \c false.
1459  */
1460 FLAC__bool FLAC__metadata_object_is_equal(const FLAC__StreamMetadata *block1, const FLAC__StreamMetadata *block2);
1461
1462 /** Sets the application data of an APPLICATION block.
1463  *
1464  *  If \a copy is \c true, a copy of the data is stored; otherwise, the object
1465  *  takes ownership of the pointer.  Returns \c false if \a copy == \c true
1466  *  and malloc fails.
1467  *
1468  * \param object  A pointer to an existing APPLICATION object.
1469  * \param data    A pointer to the data to set.
1470  * \param length  The length of \a data in bytes.
1471  * \param copy    See above.
1472  * \assert
1473  *    \code object != NULL \endcode
1474  *    \code object->type == FLAC__METADATA_TYPE_APPLICATION \endcode
1475  *    \code (data != NULL && length > 0) ||
1476  * (data == NULL && length == 0 && copy == false) \endcode
1477  * \retval FLAC__bool
1478  *    \c false if \a copy is \c true and malloc fails, else \c true.
1479  */
1480 FLAC__bool FLAC__metadata_object_application_set_data(FLAC__StreamMetadata *object, FLAC__byte *data, unsigned length, FLAC__bool copy);
1481
1482 /** Resize the seekpoint array.
1483  *
1484  *  If the size shrinks, elements will truncated; if it grows, new placeholder
1485  *  points will be added to the end.
1486  *
1487  * \param object          A pointer to an existing SEEKTABLE object.
1488  * \param new_num_points  The desired length of the array; may be \c 0.
1489  * \assert
1490  *    \code object != NULL \endcode
1491  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1492  *    \code (object->data.seek_table.points == NULL && object->data.seek_table.num_points == 0) ||
1493  * (object->data.seek_table.points != NULL && object->data.seek_table.num_points > 0) \endcode
1494  * \retval FLAC__bool
1495  *    \c false if memory allocation error, else \c true.
1496  */
1497 FLAC__bool FLAC__metadata_object_seektable_resize_points(FLAC__StreamMetadata *object, unsigned new_num_points);
1498
1499 /** Set a seekpoint in a seektable.
1500  *
1501  * \param object     A pointer to an existing SEEKTABLE object.
1502  * \param point_num  Index into seekpoint array to set.
1503  * \param point      The point to set.
1504  * \assert
1505  *    \code object != NULL \endcode
1506  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1507  *    \code object->data.seek_table.num_points > point_num \endcode
1508  */
1509 void FLAC__metadata_object_seektable_set_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1510
1511 /** Insert a seekpoint into a seektable.
1512  *
1513  * \param object     A pointer to an existing SEEKTABLE object.
1514  * \param point_num  Index into seekpoint array to set.
1515  * \param point      The point to set.
1516  * \assert
1517  *    \code object != NULL \endcode
1518  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1519  *    \code object->data.seek_table.num_points >= point_num \endcode
1520  * \retval FLAC__bool
1521  *    \c false if memory allocation error, else \c true.
1522  */
1523 FLAC__bool FLAC__metadata_object_seektable_insert_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1524
1525 /** Delete a seekpoint from a seektable.
1526  *
1527  * \param object     A pointer to an existing SEEKTABLE object.
1528  * \param point_num  Index into seekpoint array to set.
1529  * \assert
1530  *    \code object != NULL \endcode
1531  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1532  *    \code object->data.seek_table.num_points > point_num \endcode
1533  * \retval FLAC__bool
1534  *    \c false if memory allocation error, else \c true.
1535  */
1536 FLAC__bool FLAC__metadata_object_seektable_delete_point(FLAC__StreamMetadata *object, unsigned point_num);
1537
1538 /** Check a seektable to see if it conforms to the FLAC specification.
1539  *  See the format specification for limits on the contents of the
1540  *  seektable.
1541  *
1542  * \param object     A pointer to an existing SEEKTABLE object.
1543  * \assert
1544  *    \code object != NULL \endcode
1545  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1546  * \retval FLAC__bool
1547  *    \c false if seektable is illegal, else \c true.
1548  */
1549 FLAC__bool FLAC__metadata_object_seektable_is_legal(const FLAC__StreamMetadata *object);
1550
1551 /** Sets the vendor string in a VORBIS_COMMENT block.
1552  *
1553  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1554  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1555  *  \a copy == \c true and malloc fails.
1556  *
1557  * \param object  A pointer to an existing VORBIS_COMMENT object.
1558  * \param entry   The entry to set the vendor string to.
1559  * \param copy    See above.
1560  * \assert
1561  *    \code object != NULL \endcode
1562  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1563  *    \code (entry->entry != NULL && entry->length > 0) ||
1564  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1565  * \retval FLAC__bool
1566  *    \c false if \a copy is \c true and malloc fails, else \c true.
1567  */
1568 FLAC__bool FLAC__metadata_object_vorbiscomment_set_vendor_string(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1569
1570 /** Resize the comment array.
1571  *
1572  *  If the size shrinks, elements will truncated; if it grows, new empty
1573  *  fields will be added to the end.
1574  *
1575  * \param object            A pointer to an existing VORBIS_COMMENT object.
1576  * \param new_num_comments  The desired length of the array; may be \c 0.
1577  * \assert
1578  *    \code object != NULL \endcode
1579  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1580  *    \code (object->data.vorbis_comment.comments == NULL && object->data.vorbis_comment.num_comments == 0) ||
1581  * (object->data.vorbis_comment.comments != NULL && object->data.vorbis_comment.num_comments > 0) \endcode
1582  * \retval FLAC__bool
1583  *    \c false if memory allocation error, else \c true.
1584  */
1585 FLAC__bool FLAC__metadata_object_vorbiscomment_resize_comments(FLAC__StreamMetadata *object, unsigned new_num_comments);
1586
1587 /** Sets a comment in a VORBIS_COMMENT block.
1588  *
1589  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1590  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1591  *  \a copy == \c true and malloc fails.
1592  *
1593  * \param object       A pointer to an existing VORBIS_COMMENT object.
1594  * \param comment_num  Index into comment array to set.
1595  * \param entry        The entry to set the comment to.
1596  * \param copy         See above.
1597  * \assert
1598  *    \code object != NULL \endcode
1599  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1600  *    \code (entry->entry != NULL && entry->length > 0) ||
1601  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1602  * \retval FLAC__bool
1603  *    \c false if \a copy is \c true and malloc fails, else \c true.
1604  */
1605 FLAC__bool FLAC__metadata_object_vorbiscomment_set_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1606
1607 /** Insert a comment in a VORBIS_COMMENT block at the given index.
1608  *
1609  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1610  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1611  *  \a copy == \c true and malloc fails.
1612  *
1613  * \param object       A pointer to an existing VORBIS_COMMENT object.
1614  * \param comment_num  The index at which to insert the comment.  The comments
1615  *                     at and after \a comment_num move right one position.
1616  *                     To append a comment to the end, set \a comment_num to
1617  *                     \c object->data.vorbis_comment.num_comments .
1618  * \param entry        The comment to insert.
1619  * \param copy         See above.
1620  * \assert
1621  *    \code object != NULL \endcode
1622  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1623  *    \code object->data.vorbis_comment.num_comments >= comment_num \endcode
1624  *    \code (entry->entry != NULL && entry->length > 0) ||
1625  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1626  * \retval FLAC__bool
1627  *    \c false if \a copy is \c true and malloc fails, else \c true.
1628  */
1629 FLAC__bool FLAC__metadata_object_vorbiscomment_insert_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1630
1631 /** Delete a comment in a VORBIS_COMMENT block at the given index.
1632  *
1633  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1634  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1635  *  \a copy == \c true and malloc fails.
1636  *
1637  * \param object       A pointer to an existing VORBIS_COMMENT object.
1638  * \param comment_num  The index of the comment to delete.
1639  * \assert
1640  *    \code object != NULL \endcode
1641  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1642  *    \code object->data.vorbis_comment.num_comments > comment_num \endcode
1643  *    \code (entry->entry != NULL && entry->length > 0) ||
1644  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1645  * \retval FLAC__bool
1646  *    \c false if realloc fails, else \c true.
1647  */
1648 FLAC__bool FLAC__metadata_object_vorbiscomment_delete_comment(FLAC__StreamMetadata *object, unsigned comment_num);
1649
1650 /* \} */
1651
1652 #endif