~ubuntu-branches/ubuntu/hoary/flac/hoary

<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">Compound List</a>   <a class="qindex" href="files.html">File List</a>   <a class="qindex" href="functions.html">Compound Members</a>   <a class="qindex" href="globals.html">File Members</a>   </center>

<hr><h1>FLAC/metadata.h: metadata level 2 interface<br>

<small>

[<a class="el" href="group__flac__metadata.html">FLAC/metadata.h: metadata interfaces</a>]</small>

</h1>The 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.

<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>

<tr><td nowrap align=right valign=top>typedef FLAC__Metadata_Chain </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a></td></tr>

<tr><td nowrap align=right valign=top>typedef FLAC__Metadata_Iterator </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a></td></tr>

<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>

<tr><td nowrap align=right valign=top>enum  </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a21">FLAC__Metadata_ChainStatus</a> { <br>

  <a class="el" href="group__flac__metadata__level2.html#a21a18">FLAC__METADATA_CHAIN_STATUS_OK</a> = 0,

<a class="el" href="group__flac__metadata__level2.html#a21a19">FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a20">FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a21">FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE</a>,

<br>

  <a class="el" href="group__flac__metadata__level2.html#a21a22">FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a23">FLAC__METADATA_CHAIN_STATUS_BAD_METADATA</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a24">FLAC__METADATA_CHAIN_STATUS_READ_ERROR</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a25">FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR</a>,

<br>

  <a class="el" href="group__flac__metadata__level2.html#a21a26">FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a27">FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a28">FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR</a>,

<a class="el" href="group__flac__metadata__level2.html#a21a29">FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR</a>,

<br>

  <a class="el" href="group__flac__metadata__level2.html#a21a30">FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR</a>

<br>

}</td></tr>

<tr><td colspan=2><br><h2>Functions</h2></td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a3">FLAC__metadata_chain_new</a> ()</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a4">FLAC__metadata_chain_delete</a> (<a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> *chain)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__metadata__level2.html#a21">FLAC__Metadata_ChainStatus</a> </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a5">FLAC__metadata_chain_status</a> (<a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> *chain)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a6">FLAC__metadata_chain_read</a> (<a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> *chain, const char *filename)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a7">FLAC__metadata_chain_write</a> (<a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> *chain, FLAC__bool use_padding, FLAC__bool preserve_file_stats)</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a8">FLAC__metadata_chain_merge_padding</a> (<a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> *chain)</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a9">FLAC__metadata_chain_sort_padding</a> (<a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> *chain)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a10">FLAC__metadata_iterator_new</a> ()</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a11">FLAC__metadata_iterator_delete</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> *chain)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a13">FLAC__metadata_iterator_next</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a14">FLAC__metadata_iterator_prev</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__format.html#a93">FLAC__MetadataType</a> </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a15">FLAC__metadata_iterator_get_block_type</a> (const <a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a16">FLAC__metadata_iterator_get_block</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a17">FLAC__metadata_iterator_set_block</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a18">FLAC__metadata_iterator_delete_block</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator, FLAC__bool replace_with_padding)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a19">FLAC__metadata_iterator_insert_block_before</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a20">FLAC__metadata_iterator_insert_block_after</a> (<a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block)</td></tr>

<tr><td colspan=2><br><h2>Variables</h2></td></tr>

<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="group__flac__metadata__level2.html#a2">FLAC__Metadata_ChainStatusString</a> []</td></tr>

</table>

<hr><a name="_details"></a><h2>Detailed Description</h2>

The 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.

<p>

The general usage of this interface is:

<p>

<ul>

<li>Create a new chain using <a class="el" href="group__flac__metadata__level2.html#a3">FLAC__metadata_chain_new</a>(). A chain is a linked list of FLAC metadata blocks.<li>Read all metadata into the the chain from a FLAC file using <a class="el" href="group__flac__metadata__level2.html#a6">FLAC__metadata_chain_read</a>() and check the status.<li>Optionally, consolidate the padding using <a class="el" href="group__flac__metadata__level2.html#a8">FLAC__metadata_chain_merge_padding</a>() or <a class="el" href="group__flac__metadata__level2.html#a9">FLAC__metadata_chain_sort_padding</a>().<li>Create a new iterator using <a class="el" href="group__flac__metadata__level2.html#a10">FLAC__metadata_iterator_new</a>()<li>Initialize the iterator to point to the first element in the chain using <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>()<li>Traverse the chain using FLAC__metadata_iterator_next and <a class="el" href="group__flac__metadata__level2.html#a14">FLAC__metadata_iterator_prev</a>().<li>Get a block for reading or modification using <a class="el" href="group__flac__metadata__level2.html#a16">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>When done, write out the chain using <a class="el" href="group__flac__metadata__level2.html#a7">FLAC__metadata_chain_write</a>(). Make sure to read the whole comment to the function below.<li>Delete the chain using <a class="el" href="group__flac__metadata__level2.html#a4">FLAC__metadata_chain_delete</a>().</ul>

Note: </b><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#a6">FLAC__metadata_chain_read</a>() and <a class="el" href="group__flac__metadata__level2.html#a7">FLAC__metadata_chain_write</a>().</dl><dl compact><dt><b>

Note: </b><dd>

Do not modify the is_last, length, or type fields of returned FLAC__MetadataType objects. These are managed automatically.</dl><dl compact><dt><b>

Note: </b><dd>

The metadata objects returned by <a class="el" href="group__flac__metadata__level2.html#a16">FLAC__metadata_iterator_get_block</a>() are owned by the chain; do not <a class="el" href="group__flac__metadata__object.html#a2">FLAC__metadata_object_delete</a>() them. In the same way, blocks passed to <a class="el" href="group__flac__metadata__level2.html#a17">FLAC__metadata_iterator_set_block</a>() become owned by the chain and they will be deleted when the chain is deleted. </dl><hr><h2>Typedef Documentation</h2>

<tr>

<tr>

<td class="md" nowrap valign="top"> typedef struct FLAC__Metadata_Chain FLAC__Metadata_Chain

</table>

</td>

</tr>

</table>

<tr>

<td>

</td>

<td>

<p>

The opaque structure definition for the level 2 chain type. </td>

</tr>

</table>

<tr>

100

101

102

<tr>

103

<td class="md" nowrap valign="top"> typedef struct FLAC__Metadata_Iterator FLAC__Metadata_Iterator

104

</table>

105

</td>

106

</tr>

107

</table>

108

109

<tr>

110

<td>

111

112

</td>

113

<td>

114

115

<p>

116

The opaque structure definition for the level 2 iterator type. </td>

117

</tr>

118

</table>

119

<hr><h2>Enumeration Type Documentation</h2>

120

121

122

<tr>

123

124

125

<tr>

126

<td class="md" nowrap valign="top"> enum FLAC__Metadata_ChainStatus

127

</table>

128

</td>

129

</tr>

130

</table>

131

132

<tr>

133

<td>

134

135

</td>

136

<td>

137

138

<p>

139

140

Enumeration values:</b><dd>

141

142

<tr><td valign=top><em><a name="a21a18" doxytag="FLAC__METADATA_CHAIN_STATUS_OK"></a><em>FLAC__METADATA_CHAIN_STATUS_OK</em></em> </td><td>

143

The chain is in the normal OK state </td></tr>

144

<tr><td valign=top><em><a name="a21a19" doxytag="FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT"></a><em>FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT</em></em> </td><td>

145

The data passed into a function violated the function's usage criteria </td></tr>

146

<tr><td valign=top><em><a name="a21a20" doxytag="FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE"></a><em>FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE</em></em> </td><td>

147

The chain could not open the target file </td></tr>

148

<tr><td valign=top><em><a name="a21a21" doxytag="FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE"></a><em>FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE</em></em> </td><td>

149

The chain could not find the FLAC signature at the start of the file </td></tr>

150

<tr><td valign=top><em><a name="a21a22" doxytag="FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE"></a><em>FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE</em></em> </td><td>

151

The chain tried to write to a file that was not writable </td></tr>

152

<tr><td valign=top><em><a name="a21a23" doxytag="FLAC__METADATA_CHAIN_STATUS_BAD_METADATA"></a><em>FLAC__METADATA_CHAIN_STATUS_BAD_METADATA</em></em> </td><td>

153

The chain encountered input that does not conform to the FLAC metadata specification </td></tr>

154

<tr><td valign=top><em><a name="a21a24" doxytag="FLAC__METADATA_CHAIN_STATUS_READ_ERROR"></a><em>FLAC__METADATA_CHAIN_STATUS_READ_ERROR</em></em> </td><td>

155

The chain encountered an error while reading the FLAC file </td></tr>

156

<tr><td valign=top><em><a name="a21a25" doxytag="FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR"></a><em>FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR</em></em> </td><td>

157

The chain encountered an error while seeking in the FLAC file </td></tr>

158

<tr><td valign=top><em><a name="a21a26" doxytag="FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR"></a><em>FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR</em></em> </td><td>

159

The chain encountered an error while writing the FLAC file </td></tr>

160

<tr><td valign=top><em><a name="a21a27" doxytag="FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR"></a><em>FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR</em></em> </td><td>

161

The chain encountered an error renaming the FLAC file </td></tr>

162

<tr><td valign=top><em><a name="a21a28" doxytag="FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR"></a><em>FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR</em></em> </td><td>

163

The chain encountered an error removing the temporary file </td></tr>

164

<tr><td valign=top><em><a name="a21a29" doxytag="FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR"></a><em>FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR</em></em> </td><td>

165

Memory allocation failed </td></tr>

166

<tr><td valign=top><em><a name="a21a30" doxytag="FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR"></a><em>FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR</em></em> </td><td>

167

The caller violated an assertion or an unexpected error occurred </td></tr>

168

</table>

169

</dl>

170

</td>

171

</tr>

172

</table>

173

<hr><h2>Function Documentation</h2>

174

175

176

<tr>

177

178

179

<tr>

180

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a>* FLAC__metadata_chain_new </td>

181

182

183

184

185

</tr>

186

187

</table>

188

</td>

189

</tr>

190

</table>

191

192

<tr>

193

<td>

194

195

</td>

196

<td>

197

198

<p>

199

Create a new chain instance.<dl compact><dt><b>

200

Return values: </b><dd>

201

202

<tr><td valign=top><em>FLAC__Metadata_Chain</em> </td><td>

203

* <code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>

204

</table>

205

</dl> </td>

206

</tr>

207

</table>

208

209

210

<tr>

211

212

213

<tr>

214

<td class="md" nowrap valign="top"> void FLAC__metadata_chain_delete </td>

215

216

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td>

217

<td class="mdname1" valign="top" nowrap>  <em>chain</em> </td>

218

219

220

</tr>

221

222

</table>

223

</td>

224

</tr>

225

</table>

226

227

<tr>

228

<td>

229

230

</td>

231

<td>

232

233

<p>

234

Free a chain instance. Deletes the object pointed to by <em>chain</em>.<dl compact><dt><b>

235

Parameters: </b><dd>

236

237

<tr><td valign=top><em>chain</em> </td><td>

238

A pointer to an existing chain. </td></tr>

239

</table>

240

</dl><dl compact><dt><b>

241

Assertions:</b><dd>

242

<div class="fragment"><pre>chain != NULL

243

</pre></div> </dl> </td>

244

</tr>

245

</table>

246

247

248

<tr>

249

250

251

<tr>

252

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__metadata__level2.html#a21">FLAC__Metadata_ChainStatus</a> FLAC__metadata_chain_status </td>

253

254

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td>

255

<td class="mdname1" valign="top" nowrap>  <em>chain</em> </td>

256

257

258

</tr>

259

260

</table>

261

</td>

262

</tr>

263

</table>

264

265

<tr>

266

<td>

267

268

</td>

269

<td>

270

271

<p>

272

Get 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.<dl compact><dt><b>

273

Parameters: </b><dd>

274

275

<tr><td valign=top><em>chain</em> </td><td>

276

A pointer to an existing chain. </td></tr>

277

</table>

278

</dl><dl compact><dt><b>

279

Assertions:</b><dd>

280

<div class="fragment"><pre>chain != NULL

281

</pre></div> </dl><dl compact><dt><b>

282

Return values: </b><dd>

283

284

<tr><td valign=top><em>FLAC__Metadata_ChainStatus</em> </td><td>

285

The current status of the chain. </td></tr>

286

</table>

287

</dl> </td>

288

</tr>

289

</table>

290

291

292

<tr>

293

294

295

<tr>

296

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_chain_read </td>

297

298

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td>

299

<td class="mdname" nowrap>  <em>chain</em>, </td>

300

</tr>

301

<tr>

302

303

304

<td class="md" nowrap>const char * </td>

305

<td class="mdname" nowrap>  <em>filename</em></td>

306

</tr>

307

<tr>

308

309

310

311

</tr>

312

313

</table>

314

</td>

315

</tr>

316

</table>

317

318

<tr>

319

<td>

320

321

</td>

322

<td>

323

324

<p>

325

Read all metadata from a FLAC file into the chain.<dl compact><dt><b>

326

Parameters: </b><dd>

327

328

<tr><td valign=top><em>chain</em> </td><td>

329

A pointer to an existing chain. </td></tr>

330

<tr><td valign=top><em>filename</em> </td><td>

331

The path to the FLAC file to read. </td></tr>

332

</table>

333

</dl><dl compact><dt><b>

334

Assertions:</b><dd>

335

<div class="fragment"><pre>chain != NULL

336

</pre></div> <div class="fragment"><pre>filename != NULL

337

</pre></div> </dl><dl compact><dt><b>

338

Return values: </b><dd>

339

340

341

<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#a5">FLAC__metadata_chain_status</a>(). </td></tr>

342

</table>

343

</dl> </td>

344

</tr>

345

</table>

346

347

348

<tr>

349

350

351

<tr>

352

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_chain_write </td>

353

354

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td>

355

<td class="mdname" nowrap>  <em>chain</em>, </td>

356

</tr>

357

<tr>

358

359

360

361

<td class="mdname" nowrap>  <em>use_padding</em>, </td>

362

</tr>

363

<tr>

364

365

366

367

<td class="mdname" nowrap>  <em>preserve_file_stats</em></td>

368

</tr>

369

<tr>

370

371

372

373

</tr>

374

375

</table>

376

</td>

377

</tr>

378

</table>

379

380

<tr>

381

<td>

382

383

</td>

384

<td>

385

386

<p>

387

Write 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:

388

<p>

389

If the current chain is the same size as the existing metadata, the new data is written in place.

390

<p>

391

If 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#a9">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.

392

<p>

393

If 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#a11">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.

394

<p>

395

If <em>preserve_file_stats</em> is <code>true</code>, the owner and modification time will be preserved even if the FLAC file is written.<dl compact><dt><b>

396

Parameters: </b><dd>

397

398

<tr><td valign=top><em>chain</em> </td><td>

399

A pointer to an existing chain. </td></tr>

400

<tr><td valign=top><em>use_padding</em> </td><td>

401

See above. </td></tr>

402

<tr><td valign=top><em>preserve_file_stats</em> </td><td>

403

See above. </td></tr>

404

</table>

405

</dl><dl compact><dt><b>

406

Assertions:</b><dd>

407

<div class="fragment"><pre>chain != NULL

408

</pre></div> </dl><dl compact><dt><b>

409

Return values: </b><dd>

410

411

412

<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#a5">FLAC__metadata_chain_status</a>(). </td></tr>

413

</table>

414

</dl> </td>

415

</tr>

416

</table>

417

418

419

<tr>

420

421

422

<tr>

423

<td class="md" nowrap valign="top"> void FLAC__metadata_chain_merge_padding </td>

424

425

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td>

426

<td class="mdname1" valign="top" nowrap>  <em>chain</em> </td>

427

428

429

</tr>

430

431

</table>

432

</td>

433

</tr>

434

</table>

435

436

<tr>

437

<td>

438

439

</td>

440

<td>

441

442

<p>

443

Merge adjacent PADDING blocks into a single block.

444

<p>

445

446

Note: </b><dd>

447

This function does not write to the FLAC file, it only modifies the chain.</dl><dl compact><dt><b>

448

Warning: </b><dd>

449

Any iterator on the current chain will become invalid after this call. You should delete the iterator and get a new one.</dl><dl compact><dt><b>

450

Parameters: </b><dd>

451

452

<tr><td valign=top><em>chain</em> </td><td>

453

A pointer to an existing chain. </td></tr>

454

</table>

455

</dl><dl compact><dt><b>

456

Assertions:</b><dd>

457

<div class="fragment"><pre>chain != NULL

458

</pre></div> </dl> </td>

459

</tr>

460

</table>

461

462

463

<tr>

464

465

466

<tr>

467

<td class="md" nowrap valign="top"> void FLAC__metadata_chain_sort_padding </td>

468

469

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td>

470

<td class="mdname1" valign="top" nowrap>  <em>chain</em> </td>

471

472

473

</tr>

474

475

</table>

476

</td>

477

</tr>

478

</table>

479

480

<tr>

481

<td>

482

483

</td>

484

<td>

485

486

<p>

487

This function will move all PADDING blocks to the end on the metadata, then merge them into a single block.

488

<p>

489

490

Note: </b><dd>

491

This function does not write to the FLAC file, it only modifies the chain.</dl><dl compact><dt><b>

492

Warning: </b><dd>

493

Any iterator on the current chain will become invalid after this call. You should delete the iterator and get a new one.</dl><dl compact><dt><b>

494

Parameters: </b><dd>

495

496

<tr><td valign=top><em>chain</em> </td><td>

497

A pointer to an existing chain. </td></tr>

498

</table>

499

</dl><dl compact><dt><b>

500

Assertions:</b><dd>

501

<div class="fragment"><pre>chain != NULL

502

</pre></div> </dl> </td>

503

</tr>

504

</table>

505

506

507

<tr>

508

509

510

<tr>

511

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a>* FLAC__metadata_iterator_new </td>

512

513

514

515

516

</tr>

517

518

</table>

519

</td>

520

</tr>

521

</table>

522

523

<tr>

524

<td>

525

526

</td>

527

<td>

528

529

<p>

530

Create a new iterator instance.<dl compact><dt><b>

531

Return values: </b><dd>

532

533

<tr><td valign=top><em>FLAC__Metadata_Iterator</em> </td><td>

534

* <code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>

535

</table>

536

</dl> </td>

537

</tr>

538

</table>

539

540

541

<tr>

542

543

544

<tr>

545

<td class="md" nowrap valign="top"> void FLAC__metadata_iterator_delete </td>

546

547

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

548

<td class="mdname1" valign="top" nowrap>  <em>iterator</em> </td>

549

550

551

</tr>

552

553

</table>

554

</td>

555

</tr>

556

</table>

557

558

<tr>

559

<td>

560

561

</td>

562

<td>

563

564

<p>

565

Free an iterator instance. Deletes the object pointed to by <em>iterator</em>.<dl compact><dt><b>

566

Parameters: </b><dd>

567

568

<tr><td valign=top><em>iterator</em> </td><td>

569

A pointer to an existing iterator. </td></tr>

570

</table>

571

</dl><dl compact><dt><b>

572

Assertions:</b><dd>

573

<div class="fragment"><pre>iterator != NULL

574

</pre></div> </dl> </td>

575

</tr>

576

</table>

577

578

579

<tr>

580

581

582

<tr>

583

<td class="md" nowrap valign="top"> void FLAC__metadata_iterator_init </td>

584

585

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

586

<td class="mdname" nowrap>  <em>iterator</em>, </td>

587

</tr>

588

<tr>

589

590

591

<td class="md" nowrap><a class="el" href="group__flac__metadata__level2.html#a0">FLAC__Metadata_Chain</a> * </td>

592

<td class="mdname" nowrap>  <em>chain</em></td>

593

</tr>

594

<tr>

595

596

597

598

</tr>

599

600

</table>

601

</td>

602

</tr>

603

</table>

604

605

<tr>

606

<td>

607

608

</td>

609

<td>

610

611

<p>

612

Initialize the iterator to point to the first metadata block in the given chain.<dl compact><dt><b>

613

Parameters: </b><dd>

614

615

<tr><td valign=top><em>iterator</em> </td><td>

616

A pointer to an existing iterator. </td></tr>

617

<tr><td valign=top><em>chain</em> </td><td>

618

A pointer to an existing and initialized (read) chain. </td></tr>

619

</table>

620

</dl><dl compact><dt><b>

621

Assertions:</b><dd>

622

<div class="fragment"><pre>iterator != NULL

623

</pre></div> <div class="fragment"><pre>chain != NULL

624

</pre></div> </dl> </td>

625

</tr>

626

</table>

627

628

629

<tr>

630

631

632

<tr>

633

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_iterator_next </td>

634

635

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

636

<td class="mdname1" valign="top" nowrap>  <em>iterator</em> </td>

637

638

639

</tr>

640

641

</table>

642

</td>

643

</tr>

644

</table>

645

646

<tr>

647

<td>

648

649

</td>

650

<td>

651

652

<p>

653

Moves the iterator forward one metadata block, returning <code>false</code> if already at the end.<dl compact><dt><b>

654

Parameters: </b><dd>

655

656

<tr><td valign=top><em>iterator</em> </td><td>

657

A pointer to an existing initialized iterator. </td></tr>

658

</table>

659

</dl><dl compact><dt><b>

660

Assertions:</b><dd>

661

<div class="fragment"><pre>iterator != NULL

662

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() </dl><dl compact><dt><b>

663

Return values: </b><dd>

664

665

666

<code>false</code> if already at the last metadata block of the chain, else <code>true</code>. </td></tr>

667

</table>

668

</dl> </td>

669

</tr>

670

</table>

671

672

673

<tr>

674

675

676

<tr>

677

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_iterator_prev </td>

678

679

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

680

<td class="mdname1" valign="top" nowrap>  <em>iterator</em> </td>

681

682

683

</tr>

684

685

</table>

686

</td>

687

</tr>

688

</table>

689

690

<tr>

691

<td>

692

693

</td>

694

<td>

695

696

<p>

697

Moves the iterator backward one metadata block, returning <code>false</code> if already at the beginning.<dl compact><dt><b>

698

Parameters: </b><dd>

699

700

<tr><td valign=top><em>iterator</em> </td><td>

701

A pointer to an existing initialized iterator. </td></tr>

702

</table>

703

</dl><dl compact><dt><b>

704

Assertions:</b><dd>

705

<div class="fragment"><pre>iterator != NULL

706

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() </dl><dl compact><dt><b>

707

Return values: </b><dd>

708

709

710

<code>false</code> if already at the first metadata block of the chain, else <code>true</code>. </td></tr>

711

</table>

712

</dl> </td>

713

</tr>

714

</table>

715

716

717

<tr>

718

719

720

<tr>

721

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__format.html#a93">FLAC__MetadataType</a> FLAC__metadata_iterator_get_block_type </td>

722

723

<td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

724

<td class="mdname1" valign="top" nowrap>  <em>iterator</em> </td>

725

726

727

</tr>

728

729

</table>

730

</td>

731

</tr>

732

</table>

733

734

<tr>

735

<td>

736

737

</td>

738

<td>

739

740

<p>

741

Get the type of the metadata block at the current position.<dl compact><dt><b>

742

Parameters: </b><dd>

743

744

<tr><td valign=top><em>iterator</em> </td><td>

745

A pointer to an existing initialized iterator. </td></tr>

746

</table>

747

</dl><dl compact><dt><b>

748

Assertions:</b><dd>

749

<div class="fragment"><pre>iterator != NULL

750

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() </dl><dl compact><dt><b>

751

Return values: </b><dd>

752

753

<tr><td valign=top><em>FLAC__MetadataType</em> </td><td>

754

The type of the metadata block at the current iterator position. </td></tr>

755

</table>

756

</dl> </td>

757

</tr>

758

</table>

759

760

761

<tr>

762

763

764

<tr>

765

<td class="md" nowrap valign="top"> <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a>* FLAC__metadata_iterator_get_block </td>

766

767

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

768

<td class="mdname1" valign="top" nowrap>  <em>iterator</em> </td>

769

770

771

</tr>

772

773

</table>

774

</td>

775

</tr>

776

</table>

777

778

<tr>

779

<td>

780

781

</td>

782

<td>

783

784

<p>

785

Get 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#a17">FLAC__metadata_iterator_set_block</a>() to reflect the changes; the pointer returned by <a class="el" href="group__flac__metadata__level2.html#a16">FLAC__metadata_iterator_get_block</a>() points directly into the chain.

786

<p>

787

788

Warning: </b><dd>

789

Do not call <a class="el" href="group__flac__metadata__object.html#a2">FLAC__metadata_object_delete</a>() on the returned object; to delete a block use <a class="el" href="group__flac__metadata__level2.html#a18">FLAC__metadata_iterator_delete_block</a>().</dl><dl compact><dt><b>

790

Parameters: </b><dd>

791

792

<tr><td valign=top><em>iterator</em> </td><td>

793

A pointer to an existing initialized iterator. </td></tr>

794

</table>

795

</dl><dl compact><dt><b>

796

Assertions:</b><dd>

797

<div class="fragment"><pre>iterator != NULL

798

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() </dl><dl compact><dt><b>

799

Return values: </b><dd>

800

801

<tr><td valign=top><em><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a></em> </td><td>

802

* The current metadata block. </td></tr>

803

</table>

804

</dl> </td>

805

</tr>

806

</table>

807

808

809

<tr>

810

811

812

<tr>

813

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_iterator_set_block </td>

814

815

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

816

<td class="mdname" nowrap>  <em>iterator</em>, </td>

817

</tr>

818

<tr>

819

820

821

<td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td>

822

<td class="mdname" nowrap>  <em>block</em></td>

823

</tr>

824

<tr>

825

826

827

828

</tr>

829

830

</table>

831

</td>

832

</tr>

833

</table>

834

835

<tr>

836

<td>

837

838

</td>

839

<td>

840

841

<p>

842

Set 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.<dl compact><dt><b>

843

Parameters: </b><dd>

844

845

<tr><td valign=top><em>iterator</em> </td><td>

846

A pointer to an existing initialized iterator. </td></tr>

847

<tr><td valign=top><em>block</em> </td><td>

848

A pointer to a metadata block. </td></tr>

849

</table>

850

</dl><dl compact><dt><b>

851

Assertions:</b><dd>

852

<div class="fragment"><pre>iterator != NULL

853

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() <div class="fragment"><pre>block != NULL

854

</pre></div> </dl><dl compact><dt><b>

855

Return values: </b><dd>

856

857

858

<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>

859

</table>

860

</dl> </td>

861

</tr>

862

</table>

863

864

865

<tr>

866

867

868

<tr>

869

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_iterator_delete_block </td>

870

871

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

872

<td class="mdname" nowrap>  <em>iterator</em>, </td>

873

</tr>

874

<tr>

875

876

877

878

<td class="mdname" nowrap>  <em>replace_with_padding</em></td>

879

</tr>

880

<tr>

881

882

883

884

</tr>

885

886

</table>

887

</td>

888

</tr>

889

</table>

890

891

<tr>

892

<td>

893

894

</td>

895

<td>

896

897

<p>

898

Removes 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>.<dl compact><dt><b>

899

Parameters: </b><dd>

900

901

<tr><td valign=top><em>iterator</em> </td><td>

902

A pointer to an existing initialized iterator. </td></tr>

903

<tr><td valign=top><em>replace_with_padding</em> </td><td>

904

See above. </td></tr>

905

</table>

906

</dl><dl compact><dt><b>

907

Assertions:</b><dd>

908

<div class="fragment"><pre>iterator != NULL

909

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() </dl><dl compact><dt><b>

910

Return values: </b><dd>

911

912

913

<code>false</code> if the conditions in the above description are not met, otherwise <code>true</code>. </td></tr>

914

</table>

915

</dl> </td>

916

</tr>

917

</table>

918

919

920

<tr>

921

922

923

<tr>

924

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_iterator_insert_block_before </td>

925

926

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

927

<td class="mdname" nowrap>  <em>iterator</em>, </td>

928

</tr>

929

<tr>

930

931

932

<td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td>

933

<td class="mdname" nowrap>  <em>block</em></td>

934

</tr>

935

<tr>

936

937

938

939

</tr>

940

941

</table>

942

</td>

943

</tr>

944

</table>

945

946

<tr>

947

<td>

948

949

</td>

950

<td>

951

952

<p>

953

Insert 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.<dl compact><dt><b>

954

Parameters: </b><dd>

955

956

<tr><td valign=top><em>iterator</em> </td><td>

957

A pointer to an existing initialized iterator. </td></tr>

958

<tr><td valign=top><em>block</em> </td><td>

959

A pointer to a metadata block to insert. </td></tr>

960

</table>

961

</dl><dl compact><dt><b>

962

Assertions:</b><dd>

963

<div class="fragment"><pre>iterator != NULL

964

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() </dl><dl compact><dt><b>

965

Return values: </b><dd>

966

967

968

<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>

969

</table>

970

</dl> </td>

971

</tr>

972

</table>

973

974

975

<tr>

976

977

978

<tr>

979

<td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_iterator_insert_block_after </td>

980

981

<td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level2.html#a1">FLAC__Metadata_Iterator</a> * </td>

982

<td class="mdname" nowrap>  <em>iterator</em>, </td>

983

</tr>

984

<tr>

985

986

987

<td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td>

988

<td class="mdname" nowrap>  <em>block</em></td>

989

</tr>

990

<tr>

991

992

993

994

</tr>

995

996

</table>

997

</td>

998

</tr>

999

</table>

1000

1001

<tr>

1002

<td>

1003

1004

</td>

1005

<td>

1006

1007

<p>

1008

Insert 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.<dl compact><dt><b>

1009

Parameters: </b><dd>

1010

1011

<tr><td valign=top><em>iterator</em> </td><td>

1012

A pointer to an existing initialized iterator. </td></tr>

1013

<tr><td valign=top><em>block</em> </td><td>

1014

A pointer to a metadata block to insert. </td></tr>

1015

</table>

1016

</dl><dl compact><dt><b>

1017

Assertions:</b><dd>

1018

<div class="fragment"><pre>iterator != NULL

1019

</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level2.html#a12">FLAC__metadata_iterator_init</a>() </dl><dl compact><dt><b>

1020

Return values: </b><dd>

1021

1022

1023

<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>

1024

</table>

1025

</dl> </td>

1026

</tr>

1027

</table>

1028

<hr><h2>Variable Documentation</h2>

1029

1030

1031

<tr>

1032

1033

1034

<tr>

1035

<td class="md" nowrap valign="top"> const char* const FLAC__Metadata_ChainStatusString[]

1036

</table>

1037

</td>

1038

</tr>

1039

</table>

1040

1041

<tr>

1042

<td>

1043

1044

</td>

1045

<td>

1046

1047

<p>

1048

Maps a FLAC__Metadata_ChainStatus to a C string.

1049

<p>

1050

Using a FLAC__Metadata_ChainStatus as the index to this array will give the string equivalent. The contents should not be modified. </td>

1051

</tr>

1052

</table>

1053

<hr><address><small>Generated on Sat Jan 25 10:44:54 2003 for FLAC by

1054

1055

<img src="doxygen.gif" alt="doxygen" align="middle" border=0

1056

width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,

1057

1058

</body>

1059

</html>

Older »