add undocumented option to flac: --ignore-chunk-sizes
[flac.git] / include / FLAC / metadata.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2001,2002,2003,2004,2005,2006,2007  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
42    metaflac 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 native FLAC files.
63  *  Note that currently only the Chain interface (level 2) supports Ogg
64  *  FLAC files, and it is read-only i.e. no writing back changed
65  *  metadata to file.
66  *
67  *  There are three metadata interfaces of increasing complexity:
68  *
69  *  Level 0:
70  *  Read-only access to the STREAMINFO, VORBIS_COMMENT, CUESHEET, and
71  *  PICTURE blocks.
72  *
73  *  Level 1:
74  *  Read-write access to all metadata blocks.  This level is write-
75  *  efficient in most cases (more on this below), and uses less memory
76  *  than level 2.
77  *
78  *  Level 2:
79  *  Read-write access to all metadata blocks.  This level is write-
80  *  efficient in all cases, but uses more memory since all metadata for
81  *  the whole file is read into memory and manipulated before writing
82  *  out again.
83  *
84  *  What do we mean by efficient?  Since FLAC metadata appears at the
85  *  beginning of the file, when writing metadata back to a FLAC file
86  *  it is possible to grow or shrink the metadata such that the entire
87  *  file must be rewritten.  However, if the size remains the same during
88  *  changes or PADDING blocks are utilized, only the metadata needs to be
89  *  overwritten, which is much faster.
90  *
91  *  Efficient means the whole file is rewritten at most one time, and only
92  *  when necessary.  Level 1 is not efficient only in the case that you
93  *  cause more than one metadata block to grow or shrink beyond what can
94  *  be accomodated by padding.  In this case you should probably use level
95  *  2, which allows you to edit all the metadata for a file in memory and
96  *  write it out all at once.
97  *
98  *  All levels know how to skip over and not disturb an ID3v2 tag at the
99  *  front of the file.
100  *
101  *  All levels access files via their filenames.  In addition, level 2
102  *  has additional alternative read and write functions that take an I/O
103  *  handle and callbacks, for situations where access by filename is not
104  *  possible.
105  *
106  *  In addition to the three interfaces, this module defines functions for
107  *  creating and manipulating various metadata objects in memory.  As we see
108  *  from the Format module, FLAC metadata blocks in memory are very primitive
109  *  structures for storing information in an efficient way.  Reading
110  *  information from the structures is easy but creating or modifying them
111  *  directly is more complex.  The metadata object routines here facilitate
112  *  this by taking care of the consistency and memory management drudgery.
113  *
114  *  Unless you will be using the level 1 or 2 interfaces to modify existing
115  *  metadata however, you will not probably not need these.
116  *
117  *  From a dependency standpoint, none of the encoders or decoders require
118  *  the metadata module.  This is so that embedded users can strip out the
119  *  metadata module from libFLAC to reduce the size and complexity.
120  */
121
122 #ifdef __cplusplus
123 extern "C" {
124 #endif
125
126
127 /** \defgroup flac_metadata_level0 FLAC/metadata.h: metadata level 0 interface
128  *  \ingroup flac_metadata
129  *
130  *  \brief
131  *  The level 0 interface consists of individual routines to read the
132  *  STREAMINFO, VORBIS_COMMENT, CUESHEET, and PICTURE blocks, requiring
133  *  only a filename.
134  *
135  *  They try to skip any ID3v2 tag at the head of the file.
136  *
137  * \{
138  */
139
140 /** Read the STREAMINFO metadata block of the given FLAC file.  This function
141  *  will try to skip any ID3v2 tag at the head of the file.
142  *
143  * \param filename    The path to the FLAC file to read.
144  * \param streaminfo  A pointer to space for the STREAMINFO block.  Since
145  *                    FLAC__StreamMetadata is a simple structure with no
146  *                    memory allocation involved, you pass the address of
147  *                    an existing structure.  It need not be initialized.
148  * \assert
149  *    \code filename != NULL \endcode
150  *    \code streaminfo != NULL \endcode
151  * \retval FLAC__bool
152  *    \c true if a valid STREAMINFO block was read from \a filename.  Returns
153  *    \c false if there was a memory allocation error, a file decoder error,
154  *    or the file contained no STREAMINFO block.  (A memory allocation error
155  *    is possible because this function must set up a file decoder.)
156  */
157 FLAC_API FLAC__bool FLAC__metadata_get_streaminfo(const char *filename, FLAC__StreamMetadata *streaminfo);
158
159 /** Read the VORBIS_COMMENT metadata block of the given FLAC file.  This
160  *  function will try to skip any ID3v2 tag at the head of the file.
161  *
162  * \param filename    The path to the FLAC file to read.
163  * \param tags        The address where the returned pointer will be
164  *                    stored.  The \a tags object must be deleted by
165  *                    the caller using FLAC__metadata_object_delete().
166  * \assert
167  *    \code filename != NULL \endcode
168  *    \code tags != NULL \endcode
169  * \retval FLAC__bool
170  *    \c true if a valid VORBIS_COMMENT block was read from \a filename,
171  *    and \a *tags will be set to the address of the metadata structure.
172  *    Returns \c false if there was a memory allocation error, a file
173  *    decoder error, or the file contained no VORBIS_COMMENT block, and
174  *    \a *tags will be set to \c NULL.
175  */
176 FLAC_API FLAC__bool FLAC__metadata_get_tags(const char *filename, FLAC__StreamMetadata **tags);
177
178 /** Read the CUESHEET metadata block of the given FLAC file.  This
179  *  function will try to skip any ID3v2 tag at the head of the file.
180  *
181  * \param filename    The path to the FLAC file to read.
182  * \param cuesheet    The address where the returned pointer will be
183  *                    stored.  The \a cuesheet object must be deleted by
184  *                    the caller using FLAC__metadata_object_delete().
185  * \assert
186  *    \code filename != NULL \endcode
187  *    \code cuesheet != NULL \endcode
188  * \retval FLAC__bool
189  *    \c true if a valid CUESHEET block was read from \a filename,
190  *    and \a *cuesheet will be set to the address of the metadata
191  *    structure.  Returns \c false if there was a memory allocation
192  *    error, a file decoder error, or the file contained no CUESHEET
193  *    block, and \a *cuesheet will be set to \c NULL.
194  */
195 FLAC_API FLAC__bool FLAC__metadata_get_cuesheet(const char *filename, FLAC__StreamMetadata **cuesheet);
196
197 /** Read a PICTURE metadata block of the given FLAC file.  This
198  *  function will try to skip any ID3v2 tag at the head of the file.
199  *  Since there can be more than one PICTURE block in a file, this
200  *  function takes a number of parameters that act as constraints to
201  *  the search.  The PICTURE block with the largest area matching all
202  *  the constraints will be returned, or \a *picture will be set to
203  *  \c NULL if there was no such block.
204  *
205  * \param filename    The path to the FLAC file to read.
206  * \param picture     The address where the returned pointer will be
207  *                    stored.  The \a picture object must be deleted by
208  *                    the caller using FLAC__metadata_object_delete().
209  * \param type        The desired picture type.  Use \c -1 to mean
210  *                    "any type".
211  * \param mime_type   The desired MIME type, e.g. "image/jpeg".  The
212  *                    string will be matched exactly.  Use \c NULL to
213  *                    mean "any MIME type".
214  * \param description The desired description.  The string will be
215  *                    matched exactly.  Use \c NULL to mean "any
216  *                    description".
217  * \param max_width   The maximum width in pixels desired.  Use
218  *                    \c (unsigned)(-1) to mean "any width".
219  * \param max_height  The maximum height in pixels desired.  Use
220  *                    \c (unsigned)(-1) to mean "any height".
221  * \param max_depth   The maximum color depth in bits-per-pixel desired.
222  *                    Use \c (unsigned)(-1) to mean "any depth".
223  * \param max_colors  The maximum number of colors desired.  Use
224  *                    \c (unsigned)(-1) to mean "any number of colors".
225  * \assert
226  *    \code filename != NULL \endcode
227  *    \code picture != NULL \endcode
228  * \retval FLAC__bool
229  *    \c true if a valid PICTURE block was read from \a filename,
230  *    and \a *picture will be set to the address of the metadata
231  *    structure.  Returns \c false if there was a memory allocation
232  *    error, a file decoder error, or the file contained no PICTURE
233  *    block, and \a *picture will be set to \c NULL.
234  */
235 FLAC_API FLAC__bool FLAC__metadata_get_picture(const char *filename, FLAC__StreamMetadata **picture, FLAC__StreamMetadata_Picture_Type type, const char *mime_type, const FLAC__byte *description, unsigned max_width, unsigned max_height, unsigned max_depth, unsigned max_colors);
236
237 /* \} */
238
239
240 /** \defgroup flac_metadata_level1 FLAC/metadata.h: metadata level 1 interface
241  *  \ingroup flac_metadata
242  *
243  * \brief
244  * The level 1 interface provides read-write access to FLAC file metadata and
245  * operates directly on the FLAC file.
246  *
247  * The general usage of this interface is:
248  *
249  * - Create an iterator using FLAC__metadata_simple_iterator_new()
250  * - Attach it to a file using FLAC__metadata_simple_iterator_init() and check
251  *   the exit code.  Call FLAC__metadata_simple_iterator_is_writable() to
252  *   see if the file is writable, or only read access is allowed.
253  * - Use FLAC__metadata_simple_iterator_next() and
254  *   FLAC__metadata_simple_iterator_prev() to traverse the blocks.
255  *   This is does not read the actual blocks themselves.
256  *   FLAC__metadata_simple_iterator_next() is relatively fast.
257  *   FLAC__metadata_simple_iterator_prev() is slower since it needs to search
258  *   forward from the front of the file.
259  * - Use FLAC__metadata_simple_iterator_get_block_type() or
260  *   FLAC__metadata_simple_iterator_get_block() to access the actual data at
261  *   the current iterator position.  The returned object is yours to modify
262  *   and free.
263  * - Use FLAC__metadata_simple_iterator_set_block() to write a modified block
264  *   back.  You must have write permission to the original file.  Make sure to
265  *   read the whole comment to FLAC__metadata_simple_iterator_set_block()
266  *   below.
267  * - Use FLAC__metadata_simple_iterator_insert_block_after() to add new blocks.
268  *   Use the object creation functions from
269  *   \link flac_metadata_object here \endlink to generate new objects.
270  * - Use FLAC__metadata_simple_iterator_delete_block() to remove the block
271  *   currently referred to by the iterator, or replace it with padding.
272  * - Destroy the iterator with FLAC__metadata_simple_iterator_delete() when
273  *   finished.
274  *
275  * \note
276  * The FLAC file remains open the whole time between
277  * FLAC__metadata_simple_iterator_init() and
278  * FLAC__metadata_simple_iterator_delete(), so make sure you are not altering
279  * the file during this time.
280  *
281  * \note
282  * Do not modify the \a is_last, \a length, or \a type fields of returned
283  * FLAC__StreamMetadata objects.  These are managed automatically.
284  *
285  * \note
286  * If any of the modification functions
287  * (FLAC__metadata_simple_iterator_set_block(),
288  * FLAC__metadata_simple_iterator_delete_block(),
289  * FLAC__metadata_simple_iterator_insert_block_after(), etc.) return \c false,
290  * you should delete the iterator as it may no longer be valid.
291  *
292  * \{
293  */
294
295 struct FLAC__Metadata_SimpleIterator;
296 /** The opaque structure definition for the level 1 iterator type.
297  *  See the
298  *  \link flac_metadata_level1 metadata level 1 module \endlink
299  *  for a detailed description.
300  */
301 typedef struct FLAC__Metadata_SimpleIterator FLAC__Metadata_SimpleIterator;
302
303 /** Status type for FLAC__Metadata_SimpleIterator.
304  *
305  *  The iterator's current status can be obtained by calling FLAC__metadata_simple_iterator_status().
306  */
307 typedef enum {
308
309         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK = 0,
310         /**< The iterator is in the normal OK state */
311
312         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT,
313         /**< The data passed into a function violated the function's usage criteria */
314
315         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE,
316         /**< The iterator could not open the target file */
317
318         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE,
319         /**< The iterator could not find the FLAC signature at the start of the file */
320
321         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE,
322         /**< The iterator tried to write to a file that was not writable */
323
324         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA,
325         /**< The iterator encountered input that does not conform to the FLAC metadata specification */
326
327         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR,
328         /**< The iterator encountered an error while reading the FLAC file */
329
330         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR,
331         /**< The iterator encountered an error while seeking in the FLAC file */
332
333         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR,
334         /**< The iterator encountered an error while writing the FLAC file */
335
336         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR,
337         /**< The iterator encountered an error renaming the FLAC file */
338
339         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR,
340         /**< The iterator encountered an error removing the temporary file */
341
342         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR,
343         /**< Memory allocation failed */
344
345         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR
346         /**< The caller violated an assertion or an unexpected error occurred */
347
348 } FLAC__Metadata_SimpleIteratorStatus;
349
350 /** Maps a FLAC__Metadata_SimpleIteratorStatus to a C string.
351  *
352  *  Using a FLAC__Metadata_SimpleIteratorStatus as the index to this array
353  *  will give the string equivalent.  The contents should not be modified.
354  */
355 extern FLAC_API const char * const FLAC__Metadata_SimpleIteratorStatusString[];
356
357
358 /** Create a new iterator instance.
359  *
360  * \retval FLAC__Metadata_SimpleIterator*
361  *    \c NULL if there was an error allocating memory, else the new instance.
362  */
363 FLAC_API FLAC__Metadata_SimpleIterator *FLAC__metadata_simple_iterator_new(void);
364
365 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
366  *
367  * \param iterator  A pointer to an existing iterator.
368  * \assert
369  *    \code iterator != NULL \endcode
370  */
371 FLAC_API void FLAC__metadata_simple_iterator_delete(FLAC__Metadata_SimpleIterator *iterator);
372
373 /** Get the current status of the iterator.  Call this after a function
374  *  returns \c false to get the reason for the error.  Also resets the status
375  *  to FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK.
376  *
377  * \param iterator  A pointer to an existing iterator.
378  * \assert
379  *    \code iterator != NULL \endcode
380  * \retval FLAC__Metadata_SimpleIteratorStatus
381  *    The current status of the iterator.
382  */
383 FLAC_API FLAC__Metadata_SimpleIteratorStatus FLAC__metadata_simple_iterator_status(FLAC__Metadata_SimpleIterator *iterator);
384
385 /** Initialize the iterator to point to the first metadata block in the
386  *  given FLAC file.
387  *
388  * \param iterator             A pointer to an existing iterator.
389  * \param filename             The path to the FLAC file.
390  * \param read_only            If \c true, the FLAC file will be opened
391  *                             in read-only mode; if \c false, the FLAC
392  *                             file will be opened for edit even if no
393  *                             edits are performed.
394  * \param preserve_file_stats  If \c true, the owner and modification
395  *                             time will be preserved even if the FLAC
396  *                             file is written to.
397  * \assert
398  *    \code iterator != NULL \endcode
399  *    \code filename != NULL \endcode
400  * \retval FLAC__bool
401  *    \c false if a memory allocation error occurs, the file can't be
402  *    opened, or another error occurs, else \c true.
403  */
404 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);
405
406 /** Returns \c true if the FLAC file is writable.  If \c false, calls to
407  *  FLAC__metadata_simple_iterator_set_block() and
408  *  FLAC__metadata_simple_iterator_insert_block_after() will fail.
409  *
410  * \param iterator             A pointer to an existing iterator.
411  * \assert
412  *    \code iterator != NULL \endcode
413  * \retval FLAC__bool
414  *    See above.
415  */
416 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_is_writable(const FLAC__Metadata_SimpleIterator *iterator);
417
418 /** Moves the iterator forward one metadata block, returning \c false if
419  *  already at the end.
420  *
421  * \param iterator  A pointer to an existing initialized iterator.
422  * \assert
423  *    \code iterator != NULL \endcode
424  *    \a iterator has been successfully initialized with
425  *    FLAC__metadata_simple_iterator_init()
426  * \retval FLAC__bool
427  *    \c false if already at the last metadata block of the chain, else
428  *    \c true.
429  */
430 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_next(FLAC__Metadata_SimpleIterator *iterator);
431
432 /** Moves the iterator backward one metadata block, returning \c false if
433  *  already at the beginning.
434  *
435  * \param iterator  A pointer to an existing initialized iterator.
436  * \assert
437  *    \code iterator != NULL \endcode
438  *    \a iterator has been successfully initialized with
439  *    FLAC__metadata_simple_iterator_init()
440  * \retval FLAC__bool
441  *    \c false if already at the first metadata block of the chain, else
442  *    \c true.
443  */
444 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_prev(FLAC__Metadata_SimpleIterator *iterator);
445
446 /** Get the type of the metadata block at the current position.  This
447  *  avoids reading the actual block data which can save time for large
448  *  blocks.
449  *
450  * \param iterator  A pointer to an existing initialized iterator.
451  * \assert
452  *    \code iterator != NULL \endcode
453  *    \a iterator has been successfully initialized with
454  *    FLAC__metadata_simple_iterator_init()
455  * \retval FLAC__MetadataType
456  *    The type of the metadata block at the current iterator position.
457  */
458
459 FLAC_API FLAC__MetadataType FLAC__metadata_simple_iterator_get_block_type(const FLAC__Metadata_SimpleIterator *iterator);
460
461 /** Get the metadata block at the current position.  You can modify the
462  *  block but must use FLAC__metadata_simple_iterator_set_block() to
463  *  write it back to the FLAC file.
464  *
465  *  You must call FLAC__metadata_object_delete() on the returned object
466  *  when you are finished with it.
467  *
468  * \param iterator  A pointer to an existing initialized iterator.
469  * \assert
470  *    \code iterator != NULL \endcode
471  *    \a iterator has been successfully initialized with
472  *    FLAC__metadata_simple_iterator_init()
473  * \retval FLAC__StreamMetadata*
474  *    The current metadata block.
475  */
476 FLAC_API FLAC__StreamMetadata *FLAC__metadata_simple_iterator_get_block(FLAC__Metadata_SimpleIterator *iterator);
477
478 /** Write a block back to the FLAC file.  This function tries to be
479  *  as efficient as possible; how the block is actually written is
480  *  shown by the following:
481  *
482  *  Existing block is a STREAMINFO block and the new block is a
483  *  STREAMINFO block: the new block is written in place.  Make sure
484  *  you know what you're doing when changing the values of a
485  *  STREAMINFO block.
486  *
487  *  Existing block is a STREAMINFO block and the new block is a
488  *  not a STREAMINFO block: this is an error since the first block
489  *  must be a STREAMINFO block.  Returns \c false without altering the
490  *  file.
491  *
492  *  Existing block is not a STREAMINFO block and the new block is a
493  *  STREAMINFO block: this is an error since there may be only one
494  *  STREAMINFO block.  Returns \c false without altering the file.
495  *
496  *  Existing block and new block are the same length: the existing
497  *  block will be replaced by the new block, written in place.
498  *
499  *  Existing block is longer than new block: if use_padding is \c true,
500  *  the existing block will be overwritten in place with the new
501  *  block followed by a PADDING block, if possible, to make the total
502  *  size the same as the existing block.  Remember that a padding
503  *  block requires at least four bytes so if the difference in size
504  *  between the new block and existing block is less than that, the
505  *  entire file will have to be rewritten, using the new block's
506  *  exact size.  If use_padding is \c false, the entire file will be
507  *  rewritten, replacing the existing block by the new block.
508  *
509  *  Existing block is shorter than new block: if use_padding is \c true,
510  *  the function will try and expand the new block into the following
511  *  PADDING block, if it exists and doing so won't shrink the PADDING
512  *  block to less than 4 bytes.  If there is no following PADDING
513  *  block, or it will shrink to less than 4 bytes, or use_padding is
514  *  \c false, the entire file is rewritten, replacing the existing block
515  *  with the new block.  Note that in this case any following PADDING
516  *  block is preserved as is.
517  *
518  *  After writing the block, the iterator will remain in the same
519  *  place, i.e. pointing to the new block.
520  *
521  * \param iterator     A pointer to an existing initialized iterator.
522  * \param block        The block to set.
523  * \param use_padding  See above.
524  * \assert
525  *    \code iterator != NULL \endcode
526  *    \a iterator has been successfully initialized with
527  *    FLAC__metadata_simple_iterator_init()
528  *    \code block != NULL \endcode
529  * \retval FLAC__bool
530  *    \c true if successful, else \c false.
531  */
532 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_set_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
533
534 /** This is similar to FLAC__metadata_simple_iterator_set_block()
535  *  except that instead of writing over an existing block, it appends
536  *  a block after the existing block.  \a use_padding is again used to
537  *  tell the function to try an expand into following padding in an
538  *  attempt to avoid rewriting the entire file.
539  *
540  *  This function will fail and return \c false if given a STREAMINFO
541  *  block.
542  *
543  *  After writing the block, the iterator will be pointing to the
544  *  new block.
545  *
546  * \param iterator     A pointer to an existing initialized iterator.
547  * \param block        The block to set.
548  * \param use_padding  See above.
549  * \assert
550  *    \code iterator != NULL \endcode
551  *    \a iterator has been successfully initialized with
552  *    FLAC__metadata_simple_iterator_init()
553  *    \code block != NULL \endcode
554  * \retval FLAC__bool
555  *    \c true if successful, else \c false.
556  */
557 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_insert_block_after(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
558
559 /** Deletes the block at the current position.  This will cause the
560  *  entire FLAC file to be rewritten, unless \a use_padding is \c true,
561  *  in which case the block will be replaced by an equal-sized PADDING
562  *  block.  The iterator will be left pointing to the block before the
563  *  one just deleted.
564  *
565  *  You may not delete the STREAMINFO block.
566  *
567  * \param iterator     A pointer to an existing initialized iterator.
568  * \param use_padding  See above.
569  * \assert
570  *    \code iterator != NULL \endcode
571  *    \a iterator has been successfully initialized with
572  *    FLAC__metadata_simple_iterator_init()
573  * \retval FLAC__bool
574  *    \c true if successful, else \c false.
575  */
576 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_delete_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__bool use_padding);
577
578 /* \} */
579
580
581 /** \defgroup flac_metadata_level2 FLAC/metadata.h: metadata level 2 interface
582  *  \ingroup flac_metadata
583  *
584  * \brief
585  * The level 2 interface provides read-write access to FLAC file metadata;
586  * all metadata is read into memory, operated on in memory, and then written
587  * to file, which is more efficient than level 1 when editing multiple blocks.
588  *
589  * Currently Ogg FLAC is supported for read only, via
590  * FLAC__metadata_chain_read_ogg() but a subsequent
591  * FLAC__metadata_chain_write() will fail.
592  *
593  * The general usage of this interface is:
594  *
595  * - Create a new chain using FLAC__metadata_chain_new().  A chain is a
596  *   linked list of FLAC metadata blocks.
597  * - Read all metadata into the the chain from a FLAC file using
598  *   FLAC__metadata_chain_read() or FLAC__metadata_chain_read_ogg() and
599  *   check the status.
600  * - Optionally, consolidate the padding using
601  *   FLAC__metadata_chain_merge_padding() or
602  *   FLAC__metadata_chain_sort_padding().
603  * - Create a new iterator using FLAC__metadata_iterator_new()
604  * - Initialize the iterator to point to the first element in the chain
605  *   using FLAC__metadata_iterator_init()
606  * - Traverse the chain using FLAC__metadata_iterator_next and
607  *   FLAC__metadata_iterator_prev().
608  * - Get a block for reading or modification using
609  *   FLAC__metadata_iterator_get_block().  The pointer to the object
610  *   inside the chain is returned, so the block is yours to modify.
611  *   Changes will be reflected in the FLAC file when you write the
612  *   chain.  You can also add and delete blocks (see functions below).
613  * - When done, write out the chain using FLAC__metadata_chain_write().
614  *   Make sure to read the whole comment to the function below.
615  * - Delete the chain using FLAC__metadata_chain_delete().
616  *
617  * \note
618  * Even though the FLAC file is not open while the chain is being
619  * manipulated, you must not alter the file externally during
620  * this time.  The chain assumes the FLAC file will not change
621  * between the time of FLAC__metadata_chain_read()/FLAC__metadata_chain_read_ogg()
622  * and FLAC__metadata_chain_write().
623  *
624  * \note
625  * Do not modify the is_last, length, or type fields of returned
626  * FLAC__StreamMetadata objects.  These are managed automatically.
627  *
628  * \note
629  * The metadata objects returned by FLAC__metadata_iterator_get_block()
630  * are owned by the chain; do not FLAC__metadata_object_delete() them.
631  * In the same way, blocks passed to FLAC__metadata_iterator_set_block()
632  * become owned by the chain and they will be deleted when the chain is
633  * deleted.
634  *
635  * \{
636  */
637
638 struct FLAC__Metadata_Chain;
639 /** The opaque structure definition for the level 2 chain type.
640  */
641 typedef struct FLAC__Metadata_Chain FLAC__Metadata_Chain;
642
643 struct FLAC__Metadata_Iterator;
644 /** The opaque structure definition for the level 2 iterator type.
645  */
646 typedef struct FLAC__Metadata_Iterator FLAC__Metadata_Iterator;
647
648 typedef enum {
649         FLAC__METADATA_CHAIN_STATUS_OK = 0,
650         /**< The chain is in the normal OK state */
651
652         FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT,
653         /**< The data passed into a function violated the function's usage criteria */
654
655         FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE,
656         /**< The chain could not open the target file */
657
658         FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE,
659         /**< The chain could not find the FLAC signature at the start of the file */
660
661         FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE,
662         /**< The chain tried to write to a file that was not writable */
663
664         FLAC__METADATA_CHAIN_STATUS_BAD_METADATA,
665         /**< The chain encountered input that does not conform to the FLAC metadata specification */
666
667         FLAC__METADATA_CHAIN_STATUS_READ_ERROR,
668         /**< The chain encountered an error while reading the FLAC file */
669
670         FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR,
671         /**< The chain encountered an error while seeking in the FLAC file */
672
673         FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR,
674         /**< The chain encountered an error while writing the FLAC file */
675
676         FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR,
677         /**< The chain encountered an error renaming the FLAC file */
678
679         FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR,
680         /**< The chain encountered an error removing the temporary file */
681
682         FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR,
683         /**< Memory allocation failed */
684
685         FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR,
686         /**< The caller violated an assertion or an unexpected error occurred */
687
688         FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS,
689         /**< One or more of the required callbacks was NULL */
690
691         FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH,
692         /**< FLAC__metadata_chain_write() was called on a chain read by
693          *   FLAC__metadata_chain_read_with_callbacks()/FLAC__metadata_chain_read_ogg_with_callbacks(),
694          *   or 
695          *   FLAC__metadata_chain_write_with_callbacks()/FLAC__metadata_chain_write_with_callbacks_and_tempfile()
696          *   was called on a chain read by
697          *   FLAC__metadata_chain_read()/FLAC__metadata_chain_read_ogg().
698          *   Matching read/write methods must always be used. */
699
700         FLAC__METADATA_CHAIN_STATUS_WRONG_WRITE_CALL
701         /**< FLAC__metadata_chain_write_with_callbacks() was called when the
702          *   chain write requires a tempfile; use
703          *   FLAC__metadata_chain_write_with_callbacks_and_tempfile() instead.
704          *   Or, FLAC__metadata_chain_write_with_callbacks_and_tempfile() was
705          *   called when the chain write does not require a tempfile; use
706          *   FLAC__metadata_chain_write_with_callbacks() instead.
707          *   Always check FLAC__metadata_chain_check_if_tempfile_needed()
708          *   before writing via callbacks. */
709
710 } FLAC__Metadata_ChainStatus;
711
712 /** Maps a FLAC__Metadata_ChainStatus to a C string.
713  *
714  *  Using a FLAC__Metadata_ChainStatus as the index to this array
715  *  will give the string equivalent.  The contents should not be modified.
716  */
717 extern FLAC_API const char * const FLAC__Metadata_ChainStatusString[];
718
719 /*********** FLAC__Metadata_Chain ***********/
720
721 /** Create a new chain instance.
722  *
723  * \retval FLAC__Metadata_Chain*
724  *    \c NULL if there was an error allocating memory, else the new instance.
725  */
726 FLAC_API FLAC__Metadata_Chain *FLAC__metadata_chain_new(void);
727
728 /** Free a chain instance.  Deletes the object pointed to by \a chain.
729  *
730  * \param chain  A pointer to an existing chain.
731  * \assert
732  *    \code chain != NULL \endcode
733  */
734 FLAC_API void FLAC__metadata_chain_delete(FLAC__Metadata_Chain *chain);
735
736 /** Get the current status of the chain.  Call this after a function
737  *  returns \c false to get the reason for the error.  Also resets the
738  *  status to FLAC__METADATA_CHAIN_STATUS_OK.
739  *
740  * \param chain    A pointer to an existing chain.
741  * \assert
742  *    \code chain != NULL \endcode
743  * \retval FLAC__Metadata_ChainStatus
744  *    The current status of the chain.
745  */
746 FLAC_API FLAC__Metadata_ChainStatus FLAC__metadata_chain_status(FLAC__Metadata_Chain *chain);
747
748 /** Read all metadata from a FLAC file into the chain.
749  *
750  * \param chain    A pointer to an existing chain.
751  * \param filename The path to the FLAC file to read.
752  * \assert
753  *    \code chain != NULL \endcode
754  *    \code filename != NULL \endcode
755  * \retval FLAC__bool
756  *    \c true if a valid list of metadata blocks was read from
757  *    \a filename, else \c false.  On failure, check the status with
758  *    FLAC__metadata_chain_status().
759  */
760 FLAC_API FLAC__bool FLAC__metadata_chain_read(FLAC__Metadata_Chain *chain, const char *filename);
761
762 /*@@@@ add to unit tests*/
763 /** Read all metadata from an Ogg FLAC file into the chain.
764  *
765  * \note Ogg FLAC metadata data writing is not supported yet and
766  * FLAC__metadata_chain_write() will fail.
767  *
768  * \param chain    A pointer to an existing chain.
769  * \param filename The path to the Ogg FLAC file to read.
770  * \assert
771  *    \code chain != NULL \endcode
772  *    \code filename != NULL \endcode
773  * \retval FLAC__bool
774  *    \c true if a valid list of metadata blocks was read from
775  *    \a filename, else \c false.  On failure, check the status with
776  *    FLAC__metadata_chain_status().
777  */
778 FLAC_API FLAC__bool FLAC__metadata_chain_read_ogg(FLAC__Metadata_Chain *chain, const char *filename);
779
780 /** Read all metadata from a FLAC stream into the chain via I/O callbacks.
781  *
782  *  The \a handle need only be open for reading, but must be seekable.
783  *  The equivalent minimum stdio fopen() file mode is \c "r" (or \c "rb"
784  *  for Windows).
785  *
786  * \param chain    A pointer to an existing chain.
787  * \param handle   The I/O handle of the FLAC stream to read.  The
788  *                 handle will NOT be closed after the metadata is read;
789  *                 that is the duty of the caller.
790  * \param callbacks
791  *                 A set of callbacks to use for I/O.  The mandatory
792  *                 callbacks are \a read, \a seek, and \a tell.
793  * \assert
794  *    \code chain != NULL \endcode
795  * \retval FLAC__bool
796  *    \c true if a valid list of metadata blocks was read from
797  *    \a handle, else \c false.  On failure, check the status with
798  *    FLAC__metadata_chain_status().
799  */
800 FLAC_API FLAC__bool FLAC__metadata_chain_read_with_callbacks(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks);
801
802 /*@@@@ add to unit tests*/
803 /** Read all metadata from an Ogg FLAC stream into the chain via I/O callbacks.
804  *
805  *  The \a handle need only be open for reading, but must be seekable.
806  *  The equivalent minimum stdio fopen() file mode is \c "r" (or \c "rb"
807  *  for Windows).
808  *
809  * \note Ogg FLAC metadata data writing is not supported yet and
810  * FLAC__metadata_chain_write() will fail.
811  *
812  * \param chain    A pointer to an existing chain.
813  * \param handle   The I/O handle of the Ogg FLAC stream to read.  The
814  *                 handle will NOT be closed after the metadata is read;
815  *                 that is the duty of the caller.
816  * \param callbacks
817  *                 A set of callbacks to use for I/O.  The mandatory
818  *                 callbacks are \a read, \a seek, and \a tell.
819  * \assert
820  *    \code chain != NULL \endcode
821  * \retval FLAC__bool
822  *    \c true if a valid list of metadata blocks was read from
823  *    \a handle, else \c false.  On failure, check the status with
824  *    FLAC__metadata_chain_status().
825  */
826 FLAC_API FLAC__bool FLAC__metadata_chain_read_ogg_with_callbacks(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks);
827
828 /** Checks if writing the given chain would require the use of a
829  *  temporary file, or if it could be written in place.
830  *
831  *  Under certain conditions, padding can be utilized so that writing
832  *  edited metadata back to the FLAC file does not require rewriting the
833  *  entire file.  If rewriting is required, then a temporary workfile is
834  *  required.  When writing metadata using callbacks, you must check
835  *  this function to know whether to call
836  *  FLAC__metadata_chain_write_with_callbacks() or
837  *  FLAC__metadata_chain_write_with_callbacks_and_tempfile().  When
838  *  writing with FLAC__metadata_chain_write(), the temporary file is
839  *  handled internally.
840  *
841  * \param chain    A pointer to an existing chain.
842  * \param use_padding
843  *                 Whether or not padding will be allowed to be used
844  *                 during the write.  The value of \a use_padding given
845  *                 here must match the value later passed to
846  *                 FLAC__metadata_chain_write_with_callbacks() or
847  *                 FLAC__metadata_chain_write_with_callbacks_with_tempfile().
848  * \assert
849  *    \code chain != NULL \endcode
850  * \retval FLAC__bool
851  *    \c true if writing the current chain would require a tempfile, or
852  *    \c false if metadata can be written in place.
853  */
854 FLAC_API FLAC__bool FLAC__metadata_chain_check_if_tempfile_needed(FLAC__Metadata_Chain *chain, FLAC__bool use_padding);
855
856 /** Write all metadata out to the FLAC file.  This function tries to be as
857  *  efficient as possible; how the metadata is actually written is shown by
858  *  the following:
859  *
860  *  If the current chain is the same size as the existing metadata, the new
861  *  data is written in place.
862  *
863  *  If the current chain is longer than the existing metadata, and
864  *  \a use_padding is \c true, and the last block is a PADDING block of
865  *  sufficient length, the function will truncate the final padding block
866  *  so that the overall size of the metadata is the same as the existing
867  *  metadata, and then just rewrite the metadata.  Otherwise, if not all of
868  *  the above conditions are met, the entire FLAC file must be rewritten.
869  *  If you want to use padding this way it is a good idea to call
870  *  FLAC__metadata_chain_sort_padding() first so that you have the maximum
871  *  amount of padding to work with, unless you need to preserve ordering
872  *  of the PADDING blocks for some reason.
873  *
874  *  If the current chain is shorter than the existing metadata, and
875  *  \a use_padding is \c true, and the final block is a PADDING block, the padding
876  *  is extended to make the overall size the same as the existing data.  If
877  *  \a use_padding is \c true and the last block is not a PADDING block, a new
878  *  PADDING block is added to the end of the new data to make it the same
879  *  size as the existing data (if possible, see the note to
880  *  FLAC__metadata_simple_iterator_set_block() about the four byte limit)
881  *  and the new data is written in place.  If none of the above apply or
882  *  \a use_padding is \c false, the entire FLAC file is rewritten.
883  *
884  *  If \a preserve_file_stats is \c true, the owner and modification time will
885  *  be preserved even if the FLAC file is written.
886  *
887  *  For this write function to be used, the chain must have been read with
888  *  FLAC__metadata_chain_read()/FLAC__metadata_chain_read_ogg(), not
889  *  FLAC__metadata_chain_read_with_callbacks()/FLAC__metadata_chain_read_ogg_with_callbacks().
890  *
891  * \param chain               A pointer to an existing chain.
892  * \param use_padding         See above.
893  * \param preserve_file_stats See above.
894  * \assert
895  *    \code chain != NULL \endcode
896  * \retval FLAC__bool
897  *    \c true if the write succeeded, else \c false.  On failure,
898  *    check the status with FLAC__metadata_chain_status().
899  */
900 FLAC_API FLAC__bool FLAC__metadata_chain_write(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__bool preserve_file_stats);
901
902 /** Write all metadata out to a FLAC stream via callbacks.
903  *
904  *  (See FLAC__metadata_chain_write() for the details on how padding is
905  *  used to write metadata in place if possible.)
906  *
907  *  The \a handle must be open for updating and be seekable.  The
908  *  equivalent minimum stdio fopen() file mode is \c "r+" (or \c "r+b"
909  *  for Windows).
910  *
911  *  For this write function to be used, the chain must have been read with
912  *  FLAC__metadata_chain_read_with_callbacks()/FLAC__metadata_chain_read_ogg_with_callbacks(),
913  *  not FLAC__metadata_chain_read()/FLAC__metadata_chain_read_ogg().
914  *  Also, FLAC__metadata_chain_check_if_tempfile_needed() must have returned
915  *  \c false.
916  *
917  * \param chain        A pointer to an existing chain.
918  * \param use_padding  See FLAC__metadata_chain_write()
919  * \param handle       The I/O handle of the FLAC stream to write.  The
920  *                     handle will NOT be closed after the metadata is
921  *                     written; that is the duty of the caller.
922  * \param callbacks    A set of callbacks to use for I/O.  The mandatory
923  *                     callbacks are \a write and \a seek.
924  * \assert
925  *    \code chain != NULL \endcode
926  * \retval FLAC__bool
927  *    \c true if the write succeeded, else \c false.  On failure,
928  *    check the status with FLAC__metadata_chain_status().
929  */
930 FLAC_API FLAC__bool FLAC__metadata_chain_write_with_callbacks(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks);
931
932 /** Write all metadata out to a FLAC stream via callbacks.
933  *
934  *  (See FLAC__metadata_chain_write() for the details on how padding is
935  *  used to write metadata in place if possible.)
936  *
937  *  This version of the write-with-callbacks function must be used when
938  *  FLAC__metadata_chain_check_if_tempfile_needed() returns true.  In
939  *  this function, you must supply an I/O handle corresponding to the
940  *  FLAC file to edit, and a temporary handle to which the new FLAC
941  *  file will be written.  It is the caller's job to move this temporary
942  *  FLAC file on top of the original FLAC file to complete the metadata
943  *  edit.
944  *
945  *  The \a handle must be open for reading and be seekable.  The
946  *  equivalent minimum stdio fopen() file mode is \c "r" (or \c "rb"
947  *  for Windows).
948  *
949  *  The \a temp_handle must be open for writing.  The
950  *  equivalent minimum stdio fopen() file mode is \c "w" (or \c "wb"
951  *  for Windows).  It should be an empty stream, or at least positioned
952  *  at the start-of-file (in which case it is the caller's duty to
953  *  truncate it on return).
954  *
955  *  For this write function to be used, the chain must have been read with
956  *  FLAC__metadata_chain_read_with_callbacks()/FLAC__metadata_chain_read_ogg_with_callbacks(),
957  *  not FLAC__metadata_chain_read()/FLAC__metadata_chain_read_ogg().
958  *  Also, FLAC__metadata_chain_check_if_tempfile_needed() must have returned
959  *  \c true.
960  *
961  * \param chain        A pointer to an existing chain.
962  * \param use_padding  See FLAC__metadata_chain_write()
963  * \param handle       The I/O handle of the original FLAC stream to read.
964  *                     The handle will NOT be closed after the metadata is
965  *                     written; that is the duty of the caller.
966  * \param callbacks    A set of callbacks to use for I/O on \a handle.
967  *                     The mandatory callbacks are \a read, \a seek, and
968  *                     \a eof.
969  * \param temp_handle  The I/O handle of the FLAC stream to write.  The
970  *                     handle will NOT be closed after the metadata is
971  *                     written; that is the duty of the caller.
972  * \param temp_callbacks
973  *                     A set of callbacks to use for I/O on temp_handle.
974  *                     The only mandatory callback is \a write.
975  * \assert
976  *    \code chain != NULL \endcode
977  * \retval FLAC__bool
978  *    \c true if the write succeeded, else \c false.  On failure,
979  *    check the status with FLAC__metadata_chain_status().
980  */
981 FLAC_API FLAC__bool FLAC__metadata_chain_write_with_callbacks_and_tempfile(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks, FLAC__IOHandle temp_handle, FLAC__IOCallbacks temp_callbacks);
982
983 /** Merge adjacent PADDING blocks into a single block.
984  *
985  * \note This function does not write to the FLAC file, it only
986  * modifies the chain.
987  *
988  * \warning Any iterator on the current chain will become invalid after this
989  * call.  You should delete the iterator and get a new one.
990  *
991  * \param chain               A pointer to an existing chain.
992  * \assert
993  *    \code chain != NULL \endcode
994  */
995 FLAC_API void FLAC__metadata_chain_merge_padding(FLAC__Metadata_Chain *chain);
996
997 /** This function will move all PADDING blocks to the end on the metadata,
998  *  then merge them into a single block.
999  *
1000  * \note This function does not write to the FLAC file, it only
1001  * modifies the chain.
1002  *
1003  * \warning Any iterator on the current chain will become invalid after this
1004  * call.  You should delete the iterator and get a new one.
1005  *
1006  * \param chain  A pointer to an existing chain.
1007  * \assert
1008  *    \code chain != NULL \endcode
1009  */
1010 FLAC_API void FLAC__metadata_chain_sort_padding(FLAC__Metadata_Chain *chain);
1011
1012
1013 /*********** FLAC__Metadata_Iterator ***********/
1014
1015 /** Create a new iterator instance.
1016  *
1017  * \retval FLAC__Metadata_Iterator*
1018  *    \c NULL if there was an error allocating memory, else the new instance.
1019  */
1020 FLAC_API FLAC__Metadata_Iterator *FLAC__metadata_iterator_new(void);
1021
1022 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
1023  *
1024  * \param iterator  A pointer to an existing iterator.
1025  * \assert
1026  *    \code iterator != NULL \endcode
1027  */
1028 FLAC_API void FLAC__metadata_iterator_delete(FLAC__Metadata_Iterator *iterator);
1029
1030 /** Initialize the iterator to point to the first metadata block in the
1031  *  given chain.
1032  *
1033  * \param iterator  A pointer to an existing iterator.
1034  * \param chain     A pointer to an existing and initialized (read) chain.
1035  * \assert
1036  *    \code iterator != NULL \endcode
1037  *    \code chain != NULL \endcode
1038  */
1039 FLAC_API void FLAC__metadata_iterator_init(FLAC__Metadata_Iterator *iterator, FLAC__Metadata_Chain *chain);
1040
1041 /** Moves the iterator forward one metadata block, returning \c false if
1042  *  already at the end.
1043  *
1044  * \param iterator  A pointer to an existing initialized iterator.
1045  * \assert
1046  *    \code iterator != NULL \endcode
1047  *    \a iterator has been successfully initialized with
1048  *    FLAC__metadata_iterator_init()
1049  * \retval FLAC__bool
1050  *    \c false if already at the last metadata block of the chain, else
1051  *    \c true.
1052  */
1053 FLAC_API FLAC__bool FLAC__metadata_iterator_next(FLAC__Metadata_Iterator *iterator);
1054
1055 /** Moves the iterator backward one metadata block, returning \c false if
1056  *  already at the beginning.
1057  *
1058  * \param iterator  A pointer to an existing initialized iterator.
1059  * \assert
1060  *    \code iterator != NULL \endcode
1061  *    \a iterator has been successfully initialized with
1062  *    FLAC__metadata_iterator_init()
1063  * \retval FLAC__bool
1064  *    \c false if already at the first metadata block of the chain, else
1065  *    \c true.
1066  */
1067 FLAC_API FLAC__bool FLAC__metadata_iterator_prev(FLAC__Metadata_Iterator *iterator);
1068
1069 /** Get the type of the metadata block at the current position.
1070  *
1071  * \param iterator  A pointer to an existing initialized iterator.
1072  * \assert
1073  *    \code iterator != NULL \endcode
1074  *    \a iterator has been successfully initialized with
1075  *    FLAC__metadata_iterator_init()
1076  * \retval FLAC__MetadataType
1077  *    The type of the metadata block at the current iterator position.
1078  */
1079 FLAC_API FLAC__MetadataType FLAC__metadata_iterator_get_block_type(const FLAC__Metadata_Iterator *iterator);
1080
1081 /** Get the metadata block at the current position.  You can modify
1082  *  the block in place but must write the chain before the changes
1083  *  are reflected to the FLAC file.  You do not need to call
1084  *  FLAC__metadata_iterator_set_block() to reflect the changes;
1085  *  the pointer returned by FLAC__metadata_iterator_get_block()
1086  *  points directly into the chain.
1087  *
1088  * \warning
1089  * Do not call FLAC__metadata_object_delete() on the returned object;
1090  * to delete a block use FLAC__metadata_iterator_delete_block().
1091  *
1092  * \param iterator  A pointer to an existing initialized iterator.
1093  * \assert
1094  *    \code iterator != NULL \endcode
1095  *    \a iterator has been successfully initialized with
1096  *    FLAC__metadata_iterator_init()
1097  * \retval FLAC__StreamMetadata*
1098  *    The current metadata block.
1099  */
1100 FLAC_API FLAC__StreamMetadata *FLAC__metadata_iterator_get_block(FLAC__Metadata_Iterator *iterator);
1101
1102 /** Set the metadata block at the current position, replacing the existing
1103  *  block.  The new block passed in becomes owned by the chain and it will be
1104  *  deleted when the chain is deleted.
1105  *
1106  * \param iterator  A pointer to an existing initialized iterator.
1107  * \param block     A pointer to a metadata block.
1108  * \assert
1109  *    \code iterator != NULL \endcode
1110  *    \a iterator has been successfully initialized with
1111  *    FLAC__metadata_iterator_init()
1112  *    \code block != NULL \endcode
1113  * \retval FLAC__bool
1114  *    \c false if the conditions in the above description are not met, or
1115  *    a memory allocation error occurs, otherwise \c true.
1116  */
1117 FLAC_API FLAC__bool FLAC__metadata_iterator_set_block(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
1118
1119 /** Removes the current block from the chain.  If \a replace_with_padding is
1120  *  \c true, the block will instead be replaced with a padding block of equal
1121  *  size.  You can not delete the STREAMINFO block.  The iterator will be
1122  *  left pointing to the block before the one just "deleted", even if
1123  *  \a replace_with_padding is \c true.
1124  *
1125  * \param iterator              A pointer to an existing initialized iterator.
1126  * \param replace_with_padding  See above.
1127  * \assert
1128  *    \code iterator != NULL \endcode
1129  *    \a iterator has been successfully initialized with
1130  *    FLAC__metadata_iterator_init()
1131  * \retval FLAC__bool
1132  *    \c false if the conditions in the above description are not met,
1133  *    otherwise \c true.
1134  */
1135 FLAC_API FLAC__bool FLAC__metadata_iterator_delete_block(FLAC__Metadata_Iterator *iterator, FLAC__bool replace_with_padding);
1136
1137 /** Insert a new block before the current block.  You cannot insert a block
1138  *  before the first STREAMINFO block.  You cannot insert a STREAMINFO block
1139  *  as there can be only one, the one that already exists at the head when you
1140  *  read in a chain.  The chain takes ownership of the new block and it will be
1141  *  deleted when the chain is deleted.  The iterator will be left pointing to
1142  *  the new block.
1143  *
1144  * \param iterator  A pointer to an existing initialized iterator.
1145  * \param block     A pointer to a metadata block to insert.
1146  * \assert
1147  *    \code iterator != NULL \endcode
1148  *    \a iterator has been successfully initialized with
1149  *    FLAC__metadata_iterator_init()
1150  * \retval FLAC__bool
1151  *    \c false if the conditions in the above description are not met, or
1152  *    a memory allocation error occurs, otherwise \c true.
1153  */
1154 FLAC_API FLAC__bool FLAC__metadata_iterator_insert_block_before(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
1155
1156 /** Insert a new block after the current block.  You cannot insert a STREAMINFO
1157  *  block as there can be only one, the one that already exists at the head when
1158  *  you read in a chain.  The chain takes ownership of the new block and it will
1159  *  be deleted when the chain is deleted.  The iterator will be left pointing to
1160  *  the new block.
1161  *
1162  * \param iterator  A pointer to an existing initialized iterator.
1163  * \param block     A pointer to a metadata block to insert.
1164  * \assert
1165  *    \code iterator != NULL \endcode
1166  *    \a iterator has been successfully initialized with
1167  *    FLAC__metadata_iterator_init()
1168  * \retval FLAC__bool
1169  *    \c false if the conditions in the above description are not met, or
1170  *    a memory allocation error occurs, otherwise \c true.
1171  */
1172 FLAC_API FLAC__bool FLAC__metadata_iterator_insert_block_after(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
1173
1174 /* \} */
1175
1176
1177 /** \defgroup flac_metadata_object FLAC/metadata.h: metadata object methods
1178  *  \ingroup flac_metadata
1179  *
1180  * \brief
1181  * This module contains methods for manipulating FLAC metadata objects.
1182  *
1183  * Since many are variable length we have to be careful about the memory
1184  * management.  We decree that all pointers to data in the object are
1185  * owned by the object and memory-managed by the object.
1186  *
1187  * Use the FLAC__metadata_object_new() and FLAC__metadata_object_delete()
1188  * functions to create all instances.  When using the
1189  * FLAC__metadata_object_set_*() functions to set pointers to data, set
1190  * \a copy to \c true to have the function make it's own copy of the data, or
1191  * to \c false to give the object ownership of your data.  In the latter case
1192  * your pointer must be freeable by free() and will be free()d when the object
1193  * is FLAC__metadata_object_delete()d.  It is legal to pass a null pointer as
1194  * the data pointer to a FLAC__metadata_object_set_*() function as long as
1195  * the length argument is 0 and the \a copy argument is \c false.
1196  *
1197  * The FLAC__metadata_object_new() and FLAC__metadata_object_clone() function
1198  * will return \c NULL in the case of a memory allocation error, otherwise a new
1199  * object.  The FLAC__metadata_object_set_*() functions return \c false in the
1200  * case of a memory allocation error.
1201  *
1202  * We don't have the convenience of C++ here, so note that the library relies
1203  * on you to keep the types straight.  In other words, if you pass, for
1204  * example, a FLAC__StreamMetadata* that represents a STREAMINFO block to
1205  * FLAC__metadata_object_application_set_data(), you will get an assertion
1206  * failure.
1207  *
1208  * For convenience the FLAC__metadata_object_vorbiscomment_*() functions
1209  * maintain a trailing NUL on each Vorbis comment entry.  This is not counted
1210  * toward the length or stored in the stream, but it can make working with plain
1211  * comments (those that don't contain embedded-NULs in the value) easier.
1212  * Entries passed into these functions have trailing NULs added if missing, and
1213  * returned entries are guaranteed to have a trailing NUL.
1214  *
1215  * The FLAC__metadata_object_vorbiscomment_*() functions that take a Vorbis
1216  * comment entry/name/value will first validate that it complies with the Vorbis
1217  * comment specification and return false if it does not.
1218  *
1219  * There is no need to recalculate the length field on metadata blocks you
1220  * have modified.  They will be calculated automatically before they  are
1221  * written back to a file.
1222  *
1223  * \{
1224  */
1225
1226
1227 /** Create a new metadata object instance of the given type.
1228  *
1229  *  The object will be "empty"; i.e. values and data pointers will be \c 0,
1230  *  with the exception of FLAC__METADATA_TYPE_VORBIS_COMMENT, which will have
1231  *  the vendor string set (but zero comments).
1232  *
1233  *  Do not pass in a value greater than or equal to
1234  *  \a FLAC__METADATA_TYPE_UNDEFINED unless you really know what you're
1235  *  doing.
1236  *
1237  * \param type  Type of object to create
1238  * \retval FLAC__StreamMetadata*
1239  *    \c NULL if there was an error allocating memory or the type code is
1240  *    greater than FLAC__MAX_METADATA_TYPE_CODE, else the new instance.
1241  */
1242 FLAC_API FLAC__StreamMetadata *FLAC__metadata_object_new(FLAC__MetadataType type);
1243
1244 /** Create a copy of an existing metadata object.
1245  *
1246  *  The copy is a "deep" copy, i.e. dynamically allocated data within the
1247  *  object is also copied.  The caller takes ownership of the new block and
1248  *  is responsible for freeing it with FLAC__metadata_object_delete().
1249  *
1250  * \param object  Pointer to object to copy.
1251  * \assert
1252  *    \code object != NULL \endcode
1253  * \retval FLAC__StreamMetadata*
1254  *    \c NULL if there was an error allocating memory, else the new instance.
1255  */
1256 FLAC_API FLAC__StreamMetadata *FLAC__metadata_object_clone(const FLAC__StreamMetadata *object);
1257
1258 /** Free a metadata object.  Deletes the object pointed to by \a object.
1259  *
1260  *  The delete is a "deep" delete, i.e. dynamically allocated data within the
1261  *  object is also deleted.
1262  *
1263  * \param object  A pointer to an existing object.
1264  * \assert
1265  *    \code object != NULL \endcode
1266  */
1267 FLAC_API void FLAC__metadata_object_delete(FLAC__StreamMetadata *object);
1268
1269 /** Compares two metadata objects.
1270  *
1271  *  The compare is "deep", i.e. dynamically allocated data within the
1272  *  object is also compared.
1273  *
1274  * \param block1  A pointer to an existing object.
1275  * \param block2  A pointer to an existing object.
1276  * \assert
1277  *    \code block1 != NULL \endcode
1278  *    \code block2 != NULL \endcode
1279  * \retval FLAC__bool
1280  *    \c true if objects are identical, else \c false.
1281  */
1282 FLAC_API FLAC__bool FLAC__metadata_object_is_equal(const FLAC__StreamMetadata *block1, const FLAC__StreamMetadata *block2);
1283
1284 /** Sets the application data of an APPLICATION block.
1285  *
1286  *  If \a copy is \c true, a copy of the data is stored; otherwise, the object
1287  *  takes ownership of the pointer.  The existing data will be freed if this
1288  *  function is successful, otherwise the original data will remain if \a copy
1289  *  is \c true and malloc() fails.
1290  *
1291  * \note It is safe to pass a const pointer to \a data if \a copy is \c true.
1292  *
1293  * \param object  A pointer to an existing APPLICATION object.
1294  * \param data    A pointer to the data to set.
1295  * \param length  The length of \a data in bytes.
1296  * \param copy    See above.
1297  * \assert
1298  *    \code object != NULL \endcode
1299  *    \code object->type == FLAC__METADATA_TYPE_APPLICATION \endcode
1300  *    \code (data != NULL && length > 0) ||
1301  * (data == NULL && length == 0 && copy == false) \endcode
1302  * \retval FLAC__bool
1303  *    \c false if \a copy is \c true and malloc() fails, else \c true.
1304  */
1305 FLAC_API FLAC__bool FLAC__metadata_object_application_set_data(FLAC__StreamMetadata *object, FLAC__byte *data, unsigned length, FLAC__bool copy);
1306
1307 /** Resize the seekpoint array.
1308  *
1309  *  If the size shrinks, elements will truncated; if it grows, new placeholder
1310  *  points will be added to the end.
1311  *
1312  * \param object          A pointer to an existing SEEKTABLE object.
1313  * \param new_num_points  The desired length of the array; may be \c 0.
1314  * \assert
1315  *    \code object != NULL \endcode
1316  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1317  *    \code (object->data.seek_table.points == NULL && object->data.seek_table.num_points == 0) ||
1318  * (object->data.seek_table.points != NULL && object->data.seek_table.num_points > 0) \endcode
1319  * \retval FLAC__bool
1320  *    \c false if memory allocation error, else \c true.
1321  */
1322 FLAC_API FLAC__bool FLAC__metadata_object_seektable_resize_points(FLAC__StreamMetadata *object, unsigned new_num_points);
1323
1324 /** Set a seekpoint in a seektable.
1325  *
1326  * \param object     A pointer to an existing SEEKTABLE object.
1327  * \param point_num  Index into seekpoint array to set.
1328  * \param point      The point to set.
1329  * \assert
1330  *    \code object != NULL \endcode
1331  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1332  *    \code object->data.seek_table.num_points > point_num \endcode
1333  */
1334 FLAC_API void FLAC__metadata_object_seektable_set_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1335
1336 /** Insert a seekpoint into a seektable.
1337  *
1338  * \param object     A pointer to an existing SEEKTABLE object.
1339  * \param point_num  Index into seekpoint array to set.
1340  * \param point      The point to set.
1341  * \assert
1342  *    \code object != NULL \endcode
1343  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1344  *    \code object->data.seek_table.num_points >= point_num \endcode
1345  * \retval FLAC__bool
1346  *    \c false if memory allocation error, else \c true.
1347  */
1348 FLAC_API FLAC__bool FLAC__metadata_object_seektable_insert_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1349
1350 /** Delete a seekpoint from a seektable.
1351  *
1352  * \param object     A pointer to an existing SEEKTABLE object.
1353  * \param point_num  Index into seekpoint array to set.
1354  * \assert
1355  *    \code object != NULL \endcode
1356  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1357  *    \code object->data.seek_table.num_points > point_num \endcode
1358  * \retval FLAC__bool
1359  *    \c false if memory allocation error, else \c true.
1360  */
1361 FLAC_API FLAC__bool FLAC__metadata_object_seektable_delete_point(FLAC__StreamMetadata *object, unsigned point_num);
1362
1363 /** Check a seektable to see if it conforms to the FLAC specification.
1364  *  See the format specification for limits on the contents of the
1365  *  seektable.
1366  *
1367  * \param object  A pointer to an existing SEEKTABLE object.
1368  * \assert
1369  *    \code object != NULL \endcode
1370  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1371  * \retval FLAC__bool
1372  *    \c false if seek table is illegal, else \c true.
1373  */
1374 FLAC_API FLAC__bool FLAC__metadata_object_seektable_is_legal(const FLAC__StreamMetadata *object);
1375
1376 /** Append a number of placeholder points to the end of a seek table.
1377  *
1378  * \note
1379  * As with the other ..._seektable_template_... functions, you should
1380  * call FLAC__metadata_object_seektable_template_sort() when finished
1381  * to make the seek table legal.
1382  *
1383  * \param object  A pointer to an existing SEEKTABLE object.
1384  * \param num     The number of placeholder points to append.
1385  * \assert
1386  *    \code object != NULL \endcode
1387  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1388  * \retval FLAC__bool
1389  *    \c false if memory allocation fails, else \c true.
1390  */
1391 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_placeholders(FLAC__StreamMetadata *object, unsigned num);
1392
1393 /** Append a specific seek point template to the end of a seek table.
1394  *
1395  * \note
1396  * As with the other ..._seektable_template_... functions, you should
1397  * call FLAC__metadata_object_seektable_template_sort() when finished
1398  * to make the seek table legal.
1399  *
1400  * \param object  A pointer to an existing SEEKTABLE object.
1401  * \param sample_number  The sample number of the seek point template.
1402  * \assert
1403  *    \code object != NULL \endcode
1404  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1405  * \retval FLAC__bool
1406  *    \c false if memory allocation fails, else \c true.
1407  */
1408 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_point(FLAC__StreamMetadata *object, FLAC__uint64 sample_number);
1409
1410 /** Append specific seek point templates to the end of a seek table.
1411  *
1412  * \note
1413  * As with the other ..._seektable_template_... functions, you should
1414  * call FLAC__metadata_object_seektable_template_sort() when finished
1415  * to make the seek table legal.
1416  *
1417  * \param object  A pointer to an existing SEEKTABLE object.
1418  * \param sample_numbers  An array of sample numbers for the seek points.
1419  * \param num     The number of seek point templates to append.
1420  * \assert
1421  *    \code object != NULL \endcode
1422  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1423  * \retval FLAC__bool
1424  *    \c false if memory allocation fails, else \c true.
1425  */
1426 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_points(FLAC__StreamMetadata *object, FLAC__uint64 sample_numbers[], unsigned num);
1427
1428 /** Append a set of evenly-spaced seek point templates to the end of a
1429  *  seek table.
1430  *
1431  * \note
1432  * As with the other ..._seektable_template_... functions, you should
1433  * call FLAC__metadata_object_seektable_template_sort() when finished
1434  * to make the seek table legal.
1435  *
1436  * \param object  A pointer to an existing SEEKTABLE object.
1437  * \param num     The number of placeholder points to append.
1438  * \param total_samples  The total number of samples to be encoded;
1439  *                       the seekpoints will be spaced approximately
1440  *                       \a total_samples / \a num samples apart.
1441  * \assert
1442  *    \code object != NULL \endcode
1443  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1444  *    \code total_samples > 0 \endcode
1445  * \retval FLAC__bool
1446  *    \c false if memory allocation fails, else \c true.
1447  */
1448 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_spaced_points(FLAC__StreamMetadata *object, unsigned num, FLAC__uint64 total_samples);
1449
1450 /** Append a set of evenly-spaced seek point templates to the end of a
1451  *  seek table.
1452  *
1453  * \note
1454  * As with the other ..._seektable_template_... functions, you should
1455  * call FLAC__metadata_object_seektable_template_sort() when finished
1456  * to make the seek table legal.
1457  *
1458  * \param object  A pointer to an existing SEEKTABLE object.
1459  * \param samples The number of samples apart to space the placeholder
1460  *                points.  The first point will be at sample \c 0, the
1461  *                second at sample \a samples, then 2*\a samples, and
1462  *                so on.  As long as \a samples and \a total_samples
1463  *                are greater than \c 0, there will always be at least
1464  *                one seekpoint at sample \c 0.
1465  * \param total_samples  The total number of samples to be encoded;
1466  *                       the seekpoints will be spaced
1467  *                       \a samples samples apart.
1468  * \assert
1469  *    \code object != NULL \endcode
1470  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1471  *    \code samples > 0 \endcode
1472  *    \code total_samples > 0 \endcode
1473  * \retval FLAC__bool
1474  *    \c false if memory allocation fails, else \c true.
1475  */
1476 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_spaced_points_by_samples(FLAC__StreamMetadata *object, unsigned samples, FLAC__uint64 total_samples);
1477
1478 /** Sort a seek table's seek points according to the format specification,
1479  *  removing duplicates.
1480  *
1481  * \param object   A pointer to a seek table to be sorted.
1482  * \param compact  If \c false, behaves like FLAC__format_seektable_sort().
1483  *                 If \c true, duplicates are deleted and the seek table is
1484  *                 shrunk appropriately; the number of placeholder points
1485  *                 present in the seek table will be the same after the call
1486  *                 as before.
1487  * \assert
1488  *    \code object != NULL \endcode
1489  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1490  * \retval FLAC__bool
1491  *    \c false if realloc() fails, else \c true.
1492  */
1493 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_sort(FLAC__StreamMetadata *object, FLAC__bool compact);
1494
1495 /** Sets the vendor string in a VORBIS_COMMENT block.
1496  *
1497  *  For convenience, a trailing NUL is added to the entry if it doesn't have
1498  *  one already.
1499  *
1500  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1501  *  takes ownership of the \c entry.entry pointer.
1502  *
1503  *  \note If this function returns \c false, the caller still owns the
1504  *  pointer.
1505  *
1506  * \param object  A pointer to an existing VORBIS_COMMENT object.
1507  * \param entry   The entry to set the vendor string to.
1508  * \param copy    See above.
1509  * \assert
1510  *    \code object != NULL \endcode
1511  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1512  *    \code (entry.entry != NULL && entry.length > 0) ||
1513  * (entry.entry == NULL && entry.length == 0) \endcode
1514  * \retval FLAC__bool
1515  *    \c false if memory allocation fails or \a entry does not comply with the
1516  *    Vorbis comment specification, else \c true.
1517  */
1518 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_set_vendor_string(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1519
1520 /** Resize the comment array.
1521  *
1522  *  If the size shrinks, elements will truncated; if it grows, new empty
1523  *  fields will be added to the end.
1524  *
1525  * \param object            A pointer to an existing VORBIS_COMMENT object.
1526  * \param new_num_comments  The desired length of the array; may be \c 0.
1527  * \assert
1528  *    \code object != NULL \endcode
1529  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1530  *    \code (object->data.vorbis_comment.comments == NULL && object->data.vorbis_comment.num_comments == 0) ||
1531  * (object->data.vorbis_comment.comments != NULL && object->data.vorbis_comment.num_comments > 0) \endcode
1532  * \retval FLAC__bool
1533  *    \c false if memory allocation fails, else \c true.
1534  */
1535 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_resize_comments(FLAC__StreamMetadata *object, unsigned new_num_comments);
1536
1537 /** Sets a comment in a VORBIS_COMMENT block.
1538  *
1539  *  For convenience, a trailing NUL is added to the entry if it doesn't have
1540  *  one already.
1541  *
1542  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1543  *  takes ownership of the \c entry.entry pointer.
1544  *
1545  *  \note If this function returns \c false, the caller still owns the
1546  *  pointer.
1547  *
1548  * \param object       A pointer to an existing VORBIS_COMMENT object.
1549  * \param comment_num  Index into comment array to set.
1550  * \param entry        The entry to set the comment to.
1551  * \param copy         See above.
1552  * \assert
1553  *    \code object != NULL \endcode
1554  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1555  *    \code comment_num < object->data.vorbis_comment.num_comments \endcode
1556  *    \code (entry.entry != NULL && entry.length > 0) ||
1557  * (entry.entry == NULL && entry.length == 0) \endcode
1558  * \retval FLAC__bool
1559  *    \c false if memory allocation fails or \a entry does not comply with the
1560  *    Vorbis comment specification, else \c true.
1561  */
1562 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_set_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1563
1564 /** Insert a comment in a VORBIS_COMMENT block at the given index.
1565  *
1566  *  For convenience, a trailing NUL is added to the entry if it doesn't have
1567  *  one already.
1568  *
1569  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1570  *  takes ownership of the \c entry.entry pointer.
1571  *
1572  *  \note If this function returns \c false, the caller still owns the
1573  *  pointer.
1574  *
1575  * \param object       A pointer to an existing VORBIS_COMMENT object.
1576  * \param comment_num  The index at which to insert the comment.  The comments
1577  *                     at and after \a comment_num move right one position.
1578  *                     To append a comment to the end, set \a comment_num to
1579  *                     \c object->data.vorbis_comment.num_comments .
1580  * \param entry        The comment to insert.
1581  * \param copy         See above.
1582  * \assert
1583  *    \code object != NULL \endcode
1584  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1585  *    \code object->data.vorbis_comment.num_comments >= comment_num \endcode
1586  *    \code (entry.entry != NULL && entry.length > 0) ||
1587  * (entry.entry == NULL && entry.length == 0 && copy == false) \endcode
1588  * \retval FLAC__bool
1589  *    \c false if memory allocation fails or \a entry does not comply with the
1590  *    Vorbis comment specification, else \c true.
1591  */
1592 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_insert_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1593
1594 /** Appends a comment to a VORBIS_COMMENT block.
1595  *
1596  *  For convenience, a trailing NUL is added to the entry if it doesn't have
1597  *  one already.
1598  *
1599  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1600  *  takes ownership of the \c entry.entry pointer.
1601  *
1602  *  \note If this function returns \c false, the caller still owns the
1603  *  pointer.
1604  *
1605  * \param object       A pointer to an existing VORBIS_COMMENT object.
1606  * \param entry        The comment to insert.
1607  * \param copy         See above.
1608  * \assert
1609  *    \code object != NULL \endcode
1610  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1611  *    \code (entry.entry != NULL && entry.length > 0) ||
1612  * (entry.entry == NULL && entry.length == 0 && copy == false) \endcode
1613  * \retval FLAC__bool
1614  *    \c false if memory allocation fails or \a entry does not comply with the
1615  *    Vorbis comment specification, else \c true.
1616  */
1617 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_append_comment(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1618
1619 /** Replaces comments in a VORBIS_COMMENT block with a new one.
1620  *
1621  *  For convenience, a trailing NUL is added to the entry if it doesn't have
1622  *  one already.
1623  *
1624  *  Depending on the the value of \a all, either all or just the first comment
1625  *  whose field name(s) match the given entry's name will be replaced by the
1626  *  given entry.  If no comments match, \a entry will simply be appended.
1627  *
1628  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1629  *  takes ownership of the \c entry.entry pointer.
1630  *
1631  *  \note If this function returns \c false, the caller still owns the
1632  *  pointer.
1633  *
1634  * \param object       A pointer to an existing VORBIS_COMMENT object.
1635  * \param entry        The comment to insert.
1636  * \param all          If \c true, all comments whose field name matches
1637  *                     \a entry's field name will be removed, and \a entry will
1638  *                     be inserted at the position of the first matching
1639  *                     comment.  If \c false, only the first comment whose
1640  *                     field name matches \a entry's field name will be
1641  *                     replaced with \a entry.
1642  * \param copy         See above.
1643  * \assert
1644  *    \code object != NULL \endcode
1645  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1646  *    \code (entry.entry != NULL && entry.length > 0) ||
1647  * (entry.entry == NULL && entry.length == 0 && copy == false) \endcode
1648  * \retval FLAC__bool
1649  *    \c false if memory allocation fails or \a entry does not comply with the
1650  *    Vorbis comment specification, else \c true.
1651  */
1652 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_replace_comment(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool all, FLAC__bool copy);
1653
1654 /** Delete a comment in a VORBIS_COMMENT block at the given index.
1655  *
1656  * \param object       A pointer to an existing VORBIS_COMMENT object.
1657  * \param comment_num  The index of the comment to delete.
1658  * \assert
1659  *    \code object != NULL \endcode
1660  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1661  *    \code object->data.vorbis_comment.num_comments > comment_num \endcode
1662  * \retval FLAC__bool
1663  *    \c false if realloc() fails, else \c true.
1664  */
1665 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_delete_comment(FLAC__StreamMetadata *object, unsigned comment_num);
1666
1667 /** Creates a Vorbis comment entry from NUL-terminated name and value strings.
1668  *
1669  *  On return, the filled-in \a entry->entry pointer will point to malloc()ed
1670  *  memory and shall be owned by the caller.  For convenience the entry will
1671  *  have a terminating NUL.
1672  *
1673  * \param entry              A pointer to a Vorbis comment entry.  The entry's
1674  *                           \c entry pointer should not point to allocated
1675  *                           memory as it will be overwritten.
1676  * \param field_name         The field name in ASCII, \c NUL terminated.
1677  * \param field_value        The field value in UTF-8, \c NUL terminated.
1678  * \assert
1679  *    \code entry != NULL \endcode
1680  *    \code field_name != NULL \endcode
1681  *    \code field_value != NULL \endcode
1682  * \retval FLAC__bool
1683  *    \c false if malloc() fails, or if \a field_name or \a field_value does
1684  *    not comply with the Vorbis comment specification, else \c true.
1685  */
1686 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_entry_from_name_value_pair(FLAC__StreamMetadata_VorbisComment_Entry *entry, const char *field_name, const char *field_value);
1687
1688 /** Splits a Vorbis comment entry into NUL-terminated name and value strings.
1689  *
1690  *  The returned pointers to name and value will be allocated by malloc()
1691  *  and shall be owned by the caller.
1692  *
1693  * \param entry              An existing Vorbis comment entry.
1694  * \param field_name         The address of where the returned pointer to the
1695  *                           field name will be stored.
1696  * \param field_value        The address of where the returned pointer to the
1697  *                           field value will be stored.
1698  * \assert
1699  *    \code (entry.entry != NULL && entry.length > 0) \endcode
1700  *    \code memchr(entry.entry, '=', entry.length) != NULL \endcode
1701  *    \code field_name != NULL \endcode
1702  *    \code field_value != NULL \endcode
1703  * \retval FLAC__bool
1704  *    \c false if memory allocation fails or \a entry does not comply with the
1705  *    Vorbis comment specification, else \c true.
1706  */
1707 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_entry_to_name_value_pair(const FLAC__StreamMetadata_VorbisComment_Entry entry, char **field_name, char **field_value);
1708
1709 /** Check if the given Vorbis comment entry's field name matches the given
1710  *  field name.
1711  *
1712  * \param entry              An existing Vorbis comment entry.
1713  * \param field_name         The field name to check.
1714  * \param field_name_length  The length of \a field_name, not including the
1715  *                           terminating \c NUL.
1716  * \assert
1717  *    \code (entry.entry != NULL && entry.length > 0) \endcode
1718  * \retval FLAC__bool
1719  *    \c true if the field names match, else \c false
1720  */
1721 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_entry_matches(const FLAC__StreamMetadata_VorbisComment_Entry entry, const char *field_name, unsigned field_name_length);
1722
1723 /** Find a Vorbis comment with the given field name.
1724  *
1725  *  The search begins at entry number \a offset; use an offset of 0 to
1726  *  search from the beginning of the comment array.
1727  *
1728  * \param object      A pointer to an existing VORBIS_COMMENT object.
1729  * \param offset      The offset into the comment array from where to start
1730  *                    the search.
1731  * \param field_name  The field name of the comment to find.
1732  * \assert
1733  *    \code object != NULL \endcode
1734  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1735  *    \code field_name != NULL \endcode
1736  * \retval int
1737  *    The offset in the comment array of the first comment whose field
1738  *    name matches \a field_name, or \c -1 if no match was found.
1739  */
1740 FLAC_API int FLAC__metadata_object_vorbiscomment_find_entry_from(const FLAC__StreamMetadata *object, unsigned offset, const char *field_name);
1741
1742 /** Remove first Vorbis comment matching the given field name.
1743  *
1744  * \param object      A pointer to an existing VORBIS_COMMENT object.
1745  * \param field_name  The field name of comment to delete.
1746  * \assert
1747  *    \code object != NULL \endcode
1748  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1749  * \retval int
1750  *    \c -1 for memory allocation error, \c 0 for no matching entries,
1751  *    \c 1 for one matching entry deleted.
1752  */
1753 FLAC_API int FLAC__metadata_object_vorbiscomment_remove_entry_matching(FLAC__StreamMetadata *object, const char *field_name);
1754
1755 /** Remove all Vorbis comments matching the given field name.
1756  *
1757  * \param object      A pointer to an existing VORBIS_COMMENT object.
1758  * \param field_name  The field name of comments to delete.
1759  * \assert
1760  *    \code object != NULL \endcode
1761  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1762  * \retval int
1763  *    \c -1 for memory allocation error, \c 0 for no matching entries,
1764  *    else the number of matching entries deleted.
1765  */
1766 FLAC_API int FLAC__metadata_object_vorbiscomment_remove_entries_matching(FLAC__StreamMetadata *object, const char *field_name);
1767
1768 /** Create a new CUESHEET track instance.
1769  *
1770  *  The object will be "empty"; i.e. values and data pointers will be \c 0.
1771  *
1772  * \retval FLAC__StreamMetadata_CueSheet_Track*
1773  *    \c NULL if there was an error allocating memory, else the new instance.
1774  */
1775 FLAC_API FLAC__StreamMetadata_CueSheet_Track *FLAC__metadata_object_cuesheet_track_new(void);
1776
1777 /** Create a copy of an existing CUESHEET track object.
1778  *
1779  *  The copy is a "deep" copy, i.e. dynamically allocated data within the
1780  *  object is also copied.  The caller takes ownership of the new object and
1781  *  is responsible for freeing it with
1782  *  FLAC__metadata_object_cuesheet_track_delete().
1783  *
1784  * \param object  Pointer to object to copy.
1785  * \assert
1786  *    \code object != NULL \endcode
1787  * \retval FLAC__StreamMetadata_CueSheet_Track*
1788  *    \c NULL if there was an error allocating memory, else the new instance.
1789  */
1790 FLAC_API FLAC__StreamMetadata_CueSheet_Track *FLAC__metadata_object_cuesheet_track_clone(const FLAC__StreamMetadata_CueSheet_Track *object);
1791
1792 /** Delete a CUESHEET track object
1793  *
1794  * \param object       A pointer to an existing CUESHEET track object.
1795  * \assert
1796  *    \code object != NULL \endcode
1797  */
1798 FLAC_API void FLAC__metadata_object_cuesheet_track_delete(FLAC__StreamMetadata_CueSheet_Track *object);
1799
1800 /** Resize a track's index point array.
1801  *
1802  *  If the size shrinks, elements will truncated; if it grows, new blank
1803  *  indices will be added to the end.
1804  *
1805  * \param object           A pointer to an existing CUESHEET object.
1806  * \param track_num        The index of the track to modify.  NOTE: this is not
1807  *                         necessarily the same as the track's \a number field.
1808  * \param new_num_indices  The desired length of the array; may be \c 0.
1809  * \assert
1810  *    \code object != NULL \endcode
1811  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1812  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1813  *    \code (object->data.cue_sheet.tracks[track_num].indices == NULL && object->data.cue_sheet.tracks[track_num].num_indices == 0) ||
1814  * (object->data.cue_sheet.tracks[track_num].indices != NULL && object->data.cue_sheet.tracks[track_num].num_indices > 0) \endcode
1815  * \retval FLAC__bool
1816  *    \c false if memory allocation error, else \c true.
1817  */
1818 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_resize_indices(FLAC__StreamMetadata *object, unsigned track_num, unsigned new_num_indices);
1819
1820 /** Insert an index point in a CUESHEET track at the given index.
1821  *
1822  * \param object       A pointer to an existing CUESHEET object.
1823  * \param track_num    The index of the track to modify.  NOTE: this is not
1824  *                     necessarily the same as the track's \a number field.
1825  * \param index_num    The index into the track's index array at which to
1826  *                     insert the index point.  NOTE: this is not necessarily
1827  *                     the same as the index point's \a number field.  The
1828  *                     indices at and after \a index_num move right one
1829  *                     position.  To append an index point to the end, set
1830  *                     \a index_num to
1831  *                     \c object->data.cue_sheet.tracks[track_num].num_indices .
1832  * \param index        The index point to insert.
1833  * \assert
1834  *    \code object != NULL \endcode
1835  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1836  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1837  *    \code object->data.cue_sheet.tracks[track_num].num_indices >= index_num \endcode
1838  * \retval FLAC__bool
1839  *    \c false if realloc() fails, else \c true.
1840  */
1841 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);
1842
1843 /** Insert a blank index point in a CUESHEET track at the given index.
1844  *
1845  *  A blank index point is one in which all field values are zero.
1846  *
1847  * \param object       A pointer to an existing CUESHEET object.
1848  * \param track_num    The index of the track to modify.  NOTE: this is not
1849  *                     necessarily the same as the track's \a number field.
1850  * \param index_num    The index into the track's index array at which to
1851  *                     insert the index point.  NOTE: this is not necessarily
1852  *                     the same as the index point's \a number field.  The
1853  *                     indices at and after \a index_num move right one
1854  *                     position.  To append an index point to the end, set
1855  *                     \a index_num to
1856  *                     \c object->data.cue_sheet.tracks[track_num].num_indices .
1857  * \assert
1858  *    \code object != NULL \endcode
1859  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1860  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1861  *    \code object->data.cue_sheet.tracks[track_num].num_indices >= index_num \endcode
1862  * \retval FLAC__bool
1863  *    \c false if realloc() fails, else \c true.
1864  */
1865 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_insert_blank_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num);
1866
1867 /** Delete an index point in a CUESHEET track at the given index.
1868  *
1869  * \param object       A pointer to an existing CUESHEET object.
1870  * \param track_num    The index into the track array of the track to
1871  *                     modify.  NOTE: this is not necessarily the same
1872  *                     as the track's \a number field.
1873  * \param index_num    The index into the track's index array of the index
1874  *                     to delete.  NOTE: this is not necessarily the same
1875  *                     as the index's \a number field.
1876  * \assert
1877  *    \code object != NULL \endcode
1878  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1879  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1880  *    \code object->data.cue_sheet.tracks[track_num].num_indices > index_num \endcode
1881  * \retval FLAC__bool
1882  *    \c false if realloc() fails, else \c true.
1883  */
1884 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_delete_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num);
1885
1886 /** Resize the track array.
1887  *
1888  *  If the size shrinks, elements will truncated; if it grows, new blank
1889  *  tracks will be added to the end.
1890  *
1891  * \param object            A pointer to an existing CUESHEET object.
1892  * \param new_num_tracks    The desired length of the array; may be \c 0.
1893  * \assert
1894  *    \code object != NULL \endcode
1895  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1896  *    \code (object->data.cue_sheet.tracks == NULL && object->data.cue_sheet.num_tracks == 0) ||
1897  * (object->data.cue_sheet.tracks != NULL && object->data.cue_sheet.num_tracks > 0) \endcode
1898  * \retval FLAC__bool
1899  *    \c false if memory allocation error, else \c true.
1900  */
1901 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_resize_tracks(FLAC__StreamMetadata *object, unsigned new_num_tracks);
1902
1903 /** Sets a track in a CUESHEET block.
1904  *
1905  *  If \a copy is \c true, a copy of the track is stored; otherwise, the object
1906  *  takes ownership of the \a track pointer.
1907  *
1908  * \param object       A pointer to an existing CUESHEET object.
1909  * \param track_num    Index into track array to set.  NOTE: this is not
1910  *                     necessarily the same as the track's \a number field.
1911  * \param track        The track to set the track to.  You may safely pass in
1912  *                     a const pointer if \a copy is \c true.
1913  * \param copy         See above.
1914  * \assert
1915  *    \code object != NULL \endcode
1916  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1917  *    \code track_num < object->data.cue_sheet.num_tracks \endcode
1918  *    \code (track->indices != NULL && track->num_indices > 0) ||
1919  * (track->indices == NULL && track->num_indices == 0)
1920  * \retval FLAC__bool
1921  *    \c false if \a copy is \c true and malloc() fails, else \c true.
1922  */
1923 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_set_track(FLAC__StreamMetadata *object, unsigned track_num, FLAC__StreamMetadata_CueSheet_Track *track, FLAC__bool copy);
1924
1925 /** Insert a track in a CUESHEET block at the given index.
1926  *
1927  *  If \a copy is \c true, a copy of the track is stored; otherwise, the object
1928  *  takes ownership of the \a track pointer.
1929  *
1930  * \param object       A pointer to an existing CUESHEET object.
1931  * \param track_num    The index at which to insert the track.  NOTE: this
1932  *                     is not necessarily the same as the track's \a number
1933  *                     field.  The tracks at and after \a track_num move right
1934  *                     one position.  To append a track to the end, set
1935  *                     \a track_num to \c object->data.cue_sheet.num_tracks .
1936  * \param track        The track to insert.  You may safely pass in a const
1937  *                     pointer if \a copy is \c true.
1938  * \param copy         See above.
1939  * \assert
1940  *    \code object != NULL \endcode
1941  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1942  *    \code object->data.cue_sheet.num_tracks >= track_num \endcode
1943  * \retval FLAC__bool
1944  *    \c false if \a copy is \c true and malloc() fails, else \c true.
1945  */
1946 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_insert_track(FLAC__StreamMetadata *object, unsigned track_num, FLAC__StreamMetadata_CueSheet_Track *track, FLAC__bool copy);
1947
1948 /** Insert a blank track in a CUESHEET block at the given index.
1949  *
1950  *  A blank track is one in which all field values are zero.
1951  *
1952  * \param object       A pointer to an existing CUESHEET object.
1953  * \param track_num    The index at which to insert the track.  NOTE: this
1954  *                     is not necessarily the same as the track's \a number
1955  *                     field.  The tracks at and after \a track_num move right
1956  *                     one position.  To append a track to the end, set
1957  *                     \a track_num to \c object->data.cue_sheet.num_tracks .
1958  * \assert
1959  *    \code object != NULL \endcode
1960  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1961  *    \code object->data.cue_sheet.num_tracks >= track_num \endcode
1962  * \retval FLAC__bool
1963  *    \c false if \a copy is \c true and malloc() fails, else \c true.
1964  */
1965 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_insert_blank_track(FLAC__StreamMetadata *object, unsigned track_num);
1966
1967 /** Delete a track in a CUESHEET block at the given index.
1968  *
1969  * \param object       A pointer to an existing CUESHEET object.
1970  * \param track_num    The index into the track array of the track to
1971  *                     delete.  NOTE: this is not necessarily the same
1972  *                     as the track's \a number field.
1973  * \assert
1974  *    \code object != NULL \endcode
1975  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1976  *    \code object->data.cue_sheet.num_tracks > track_num \endcode
1977  * \retval FLAC__bool
1978  *    \c false if realloc() fails, else \c true.
1979  */
1980 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_delete_track(FLAC__StreamMetadata *object, unsigned track_num);
1981
1982 /** Check a cue sheet to see if it conforms to the FLAC specification.
1983  *  See the format specification for limits on the contents of the
1984  *  cue sheet.
1985  *
1986  * \param object     A pointer to an existing CUESHEET object.
1987  * \param check_cd_da_subset  If \c true, check CUESHEET against more
1988  *                   stringent requirements for a CD-DA (audio) disc.
1989  * \param violation  Address of a pointer to a string.  If there is a
1990  *                   violation, a pointer to a string explanation of the
1991  *                   violation will be returned here. \a violation may be
1992  *                   \c NULL if you don't need the returned string.  Do not
1993  *                   free the returned string; it will always point to static
1994  *                   data.
1995  * \assert
1996  *    \code object != NULL \endcode
1997  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1998  * \retval FLAC__bool
1999  *    \c false if cue sheet is illegal, else \c true.
2000  */
2001 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_is_legal(const FLAC__StreamMetadata *object, FLAC__bool check_cd_da_subset, const char **violation);
2002
2003 /* @@@@ add to unit tests */
2004 /** Calculate and return the CDDB/freedb ID for a cue sheet.  The function
2005  *  assumes the cue sheet corresponds to a CD; the result is undefined
2006  *  if the cuesheet's is_cd bit is not set.
2007  *
2008  * \param object     A pointer to an existing CUESHEET object.
2009  * \assert
2010  *    \code object != NULL \endcode
2011  *    \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
2012  * \retval FLAC__uint32
2013  *    The unsigned integer representation of the CDDB/freedb ID
2014  */
2015 FLAC_API FLAC__uint32 FLAC__metadata_object_cuesheet_calculate_cddb_id(const FLAC__StreamMetadata *object);
2016
2017 /** Sets the MIME type of a PICTURE block.
2018  *
2019  *  If \a copy is \c true, a copy of the string is stored; otherwise, the object
2020  *  takes ownership of the pointer.  The existing string will be freed if this
2021  *  function is successful, otherwise the original string will remain if \a copy
2022  *  is \c true and malloc() fails.
2023  *
2024  * \note It is safe to pass a const pointer to \a mime_type if \a copy is \c true.
2025  *
2026  * \param object      A pointer to an existing PICTURE object.
2027  * \param mime_type   A pointer to the MIME type string.  The string must be
2028  *                    ASCII characters 0x20-0x7e, NUL-terminated.  No validation
2029  *                    is done.
2030  * \param copy        See above.
2031  * \assert
2032  *    \code object != NULL \endcode
2033  *    \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2034  *    \code (mime_type != NULL) \endcode
2035  * \retval FLAC__bool
2036  *    \c false if \a copy is \c true and malloc() fails, else \c true.
2037  */
2038 FLAC_API FLAC__bool FLAC__metadata_object_picture_set_mime_type(FLAC__StreamMetadata *object, char *mime_type, FLAC__bool copy);
2039
2040 /** Sets the description of a PICTURE block.
2041  *
2042  *  If \a copy is \c true, a copy of the string is stored; otherwise, the object
2043  *  takes ownership of the pointer.  The existing string will be freed if this
2044  *  function is successful, otherwise the original string will remain if \a copy
2045  *  is \c true and malloc() fails.
2046  *
2047  * \note It is safe to pass a const pointer to \a description if \a copy is \c true.
2048  *
2049  * \param object      A pointer to an existing PICTURE object.
2050  * \param description A pointer to the description string.  The string must be
2051  *                    valid UTF-8, NUL-terminated.  No validation is done.
2052  * \param copy        See above.
2053  * \assert
2054  *    \code object != NULL \endcode
2055  *    \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2056  *    \code (description != NULL) \endcode
2057  * \retval FLAC__bool
2058  *    \c false if \a copy is \c true and malloc() fails, else \c true.
2059  */
2060 FLAC_API FLAC__bool FLAC__metadata_object_picture_set_description(FLAC__StreamMetadata *object, FLAC__byte *description, FLAC__bool copy);
2061
2062 /** Sets the picture data of a PICTURE block.
2063  *
2064  *  If \a copy is \c true, a copy of the data is stored; otherwise, the object
2065  *  takes ownership of the pointer.  Also sets the \a data_length field of the
2066  *  metadata object to what is passed in as the \a length parameter.  The
2067  *  existing data will be freed if this function is successful, otherwise the
2068  *  original data and data_length will remain if \a copy is \c true and
2069  *  malloc() fails.
2070  *
2071  * \note It is safe to pass a const pointer to \a data if \a copy is \c true.
2072  *
2073  * \param object  A pointer to an existing PICTURE object.
2074  * \param data    A pointer to the data to set.
2075  * \param length  The length of \a data in bytes.
2076  * \param copy    See above.
2077  * \assert
2078  *    \code object != NULL \endcode
2079  *    \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2080  *    \code (data != NULL && length > 0) ||
2081  * (data == NULL && length == 0 && copy == false) \endcode
2082  * \retval FLAC__bool
2083  *    \c false if \a copy is \c true and malloc() fails, else \c true.
2084  */
2085 FLAC_API FLAC__bool FLAC__metadata_object_picture_set_data(FLAC__StreamMetadata *object, FLAC__byte *data, FLAC__uint32 length, FLAC__bool copy);
2086
2087 /** Check a PICTURE block to see if it conforms to the FLAC specification.
2088  *  See the format specification for limits on the contents of the
2089  *  PICTURE block.
2090  *
2091  * \param object     A pointer to existing PICTURE block to be checked.
2092  * \param violation  Address of a pointer to a string.  If there is a
2093  *                   violation, a pointer to a string explanation of the
2094  *                   violation will be returned here. \a violation may be
2095  *                   \c NULL if you don't need the returned string.  Do not
2096  *                   free the returned string; it will always point to static
2097  *                   data.
2098  * \assert
2099  *    \code object != NULL \endcode
2100  *    \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2101  * \retval FLAC__bool
2102  *    \c false if PICTURE block is illegal, else \c true.
2103  */
2104 FLAC_API FLAC__bool FLAC__metadata_object_picture_is_legal(const FLAC__StreamMetadata *object, const char **violation);
2105
2106 /* \} */
2107
2108 #ifdef __cplusplus
2109 }
2110 #endif
2111
2112 #endif