~ubuntu-branches/ubuntu/gutsy/flac/gutsy-updates

<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/seekable_stream_encoder.h: seekable stream encoder interface<br>

<small>

[<a class="el" href="group__flac__encoder.html">FLAC/_encoder.h: encoder interfaces</a>]</small>

</h1>This module contains the functions which implement the seekable stream encoder.

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

<tr><td nowrap align=right valign=top>struct  </td><td valign=bottom><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a></td></tr>

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

<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__seekable__stream__encoder.html#a54">FLAC__SeekableStreamEncoderSeekStatus</a>(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a2">FLAC__SeekableStreamEncoderSeekCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__stream__encoder.html#a53">FLAC__StreamEncoderWriteStatus</a>(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a3">FLAC__SeekableStreamEncoderWriteCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data)</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__seekable__stream__encoder.html#a53">FLAC__SeekableStreamEncoderState</a> { <br>

  <a class="el" href="group__flac__seekable__stream__encoder.html#a53a4">FLAC__SEEKABLE_STREAM_ENCODER_OK</a> = 0,

<a class="el" href="group__flac__seekable__stream__encoder.html#a53a5">FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</a>,

<a class="el" href="group__flac__seekable__stream__encoder.html#a53a6">FLAC__SEEKABLE_STREAM_ENCODER_MEMORY_ALLOCATION_ERROR</a>,

<a class="el" href="group__flac__seekable__stream__encoder.html#a53a7">FLAC__SEEKABLE_STREAM_ENCODER_WRITE_ERROR</a>,

<br>

  <a class="el" href="group__flac__seekable__stream__encoder.html#a53a8">FLAC__SEEKABLE_STREAM_ENCODER_READ_ERROR</a>,

<a class="el" href="group__flac__seekable__stream__encoder.html#a53a9">FLAC__SEEKABLE_STREAM_ENCODER_SEEK_ERROR</a>,

<a class="el" href="group__flac__seekable__stream__encoder.html#a53a10">FLAC__SEEKABLE_STREAM_ENCODER_ALREADY_INITIALIZED</a>,

<a class="el" href="group__flac__seekable__stream__encoder.html#a53a11">FLAC__SEEKABLE_STREAM_ENCODER_INVALID_CALLBACK</a>,

<br>

  <a class="el" href="group__flac__seekable__stream__encoder.html#a53a12">FLAC__SEEKABLE_STREAM_ENCODER_INVALID_SEEKTABLE</a>,

<a class="el" href="group__flac__seekable__stream__encoder.html#a53a13">FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED</a>

<br>

}</td></tr>

<tr><td nowrap align=right valign=top>enum  </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a54">FLAC__SeekableStreamEncoderSeekStatus</a> { <a class="el" href="group__flac__seekable__stream__encoder.html#a54a14">FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_OK</a>,

<a class="el" href="group__flac__seekable__stream__encoder.html#a54a15">FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_ERROR</a>

}</td></tr>

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

<tr><td nowrap align=right valign=top><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a4">FLAC__seekable_stream_encoder_new</a> ()</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a5">FLAC__seekable_stream_encoder_delete</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a6">FLAC__seekable_stream_encoder_set_verify</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a7">FLAC__seekable_stream_encoder_set_streamable_subset</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a8">FLAC__seekable_stream_encoder_set_do_mid_side_stereo</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a9">FLAC__seekable_stream_encoder_set_loose_mid_side_stereo</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a10">FLAC__seekable_stream_encoder_set_channels</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a11">FLAC__seekable_stream_encoder_set_bits_per_sample</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a12">FLAC__seekable_stream_encoder_set_sample_rate</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a13">FLAC__seekable_stream_encoder_set_blocksize</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a14">FLAC__seekable_stream_encoder_set_max_lpc_order</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a15">FLAC__seekable_stream_encoder_set_qlp_coeff_precision</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a16">FLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a17">FLAC__seekable_stream_encoder_set_do_escape_coding</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a18">FLAC__seekable_stream_encoder_set_do_exhaustive_model_search</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a19">FLAC__seekable_stream_encoder_set_min_residual_partition_order</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a20">FLAC__seekable_stream_encoder_set_max_residual_partition_order</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a21">FLAC__seekable_stream_encoder_set_rice_parameter_search_dist</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a22">FLAC__seekable_stream_encoder_set_total_samples_estimate</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a23">FLAC__seekable_stream_encoder_set_metadata</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, unsigned num_blocks)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a24">FLAC__seekable_stream_encoder_set_seek_callback</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="group__flac__seekable__stream__encoder.html#a2">FLAC__SeekableStreamEncoderSeekCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a25">FLAC__seekable_stream_encoder_set_write_callback</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="group__flac__seekable__stream__encoder.html#a3">FLAC__SeekableStreamEncoderWriteCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a26">FLAC__seekable_stream_encoder_set_client_data</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, void *value)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__encoder.html#a53">FLAC__SeekableStreamEncoderState</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a27">FLAC__seekable_stream_encoder_get_state</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__encoder.html#a52">FLAC__StreamEncoderState</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a28">FLAC__seekable_stream_encoder_get_stream_encoder_state</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__decoder.html#a34">FLAC__StreamDecoderState</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a29">FLAC__seekable_stream_encoder_get_verify_decoder_state</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a30">FLAC__seekable_stream_encoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a31">FLAC__seekable_stream_encoder_get_verify_decoder_error_stats</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a32">FLAC__seekable_stream_encoder_get_verify</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a33">FLAC__seekable_stream_encoder_get_streamable_subset</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a34">FLAC__seekable_stream_encoder_get_do_mid_side_stereo</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a35">FLAC__seekable_stream_encoder_get_loose_mid_side_stereo</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a36">FLAC__seekable_stream_encoder_get_channels</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a37">FLAC__seekable_stream_encoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a38">FLAC__seekable_stream_encoder_get_sample_rate</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a39">FLAC__seekable_stream_encoder_get_blocksize</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a40">FLAC__seekable_stream_encoder_get_max_lpc_order</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a41">FLAC__seekable_stream_encoder_get_qlp_coeff_precision</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a42">FLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a43">FLAC__seekable_stream_encoder_get_do_escape_coding</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a44">FLAC__seekable_stream_encoder_get_do_exhaustive_model_search</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a45">FLAC__seekable_stream_encoder_get_min_residual_partition_order</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a46">FLAC__seekable_stream_encoder_get_max_residual_partition_order</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a47">FLAC__seekable_stream_encoder_get_rice_parameter_search_dist</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__uint64 </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a48">FLAC__seekable_stream_encoder_get_total_samples_estimate</a> (const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__encoder.html#a53">FLAC__SeekableStreamEncoderState</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_init</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a50">FLAC__seekable_stream_encoder_finish</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a51">FLAC__seekable_stream_encoder_process</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, const FLAC__int32 *const buffer[], unsigned samples)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__encoder.html#a52">FLAC__seekable_stream_encoder_process_interleaved</a> (<a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, const FLAC__int32 buffer[], unsigned samples)</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__seekable__stream__encoder.html#a0">FLAC__SeekableStreamEncoderStateString</a> []</td></tr>

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

</table>

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

This module contains the functions which implement the seekable stream encoder.

<p>

The basic usage of this encoder is as follows:<ul>

<li>The program creates an instance of an encoder using <a class="el" href="group__flac__seekable__stream__encoder.html#a4">FLAC__seekable_stream_encoder_new</a>().<li>The program overrides the default settings and sets callbacks using FLAC__seekable_stream_encoder_set_*() functions.<li>The program initializes the instance to validate the settings and prepare for encoding using <a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_init</a>().<li>The program calls <a class="el" href="group__flac__seekable__stream__encoder.html#a51">FLAC__seekable_stream_encoder_process</a>() or <a class="el" href="group__flac__seekable__stream__encoder.html#a52">FLAC__seekable_stream_encoder_process_interleaved</a>() to encode data, which subsequently calls the callbacks when there is encoder data ready to be written.<li>The program finishes the encoding with <a class="el" href="group__flac__seekable__stream__encoder.html#a50">FLAC__seekable_stream_encoder_finish</a>(), which causes the encoder to encode any data still in its input pipe, rewrite the metadata with the final encoding statistics, and finally reset the encoder to the uninitialized state.<li>The instance may be used again or deleted with <a class="el" href="group__flac__seekable__stream__encoder.html#a5">FLAC__seekable_stream_encoder_delete</a>().</ul>

The seekable stream encoder is a wrapper around the <a class="el" href="group__flac__stream__encoder.html">stream encoder</a> with callbacks for seeking the output. This allows the encoder to go back and rewrite some of the metadata after encoding if necessary, and provides the metadata callback of the stream encoder internally. However, you must provide a seek callback (see <a class="el" href="group__flac__seekable__stream__encoder.html#a24">FLAC__seekable_stream_encoder_set_seek_callback</a>()).

100

<p>

101

Make sure to read the detailed description of the <a class="el" href="group__flac__stream__encoder.html">stream encoder module</a> since the seekable stream encoder inherits much of its behavior.

102

<p>

103

104

Note: </b><dd>

105

If you are writing the FLAC data to a file, make sure it is open for update (e.g. mode "w+" for stdio streams). This is because after the first encoding pass, the encoder will try to seek back to the beginning of the stream, to the STREAMINFO block, to write some data there.</dl><dl compact><dt><b>

106

Note: </b><dd>

107

The "set" functions may only be called when the encoder is in the state FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED, i.e. after <a class="el" href="group__flac__seekable__stream__encoder.html#a4">FLAC__seekable_stream_encoder_new</a>() or <a class="el" href="group__flac__seekable__stream__encoder.html#a50">FLAC__seekable_stream_encoder_finish</a>(), but before <a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_init</a>(). If this is the case they will return <code>true</code>, otherwise <code>false</code>.</dl><dl compact><dt><b>

108

Note: </b><dd>

109

<a class="el" href="group__flac__seekable__stream__encoder.html#a50">FLAC__seekable_stream_encoder_finish</a>() resets all settings to the constructor defaults, including the callbacks. </dl><hr><h2>Typedef Documentation</h2>

110

111

112

<tr>

113

114

115

<tr>

116

<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__seekable__stream__encoder.html#a54">FLAC__SeekableStreamEncoderSeekStatus</a>(* FLAC__SeekableStreamEncoderSeekCallback)(const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)

117

</table>

118

</td>

119

</tr>

120

</table>

121

122

<tr>

123

<td>

124

125

</td>

126

<td>

127

128

<p>

129

Signature for the seek callback. See <a class="el" href="group__flac__seekable__stream__encoder.html#a24">FLAC__seekable_stream_encoder_set_seek_callback</a>() for more info.<dl compact><dt><b>

130

Parameters: </b><dd>

131

132

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

133

The encoder instance calling the callback. </td></tr>

134

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

135

The offset from the beginning of the stream to seek to. </td></tr>

136

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

137

The callee's client data set through <a class="el" href="group__flac__seekable__stream__encoder.html#a26">FLAC__seekable_stream_encoder_set_client_data</a>(). </td></tr>

138

</table>

139

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

140

Return values: </b><dd>

141

142

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

143

The callee's return status. </td></tr>

144

</table>

145

</dl> </td>

146

</tr>

147

</table>

148

149

150

<tr>

151

152

153

<tr>

154

<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__stream__encoder.html#a53">FLAC__StreamEncoderWriteStatus</a>(* FLAC__SeekableStreamEncoderWriteCallback)(const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data)

155

</table>

156

</td>

157

</tr>

158

</table>

159

160

<tr>

161

<td>

162

163

</td>

164

<td>

165

166

<p>

167

Signature for the write callback. See <a class="el" href="group__flac__seekable__stream__encoder.html#a25">FLAC__seekable_stream_encoder_set_write_callback</a>() and FLAC__StreamEncoderWriteCallback for more info.<dl compact><dt><b>

168

Parameters: </b><dd>

169

170

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

171

The encoder instance calling the callback. </td></tr>

172

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

173

An array of encoded data of length <em>bytes</em>. </td></tr>

174

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

175

The byte length of <em>buffer</em>. </td></tr>

176

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

177

The number of samples encoded by <em>buffer</em>. <code>0</code> has a special meaning; see <a class="el" href="group__flac__stream__encoder.html#a24">FLAC__stream_encoder_set_write_callback</a>(). </td></tr>

178

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

179

The number of current frame being encoded. </td></tr>

180

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

181

The callee's client data set through <a class="el" href="group__flac__seekable__stream__encoder.html#a26">FLAC__seekable_stream_encoder_set_client_data</a>(). </td></tr>

182

</table>

183

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

184

Return values: </b><dd>

185

186

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

187

The callee's return status. </td></tr>

188

</table>

189

</dl> </td>

190

</tr>

191

</table>

192

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

193

194

195

<tr>

196

197

198

<tr>

199

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

200

</table>

201

</td>

202

</tr>

203

</table>

204

205

<tr>

206

<td>

207

208

</td>

209

<td>

210

211

<p>

212

State values for a <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>

213

<p>

214

The encoder's state can be obtained by calling <a class="el" href="group__flac__seekable__stream__encoder.html#a27">FLAC__seekable_stream_encoder_get_state</a>(). <dl compact><dt><b>

215

Enumeration values:</b><dd>

216

217

<tr><td valign=top><em><a name="a53a4" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_OK"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_OK</em></em> </td><td>

218

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

219

<tr><td valign=top><em><a name="a53a5" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</em></em> </td><td>

220

An error occurred in the underlying stream encoder; check <a class="el" href="group__flac__seekable__stream__encoder.html#a28">FLAC__seekable_stream_encoder_get_stream_encoder_state</a>(). </td></tr>

221

<tr><td valign=top><em><a name="a53a6" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_MEMORY_ALLOCATION_ERROR"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_MEMORY_ALLOCATION_ERROR</em></em> </td><td>

222

Memory allocation failed. </td></tr>

223

<tr><td valign=top><em><a name="a53a7" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_WRITE_ERROR"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_WRITE_ERROR</em></em> </td><td>

224

The write callback returned an error. </td></tr>

225

<tr><td valign=top><em><a name="a53a8" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_READ_ERROR"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_READ_ERROR</em></em> </td><td>

226

The read callback returned an error. </td></tr>

227

<tr><td valign=top><em><a name="a53a9" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_SEEK_ERROR"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_SEEK_ERROR</em></em> </td><td>

228

The seek callback returned an error. </td></tr>

229

<tr><td valign=top><em><a name="a53a10" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_ALREADY_INITIALIZED"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_ALREADY_INITIALIZED</em></em> </td><td>

230

<a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_init</a>() was called when the encoder was already initialized, usually because <a class="el" href="group__flac__seekable__stream__encoder.html#a50">FLAC__seekable_stream_encoder_finish</a>() was not called. </td></tr>

231

<tr><td valign=top><em><a name="a53a11" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_INVALID_CALLBACK"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_INVALID_CALLBACK</em></em> </td><td>

232

<a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_init</a>() was called without all callbacks being set. </td></tr>

233

<tr><td valign=top><em><a name="a53a12" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_INVALID_SEEKTABLE"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_INVALID_SEEKTABLE</em></em> </td><td>

234

An invalid seek table was passed is the metadata to <a class="el" href="group__flac__seekable__stream__encoder.html#a23">FLAC__seekable_stream_encoder_set_metadata</a>(). </td></tr>

235

<tr><td valign=top><em><a name="a53a13" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED</em></em> </td><td>

236

The encoder is in the uninitialized state. </td></tr>

237

</table>

238

</dl>

239

</td>

240

</tr>

241

</table>

242

243

244

<tr>

245

246

247

<tr>

248

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

249

</table>

250

</td>

251

</tr>

252

</table>

253

254

<tr>

255

<td>

256

257

</td>

258

<td>

259

260

<p>

261

Return values for the <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> seek callback. <dl compact><dt><b>

262

Enumeration values:</b><dd>

263

264

<tr><td valign=top><em><a name="a54a14" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_OK"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_OK</em></em> </td><td>

265

The seek was OK and encoding can continue. </td></tr>

266

<tr><td valign=top><em><a name="a54a15" doxytag="FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_ERROR"></a><em>FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_ERROR</em></em> </td><td>

267

An unrecoverable error occurred. The encoder will return from the process call. </td></tr>

268

</table>

269

</dl>

270

</td>

271

</tr>

272

</table>

273

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

274

275

276

<tr>

277

278

279

<tr>

280

<td class="md" nowrap valign="top"> <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>* FLAC__seekable_stream_encoder_new </td>

281

282

283

284

285

</tr>

286

287

</table>

288

</td>

289

</tr>

290

</table>

291

292

<tr>

293

<td>

294

295

</td>

296

<td>

297

298

<p>

299

Create a new seekable stream encoder instance. The instance is created with default settings; see the individual FLAC__seekable_stream_encoder_set_*() functions for each setting's default.<dl compact><dt><b>

300

Return values: </b><dd>

301

302

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

303

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

304

</table>

305

</dl> </td>

306

</tr>

307

</table>

308

309

310

<tr>

311

312

313

<tr>

314

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

315

316

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

317

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

318

319

320

</tr>

321

322

</table>

323

</td>

324

</tr>

325

</table>

326

327

<tr>

328

<td>

329

330

</td>

331

<td>

332

333

<p>

334

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

335

Parameters: </b><dd>

336

337

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

338

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

339

</table>

340

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

341

Assertions:</b><dd>

342

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

343

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

344

</tr>

345

</table>

346

347

348

<tr>

349

350

351

<tr>

352

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

353

354

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

355

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

356

</tr>

357

<tr>

358

359

360

361

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

362

</tr>

363

<tr>

364

365

366

367

</tr>

368

369

</table>

370

</td>

371

</tr>

372

</table>

373

374

<tr>

375

<td>

376

377

</td>

378

<td>

379

380

<p>

381

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a6">FLAC__stream_encoder_set_verify</a>().<dl compact><dt><b>

382

Default Value:</b><dd>

383

384

Parameters: </b><dd>

385

386

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

387

An encoder instance to set. </td></tr>

388

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

389

See above. </td></tr>

390

</table>

391

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

392

Assertions:</b><dd>

393

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

394

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

395

Return values: </b><dd>

396

397

398

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

399

</table>

400

</dl> </td>

401

</tr>

402

</table>

403

404

405

<tr>

406

407

408

<tr>

409

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

410

411

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

412

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

413

</tr>

414

<tr>

415

416

417

418

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

419

</tr>

420

<tr>

421

422

423

424

</tr>

425

426

</table>

427

</td>

428

</tr>

429

</table>

430

431

<tr>

432

<td>

433

434

</td>

435

<td>

436

437

<p>

438

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a7">FLAC__stream_encoder_set_streamable_subset</a>().<dl compact><dt><b>

439

Default Value:</b><dd>

440

441

Parameters: </b><dd>

442

443

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

444

An encoder instance to set. </td></tr>

445

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

446

See above. </td></tr>

447

</table>

448

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

449

Assertions:</b><dd>

450

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

451

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

452

Return values: </b><dd>

453

454

455

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

456

</table>

457

</dl> </td>

458

</tr>

459

</table>

460

461

462

<tr>

463

464

465

<tr>

466

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

467

468

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

469

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

470

</tr>

471

<tr>

472

473

474

475

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

476

</tr>

477

<tr>

478

479

480

481

</tr>

482

483

</table>

484

</td>

485

</tr>

486

</table>

487

488

<tr>

489

<td>

490

491

</td>

492

<td>

493

494

<p>

495

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a8">FLAC__stream_encoder_set_do_mid_side_stereo</a>().<dl compact><dt><b>

496

Default Value:</b><dd>

497

<code>false</code> </dl><dl compact><dt><b>

498

Parameters: </b><dd>

499

500

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

501

An encoder instance to set. </td></tr>

502

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

503

See above. </td></tr>

504

</table>

505

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

506

Assertions:</b><dd>

507

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

508

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

509

Return values: </b><dd>

510

511

512

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

513

</table>

514

</dl> </td>

515

</tr>

516

</table>

517

518

519

<tr>

520

521

522

<tr>

523

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

524

525

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

526

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

527

</tr>

528

<tr>

529

530

531

532

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

533

</tr>

534

<tr>

535

536

537

538

</tr>

539

540

</table>

541

</td>

542

</tr>

543

</table>

544

545

<tr>

546

<td>

547

548

</td>

549

<td>

550

551

<p>

552

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a9">FLAC__stream_encoder_set_loose_mid_side_stereo</a>().<dl compact><dt><b>

553

Default Value:</b><dd>

554

<code>false</code> </dl><dl compact><dt><b>

555

Parameters: </b><dd>

556

557

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

558

An encoder instance to set. </td></tr>

559

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

560

See above. </td></tr>

561

</table>

562

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

563

Assertions:</b><dd>

564

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

565

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

566

Return values: </b><dd>

567

568

569

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

570

</table>

571

</dl> </td>

572

</tr>

573

</table>

574

575

576

<tr>

577

578

579

<tr>

580

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

581

582

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

583

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

584

</tr>

585

<tr>

586

587

588

<td class="md" nowrap>unsigned </td>

589

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

590

</tr>

591

<tr>

592

593

594

595

</tr>

596

597

</table>

598

</td>

599

</tr>

600

</table>

601

602

<tr>

603

<td>

604

605

</td>

606

<td>

607

608

<p>

609

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a10">FLAC__stream_encoder_set_channels</a>().<dl compact><dt><b>

610

Default Value:</b><dd>

611

612

Parameters: </b><dd>

613

614

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

615

An encoder instance to set. </td></tr>

616

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

617

See above. </td></tr>

618

</table>

619

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

620

Assertions:</b><dd>

621

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

622

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

623

Return values: </b><dd>

624

625

626

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

627

</table>

628

</dl> </td>

629

</tr>

630

</table>

631

632

633

<tr>

634

635

636

<tr>

637

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

638

639

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

640

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

641

</tr>

642

<tr>

643

644

645

<td class="md" nowrap>unsigned </td>

646

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

647

</tr>

648

<tr>

649

650

651

652

</tr>

653

654

</table>

655

</td>

656

</tr>

657

</table>

658

659

<tr>

660

<td>

661

662

</td>

663

<td>

664

665

<p>

666

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a11">FLAC__stream_encoder_set_bits_per_sample</a>().

667

<p>

668

669

Warning: </b><dd>

670

Do not feed the encoder data that is wider than the value you set here or you will generate an invalid stream.</dl><dl compact><dt><b>

671

Default Value:</b><dd>

672

673

Parameters: </b><dd>

674

675

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

676

An encoder instance to set. </td></tr>

677

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

678

See above. </td></tr>

679

</table>

680

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

681

Assertions:</b><dd>

682

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

683

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

684

Return values: </b><dd>

685

686

687

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

688

</table>

689

</dl> </td>

690

</tr>

691

</table>

692

693

694

<tr>

695

696

697

<tr>

698

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

699

700

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

701

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

702

</tr>

703

<tr>

704

705

706

<td class="md" nowrap>unsigned </td>

707

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

708

</tr>

709

<tr>

710

711

712

713

</tr>

714

715

</table>

716

</td>

717

</tr>

718

</table>

719

720

<tr>

721

<td>

722

723

</td>

724

<td>

725

726

<p>

727

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a12">FLAC__stream_encoder_set_sample_rate</a>().<dl compact><dt><b>

728

Default Value:</b><dd>

729

730

Parameters: </b><dd>

731

732

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

733

An encoder instance to set. </td></tr>

734

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

735

See above. </td></tr>

736

</table>

737

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

738

Assertions:</b><dd>

739

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

740

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

741

Return values: </b><dd>

742

743

744

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

745

</table>

746

</dl> </td>

747

</tr>

748

</table>

749

750

751

<tr>

752

753

754

<tr>

755

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

756

757

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

758

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

759

</tr>

760

<tr>

761

762

763

<td class="md" nowrap>unsigned </td>

764

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

765

</tr>

766

<tr>

767

768

769

770

</tr>

771

772

</table>

773

</td>

774

</tr>

775

</table>

776

777

<tr>

778

<td>

779

780

</td>

781

<td>

782

783

<p>

784

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a13">FLAC__stream_encoder_set_blocksize</a>().<dl compact><dt><b>

785

Default Value:</b><dd>

786

787

Parameters: </b><dd>

788

789

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

790

An encoder instance to set. </td></tr>

791

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

792

See above. </td></tr>

793

</table>

794

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

795

Assertions:</b><dd>

796

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

797

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

798

Return values: </b><dd>

799

800

801

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

802

</table>

803

</dl> </td>

804

</tr>

805

</table>

806

807

808

<tr>

809

810

811

<tr>

812

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

813

814

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

815

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

816

</tr>

817

<tr>

818

819

820

<td class="md" nowrap>unsigned </td>

821

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

822

</tr>

823

<tr>

824

825

826

827

</tr>

828

829

</table>

830

</td>

831

</tr>

832

</table>

833

834

<tr>

835

<td>

836

837

</td>

838

<td>

839

840

<p>

841

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a14">FLAC__stream_encoder_set_max_lpc_order</a>().<dl compact><dt><b>

842

Default Value:</b><dd>

843

844

Parameters: </b><dd>

845

846

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

847

An encoder instance to set. </td></tr>

848

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

849

See above. </td></tr>

850

</table>

851

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

852

Assertions:</b><dd>

853

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

854

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

855

Return values: </b><dd>

856

857

858

<code>false</code> if the encoder is already initialized, else <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__seekable_stream_encoder_set_qlp_coeff_precision </td>

870

871

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

872

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

873

</tr>

874

<tr>

875

876

877

<td class="md" nowrap>unsigned </td>

878

<td class="mdname" nowrap>  <em>value</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

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a15">FLAC__stream_encoder_set_qlp_coeff_precision</a>().

899

<p>

900

901

Note: </b><dd>

902

In the current implementation, qlp_coeff_precision + bits_per_sample must be less than 32.</dl><dl compact><dt><b>

903

Default Value:</b><dd>

904

905

Parameters: </b><dd>

906

907

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

908

An encoder instance to set. </td></tr>

909

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

910

See above. </td></tr>

911

</table>

912

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

913

Assertions:</b><dd>

914

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

915

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

916

Return values: </b><dd>

917

918

919

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

920

</table>

921

</dl> </td>

922

</tr>

923

</table>

924

925

926

<tr>

927

928

929

<tr>

930

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

931

932

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

933

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

934

</tr>

935

<tr>

936

937

938

939

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

940

</tr>

941

<tr>

942

943

944

945

</tr>

946

947

</table>

948

</td>

949

</tr>

950

</table>

951

952

<tr>

953

<td>

954

955

</td>

956

<td>

957

958

<p>

959

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a16">FLAC__stream_encoder_set_do_qlp_coeff_prec_search</a>().<dl compact><dt><b>

960

Default Value:</b><dd>

961

<code>false</code> </dl><dl compact><dt><b>

962

Parameters: </b><dd>

963

964

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

965

An encoder instance to set. </td></tr>

966

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

967

See above. </td></tr>

968

</table>

969

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

970

Assertions:</b><dd>

971

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

972

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

973

Return values: </b><dd>

974

975

976

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

977

</table>

978

</dl> </td>

979

</tr>

980

</table>

981

982

983

<tr>

984

985

986

<tr>

987

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

988

989

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

990

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

991

</tr>

992

<tr>

993

994

995

996

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

997

</tr>

998

<tr>

999

1000

1001

1002

</tr>

1003

1004

</table>

1005

</td>

1006

</tr>

1007

</table>

1008

1009

<tr>

1010

<td>

1011

1012

</td>

1013

<td>

1014

1015

<p>

1016

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a17">FLAC__stream_encoder_set_do_escape_coding</a>().<dl compact><dt><b>

1017

Default Value:</b><dd>

1018

<code>false</code> </dl><dl compact><dt><b>

1019

Parameters: </b><dd>

1020

1021

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

1022

An encoder instance to set. </td></tr>

1023

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

1024

See above. </td></tr>

1025

</table>

1026

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

1027

Assertions:</b><dd>

1028

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

1029

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

1030

Return values: </b><dd>

1031

1032

1033

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1034

</table>

1035

</dl> </td>

1036

</tr>

1037

</table>

1038

1039

1040

<tr>

1041

1042

1043

<tr>

1044

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

1045

1046

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1047

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

1048

</tr>

1049

<tr>

1050

1051

1052

1053

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

1054

</tr>

1055

<tr>

1056

1057

1058

1059

</tr>

1060

1061

</table>

1062

</td>

1063

</tr>

1064

</table>

1065

1066

<tr>

1067

<td>

1068

1069

</td>

1070

<td>

1071

1072

<p>

1073

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a18">FLAC__stream_encoder_set_do_exhaustive_model_search</a>().<dl compact><dt><b>

1074

Default Value:</b><dd>

1075

<code>false</code> </dl><dl compact><dt><b>

1076

Parameters: </b><dd>

1077

1078

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

1079

An encoder instance to set. </td></tr>

1080

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

1081

See above. </td></tr>

1082

</table>

1083

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

1084

Assertions:</b><dd>

1085

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

1086

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

1087

Return values: </b><dd>

1088

1089

1090

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1091

</table>

1092

</dl> </td>

1093

</tr>

1094

</table>

1095

1096

1097

<tr>

1098

1099

1100

<tr>

1101

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

1102

1103

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1104

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

1105

</tr>

1106

<tr>

1107

1108

1109

<td class="md" nowrap>unsigned </td>

1110

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

1111

</tr>

1112

<tr>

1113

1114

1115

1116

</tr>

1117

1118

</table>

1119

</td>

1120

</tr>

1121

</table>

1122

1123

<tr>

1124

<td>

1125

1126

</td>

1127

<td>

1128

1129

<p>

1130

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a19">FLAC__stream_encoder_set_min_residual_partition_order</a>().<dl compact><dt><b>

1131

Default Value:</b><dd>

1132

1133

Parameters: </b><dd>

1134

1135

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

1136

An encoder instance to set. </td></tr>

1137

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

1138

See above. </td></tr>

1139

</table>

1140

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

1141

Assertions:</b><dd>

1142

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

1143

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

1144

Return values: </b><dd>

1145

1146

1147

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1148

</table>

1149

</dl> </td>

1150

</tr>

1151

</table>

1152

1153

1154

<tr>

1155

1156

1157

<tr>

1158

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

1159

1160

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1161

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

1162

</tr>

1163

<tr>

1164

1165

1166

<td class="md" nowrap>unsigned </td>

1167

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

1168

</tr>

1169

<tr>

1170

1171

1172

1173

</tr>

1174

1175

</table>

1176

</td>

1177

</tr>

1178

</table>

1179

1180

<tr>

1181

<td>

1182

1183

</td>

1184

<td>

1185

1186

<p>

1187

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a20">FLAC__stream_encoder_set_max_residual_partition_order</a>().<dl compact><dt><b>

1188

Default Value:</b><dd>

1189

1190

Parameters: </b><dd>

1191

1192

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

1193

An encoder instance to set. </td></tr>

1194

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

1195

See above. </td></tr>

1196

</table>

1197

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

1198

Assertions:</b><dd>

1199

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

1200

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

1201

Return values: </b><dd>

1202

1203

1204

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1205

</table>

1206

</dl> </td>

1207

</tr>

1208

</table>

1209

1210

1211

<tr>

1212

1213

1214

<tr>

1215

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

1216

1217

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1218

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

1219

</tr>

1220

<tr>

1221

1222

1223

<td class="md" nowrap>unsigned </td>

1224

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

1225

</tr>

1226

<tr>

1227

1228

1229

1230

</tr>

1231

1232

</table>

1233

</td>

1234

</tr>

1235

</table>

1236

1237

<tr>

1238

<td>

1239

1240

</td>

1241

<td>

1242

1243

<p>

1244

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a21">FLAC__stream_encoder_set_rice_parameter_search_dist</a>().<dl compact><dt><b>

1245

Default Value:</b><dd>

1246

1247

Parameters: </b><dd>

1248

1249

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

1250

An encoder instance to set. </td></tr>

1251

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

1252

See above. </td></tr>

1253

</table>

1254

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

1255

Assertions:</b><dd>

1256

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

1257

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

1258

Return values: </b><dd>

1259

1260

1261

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1262

</table>

1263

</dl> </td>

1264

</tr>

1265

</table>

1266

1267

1268

<tr>

1269

1270

1271

<tr>

1272

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

1273

1274

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1275

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

1276

</tr>

1277

<tr>

1278

1279

1280

1281

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

1282

</tr>

1283

<tr>

1284

1285

1286

1287

</tr>

1288

1289

</table>

1290

</td>

1291

</tr>

1292

</table>

1293

1294

<tr>

1295

<td>

1296

1297

</td>

1298

<td>

1299

1300

<p>

1301

This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a22">FLAC__stream_encoder_set_total_samples_estimate</a>().<dl compact><dt><b>

1302

Default Value:</b><dd>

1303

1304

Parameters: </b><dd>

1305

1306

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

1307

An encoder instance to set. </td></tr>

1308

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

1309

See above. </td></tr>

1310

</table>

1311

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

1312

Assertions:</b><dd>

1313

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

1314

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

1315

Return values: </b><dd>

1316

1317

1318

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1319

</table>

1320

</dl> </td>

1321

</tr>

1322

</table>

1323

1324

1325

<tr>

1326

1327

1328

<tr>

1329

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

1330

1331

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1332

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

1333

</tr>

1334

<tr>

1335

1336

1337

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

1338

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

1339

</tr>

1340

<tr>

1341

1342

1343

<td class="md" nowrap>unsigned </td>

1344

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

1345

</tr>

1346

<tr>

1347

1348

1349

1350

</tr>

1351

1352

</table>

1353

</td>

1354

</tr>

1355

</table>

1356

1357

<tr>

1358

<td>

1359

1360

</td>

1361

<td>

1362

1363

<p>

1364

1365

<p>

1366

1367

Note: </b><dd>

1368

SEEKTABLE blocks are handled specially. Since you will not know the values for the seek point stream offsets, you should pass in a SEEKTABLE 'template', that is, a SEEKTABLE object with the required sample numbers (or placeholder points), with <code>0</code> for the <em>frame_samples</em> and <em>stream_offset</em> fields for each point. While encoding, the encoder will fill them in for you and when encoding is finished, it will seek back and write the real values into the SEEKTABLE block in the stream. There are helper routines for manipulating seektable template blocks; see <a class="el" href="+_2metadata_8h.html">metadata.h</a>: FLAC__metadata_object_seektable_template_*().</dl><dl compact><dt><b>

1369

Note: </b><dd>

1370

The encoder instance <b>will</b> modify the first <code>SEEKTABLE</code> block as it transforms the template to a valid seektable while encoding, but it is still up to the caller to free all metadata blocks after encoding.</dl><dl compact><dt><b>

1371

Default Value:</b><dd>

1372

1373

Parameters: </b><dd>

1374

1375

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

1376

An encoder instance to set. </td></tr>

1377

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

1378

See above. </td></tr>

1379

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

1380

See above. </td></tr>

1381

</table>

1382

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

1383

Assertions:</b><dd>

1384

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

1385

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

1386

Return values: </b><dd>

1387

1388

1389

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1390

</table>

1391

</dl> </td>

1392

</tr>

1393

</table>

1394

1395

1396

<tr>

1397

1398

1399

<tr>

1400

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

1401

1402

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1403

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

1404

</tr>

1405

<tr>

1406

1407

1408

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__encoder.html#a2">FLAC__SeekableStreamEncoderSeekCallback</a> </td>

1409

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

1410

</tr>

1411

<tr>

1412

1413

1414

1415

</tr>

1416

1417

</table>

1418

</td>

1419

</tr>

1420

</table>

1421

1422

<tr>

1423

<td>

1424

1425

</td>

1426

<td>

1427

1428

<p>

1429

Set the seek callback. The supplied function will be called when the encoder needs to seek the output stream. The encoder will pass the absolute byte offset to seek to, 0 meaning the beginning of the stream.

1430

<p>

1431

1432

Note: </b><dd>

1433

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

1434

Default Value:</b><dd>

1435

1436

Parameters: </b><dd>

1437

1438

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

1439

An encoder instance to set. </td></tr>

1440

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

1441

See above. </td></tr>

1442

</table>

1443

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

1444

Assertions:</b><dd>

1445

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

1446

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

1447

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

1448

Return values: </b><dd>

1449

1450

1451

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1452

</table>

1453

</dl> </td>

1454

</tr>

1455

</table>

1456

1457

1458

<tr>

1459

1460

1461

<tr>

1462

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

1463

1464

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1465

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

1466

</tr>

1467

<tr>

1468

1469

1470

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__encoder.html#a3">FLAC__SeekableStreamEncoderWriteCallback</a> </td>

1471

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

1472

</tr>

1473

<tr>

1474

1475

1476

1477

</tr>

1478

1479

</table>

1480

</td>

1481

</tr>

1482

</table>

1483

1484

<tr>

1485

<td>

1486

1487

</td>

1488

<td>

1489

1490

<p>

1491

Set the write callback. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a24">FLAC__stream_encoder_set_write_callback</a>().

1492

<p>

1493

1494

Note: </b><dd>

1495

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

1496

Default Value:</b><dd>

1497

1498

Parameters: </b><dd>

1499

1500

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

1501

An encoder instance to set. </td></tr>

1502

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

1503

See above. </td></tr>

1504

</table>

1505

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

1506

Assertions:</b><dd>

1507

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

1508

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

1509

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

1510

Return values: </b><dd>

1511

1512

1513

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1514

</table>

1515

</dl> </td>

1516

</tr>

1517

</table>

1518

1519

1520

<tr>

1521

1522

1523

<tr>

1524

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

1525

1526

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1527

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

1528

</tr>

1529

<tr>

1530

1531

1532

1533

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

1534

</tr>

1535

<tr>

1536

1537

1538

1539

</tr>

1540

1541

</table>

1542

</td>

1543

</tr>

1544

</table>

1545

1546

<tr>

1547

<td>

1548

1549

</td>

1550

<td>

1551

1552

<p>

1553

Set the client data to be passed back to callbacks. This value will be supplied to callbacks in their <em>client_data</em> argument.<dl compact><dt><b>

1554

Default Value:</b><dd>

1555

1556

Parameters: </b><dd>

1557

1558

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

1559

An encoder instance to set. </td></tr>

1560

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

1561

See above. </td></tr>

1562

</table>

1563

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

1564

Assertions:</b><dd>

1565

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

1566

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

1567

Return values: </b><dd>

1568

1569

1570

<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>

1571

</table>

1572

</dl> </td>

1573

</tr>

1574

</table>

1575

1576

1577

<tr>

1578

1579

1580

<tr>

1581

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__seekable__stream__encoder.html#a53">FLAC__SeekableStreamEncoderState</a> FLAC__seekable_stream_encoder_get_state </td>

1582

1583

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1584

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

1585

1586

1587

</tr>

1588

1589

</table>

1590

</td>

1591

</tr>

1592

</table>

1593

1594

<tr>

1595

<td>

1596

1597

</td>

1598

<td>

1599

1600

<p>

1601

Get the current encoder state.<dl compact><dt><b>

1602

Parameters: </b><dd>

1603

1604

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

1605

An encoder instance to query. </td></tr>

1606

</table>

1607

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

1608

Assertions:</b><dd>

1609

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

1610

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

1611

Return values: </b><dd>

1612

1613

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

1614

The current encoder state. </td></tr>

1615

</table>

1616

</dl> </td>

1617

</tr>

1618

</table>

1619

1620

1621

<tr>

1622

1623

1624

<tr>

1625

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__stream__encoder.html#a52">FLAC__StreamEncoderState</a> FLAC__seekable_stream_encoder_get_stream_encoder_state </td>

1626

1627

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1628

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

1629

1630

1631

</tr>

1632

1633

</table>

1634

</td>

1635

</tr>

1636

</table>

1637

1638

<tr>

1639

<td>

1640

1641

</td>

1642

<td>

1643

1644

<p>

1645

Get the state of the underlying stream encoder. Useful when the seekable stream encoder state is <code>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</code>.<dl compact><dt><b>

1646

Parameters: </b><dd>

1647

1648

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

1649

An encoder instance to query. </td></tr>

1650

</table>

1651

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

1652

Assertions:</b><dd>

1653

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

1654

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

1655

Return values: </b><dd>

1656

1657

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

1658

The stream encoder state. </td></tr>

1659

</table>

1660

</dl> </td>

1661

</tr>

1662

</table>

1663

1664

1665

<tr>

1666

1667

1668

<tr>

1669

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__stream__decoder.html#a34">FLAC__StreamDecoderState</a> FLAC__seekable_stream_encoder_get_verify_decoder_state </td>

1670

1671

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1672

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

1673

1674

1675

</tr>

1676

1677

</table>

1678

</td>

1679

</tr>

1680

</table>

1681

1682

<tr>

1683

<td>

1684

1685

</td>

1686

<td>

1687

1688

<p>

1689

Get the state of the underlying stream encoder's verify decoder. Useful when the seekable stream encoder state is <code>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</code> and the stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>.<dl compact><dt><b>

1690

Parameters: </b><dd>

1691

1692

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

1693

An encoder instance to query. </td></tr>

1694

</table>

1695

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

1696

Assertions:</b><dd>

1697

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

1698

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

1699

Return values: </b><dd>

1700

1701

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

1702

The stream encoder state. </td></tr>

1703

</table>

1704

</dl> </td>

1705

</tr>

1706

</table>

1707

1708

1709

<tr>

1710

1711

1712

<tr>

1713

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

1714

1715

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1716

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

1717

1718

1719

</tr>

1720

1721

</table>

1722

</td>

1723

</tr>

1724

</table>

1725

1726

<tr>

1727

<td>

1728

1729

</td>

1730

<td>

1731

1732

<p>

1733

Get the current encoder state as a C string. This version automatically resolves <code>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</code> by getting the stream encoder's state.<dl compact><dt><b>

1734

Parameters: </b><dd>

1735

1736

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

1737

A encoder instance to query. </td></tr>

1738

</table>

1739

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

1740

Assertions:</b><dd>

1741

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

1742

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

1743

Return values: </b><dd>

1744

1745

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

1746

char * The encoder state as a C string. Do not modify the contents. </td></tr>

1747

</table>

1748

</dl> </td>

1749

</tr>

1750

</table>

1751

1752

1753

<tr>

1754

1755

1756

<tr>

1757

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

1758

1759

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1760

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

1761

</tr>

1762

<tr>

1763

1764

1765

1766

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

1767

</tr>

1768

<tr>

1769

1770

1771

<td class="md" nowrap>unsigned * </td>

1772

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

1773

</tr>

1774

<tr>

1775

1776

1777

<td class="md" nowrap>unsigned * </td>

1778

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

1779

</tr>

1780

<tr>

1781

1782

1783

<td class="md" nowrap>unsigned * </td>

1784

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

1785

</tr>

1786

<tr>

1787

1788

1789

1790

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

1791

</tr>

1792

<tr>

1793

1794

1795

1796

1797

</tr>

1798

<tr>

1799

1800

1801

1802

</tr>

1803

1804

</table>

1805

</td>

1806

</tr>

1807

</table>

1808

1809

<tr>

1810

<td>

1811

1812

</td>

1813

<td>

1814

1815

<p>

1816

Get relevant values about the nature of a verify decoder error. Inherited from <a class="el" href="group__flac__stream__encoder.html#a30">FLAC__stream_encoder_get_verify_decoder_error_stats</a>(). Useful when the seekable stream encoder state is <code>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</code> and the stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>.<dl compact><dt><b>

1817

Parameters: </b><dd>

1818

1819

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

1820

An encoder instance to query. </td></tr>

1821

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

1822

The absolute sample number of the mismatch. </td></tr>

1823

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

1824

The number of the frame in which the mismatch occurred. </td></tr>

1825

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

1826

The channel in which the mismatch occurred. </td></tr>

1827

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

1828

The number of the sample (relative to the frame) in which the mismatch occurred. </td></tr>

1829

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

1830

The expected value for the sample in question. </td></tr>

1831

1832

The actual value returned by the decoder. </td></tr>

1833

</table>

1834

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

1835

Assertions:</b><dd>

1836

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

1837

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

1838

</tr>

1839

</table>

1840

1841

1842

<tr>

1843

1844

1845

<tr>

1846

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

1847

1848

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1849

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

1850

1851

1852

</tr>

1853

1854

</table>

1855

</td>

1856

</tr>

1857

</table>

1858

1859

<tr>

1860

<td>

1861

1862

</td>

1863

<td>

1864

1865

<p>

1866

Get the "verify" flag. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a31">FLAC__stream_encoder_get_verify</a>().<dl compact><dt><b>

1867

Parameters: </b><dd>

1868

1869

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

1870

An encoder instance to query. </td></tr>

1871

</table>

1872

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

1873

Assertions:</b><dd>

1874

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

1875

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

1876

Return values: </b><dd>

1877

1878

1879

See <a class="el" href="group__flac__seekable__stream__encoder.html#a6">FLAC__seekable_stream_encoder_set_verify</a>(). </td></tr>

1880

</table>

1881

</dl> </td>

1882

</tr>

1883

</table>

1884

1885

1886

<tr>

1887

1888

1889

<tr>

1890

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

1891

1892

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1893

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

1894

1895

1896

</tr>

1897

1898

</table>

1899

</td>

1900

</tr>

1901

</table>

1902

1903

<tr>

1904

<td>

1905

1906

</td>

1907

<td>

1908

1909

<p>

1910

Get the "streamable subset" flag. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a32">FLAC__stream_encoder_get_streamable_subset</a>().<dl compact><dt><b>

1911

Parameters: </b><dd>

1912

1913

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

1914

An encoder instance to query. </td></tr>

1915

</table>

1916

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

1917

Assertions:</b><dd>

1918

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

1919

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

1920

Return values: </b><dd>

1921

1922

1923

See <a class="el" href="group__flac__seekable__stream__encoder.html#a7">FLAC__seekable_stream_encoder_set_streamable_subset</a>(). </td></tr>

1924

</table>

1925

</dl> </td>

1926

</tr>

1927

</table>

1928

1929

1930

<tr>

1931

1932

1933

<tr>

1934

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

1935

1936

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1937

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

1938

1939

1940

</tr>

1941

1942

</table>

1943

</td>

1944

</tr>

1945

</table>

1946

1947

<tr>

1948

<td>

1949

1950

</td>

1951

<td>

1952

1953

<p>

1954

Get the "mid/side stereo coding" flag. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a33">FLAC__stream_encoder_get_do_mid_side_stereo</a>().<dl compact><dt><b>

1955

Parameters: </b><dd>

1956

1957

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

1958

An encoder instance to query. </td></tr>

1959

</table>

1960

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

1961

Assertions:</b><dd>

1962

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

1963

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

1964

Return values: </b><dd>

1965

1966

1967

See <a class="el" href="group__flac__seekable__stream__encoder.html#a34">FLAC__seekable_stream_encoder_get_do_mid_side_stereo</a>(). </td></tr>

1968

</table>

1969

</dl> </td>

1970

</tr>

1971

</table>

1972

1973

1974

<tr>

1975

1976

1977

<tr>

1978

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

1979

1980

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

1981

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

1982

1983

1984

</tr>

1985

1986

</table>

1987

</td>

1988

</tr>

1989

</table>

1990

1991

<tr>

1992

<td>

1993

1994

</td>

1995

<td>

1996

1997

<p>

1998

Get the "adaptive mid/side switching" flag. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a34">FLAC__stream_encoder_get_loose_mid_side_stereo</a>().<dl compact><dt><b>

1999

Parameters: </b><dd>

2000

2001

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

2002

An encoder instance to query. </td></tr>

2003

</table>

2004

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

2005

Assertions:</b><dd>

2006

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

2007

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

2008

Return values: </b><dd>

2009

2010

2011

See <a class="el" href="group__flac__seekable__stream__encoder.html#a9">FLAC__seekable_stream_encoder_set_loose_mid_side_stereo</a>(). </td></tr>

2012

</table>

2013

</dl> </td>

2014

</tr>

2015

</table>

2016

2017

2018

<tr>

2019

2020

2021

<tr>

2022

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_channels </td>

2023

2024

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2025

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

2026

2027

2028

</tr>

2029

2030

</table>

2031

</td>

2032

</tr>

2033

</table>

2034

2035

<tr>

2036

<td>

2037

2038

</td>

2039

<td>

2040

2041

<p>

2042

Get the number of input channels being processed. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a35">FLAC__stream_encoder_get_channels</a>().<dl compact><dt><b>

2043

Parameters: </b><dd>

2044

2045

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

2046

An encoder instance to query. </td></tr>

2047

</table>

2048

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

2049

Assertions:</b><dd>

2050

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

2051

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

2052

Return values: </b><dd>

2053

2054

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

2055

See <a class="el" href="group__flac__seekable__stream__encoder.html#a10">FLAC__seekable_stream_encoder_set_channels</a>(). </td></tr>

2056

</table>

2057

</dl> </td>

2058

</tr>

2059

</table>

2060

2061

2062

<tr>

2063

2064

2065

<tr>

2066

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_bits_per_sample </td>

2067

2068

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2069

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

2070

2071

2072

</tr>

2073

2074

</table>

2075

</td>

2076

</tr>

2077

</table>

2078

2079

<tr>

2080

<td>

2081

2082

</td>

2083

<td>

2084

2085

<p>

2086

Get the input sample resolution setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a36">FLAC__stream_encoder_get_bits_per_sample</a>().<dl compact><dt><b>

2087

Parameters: </b><dd>

2088

2089

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

2090

An encoder instance to query. </td></tr>

2091

</table>

2092

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

2093

Assertions:</b><dd>

2094

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

2095

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

2096

Return values: </b><dd>

2097

2098

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

2099

See <a class="el" href="group__flac__seekable__stream__encoder.html#a11">FLAC__seekable_stream_encoder_set_bits_per_sample</a>(). </td></tr>

2100

</table>

2101

</dl> </td>

2102

</tr>

2103

</table>

2104

2105

2106

<tr>

2107

2108

2109

<tr>

2110

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_sample_rate </td>

2111

2112

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2113

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

2114

2115

2116

</tr>

2117

2118

</table>

2119

</td>

2120

</tr>

2121

</table>

2122

2123

<tr>

2124

<td>

2125

2126

</td>

2127

<td>

2128

2129

<p>

2130

Get the input sample rate setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a37">FLAC__stream_encoder_get_sample_rate</a>().<dl compact><dt><b>

2131

Parameters: </b><dd>

2132

2133

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

2134

An encoder instance to query. </td></tr>

2135

</table>

2136

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

2137

Assertions:</b><dd>

2138

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

2139

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

2140

Return values: </b><dd>

2141

2142

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

2143

See <a class="el" href="group__flac__seekable__stream__encoder.html#a12">FLAC__seekable_stream_encoder_set_sample_rate</a>(). </td></tr>

2144

</table>

2145

</dl> </td>

2146

</tr>

2147

</table>

2148

2149

2150

<tr>

2151

2152

2153

<tr>

2154

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_blocksize </td>

2155

2156

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2157

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

2158

2159

2160

</tr>

2161

2162

</table>

2163

</td>

2164

</tr>

2165

</table>

2166

2167

<tr>

2168

<td>

2169

2170

</td>

2171

<td>

2172

2173

<p>

2174

Get the blocksize setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a38">FLAC__stream_encoder_get_blocksize</a>().<dl compact><dt><b>

2175

Parameters: </b><dd>

2176

2177

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

2178

An encoder instance to query. </td></tr>

2179

</table>

2180

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

2181

Assertions:</b><dd>

2182

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

2183

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

2184

Return values: </b><dd>

2185

2186

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

2187

See <a class="el" href="group__flac__seekable__stream__encoder.html#a13">FLAC__seekable_stream_encoder_set_blocksize</a>(). </td></tr>

2188

</table>

2189

</dl> </td>

2190

</tr>

2191

</table>

2192

2193

2194

<tr>

2195

2196

2197

<tr>

2198

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_max_lpc_order </td>

2199

2200

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2201

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

2202

2203

2204

</tr>

2205

2206

</table>

2207

</td>

2208

</tr>

2209

</table>

2210

2211

<tr>

2212

<td>

2213

2214

</td>

2215

<td>

2216

2217

<p>

2218

Get the maximum LPC order setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a39">FLAC__stream_encoder_get_max_lpc_order</a>().<dl compact><dt><b>

2219

Parameters: </b><dd>

2220

2221

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

2222

An encoder instance to query. </td></tr>

2223

</table>

2224

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

2225

Assertions:</b><dd>

2226

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

2227

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

2228

Return values: </b><dd>

2229

2230

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

2231

See <a class="el" href="group__flac__seekable__stream__encoder.html#a14">FLAC__seekable_stream_encoder_set_max_lpc_order</a>(). </td></tr>

2232

</table>

2233

</dl> </td>

2234

</tr>

2235

</table>

2236

2237

2238

<tr>

2239

2240

2241

<tr>

2242

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_qlp_coeff_precision </td>

2243

2244

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2245

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

2246

2247

2248

</tr>

2249

2250

</table>

2251

</td>

2252

</tr>

2253

</table>

2254

2255

<tr>

2256

<td>

2257

2258

</td>

2259

<td>

2260

2261

<p>

2262

Get the quantized linear predictor coefficient precision setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a40">FLAC__stream_encoder_get_qlp_coeff_precision</a>().<dl compact><dt><b>

2263

Parameters: </b><dd>

2264

2265

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

2266

An encoder instance to query. </td></tr>

2267

</table>

2268

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

2269

Assertions:</b><dd>

2270

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

2271

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

2272

Return values: </b><dd>

2273

2274

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

2275

See <a class="el" href="group__flac__seekable__stream__encoder.html#a15">FLAC__seekable_stream_encoder_set_qlp_coeff_precision</a>(). </td></tr>

2276

</table>

2277

</dl> </td>

2278

</tr>

2279

</table>

2280

2281

2282

<tr>

2283

2284

2285

<tr>

2286

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

2287

2288

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2289

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

2290

2291

2292

</tr>

2293

2294

</table>

2295

</td>

2296

</tr>

2297

</table>

2298

2299

<tr>

2300

<td>

2301

2302

</td>

2303

<td>

2304

2305

<p>

2306

Get the qlp coefficient precision search flag. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a41">FLAC__stream_encoder_get_do_qlp_coeff_prec_search</a>().<dl compact><dt><b>

2307

Parameters: </b><dd>

2308

2309

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

2310

An encoder instance to query. </td></tr>

2311

</table>

2312

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

2313

Assertions:</b><dd>

2314

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

2315

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

2316

Return values: </b><dd>

2317

2318

2319

See <a class="el" href="group__flac__seekable__stream__encoder.html#a16">FLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search</a>(). </td></tr>

2320

</table>

2321

</dl> </td>

2322

</tr>

2323

</table>

2324

2325

2326

<tr>

2327

2328

2329

<tr>

2330

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

2331

2332

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2333

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

2334

2335

2336

</tr>

2337

2338

</table>

2339

</td>

2340

</tr>

2341

</table>

2342

2343

<tr>

2344

<td>

2345

2346

</td>

2347

<td>

2348

2349

<p>

2350

Get the "escape coding" flag. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a42">FLAC__stream_encoder_get_do_escape_coding</a>().<dl compact><dt><b>

2351

Parameters: </b><dd>

2352

2353

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

2354

An encoder instance to query. </td></tr>

2355

</table>

2356

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

2357

Assertions:</b><dd>

2358

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

2359

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

2360

Return values: </b><dd>

2361

2362

2363

See <a class="el" href="group__flac__seekable__stream__encoder.html#a17">FLAC__seekable_stream_encoder_set_do_escape_coding</a>(). </td></tr>

2364

</table>

2365

</dl> </td>

2366

</tr>

2367

</table>

2368

2369

2370

<tr>

2371

2372

2373

<tr>

2374

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

2375

2376

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2377

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

2378

2379

2380

</tr>

2381

2382

</table>

2383

</td>

2384

</tr>

2385

</table>

2386

2387

<tr>

2388

<td>

2389

2390

</td>

2391

<td>

2392

2393

<p>

2394

Get the exhaustive model search flag. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a43">FLAC__stream_encoder_get_do_exhaustive_model_search</a>().<dl compact><dt><b>

2395

Parameters: </b><dd>

2396

2397

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

2398

An encoder instance to query. </td></tr>

2399

</table>

2400

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

2401

Assertions:</b><dd>

2402

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

2403

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

2404

Return values: </b><dd>

2405

2406

2407

See <a class="el" href="group__flac__seekable__stream__encoder.html#a18">FLAC__seekable_stream_encoder_set_do_exhaustive_model_search</a>(). </td></tr>

2408

</table>

2409

</dl> </td>

2410

</tr>

2411

</table>

2412

2413

2414

<tr>

2415

2416

2417

<tr>

2418

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_min_residual_partition_order </td>

2419

2420

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2421

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

2422

2423

2424

</tr>

2425

2426

</table>

2427

</td>

2428

</tr>

2429

</table>

2430

2431

<tr>

2432

<td>

2433

2434

</td>

2435

<td>

2436

2437

<p>

2438

Get the minimum residual partition order setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a44">FLAC__stream_encoder_get_min_residual_partition_order</a>().<dl compact><dt><b>

2439

Parameters: </b><dd>

2440

2441

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

2442

An encoder instance to query. </td></tr>

2443

</table>

2444

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

2445

Assertions:</b><dd>

2446

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

2447

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

2448

Return values: </b><dd>

2449

2450

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

2451

See <a class="el" href="group__flac__seekable__stream__encoder.html#a19">FLAC__seekable_stream_encoder_set_min_residual_partition_order</a>(). </td></tr>

2452

</table>

2453

</dl> </td>

2454

</tr>

2455

</table>

2456

2457

2458

<tr>

2459

2460

2461

<tr>

2462

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_max_residual_partition_order </td>

2463

2464

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2465

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

2466

2467

2468

</tr>

2469

2470

</table>

2471

</td>

2472

</tr>

2473

</table>

2474

2475

<tr>

2476

<td>

2477

2478

</td>

2479

<td>

2480

2481

<p>

2482

Get maximum residual partition order setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a45">FLAC__stream_encoder_get_max_residual_partition_order</a>().<dl compact><dt><b>

2483

Parameters: </b><dd>

2484

2485

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

2486

An encoder instance to query. </td></tr>

2487

</table>

2488

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

2489

Assertions:</b><dd>

2490

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

2491

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

2492

Return values: </b><dd>

2493

2494

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

2495

See <a class="el" href="group__flac__seekable__stream__encoder.html#a20">FLAC__seekable_stream_encoder_set_max_residual_partition_order</a>(). </td></tr>

2496

</table>

2497

</dl> </td>

2498

</tr>

2499

</table>

2500

2501

2502

<tr>

2503

2504

2505

<tr>

2506

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_encoder_get_rice_parameter_search_dist </td>

2507

2508

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2509

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

2510

2511

2512

</tr>

2513

2514

</table>

2515

</td>

2516

</tr>

2517

</table>

2518

2519

<tr>

2520

<td>

2521

2522

</td>

2523

<td>

2524

2525

<p>

2526

Get the Rice parameter search distance setting. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a46">FLAC__stream_encoder_get_rice_parameter_search_dist</a>().<dl compact><dt><b>

2527

Parameters: </b><dd>

2528

2529

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

2530

An encoder instance to query. </td></tr>

2531

</table>

2532

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

2533

Assertions:</b><dd>

2534

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

2535

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

2536

Return values: </b><dd>

2537

2538

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

2539

See <a class="el" href="group__flac__seekable__stream__encoder.html#a21">FLAC__seekable_stream_encoder_set_rice_parameter_search_dist</a>(). </td></tr>

2540

</table>

2541

</dl> </td>

2542

</tr>

2543

</table>

2544

2545

2546

<tr>

2547

2548

2549

<tr>

2550

<td class="md" nowrap valign="top"> FLAC__uint64 FLAC__seekable_stream_encoder_get_total_samples_estimate </td>

2551

2552

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2553

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

2554

2555

2556

</tr>

2557

2558

</table>

2559

</td>

2560

</tr>

2561

</table>

2562

2563

<tr>

2564

<td>

2565

2566

</td>

2567

<td>

2568

2569

<p>

2570

Get the previously set estimate of the total samples to be encoded. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a47">FLAC__stream_encoder_get_total_samples_estimate</a>().<dl compact><dt><b>

2571

Parameters: </b><dd>

2572

2573

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

2574

An encoder instance to query. </td></tr>

2575

</table>

2576

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

2577

Assertions:</b><dd>

2578

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

2579

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

2580

Return values: </b><dd>

2581

2582

2583

See <a class="el" href="group__flac__seekable__stream__encoder.html#a22">FLAC__seekable_stream_encoder_set_total_samples_estimate</a>(). </td></tr>

2584

</table>

2585

</dl> </td>

2586

</tr>

2587

</table>

2588

2589

2590

<tr>

2591

2592

2593

<tr>

2594

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__seekable__stream__encoder.html#a53">FLAC__SeekableStreamEncoderState</a> FLAC__seekable_stream_encoder_init </td>

2595

2596

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2597

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

2598

2599

2600

</tr>

2601

2602

</table>

2603

</td>

2604

</tr>

2605

</table>

2606

2607

<tr>

2608

<td>

2609

2610

</td>

2611

<td>

2612

2613

<p>

2614

Initialize the encoder instance. Should be called after <a class="el" href="group__flac__seekable__stream__encoder.html#a4">FLAC__seekable_stream_encoder_new</a>() and FLAC__seekable_stream_encoder_set_*() but before <a class="el" href="group__flac__seekable__stream__encoder.html#a51">FLAC__seekable_stream_encoder_process</a>() or <a class="el" href="group__flac__seekable__stream__encoder.html#a52">FLAC__seekable_stream_encoder_process_interleaved</a>(). Will set and return the encoder state, which will be FLAC__SEEKABLE_STREAM_ENCODER_OK if initialization succeeded.

2615

<p>

2616

The call to <a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_init</a>() currently will also immediately call the write callback with the <code>fLaC</code> signature and all the encoded metadata.<dl compact><dt><b>

2617

Parameters: </b><dd>

2618

2619

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

2620

An uninitialized encoder instance. </td></tr>

2621

</table>

2622

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

2623

Assertions:</b><dd>

2624

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

2625

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

2626

Return values: </b><dd>

2627

2628

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

2629

<code>FLAC__SEEKABLE_STREAM_ENCODER_OK</code> if initialization was successful; see FLAC__SeekableStreamEncoderState for the meanings of other return values. </td></tr>

2630

</table>

2631

</dl> </td>

2632

</tr>

2633

</table>

2634

2635

2636

<tr>

2637

2638

2639

<tr>

2640

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

2641

2642

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2643

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

2644

2645

2646

</tr>

2647

2648

</table>

2649

</td>

2650

</tr>

2651

</table>

2652

2653

<tr>

2654

<td>

2655

2656

</td>

2657

<td>

2658

2659

<p>

2660

Finish the encoding process. Flushes the encoding buffer, releases resources, resets the encoder settings to their defaults, and returns the encoder state to FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED.

2661

<p>

2662

In the event of a prematurely-terminated encode, it is not strictly necessary to call this immediately before <a class="el" href="group__flac__seekable__stream__encoder.html#a5">FLAC__seekable_stream_encoder_delete</a>() but it is good practice to match every <a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_init</a>() with a <a class="el" href="group__flac__seekable__stream__encoder.html#a50">FLAC__seekable_stream_encoder_finish</a>().<dl compact><dt><b>

2663

Parameters: </b><dd>

2664

2665

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

2666

An uninitialized encoder instance. </td></tr>

2667

</table>

2668

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

2669

Assertions:</b><dd>

2670

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

2671

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

2672

</tr>

2673

</table>

2674

2675

2676

<tr>

2677

2678

2679

<tr>

2680

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

2681

2682

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2683

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

2684

</tr>

2685

<tr>

2686

2687

2688

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

2689

<td class="mdname" nowrap>  <em>buffer</em>[], </td>

2690

</tr>

2691

<tr>

2692

2693

2694

<td class="md" nowrap>unsigned </td>

2695

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

2696

</tr>

2697

<tr>

2698

2699

2700

2701

</tr>

2702

2703

</table>

2704

</td>

2705

</tr>

2706

</table>

2707

2708

<tr>

2709

<td>

2710

2711

</td>

2712

<td>

2713

2714

<p>

2715

Submit data for encoding. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a50">FLAC__stream_encoder_process</a>().<dl compact><dt><b>

2716

Parameters: </b><dd>

2717

2718

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

2719

An initialized encoder instance in the OK state. </td></tr>

2720

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

2721

An array of pointers to each channel's signal. </td></tr>

2722

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

2723

The number of samples in one channel. </td></tr>

2724

</table>

2725

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

2726

Assertions:</b><dd>

2727

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

2728

</pre></div> <div class="fragment"><pre><a class="code" href="seekable__stream__encoder_8h.html#a27">FLAC__seekable_stream_encoder_get_state</a>(encoder) == <a class="code" href="seekable__stream__encoder_8h.html#a53a4">FLAC__SEEKABLE_STREAM_ENCODER_OK</a>

2729

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

2730

Return values: </b><dd>

2731

2732

2733

<code>true</code> if successful, else <code>false</code>; in this case, check the encoder state with <a class="el" href="group__flac__seekable__stream__encoder.html#a27">FLAC__seekable_stream_encoder_get_state</a>() to see what went wrong. </td></tr>

2734

</table>

2735

</dl> </td>

2736

</tr>

2737

</table>

2738

2739

2740

<tr>

2741

2742

2743

<tr>

2744

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

2745

2746

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a> * </td>

2747

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

2748

</tr>

2749

<tr>

2750

2751

2752

<td class="md" nowrap>const FLAC__int32 </td>

2753

<td class="mdname" nowrap>  <em>buffer</em>[], </td>

2754

</tr>

2755

<tr>

2756

2757

2758

<td class="md" nowrap>unsigned </td>

2759

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

2760

</tr>

2761

<tr>

2762

2763

2764

2765

</tr>

2766

2767

</table>

2768

</td>

2769

</tr>

2770

</table>

2771

2772

<tr>

2773

<td>

2774

2775

</td>

2776

<td>

2777

2778

<p>

2779

Submit data for encoding. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a51">FLAC__stream_encoder_process_interleaved</a>().<dl compact><dt><b>

2780

Parameters: </b><dd>

2781

2782

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

2783

An initialized encoder instance in the OK state. </td></tr>

2784

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

2785

An array of channel-interleaved data (see above). </td></tr>

2786

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

2787

The number of samples in one channel, the same as for <a class="el" href="group__flac__seekable__stream__encoder.html#a51">FLAC__seekable_stream_encoder_process</a>(). For example, if encoding two channels, <code>1000</code> <em>samples</em> corresponds to a <em>buffer</em> of 2000 values. </td></tr>

2788

</table>

2789

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

2790

Assertions:</b><dd>

2791

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

2792

2793

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

2794

Return values: </b><dd>

2795

2796

2797

2798

</table>

2799

</dl> </td>

2800

</tr>

2801

</table>

2802

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

2803

2804

2805

<tr>

2806

2807

2808

<tr>

2809

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

2810

</table>

2811

</td>

2812

</tr>

2813

</table>

2814

2815

<tr>

2816

<td>

2817

2818

</td>

2819

<td>

2820

2821

<p>

2822

Maps a FLAC__SeekableStreamEncoderState to a C string.

2823

<p>

2824

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

2825

</tr>

2826

</table>

2827

2828

2829

<tr>

2830

2831

2832

<tr>

2833

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

2834

</table>

2835

</td>

2836

</tr>

2837

</table>

2838

2839

<tr>

2840

<td>

2841

2842

</td>

2843

<td>

2844

2845

<p>

2846

Maps a FLAC__SeekableStreamEncoderSeekStatus to a C string.

2847

<p>

2848

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

2849

</tr>

2850

</table>

2851

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

2852

2853

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

2854

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

2855

2856

</body>

2857

</html>

Older »