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