1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
<title>file_encoder.h File Reference</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
<!-- Generated by Doxygen 1.2.14 -->
8
<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>
9
<hr><h1>include/FLAC/file_encoder.h File Reference</h1>This module contains the functions which implement the file encoder.
10
<a href="#_details">More...</a>
12
<code>#include "export.h"</code><br>
13
<code>#include "<a class="el" href="FLAC_2seekable__stream__encoder_8h-source.html">seekable_stream_encoder.h</a>"</code><br>
16
<a href="FLAC_2file__encoder_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
17
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
18
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a></td></tr>
19
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
20
<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a1">FLAC__FileEncoderProgressCallback</a> )(const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data)</td></tr>
21
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
22
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a> { <br>
23
<a class="el" href="group__flac__file__encoder.html#a52a2">FLAC__FILE_ENCODER_OK</a> = 0,
24
<a class="el" href="group__flac__file__encoder.html#a52a3">FLAC__FILE_ENCODER_NO_FILENAME</a>,
25
<a class="el" href="group__flac__file__encoder.html#a52a4">FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</a>,
26
<a class="el" href="group__flac__file__encoder.html#a52a5">FLAC__FILE_ENCODER_FATAL_ERROR_WHILE_WRITING</a>,
28
<a class="el" href="group__flac__file__encoder.html#a52a6">FLAC__FILE_ENCODER_ERROR_OPENING_FILE</a>,
29
<a class="el" href="group__flac__file__encoder.html#a52a7">FLAC__FILE_ENCODER_MEMORY_ALLOCATION_ERROR</a>,
30
<a class="el" href="group__flac__file__encoder.html#a52a8">FLAC__FILE_ENCODER_ALREADY_INITIALIZED</a>,
31
<a class="el" href="group__flac__file__encoder.html#a52a9">FLAC__FILE_ENCODER_UNINITIALIZED</a>
34
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
35
<tr><td nowrap align=right valign=top><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> * </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a2">FLAC__file_encoder_new</a> ()</td></tr>
36
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a3">FLAC__file_encoder_delete</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
37
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a4">FLAC__file_encoder_set_verify</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
38
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a5">FLAC__file_encoder_set_streamable_subset</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
39
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a6">FLAC__file_encoder_set_do_mid_side_stereo</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
40
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a7">FLAC__file_encoder_set_loose_mid_side_stereo</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
41
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a8">FLAC__file_encoder_set_channels</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
42
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a9">FLAC__file_encoder_set_bits_per_sample</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
43
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a10">FLAC__file_encoder_set_sample_rate</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
44
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a11">FLAC__file_encoder_set_blocksize</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
45
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a12">FLAC__file_encoder_set_max_lpc_order</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
46
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a13">FLAC__file_encoder_set_qlp_coeff_precision</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
47
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a14">FLAC__file_encoder_set_do_qlp_coeff_prec_search</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
48
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a15">FLAC__file_encoder_set_do_escape_coding</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
49
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a16">FLAC__file_encoder_set_do_exhaustive_model_search</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
50
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a17">FLAC__file_encoder_set_min_residual_partition_order</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
51
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a18">FLAC__file_encoder_set_max_residual_partition_order</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
52
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a19">FLAC__file_encoder_set_rice_parameter_search_dist</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
53
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a20">FLAC__file_encoder_set_total_samples_estimate</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 value)</td></tr>
54
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a21">FLAC__file_encoder_set_metadata</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, unsigned num_blocks)</td></tr>
55
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a22">FLAC__file_encoder_set_filename</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const char *value)</td></tr>
56
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a23">FLAC__file_encoder_set_progress_callback</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, <a class="el" href="group__flac__file__encoder.html#a1">FLAC__FileEncoderProgressCallback</a> value)</td></tr>
57
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a24">FLAC__file_encoder_set_client_data</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, void *value)</td></tr>
58
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a> </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a25">FLAC__file_encoder_get_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
59
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__encoder.html#a56">FLAC__SeekableStreamEncoderState</a> </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a26">FLAC__file_encoder_get_seekable_stream_encoder_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
60
<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__file__encoder.html#a27">FLAC__file_encoder_get_stream_encoder_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
61
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a> </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a28">FLAC__file_encoder_get_verify_decoder_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
62
<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a29">FLAC__file_encoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
63
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a30">FLAC__file_encoder_get_verify_decoder_error_stats</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got)</td></tr>
64
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a31">FLAC__file_encoder_get_verify</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
65
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a32">FLAC__file_encoder_get_streamable_subset</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
66
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a33">FLAC__file_encoder_get_do_mid_side_stereo</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
67
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a34">FLAC__file_encoder_get_loose_mid_side_stereo</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
68
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a35">FLAC__file_encoder_get_channels</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
69
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a36">FLAC__file_encoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
70
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a37">FLAC__file_encoder_get_sample_rate</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
71
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a38">FLAC__file_encoder_get_blocksize</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
72
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a39">FLAC__file_encoder_get_max_lpc_order</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
73
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a40">FLAC__file_encoder_get_qlp_coeff_precision</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
74
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a41">FLAC__file_encoder_get_do_qlp_coeff_prec_search</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
75
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a42">FLAC__file_encoder_get_do_escape_coding</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
76
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a43">FLAC__file_encoder_get_do_exhaustive_model_search</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
77
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a44">FLAC__file_encoder_get_min_residual_partition_order</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
78
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a45">FLAC__file_encoder_get_max_residual_partition_order</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
79
<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a46">FLAC__file_encoder_get_rice_parameter_search_dist</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
80
<tr><td nowrap align=right valign=top>FLAC__uint64 </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a47">FLAC__file_encoder_get_total_samples_estimate</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
81
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a> </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a48">FLAC__file_encoder_init</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
82
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a49">FLAC__file_encoder_finish</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
83
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a50">FLAC__file_encoder_process</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const FLAC__int32 *const buffer[], unsigned samples)</td></tr>
84
<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a51">FLAC__file_encoder_process_interleaved</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const FLAC__int32 buffer[], unsigned samples)</td></tr>
85
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
86
<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a0">FLAC__FileEncoderStateString</a> []</td></tr>
88
<hr><a name="_details"></a><h2>Detailed Description</h2>
89
This module contains the functions which implement the file encoder.
95
See the detailed documentation in the <a class="el" href="group__flac__file__encoder.html">file encoder</a> module.
97
<hr><address><small>Generated on Fri Feb 4 18:39:11 2005 for FLAC by
98
<a href="http://www.doxygen.org/index.html">
99
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
100
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
101
© 1997-2002</small></address>