add callback.h
[flac.git] / include / FLAC / metadata.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2001,2002,2003,2004  Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef FLAC__METADATA_H
33 #define FLAC__METADATA_H
34
35 #include "export.h"
36 #include "callback.h"
37 #include "format.h"
38
39 /******************************************************************************
40         (For an example of how all these routines are used, see the source
41         code for the unit tests in src/test_libFLAC/metadata_*.c, or metaflac
42         in src/metaflac/)
43 ******************************************************************************/
44
45 /** \file include/FLAC/metadata.h
46  *
47  *  \brief
48  *  This module provides functions for creating and manipulating FLAC
49  *  metadata blocks in memory, and three progressively more powerful
50  *  interfaces for traversing and editing metadata in FLAC files.
51  *
52  *  See the detailed documentation for each interface in the
53  *  \link flac_metadata metadata \endlink module.
54  */
55
56 /** \defgroup flac_metadata FLAC/metadata.h: metadata interfaces
57  *  \ingroup flac
58  *
59  *  \brief
60  *  This module provides functions for creating and manipulating FLAC
61  *  metadata blocks in memory, and three progressively more powerful
62  *  interfaces for traversing and editing metadata in FLAC files.
63  *
64  *  There are three metadata interfaces of increasing complexity:
65  *
66  *  Level 0:
67  *  Read-only access to the STREAMINFO block.
68  *
69  *  Level 1:
70  *  Read-write access to all metadata blocks.  This level is write-
71  *  efficient in most cases (more on this below), and uses less memory
72  *  than level 2.
73  *
74  *  Level 2:
75  *  Read-write access to all metadata blocks.  This level is write-
76  *  efficient in all cases, but uses more memory since all metadata for
77  *  the whole file is read into memory and manipulated before writing
78  *  out again.
79  *
80  *  What do we mean by efficient?  Since FLAC metadata appears at the
81  *  beginning of the file, when writing metadata back to a FLAC file
82  *  it is possible to grow or shrink the metadata such that the entire
83  *  file must be rewritten.  However, if the size remains the same during
84  *  changes or PADDING blocks are utilized, only the metadata needs to be
85  *  overwritten, which is much faster.
86  *
87  *  Efficient means the whole file is rewritten at most one time, and only
88  *  when necessary.  Level 1 is not efficient only in the case that you
89  *  cause more than one metadata block to grow or shrink beyond what can
90  *  be accomodated by padding.  In this case you should probably use level
91  *  2, which allows you to edit all the metadata for a file in memory and
92  *  write it out all at once.
93  *
94  *  All levels know how to skip over and not disturb an ID3v2 tag at the
95  *  front of the file.
96  *
97  *  In addition to the three interfaces, this module defines functions for
98  *  creating and manipulating various metadata objects in memory.  As we see
99  *  from the Format module, FLAC metadata blocks in memory are very primitive
100  *  structures for storing information in an efficient way.  Reading
101  *  information from the structures is easy but creating or modifying them
102  *  directly is more complex.  The metadata object routines here facilitate
103  *  this by taking care of the consistency and memory management drudgery.
104  *
105  *  Unless you will be using the level 1 or 2 interfaces to modify existing
106  *  metadata however, you will not probably not need these.
107  *
108  *  From a dependency standpoint, none of the encoders or decoders require
109  *  the metadata module.  This is so that embedded users can strip out the
110  *  metadata module from libFLAC to reduce the size and complexity.
111  */
112
113 #ifdef __cplusplus
114 extern "C" {
115 #endif
116
117
118 /** \defgroup flac_metadata_level0 FLAC/metadata.h: metadata level 0 interface
119  *  \ingroup flac_metadata
120  *
121  *  \brief
122  *  The level 0 interface consists of a single routine to read the
123  *  STREAMINFO block.
124  *
125  *  It skips any ID3v2 tag at the head of the file.
126  *
127  * \{
128  */
129
130 /** Read the STREAMINFO metadata block of the given FLAC file.  This function
131  *  will skip any ID3v2 tag at the head of the file.
132  *
133  * \param filename    The path to the FLAC file to read.
134  * \param streaminfo  A pointer to space for the STREAMINFO block.
135  * \assert
136  *    \code filename != NULL \endcode
137  *    \code streaminfo != NULL \endcode
138  * \retval FLAC__bool
139  *    \c true if a valid STREAMINFO block was read from \a filename.  Returns
140  *    \c false if there was a memory allocation error, a file decoder error,
141  *    or the file contained no STREAMINFO block.
142  */
143 FLAC_API FLAC__bool FLAC__metadata_get_streaminfo(const char *filename, FLAC__StreamMetadata *streaminfo);
144
145 /* \} */
146
147
148 /** \defgroup flac_metadata_level1 FLAC/metadata.h: metadata level 1 interface
149  *  \ingroup flac_metadata
150  *
151  * \brief
152  * The level 1 interface provides read-write access to FLAC file metadata and
153  * operates directly on the FLAC file.
154  *
155  * The general usage of this interface is:
156  *
157  * - Create an iterator using FLAC__metadata_simple_iterator_new()
158  * - Attach it to a file using FLAC__metadata_simple_iterator_init() and check
159  *   the exit code.  Call FLAC__metadata_simple_iterator_is_writable() to
160  *   see if the file is writable, or read-only access is allowed.
161  * - Use FLAC__metadata_simple_iterator_next() and
162  *   FLAC__metadata_simple_iterator_prev() to move around the blocks.
163  *   This is does not read the actual blocks themselves.
164  *   FLAC__metadata_simple_iterator_next() is relatively fast.
165  *   FLAC__metadata_simple_iterator_prev() is slower since it needs to search
166  *   forward from the front of the file.
167  * - Use FLAC__metadata_simple_iterator_get_block_type() or
168  *   FLAC__metadata_simple_iterator_get_block() to access the actual data at
169  *   the current iterator position.  The returned object is yours to modify
170  *   and free.
171  * - Use FLAC__metadata_simple_iterator_set_block() to write a modified block
172  *   back.  You must have write permission to the original file.  Make sure to
173  *   read the whole comment to FLAC__metadata_simple_iterator_set_block()
174  *   below.
175  * - Use FLAC__metadata_simple_iterator_insert_block_after() to add new blocks.
176  *   Use the object creation functions from
177  *   \link flac_metadata_object here \endlink to generate new objects.
178  * - Use FLAC__metadata_simple_iterator_delete_block() to remove the block
179  *   currently referred to by the iterator, or replace it with padding.
180  * - Destroy the iterator with FLAC__metadata_simple_iterator_delete() when
181  *   finished.
182  *
183  * \note
184  * The FLAC file remains open the whole time between
185  * FLAC__metadata_simple_iterator_init() and
186  * FLAC__metadata_simple_iterator_delete(), so make sure you are not altering
187  * the file during this time.
188  *
189  * \note
190  * Do not modify the \a is_last, \a length, or \a type fields of returned
191  * FLAC__StreamMetadata objects.  These are managed automatically.
192  *
193  * \note
194  * If any of the modification functions
195  * (FLAC__metadata_simple_iterator_set_block(),
196  * FLAC__metadata_simple_iterator_delete_block(),
197  * FLAC__metadata_simple_iterator_insert_block_after(), etc.) return \c false,
198  * you should delete the iterator as it may no longer be valid.
199  *
200  * \{
201  */
202
203 struct FLAC__Metadata_SimpleIterator;
204 /** The opaque structure definition for the level 1 iterator type.
205  *  See the
206  *  \link flac_metadata_level1 metadata level 1 module \endlink
207  *  for a detailed description.
208  */
209 typedef struct FLAC__Metadata_SimpleIterator FLAC__Metadata_SimpleIterator;
210
211 /** Status type for FLAC__Metadata_SimpleIterator.
212  *
213  *  The iterator's current status can be obtained by calling FLAC__metadata_simple_iterator_status().
214  */
215 typedef enum {
216
217         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK = 0,
218         /**< The iterator is in the normal OK state */
219
220         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT,
221         /**< The data passed into a function violated the function's usage criteria */
222
223         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE,
224         /**< The iterator could not open the target file */
225
226         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE,
227         /**< The iterator could not find the FLAC signature at the start of the file */
228
229         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE,
230         /**< The iterator tried to write to a file that was not writable */
231
232         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA,
233         /**< The iterator encountered input that does not conform to the FLAC metadata specification */
234
235         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR,
236         /**< The iterator encountered an error while reading the FLAC file */
237
238         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR,
239         /**< The iterator encountered an error while seeking in the FLAC file */
240
241         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR,
242         /**< The iterator encountered an error while writing the FLAC file */
243
244         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR,
245         /**< The iterator encountered an error renaming the FLAC file */
246
247         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR,
248         /**< The iterator encountered an error removing the temporary file */
249
250         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR,
251         /**< Memory allocation failed */
252
253         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR
254         /**< The caller violated an assertion or an unexpected error occurred */
255
256 } FLAC__Metadata_SimpleIteratorStatus;
257
258 /** Maps a FLAC__Metadata_SimpleIteratorStatus to a C string.
259  *
260  *  Using a FLAC__Metadata_SimpleIteratorStatus as the index to this array
261  *  will give the string equivalent.  The contents should not be modified.
262  */
263 extern FLAC_API const char * const FLAC__Metadata_SimpleIteratorStatusString[];
264
265
266 /** Create a new iterator instance.
267  *
268  * \retval FLAC__Metadata_SimpleIterator*
269  *    \c NULL if there was an error allocating memory, else the new instance.
270  */
271 FLAC_API FLAC__Metadata_SimpleIterator *FLAC__metadata_simple_iterator_new();
272
273 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
274  *
275  * \param iterator  A pointer to an existing iterator.
276  * \assert
277  *    \code iterator != NULL \endcode
278  */
279 FLAC_API void FLAC__metadata_simple_iterator_delete(FLAC__Metadata_SimpleIterator *iterator);
280
281 /** Get the current status of the iterator.  Call this after a function
282  *  returns \c false to get the reason for the error.  Also resets the status
283  *  to FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK.
284  *
285  * \param iterator  A pointer to an existing iterator.
286  * \assert
287  *    \code iterator != NULL \endcode
288  * \retval FLAC__Metadata_SimpleIteratorStatus
289  *    The current status of the iterator.
290  */
291 FLAC_API FLAC__Metadata_SimpleIteratorStatus FLAC__metadata_simple_iterator_status(FLAC__Metadata_SimpleIterator *iterator);
292
293 /** Initialize the iterator to point to the first metadata block in the
294  *  given FLAC file.
295  *
296  * \param iterator             A pointer to an existing iterator.
297  * \param filename             The path to the FLAC file.
298  * \param read_only            If \c true, the FLAC file will be opened
299  *                             in read-only mode; if \c false, the FLAC
300  *                             file will be opened for edit even if no
301  *                             edits are performed.
302  * \param preserve_file_stats  If \c true, the owner and modification
303  *                             time will be preserved even if the FLAC
304  *                             file is written to.
305  * \assert
306  *    \code iterator != NULL \endcode
307  *    \code filename != NULL \endcode
308  * \retval FLAC__bool
309  *    \c false if a memory allocation error occurs, the file can't be
310  *    opened, or another error occurs, else \c true.
311  */
312 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_init(FLAC__Metadata_SimpleIterator *iterator, const char *filename, FLAC__bool read_only, FLAC__bool preserve_file_stats);
313
314 /** Returns \c true if the FLAC file is writable.  If \c false, calls to
315  *  FLAC__metadata_simple_iterator_set_block() and
316  *  FLAC__metadata_simple_iterator_insert_block_after() will fail.
317  *
318  * \param iterator             A pointer to an existing iterator.
319  * \assert
320  *    \code iterator != NULL \endcode
321  * \retval FLAC__bool
322  *    See above.
323  */
324 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_is_writable(const FLAC__Metadata_SimpleIterator *iterator);
325
326 /** Moves the iterator forward one metadata block, returning \c false if
327  *  already at the end.
328  *
329  * \param iterator  A pointer to an existing initialized iterator.
330  * \assert
331  *    \code iterator != NULL \endcode
332  *    \a iterator has been successfully initialized with
333  *    FLAC__metadata_simple_iterator_init()
334  * \retval FLAC__bool
335  *    \c false if already at the last metadata block of the chain, else
336  *    \c true.
337  */
338 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_next(FLAC__Metadata_SimpleIterator *iterator);
339
340 /** Moves the iterator backward one metadata block, returning \c false if
341  *  already at the beginning.
342  *
343  * \param iterator  A pointer to an existing initialized iterator.
344  * \assert
345  *    \code iterator != NULL \endcode
346  *    \a iterator has been successfully initialized with
347  *    FLAC__metadata_simple_iterator_init()
348  * \retval FLAC__bool
349  *    \c false if already at the first metadata block of the chain, else
350  *    \c true.
351  */
352 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_prev(FLAC__Metadata_SimpleIterator *iterator);
353
354 /** Get the type of the metadata block at the current position.  This
355  *  avoids reading the actual block data which can save time for large
356  *  blocks.
357  *
358  * \param iterator  A pointer to an existing initialized iterator.
359  * \assert
360  *    \code iterator != NULL \endcode
361  *    \a iterator has been successfully initialized with
362  *    FLAC__metadata_simple_iterator_init()
363  * \retval FLAC__MetadataType
364  *    The type of the metadata block at the current iterator position.
365  */
366
367 FLAC_API FLAC__MetadataType FLAC__metadata_simple_iterator_get_block_type(const FLAC__Metadata_SimpleIterator *iterator);
368
369 /** Get the metadata block at the current position.  You can modify the
370  *  block but must use FLAC__metadata_simple_iterator_set_block() to
371  *  write it back to the FLAC file.
372  *
373  *  You must call FLAC__metadata_object_delete() on the returned object
374  *  when you are finished with it.
375  *
376  * \param iterator  A pointer to an existing initialized iterator.
377  * \assert
378  *    \code iterator != NULL \endcode
379  *    \a iterator has been successfully initialized with
380  *    FLAC__metadata_simple_iterator_init()
381  * \retval FLAC__StreamMetadata*
382  *    The current metadata block.
383  */
384 FLAC_API FLAC__StreamMetadata *FLAC__metadata_simple_iterator_get_block(FLAC__Metadata_SimpleIterator *iterator);
385
386 /** Write a block back to the FLAC file.  This function tries to be
387  *  as efficient as possible; how the block is actually written is
388  *  shown by the following:
389  *
390  *  Existing block is a STREAMINFO block and the new block is a
391  *  STREAMINFO block: the new block is written in place.  Make sure
392  *  you know what you're doing when changing the values of a
393  *  STREAMINFO block.
394  *
395  *  Existing block is a STREAMINFO block and the new block is a
396  *  not a STREAMINFO block: this is an error since the first block
397  *  must be a STREAMINFO block.  Returns \c false without altering the
398  *  file.
399  *
400  *  Existing block is not a STREAMINFO block and the new block is a
401  *  STREAMINFO block: this is an error since there may be only one
402  *  STREAMINFO block.  Returns \c false without altering the file.
403  *
404  *  Existing block and new block are the same length: the existing
405  *  block will be replaced by the new block, written in place.
406  *
407  *  Existing block is longer than new block: if use_padding is \c true,
408  *  the existing block will be overwritten in place with the new
409  *  block followed by a PADDING block, if possible, to make the total
410  *  size the same as the existing block.  Remember that a padding
411  *  block requires at least four bytes so if the difference in size
412  *  between the new block and existing block is less than that, the
413  *  entire file will have to be rewritten, using the new block's
414  *  exact size.  If use_padding is \c false, the entire file will be
415  *  rewritten, replacing the existing block by the new block.
416  *
417  *  Existing block is shorter than new block: if use_padding is \c true,
418  *  the function will try and expand the new block into the following
419  *  PADDING block, if it exists and doing so won't shrink the PADDING
420  *  block to less than 4 bytes.  If there is no following PADDING
421  *  block, or it will shrink to less than 4 bytes, or use_padding is
422  *  \c false, the entire file is rewritten, replacing the existing block
423  *  with the new block.  Note that in this case any following PADDING
424  *  block is preserved as is.
425  *
426  *  After writing the block, the iterator will remain in the same
427  *  place, i.e. pointing to the new block.
428  *
429  * \param iterator     A pointer to an existing initialized iterator.
430  * \param block        The block to set.
431  * \param use_padding  See above.
432  * \assert
433  *    \code iterator != NULL \endcode
434  *    \a iterator has been successfully initialized with
435  *    FLAC__metadata_simple_iterator_init()
436  *    \code block != NULL \endcode
437  * \retval FLAC__bool
438  *    \c true if successful, else \c false.
439  */
440 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_set_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
441
442 /** This is similar to FLAC__metadata_simple_iterator_set_block()
443  *  except that instead of writing over an existing block, it appends
444  *  a block after the existing block.  \a use_padding is again used to
445  *  tell the function to try an expand into following padding in an
446  *  attempt to avoid rewriting the entire file.
447  *
448  *  This function will fail and return \c false if given a STREAMINFO
449  *  block.
450  *
451  *  After writing the block, the iterator will be pointing to the
452  *  new block.
453  *
454  * \param iterator     A pointer to an existing initialized iterator.
455  * \param block        The block to set.
456  * \param use_padding  See above.
457  * \assert
458  *    \code iterator != NULL \endcode
459  *    \a iterator has been successfully initialized with
460  *    FLAC__metadata_simple_iterator_init()
461  *    \code block != NULL \endcode
462  * \retval FLAC__bool
463  *    \c true if successful, else \c false.
464  */
465 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_insert_block_after(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
466
467 /** Deletes the block at the current position.  This will cause the
468  *  entire FLAC file to be rewritten, unless \a use_padding is \c true,
469  *  in which case the block will be replaced by an equal-sized PADDING
470  *  block.  The iterator will be left pointing to the block before the
471  *  one just deleted.
472  *
473  *  You may not delete the STREAMINFO block.
474  *
475  * \param iterator     A pointer to an existing initialized iterator.
476  * \param use_padding  See above.
477  * \assert
478  *    \code iterator != NULL \endcode
479  *    \a iterator has been successfully initialized with
480  *    FLAC__metadata_simple_iterator_init()
481  * \retval FLAC__bool
482  *    \c true if successful, else \c false.
483  */
484 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_delete_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__bool use_padding);
485
486 /* \} */
487
488
489 /** \defgroup flac_metadata_level2 FLAC/metadata.h: metadata level 2 interface
490  *  \ingroup flac_metadata
491  *
492  * \brief
493  * The level 2 interface provides read-write access to FLAC file metadata;
494  * all metadata is read into memory, operated on in memory, and then written
495  * to file, which is more efficient than level 1 when editing multiple blocks.
496  *
497  * The general usage of this interface is:
498  *
499  * - Create a new chain using FLAC__metadata_chain_new().  A chain is a
500  *   linked list of FLAC metadata blocks.
501  * - Read all metadata into the the chain from a FLAC file using
502  *   FLAC__metadata_chain_read() and check the status.
503  * - Optionally, consolidate the padding using
504  *   FLAC__metadata_chain_merge_padding() or
505  *   FLAC__metadata_chain_sort_padding().
506  * - Create a new iterator using FLAC__metadata_iterator_new()
507  * - Initialize the iterator to point to the first element in the chain
508  *   using FLAC__metadata_iterator_init()
509  * - Traverse the chain using FLAC__metadata_iterator_next and
510  *   FLAC__metadata_iterator_prev().
511  * - Get a block for reading or modification using
512  *   FLAC__metadata_iterator_get_block().  The pointer to the object
513  *   inside the chain is returned, so the block is yours to modify.
514  *   Changes will be reflected in the FLAC file when you write the
515  *   chain.  You can also add and delete blocks (see functions below).
516  * - When done, write out the chain using FLAC__metadata_chain_write().
517  *   Make sure to read the whole comment to the function below.
518  * - Delete the chain using FLAC__metadata_chain_delete().
519  *
520  * \note
521  * Even though the FLAC file is not open while the chain is being
522  * manipulated, you must not alter the file externally during
523  * this time.  The chain assumes the FLAC file will not change
524  * between the time of FLAC__metadata_chain_read() and
525  * FLAC__metadata_chain_write().
526  *
527  * \note
528  * Do not modify the is_last, length, or type fields of returned
529  * FLAC__StreamMetadata objects.  These are managed automatically.
530  *
531  * \note
532  * The metadata objects returned by FLAC__metadata_iterator_get_block()
533  * are owned by the chain; do not FLAC__metadata_object_delete() them.
534  * In the same way, blocks passed to FLAC__metadata_iterator_set_block()
535  * become owned by the chain and they will be deleted when the chain is
536  * deleted.
537  *
538  * \{
539  */
540
541 struct FLAC__Metadata_Chain;
542 /** The opaque structure definition for the level 2 chain type.
543  */
544 typedef struct FLAC__Metadata_Chain FLAC__Metadata_Chain;
545
546 struct FLAC__Metadata_Iterator;
547 /** The opaque structure definition for the level 2 iterator type.
548  */
549 typedef struct FLAC__Metadata_Iterator FLAC__Metadata_Iterator;
550
551 typedef enum {
552         FLAC__METADATA_CHAIN_STATUS_OK = 0,
553         /**< The chain is in the normal OK state */
554
555         FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT,
556         /**< The data passed into a function violated the function's usage criteria */
557
558         FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE,
559         /**< The chain could not open the target file */
560
561         FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE,
562         /**< The chain could not find the FLAC signature at the start of the file */
563
564         FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE,
565         /**< The chain tried to write to a file that was not writable */
566
567         FLAC__METADATA_CHAIN_STATUS_BAD_METADATA,
568         /**< The chain encountered input that does not conform to the FLAC metadata specification */
569
570         FLAC__METADATA_CHAIN_STATUS_READ_ERROR,
571         /**< The chain encountered an error while reading the FLAC file */
572
573         FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR,
574         /**< The chain encountered an error while seeking in the FLAC file */
575
576         FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR,
577         /**< The chain encountered an error while writing the FLAC file */
578
579         FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR,
580         /**< The chain encountered an error renaming the FLAC file */
581
582         FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR,
583         /**< The chain encountered an error removing the temporary file */
584
585         FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR,
586         /**< Memory allocation failed */
587
588         FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR
589         /**< The caller violated an assertion or an unexpected error occurred */
590
591 } FLAC__Metadata_ChainStatus;
592
593 /** Maps a FLAC__Metadata_ChainStatus to a C string.
594  *
595  *  Using a FLAC__Metadata_ChainStatus as the index to this array
596  *  will give the string equivalent.  The contents should not be modified.
597  */
598 extern FLAC_API const char * const FLAC__Metadata_ChainStatusString[];
599
600 /*********** FLAC__Metadata_Chain ***********/
601
602 /** Create a new chain instance.
603  *
604  * \retval FLAC__Metadata_Chain*
605  *    \c NULL if there was an error allocating memory, else the new instance.
606  */
607 FLAC_API FLAC__Metadata_Chain *FLAC__metadata_chain_new();
608
609 /** Free a chain instance.  Deletes the object pointed to by \a chain.
610  *
611  * \param chain  A pointer to an existing chain.
612  * \assert
613  *    \code chain != NULL \endcode
614  */
615 FLAC_API void FLAC__metadata_chain_delete(FLAC__Metadata_Chain *chain);
616
617 /** Get the current status of the chain.  Call this after a function
618  *  returns \c false to get the reason for the error.  Also resets the
619  *  status to FLAC__METADATA_CHAIN_STATUS_OK.
620  *
621  * \param chain    A pointer to an existing chain.
622  * \assert
623  *    \code chain != NULL \endcode
624  * \retval FLAC__Metadata_ChainStatus
625  *    The current status of the chain.
626  */
627 FLAC_API FLAC__Metadata_ChainStatus FLAC__metadata_chain_status(FLAC__Metadata_Chain *chain);
628
629 /** Read all metadata from a FLAC file into the chain.
630  *
631  * \param chain    A pointer to an existing chain.
632  * \param filename The path to the FLAC file to read.
633  * \assert
634  *    \code chain != NULL \endcode
635  *    \code filename != NULL \endcode
636  * \retval FLAC__bool
637  *    \c true if a valid list of metadata blocks was read from
638  *    \a filename, else \c false.  On failure, check the status with
639  *    FLAC__metadata_chain_status().
640  */
641 FLAC_API FLAC__bool FLAC__metadata_chain_read(FLAC__Metadata_Chain *chain, const char *filename);
642
643 /** Write all metadata out to the FLAC file.  This function tries to be as
644  *  efficient as possible; how the metadata is actually written is shown by
645  *  the following:
646  *
647  *  If the current chain is the same size as the existing metadata, the new
648  *  data is written in place.
649  *
650  *  If the current chain is longer than the existing metadata, and
651  *  \a use_padding is \c true, and the last block is a PADDING block of
652  *  sufficient length, the function will truncate the final padding block
653  *  so that the overall size of the metadata is the same as the existing
654  *  metadata, and then just rewrite the metadata.  Otherwise, if not all of
655  *  the above conditions are met, the entire FLAC file must be rewritten.
656  *  If you want to use padding this way it is a good idea to call
657  *  FLAC__metadata_chain_sort_padding() first so that you have the maximum
658  *  amount of padding to work with, unless you need to preserve ordering
659  *  of the PADDING blocks for some reason.
660  *
661  *  If the current chain is shorter than the existing metadata, and
662  *  \a use_padding is \c true, and the final block is a PADDING block, the padding
663  *  is extended to make the overall size the same as the existing data.  If
664  *  \a use_padding is \c true and the last block is not a PADDING block, a new
665  *  PADDING block is added to the end of the new data to make it the same
666  *  size as the existing data (if possible, see the note to
667  *  FLAC__metadata_simple_iterator_set_block() about the four byte limit)
668  *  and the new data is written in place.  If none of the above apply or
669  *  \a use_padding is \c false, the entire FLAC file is rewritten.
670  *
671  *  If \a preserve_file_stats is \c true, the owner and modification time will
672  *  be preserved even if the FLAC file is written.
673  *
674  * \param chain               A pointer to an existing chain.
675  * \param use_padding         See above.
676  * \param preserve_file_stats See above.
677  * \assert
678  *    \code chain != NULL \endcode
679  * \retval FLAC__bool
680  *    \c true if the write succeeded, else \c false.  On failure,
681  *    check the status with FLAC__metadata_chain_status().
682  */
683 FLAC_API FLAC__bool FLAC__metadata_chain_write(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__bool preserve_file_stats);
684
685 /** Merge adjacent PADDING blocks into a single block.
686  *
687  * \note This function does not write to the FLAC file, it only
688  * modifies the chain.
689  *
690  * \warning Any iterator on the current chain will become invalid after this
691  * call.  You should delete the iterator and get a new one.
692  *
693  * \param chain               A pointer to an existing chain.
694  * \assert
695  *    \code chain != NULL \endcode
696  */
697 FLAC_API void FLAC__metadata_chain_merge_padding(FLAC__Metadata_Chain *chain);
698
699 /** This function will move all PADDING blocks to the end on the metadata,
700  *  then merge them into a single block.
701  *
702  * \note This function does not write to the FLAC file, it only
703  * modifies the chain.
704  *
705  * \warning Any iterator on the current chain will become invalid after this
706  * call.  You should delete the iterator and get a new one.
707  *
708  * \param chain  A pointer to an existing chain.
709  * \assert
710  *    \code chain != NULL \endcode
711  */
712 FLAC_API void FLAC__metadata_chain_sort_padding(FLAC__Metadata_Chain *chain);
713
714
715 /*********** FLAC__Metadata_Iterator ***********/
716
717 /** Create a new iterator instance.
718  *
719  * \retval FLAC__Metadata_Iterator*
720  *    \c NULL if there was an error allocating memory, else the new instance.
721  */
722 FLAC_API FLAC__Metadata_Iterator *FLAC__metadata_iterator_new();
723
724 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
725  *
726  * \param iterator  A pointer to an existing iterator.
727  * \assert
728  *    \code iterator != NULL \endcode
729  */
730 FLAC_API void FLAC__metadata_iterator_delete(FLAC__Metadata_Iterator *iterator);
731
732 /** Initialize the iterator to point to the first metadata block in the
733  *  given chain.
734  *
735  * \param iterator  A pointer to an existing iterator.
736  * \param chain     A pointer to an existing and initialized (read) chain.
737  * \assert
738  *    \code iterator != NULL \endcode
739  *    \code chain != NULL \endcode
740  */
741 FLAC_API void FLAC__metadata_iterator_init(FLAC__Metadata_Iterator *iterator, FLAC__Metadata_Chain *chain);
742
743 /** Moves the iterator forward one metadata block, returning \c false if
744  *  already at the end.
745  *
746  * \param iterator  A pointer to an existing initialized iterator.
747  * \assert
748  *    \code iterator != NULL \endcode
749  *    \a iterator has been successfully initialized with
750  *    FLAC__metadata_iterator_init()
751  * \retval FLAC__bool
752  *    \c false if already at the last metadata block of the chain, else
753  *    \c true.
754  */
755 FLAC_API FLAC__bool FLAC__metadata_iterator_next(FLAC__Metadata_Iterator *iterator);
756
757 /** Moves the iterator backward one metadata block, returning \c false if
758  *  already at the beginning.
759  *
760  * \param iterator  A pointer to an existing initialized iterator.
761  * \assert
762  *    \code iterator != NULL \endcode
763  *    \a iterator has been successfully initialized with
764  *    FLAC__metadata_iterator_init()
765  * \retval FLAC__bool
766  *    \c false if already at the first metadata block of the chain, else
767  *    \c true.
768  */
769 FLAC_API FLAC__bool FLAC__metadata_iterator_prev(FLAC__Metadata_Iterator *iterator);
770
771 /** Get the type of the metadata block at the current position.
772  *
773  * \param iterator  A pointer to an existing initialized iterator.
774  * \assert
775  *    \code iterator != NULL \endcode
776  *    \a iterator has been successfully initialized with
777  *    FLAC__metadata_iterator_init()
778  * \retval FLAC__MetadataType
779  *    The type of the metadata block at the current iterator position.
780  */
781 FLAC_API FLAC__MetadataType FLAC__metadata_iterator_get_block_type(const FLAC__Metadata_Iterator *iterator);
782
783 /** Get the metadata block at the current position.  You can modify
784  *  the block in place but must write the chain before the changes
785  *  are reflected to the FLAC file.  You do not need to call
786  *  FLAC__metadata_iterator_set_block() to reflect the changes;
787  *  the pointer returned by FLAC__metadata_iterator_get_block()
788  *  points directly into the chain.
789  *
790  * \warning
791  * Do not call FLAC__metadata_object_delete() on the returned object;
792  * to delete a block use FLAC__metadata_iterator_delete_block().
793  *
794  * \param iterator  A pointer to an existing initialized iterator.
795  * \assert
796  *    \code iterator != NULL \endcode
797  *    \a iterator has been successfully initialized with
798  *    FLAC__metadata_iterator_init()
799  * \retval FLAC__StreamMetadata*
800  *    The current metadata block.
801  */
802 FLAC_API FLAC__StreamMetadata *FLAC__metadata_iterator_get_block(FLAC__Metadata_Iterator *iterator);
803
804 /** Set the metadata block at the current position, replacing the existing
805  *  block.  The new block passed in becomes owned by the chain and it will be
806  *  deleted when the chain is deleted.
807  *
808  * \param iterator  A pointer to an existing initialized iterator.
809  * \param block     A pointer to a metadata block.
810  * \assert
811  *    \code iterator != NULL \endcode
812  *    \a iterator has been successfully initialized with
813  *    FLAC__metadata_iterator_init()
814  *    \code block != NULL \endcode
815  * \retval FLAC__bool
816  *    \c false if the conditions in the above description are not met, or
817  *    a memory allocation error occurs, otherwise \c true.
818  */
819 FLAC_API FLAC__bool FLAC__metadata_iterator_set_block(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
820
821 /** Removes the current block from the chain.  If \a replace_with_padding is
822  *  \c true, the block will instead be replaced with a padding block of equal
823  *  size.  You can not delete the STREAMINFO block.  The iterator will be
824  *  left pointing to the block before the one just "deleted", even if
825  *  \a replace_with_padding is \c true.
826  *
827  * \param iterator              A pointer to an existing initialized iterator.
828  * \param replace_with_padding  See above.
829  * \assert
830  *    \code iterator != NULL \endcode
831  *    \a iterator has been successfully initialized with
832  *    FLAC__metadata_iterator_init()
833  * \retval FLAC__bool
834  *    \c false if the conditions in the above description are not met,
835  *    otherwise \c true.
836  */
837 FLAC_API FLAC__bool FLAC__metadata_iterator_delete_block(FLAC__Metadata_Iterator *iterator, FLAC__bool replace_with_padding);
838
839 /** Insert a new block before the current block.  You cannot insert a block
840  *  before the first STREAMINFO block.  You cannot insert a STREAMINFO block
841  *  as there can be only one, the one that already exists at the head when you
842  *  read in a chain.  The chain takes ownership of the new block and it will be
843  *  deleted when the chain is deleted.  The iterator will be left pointing to
844  *  the new block.
845  *
846  * \param iterator  A pointer to an existing initialized iterator.
847  * \param block     A pointer to a metadata block to insert.
848  * \assert
849  *    \code iterator != NULL \endcode
850  *    \a iterator has been successfully initialized with
851  *    FLAC__metadata_iterator_init()
852  * \retval FLAC__bool
853  *    \c false if the conditions in the above description are not met, or
854  *    a memory allocation error occurs, otherwise \c true.
855  */
856 FLAC_API FLAC__bool FLAC__metadata_iterator_insert_block_before(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
857
858 /** Insert a new block after the current block.  You cannot insert a STREAMINFO
859  *  block as there can be only one, the one that already exists at the head when
860  *  you read in a chain.  The chain takes ownership of the new block and it will
861  *  be deleted when the chain is deleted.  The iterator will be left pointing to
862  *  the new block.
863  *
864  * \param iterator  A pointer to an existing initialized iterator.
865  * \param block     A pointer to a metadata block to insert.
866  * \assert
867  *    \code iterator != NULL \endcode
868  *    \a iterator has been successfully initialized with
869  *    FLAC__metadata_iterator_init()
870  * \retval FLAC__bool
871  *    \c false if the conditions in the above description are not met, or
872  *    a memory allocation error occurs, otherwise \c true.
873  */
874 FLAC_API FLAC__bool FLAC__metadata_iterator_insert_block_after(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
875
876 /* \} */
877
878
879 /** \defgroup flac_metadata_object FLAC/metadata.h: metadata object methods
880  *  \ingroup flac_metadata
881  *
882  * \brief
883  * This module contains methods for manipulating FLAC metadata objects.
884  *
885  * Since many are variable length we have to be careful about the memory
886  * management.  We decree that all pointers to data in the object are
887  * owned by the object and memory-managed by the object.
888  *
889  * Use the FLAC__metadata_object_new() and FLAC__metadata_object_delete()
890  * functions to create all instances.  When using the
891  * FLAC__metadata_object_set_*() functions to set pointers to data, set
892  * \a copy to \c true to have the function make it's own copy of the data, or
893  * to \c false to give the object ownership of your data.  In the latter case
894  * your pointer must be freeable by free() and will be free()d when the object
895  * is FLAC__metadata_object_delete()d.  It is legal to pass a null pointer as
896  * the data pointer to a FLAC__metadata_object_set_*() function as long as
897  * the length argument is 0 and the \a copy argument is \c false.
898  *
899  * The FLAC__metadata_object_new() and FLAC__metadata_object_clone() function
900  * will return \c NULL in the case of a memory allocation error, otherwise a new
901  * object.  The FLAC__metadata_object_set_*() functions return \c false in the
902  * case of a memory allocation error.
903  *
904  * We don't have the convenience of C++ here, so note that the library relies
905  * on you to keep the types straight.  In other words, if you pass, for
906  * example, a FLAC__StreamMetadata* that represents a STREAMINFO block to
907  * FLAC__metadata_object_application_set_data(), you will get an assertion
908  * failure.
909  *
910  * There is no need to recalculate the length field on metadata blocks you
911  * have modified.  They will be calculated automatically before they  are
912  * written back to a file.
913  *
914  * \{
915  */
916
917
918 /** Create a new metadata object instance of the given type.
919  *
920  *  The object will be "empty"; i.e. values and data pointers will be \c 0,
921  *  with the exception of FLAC__METADATA_TYPE_VORBIS_COMMENT, which will have
922  *  the vendor string set (but zero comments).
923  *
924  *  Do not pass in a value greater than or equal to
925  *  \a FLAC__METADATA_TYPE_UNDEFINED unless you really know what you're
926  *  doing.
927  *
928  * \param type  Type of object to create
929  * \retval FLAC__StreamMetadata*
930  *    \c NULL if there was an error allocating memory, else the new instance.
931  */
932 FLAC_API FLAC__StreamMetadata *FLAC__metadata_object_new(FLAC__MetadataType type);
933
934 /** Create a copy of an existing metadata object.
935  *
936  *  The copy is a "deep" copy, i.e. dynamically allocated data within the
937  *  object is also copied.  The caller takes ownership of the new block and
938  *  is responsible for freeing it with FLAC__metadata_object_delete().
939  *
940  * \param object  Pointer to object to copy.
941  * \assert
942  *    \code object != NULL \endcode
943  * \retval FLAC__StreamMetadata*
944  *    \c NULL if there was an error allocating memory, else the new instance.
945  */
946 FLAC_API FLAC__StreamMetadata *FLAC__metadata_object_clone(const FLAC__StreamMetadata *object);
947
948 /** Free a metadata object.  Deletes the object pointed to by \a object.
949  *
950  *  The delete is a "deep" delete, i.e. dynamically allocated data within the
951  *  object is also deleted.
952  *
953  * \param object  A pointer to an existing object.
954  * \assert
955  *    \code object != NULL \endcode
956  */
957 FLAC_API void FLAC__metadata_object_delete(FLAC__StreamMetadata *object);
958
959 /** Compares two metadata objects.
960  *
961  *  The compare is "deep", i.e. dynamically allocated data within the
962  *  object is also compared.
963  *
964  * \param block1  A pointer to an existing object.
965  * \param block2  A pointer to an existing object.
966  * \assert
967  *    \code block1 != NULL \endcode
968  *    \code block2 != NULL \endcode
969  * \retval FLAC__bool
970  *    \c true if objects are identical, else \c false.
971  */
972 FLAC_API FLAC__bool FLAC__metadata_object_is_equal(const FLAC__StreamMetadata *block1, const FLAC__StreamMetadata *block2);
973
974 /** Sets the application data of an APPLICATION block.
975  *
976  *  If \a copy is \c true, a copy of the data is stored; otherwise, the object
977  *  takes ownership of the pointer.  Returns \c false if \a copy == \c true
978  *  and malloc fails.
979  *
980  * \param object  A pointer to an existing APPLICATION object.
981  * \param data    A pointer to the data to set.
982  * \param length  The length of \a data in bytes.
983  * \param copy    See above.
984  * \assert
985  *    \code object != NULL \endcode
986  *    \code object->type == FLAC__METADATA_TYPE_APPLICATION \endcode
987  *    \code (data != NULL && length > 0) ||
988  * (data == NULL && length == 0 && copy == false) \endcode
989  * \retval FLAC__bool
990  *    \c false if \a copy is \c true and malloc fails, else \c true.
991  */
992 FLAC_API FLAC__bool FLAC__metadata_object_application_set_data(FLAC__StreamMetadata *object, FLAC__byte *data, unsigned length, FLAC__bool copy);
993
994 /** Resize the seekpoint array.
995  *
996  *  If the size shrinks, elements will truncated; if it grows, new placeholder
997  *  points will be added to the end.
998  *
999  * \param object          A pointer to an existing SEEKTABLE object.
1000  * \param new_num_points  The desired length of the array; may be \c 0.
1001  * \assert
1002  *    \code object != NULL \endcode
1003  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1004  *    \code (object->data.seek_table.points == NULL && object->data.seek_table.num_points == 0) ||
1005  * (object->data.seek_table.points != NULL && object->data.seek_table.num_points > 0) \endcode
1006  * \retval FLAC__bool
1007  *    \c false if memory allocation error, else \c true.
1008  */
1009 FLAC_API FLAC__bool FLAC__metadata_object_seektable_resize_points(FLAC__StreamMetadata *object, unsigned new_num_points);
1010
1011 /** Set a seekpoint in a seektable.
1012  *
1013  * \param object     A pointer to an existing SEEKTABLE object.
1014  * \param point_num  Index into seekpoint array to set.
1015  * \param point      The point to set.
1016  * \assert
1017  *    \code object != NULL \endcode
1018  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1019  *    \code object->data.seek_table.num_points > point_num \endcode
1020  */
1021 FLAC_API void FLAC__metadata_object_seektable_set_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1022
1023 /** Insert a seekpoint into a seektable.
1024  *
1025  * \param object     A pointer to an existing SEEKTABLE object.
1026  * \param point_num  Index into seekpoint array to set.
1027  * \param point      The point to set.
1028  * \assert
1029  *    \code object != NULL \endcode
1030  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1031  *    \code object->data.seek_table.num_points >= point_num \endcode
1032  * \retval FLAC__bool
1033  *    \c false if memory allocation error, else \c true.
1034  */
1035 FLAC_API FLAC__bool FLAC__metadata_object_seektable_insert_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1036
1037 /** Delete a seekpoint from a seektable.
1038  *
1039  * \param object     A pointer to an existing SEEKTABLE object.
1040  * \param point_num  Index into seekpoint array to set.
1041  * \assert
1042  *    \code object != NULL \endcode
1043  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1044  *    \code object->data.seek_table.num_points > point_num \endcode
1045  * \retval FLAC__bool
1046  *    \c false if memory allocation error, else \c true.
1047  */
1048 FLAC_API FLAC__bool FLAC__metadata_object_seektable_delete_point(FLAC__StreamMetadata *object, unsigned point_num);
1049
1050 /** Check a seektable to see if it conforms to the FLAC specification.
1051  *  See the format specification for limits on the contents of the
1052  *  seektable.
1053  *
1054  * \param object  A pointer to an existing SEEKTABLE object.
1055  * \assert
1056  *    \code object != NULL \endcode
1057  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1058  * \retval FLAC__bool
1059  *    \c false if seek table is illegal, else \c true.
1060  */
1061 FLAC_API FLAC__bool FLAC__metadata_object_seektable_is_legal(const FLAC__StreamMetadata *object);
1062
1063 /** Append a number of placeholder points to the end of a seek table.
1064  *
1065  * \note
1066  * As with the other ..._seektable_template_... functions, you should
1067  * call FLAC__metadata_object_seektable_template_sort() when finished
1068  * to make the seek table legal.
1069  *
1070  * \param object  A pointer to an existing SEEKTABLE object.
1071  * \param num     The number of placeholder points to append.
1072  * \assert
1073  *    \code object != NULL \endcode
1074  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1075  * \retval FLAC__bool
1076  *    \c false if memory allocation fails, else \c true.
1077  */
1078 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_placeholders(FLAC__StreamMetadata *object, unsigned num);
1079
1080 /** Append a specific seek point template to the end of a seek table.
1081  *
1082  * \note
1083  * As with the other ..._seektable_template_... functions, you should
1084  * call FLAC__metadata_object_seektable_template_sort() when finished
1085  * to make the seek table legal.
1086  *
1087  * \param object  A pointer to an existing SEEKTABLE object.
1088  * \param sample_number  The sample number of the seek point template.
1089  * \assert
1090  *    \code object != NULL \endcode
1091  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1092  * \retval FLAC__bool
1093  *    \c false if memory allocation fails, else \c true.
1094  */
1095 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_point(FLAC__StreamMetadata *object, FLAC__uint64 sample_number);
1096
1097 /** Append specific seek point templates to the end of a seek table.
1098  *
1099  * \note
1100  * As with the other ..._seektable_template_... functions, you should
1101  * call FLAC__metadata_object_seektable_template_sort() when finished
1102  * to make the seek table legal.
1103  *
1104  * \param object  A pointer to an existing SEEKTABLE object.
1105  * \param sample_numbers  An array of sample numbers for the seek points.
1106  * \param num     The number of seek point templates to append.
1107  * \assert
1108  *    \code object != NULL \endcode
1109  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1110  * \retval FLAC__bool
1111  *    \c false if memory allocation fails, else \c true.
1112  */
1113 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_points(FLAC__StreamMetadata *object, FLAC__uint64 sample_numbers[], unsigned num);
1114
1115 /** Append a set of evenly-spaced seek point templates to the end of a
1116  *  seek table.
1117  *
1118  * \note
1119  * As with the other ..._seektable_template_... functions, you should
1120  * call FLAC__metadata_object_seektable_template_sort() when finished
1121  * to make the seek table legal.
1122  *
1123  * \param object  A pointer to an existing SEEKTABLE object.
1124  * \param num     The number of placeholder points to append.
1125  * \param total_samples  The total number of samples to be encoded;
1126  *                       the seekpoints will be spaced approximately
1127  *                       \a total_samples / \a num samples apart.
1128  * \assert
1129  *    \code object != NULL \endcode
1130  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1131  * \retval FLAC__bool
1132  *    \c false if memory allocation fails, else \c true.
1133  */
1134 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_spaced_points(FLAC__StreamMetadata *object, unsigned num, FLAC__uint64 total_samples);
1135
1136 /** Sort a seek table's seek points according to the format specification,
1137  *  removing duplicates.
1138  *
1139  * \param object   A pointer to a seek table to be sorted.
1140  * \param compact  If \c false, behaves like FLAC__format_seektable_sort().
1141  *                 If \c true, duplicates are deleted and the seek table is
1142  *                 shrunk appropriately; the number of placeholder points
1143  *                 present in the seek table will be the same after the call
1144  *                 as before.
1145  * \assert
1146  *    \code object != NULL \endcode
1147  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1148  * \retval FLAC__bool
1149  *    \c false if realloc fails, else \c true.
1150  */
1151 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_sort(FLAC__StreamMetadata *object, FLAC__bool compact);
1152
1153 /** Sets the vendor string in a VORBIS_COMMENT block.
1154  *
1155  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1156  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1157  *  \a copy == \c true and malloc fails.
1158  *
1159  * \param object  A pointer to an existing VORBIS_COMMENT object.
1160  * \param entry   The entry to set the vendor string to.
1161  * \param copy    See above.
1162  * \assert
1163  *    \code object != NULL \endcode
1164  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1165  *    \code (entry->entry != NULL && entry->length > 0) ||
1166  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1167  * \retval FLAC__bool
1168  *    \c false if \a copy is \c true and malloc fails, else \c true.
1169  */
1170 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_set_vendor_string(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1171
1172 /** Resize the comment array.
1173  *
1174  *  If the size shrinks, elements will truncated; if it grows, new empty
1175  *  fields will be added to the end.
1176  *
1177  * \param object            A pointer to an existing VORBIS_COMMENT object.
1178  * \param new_num_comments  The desired length of the array; may be \c 0.
1179  * \assert
1180  *    \code object != NULL \endcode
1181  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1182  *    \code (object->data.vorbis_comment.comments == NULL && object->data.vorbis_comment.num_comments == 0) ||
1183  * (object->data.vorbis_comment.comments != NULL && object->data.vorbis_comment.num_comments > 0) \endcode
1184  * \retval FLAC__bool
1185  *    \c false if memory allocation error, else \c true.
1186  */
1187 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_resize_comments(FLAC__StreamMetadata *object, unsigned new_num_comments);
1188
1189 /** Sets a comment in a VORBIS_COMMENT block.
1190  *
1191  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1192  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1193  *  \a copy == \c true and malloc fails.
1194  *
1195  * \param object       A pointer to an existing VORBIS_COMMENT object.
1196  * \param comment_num  Index into comment array to set.
1197  * \param entry        The entry to set the comment to.
1198  * \param copy         See above.
1199  * \assert
1200  *    \code object != NULL \endcode
1201  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1202  *    \code comment_num < object->data.vorbis_comment.num_comments \endcode
1203  *    \code (entry->entry != NULL && entry->length > 0) ||
1204  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1205  * \retval FLAC__bool
1206  *    \c false if \a copy is \c true and malloc fails, else \c true.
1207  */
1208 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_set_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1209
1210 /** Insert a comment in a VORBIS_COMMENT block at the given index.
1211  *
1212  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1213  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1214  *  \a copy == \c true and malloc fails.
1215  *
1216  * \param object       A pointer to an existing VORBIS_COMMENT object.
1217  * \param comment_num  The index at which to insert the comment.  The comments
1218  *                     at and after \a comment_num move right one position.
1219  *                     To append a comment to the end, set \a comment_num to
1220  *                     \c object->data.vorbis_comment.num_comments .
1221  * \param entry        The comment to insert.
1222  * \param copy         See above.
1223  * \assert
1224  *    \code object != NULL \endcode
1225  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1226  *    \code object->data.vorbis_comment.num_comments >= comment_num \endcode
1227  *    \code (entry->entry != NULL && entry->length > 0) ||
1228  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1229  * \retval FLAC__bool
1230  *    \c false if \a copy is \c true and malloc fails, else \c true.
1231  */
1232 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_insert_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1233
1234 /** Delete a comment in a VORBIS_COMMENT block at the given index.
1235  *
1236  * \param object       A pointer to an existing VORBIS_COMMENT object.
1237  * \param comment_num  The index of the comment to delete.
1238  * \assert
1239  *    \code object != NULL \endcode
1240  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1241  *    \code object->data.vorbis_comment.num_comments > comment_num \endcode
1242  *    \code (entry->entry != NULL && entry->length > 0) ||
1243  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1244  * \retval FLAC__bool
1245  *    \c false if realloc fails, else \c true.
1246  */
1247 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_delete_comment(FLAC__StreamMetadata *object, unsigned comment_num);
1248
1249 /*@@@@ add to unit tests */
1250 /** Check if the given Vorbis comment entry's field name matches the given
1251  *  field name.
1252  *
1253  * \param entry              A pointer to an existing Vorbis comment entry.
1254  * \param field_name         The field name to check.
1255  * \param field_name_length  The length of \a field_name, not including the
1256  *                           terminating \c NULL.
1257  * \assert
1258  *    \code entry != NULL \endcode
1259  *    \code (entry->entry != NULL && entry->length > 0) \endcode
1260  * \retval FLAC__bool
1261  *    \c true if the field names match, else \c false
1262  */
1263 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_entry_matches(const FLAC__StreamMetadata_VorbisComment_Entry *entry, const char *field_name, unsigned field_name_length);
1264
1265 /*@@@@ add to unit tests */
1266 /** Find a Vorbis comment with the given field name.
1267  *
1268  *  The search begins at entry number \a offset; use and offset of 0 to
1269  *  search from the beginning of the comment array.
1270  *
1271  * \param object      A pointer to an existing VORBIS_COMMENT object.
1272  * \param offset      The offset into the comment array from where to start
1273  *                    the search.
1274  * \param field_name  The field name of the comment to find.
1275  * \assert
1276  *    \code object != NULL \endcode
1277  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1278  * \retval int
1279  *    The offset in the comment array of the first comment whose field
1280  *    name matches \a field_name, or \c -1 if no match was found.
1281  */
1282 FLAC_API int FLAC__metadata_object_vorbiscomment_find_entry_from(const FLAC__StreamMetadata *object, unsigned offset, const char *field_name);
1283
1284 /*@@@@ add to unit tests */
1285 /** Remove first Vorbis comment matching the given field name.
1286  *
1287  * \param object      A pointer to an existing VORBIS_COMMENT object.
1288  * \param field_name  The field name of comment to delete.
1289  * \assert
1290  *    \code object != NULL \endcode
1291  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1292  * \retval int
1293  *    \c -1 for memory allocation error, \c 0 for no matching entries,
1294  *    \c 1 for one matching entry deleted.
1295  */
1296 FLAC_API int FLAC__metadata_object_vorbiscomment_remove_entry_matching(FLAC__StreamMetadata *object, const char *field_name);
1297
1298 /*@@@@ add to unit tests */
1299 /** Remove all Vorbis comments matching the given field name.
1300  *
1301  * \param object      A pointer to an existing VORBIS_COMMENT object.
1302  * \param field_name  The field name of comments to delete.
1303  * \assert
1304  *    \code object != NULL \endcode
1305  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1306  * \retval int
1307  *    \c -1 for memory allocation error, \c 0 for no matching entries,
1308  *    else the number of matching entries deleted.
1309  */
1310 FLAC_API int FLAC__metadata_object_vorbiscomment_remove_entries_matching(FLAC__StreamMetadata *object, const char *field_name);
1311
1312 /** Create a new CUESHEET track instance.
1313  *
1314  *  The object will be "empty"; i.e. values and data pointers will be \c 0.
1315  *
1316  * \retval FLAC__StreamMetadata_CueSheet_Track*
1317  *    \c NULL if there was an error allocating memory, else the new instance.
1318  */
1319 FLAC_API FLAC__StreamMetadata_CueSheet_Track *FLAC__metadata_object_cuesheet_track_new();
1320
1321 /** Create a copy of an existing CUESHEET track object.
1322  *
1323  *  The copy is a "deep" copy, i.e. dynamically allocated data within the
1324  *  object is also copied.  The caller takes ownership of the new object and
1325  *  is responsible for freeing it with
1326  *  FLAC__metadata_object_cuesheet_track_delete().
1327  *
1328  * \param object  Pointer to object to copy.
1329  * \assert
1330  *    \code object != NULL \endcode
1331  * \retval FLAC__StreamMetadata_CueSheet_Track*
1332  *    \c NULL if there was an error allocating memory, else the new instance.
1333  */
1334 FLAC_API FLAC__StreamMetadata_CueSheet_Track *FLAC__metadata_object_cuesheet_track_clone(const FLAC__StreamMetadata_CueSheet_Track *object);
1335
1336 /** Delete a CUESHEET track object
1337  *
1338  * \param object       A pointer to an existing CUESHEET track object.
1339  * \assert
1340  *    \code object != NULL \endcode
1341  */
1342 FLAC_API void FLAC__metadata_object_cuesheet_track_delete(FLAC__StreamMetadata_CueSheet_Track *object);
1343
1344 /** Resize a track's index point array.
1345  *
1346  *  If the size shrinks, elements will truncated; if it grows, new blank
1347  *  indices will be added to the end.
1348  *
1349  * \param object           A pointer to an existing CUESHEET object.
1350  * \param track_num        The index of the track to modify.  NOTE: this is not
1351  *                         necessarily the same as the track's \a number field.
1352  * \param new_num_indices  The desired length of the array; may be \c 0.
1353  * \assert
1354  *    \code object != NULL \endcode
1355  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1356  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1357  *    \code (object->data.cue_sheet.tracks[track_num].indices == NULL && object->data.cue_sheet.tracks[track_num].num_indices == 0) ||
1358  * (object->data.cue_sheet.tracks[track_num].indices != NULL && object->data.cue_sheet.tracks[track_num].num_indices > 0) \endcode
1359  * \retval FLAC__bool
1360  *    \c false if memory allocation error, else \c true.
1361  */
1362 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_resize_indices(FLAC__StreamMetadata *object, unsigned track_num, unsigned new_num_indices);
1363
1364 /** Insert an index point in a CUESHEET track at the given index.
1365  *
1366  * \param object       A pointer to an existing CUESHEET object.
1367  * \param track_num    The index of the track to modify.  NOTE: this is not
1368  *                     necessarily the same as the track's \a number field.
1369  * \param index_num    The index into the track's index array at which to
1370  *                     insert the index point.  NOTE: this is not necessarily
1371  *                     the same as the index point's \a number field.  The
1372  *                     indices at and after \a index_num move right one
1373  *                     position.  To append an index point to the end, set
1374  *                     \a index_num to
1375  *                     \c object->data.cue_sheet.tracks[track_num].num_indices .
1376  * \param index        The index point to insert.
1377  * \assert
1378  *    \code object != NULL \endcode
1379  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1380  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1381  *    \code object->data.cue_sheet.tracks[track_num].num_indices >= index_num \endcode
1382  * \retval FLAC__bool
1383  *    \c false if realloc fails, else \c true.
1384  */
1385 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_insert_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num, FLAC__StreamMetadata_CueSheet_Index index);
1386
1387 /** Insert a blank index point in a CUESHEET track at the given index.
1388  *
1389  *  A blank index point is one in which all field values are zero.
1390  *
1391  * \param object       A pointer to an existing CUESHEET object.
1392  * \param track_num    The index of the track to modify.  NOTE: this is not
1393  *                     necessarily the same as the track's \a number field.
1394  * \param index_num    The index into the track's index array at which to
1395  *                     insert the index point.  NOTE: this is not necessarily
1396  *                     the same as the index point's \a number field.  The
1397  *                     indices at and after \a index_num move right one
1398  *                     position.  To append an index point to the end, set
1399  *                     \a index_num to
1400  *                     \c object->data.cue_sheet.tracks[track_num].num_indices .
1401  * \assert
1402  *    \code object != NULL \endcode
1403  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1404  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1405  *    \code object->data.cue_sheet.tracks[track_num].num_indices >= index_num \endcode
1406  * \retval FLAC__bool
1407  *    \c false if realloc fails, else \c true.
1408  */
1409 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_insert_blank_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num);
1410
1411 /** Delete an index point in a CUESHEET track at the given index.
1412  *
1413  * \param object       A pointer to an existing CUESHEET object.
1414  * \param track_num    The index into the track array of the track to
1415  *                     modify.  NOTE: this is not necessarily the same
1416  *                     as the track's \a number field.
1417  * \param index_num    The index into the track's index array of the index
1418  *                     to delete.  NOTE: this is not necessarily the same
1419  *                     as the index's \a number field.
1420  * \assert
1421  *    \code object != NULL \endcode
1422  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1423  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1424  *    \code object->data.cue_sheet.tracks[track_num].num_indices > index_num \endcode
1425  * \retval FLAC__bool
1426  *    \c false if realloc fails, else \c true.
1427  */
1428 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_delete_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num);
1429
1430 /** Resize the track array.
1431  *
1432  *  If the size shrinks, elements will truncated; if it grows, new blank
1433  *  tracks will be added to the end.
1434  *
1435  * \param object            A pointer to an existing CUESHEET object.
1436  * \param new_num_tracks    The desired length of the array; may be \c 0.
1437  * \assert
1438  *    \code object != NULL \endcode
1439  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1440  *    \code (object->data.cue_sheet.tracks == NULL && object->data.cue_sheet.num_tracks == 0) ||
1441  * (object->data.cue_sheet.tracks != NULL && object->data.cue_sheet.num_tracks > 0) \endcode
1442  * \retval FLAC__bool
1443  *    \c false if memory allocation error, else \c true.
1444  */
1445 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_resize_tracks(FLAC__StreamMetadata *object, unsigned new_num_tracks);
1446
1447 /** Sets a track in a CUESHEET block.
1448  *
1449  *  If \a copy is \c true, a copy of the track is stored; otherwise, the object
1450  *  takes ownership of the \a track pointer.  Returns \c false if
1451  *  \a copy == \c true and malloc fails.
1452  *
1453  * \param object       A pointer to an existing CUESHEET object.
1454  * \param track_num    Index into track array to set.  NOTE: this is not
1455  *                     necessarily the same as the track's \a number field.
1456  * \param track        The track to set the track to.  You may safely pass in
1457  *                     a const pointer if \a copy is \c true.
1458  * \param copy         See above.
1459  * \assert
1460  *    \code object != NULL \endcode
1461  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1462  *    \code track_num < object->data.cue_sheet.num_tracks \endcode
1463  *    \code (track->indices != NULL && track->num_indices > 0) ||
1464  * (track->indices == NULL && track->num_indices == 0)
1465  * \retval FLAC__bool
1466  *    \c false if \a copy is \c true and malloc fails, else \c true.
1467  */
1468 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_set_track(FLAC__StreamMetadata *object, unsigned track_num, FLAC__StreamMetadata_CueSheet_Track *track, FLAC__bool copy);
1469
1470 /** Insert a track in a CUESHEET block at the given index.
1471  *
1472  *  If \a copy is \c true, a copy of the track is stored; otherwise, the object
1473  *  takes ownership of the \a track pointer.  Returns \c false if
1474  *  \a copy == \c true and malloc fails.
1475  *
1476  * \param object       A pointer to an existing CUESHEET object.
1477  * \param track_num    The index at which to insert the track.  NOTE: this
1478  *                     is not necessarily the same as the track's \a number
1479  *                     field.  The tracks at and after \a track_num move right
1480  *                     one position.  To append a track to the end, set
1481  *                     \a track_num to \c object->data.cue_sheet.num_tracks .
1482  * \param track        The track to insert.  You may safely pass in a const
1483  *                     pointer if \a copy is \c true.
1484  * \param copy         See above.
1485  * \assert
1486  *    \code object != NULL \endcode
1487  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1488  *    \code object->data.cue_sheet.num_tracks >= track_num \endcode
1489  * \retval FLAC__bool
1490  *    \c false if \a copy is \c true and malloc fails, else \c true.
1491  */
1492 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_insert_track(FLAC__StreamMetadata *object, unsigned track_num, FLAC__StreamMetadata_CueSheet_Track *track, FLAC__bool copy);
1493
1494 /** Insert a blank track in a CUESHEET block at the given index.
1495  *
1496  *  A blank track is one in which all field values are zero.
1497  *
1498  * \param object       A pointer to an existing CUESHEET object.
1499  * \param track_num    The index at which to insert the track.  NOTE: this
1500  *                     is not necessarily the same as the track's \a number
1501  *                     field.  The tracks at and after \a track_num move right
1502  *                     one position.  To append a track to the end, set
1503  *                     \a track_num to \c object->data.cue_sheet.num_tracks .
1504  * \assert
1505  *    \code object != NULL \endcode
1506  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1507  *    \code object->data.cue_sheet.num_tracks >= track_num \endcode
1508  * \retval FLAC__bool
1509  *    \c false if \a copy is \c true and malloc fails, else \c true.
1510  */
1511 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_insert_blank_track(FLAC__StreamMetadata *object, unsigned track_num);
1512
1513 /** Delete a track in a CUESHEET block at the given index.
1514  *
1515  * \param object       A pointer to an existing CUESHEET object.
1516  * \param track_num    The index into the track array of the track to
1517  *                     delete.  NOTE: this is not necessarily the same
1518  *                     as the track's \a number field.
1519  * \assert
1520  *    \code object != NULL \endcode
1521  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1522  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1523  * \retval FLAC__bool
1524  *    \c false if realloc fails, else \c true.
1525  */
1526 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_delete_track(FLAC__StreamMetadata *object, unsigned track_num);
1527
1528 /** Check a cue sheet to see if it conforms to the FLAC specification.
1529  *  See the format specification for limits on the contents of the
1530  *  cue sheet.
1531  *
1532  * \param object     A pointer to an existing CUESHEET object.
1533  * \param check_cd_da_subset  If \c true, check CUESHEET against more
1534  *                   stringent requirements for a CD-DA (audio) disc.
1535  * \param violation  Address of a pointer to a string.  If there is a
1536  *                   violation, a pointer to a string explanation of the
1537  *                   violation will be returned here. \a violation may be
1538  *                   \c NULL if you don't need the returned string.  Do not
1539  *                   free the returned string; it will always point to static
1540  *                   data.
1541  * \assert
1542  *    \code object != NULL \endcode
1543  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1544  * \retval FLAC__bool
1545  *    \c false if cue sheet is illegal, else \c true.
1546  */
1547 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_is_legal(const FLAC__StreamMetadata *object, FLAC__bool check_cd_da_subset, const char **violation);
1548
1549 /* \} */
1550
1551 #ifdef __cplusplus
1552 }
1553 #endif
1554
1555 #endif