2c9fe843719370163c3401c74ad5aa2886a2fd7f
[flac.git] / include / FLAC / metadata.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2001,2002  Josh Coalson
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA  02111-1307, USA.
18  */
19
20 #ifndef FLAC__METADATA_H
21 #define FLAC__METADATA_H
22
23 #include "format.h"
24
25 /******************************************************************************
26         (For an example of how all these routines are used, see the source
27         code for the unit tests in src/test_libFLAC/metadata_*.c, or metaflac
28         in src/metaflac/)
29 ******************************************************************************/
30
31 /** \file include/FLAC/metadata.h
32  *
33  *  \brief
34  *  This module provides functions for creating and manipulating FLAC
35  *  metadata blocks in memory, and three progressively more powerful
36  *  interfaces for traversing and editing metadata in FLAC files.
37  *
38  *  See the detailed documentation for each interface in the
39  *  \link flac_metadata metadata \endlink module.
40  */
41
42 /** \defgroup flac_metadata FLAC/metadata.h: metadata interfaces
43  *  \ingroup flac
44  *
45  *  \brief
46  *  This module provides functions for creating and manipulating FLAC
47  *  metadata blocks in memory, and three progressively more powerful
48  *  interfaces for traversing and editing metadata in FLAC files.
49  *
50  *  There are three metadata interfaces of increasing complexity:
51  *
52  *  Level 0:
53  *  Read-only access to the STREAMINFO block.
54  *
55  *  Level 1:
56  *  Read-write access to all metadata blocks.  This level is write-
57  *  efficient in most cases (more on this below), and uses less memory
58  *  than level 2.
59  *
60  *  Level 2:
61  *  Read-write access to all metadata blocks.  This level is write-
62  *  efficient in all cases, but uses more memory since all metadata for
63  *  the whole file is read into memory and manipulated before writing
64  *  out again.
65  *
66  *  What do we mean by efficient?  When writing metadata back to a FLAC
67  *  file it is possible to grow or shrink the metadata such that the entire
68  *  file must be rewritten.  However, if the size remains the same during
69  *  changes or PADDING blocks are utilized, only the metadata needs to be
70  *  overwritten, which is much faster.
71  *
72  *  Efficient means the whole file is rewritten at most one time, and only
73  *  when necessary.  Level 1 is not efficient only in the case that you
74  *  cause more than one metadata block to grow or shrink beyond what can
75  *  be accomodated by padding.  In this case you should probably use level
76  *  2, which allows you to edit all the metadata for a file in memory and
77  *  write it out all at once.
78  *
79  *  All levels know how to skip over and not disturb an ID3v2 tag at the
80  *  front of the file.
81  *
82  *  In addition to the three interfaces, this module defines functions for
83  *  creating and manipulating various metadata objects in memory.  As we see
84  *  from the Format module, FLAC metadata blocks in memory are very primitive
85  *  structures for storing information in an efficient way.  Reading
86  *  information from the structures is easy but creating or modifying them
87  *  directly is more complex.  The metadata object routines here facilitate
88  *  this by taking care of the consistency and memory management drudgery.
89  *
90  *  Unless you will be using the level 1 or 2 interfaces to modify existing
91  *  metadata however, you will not probably not need these.
92  *
93  *  From a dependency standpoint, none of the encoders or decoders require
94  *  the metadata module.  This is so that embedded users can strip out the
95  *  metadata module from libFLAC to reduce the size and complexity.
96  */
97
98 #ifdef __cplusplus
99 extern "C" {
100 #endif
101
102
103 /** \defgroup flac_metadata_level0 FLAC/metadata.h: metadata level 0 interface
104  *  \ingroup flac_metadata
105  *
106  *  \brief
107  *  The level 0 interface consists of a single routine to read the
108  *  STREAMINFO block.
109  *
110  *  It skips any ID3v2 tag at the head of the file.
111  *
112  * \{
113  */
114
115 /** Read the STREAMINFO metadata block of the given FLAC file.  This function
116  *  will skip any ID3v2 tag at the head of the file.
117  *
118  * \param filename    The path to the FLAC file to read.
119  * \param streaminfo  A pointer to space for the STREAMINFO block.
120  * \assert
121  *    \code filename != NULL \endcode
122  *    \code streaminfo != NULL \endcode
123  * \retval FLAC__bool
124  *    \c true if a valid STREAMINFO block was read from \a filename.  Returns
125  *    \c false if there was a memory allocation error, a file decoder error,
126  *    or the file contained no STREAMINFO block.
127  */
128 FLAC__bool FLAC__metadata_get_streaminfo(const char *filename, FLAC__StreamMetadata *streaminfo);
129
130 /* \} */
131
132
133 /** \defgroup flac_metadata_level1 FLAC/metadata.h: metadata level 1 interface
134  *  \ingroup flac_metadata
135  *
136  * \brief
137  * The level 1 interface provides read-write access to FLAC file metadata and
138  * operates directly on the FLAC file.
139  *
140  * The general usage of this interface is:
141  *
142  * - Create an iterator using FLAC__metadata_simple_iterator_new()
143  * - Attach it to a file using FLAC__metadata_simple_iterator_init() and check
144  *   the exit code.  Call FLAC__metadata_simple_iterator_is_writable() to
145  *   see if the file is writable, or read-only access is allowed.
146  * - Use FLAC__metadata_simple_iterator_next() and
147  *   FLAC__metadata_simple_iterator_prev() to move around the blocks.
148  *   This is does not read the actual blocks themselves.
149  *   FLAC__metadata_simple_iterator_next() is relatively fast.
150  *   FLAC__metadata_simple_iterator_prev() is slower since it needs to search
151  *   forward from the front of the file.
152  * - Use FLAC__metadata_simple_iterator_get_block_type() or
153  *   FLAC__metadata_simple_iterator_get_block() to access the actual data at
154  *   the current iterator position.  The returned object is yours to modify
155  *   and free.
156  * - Use FLAC__metadata_simple_iterator_set_block() to write a modified block
157  *   back.  You must have write permission to the original file.  Make sure to
158  *   read the whole comment to FLAC__metadata_simple_iterator_set_block()
159  *   below.
160  * - Use FLAC__metadata_simple_iterator_insert_block_after() to add new blocks.
161  *   Use the object creation functions from
162  *   \link flac_metadata_object here \endlink to generate new objects.
163  * - Use FLAC__metadata_simple_iterator_delete_block() to remove the block
164  *   currently referred to by the iterator, or replace it with padding.
165  * - Destroy the iterator with FLAC__metadata_simple_iterator_delete() when
166  *   finished.
167  *
168  * \note
169  * The FLAC file remains open the whole time between
170  * FLAC__metadata_simple_iterator_init() and
171  * FLAC__metadata_simple_iterator_delete(), so make sure you are not altering
172  * the file during this time.
173  *
174  * \note
175  * Do not modify the \a is_last, \a length, or \a type fields of returned
176  * FLAC__MetadataType objects.  These are managed automatically.
177  *
178  * \note
179  * If any of the modification functions
180  * (FLAC__metadata_simple_iterator_set_block(),
181  * FLAC__metadata_simple_iterator_delete_block(),
182  * FLAC__metadata_simple_iterator_insert_block_after(), etc.) return \c false,
183  * you should delete the iterator as it may no longer be valid.
184  *
185  * \{
186  */
187
188 struct FLAC__Metadata_SimpleIterator;
189 /** The opaque structure definition for the level 1 iterator type.
190  *  See the
191  *  \link flac_metadata_level1 metadata level 1 module \endlink
192  *  for a detailed description.
193  */
194 typedef struct FLAC__Metadata_SimpleIterator FLAC__Metadata_SimpleIterator;
195
196 /** Status type for FLAC__Metadata_SimpleIterator.
197  *
198  *  The iterator's current status can be obtained by calling FLAC__metadata_simple_iterator_status().
199  */
200 typedef enum {
201
202         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK = 0,
203         /**< The iterator is in the normal OK state */
204
205         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT,
206         /**< The data passed into a function violated the function's usage criteria */
207
208         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE,
209         /**< The iterator could not open the target file */
210
211         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE,
212         /**< The iterator could not find the FLAC signature at the start of the file */
213
214         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE,
215         /**< The iterator tried to write to a file that was not writable */
216
217         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA,
218         /**< The iterator encountered input that does not conform to the FLAC metadata specification */
219
220         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR,
221         /**< The iterator encountered an error while reading the FLAC file */
222
223         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR,
224         /**< The iterator encountered an error while seeking in the FLAC file */
225
226         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR,
227         /**< The iterator encountered an error while writing the FLAC file */
228
229         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR,
230         /**< The iterator encountered an error renaming the FLAC file */
231
232         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR,
233         /**< The iterator encountered an error removing the temporary file */
234
235         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR,
236         /**< Memory allocation failed */
237
238         FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR
239         /**< The caller violated an assertion or an unexpected error occurred */
240
241 } FLAC__Metadata_SimpleIteratorStatus;
242
243 /** Maps a FLAC__Metadata_SimpleIteratorStatus to a C string.
244  *
245  *  Using a FLAC__Metadata_SimpleIteratorStatus as the index to this array
246  *  will give the string equivalent.  The contents should not be modified.
247  */
248 extern const char * const FLAC__Metadata_SimpleIteratorStatusString[];
249
250
251 /** Create a new iterator instance.
252  *
253  * \retval FLAC__Metadata_SimpleIterator*
254  *    \c NULL if there was an error allocating memory, else the new instance.
255  */
256 FLAC__Metadata_SimpleIterator *FLAC__metadata_simple_iterator_new();
257
258 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
259  *
260  * \param iterator  A pointer to an existing iterator.
261  * \assert
262  *    \code iterator != NULL \endcode
263  */
264 void FLAC__metadata_simple_iterator_delete(FLAC__Metadata_SimpleIterator *iterator);
265
266 /** Get the current status of the iterator.  Call this after a function
267  *  returns \c false to get the reason for the error.  Also resets the status
268  *  to FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK.
269  *
270  * \param iterator  A pointer to an existing iterator.
271  * \assert
272  *    \code iterator != NULL \endcode
273  * \retval FLAC__Metadata_SimpleIteratorStatus
274  *    The current status of the iterator.
275  */
276 FLAC__Metadata_SimpleIteratorStatus FLAC__metadata_simple_iterator_status(FLAC__Metadata_SimpleIterator *iterator);
277
278 /** Initialize the iterator to point to the first metadata block in the
279  *  given FLAC file.  If \a preserve_file_stats is \c true, the owner and
280  *  modification time will be preserved even if the FLAC file is written.
281  *
282  * \param iterator             A pointer to an existing iterator.
283  * \param filename             The path to the FLAC file.
284  * \param preserve_file_stats  See above.
285  * \assert
286  *    \code iterator != NULL \endcode
287  *    \code filename != NULL \endcode
288  * \retval FLAC__bool
289  *    \c false if a memory allocation error occurs, the file can't be
290  *    opened, or another error occurs, else \c true.
291  */
292 FLAC__bool FLAC__metadata_simple_iterator_init(FLAC__Metadata_SimpleIterator *iterator, const char *filename, FLAC__bool preserve_file_stats);
293
294 /** Returns \c true if the FLAC file is writable.  If \c false, calls to
295  *  FLAC__metadata_simple_iterator_set_block() and
296  *  FLAC__metadata_simple_iterator_insert_block_after() will fail.
297  *
298  * \param iterator             A pointer to an existing iterator.
299  * \assert
300  *    \code iterator != NULL \endcode
301  * \retval FLAC__bool
302  *    See above.
303  */
304 FLAC__bool FLAC__metadata_simple_iterator_is_writable(const FLAC__Metadata_SimpleIterator *iterator);
305
306 /** Moves the iterator forward one metadata block, returning \c false if
307  *  already at the end.
308  *
309  * \param iterator  A pointer to an existing initialized iterator.
310  * \assert
311  *    \code iterator != NULL \endcode
312  *    \a iterator has been successfully initialized with
313  *    FLAC__metadata_simple_iterator_init()
314  * \retval FLAC__bool
315  *    \c false if already at the last metadata block of the chain, else
316  *    \c true.
317  */
318 FLAC__bool FLAC__metadata_simple_iterator_next(FLAC__Metadata_SimpleIterator *iterator);
319
320 /** Moves the iterator backward one metadata block, returning \c false if
321  *  already at the beginning.
322  *
323  * \param iterator  A pointer to an existing initialized iterator.
324  * \assert
325  *    \code iterator != NULL \endcode
326  *    \a iterator has been successfully initialized with
327  *    FLAC__metadata_simple_iterator_init()
328  * \retval FLAC__bool
329  *    \c false if already at the first metadata block of the chain, else
330  *    \c true.
331  */
332 FLAC__bool FLAC__metadata_simple_iterator_prev(FLAC__Metadata_SimpleIterator *iterator);
333
334 /** Get the type of the metadata block at the current position.  This
335  *  avoids reading the actual block data which can save time for large
336  *  blocks.
337  *
338  * \param iterator  A pointer to an existing initialized iterator.
339  * \assert
340  *    \code iterator != NULL \endcode
341  *    \a iterator has been successfully initialized with
342  *    FLAC__metadata_simple_iterator_init()
343  * \retval FLAC__MetadataType
344  *    The type of the metadata block at the current iterator position.
345  */
346
347 FLAC__MetadataType FLAC__metadata_simple_iterator_get_block_type(const FLAC__Metadata_SimpleIterator *iterator);
348
349 /** Get the metadata block at the current position.  You can modify the
350  *  block but must use FLAC__metadata_simple_iterator_set_block() to
351  *  write it back to the FLAC file.
352  *
353  *  You must call FLAC__metadata_object_delete() on the returned object
354  *  when you are finished with it.
355  *
356  * \param iterator  A pointer to an existing initialized iterator.
357  * \assert
358  *    \code iterator != NULL \endcode
359  *    \a iterator has been successfully initialized with
360  *    FLAC__metadata_simple_iterator_init()
361  * \retval FLAC__StreamMetadata*
362  *    The current metadata block.
363  */
364 FLAC__StreamMetadata *FLAC__metadata_simple_iterator_get_block(FLAC__Metadata_SimpleIterator *iterator);
365
366 /** Write a block back to the FLAC file.  This function tries to be
367  *  as efficient as possible; how the block is actually written is
368  *  shown by the following:
369  *
370  *  Existing block is a STREAMINFO block and the new block is a
371  *  STREAMINFO block: the new block is written in place.  Make sure
372  *  you know what you're doing when changing the values of a
373  *  STREAMINFO block.
374  *
375  *  Existing block is a STREAMINFO block and the new block is a
376  *  not a STREAMINFO block: this is an error since the first block
377  *  must be a STREAMINFO block.  Returns \c false without altering the
378  *  file.
379  *
380  *  Existing block is not a STREAMINFO block and the new block is a
381  *  STREAMINFO block: this is an error since there may be only one
382  *  STREAMINFO block.  Returns \c false without altering the file.
383  *
384  *  Existing block and new block are the same length: the existing
385  *  block will be replaced by the new block, written in place.
386  *
387  *  Existing block is longer than new block: if use_padding is \c true,
388  *  the existing block will be overwritten in place with the new
389  *  block followed by a PADDING block, if possible, to make the total
390  *  size the same as the existing block.  Remember that a padding
391  *  block requires at least four bytes so if the difference in size
392  *  between the new block and existing block is less than that, the
393  *  entire file will have to be rewritten, using the new block's
394  *  exact size.  If use_padding is \c false, the entire file will be
395  *  rewritten, replacing the existing block by the new block.
396  *
397  *  Existing block is shorter than new block: if use_padding is \c true,
398  *  the function will try and expand the new block into the following
399  *  PADDING block, if it exists and doing so won't shrink the PADDING
400  *  block to less than 4 bytes.  If there is no following PADDING
401  *  block, or it will shrink to less than 4 bytes, or use_padding is
402  *  \c false, the entire file is rewritten, replacing the existing block
403  *  with the new block.  Note that in this case any following PADDING
404  *  block is preserved as is.
405  *
406  *  After writing the block, the iterator will remain in the same
407  *  place, i.e. pointing to the new block.
408  *
409  * \param iterator     A pointer to an existing initialized iterator.
410  * \param block        The block to set.
411  * \param use_padding  See above.
412  * \assert
413  *    \code iterator != NULL \endcode
414  *    \a iterator has been successfully initialized with
415  *    FLAC__metadata_simple_iterator_init()
416  *    \code block != NULL \endcode
417  * \retval FLAC__bool
418  *    \c true if successful, else \c false.
419  */
420 FLAC__bool FLAC__metadata_simple_iterator_set_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
421
422 /** This is similar to FLAC__metadata_simple_iterator_set_block()
423  *  except that instead of writing over an existing block, it appends
424  *  a block after the existing block.  \a use_padding is again used to
425  *  tell the function to try an expand into following padding in an
426  *  attempt to avoid rewriting the entire file.
427  *
428  *  This function will fail and return \c false if given a STREAMINFO
429  *  block.
430  *
431  *  After writing the block, the iterator will be pointing to the
432  *  new block.
433  *
434  * \param iterator     A pointer to an existing initialized iterator.
435  * \param block        The block to set.
436  * \param use_padding  See above.
437  * \assert
438  *    \code iterator != NULL \endcode
439  *    \a iterator has been successfully initialized with
440  *    FLAC__metadata_simple_iterator_init()
441  *    \code block != NULL \endcode
442  * \retval FLAC__bool
443  *    \c true if successful, else \c false.
444  */
445 FLAC__bool FLAC__metadata_simple_iterator_insert_block_after(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding);
446
447 /** Deletes the block at the current position.  This will cause the
448  *  entire FLAC file to be rewritten, unless \a use_padding is \c true,
449  *  in which case the block will be replaced by an equal-sized PADDING
450  *  block.  The iterator will be left pointing to the block before the
451  *  one just deleted.
452  *
453  *  You may not delete the STREAMINFO block.
454  *
455  * \param iterator     A pointer to an existing initialized iterator.
456  * \param use_padding  See above.
457  * \assert
458  *    \code iterator != NULL \endcode
459  *    \a iterator has been successfully initialized with
460  *    FLAC__metadata_simple_iterator_init()
461  * \retval FLAC__bool
462  *    \c true if successful, else \c false.
463  */
464 FLAC__bool FLAC__metadata_simple_iterator_delete_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__bool use_padding);
465
466 /* \} */
467
468
469 /** \defgroup flac_metadata_level2 FLAC/metadata.h: metadata level 2 interface
470  *  \ingroup flac_metadata
471  *
472  * \brief
473  * The level 2 interface provides read-write access to FLAC file metadata;
474  * all metadata is read into memory, operated on in memory, and then written
475  * to file, which is more efficient than level 1 when editing multiple blocks.
476  *
477  * The general usage of this interface is:
478  *
479  * - Create a new chain using FLAC__metadata_chain_new().  A chain is a
480  *   linked list of FLAC metadata blocks.
481  * - Read all metadata into the the chain from a FLAC file using
482  *   FLAC__metadata_chain_read() and check the status.
483  * - Optionally, consolidate the padding using
484  *   FLAC__metadata_chain_merge_padding() or
485  *   FLAC__metadata_chain_sort_padding().
486  * - Create a new iterator using FLAC__metadata_iterator_new()
487  * - Initialize the iterator to point to the first element in the chain
488  *   using FLAC__metadata_iterator_init()
489  * - Traverse the chain using FLAC__metadata_iterator_next and
490  *   FLAC__metadata_iterator_prev().
491  * - Get a block for reading or modification using
492  *   FLAC__metadata_iterator_get_block().  The pointer to the object
493  *   inside the chain is returned, so the block is yours to modify.
494  *   Changes will be reflected in the FLAC file when you write the
495  *   chain.  You can also add and delete blocks (see functions below).
496  * - When done, write out the chain using FLAC__metadata_chain_write().
497  *   Make sure to read the whole comment to the function below.
498  * - Delete the chain using FLAC__metadata_chain_delete().
499  *
500  * \note
501  * Even though the FLAC file is not open while the chain is being
502  * manipulated, you must not alter the file externally during
503  * this time.  The chain assumes the FLAC file will not change
504  * between the time of FLAC__metadata_chain_read() and
505  * FLAC__metadata_chain_write().
506  *
507  * \note
508  * Do not modify the is_last, length, or type fields of returned
509  * FLAC__MetadataType objects.  These are managed automatically.
510  *
511  * \note
512  * The metadata objects returned by FLAC__metadata_iterator_get_block()
513  * are owned by the chain; do not FLAC__metadata_object_delete() them.
514  * In the same way, blocks passed to FLAC__metadata_iterator_set_block()
515  * become owned by the chain and they will be deleted when the chain is
516  * deleted.
517  *
518  * \{
519  */
520
521 struct FLAC__Metadata_Chain;
522 /** The opaque structure definition for the level 2 chain type.
523  */
524 typedef struct FLAC__Metadata_Chain FLAC__Metadata_Chain;
525
526 struct FLAC__Metadata_Iterator;
527 /** The opaque structure definition for the level 2 iterator type.
528  */
529 typedef struct FLAC__Metadata_Iterator FLAC__Metadata_Iterator;
530
531 typedef enum {
532         FLAC__METADATA_CHAIN_STATUS_OK = 0,
533         /**< The chain is in the normal OK state */
534
535         FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT,
536         /**< The data passed into a function violated the function's usage criteria */
537
538         FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE,
539         /**< The chain could not open the target file */
540
541         FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE,
542         /**< The chain could not find the FLAC signature at the start of the file */
543
544         FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE,
545         /**< The chain tried to write to a file that was not writable */
546
547         FLAC__METADATA_CHAIN_STATUS_BAD_METADATA,
548         /**< The chain encountered input that does not conform to the FLAC metadata specification */
549
550         FLAC__METADATA_CHAIN_STATUS_READ_ERROR,
551         /**< The chain encountered an error while reading the FLAC file */
552
553         FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR,
554         /**< The chain encountered an error while seeking in the FLAC file */
555
556         FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR,
557         /**< The chain encountered an error while writing the FLAC file */
558
559         FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR,
560         /**< The chain encountered an error renaming the FLAC file */
561
562         FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR,
563         /**< The chain encountered an error removing the temporary file */
564
565         FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR,
566         /**< Memory allocation failed */
567
568         FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR
569         /**< The caller violated an assertion or an unexpected error occurred */
570
571 } FLAC__Metadata_ChainStatus;
572
573 /** Maps a FLAC__Metadata_ChainStatus to a C string.
574  *
575  *  Using a FLAC__Metadata_ChainStatus as the index to this array
576  *  will give the string equivalent.  The contents should not be modified.
577  */
578 extern const char * const FLAC__Metadata_ChainStatusString[];
579
580 /*********** FLAC__Metadata_Chain ***********/
581
582 /** Create a new chain instance.
583  *
584  * \retval FLAC__Metadata_Chain*
585  *    \c NULL if there was an error allocating memory, else the new instance.
586  */
587 FLAC__Metadata_Chain *FLAC__metadata_chain_new();
588
589 /** Free a chain instance.  Deletes the object pointed to by \a chain.
590  *
591  * \param chain  A pointer to an existing chain.
592  * \assert
593  *    \code chain != NULL \endcode
594  */
595 void FLAC__metadata_chain_delete(FLAC__Metadata_Chain *chain);
596
597 /** Get the current status of the chain.  Call this after a function
598  *  returns \c false to get the reason for the error.  Also resets the
599  *  status to FLAC__METADATA_CHAIN_STATUS_OK.
600  *
601  * \param chain    A pointer to an existing chain.
602  * \assert
603  *    \code chain != NULL \endcode
604  * \retval FLAC__Metadata_ChainStatus
605  *    The current status of the chain.
606  */
607 FLAC__Metadata_ChainStatus FLAC__metadata_chain_status(FLAC__Metadata_Chain *chain);
608
609 /** Read all metadata from a FLAC file into the chain.
610  *
611  * \param chain    A pointer to an existing chain.
612  * \param filename The path to the FLAC file to read.
613  * \assert
614  *    \code chain != NULL \endcode
615  *    \code filename != NULL \endcode
616  * \retval FLAC__bool
617  *    \c true if a valid list of metadata blocks was read from
618  *    \a filename, else \c false.  On failure, check the status with
619  *    FLAC__metadata_chain_status().
620  */
621 FLAC__bool FLAC__metadata_chain_read(FLAC__Metadata_Chain *chain, const char *filename);
622
623 /** Write all metadata out to the FLAC file.  This function tries to be as
624  *  efficient as possible; how the metadata is actually written is shown by
625  *  the following:
626  *
627  *  If the current chain is the same size as the existing metadata, the new
628  *  data is written in place.
629  *
630  *  If the current chain is longer than the existing metadata, and
631  *  \a use_padding is \c true, and the last block is a PADDING block of
632  *  sufficient length, the function will truncate the final padding block
633  *  so that the overall size of the metadata is the same as the existing
634  *  metadata, and then just rewrite the metadata.  Otherwise, if not all of
635  *  the above conditions are met, the entire FLAC file must be rewritten.
636  *  If you want to use padding this way it is a good idea to call
637  *  FLAC__metadata_chain_sort_padding() first so that you have the maximum
638  *  amount of padding to work with, unless you need to preserve ordering
639  *  of the PADDING blocks for some reason.
640  *
641  *  If the current chain is shorter than the existing metadata, and
642  *  \a use_padding is \c true, and the final block is a PADDING block, the padding
643  *  is extended to make the overall size the same as the existing data.  If
644  *  \a use_padding is \c true and the last block is not a PADDING block, a new
645  *  PADDING block is added to the end of the new data to make it the same
646  *  size as the existing data (if possible, see the note to
647  *  FLAC__metadata_simple_iterator_set_block() about the four byte limit)
648  *  and the new data is written in place.  If none of the above apply or
649  *  \a use_padding is \c false, the entire FLAC file is rewritten.
650  *
651  *  If \a preserve_file_stats is \c true, the owner and modification time will
652  *  be preserved even if the FLAC file is written.
653  *
654  * \param chain               A pointer to an existing chain.
655  * \param use_padding         See above.
656  * \param preserve_file_stats See above.
657  * \assert
658  *    \code chain != NULL \endcode
659  * \retval FLAC__bool
660  *    \c true if the write succeeded, else \c false.  On failure,
661  *    check the status with FLAC__metadata_chain_status().
662  */
663 FLAC__bool FLAC__metadata_chain_write(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__bool preserve_file_stats);
664
665 /** Merge adjacent PADDING blocks into a single block.
666  *
667  * \note This function does not write to the FLAC file, it only
668  * modifies the chain.
669  *
670  * \warning Any iterator on the current chain will become invalid after this
671  * call.  You should delete the iterator and get a new one.
672  *
673  * \param chain               A pointer to an existing chain.
674  * \assert
675  *    \code chain != NULL \endcode
676  */
677 void FLAC__metadata_chain_merge_padding(FLAC__Metadata_Chain *chain);
678
679 /** This function will move all PADDING blocks to the end on the metadata,
680  *  then merge them into a single block.
681  *
682  * \note This function does not write to the FLAC file, it only
683  * modifies the chain.
684  *
685  * \warning Any iterator on the current chain will become invalid after this
686  * call.  You should delete the iterator and get a new one.
687  *
688  * \param chain  A pointer to an existing chain.
689  * \assert
690  *    \code chain != NULL \endcode
691  */
692 void FLAC__metadata_chain_sort_padding(FLAC__Metadata_Chain *chain);
693
694
695 /*********** FLAC__Metadata_Iterator ***********/
696
697 /** Create a new iterator instance.
698  *
699  * \retval FLAC__Metadata_Iterator*
700  *    \c NULL if there was an error allocating memory, else the new instance.
701  */
702 FLAC__Metadata_Iterator *FLAC__metadata_iterator_new();
703
704 /** Free an iterator instance.  Deletes the object pointed to by \a iterator.
705  *
706  * \param iterator  A pointer to an existing iterator.
707  * \assert
708  *    \code iterator != NULL \endcode
709  */
710 void FLAC__metadata_iterator_delete(FLAC__Metadata_Iterator *iterator);
711
712 /** Initialize the iterator to point to the first metadata block in the
713  *  given chain.
714  *
715  * \param iterator  A pointer to an existing iterator.
716  * \param chain     A pointer to an existing and initialized (read) chain.
717  * \assert
718  *    \code iterator != NULL \endcode
719  *    \code chain != NULL \endcode
720  */
721 void FLAC__metadata_iterator_init(FLAC__Metadata_Iterator *iterator, FLAC__Metadata_Chain *chain);
722
723 /** Moves the iterator forward one metadata block, returning \c false if
724  *  already at the end.
725  *
726  * \param iterator  A pointer to an existing initialized iterator.
727  * \assert
728  *    \code iterator != NULL \endcode
729  *    \a iterator has been successfully initialized with
730  *    FLAC__metadata_iterator_init()
731  * \retval FLAC__bool
732  *    \c false if already at the last metadata block of the chain, else
733  *    \c true.
734  */
735 FLAC__bool FLAC__metadata_iterator_next(FLAC__Metadata_Iterator *iterator);
736
737 /** Moves the iterator backward one metadata block, returning \c false if
738  *  already at the beginning.
739  *
740  * \param iterator  A pointer to an existing initialized iterator.
741  * \assert
742  *    \code iterator != NULL \endcode
743  *    \a iterator has been successfully initialized with
744  *    FLAC__metadata_iterator_init()
745  * \retval FLAC__bool
746  *    \c false if already at the first metadata block of the chain, else
747  *    \c true.
748  */
749 FLAC__bool FLAC__metadata_iterator_prev(FLAC__Metadata_Iterator *iterator);
750
751 /** Get the type of the metadata block at the current position.
752  *
753  * \param iterator  A pointer to an existing initialized iterator.
754  * \assert
755  *    \code iterator != NULL \endcode
756  *    \a iterator has been successfully initialized with
757  *    FLAC__metadata_iterator_init()
758  * \retval FLAC__MetadataType
759  *    The type of the metadata block at the current iterator position.
760  */
761 FLAC__MetadataType FLAC__metadata_iterator_get_block_type(const FLAC__Metadata_Iterator *iterator);
762
763 /** Get the metadata block at the current position.  You can modify
764  *  the block in place but must write the chain before the changes
765  *  are reflected to the FLAC file.  You do not need to call
766  *  FLAC__metadata_iterator_set_block() to reflect the changes;
767  *  the pointer returned by FLAC__metadata_iterator_get_block()
768  *  points directly into the chain.
769  *
770  * \warning
771  * Do not call FLAC__metadata_object_delete() on the returned object;
772  * to delete a block use FLAC__metadata_iterator_delete_block().
773  *
774  * \param iterator  A pointer to an existing initialized iterator.
775  * \assert
776  *    \code iterator != NULL \endcode
777  *    \a iterator has been successfully initialized with
778  *    FLAC__metadata_iterator_init()
779  * \retval FLAC__StreamMetadata*
780  *    The current metadata block.
781  */
782 FLAC__StreamMetadata *FLAC__metadata_iterator_get_block(FLAC__Metadata_Iterator *iterator);
783
784 /** Set the metadata block at the current position, replacing the existing
785  *  block.  The new block passed in becomes owned by the chain and it will be
786  *  deleted when the chain is deleted.
787  *
788  * \param iterator  A pointer to an existing initialized iterator.
789  * \param block     A pointer to a metadata block.
790  * \assert
791  *    \code iterator != NULL \endcode
792  *    \a iterator has been successfully initialized with
793  *    FLAC__metadata_iterator_init()
794  *    \code block != NULL \endcode
795  * \retval FLAC__bool
796  *    \c false if the conditions in the above description are not met, or
797  *    a memory allocation error occurs, otherwise \c true.
798  */
799 FLAC__bool FLAC__metadata_iterator_set_block(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
800
801 /** Removes the current block from the chain.  If \a replace_with_padding is
802  *  \c true, the block will instead be replaced with a padding block of equal
803  *  size.  You can not delete the STREAMINFO block.  The iterator will be
804  *  left pointing to the block before the one just "deleted", even if
805  *  \a replace_with_padding is \c true.
806  *
807  * \param iterator              A pointer to an existing initialized iterator.
808  * \param replace_with_padding  See above.
809  * \assert
810  *    \code iterator != NULL \endcode
811  *    \a iterator has been successfully initialized with
812  *    FLAC__metadata_iterator_init()
813  * \retval FLAC__bool
814  *    \c false if the conditions in the above description are not met,
815  *    otherwise \c true.
816  */
817 FLAC__bool FLAC__metadata_iterator_delete_block(FLAC__Metadata_Iterator *iterator, FLAC__bool replace_with_padding);
818
819 /** Insert a new block before the current block.  You cannot insert a block
820  *  before the first STREAMINFO block.  You cannot insert a STREAMINFO block
821  *  as there can be only one, the one that already exists at the head when you
822  *  read in a chain.  The chain takes ownership of the new block and it will be
823  *  deleted when the chain is deleted.  The iterator will be left pointing to
824  *  the new block.
825  *
826  * \param iterator  A pointer to an existing initialized iterator.
827  * \param block     A pointer to a metadata block to insert.
828  * \assert
829  *    \code iterator != NULL \endcode
830  *    \a iterator has been successfully initialized with
831  *    FLAC__metadata_iterator_init()
832  * \retval FLAC__bool
833  *    \c false if the conditions in the above description are not met, or
834  *    a memory allocation error occurs, otherwise \c true.
835  */
836 FLAC__bool FLAC__metadata_iterator_insert_block_before(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
837
838 /** Insert a new block after the current block.  You cannot insert a STREAMINFO
839  *  block as there can be only one, the one that already exists at the head when
840  *  you read in a chain.  The chain takes ownership of the new block and it will
841  *  be deleted when the chain is deleted.  The iterator will be left pointing to
842  *  the new block.
843  *
844  * \param iterator  A pointer to an existing initialized iterator.
845  * \param block     A pointer to a metadata block to insert.
846  * \assert
847  *    \code iterator != NULL \endcode
848  *    \a iterator has been successfully initialized with
849  *    FLAC__metadata_iterator_init()
850  * \retval FLAC__bool
851  *    \c false if the conditions in the above description are not met, or
852  *    a memory allocation error occurs, otherwise \c true.
853  */
854 FLAC__bool FLAC__metadata_iterator_insert_block_after(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block);
855
856 /* \} */
857
858
859 /** \defgroup flac_metadata_object FLAC/metadata.h: metadata object methods
860  *  \ingroup flac_metadata
861  *
862  * \brief
863  * This module contains methods for manipulating FLAC metadata objects.
864  *
865  * Since many are variable length we have to be careful about the memory
866  * management.  We decree that all pointers to data in the object are
867  * owned by the object and memory-managed by the object.
868  *
869  * Use the FLAC__metadata_object_new() and FLAC__metadata_object_delete()
870  * functions to create all instances.  When using the
871  * FLAC__metadata_object_set_*() functions to set pointers to data, set
872  * \a copy to \c true to have the function make it's own copy of the data, or
873  * to \c false to give the object ownership of your data.  In the latter case
874  * your pointer must be freeable by free() and will be free()d when the object
875  * is FLAC__metadata_object_delete()d.  It is legal to pass a null pointer as
876  * the data pointer to a FLAC__metadata_object_set_*() function as long as
877  * the length argument is 0 and the \a copy argument is \c false.
878  *
879  * The FLAC__metadata_object_new() and FLAC__metadata_object_clone() function
880  * will return \c NULL in the case of a memory allocation error, otherwise a new
881  * object.  The FLAC__metadata_object_set_*() functions return \c false in the
882  * case of a memory allocation error.
883  *
884  * We don't have the convenience of C++ here, so note that the library relies
885  * on you to keep the types straight.  In other words, if you pass, for
886  * example, a FLAC__StreamMetadata* that represents a STREAMINFO block to
887  * FLAC__metadata_object_application_set_data(), you will get an assertion
888  * failure.
889  *
890  * There is no need to recalculate the length field on metadata blocks you
891  * have modified.  They will be calculated automatically before they  are
892  * written back to a file.
893  *
894  * \{
895  */
896
897
898 /** Create a new metadata object instance of the given type.
899  *
900  *  The object will be "empty"; i.e. values and data pointers will be \c 0.
901  *
902  * \param type  Type of object to create
903  * \retval FLAC__StreamMetadata*
904  *    \c NULL if there was an error allocating memory, else the new instance.
905  */
906 FLAC__StreamMetadata *FLAC__metadata_object_new(FLAC__MetadataType type);
907
908 /** Create a copy of an existing metadata object.
909  *
910  *  The copy is a "deep" copy, i.e. dynamically allocated data within the
911  *  object is also copied.  The caller takes ownership of the new block and
912  *  is responsible for freeing it with FLAC__metadata_object_delete().
913  *
914  * \param object  Pointer to object to copy.
915  * \assert
916  *    \code object != NULL \endcode
917  * \retval FLAC__StreamMetadata*
918  *    \c NULL if there was an error allocating memory, else the new instance.
919  */
920 FLAC__StreamMetadata *FLAC__metadata_object_clone(const FLAC__StreamMetadata *object);
921
922 /** Free a metadata object.  Deletes the object pointed to by \a object.
923  *
924  *  The delete is a "deep" delete, i.e. dynamically allocated data within the
925  *  object is also deleted.
926  *
927  * \param object  A pointer to an existing object.
928  * \assert
929  *    \code object != NULL \endcode
930  */
931 void FLAC__metadata_object_delete(FLAC__StreamMetadata *object);
932
933 /** Compares two metadata objects.
934  *
935  *  The compare is "deep", i.e. dynamically allocated data within the
936  *  object is also compared.
937  *
938  * \param block1  A pointer to an existing object.
939  * \param block2  A pointer to an existing object.
940  * \assert
941  *    \code block1 != NULL \endcode
942  *    \code block2 != NULL \endcode
943  * \retval FLAC__bool
944  *    \c true if objects are identical, else \c false.
945  */
946 FLAC__bool FLAC__metadata_object_is_equal(const FLAC__StreamMetadata *block1, const FLAC__StreamMetadata *block2);
947
948 /** Sets the application data of an APPLICATION block.
949  *
950  *  If \a copy is \c true, a copy of the data is stored; otherwise, the object
951  *  takes ownership of the pointer.  Returns \c false if \a copy == \c true
952  *  and malloc fails.
953  *
954  * \param object  A pointer to an existing APPLICATION object.
955  * \param data    A pointer to the data to set.
956  * \param length  The length of \a data in bytes.
957  * \param copy    See above.
958  * \assert
959  *    \code object != NULL \endcode
960  *    \code object->type == FLAC__METADATA_TYPE_APPLICATION \endcode
961  *    \code (data != NULL && length > 0) ||
962  * (data == NULL && length == 0 && copy == false) \endcode
963  * \retval FLAC__bool
964  *    \c false if \a copy is \c true and malloc fails, else \c true.
965  */
966 FLAC__bool FLAC__metadata_object_application_set_data(FLAC__StreamMetadata *object, FLAC__byte *data, unsigned length, FLAC__bool copy);
967
968 /** Resize the seekpoint array.
969  *
970  *  If the size shrinks, elements will truncated; if it grows, new placeholder
971  *  points will be added to the end.
972  *
973  * \param object          A pointer to an existing SEEKTABLE object.
974  * \param new_num_points  The desired length of the array; may be \c 0.
975  * \assert
976  *    \code object != NULL \endcode
977  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
978  *    \code (object->data.seek_table.points == NULL && object->data.seek_table.num_points == 0) ||
979  * (object->data.seek_table.points != NULL && object->data.seek_table.num_points > 0) \endcode
980  * \retval FLAC__bool
981  *    \c false if memory allocation error, else \c true.
982  */
983 FLAC__bool FLAC__metadata_object_seektable_resize_points(FLAC__StreamMetadata *object, unsigned new_num_points);
984
985 /** Set a seekpoint in a seektable.
986  *
987  * \param object     A pointer to an existing SEEKTABLE object.
988  * \param point_num  Index into seekpoint array to set.
989  * \param point      The point to set.
990  * \assert
991  *    \code object != NULL \endcode
992  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
993  *    \code object->data.seek_table.num_points > point_num \endcode
994  */
995 void FLAC__metadata_object_seektable_set_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
996
997 /** Insert a seekpoint into a seektable.
998  *
999  * \param object     A pointer to an existing SEEKTABLE object.
1000  * \param point_num  Index into seekpoint array to set.
1001  * \param point      The point to set.
1002  * \assert
1003  *    \code object != NULL \endcode
1004  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1005  *    \code object->data.seek_table.num_points >= point_num \endcode
1006  * \retval FLAC__bool
1007  *    \c false if memory allocation error, else \c true.
1008  */
1009 FLAC__bool FLAC__metadata_object_seektable_insert_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1010
1011 /** Delete a seekpoint from a seektable.
1012  *
1013  * \param object     A pointer to an existing SEEKTABLE object.
1014  * \param point_num  Index into seekpoint array to set.
1015  * \assert
1016  *    \code object != NULL \endcode
1017  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1018  *    \code object->data.seek_table.num_points > point_num \endcode
1019  * \retval FLAC__bool
1020  *    \c false if memory allocation error, else \c true.
1021  */
1022 FLAC__bool FLAC__metadata_object_seektable_delete_point(FLAC__StreamMetadata *object, unsigned point_num);
1023
1024 /** Check a seektable to see if it conforms to the FLAC specification.
1025  *  See the format specification for limits on the contents of the
1026  *  seektable.
1027  *
1028  * \param object  A pointer to an existing SEEKTABLE object.
1029  * \assert
1030  *    \code object != NULL \endcode
1031  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1032  * \retval FLAC__bool
1033  *    \c false if seek table is illegal, else \c true.
1034  */
1035 FLAC__bool FLAC__metadata_object_seektable_is_legal(const FLAC__StreamMetadata *object);
1036
1037 /** Append a number of placeholder points to the end of a seek table.
1038  *
1039  * \note
1040  * As with the other ..._seektable_template_... functions, you should
1041  * call FLAC__metadata_object_seektable_template_sort() when finished
1042  * to make the seek table legal.
1043  *
1044  * \param object  A pointer to an existing SEEKTABLE object.
1045  * \param num     The number of placeholder points to append.
1046  * \assert
1047  *    \code object != NULL \endcode
1048  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1049  * \retval FLAC__bool
1050  *    \c false if memory allocation fails, else \c true.
1051  */
1052 FLAC__bool FLAC__metadata_object_seektable_template_append_placeholders(FLAC__StreamMetadata *object, unsigned num);
1053
1054 /** Append a specific seek point template to the end of a seek table.
1055  *
1056  * \note
1057  * As with the other ..._seektable_template_... functions, you should
1058  * call FLAC__metadata_object_seektable_template_sort() when finished
1059  * to make the seek table legal.
1060  *
1061  * \param object  A pointer to an existing SEEKTABLE object.
1062  * \param sample_number  The sample number of the seek point template.
1063  * \assert
1064  *    \code object != NULL \endcode
1065  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1066  * \retval FLAC__bool
1067  *    \c false if memory allocation fails, else \c true.
1068  */
1069 FLAC__bool FLAC__metadata_object_seektable_template_append_point(FLAC__StreamMetadata *object, FLAC__uint64 sample_number);
1070
1071 /** Append specific seek point templates to the end of a seek table.
1072  *
1073  * \note
1074  * As with the other ..._seektable_template_... functions, you should
1075  * call FLAC__metadata_object_seektable_template_sort() when finished
1076  * to make the seek table legal.
1077  *
1078  * \param object  A pointer to an existing SEEKTABLE object.
1079  * \param sample_numbers  An array of sample numbers for the seek points.
1080  * \param num     The number of seek point templates to append.
1081  * \assert
1082  *    \code object != NULL \endcode
1083  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1084  * \retval FLAC__bool
1085  *    \c false if memory allocation fails, else \c true.
1086  */
1087 FLAC__bool FLAC__metadata_object_seektable_template_append_points(FLAC__StreamMetadata *object, FLAC__uint64 sample_numbers[], unsigned num);
1088
1089 /** Append a set of evenly-spaced seek point templates to the end of a
1090  *  seek table.
1091  *
1092  * \note
1093  * As with the other ..._seektable_template_... functions, you should
1094  * call FLAC__metadata_object_seektable_template_sort() when finished
1095  * to make the seek table legal.
1096  *
1097  * \param object  A pointer to an existing SEEKTABLE object.
1098  * \param num     The number of placeholder points to append.
1099  * \param total_samples  The total number of samples to be encoded;
1100  *                       the seekpoints will be spaced approximately
1101  *                       \a total_samples / \a num samples apart.
1102  * \assert
1103  *    \code object != NULL \endcode
1104  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1105  * \retval FLAC__bool
1106  *    \c false if memory allocation fails, else \c true.
1107  */
1108 FLAC__bool FLAC__metadata_object_seektable_template_append_spaced_points(FLAC__StreamMetadata *object, unsigned num, FLAC__uint64 total_samples);
1109
1110 /** Sort a seek table's seek points according to the format specification,
1111  *  removing duplicates.
1112  *
1113  * \param object   A pointer to a seek table to be sorted.
1114  * \param compact  If \c false, behaves like FLAC__format_seektable_sort().
1115  *                 If \c true, duplicates are deleted and the seek table is
1116  *                 shrunk appropriately; the number of placeholder points
1117  *                 present in the seek table will be the same after the call
1118  *                 as before.
1119  * \assert
1120  *    \code object != NULL \endcode
1121  *    \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1122  * \retval FLAC__bool
1123  *    \c false if realloc fails, else \c true.
1124  */
1125 FLAC__bool FLAC__metadata_object_seektable_template_sort(FLAC__StreamMetadata *object, FLAC__bool compact);
1126
1127 /** Sets the vendor string in a VORBIS_COMMENT block.
1128  *
1129  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1130  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1131  *  \a copy == \c true and malloc fails.
1132  *
1133  * \param object  A pointer to an existing VORBIS_COMMENT object.
1134  * \param entry   The entry to set the vendor string to.
1135  * \param copy    See above.
1136  * \assert
1137  *    \code object != NULL \endcode
1138  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1139  *    \code (entry->entry != NULL && entry->length > 0) ||
1140  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1141  * \retval FLAC__bool
1142  *    \c false if \a copy is \c true and malloc fails, else \c true.
1143  */
1144 FLAC__bool FLAC__metadata_object_vorbiscomment_set_vendor_string(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1145
1146 /** Resize the comment array.
1147  *
1148  *  If the size shrinks, elements will truncated; if it grows, new empty
1149  *  fields will be added to the end.
1150  *
1151  * \param object            A pointer to an existing VORBIS_COMMENT object.
1152  * \param new_num_comments  The desired length of the array; may be \c 0.
1153  * \assert
1154  *    \code object != NULL \endcode
1155  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1156  *    \code (object->data.vorbis_comment.comments == NULL && object->data.vorbis_comment.num_comments == 0) ||
1157  * (object->data.vorbis_comment.comments != NULL && object->data.vorbis_comment.num_comments > 0) \endcode
1158  * \retval FLAC__bool
1159  *    \c false if memory allocation error, else \c true.
1160  */
1161 FLAC__bool FLAC__metadata_object_vorbiscomment_resize_comments(FLAC__StreamMetadata *object, unsigned new_num_comments);
1162
1163 /** Sets a comment in a VORBIS_COMMENT block.
1164  *
1165  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1166  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1167  *  \a copy == \c true and malloc fails.
1168  *
1169  * \param object       A pointer to an existing VORBIS_COMMENT object.
1170  * \param comment_num  Index into comment array to set.
1171  * \param entry        The entry to set the comment to.
1172  * \param copy         See above.
1173  * \assert
1174  *    \code object != NULL \endcode
1175  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1176  *    \code (entry->entry != NULL && entry->length > 0) ||
1177  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1178  * \retval FLAC__bool
1179  *    \c false if \a copy is \c true and malloc fails, else \c true.
1180  */
1181 FLAC__bool FLAC__metadata_object_vorbiscomment_set_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1182
1183 /** Insert a comment in a VORBIS_COMMENT block at the given index.
1184  *
1185  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1186  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1187  *  \a copy == \c true and malloc fails.
1188  *
1189  * \param object       A pointer to an existing VORBIS_COMMENT object.
1190  * \param comment_num  The index at which to insert the comment.  The comments
1191  *                     at and after \a comment_num move right one position.
1192  *                     To append a comment to the end, set \a comment_num to
1193  *                     \c object->data.vorbis_comment.num_comments .
1194  * \param entry        The comment to insert.
1195  * \param copy         See above.
1196  * \assert
1197  *    \code object != NULL \endcode
1198  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1199  *    \code object->data.vorbis_comment.num_comments >= comment_num \endcode
1200  *    \code (entry->entry != NULL && entry->length > 0) ||
1201  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1202  * \retval FLAC__bool
1203  *    \c false if \a copy is \c true and malloc fails, else \c true.
1204  */
1205 FLAC__bool FLAC__metadata_object_vorbiscomment_insert_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1206
1207 /** Delete a comment in a VORBIS_COMMENT block at the given index.
1208  *
1209  *  If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1210  *  takes ownership of the \c entry->entry pointer.  Returns \c false if
1211  *  \a copy == \c true and malloc fails.
1212  *
1213  * \param object       A pointer to an existing VORBIS_COMMENT object.
1214  * \param comment_num  The index of the comment to delete.
1215  * \assert
1216  *    \code object != NULL \endcode
1217  *    \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1218  *    \code object->data.vorbis_comment.num_comments > comment_num \endcode
1219  *    \code (entry->entry != NULL && entry->length > 0) ||
1220  * (entry->entry == NULL && entry->length == 0 && copy == false) \endcode
1221  * \retval FLAC__bool
1222  *    \c false if realloc fails, else \c true.
1223  */
1224 FLAC__bool FLAC__metadata_object_vorbiscomment_delete_comment(FLAC__StreamMetadata *object, unsigned comment_num);
1225
1226 /* \} */
1227
1228 #ifdef __cplusplus
1229 }
1230 #endif
1231
1232 #endif