1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>FLAC: FLAC/metadata.h: metadata level 2 interface</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5</head><body> 6<!-- Generated by Doxygen 1.4.2 --> 7<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> 8<h1>FLAC/metadata.h: metadata level 2 interface<br> 9<small> 10[<a class="el" href="group__flac__metadata.html">FLAC/metadata.h: metadata interfaces</a>]</small> 11</h1><hr><a name="_details"></a><h2>Detailed Description</h2> 12The level 2 interface provides read-write access to FLAC file metadata; all metadata is read into memory, operated on in memory, and then written to file, which is more efficient than level 1 when editing multiple blocks. 13<p> 14Currently Ogg FLAC is supported for read only, via <a class="el" href="group__flac__metadata__level2.html#ga7">FLAC__metadata_chain_read_ogg()</a> but a subsequent <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> will fail.<p> 15The general usage of this interface is:<p> 16<ul> 17<li>Create a new chain using <a class="el" href="group__flac__metadata__level2.html#ga3">FLAC__metadata_chain_new()</a>. A chain is a linked list of FLAC metadata blocks.</li><li>Read all metadata into the the chain from a FLAC file using <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a> or <a class="el" href="group__flac__metadata__level2.html#ga7">FLAC__metadata_chain_read_ogg()</a> and check the status.</li><li>Optionally, consolidate the padding using <a class="el" href="group__flac__metadata__level2.html#ga14">FLAC__metadata_chain_merge_padding()</a> or <a class="el" href="group__flac__metadata__level2.html#ga15">FLAC__metadata_chain_sort_padding()</a>.</li><li>Create a new iterator using <a class="el" href="group__flac__metadata__level2.html#ga16">FLAC__metadata_iterator_new()</a></li><li>Initialize the iterator to point to the first element in the chain using <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a></li><li>Traverse the chain using FLAC__metadata_iterator_next and <a class="el" href="group__flac__metadata__level2.html#ga20">FLAC__metadata_iterator_prev()</a>.</li><li>Get a block for reading or modification using <a class="el" href="group__flac__metadata__level2.html#ga22">FLAC__metadata_iterator_get_block()</a>. The pointer to the object inside the chain is returned, so the block is yours to modify. Changes will be reflected in the FLAC file when you write the chain. You can also add and delete blocks (see functions below).</li><li>When done, write out the chain using <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a>. Make sure to read the whole comment to the function below.</li><li>Delete the chain using <a class="el" href="group__flac__metadata__level2.html#ga4">FLAC__metadata_chain_delete()</a>.</li></ul> 18<p> 19<dl compact><dt><b>Note:</b></dt><dd>Even though the FLAC file is not open while the chain is being manipulated, you must not alter the file externally during this time. The chain assumes the FLAC file will not change between the time of <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a>/FLAC__metadata_chain_read_ogg() and <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a>.<p> 20Do not modify the is_last, length, or type fields of returned <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> objects. These are managed automatically.<p> 21The metadata objects returned by <a class="el" href="group__flac__metadata__level2.html#ga22">FLAC__metadata_iterator_get_block()</a> are owned by the chain; do not <a class="el" href="group__flac__metadata__object.html#ga2">FLAC__metadata_object_delete()</a> them. In the same way, blocks passed to <a class="el" href="group__flac__metadata__level2.html#ga23">FLAC__metadata_iterator_set_block()</a> become owned by the chain and they will be deleted when the chain is deleted. </dd></dl> 22 23<p> 24<table border="0" cellpadding="0" cellspacing="0"> 25<tr><td></td></tr> 26<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> 27<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a></td></tr> 28 29<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a></td></tr> 30 31<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> 32<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga27">FLAC__Metadata_ChainStatus</a> { <br> 33 <a class="el" href="group__flac__metadata__level2.html#gga27a18">FLAC__METADATA_CHAIN_STATUS_OK</a> = 0, 34<a class="el" href="group__flac__metadata__level2.html#gga27a19">FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT</a>, 35<a class="el" href="group__flac__metadata__level2.html#gga27a20">FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE</a>, 36<a class="el" href="group__flac__metadata__level2.html#gga27a21">FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE</a>, 37<br> 38 <a class="el" href="group__flac__metadata__level2.html#gga27a22">FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE</a>, 39<a class="el" href="group__flac__metadata__level2.html#gga27a23">FLAC__METADATA_CHAIN_STATUS_BAD_METADATA</a>, 40<a class="el" href="group__flac__metadata__level2.html#gga27a24">FLAC__METADATA_CHAIN_STATUS_READ_ERROR</a>, 41<a class="el" href="group__flac__metadata__level2.html#gga27a25">FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR</a>, 42<br> 43 <a class="el" href="group__flac__metadata__level2.html#gga27a26">FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR</a>, 44<a class="el" href="group__flac__metadata__level2.html#gga27a27">FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR</a>, 45<a class="el" href="group__flac__metadata__level2.html#gga27a28">FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR</a>, 46<a class="el" href="group__flac__metadata__level2.html#gga27a29">FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR</a>, 47<br> 48 <a class="el" href="group__flac__metadata__level2.html#gga27a30">FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR</a>, 49<a class="el" href="group__flac__metadata__level2.html#gga27a31">FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS</a>, 50<a class="el" href="group__flac__metadata__level2.html#gga27a32">FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH</a>, 51<a class="el" href="group__flac__metadata__level2.html#gga27a33">FLAC__METADATA_CHAIN_STATUS_WRONG_WRITE_CALL</a> 52<br> 53 }</td></tr> 54 55<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga3">FLAC__metadata_chain_new</a> (void)</td></tr> 57 58<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga4">FLAC__metadata_chain_delete</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain)</td></tr> 59 60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__metadata__level2.html#ga27">FLAC__Metadata_ChainStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain)</td></tr> 61 62<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, const char *filename)</td></tr> 63 64<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga7">FLAC__metadata_chain_read_ogg</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, const char *filename)</td></tr> 65 66<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga8">FLAC__metadata_chain_read_with_callbacks</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle, <a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> callbacks)</td></tr> 67 68<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga9">FLAC__metadata_chain_read_ogg_with_callbacks</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle, <a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> callbacks)</td></tr> 69 70<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga10">FLAC__metadata_chain_check_if_tempfile_needed</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, FLAC__bool use_padding)</td></tr> 71 72<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, FLAC__bool use_padding, FLAC__bool preserve_file_stats)</td></tr> 73 74<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga12">FLAC__metadata_chain_write_with_callbacks</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, FLAC__bool use_padding, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle, <a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> callbacks)</td></tr> 75 76<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga13">FLAC__metadata_chain_write_with_callbacks_and_tempfile</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain, FLAC__bool use_padding, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle, <a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> callbacks, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> temp_handle, <a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> temp_callbacks)</td></tr> 77 78<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga14">FLAC__metadata_chain_merge_padding</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain)</td></tr> 79 80<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga15">FLAC__metadata_chain_sort_padding</a> (<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain)</td></tr> 81 82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga16">FLAC__metadata_iterator_new</a> (void)</td></tr> 83 84<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga17">FLAC__metadata_iterator_delete</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr> 85 86<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> *chain)</td></tr> 87 88<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga19">FLAC__metadata_iterator_next</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr> 89 90<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga20">FLAC__metadata_iterator_prev</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr> 91 92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__format.html#ga113">FLAC__MetadataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga21">FLAC__metadata_iterator_get_block_type</a> (const <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr> 93 94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga22">FLAC__metadata_iterator_get_block</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr> 95 96<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga23">FLAC__metadata_iterator_set_block</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block)</td></tr> 97 98<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga24">FLAC__metadata_iterator_delete_block</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator, FLAC__bool replace_with_padding)</td></tr> 99 100<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga25">FLAC__metadata_iterator_insert_block_before</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block)</td></tr> 101 102<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga26">FLAC__metadata_iterator_insert_block_after</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block)</td></tr> 103 104<tr><td colspan="2"><br><h2>Variables</h2></td></tr> 105<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga2">FLAC__Metadata_ChainStatusString</a> []</td></tr> 106 107</table> 108<hr><h2>Typedef Documentation</h2> 109<a class="anchor" name="ga0" doxytag="metadata.h::FLAC__Metadata_Chain"></a><p> 110<table class="mdTable" cellpadding="2" cellspacing="0"> 111 <tr> 112 <td class="mdRow"> 113 <table cellpadding="0" cellspacing="0" border="0"> 114 <tr> 115 <td class="md" nowrap valign="top">typedef struct <a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> <a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> </td> 116 </tr> 117 </table> 118 </td> 119 </tr> 120</table> 121<table cellspacing="5" cellpadding="0" border="0"> 122 <tr> 123 <td> 124 125 </td> 126 <td> 127 128<p> 129The opaque structure definition for the level 2 chain type. </td> 130 </tr> 131</table> 132<a class="anchor" name="ga1" doxytag="metadata.h::FLAC__Metadata_Iterator"></a><p> 133<table class="mdTable" cellpadding="2" cellspacing="0"> 134 <tr> 135 <td class="mdRow"> 136 <table cellpadding="0" cellspacing="0" border="0"> 137 <tr> 138 <td class="md" nowrap valign="top">typedef struct <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> </td> 139 </tr> 140 </table> 141 </td> 142 </tr> 143</table> 144<table cellspacing="5" cellpadding="0" border="0"> 145 <tr> 146 <td> 147 148 </td> 149 <td> 150 151<p> 152The opaque structure definition for the level 2 iterator type. </td> 153 </tr> 154</table> 155<hr><h2>Enumeration Type Documentation</h2> 156<a class="anchor" name="ga27" doxytag="metadata.h::FLAC__Metadata_ChainStatus"></a><p> 157<table class="mdTable" cellpadding="2" cellspacing="0"> 158 <tr> 159 <td class="mdRow"> 160 <table cellpadding="0" cellspacing="0" border="0"> 161 <tr> 162 <td class="md" nowrap valign="top">enum <a class="el" href="group__flac__metadata__level2.html#ga27">FLAC__Metadata_ChainStatus</a> </td> 163 </tr> 164 </table> 165 </td> 166 </tr> 167</table> 168<table cellspacing="5" cellpadding="0" border="0"> 169 <tr> 170 <td> 171 172 </td> 173 <td> 174 175<p> 176<dl compact><dt><b>Enumeration values: </b></dt><dd> 177<table border="0" cellspacing="2" cellpadding="0"> 178<tr><td valign="top"><em><a class="anchor" name="gga27a18" doxytag="FLAC__METADATA_CHAIN_STATUS_OK"></a>FLAC__METADATA_CHAIN_STATUS_OK</em> </td><td> 179The chain is in the normal OK state </td></tr> 180<tr><td valign="top"><em><a class="anchor" name="gga27a19" doxytag="FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT"></a>FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT</em> </td><td> 181The data passed into a function violated the function's usage criteria </td></tr> 182<tr><td valign="top"><em><a class="anchor" name="gga27a20" doxytag="FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE"></a>FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE</em> </td><td> 183The chain could not open the target file </td></tr> 184<tr><td valign="top"><em><a class="anchor" name="gga27a21" doxytag="FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE"></a>FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE</em> </td><td> 185The chain could not find the FLAC signature at the start of the file </td></tr> 186<tr><td valign="top"><em><a class="anchor" name="gga27a22" doxytag="FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE"></a>FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE</em> </td><td> 187The chain tried to write to a file that was not writable </td></tr> 188<tr><td valign="top"><em><a class="anchor" name="gga27a23" doxytag="FLAC__METADATA_CHAIN_STATUS_BAD_METADATA"></a>FLAC__METADATA_CHAIN_STATUS_BAD_METADATA</em> </td><td> 189The chain encountered input that does not conform to the FLAC metadata specification </td></tr> 190<tr><td valign="top"><em><a class="anchor" name="gga27a24" doxytag="FLAC__METADATA_CHAIN_STATUS_READ_ERROR"></a>FLAC__METADATA_CHAIN_STATUS_READ_ERROR</em> </td><td> 191The chain encountered an error while reading the FLAC file </td></tr> 192<tr><td valign="top"><em><a class="anchor" name="gga27a25" doxytag="FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR"></a>FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR</em> </td><td> 193The chain encountered an error while seeking in the FLAC file </td></tr> 194<tr><td valign="top"><em><a class="anchor" name="gga27a26" doxytag="FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR"></a>FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR</em> </td><td> 195The chain encountered an error while writing the FLAC file </td></tr> 196<tr><td valign="top"><em><a class="anchor" name="gga27a27" doxytag="FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR"></a>FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR</em> </td><td> 197The chain encountered an error renaming the FLAC file </td></tr> 198<tr><td valign="top"><em><a class="anchor" name="gga27a28" doxytag="FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR"></a>FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR</em> </td><td> 199The chain encountered an error removing the temporary file </td></tr> 200<tr><td valign="top"><em><a class="anchor" name="gga27a29" doxytag="FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR"></a>FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR</em> </td><td> 201Memory allocation failed </td></tr> 202<tr><td valign="top"><em><a class="anchor" name="gga27a30" doxytag="FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR"></a>FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR</em> </td><td> 203The caller violated an assertion or an unexpected error occurred </td></tr> 204<tr><td valign="top"><em><a class="anchor" name="gga27a31" doxytag="FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS"></a>FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS</em> </td><td> 205One or more of the required callbacks was NULL </td></tr> 206<tr><td valign="top"><em><a class="anchor" name="gga27a32" doxytag="FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH"></a>FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH</em> </td><td> 207<a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> was called on a chain read by <a class="el" href="group__flac__metadata__level2.html#ga8">FLAC__metadata_chain_read_with_callbacks()</a>/FLAC__metadata_chain_read_ogg_with_callbacks(), or <a class="el" href="group__flac__metadata__level2.html#ga12">FLAC__metadata_chain_write_with_callbacks()</a>/FLAC__metadata_chain_write_with_callbacks_and_tempfile() was called on a chain read by <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a>/FLAC__metadata_chain_read_ogg(). Matching read/write methods must always be used. </td></tr> 208<tr><td valign="top"><em><a class="anchor" name="gga27a33" doxytag="FLAC__METADATA_CHAIN_STATUS_WRONG_WRITE_CALL"></a>FLAC__METADATA_CHAIN_STATUS_WRONG_WRITE_CALL</em> </td><td> 209<a class="el" href="group__flac__metadata__level2.html#ga12">FLAC__metadata_chain_write_with_callbacks()</a> was called when the chain write requires a tempfile; use <a class="el" href="group__flac__metadata__level2.html#ga13">FLAC__metadata_chain_write_with_callbacks_and_tempfile()</a> instead. Or, <a class="el" href="group__flac__metadata__level2.html#ga13">FLAC__metadata_chain_write_with_callbacks_and_tempfile()</a> was called when the chain write does not require a tempfile; use <a class="el" href="group__flac__metadata__level2.html#ga12">FLAC__metadata_chain_write_with_callbacks()</a> instead. Always check <a class="el" href="group__flac__metadata__level2.html#ga10">FLAC__metadata_chain_check_if_tempfile_needed()</a> before writing via callbacks. </td></tr> 210</table> 211</dl> 212 </td> 213 </tr> 214</table> 215<hr><h2>Function Documentation</h2> 216<a class="anchor" name="ga3" doxytag="metadata.h::FLAC__metadata_chain_new"></a><p> 217<table class="mdTable" cellpadding="2" cellspacing="0"> 218 <tr> 219 <td class="mdRow"> 220 <table cellpadding="0" cellspacing="0" border="0"> 221 <tr> 222 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a>* FLAC__metadata_chain_new </td> 223 <td class="md" valign="top">( </td> 224 <td class="md" nowrap valign="top">void </td> 225 <td class="mdname1" valign="top" nowrap> </td> 226 <td class="md" valign="top"> ) </td> 227 <td class="md" nowrap></td> 228 </tr> 229 </table> 230 </td> 231 </tr> 232</table> 233<table cellspacing="5" cellpadding="0" border="0"> 234 <tr> 235 <td> 236 237 </td> 238 <td> 239 240<p> 241Create a new chain instance.<p> 242<dl compact><dt><b>Return values:</b></dt><dd> 243 <table border="0" cellspacing="2" cellpadding="0"> 244 <tr><td valign="top"></td><td valign="top"><em>FLAC__Metadata_Chain*</em> </td><td><code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr> 245 </table> 246</dl> 247 </td> 248 </tr> 249</table> 250<a class="anchor" name="ga4" doxytag="metadata.h::FLAC__metadata_chain_delete"></a><p> 251<table class="mdTable" cellpadding="2" cellspacing="0"> 252 <tr> 253 <td class="mdRow"> 254 <table cellpadding="0" cellspacing="0" border="0"> 255 <tr> 256 <td class="md" nowrap valign="top">void FLAC__metadata_chain_delete </td> 257 <td class="md" valign="top">( </td> 258 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 259 <td class="mdname1" valign="top" nowrap> <em>chain</em> </td> 260 <td class="md" valign="top"> ) </td> 261 <td class="md" nowrap></td> 262 </tr> 263 </table> 264 </td> 265 </tr> 266</table> 267<table cellspacing="5" cellpadding="0" border="0"> 268 <tr> 269 <td> 270 271 </td> 272 <td> 273 274<p> 275Free a chain instance. Deletes the object pointed to by <em>chain</em>.<p> 276<dl compact><dt><b>Parameters:</b></dt><dd> 277 <table border="0" cellspacing="2" cellpadding="0"> 278 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 279 </table> 280</dl> 281<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 282</pre></div> </dd></dl> 283 </td> 284 </tr> 285</table> 286<a class="anchor" name="ga5" doxytag="metadata.h::FLAC__metadata_chain_status"></a><p> 287<table class="mdTable" cellpadding="2" cellspacing="0"> 288 <tr> 289 <td class="mdRow"> 290 <table cellpadding="0" cellspacing="0" border="0"> 291 <tr> 292 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga27">FLAC__Metadata_ChainStatus</a> FLAC__metadata_chain_status </td> 293 <td class="md" valign="top">( </td> 294 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 295 <td class="mdname1" valign="top" nowrap> <em>chain</em> </td> 296 <td class="md" valign="top"> ) </td> 297 <td class="md" nowrap></td> 298 </tr> 299 </table> 300 </td> 301 </tr> 302</table> 303<table cellspacing="5" cellpadding="0" border="0"> 304 <tr> 305 <td> 306 307 </td> 308 <td> 309 310<p> 311Get the current status of the chain. Call this after a function returns <code>false</code> to get the reason for the error. Also resets the status to FLAC__METADATA_CHAIN_STATUS_OK.<p> 312<dl compact><dt><b>Parameters:</b></dt><dd> 313 <table border="0" cellspacing="2" cellpadding="0"> 314 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 315 </table> 316</dl> 317<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 318</pre></div> </dd></dl> 319<dl compact><dt><b>Return values:</b></dt><dd> 320 <table border="0" cellspacing="2" cellpadding="0"> 321 <tr><td valign="top"></td><td valign="top"><em>FLAC__Metadata_ChainStatus</em> </td><td>The current status of the chain. </td></tr> 322 </table> 323</dl> 324 </td> 325 </tr> 326</table> 327<a class="anchor" name="ga6" doxytag="metadata.h::FLAC__metadata_chain_read"></a><p> 328<table class="mdTable" cellpadding="2" cellspacing="0"> 329 <tr> 330 <td class="mdRow"> 331 <table cellpadding="0" cellspacing="0" border="0"> 332 <tr> 333 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_read </td> 334 <td class="md" valign="top">( </td> 335 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 336 <td class="mdname" nowrap> <em>chain</em>, </td> 337 </tr> 338 <tr> 339 <td class="md" nowrap align="right"></td> 340 <td class="md"></td> 341 <td class="md" nowrap>const char * </td> 342 <td class="mdname" nowrap> <em>filename</em></td> 343 </tr> 344 <tr> 345 <td class="md"></td> 346 <td class="md">) </td> 347 <td class="md" colspan="2"></td> 348 </tr> 349 </table> 350 </td> 351 </tr> 352</table> 353<table cellspacing="5" cellpadding="0" border="0"> 354 <tr> 355 <td> 356 357 </td> 358 <td> 359 360<p> 361Read all metadata from a FLAC file into the chain.<p> 362<dl compact><dt><b>Parameters:</b></dt><dd> 363 <table border="0" cellspacing="2" cellpadding="0"> 364 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 365 <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The path to the FLAC file to read. </td></tr> 366 </table> 367</dl> 368<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 369</pre></div> <div class="fragment"><pre class="fragment"> filename != NULL 370</pre></div> </dd></dl> 371<dl compact><dt><b>Return values:</b></dt><dd> 372 <table border="0" cellspacing="2" cellpadding="0"> 373 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if a valid list of metadata blocks was read from <em>filename</em>, else <code>false</code>. On failure, check the status with <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. </td></tr> 374 </table> 375</dl> 376 </td> 377 </tr> 378</table> 379<a class="anchor" name="ga7" doxytag="metadata.h::FLAC__metadata_chain_read_ogg"></a><p> 380<table class="mdTable" cellpadding="2" cellspacing="0"> 381 <tr> 382 <td class="mdRow"> 383 <table cellpadding="0" cellspacing="0" border="0"> 384 <tr> 385 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_read_ogg </td> 386 <td class="md" valign="top">( </td> 387 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 388 <td class="mdname" nowrap> <em>chain</em>, </td> 389 </tr> 390 <tr> 391 <td class="md" nowrap align="right"></td> 392 <td class="md"></td> 393 <td class="md" nowrap>const char * </td> 394 <td class="mdname" nowrap> <em>filename</em></td> 395 </tr> 396 <tr> 397 <td class="md"></td> 398 <td class="md">) </td> 399 <td class="md" colspan="2"></td> 400 </tr> 401 </table> 402 </td> 403 </tr> 404</table> 405<table cellspacing="5" cellpadding="0" border="0"> 406 <tr> 407 <td> 408 409 </td> 410 <td> 411 412<p> 413Read all metadata from an Ogg FLAC file into the chain.<p> 414<dl compact><dt><b>Note:</b></dt><dd>Ogg FLAC metadata data writing is not supported yet and <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> will fail.</dd></dl> 415<dl compact><dt><b>Parameters:</b></dt><dd> 416 <table border="0" cellspacing="2" cellpadding="0"> 417 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 418 <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The path to the Ogg FLAC file to read. </td></tr> 419 </table> 420</dl> 421<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 422</pre></div> <div class="fragment"><pre class="fragment"> filename != NULL 423</pre></div> </dd></dl> 424<dl compact><dt><b>Return values:</b></dt><dd> 425 <table border="0" cellspacing="2" cellpadding="0"> 426 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if a valid list of metadata blocks was read from <em>filename</em>, else <code>false</code>. On failure, check the status with <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. </td></tr> 427 </table> 428</dl> 429 </td> 430 </tr> 431</table> 432<a class="anchor" name="ga8" doxytag="metadata.h::FLAC__metadata_chain_read_with_callbacks"></a><p> 433<table class="mdTable" cellpadding="2" cellspacing="0"> 434 <tr> 435 <td class="mdRow"> 436 <table cellpadding="0" cellspacing="0" border="0"> 437 <tr> 438 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_read_with_callbacks </td> 439 <td class="md" valign="top">( </td> 440 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 441 <td class="mdname" nowrap> <em>chain</em>, </td> 442 </tr> 443 <tr> 444 <td class="md" nowrap align="right"></td> 445 <td class="md"></td> 446 <td class="md" nowrap><a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 447 <td class="mdname" nowrap> <em>handle</em>, </td> 448 </tr> 449 <tr> 450 <td class="md" nowrap align="right"></td> 451 <td class="md"></td> 452 <td class="md" nowrap><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 453 <td class="mdname" nowrap> <em>callbacks</em></td> 454 </tr> 455 <tr> 456 <td class="md"></td> 457 <td class="md">) </td> 458 <td class="md" colspan="2"></td> 459 </tr> 460 </table> 461 </td> 462 </tr> 463</table> 464<table cellspacing="5" cellpadding="0" border="0"> 465 <tr> 466 <td> 467 468 </td> 469 <td> 470 471<p> 472Read all metadata from a FLAC stream into the chain via I/O callbacks.<p> 473The <em>handle</em> need only be open for reading, but must be seekable. The equivalent minimum stdio fopen() file mode is <code>"r"</code> (or <code>"rb"</code> for Windows).<p> 474<dl compact><dt><b>Parameters:</b></dt><dd> 475 <table border="0" cellspacing="2" cellpadding="0"> 476 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 477 <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>The I/O handle of the FLAC stream to read. The handle will NOT be closed after the metadata is read; that is the duty of the caller. </td></tr> 478 <tr><td valign="top"></td><td valign="top"><em>callbacks</em> </td><td>A set of callbacks to use for I/O. The mandatory callbacks are <em>read</em>, <em>seek</em>, and <em>tell</em>. </td></tr> 479 </table> 480</dl> 481<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 482</pre></div> </dd></dl> 483<dl compact><dt><b>Return values:</b></dt><dd> 484 <table border="0" cellspacing="2" cellpadding="0"> 485 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if a valid list of metadata blocks was read from <em>handle</em>, else <code>false</code>. On failure, check the status with <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. </td></tr> 486 </table> 487</dl> 488 </td> 489 </tr> 490</table> 491<a class="anchor" name="ga9" doxytag="metadata.h::FLAC__metadata_chain_read_ogg_with_callbacks"></a><p> 492<table class="mdTable" cellpadding="2" cellspacing="0"> 493 <tr> 494 <td class="mdRow"> 495 <table cellpadding="0" cellspacing="0" border="0"> 496 <tr> 497 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_read_ogg_with_callbacks </td> 498 <td class="md" valign="top">( </td> 499 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 500 <td class="mdname" nowrap> <em>chain</em>, </td> 501 </tr> 502 <tr> 503 <td class="md" nowrap align="right"></td> 504 <td class="md"></td> 505 <td class="md" nowrap><a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 506 <td class="mdname" nowrap> <em>handle</em>, </td> 507 </tr> 508 <tr> 509 <td class="md" nowrap align="right"></td> 510 <td class="md"></td> 511 <td class="md" nowrap><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 512 <td class="mdname" nowrap> <em>callbacks</em></td> 513 </tr> 514 <tr> 515 <td class="md"></td> 516 <td class="md">) </td> 517 <td class="md" colspan="2"></td> 518 </tr> 519 </table> 520 </td> 521 </tr> 522</table> 523<table cellspacing="5" cellpadding="0" border="0"> 524 <tr> 525 <td> 526 527 </td> 528 <td> 529 530<p> 531Read all metadata from an Ogg FLAC stream into the chain via I/O callbacks.<p> 532The <em>handle</em> need only be open for reading, but must be seekable. The equivalent minimum stdio fopen() file mode is <code>"r"</code> (or <code>"rb"</code> for Windows).<p> 533<dl compact><dt><b>Note:</b></dt><dd>Ogg FLAC metadata data writing is not supported yet and <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> will fail.</dd></dl> 534<dl compact><dt><b>Parameters:</b></dt><dd> 535 <table border="0" cellspacing="2" cellpadding="0"> 536 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 537 <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>The I/O handle of the Ogg FLAC stream to read. The handle will NOT be closed after the metadata is read; that is the duty of the caller. </td></tr> 538 <tr><td valign="top"></td><td valign="top"><em>callbacks</em> </td><td>A set of callbacks to use for I/O. The mandatory callbacks are <em>read</em>, <em>seek</em>, and <em>tell</em>. </td></tr> 539 </table> 540</dl> 541<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 542</pre></div> </dd></dl> 543<dl compact><dt><b>Return values:</b></dt><dd> 544 <table border="0" cellspacing="2" cellpadding="0"> 545 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if a valid list of metadata blocks was read from <em>handle</em>, else <code>false</code>. On failure, check the status with <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. </td></tr> 546 </table> 547</dl> 548 </td> 549 </tr> 550</table> 551<a class="anchor" name="ga10" doxytag="metadata.h::FLAC__metadata_chain_check_if_tempfile_needed"></a><p> 552<table class="mdTable" cellpadding="2" cellspacing="0"> 553 <tr> 554 <td class="mdRow"> 555 <table cellpadding="0" cellspacing="0" border="0"> 556 <tr> 557 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_check_if_tempfile_needed </td> 558 <td class="md" valign="top">( </td> 559 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 560 <td class="mdname" nowrap> <em>chain</em>, </td> 561 </tr> 562 <tr> 563 <td class="md" nowrap align="right"></td> 564 <td class="md"></td> 565 <td class="md" nowrap>FLAC__bool </td> 566 <td class="mdname" nowrap> <em>use_padding</em></td> 567 </tr> 568 <tr> 569 <td class="md"></td> 570 <td class="md">) </td> 571 <td class="md" colspan="2"></td> 572 </tr> 573 </table> 574 </td> 575 </tr> 576</table> 577<table cellspacing="5" cellpadding="0" border="0"> 578 <tr> 579 <td> 580 581 </td> 582 <td> 583 584<p> 585Checks if writing the given chain would require the use of a temporary file, or if it could be written in place.<p> 586Under certain conditions, padding can be utilized so that writing edited metadata back to the FLAC file does not require rewriting the entire file. If rewriting is required, then a temporary workfile is required. When writing metadata using callbacks, you must check this function to know whether to call <a class="el" href="group__flac__metadata__level2.html#ga12">FLAC__metadata_chain_write_with_callbacks()</a> or <a class="el" href="group__flac__metadata__level2.html#ga13">FLAC__metadata_chain_write_with_callbacks_and_tempfile()</a>. When writing with <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a>, the temporary file is handled internally.<p> 587<dl compact><dt><b>Parameters:</b></dt><dd> 588 <table border="0" cellspacing="2" cellpadding="0"> 589 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 590 <tr><td valign="top"></td><td valign="top"><em>use_padding</em> </td><td>Whether or not padding will be allowed to be used during the write. The value of <em>use_padding</em> given here must match the value later passed to <a class="el" href="group__flac__metadata__level2.html#ga12">FLAC__metadata_chain_write_with_callbacks()</a> or FLAC__metadata_chain_write_with_callbacks_with_tempfile(). </td></tr> 591 </table> 592</dl> 593<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 594</pre></div> </dd></dl> 595<dl compact><dt><b>Return values:</b></dt><dd> 596 <table border="0" cellspacing="2" cellpadding="0"> 597 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if writing the current chain would require a tempfile, or <code>false</code> if metadata can be written in place. </td></tr> 598 </table> 599</dl> 600 </td> 601 </tr> 602</table> 603<a class="anchor" name="ga11" doxytag="metadata.h::FLAC__metadata_chain_write"></a><p> 604<table class="mdTable" cellpadding="2" cellspacing="0"> 605 <tr> 606 <td class="mdRow"> 607 <table cellpadding="0" cellspacing="0" border="0"> 608 <tr> 609 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_write </td> 610 <td class="md" valign="top">( </td> 611 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 612 <td class="mdname" nowrap> <em>chain</em>, </td> 613 </tr> 614 <tr> 615 <td class="md" nowrap align="right"></td> 616 <td class="md"></td> 617 <td class="md" nowrap>FLAC__bool </td> 618 <td class="mdname" nowrap> <em>use_padding</em>, </td> 619 </tr> 620 <tr> 621 <td class="md" nowrap align="right"></td> 622 <td class="md"></td> 623 <td class="md" nowrap>FLAC__bool </td> 624 <td class="mdname" nowrap> <em>preserve_file_stats</em></td> 625 </tr> 626 <tr> 627 <td class="md"></td> 628 <td class="md">) </td> 629 <td class="md" colspan="2"></td> 630 </tr> 631 </table> 632 </td> 633 </tr> 634</table> 635<table cellspacing="5" cellpadding="0" border="0"> 636 <tr> 637 <td> 638 639 </td> 640 <td> 641 642<p> 643Write all metadata out to the FLAC file. This function tries to be as efficient as possible; how the metadata is actually written is shown by the following:<p> 644If the current chain is the same size as the existing metadata, the new data is written in place.<p> 645If the current chain is longer than the existing metadata, and <em>use_padding</em> is <code>true</code>, and the last block is a PADDING block of sufficient length, the function will truncate the final padding block so that the overall size of the metadata is the same as the existing metadata, and then just rewrite the metadata. Otherwise, if not all of the above conditions are met, the entire FLAC file must be rewritten. If you want to use padding this way it is a good idea to call <a class="el" href="group__flac__metadata__level2.html#ga15">FLAC__metadata_chain_sort_padding()</a> first so that you have the maximum amount of padding to work with, unless you need to preserve ordering of the PADDING blocks for some reason.<p> 646If the current chain is shorter than the existing metadata, and <em>use_padding</em> is <code>true</code>, and the final block is a PADDING block, the padding is extended to make the overall size the same as the existing data. If <em>use_padding</em> is <code>true</code> and the last block is not a PADDING block, a new PADDING block is added to the end of the new data to make it the same size as the existing data (if possible, see the note to <a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a> about the four byte limit) and the new data is written in place. If none of the above apply or <em>use_padding</em> is <code>false</code>, the entire FLAC file is rewritten.<p> 647If <em>preserve_file_stats</em> is <code>true</code>, the owner and modification time will be preserved even if the FLAC file is written.<p> 648For this write function to be used, the chain must have been read with <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a>/FLAC__metadata_chain_read_ogg(), not <a class="el" href="group__flac__metadata__level2.html#ga8">FLAC__metadata_chain_read_with_callbacks()</a>/FLAC__metadata_chain_read_ogg_with_callbacks().<p> 649<dl compact><dt><b>Parameters:</b></dt><dd> 650 <table border="0" cellspacing="2" cellpadding="0"> 651 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 652 <tr><td valign="top"></td><td valign="top"><em>use_padding</em> </td><td>See above. </td></tr> 653 <tr><td valign="top"></td><td valign="top"><em>preserve_file_stats</em> </td><td>See above. </td></tr> 654 </table> 655</dl> 656<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 657</pre></div> </dd></dl> 658<dl compact><dt><b>Return values:</b></dt><dd> 659 <table border="0" cellspacing="2" cellpadding="0"> 660 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if the write succeeded, else <code>false</code>. On failure, check the status with <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. </td></tr> 661 </table> 662</dl> 663 </td> 664 </tr> 665</table> 666<a class="anchor" name="ga12" doxytag="metadata.h::FLAC__metadata_chain_write_with_callbacks"></a><p> 667<table class="mdTable" cellpadding="2" cellspacing="0"> 668 <tr> 669 <td class="mdRow"> 670 <table cellpadding="0" cellspacing="0" border="0"> 671 <tr> 672 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_write_with_callbacks </td> 673 <td class="md" valign="top">( </td> 674 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 675 <td class="mdname" nowrap> <em>chain</em>, </td> 676 </tr> 677 <tr> 678 <td class="md" nowrap align="right"></td> 679 <td class="md"></td> 680 <td class="md" nowrap>FLAC__bool </td> 681 <td class="mdname" nowrap> <em>use_padding</em>, </td> 682 </tr> 683 <tr> 684 <td class="md" nowrap align="right"></td> 685 <td class="md"></td> 686 <td class="md" nowrap><a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 687 <td class="mdname" nowrap> <em>handle</em>, </td> 688 </tr> 689 <tr> 690 <td class="md" nowrap align="right"></td> 691 <td class="md"></td> 692 <td class="md" nowrap><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 693 <td class="mdname" nowrap> <em>callbacks</em></td> 694 </tr> 695 <tr> 696 <td class="md"></td> 697 <td class="md">) </td> 698 <td class="md" colspan="2"></td> 699 </tr> 700 </table> 701 </td> 702 </tr> 703</table> 704<table cellspacing="5" cellpadding="0" border="0"> 705 <tr> 706 <td> 707 708 </td> 709 <td> 710 711<p> 712Write all metadata out to a FLAC stream via callbacks.<p> 713(See <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> for the details on how padding is used to write metadata in place if possible.)<p> 714The <em>handle</em> must be open for updating and be seekable. The equivalent minimum stdio fopen() file mode is <code>"r+"</code> (or <code>"r+b"</code> for Windows).<p> 715For this write function to be used, the chain must have been read with <a class="el" href="group__flac__metadata__level2.html#ga8">FLAC__metadata_chain_read_with_callbacks()</a>/FLAC__metadata_chain_read_ogg_with_callbacks(), not <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a>/FLAC__metadata_chain_read_ogg(). Also, <a class="el" href="group__flac__metadata__level2.html#ga10">FLAC__metadata_chain_check_if_tempfile_needed()</a> must have returned <code>false</code>.<p> 716<dl compact><dt><b>Parameters:</b></dt><dd> 717 <table border="0" cellspacing="2" cellpadding="0"> 718 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 719 <tr><td valign="top"></td><td valign="top"><em>use_padding</em> </td><td>See <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> </td></tr> 720 <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>The I/O handle of the FLAC stream to write. The handle will NOT be closed after the metadata is written; that is the duty of the caller. </td></tr> 721 <tr><td valign="top"></td><td valign="top"><em>callbacks</em> </td><td>A set of callbacks to use for I/O. The mandatory callbacks are <em>write</em> and <em>seek</em>. </td></tr> 722 </table> 723</dl> 724<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 725</pre></div> </dd></dl> 726<dl compact><dt><b>Return values:</b></dt><dd> 727 <table border="0" cellspacing="2" cellpadding="0"> 728 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if the write succeeded, else <code>false</code>. On failure, check the status with <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. </td></tr> 729 </table> 730</dl> 731 </td> 732 </tr> 733</table> 734<a class="anchor" name="ga13" doxytag="metadata.h::FLAC__metadata_chain_write_with_callbacks_and_tempfile"></a><p> 735<table class="mdTable" cellpadding="2" cellspacing="0"> 736 <tr> 737 <td class="mdRow"> 738 <table cellpadding="0" cellspacing="0" border="0"> 739 <tr> 740 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_chain_write_with_callbacks_and_tempfile </td> 741 <td class="md" valign="top">( </td> 742 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 743 <td class="mdname" nowrap> <em>chain</em>, </td> 744 </tr> 745 <tr> 746 <td class="md" nowrap align="right"></td> 747 <td class="md"></td> 748 <td class="md" nowrap>FLAC__bool </td> 749 <td class="mdname" nowrap> <em>use_padding</em>, </td> 750 </tr> 751 <tr> 752 <td class="md" nowrap align="right"></td> 753 <td class="md"></td> 754 <td class="md" nowrap><a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 755 <td class="mdname" nowrap> <em>handle</em>, </td> 756 </tr> 757 <tr> 758 <td class="md" nowrap align="right"></td> 759 <td class="md"></td> 760 <td class="md" nowrap><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 761 <td class="mdname" nowrap> <em>callbacks</em>, </td> 762 </tr> 763 <tr> 764 <td class="md" nowrap align="right"></td> 765 <td class="md"></td> 766 <td class="md" nowrap><a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 767 <td class="mdname" nowrap> <em>temp_handle</em>, </td> 768 </tr> 769 <tr> 770 <td class="md" nowrap align="right"></td> 771 <td class="md"></td> 772 <td class="md" nowrap><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 773 <td class="mdname" nowrap> <em>temp_callbacks</em></td> 774 </tr> 775 <tr> 776 <td class="md"></td> 777 <td class="md">) </td> 778 <td class="md" colspan="2"></td> 779 </tr> 780 </table> 781 </td> 782 </tr> 783</table> 784<table cellspacing="5" cellpadding="0" border="0"> 785 <tr> 786 <td> 787 788 </td> 789 <td> 790 791<p> 792Write all metadata out to a FLAC stream via callbacks.<p> 793(See <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> for the details on how padding is used to write metadata in place if possible.)<p> 794This version of the write-with-callbacks function must be used when <a class="el" href="group__flac__metadata__level2.html#ga10">FLAC__metadata_chain_check_if_tempfile_needed()</a> returns true. In this function, you must supply an I/O handle corresponding to the FLAC file to edit, and a temporary handle to which the new FLAC file will be written. It is the caller's job to move this temporary FLAC file on top of the original FLAC file to complete the metadata edit.<p> 795The <em>handle</em> must be open for reading and be seekable. The equivalent minimum stdio fopen() file mode is <code>"r"</code> (or <code>"rb"</code> for Windows).<p> 796The <em>temp_handle</em> must be open for writing. The equivalent minimum stdio fopen() file mode is <code>"w"</code> (or <code>"wb"</code> for Windows). It should be an empty stream, or at least positioned at the start-of-file (in which case it is the caller's duty to truncate it on return).<p> 797For this write function to be used, the chain must have been read with <a class="el" href="group__flac__metadata__level2.html#ga8">FLAC__metadata_chain_read_with_callbacks()</a>/FLAC__metadata_chain_read_ogg_with_callbacks(), not <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a>/FLAC__metadata_chain_read_ogg(). Also, <a class="el" href="group__flac__metadata__level2.html#ga10">FLAC__metadata_chain_check_if_tempfile_needed()</a> must have returned <code>true</code>.<p> 798<dl compact><dt><b>Parameters:</b></dt><dd> 799 <table border="0" cellspacing="2" cellpadding="0"> 800 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 801 <tr><td valign="top"></td><td valign="top"><em>use_padding</em> </td><td>See <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a> </td></tr> 802 <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>The I/O handle of the original FLAC stream to read. The handle will NOT be closed after the metadata is written; that is the duty of the caller. </td></tr> 803 <tr><td valign="top"></td><td valign="top"><em>callbacks</em> </td><td>A set of callbacks to use for I/O on <em>handle</em>. The mandatory callbacks are <em>read</em>, <em>seek</em>, and <em>eof</em>. </td></tr> 804 <tr><td valign="top"></td><td valign="top"><em>temp_handle</em> </td><td>The I/O handle of the FLAC stream to write. The handle will NOT be closed after the metadata is written; that is the duty of the caller. </td></tr> 805 <tr><td valign="top"></td><td valign="top"><em>temp_callbacks</em> </td><td>A set of callbacks to use for I/O on temp_handle. The only mandatory callback is <em>write</em>. </td></tr> 806 </table> 807</dl> 808<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 809</pre></div> </dd></dl> 810<dl compact><dt><b>Return values:</b></dt><dd> 811 <table border="0" cellspacing="2" cellpadding="0"> 812 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if the write succeeded, else <code>false</code>. On failure, check the status with <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. </td></tr> 813 </table> 814</dl> 815 </td> 816 </tr> 817</table> 818<a class="anchor" name="ga14" doxytag="metadata.h::FLAC__metadata_chain_merge_padding"></a><p> 819<table class="mdTable" cellpadding="2" cellspacing="0"> 820 <tr> 821 <td class="mdRow"> 822 <table cellpadding="0" cellspacing="0" border="0"> 823 <tr> 824 <td class="md" nowrap valign="top">void FLAC__metadata_chain_merge_padding </td> 825 <td class="md" valign="top">( </td> 826 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 827 <td class="mdname1" valign="top" nowrap> <em>chain</em> </td> 828 <td class="md" valign="top"> ) </td> 829 <td class="md" nowrap></td> 830 </tr> 831 </table> 832 </td> 833 </tr> 834</table> 835<table cellspacing="5" cellpadding="0" border="0"> 836 <tr> 837 <td> 838 839 </td> 840 <td> 841 842<p> 843Merge adjacent PADDING blocks into a single block.<p> 844<dl compact><dt><b>Note:</b></dt><dd>This function does not write to the FLAC file, it only modifies the chain.</dd></dl> 845<dl compact><dt><b>Warning:</b></dt><dd>Any iterator on the current chain will become invalid after this call. You should delete the iterator and get a new one.</dd></dl> 846<dl compact><dt><b>Parameters:</b></dt><dd> 847 <table border="0" cellspacing="2" cellpadding="0"> 848 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 849 </table> 850</dl> 851<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 852</pre></div> </dd></dl> 853 </td> 854 </tr> 855</table> 856<a class="anchor" name="ga15" doxytag="metadata.h::FLAC__metadata_chain_sort_padding"></a><p> 857<table class="mdTable" cellpadding="2" cellspacing="0"> 858 <tr> 859 <td class="mdRow"> 860 <table cellpadding="0" cellspacing="0" border="0"> 861 <tr> 862 <td class="md" nowrap valign="top">void FLAC__metadata_chain_sort_padding </td> 863 <td class="md" valign="top">( </td> 864 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 865 <td class="mdname1" valign="top" nowrap> <em>chain</em> </td> 866 <td class="md" valign="top"> ) </td> 867 <td class="md" nowrap></td> 868 </tr> 869 </table> 870 </td> 871 </tr> 872</table> 873<table cellspacing="5" cellpadding="0" border="0"> 874 <tr> 875 <td> 876 877 </td> 878 <td> 879 880<p> 881This function will move all PADDING blocks to the end on the metadata, then merge them into a single block.<p> 882<dl compact><dt><b>Note:</b></dt><dd>This function does not write to the FLAC file, it only modifies the chain.</dd></dl> 883<dl compact><dt><b>Warning:</b></dt><dd>Any iterator on the current chain will become invalid after this call. You should delete the iterator and get a new one.</dd></dl> 884<dl compact><dt><b>Parameters:</b></dt><dd> 885 <table border="0" cellspacing="2" cellpadding="0"> 886 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing chain. </td></tr> 887 </table> 888</dl> 889<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> chain != NULL 890</pre></div> </dd></dl> 891 </td> 892 </tr> 893</table> 894<a class="anchor" name="ga16" doxytag="metadata.h::FLAC__metadata_iterator_new"></a><p> 895<table class="mdTable" cellpadding="2" cellspacing="0"> 896 <tr> 897 <td class="mdRow"> 898 <table cellpadding="0" cellspacing="0" border="0"> 899 <tr> 900 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a>* FLAC__metadata_iterator_new </td> 901 <td class="md" valign="top">( </td> 902 <td class="md" nowrap valign="top">void </td> 903 <td class="mdname1" valign="top" nowrap> </td> 904 <td class="md" valign="top"> ) </td> 905 <td class="md" nowrap></td> 906 </tr> 907 </table> 908 </td> 909 </tr> 910</table> 911<table cellspacing="5" cellpadding="0" border="0"> 912 <tr> 913 <td> 914 915 </td> 916 <td> 917 918<p> 919Create a new iterator instance.<p> 920<dl compact><dt><b>Return values:</b></dt><dd> 921 <table border="0" cellspacing="2" cellpadding="0"> 922 <tr><td valign="top"></td><td valign="top"><em>FLAC__Metadata_Iterator*</em> </td><td><code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr> 923 </table> 924</dl> 925 </td> 926 </tr> 927</table> 928<a class="anchor" name="ga17" doxytag="metadata.h::FLAC__metadata_iterator_delete"></a><p> 929<table class="mdTable" cellpadding="2" cellspacing="0"> 930 <tr> 931 <td class="mdRow"> 932 <table cellpadding="0" cellspacing="0" border="0"> 933 <tr> 934 <td class="md" nowrap valign="top">void FLAC__metadata_iterator_delete </td> 935 <td class="md" valign="top">( </td> 936 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 937 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 938 <td class="md" valign="top"> ) </td> 939 <td class="md" nowrap></td> 940 </tr> 941 </table> 942 </td> 943 </tr> 944</table> 945<table cellspacing="5" cellpadding="0" border="0"> 946 <tr> 947 <td> 948 949 </td> 950 <td> 951 952<p> 953Free an iterator instance. Deletes the object pointed to by <em>iterator</em>.<p> 954<dl compact><dt><b>Parameters:</b></dt><dd> 955 <table border="0" cellspacing="2" cellpadding="0"> 956 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing iterator. </td></tr> 957 </table> 958</dl> 959<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 960</pre></div> </dd></dl> 961 </td> 962 </tr> 963</table> 964<a class="anchor" name="ga18" doxytag="metadata.h::FLAC__metadata_iterator_init"></a><p> 965<table class="mdTable" cellpadding="2" cellspacing="0"> 966 <tr> 967 <td class="mdRow"> 968 <table cellpadding="0" cellspacing="0" border="0"> 969 <tr> 970 <td class="md" nowrap valign="top">void FLAC__metadata_iterator_init </td> 971 <td class="md" valign="top">( </td> 972 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 973 <td class="mdname" nowrap> <em>iterator</em>, </td> 974 </tr> 975 <tr> 976 <td class="md" nowrap align="right"></td> 977 <td class="md"></td> 978 <td class="md" nowrap><a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td> 979 <td class="mdname" nowrap> <em>chain</em></td> 980 </tr> 981 <tr> 982 <td class="md"></td> 983 <td class="md">) </td> 984 <td class="md" colspan="2"></td> 985 </tr> 986 </table> 987 </td> 988 </tr> 989</table> 990<table cellspacing="5" cellpadding="0" border="0"> 991 <tr> 992 <td> 993 994 </td> 995 <td> 996 997<p> 998Initialize the iterator to point to the first metadata block in the given chain.<p> 999<dl compact><dt><b>Parameters:</b></dt><dd> 1000 <table border="0" cellspacing="2" cellpadding="0"> 1001 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing iterator. </td></tr> 1002 <tr><td valign="top"></td><td valign="top"><em>chain</em> </td><td>A pointer to an existing and initialized (read) chain. </td></tr> 1003 </table> 1004</dl> 1005<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1006</pre></div> <div class="fragment"><pre class="fragment"> chain != NULL 1007</pre></div> </dd></dl> 1008 </td> 1009 </tr> 1010</table> 1011<a class="anchor" name="ga19" doxytag="metadata.h::FLAC__metadata_iterator_next"></a><p> 1012<table class="mdTable" cellpadding="2" cellspacing="0"> 1013 <tr> 1014 <td class="mdRow"> 1015 <table cellpadding="0" cellspacing="0" border="0"> 1016 <tr> 1017 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_iterator_next </td> 1018 <td class="md" valign="top">( </td> 1019 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1020 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 1021 <td class="md" valign="top"> ) </td> 1022 <td class="md" nowrap></td> 1023 </tr> 1024 </table> 1025 </td> 1026 </tr> 1027</table> 1028<table cellspacing="5" cellpadding="0" border="0"> 1029 <tr> 1030 <td> 1031 1032 </td> 1033 <td> 1034 1035<p> 1036Moves the iterator forward one metadata block, returning <code>false</code> if already at the end.<p> 1037<dl compact><dt><b>Parameters:</b></dt><dd> 1038 <table border="0" cellspacing="2" cellpadding="0"> 1039 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1040 </table> 1041</dl> 1042<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1043</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> </dd></dl> 1044<dl compact><dt><b>Return values:</b></dt><dd> 1045 <table border="0" cellspacing="2" cellpadding="0"> 1046 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>false</code> if already at the last metadata block of the chain, else <code>true</code>. </td></tr> 1047 </table> 1048</dl> 1049 </td> 1050 </tr> 1051</table> 1052<a class="anchor" name="ga20" doxytag="metadata.h::FLAC__metadata_iterator_prev"></a><p> 1053<table class="mdTable" cellpadding="2" cellspacing="0"> 1054 <tr> 1055 <td class="mdRow"> 1056 <table cellpadding="0" cellspacing="0" border="0"> 1057 <tr> 1058 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_iterator_prev </td> 1059 <td class="md" valign="top">( </td> 1060 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1061 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 1062 <td class="md" valign="top"> ) </td> 1063 <td class="md" nowrap></td> 1064 </tr> 1065 </table> 1066 </td> 1067 </tr> 1068</table> 1069<table cellspacing="5" cellpadding="0" border="0"> 1070 <tr> 1071 <td> 1072 1073 </td> 1074 <td> 1075 1076<p> 1077Moves the iterator backward one metadata block, returning <code>false</code> if already at the beginning.<p> 1078<dl compact><dt><b>Parameters:</b></dt><dd> 1079 <table border="0" cellspacing="2" cellpadding="0"> 1080 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1081 </table> 1082</dl> 1083<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1084</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> </dd></dl> 1085<dl compact><dt><b>Return values:</b></dt><dd> 1086 <table border="0" cellspacing="2" cellpadding="0"> 1087 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>false</code> if already at the first metadata block of the chain, else <code>true</code>. </td></tr> 1088 </table> 1089</dl> 1090 </td> 1091 </tr> 1092</table> 1093<a class="anchor" name="ga21" doxytag="metadata.h::FLAC__metadata_iterator_get_block_type"></a><p> 1094<table class="mdTable" cellpadding="2" cellspacing="0"> 1095 <tr> 1096 <td class="mdRow"> 1097 <table cellpadding="0" cellspacing="0" border="0"> 1098 <tr> 1099 <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga113">FLAC__MetadataType</a> FLAC__metadata_iterator_get_block_type </td> 1100 <td class="md" valign="top">( </td> 1101 <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1102 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 1103 <td class="md" valign="top"> ) </td> 1104 <td class="md" nowrap></td> 1105 </tr> 1106 </table> 1107 </td> 1108 </tr> 1109</table> 1110<table cellspacing="5" cellpadding="0" border="0"> 1111 <tr> 1112 <td> 1113 1114 </td> 1115 <td> 1116 1117<p> 1118Get the type of the metadata block at the current position.<p> 1119<dl compact><dt><b>Parameters:</b></dt><dd> 1120 <table border="0" cellspacing="2" cellpadding="0"> 1121 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1122 </table> 1123</dl> 1124<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1125</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> </dd></dl> 1126<dl compact><dt><b>Return values:</b></dt><dd> 1127 <table border="0" cellspacing="2" cellpadding="0"> 1128 <tr><td valign="top"></td><td valign="top"><em>FLAC__MetadataType</em> </td><td>The type of the metadata block at the current iterator position. </td></tr> 1129 </table> 1130</dl> 1131 </td> 1132 </tr> 1133</table> 1134<a class="anchor" name="ga22" doxytag="metadata.h::FLAC__metadata_iterator_get_block"></a><p> 1135<table class="mdTable" cellpadding="2" cellspacing="0"> 1136 <tr> 1137 <td class="mdRow"> 1138 <table cellpadding="0" cellspacing="0" border="0"> 1139 <tr> 1140 <td class="md" nowrap valign="top"><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a>* FLAC__metadata_iterator_get_block </td> 1141 <td class="md" valign="top">( </td> 1142 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1143 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 1144 <td class="md" valign="top"> ) </td> 1145 <td class="md" nowrap></td> 1146 </tr> 1147 </table> 1148 </td> 1149 </tr> 1150</table> 1151<table cellspacing="5" cellpadding="0" border="0"> 1152 <tr> 1153 <td> 1154 1155 </td> 1156 <td> 1157 1158<p> 1159Get the metadata block at the current position. You can modify the block in place but must write the chain before the changes are reflected to the FLAC file. You do not need to call <a class="el" href="group__flac__metadata__level2.html#ga23">FLAC__metadata_iterator_set_block()</a> to reflect the changes; the pointer returned by <a class="el" href="group__flac__metadata__level2.html#ga22">FLAC__metadata_iterator_get_block()</a> points directly into the chain.<p> 1160<dl compact><dt><b>Warning:</b></dt><dd>Do not call <a class="el" href="group__flac__metadata__object.html#ga2">FLAC__metadata_object_delete()</a> on the returned object; to delete a block use <a class="el" href="group__flac__metadata__level2.html#ga24">FLAC__metadata_iterator_delete_block()</a>.</dd></dl> 1161<dl compact><dt><b>Parameters:</b></dt><dd> 1162 <table border="0" cellspacing="2" cellpadding="0"> 1163 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1164 </table> 1165</dl> 1166<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1167</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> </dd></dl> 1168<dl compact><dt><b>Return values:</b></dt><dd> 1169 <table border="0" cellspacing="2" cellpadding="0"> 1170 <tr><td valign="top"></td><td valign="top"><em>FLAC__StreamMetadata*</em> </td><td>The current metadata block. </td></tr> 1171 </table> 1172</dl> 1173 </td> 1174 </tr> 1175</table> 1176<a class="anchor" name="ga23" doxytag="metadata.h::FLAC__metadata_iterator_set_block"></a><p> 1177<table class="mdTable" cellpadding="2" cellspacing="0"> 1178 <tr> 1179 <td class="mdRow"> 1180 <table cellpadding="0" cellspacing="0" border="0"> 1181 <tr> 1182 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_iterator_set_block </td> 1183 <td class="md" valign="top">( </td> 1184 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1185 <td class="mdname" nowrap> <em>iterator</em>, </td> 1186 </tr> 1187 <tr> 1188 <td class="md" nowrap align="right"></td> 1189 <td class="md"></td> 1190 <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td> 1191 <td class="mdname" nowrap> <em>block</em></td> 1192 </tr> 1193 <tr> 1194 <td class="md"></td> 1195 <td class="md">) </td> 1196 <td class="md" colspan="2"></td> 1197 </tr> 1198 </table> 1199 </td> 1200 </tr> 1201</table> 1202<table cellspacing="5" cellpadding="0" border="0"> 1203 <tr> 1204 <td> 1205 1206 </td> 1207 <td> 1208 1209<p> 1210Set the metadata block at the current position, replacing the existing block. The new block passed in becomes owned by the chain and it will be deleted when the chain is deleted.<p> 1211<dl compact><dt><b>Parameters:</b></dt><dd> 1212 <table border="0" cellspacing="2" cellpadding="0"> 1213 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1214 <tr><td valign="top"></td><td valign="top"><em>block</em> </td><td>A pointer to a metadata block. </td></tr> 1215 </table> 1216</dl> 1217<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1218</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> <div class="fragment"><pre class="fragment"> block != NULL 1219</pre></div> </dd></dl> 1220<dl compact><dt><b>Return values:</b></dt><dd> 1221 <table border="0" cellspacing="2" cellpadding="0"> 1222 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>false</code> if the conditions in the above description are not met, or a memory allocation error occurs, otherwise <code>true</code>. </td></tr> 1223 </table> 1224</dl> 1225 </td> 1226 </tr> 1227</table> 1228<a class="anchor" name="ga24" doxytag="metadata.h::FLAC__metadata_iterator_delete_block"></a><p> 1229<table class="mdTable" cellpadding="2" cellspacing="0"> 1230 <tr> 1231 <td class="mdRow"> 1232 <table cellpadding="0" cellspacing="0" border="0"> 1233 <tr> 1234 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_iterator_delete_block </td> 1235 <td class="md" valign="top">( </td> 1236 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1237 <td class="mdname" nowrap> <em>iterator</em>, </td> 1238 </tr> 1239 <tr> 1240 <td class="md" nowrap align="right"></td> 1241 <td class="md"></td> 1242 <td class="md" nowrap>FLAC__bool </td> 1243 <td class="mdname" nowrap> <em>replace_with_padding</em></td> 1244 </tr> 1245 <tr> 1246 <td class="md"></td> 1247 <td class="md">) </td> 1248 <td class="md" colspan="2"></td> 1249 </tr> 1250 </table> 1251 </td> 1252 </tr> 1253</table> 1254<table cellspacing="5" cellpadding="0" border="0"> 1255 <tr> 1256 <td> 1257 1258 </td> 1259 <td> 1260 1261<p> 1262Removes the current block from the chain. If <em>replace_with_padding</em> is <code>true</code>, the block will instead be replaced with a padding block of equal size. You can not delete the STREAMINFO block. The iterator will be left pointing to the block before the one just "deleted", even if <em>replace_with_padding</em> is <code>true</code>.<p> 1263<dl compact><dt><b>Parameters:</b></dt><dd> 1264 <table border="0" cellspacing="2" cellpadding="0"> 1265 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1266 <tr><td valign="top"></td><td valign="top"><em>replace_with_padding</em> </td><td>See above. </td></tr> 1267 </table> 1268</dl> 1269<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1270</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> </dd></dl> 1271<dl compact><dt><b>Return values:</b></dt><dd> 1272 <table border="0" cellspacing="2" cellpadding="0"> 1273 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>false</code> if the conditions in the above description are not met, otherwise <code>true</code>. </td></tr> 1274 </table> 1275</dl> 1276 </td> 1277 </tr> 1278</table> 1279<a class="anchor" name="ga25" doxytag="metadata.h::FLAC__metadata_iterator_insert_block_before"></a><p> 1280<table class="mdTable" cellpadding="2" cellspacing="0"> 1281 <tr> 1282 <td class="mdRow"> 1283 <table cellpadding="0" cellspacing="0" border="0"> 1284 <tr> 1285 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_iterator_insert_block_before </td> 1286 <td class="md" valign="top">( </td> 1287 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1288 <td class="mdname" nowrap> <em>iterator</em>, </td> 1289 </tr> 1290 <tr> 1291 <td class="md" nowrap align="right"></td> 1292 <td class="md"></td> 1293 <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td> 1294 <td class="mdname" nowrap> <em>block</em></td> 1295 </tr> 1296 <tr> 1297 <td class="md"></td> 1298 <td class="md">) </td> 1299 <td class="md" colspan="2"></td> 1300 </tr> 1301 </table> 1302 </td> 1303 </tr> 1304</table> 1305<table cellspacing="5" cellpadding="0" border="0"> 1306 <tr> 1307 <td> 1308 1309 </td> 1310 <td> 1311 1312<p> 1313Insert a new block before the current block. You cannot insert a block before the first STREAMINFO block. You cannot insert a STREAMINFO block as there can be only one, the one that already exists at the head when you read in a chain. The chain takes ownership of the new block and it will be deleted when the chain is deleted. The iterator will be left pointing to the new block.<p> 1314<dl compact><dt><b>Parameters:</b></dt><dd> 1315 <table border="0" cellspacing="2" cellpadding="0"> 1316 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1317 <tr><td valign="top"></td><td valign="top"><em>block</em> </td><td>A pointer to a metadata block to insert. </td></tr> 1318 </table> 1319</dl> 1320<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1321</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> </dd></dl> 1322<dl compact><dt><b>Return values:</b></dt><dd> 1323 <table border="0" cellspacing="2" cellpadding="0"> 1324 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>false</code> if the conditions in the above description are not met, or a memory allocation error occurs, otherwise <code>true</code>. </td></tr> 1325 </table> 1326</dl> 1327 </td> 1328 </tr> 1329</table> 1330<a class="anchor" name="ga26" doxytag="metadata.h::FLAC__metadata_iterator_insert_block_after"></a><p> 1331<table class="mdTable" cellpadding="2" cellspacing="0"> 1332 <tr> 1333 <td class="mdRow"> 1334 <table cellpadding="0" cellspacing="0" border="0"> 1335 <tr> 1336 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_iterator_insert_block_after </td> 1337 <td class="md" valign="top">( </td> 1338 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> * </td> 1339 <td class="mdname" nowrap> <em>iterator</em>, </td> 1340 </tr> 1341 <tr> 1342 <td class="md" nowrap align="right"></td> 1343 <td class="md"></td> 1344 <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td> 1345 <td class="mdname" nowrap> <em>block</em></td> 1346 </tr> 1347 <tr> 1348 <td class="md"></td> 1349 <td class="md">) </td> 1350 <td class="md" colspan="2"></td> 1351 </tr> 1352 </table> 1353 </td> 1354 </tr> 1355</table> 1356<table cellspacing="5" cellpadding="0" border="0"> 1357 <tr> 1358 <td> 1359 1360 </td> 1361 <td> 1362 1363<p> 1364Insert a new block after the current block. You cannot insert a STREAMINFO block as there can be only one, the one that already exists at the head when you read in a chain. The chain takes ownership of the new block and it will be deleted when the chain is deleted. The iterator will be left pointing to the new block.<p> 1365<dl compact><dt><b>Parameters:</b></dt><dd> 1366 <table border="0" cellspacing="2" cellpadding="0"> 1367 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 1368 <tr><td valign="top"></td><td valign="top"><em>block</em> </td><td>A pointer to a metadata block to insert. </td></tr> 1369 </table> 1370</dl> 1371<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 1372</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#ga18">FLAC__metadata_iterator_init()</a> </dd></dl> 1373<dl compact><dt><b>Return values:</b></dt><dd> 1374 <table border="0" cellspacing="2" cellpadding="0"> 1375 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>false</code> if the conditions in the above description are not met, or a memory allocation error occurs, otherwise <code>true</code>. </td></tr> 1376 </table> 1377</dl> 1378 </td> 1379 </tr> 1380</table> 1381<hr><h2>Variable Documentation</h2> 1382<a class="anchor" name="ga2" doxytag="metadata.h::FLAC__Metadata_ChainStatusString"></a><p> 1383<table class="mdTable" cellpadding="2" cellspacing="0"> 1384 <tr> 1385 <td class="mdRow"> 1386 <table cellpadding="0" cellspacing="0" border="0"> 1387 <tr> 1388 <td class="md" nowrap valign="top">const char* const <a class="el" href="group__flac__metadata__level2.html#ga2">FLAC__Metadata_ChainStatusString</a>[] </td> 1389 </tr> 1390 </table> 1391 </td> 1392 </tr> 1393</table> 1394<table cellspacing="5" cellpadding="0" border="0"> 1395 <tr> 1396 <td> 1397 1398 </td> 1399 <td> 1400 1401<p> 1402Maps a FLAC__Metadata_ChainStatus to a C string.<p> 1403Using a FLAC__Metadata_ChainStatus as the index to this array will give the string equivalent. The contents should not be modified. </td> 1404 </tr> 1405</table> 1406 1407<hr size="1"> 1408<div class="copyright"> 1409 <!-- @@@ oh so hacky --> 1410 <table> 1411 <tr> 1412 <td align="left"> 1413 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson 1414 </td> 1415 <td width="1%" align="right"> 1416 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> 1417 </td> 1418 </tr> 1419 </table> 1420</div> 1421<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson --> 1422<!-- Permission is granted to copy, distribute and/or modify this document --> 1423<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> 1424<!-- or any later version published by the Free Software Foundation; --> 1425<!-- with no invariant sections. --> 1426<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> 1427</body> 1428</html> 1429