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