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 1 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 1 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 1 interface provides read-write access to FLAC file metadata and operates directly on the FLAC file. 13<p> 14The general usage of this interface is:<p> 15<ul> 16<li>Create an iterator using <a class="el" href="group__flac__metadata__level1.html#ga2">FLAC__metadata_simple_iterator_new()</a></li><li>Attach it to a file using <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> and check the exit code. Call <a class="el" href="group__flac__metadata__level1.html#ga6">FLAC__metadata_simple_iterator_is_writable()</a> to see if the file is writable, or only read access is allowed.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga7">FLAC__metadata_simple_iterator_next()</a> and <a class="el" href="group__flac__metadata__level1.html#ga8">FLAC__metadata_simple_iterator_prev()</a> to traverse the blocks. This is does not read the actual blocks themselves. <a class="el" href="group__flac__metadata__level1.html#ga7">FLAC__metadata_simple_iterator_next()</a> is relatively fast. <a class="el" href="group__flac__metadata__level1.html#ga8">FLAC__metadata_simple_iterator_prev()</a> is slower since it needs to search forward from the front of the file.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_get_block_type()</a> or <a class="el" href="group__flac__metadata__level1.html#ga14">FLAC__metadata_simple_iterator_get_block()</a> to access the actual data at the current iterator position. The returned object is yours to modify and free.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a> to write a modified block back. You must have write permission to the original file. Make sure to read the whole comment to <a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a> below.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga16">FLAC__metadata_simple_iterator_insert_block_after()</a> to add new blocks. Use the object creation functions from <a class="el" href="group__flac__metadata__object.html">here </a> to generate new objects.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga17">FLAC__metadata_simple_iterator_delete_block()</a> to remove the block currently referred to by the iterator, or replace it with padding.</li><li>Destroy the iterator with <a class="el" href="group__flac__metadata__level1.html#ga3">FLAC__metadata_simple_iterator_delete()</a> when finished.</li></ul> 17<p> 18<dl compact><dt><b>Note:</b></dt><dd>The FLAC file remains open the whole time between <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> and <a class="el" href="group__flac__metadata__level1.html#ga3">FLAC__metadata_simple_iterator_delete()</a>, so make sure you are not altering the file during this time.<p> 19Do not modify the <em>is_last</em>, <em>length</em>, or <em>type</em> fields of returned <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> objects. These are managed automatically.<p> 20If any of the modification functions (<a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a>, <a class="el" href="group__flac__metadata__level1.html#ga17">FLAC__metadata_simple_iterator_delete_block()</a>, <a class="el" href="group__flac__metadata__level1.html#ga16">FLAC__metadata_simple_iterator_insert_block_after()</a>, etc.) return <code>false</code>, you should delete the iterator as it may no longer be valid. </dd></dl> 21 22<p> 23<table border="0" cellpadding="0" cellspacing="0"> 24<tr><td></td></tr> 25<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> 26<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a></td></tr> 27 28<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> 29<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga18">FLAC__Metadata_SimpleIteratorStatus</a> { <br> 30 <a class="el" href="group__flac__metadata__level1.html#gga18a5">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK</a> = 0, 31<a class="el" href="group__flac__metadata__level1.html#gga18a6">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT</a>, 32<a class="el" href="group__flac__metadata__level1.html#gga18a7">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE</a>, 33<a class="el" href="group__flac__metadata__level1.html#gga18a8">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE</a>, 34<br> 35 <a class="el" href="group__flac__metadata__level1.html#gga18a9">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE</a>, 36<a class="el" href="group__flac__metadata__level1.html#gga18a10">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA</a>, 37<a class="el" href="group__flac__metadata__level1.html#gga18a11">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR</a>, 38<a class="el" href="group__flac__metadata__level1.html#gga18a12">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR</a>, 39<br> 40 <a class="el" href="group__flac__metadata__level1.html#gga18a13">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR</a>, 41<a class="el" href="group__flac__metadata__level1.html#gga18a14">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR</a>, 42<a class="el" href="group__flac__metadata__level1.html#gga18a15">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR</a>, 43<a class="el" href="group__flac__metadata__level1.html#gga18a16">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR</a>, 44<br> 45 <a class="el" href="group__flac__metadata__level1.html#gga18a17">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR</a> 46<br> 47 }</td></tr> 48 49<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga2">FLAC__metadata_simple_iterator_new</a> (void)</td></tr> 51 52<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga3">FLAC__metadata_simple_iterator_delete</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr> 53 54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__metadata__level1.html#ga18">FLAC__Metadata_SimpleIteratorStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga4">FLAC__metadata_simple_iterator_status</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr> 55 56<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, const char *filename, FLAC__bool read_only, FLAC__bool preserve_file_stats)</td></tr> 57 58<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga6">FLAC__metadata_simple_iterator_is_writable</a> (const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr> 59 60<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga7">FLAC__metadata_simple_iterator_next</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</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__level1.html#ga8">FLAC__metadata_simple_iterator_prev</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</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__level1.html#ga9">FLAC__metadata_simple_iterator_is_last</a> (const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr> 65 66<tr><td class="memItemLeft" nowrap align="right" valign="top">off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga10">FLAC__metadata_simple_iterator_get_block_offset</a> (const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr> 67 68<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__level1.html#ga11">FLAC__metadata_simple_iterator_get_block_type</a> (const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr> 69 70<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga12">FLAC__metadata_simple_iterator_get_block_length</a> (const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</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__level1.html#ga13">FLAC__metadata_simple_iterator_get_application_id</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, FLAC__byte *id)</td></tr> 73 74<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__level1.html#ga14">FLAC__metadata_simple_iterator_get_block</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</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__level1.html#ga15">FLAC__metadata_simple_iterator_set_block</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block, FLAC__bool use_padding)</td></tr> 77 78<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga16">FLAC__metadata_simple_iterator_insert_block_after</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block, FLAC__bool use_padding)</td></tr> 79 80<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga17">FLAC__metadata_simple_iterator_delete_block</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, FLAC__bool use_padding)</td></tr> 81 82<tr><td colspan="2"><br><h2>Variables</h2></td></tr> 83<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__level1.html#ga1">FLAC__Metadata_SimpleIteratorStatusString</a> []</td></tr> 84 85</table> 86<hr><h2>Typedef Documentation</h2> 87<a class="anchor" name="ga0" doxytag="metadata.h::FLAC__Metadata_SimpleIterator"></a><p> 88<table class="mdTable" cellpadding="2" cellspacing="0"> 89 <tr> 90 <td class="mdRow"> 91 <table cellpadding="0" cellspacing="0" border="0"> 92 <tr> 93 <td class="md" nowrap valign="top">typedef struct <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> </td> 94 </tr> 95 </table> 96 </td> 97 </tr> 98</table> 99<table cellspacing="5" cellpadding="0" border="0"> 100 <tr> 101 <td> 102 103 </td> 104 <td> 105 106<p> 107The opaque structure definition for the level 1 iterator type. See the <a class="el" href="group__flac__metadata__level1.html">metadata level 1 module </a> for a detailed description. </td> 108 </tr> 109</table> 110<hr><h2>Enumeration Type Documentation</h2> 111<a class="anchor" name="ga18" doxytag="metadata.h::FLAC__Metadata_SimpleIteratorStatus"></a><p> 112<table class="mdTable" cellpadding="2" cellspacing="0"> 113 <tr> 114 <td class="mdRow"> 115 <table cellpadding="0" cellspacing="0" border="0"> 116 <tr> 117 <td class="md" nowrap valign="top">enum <a class="el" href="group__flac__metadata__level1.html#ga18">FLAC__Metadata_SimpleIteratorStatus</a> </td> 118 </tr> 119 </table> 120 </td> 121 </tr> 122</table> 123<table cellspacing="5" cellpadding="0" border="0"> 124 <tr> 125 <td> 126 127 </td> 128 <td> 129 130<p> 131Status type for FLAC__Metadata_SimpleIterator.<p> 132The iterator's current status can be obtained by calling <a class="el" href="group__flac__metadata__level1.html#ga4">FLAC__metadata_simple_iterator_status()</a>. <dl compact><dt><b>Enumeration values: </b></dt><dd> 133<table border="0" cellspacing="2" cellpadding="0"> 134<tr><td valign="top"><em><a class="anchor" name="gga18a5" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK</em> </td><td> 135The iterator is in the normal OK state </td></tr> 136<tr><td valign="top"><em><a class="anchor" name="gga18a6" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT</em> </td><td> 137The data passed into a function violated the function's usage criteria </td></tr> 138<tr><td valign="top"><em><a class="anchor" name="gga18a7" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE</em> </td><td> 139The iterator could not open the target file </td></tr> 140<tr><td valign="top"><em><a class="anchor" name="gga18a8" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE</em> </td><td> 141The iterator could not find the FLAC signature at the start of the file </td></tr> 142<tr><td valign="top"><em><a class="anchor" name="gga18a9" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE</em> </td><td> 143The iterator tried to write to a file that was not writable </td></tr> 144<tr><td valign="top"><em><a class="anchor" name="gga18a10" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA</em> </td><td> 145The iterator encountered input that does not conform to the FLAC metadata specification </td></tr> 146<tr><td valign="top"><em><a class="anchor" name="gga18a11" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR</em> </td><td> 147The iterator encountered an error while reading the FLAC file </td></tr> 148<tr><td valign="top"><em><a class="anchor" name="gga18a12" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR</em> </td><td> 149The iterator encountered an error while seeking in the FLAC file </td></tr> 150<tr><td valign="top"><em><a class="anchor" name="gga18a13" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR</em> </td><td> 151The iterator encountered an error while writing the FLAC file </td></tr> 152<tr><td valign="top"><em><a class="anchor" name="gga18a14" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR</em> </td><td> 153The iterator encountered an error renaming the FLAC file </td></tr> 154<tr><td valign="top"><em><a class="anchor" name="gga18a15" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR</em> </td><td> 155The iterator encountered an error removing the temporary file </td></tr> 156<tr><td valign="top"><em><a class="anchor" name="gga18a16" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR</em> </td><td> 157Memory allocation failed </td></tr> 158<tr><td valign="top"><em><a class="anchor" name="gga18a17" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR</em> </td><td> 159The caller violated an assertion or an unexpected error occurred </td></tr> 160</table> 161</dl> 162 </td> 163 </tr> 164</table> 165<hr><h2>Function Documentation</h2> 166<a class="anchor" name="ga2" doxytag="metadata.h::FLAC__metadata_simple_iterator_new"></a><p> 167<table class="mdTable" cellpadding="2" cellspacing="0"> 168 <tr> 169 <td class="mdRow"> 170 <table cellpadding="0" cellspacing="0" border="0"> 171 <tr> 172 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a>* FLAC__metadata_simple_iterator_new </td> 173 <td class="md" valign="top">( </td> 174 <td class="md" nowrap valign="top">void </td> 175 <td class="mdname1" valign="top" nowrap> </td> 176 <td class="md" valign="top"> ) </td> 177 <td class="md" nowrap></td> 178 </tr> 179 </table> 180 </td> 181 </tr> 182</table> 183<table cellspacing="5" cellpadding="0" border="0"> 184 <tr> 185 <td> 186 187 </td> 188 <td> 189 190<p> 191Create a new iterator instance.<p> 192<dl compact><dt><b>Return values:</b></dt><dd> 193 <table border="0" cellspacing="2" cellpadding="0"> 194 <tr><td valign="top"></td><td valign="top"><em>FLAC__Metadata_SimpleIterator*</em> </td><td><code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr> 195 </table> 196</dl> 197 </td> 198 </tr> 199</table> 200<a class="anchor" name="ga3" doxytag="metadata.h::FLAC__metadata_simple_iterator_delete"></a><p> 201<table class="mdTable" cellpadding="2" cellspacing="0"> 202 <tr> 203 <td class="mdRow"> 204 <table cellpadding="0" cellspacing="0" border="0"> 205 <tr> 206 <td class="md" nowrap valign="top">void FLAC__metadata_simple_iterator_delete </td> 207 <td class="md" valign="top">( </td> 208 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 209 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 210 <td class="md" valign="top"> ) </td> 211 <td class="md" nowrap></td> 212 </tr> 213 </table> 214 </td> 215 </tr> 216</table> 217<table cellspacing="5" cellpadding="0" border="0"> 218 <tr> 219 <td> 220 221 </td> 222 <td> 223 224<p> 225Free an iterator instance. Deletes the object pointed to by <em>iterator</em>.<p> 226<dl compact><dt><b>Parameters:</b></dt><dd> 227 <table border="0" cellspacing="2" cellpadding="0"> 228 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing iterator. </td></tr> 229 </table> 230</dl> 231<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 232</pre></div> </dd></dl> 233 </td> 234 </tr> 235</table> 236<a class="anchor" name="ga4" doxytag="metadata.h::FLAC__metadata_simple_iterator_status"></a><p> 237<table class="mdTable" cellpadding="2" cellspacing="0"> 238 <tr> 239 <td class="mdRow"> 240 <table cellpadding="0" cellspacing="0" border="0"> 241 <tr> 242 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga18">FLAC__Metadata_SimpleIteratorStatus</a> FLAC__metadata_simple_iterator_status </td> 243 <td class="md" valign="top">( </td> 244 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 245 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 246 <td class="md" valign="top"> ) </td> 247 <td class="md" nowrap></td> 248 </tr> 249 </table> 250 </td> 251 </tr> 252</table> 253<table cellspacing="5" cellpadding="0" border="0"> 254 <tr> 255 <td> 256 257 </td> 258 <td> 259 260<p> 261Get the current status of the iterator. Call this after a function returns <code>false</code> to get the reason for the error. Also resets the status to FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK.<p> 262<dl compact><dt><b>Parameters:</b></dt><dd> 263 <table border="0" cellspacing="2" cellpadding="0"> 264 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing iterator. </td></tr> 265 </table> 266</dl> 267<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 268</pre></div> </dd></dl> 269<dl compact><dt><b>Return values:</b></dt><dd> 270 <table border="0" cellspacing="2" cellpadding="0"> 271 <tr><td valign="top"></td><td valign="top"><em>FLAC__Metadata_SimpleIteratorStatus</em> </td><td>The current status of the iterator. </td></tr> 272 </table> 273</dl> 274 </td> 275 </tr> 276</table> 277<a class="anchor" name="ga5" doxytag="metadata.h::FLAC__metadata_simple_iterator_init"></a><p> 278<table class="mdTable" cellpadding="2" cellspacing="0"> 279 <tr> 280 <td class="mdRow"> 281 <table cellpadding="0" cellspacing="0" border="0"> 282 <tr> 283 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_init </td> 284 <td class="md" valign="top">( </td> 285 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 286 <td class="mdname" nowrap> <em>iterator</em>, </td> 287 </tr> 288 <tr> 289 <td class="md" nowrap align="right"></td> 290 <td class="md"></td> 291 <td class="md" nowrap>const char * </td> 292 <td class="mdname" nowrap> <em>filename</em>, </td> 293 </tr> 294 <tr> 295 <td class="md" nowrap align="right"></td> 296 <td class="md"></td> 297 <td class="md" nowrap>FLAC__bool </td> 298 <td class="mdname" nowrap> <em>read_only</em>, </td> 299 </tr> 300 <tr> 301 <td class="md" nowrap align="right"></td> 302 <td class="md"></td> 303 <td class="md" nowrap>FLAC__bool </td> 304 <td class="mdname" nowrap> <em>preserve_file_stats</em></td> 305 </tr> 306 <tr> 307 <td class="md"></td> 308 <td class="md">) </td> 309 <td class="md" colspan="2"></td> 310 </tr> 311 </table> 312 </td> 313 </tr> 314</table> 315<table cellspacing="5" cellpadding="0" border="0"> 316 <tr> 317 <td> 318 319 </td> 320 <td> 321 322<p> 323Initialize the iterator to point to the first metadata block in the given FLAC file.<p> 324<dl compact><dt><b>Parameters:</b></dt><dd> 325 <table border="0" cellspacing="2" cellpadding="0"> 326 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing iterator. </td></tr> 327 <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The path to the FLAC file. </td></tr> 328 <tr><td valign="top"></td><td valign="top"><em>read_only</em> </td><td>If <code>true</code>, the FLAC file will be opened in read-only mode; if <code>false</code>, the FLAC file will be opened for edit even if no edits are performed. </td></tr> 329 <tr><td valign="top"></td><td valign="top"><em>preserve_file_stats</em> </td><td>If <code>true</code>, the owner and modification time will be preserved even if the FLAC file is written to. </td></tr> 330 </table> 331</dl> 332<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 333</pre></div> <div class="fragment"><pre class="fragment"> filename != NULL 334</pre></div> </dd></dl> 335<dl compact><dt><b>Return values:</b></dt><dd> 336 <table border="0" cellspacing="2" cellpadding="0"> 337 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>false</code> if a memory allocation error occurs, the file can't be opened, or another error occurs, else <code>true</code>. </td></tr> 338 </table> 339</dl> 340 </td> 341 </tr> 342</table> 343<a class="anchor" name="ga6" doxytag="metadata.h::FLAC__metadata_simple_iterator_is_writable"></a><p> 344<table class="mdTable" cellpadding="2" cellspacing="0"> 345 <tr> 346 <td class="mdRow"> 347 <table cellpadding="0" cellspacing="0" border="0"> 348 <tr> 349 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_is_writable </td> 350 <td class="md" valign="top">( </td> 351 <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 352 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 353 <td class="md" valign="top"> ) </td> 354 <td class="md" nowrap></td> 355 </tr> 356 </table> 357 </td> 358 </tr> 359</table> 360<table cellspacing="5" cellpadding="0" border="0"> 361 <tr> 362 <td> 363 364 </td> 365 <td> 366 367<p> 368Returns <code>true</code> if the FLAC file is writable. If <code>false</code>, calls to <a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a> and <a class="el" href="group__flac__metadata__level1.html#ga16">FLAC__metadata_simple_iterator_insert_block_after()</a> will fail.<p> 369<dl compact><dt><b>Parameters:</b></dt><dd> 370 <table border="0" cellspacing="2" cellpadding="0"> 371 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing iterator. </td></tr> 372 </table> 373</dl> 374<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 375</pre></div> </dd></dl> 376<dl compact><dt><b>Return values:</b></dt><dd> 377 <table border="0" cellspacing="2" cellpadding="0"> 378 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td>See above. </td></tr> 379 </table> 380</dl> 381 </td> 382 </tr> 383</table> 384<a class="anchor" name="ga7" doxytag="metadata.h::FLAC__metadata_simple_iterator_next"></a><p> 385<table class="mdTable" cellpadding="2" cellspacing="0"> 386 <tr> 387 <td class="mdRow"> 388 <table cellpadding="0" cellspacing="0" border="0"> 389 <tr> 390 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_next </td> 391 <td class="md" valign="top">( </td> 392 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 393 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 394 <td class="md" valign="top"> ) </td> 395 <td class="md" nowrap></td> 396 </tr> 397 </table> 398 </td> 399 </tr> 400</table> 401<table cellspacing="5" cellpadding="0" border="0"> 402 <tr> 403 <td> 404 405 </td> 406 <td> 407 408<p> 409Moves the iterator forward one metadata block, returning <code>false</code> if already at the end.<p> 410<dl compact><dt><b>Parameters:</b></dt><dd> 411 <table border="0" cellspacing="2" cellpadding="0"> 412 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 413 </table> 414</dl> 415<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 416</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 417<dl compact><dt><b>Return values:</b></dt><dd> 418 <table border="0" cellspacing="2" cellpadding="0"> 419 <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> 420 </table> 421</dl> 422 </td> 423 </tr> 424</table> 425<a class="anchor" name="ga8" doxytag="metadata.h::FLAC__metadata_simple_iterator_prev"></a><p> 426<table class="mdTable" cellpadding="2" cellspacing="0"> 427 <tr> 428 <td class="mdRow"> 429 <table cellpadding="0" cellspacing="0" border="0"> 430 <tr> 431 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_prev </td> 432 <td class="md" valign="top">( </td> 433 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 434 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 435 <td class="md" valign="top"> ) </td> 436 <td class="md" nowrap></td> 437 </tr> 438 </table> 439 </td> 440 </tr> 441</table> 442<table cellspacing="5" cellpadding="0" border="0"> 443 <tr> 444 <td> 445 446 </td> 447 <td> 448 449<p> 450Moves the iterator backward one metadata block, returning <code>false</code> if already at the beginning.<p> 451<dl compact><dt><b>Parameters:</b></dt><dd> 452 <table border="0" cellspacing="2" cellpadding="0"> 453 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 454 </table> 455</dl> 456<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 457</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 458<dl compact><dt><b>Return values:</b></dt><dd> 459 <table border="0" cellspacing="2" cellpadding="0"> 460 <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> 461 </table> 462</dl> 463 </td> 464 </tr> 465</table> 466<a class="anchor" name="ga9" doxytag="metadata.h::FLAC__metadata_simple_iterator_is_last"></a><p> 467<table class="mdTable" cellpadding="2" cellspacing="0"> 468 <tr> 469 <td class="mdRow"> 470 <table cellpadding="0" cellspacing="0" border="0"> 471 <tr> 472 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_is_last </td> 473 <td class="md" valign="top">( </td> 474 <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 475 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 476 <td class="md" valign="top"> ) </td> 477 <td class="md" nowrap></td> 478 </tr> 479 </table> 480 </td> 481 </tr> 482</table> 483<table cellspacing="5" cellpadding="0" border="0"> 484 <tr> 485 <td> 486 487 </td> 488 <td> 489 490<p> 491Returns a flag telling if the current metadata block is the last.<p> 492<dl compact><dt><b>Parameters:</b></dt><dd> 493 <table border="0" cellspacing="2" cellpadding="0"> 494 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 495 </table> 496</dl> 497<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 498</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 499<dl compact><dt><b>Return values:</b></dt><dd> 500 <table border="0" cellspacing="2" cellpadding="0"> 501 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if the current metadata block is the last in the file, else <code>false</code>. </td></tr> 502 </table> 503</dl> 504 </td> 505 </tr> 506</table> 507<a class="anchor" name="ga10" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block_offset"></a><p> 508<table class="mdTable" cellpadding="2" cellspacing="0"> 509 <tr> 510 <td class="mdRow"> 511 <table cellpadding="0" cellspacing="0" border="0"> 512 <tr> 513 <td class="md" nowrap valign="top">off_t FLAC__metadata_simple_iterator_get_block_offset </td> 514 <td class="md" valign="top">( </td> 515 <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 516 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 517 <td class="md" valign="top"> ) </td> 518 <td class="md" nowrap></td> 519 </tr> 520 </table> 521 </td> 522 </tr> 523</table> 524<table cellspacing="5" cellpadding="0" border="0"> 525 <tr> 526 <td> 527 528 </td> 529 <td> 530 531<p> 532Get the offset of the metadata block at the current position. This avoids reading the actual block data which can save time for large blocks.<p> 533<dl compact><dt><b>Parameters:</b></dt><dd> 534 <table border="0" cellspacing="2" cellpadding="0"> 535 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 536 </table> 537</dl> 538<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 539</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 540<dl compact><dt><b>Return values:</b></dt><dd> 541 <table border="0" cellspacing="2" cellpadding="0"> 542 <tr><td valign="top"></td><td valign="top"><em>off_t</em> </td><td>The offset of the metadata block at the current iterator position. This is the byte offset relative to the beginning of the file of the current metadata block's header. </td></tr> 543 </table> 544</dl> 545 </td> 546 </tr> 547</table> 548<a class="anchor" name="ga11" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block_type"></a><p> 549<table class="mdTable" cellpadding="2" cellspacing="0"> 550 <tr> 551 <td class="mdRow"> 552 <table cellpadding="0" cellspacing="0" border="0"> 553 <tr> 554 <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga113">FLAC__MetadataType</a> FLAC__metadata_simple_iterator_get_block_type </td> 555 <td class="md" valign="top">( </td> 556 <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 557 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 558 <td class="md" valign="top"> ) </td> 559 <td class="md" nowrap></td> 560 </tr> 561 </table> 562 </td> 563 </tr> 564</table> 565<table cellspacing="5" cellpadding="0" border="0"> 566 <tr> 567 <td> 568 569 </td> 570 <td> 571 572<p> 573Get the type of the metadata block at the current position. This avoids reading the actual block data which can save time for large blocks.<p> 574<dl compact><dt><b>Parameters:</b></dt><dd> 575 <table border="0" cellspacing="2" cellpadding="0"> 576 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 577 </table> 578</dl> 579<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 580</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 581<dl compact><dt><b>Return values:</b></dt><dd> 582 <table border="0" cellspacing="2" cellpadding="0"> 583 <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> 584 </table> 585</dl> 586 </td> 587 </tr> 588</table> 589<a class="anchor" name="ga12" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block_length"></a><p> 590<table class="mdTable" cellpadding="2" cellspacing="0"> 591 <tr> 592 <td class="mdRow"> 593 <table cellpadding="0" cellspacing="0" border="0"> 594 <tr> 595 <td class="md" nowrap valign="top">unsigned FLAC__metadata_simple_iterator_get_block_length </td> 596 <td class="md" valign="top">( </td> 597 <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 598 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 599 <td class="md" valign="top"> ) </td> 600 <td class="md" nowrap></td> 601 </tr> 602 </table> 603 </td> 604 </tr> 605</table> 606<table cellspacing="5" cellpadding="0" border="0"> 607 <tr> 608 <td> 609 610 </td> 611 <td> 612 613<p> 614Get the length of the metadata block at the current position. This avoids reading the actual block data which can save time for large blocks.<p> 615<dl compact><dt><b>Parameters:</b></dt><dd> 616 <table border="0" cellspacing="2" cellpadding="0"> 617 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 618 </table> 619</dl> 620<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 621</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 622<dl compact><dt><b>Return values:</b></dt><dd> 623 <table border="0" cellspacing="2" cellpadding="0"> 624 <tr><td valign="top"></td><td valign="top"><em>unsigned</em> </td><td>The length of the metadata block at the current iterator position. The is same length as that in the <a href="http://flac.sourceforge.net/format.html#metadata_block_header">metadata block header</a>, i.e. the length of the metadata body that follows the header. </td></tr> 625 </table> 626</dl> 627 </td> 628 </tr> 629</table> 630<a class="anchor" name="ga13" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_application_id"></a><p> 631<table class="mdTable" cellpadding="2" cellspacing="0"> 632 <tr> 633 <td class="mdRow"> 634 <table cellpadding="0" cellspacing="0" border="0"> 635 <tr> 636 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_get_application_id </td> 637 <td class="md" valign="top">( </td> 638 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 639 <td class="mdname" nowrap> <em>iterator</em>, </td> 640 </tr> 641 <tr> 642 <td class="md" nowrap align="right"></td> 643 <td class="md"></td> 644 <td class="md" nowrap>FLAC__byte * </td> 645 <td class="mdname" nowrap> <em>id</em></td> 646 </tr> 647 <tr> 648 <td class="md"></td> 649 <td class="md">) </td> 650 <td class="md" colspan="2"></td> 651 </tr> 652 </table> 653 </td> 654 </tr> 655</table> 656<table cellspacing="5" cellpadding="0" border="0"> 657 <tr> 658 <td> 659 660 </td> 661 <td> 662 663<p> 664Get the application ID of the <code>APPLICATION</code> block at the current position. This avoids reading the actual block data which can save time for large blocks.<p> 665<dl compact><dt><b>Parameters:</b></dt><dd> 666 <table border="0" cellspacing="2" cellpadding="0"> 667 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 668 <tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>A pointer to a buffer of at least <code>4</code> bytes where the ID will be stored. </td></tr> 669 </table> 670</dl> 671<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 672</pre></div> <div class="fragment"><pre class="fragment"> <span class="keywordtype">id</span> != NULL 673</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 674<dl compact><dt><b>Return values:</b></dt><dd> 675 <table border="0" cellspacing="2" cellpadding="0"> 676 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if the ID was successfully read, else <code>false</code>, in which case you should check <a class="el" href="group__flac__metadata__level1.html#ga4">FLAC__metadata_simple_iterator_status()</a> to find out why. If the status is <code>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT</code>, then the current metadata block is not an <code>APPLICATION</code> block. Otherwise if the status is <code>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR</code> or <code>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR</code>, an I/O error occurred and the iterator can no longer be used. </td></tr> 677 </table> 678</dl> 679 </td> 680 </tr> 681</table> 682<a class="anchor" name="ga14" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block"></a><p> 683<table class="mdTable" cellpadding="2" cellspacing="0"> 684 <tr> 685 <td class="mdRow"> 686 <table cellpadding="0" cellspacing="0" border="0"> 687 <tr> 688 <td class="md" nowrap valign="top"><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a>* FLAC__metadata_simple_iterator_get_block </td> 689 <td class="md" valign="top">( </td> 690 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 691 <td class="mdname1" valign="top" nowrap> <em>iterator</em> </td> 692 <td class="md" valign="top"> ) </td> 693 <td class="md" nowrap></td> 694 </tr> 695 </table> 696 </td> 697 </tr> 698</table> 699<table cellspacing="5" cellpadding="0" border="0"> 700 <tr> 701 <td> 702 703 </td> 704 <td> 705 706<p> 707Get the metadata block at the current position. You can modify the block but must use <a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a> to write it back to the FLAC file.<p> 708You must call <a class="el" href="group__flac__metadata__object.html#ga2">FLAC__metadata_object_delete()</a> on the returned object when you are finished with it.<p> 709<dl compact><dt><b>Parameters:</b></dt><dd> 710 <table border="0" cellspacing="2" cellpadding="0"> 711 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 712 </table> 713</dl> 714<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 715</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 716<dl compact><dt><b>Return values:</b></dt><dd> 717 <table border="0" cellspacing="2" cellpadding="0"> 718 <tr><td valign="top"></td><td valign="top"><em>FLAC__StreamMetadata*</em> </td><td>The current metadata block, or <code>NULL</code> if there was a memory allocation error. </td></tr> 719 </table> 720</dl> 721 </td> 722 </tr> 723</table> 724<a class="anchor" name="ga15" doxytag="metadata.h::FLAC__metadata_simple_iterator_set_block"></a><p> 725<table class="mdTable" cellpadding="2" cellspacing="0"> 726 <tr> 727 <td class="mdRow"> 728 <table cellpadding="0" cellspacing="0" border="0"> 729 <tr> 730 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_set_block </td> 731 <td class="md" valign="top">( </td> 732 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 733 <td class="mdname" nowrap> <em>iterator</em>, </td> 734 </tr> 735 <tr> 736 <td class="md" nowrap align="right"></td> 737 <td class="md"></td> 738 <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td> 739 <td class="mdname" nowrap> <em>block</em>, </td> 740 </tr> 741 <tr> 742 <td class="md" nowrap align="right"></td> 743 <td class="md"></td> 744 <td class="md" nowrap>FLAC__bool </td> 745 <td class="mdname" nowrap> <em>use_padding</em></td> 746 </tr> 747 <tr> 748 <td class="md"></td> 749 <td class="md">) </td> 750 <td class="md" colspan="2"></td> 751 </tr> 752 </table> 753 </td> 754 </tr> 755</table> 756<table cellspacing="5" cellpadding="0" border="0"> 757 <tr> 758 <td> 759 760 </td> 761 <td> 762 763<p> 764Write a block back to the FLAC file. This function tries to be as efficient as possible; how the block is actually written is shown by the following:<p> 765Existing block is a STREAMINFO block and the new block is a STREAMINFO block: the new block is written in place. Make sure you know what you're doing when changing the values of a STREAMINFO block.<p> 766Existing block is a STREAMINFO block and the new block is a not a STREAMINFO block: this is an error since the first block must be a STREAMINFO block. Returns <code>false</code> without altering the file.<p> 767Existing block is not a STREAMINFO block and the new block is a STREAMINFO block: this is an error since there may be only one STREAMINFO block. Returns <code>false</code> without altering the file.<p> 768Existing block and new block are the same length: the existing block will be replaced by the new block, written in place.<p> 769Existing block is longer than new block: if use_padding is <code>true</code>, the existing block will be overwritten in place with the new block followed by a PADDING block, if possible, to make the total size the same as the existing block. Remember that a padding block requires at least four bytes so if the difference in size between the new block and existing block is less than that, the entire file will have to be rewritten, using the new block's exact size. If use_padding is <code>false</code>, the entire file will be rewritten, replacing the existing block by the new block.<p> 770Existing block is shorter than new block: if use_padding is <code>true</code>, the function will try and expand the new block into the following PADDING block, if it exists and doing so won't shrink the PADDING block to less than 4 bytes. If there is no following PADDING block, or it will shrink to less than 4 bytes, or use_padding is <code>false</code>, the entire file is rewritten, replacing the existing block with the new block. Note that in this case any following PADDING block is preserved as is.<p> 771After writing the block, the iterator will remain in the same place, i.e. pointing to the new block.<p> 772<dl compact><dt><b>Parameters:</b></dt><dd> 773 <table border="0" cellspacing="2" cellpadding="0"> 774 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 775 <tr><td valign="top"></td><td valign="top"><em>block</em> </td><td>The block to set. </td></tr> 776 <tr><td valign="top"></td><td valign="top"><em>use_padding</em> </td><td>See above. </td></tr> 777 </table> 778</dl> 779<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 780</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> <div class="fragment"><pre class="fragment"> block != NULL 781</pre></div> </dd></dl> 782<dl compact><dt><b>Return values:</b></dt><dd> 783 <table border="0" cellspacing="2" cellpadding="0"> 784 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if successful, else <code>false</code>. </td></tr> 785 </table> 786</dl> 787 </td> 788 </tr> 789</table> 790<a class="anchor" name="ga16" doxytag="metadata.h::FLAC__metadata_simple_iterator_insert_block_after"></a><p> 791<table class="mdTable" cellpadding="2" cellspacing="0"> 792 <tr> 793 <td class="mdRow"> 794 <table cellpadding="0" cellspacing="0" border="0"> 795 <tr> 796 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_insert_block_after </td> 797 <td class="md" valign="top">( </td> 798 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 799 <td class="mdname" nowrap> <em>iterator</em>, </td> 800 </tr> 801 <tr> 802 <td class="md" nowrap align="right"></td> 803 <td class="md"></td> 804 <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td> 805 <td class="mdname" nowrap> <em>block</em>, </td> 806 </tr> 807 <tr> 808 <td class="md" nowrap align="right"></td> 809 <td class="md"></td> 810 <td class="md" nowrap>FLAC__bool </td> 811 <td class="mdname" nowrap> <em>use_padding</em></td> 812 </tr> 813 <tr> 814 <td class="md"></td> 815 <td class="md">) </td> 816 <td class="md" colspan="2"></td> 817 </tr> 818 </table> 819 </td> 820 </tr> 821</table> 822<table cellspacing="5" cellpadding="0" border="0"> 823 <tr> 824 <td> 825 826 </td> 827 <td> 828 829<p> 830This is similar to <a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a> except that instead of writing over an existing block, it appends a block after the existing block. <em>use_padding</em> is again used to tell the function to try an expand into following padding in an attempt to avoid rewriting the entire file.<p> 831This function will fail and return <code>false</code> if given a STREAMINFO block.<p> 832After writing the block, the iterator will be pointing to the new block.<p> 833<dl compact><dt><b>Parameters:</b></dt><dd> 834 <table border="0" cellspacing="2" cellpadding="0"> 835 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 836 <tr><td valign="top"></td><td valign="top"><em>block</em> </td><td>The block to set. </td></tr> 837 <tr><td valign="top"></td><td valign="top"><em>use_padding</em> </td><td>See above. </td></tr> 838 </table> 839</dl> 840<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 841</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> <div class="fragment"><pre class="fragment"> block != NULL 842</pre></div> </dd></dl> 843<dl compact><dt><b>Return values:</b></dt><dd> 844 <table border="0" cellspacing="2" cellpadding="0"> 845 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if successful, else <code>false</code>. </td></tr> 846 </table> 847</dl> 848 </td> 849 </tr> 850</table> 851<a class="anchor" name="ga17" doxytag="metadata.h::FLAC__metadata_simple_iterator_delete_block"></a><p> 852<table class="mdTable" cellpadding="2" cellspacing="0"> 853 <tr> 854 <td class="mdRow"> 855 <table cellpadding="0" cellspacing="0" border="0"> 856 <tr> 857 <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_delete_block </td> 858 <td class="md" valign="top">( </td> 859 <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td> 860 <td class="mdname" nowrap> <em>iterator</em>, </td> 861 </tr> 862 <tr> 863 <td class="md" nowrap align="right"></td> 864 <td class="md"></td> 865 <td class="md" nowrap>FLAC__bool </td> 866 <td class="mdname" nowrap> <em>use_padding</em></td> 867 </tr> 868 <tr> 869 <td class="md"></td> 870 <td class="md">) </td> 871 <td class="md" colspan="2"></td> 872 </tr> 873 </table> 874 </td> 875 </tr> 876</table> 877<table cellspacing="5" cellpadding="0" border="0"> 878 <tr> 879 <td> 880 881 </td> 882 <td> 883 884<p> 885Deletes the block at the current position. This will cause the entire FLAC file to be rewritten, unless <em>use_padding</em> is <code>true</code>, in which case the block will be replaced by an equal-sized PADDING block. The iterator will be left pointing to the block before the one just deleted.<p> 886You may not delete the STREAMINFO block.<p> 887<dl compact><dt><b>Parameters:</b></dt><dd> 888 <table border="0" cellspacing="2" cellpadding="0"> 889 <tr><td valign="top"></td><td valign="top"><em>iterator</em> </td><td>A pointer to an existing initialized iterator. </td></tr> 890 <tr><td valign="top"></td><td valign="top"><em>use_padding</em> </td><td>See above. </td></tr> 891 </table> 892</dl> 893<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 894</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl> 895<dl compact><dt><b>Return values:</b></dt><dd> 896 <table border="0" cellspacing="2" cellpadding="0"> 897 <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em> </td><td><code>true</code> if successful, else <code>false</code>. </td></tr> 898 </table> 899</dl> 900 </td> 901 </tr> 902</table> 903<hr><h2>Variable Documentation</h2> 904<a class="anchor" name="ga1" doxytag="metadata.h::FLAC__Metadata_SimpleIteratorStatusString"></a><p> 905<table class="mdTable" cellpadding="2" cellspacing="0"> 906 <tr> 907 <td class="mdRow"> 908 <table cellpadding="0" cellspacing="0" border="0"> 909 <tr> 910 <td class="md" nowrap valign="top">const char* const <a class="el" href="group__flac__metadata__level1.html#ga1">FLAC__Metadata_SimpleIteratorStatusString</a>[] </td> 911 </tr> 912 </table> 913 </td> 914 </tr> 915</table> 916<table cellspacing="5" cellpadding="0" border="0"> 917 <tr> 918 <td> 919 920 </td> 921 <td> 922 923<p> 924Maps a FLAC__Metadata_SimpleIteratorStatus to a C string.<p> 925Using a FLAC__Metadata_SimpleIteratorStatus as the index to this array will give the string equivalent. The contents should not be modified. </td> 926 </tr> 927</table> 928 929<hr size="1"> 930<div class="copyright"> 931 <!-- @@@ oh so hacky --> 932 <table> 933 <tr> 934 <td align="left"> 935 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson 936 </td> 937 <td width="1%" align="right"> 938 <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> 939 </td> 940 </tr> 941 </table> 942</div> 943<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson --> 944<!-- Permission is granted to copy, distribute and/or modify this document --> 945<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> 946<!-- or any later version published by the Free Software Foundation; --> 947<!-- with no invariant sections. --> 948<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> 949</body> 950</html> 951