667a3cb69fbee39451d8f43f2968e24e8fbc21bc
[flac.git] / src / libFLAC / stream_encoder.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002,2003,2004,2005,2006  Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #if HAVE_CONFIG_H
33 #  include <config.h>
34 #endif
35
36 #if defined _MSC_VER || defined __MINGW32__
37 #include <io.h> /* for _setmode() */
38 #include <fcntl.h> /* for _O_BINARY */
39 #endif
40 #if defined __CYGWIN__ || defined __EMX__
41 #include <io.h> /* for setmode(), O_BINARY */
42 #include <fcntl.h> /* for _O_BINARY */
43 #endif
44 #include <limits.h>
45 #include <stdio.h>
46 #include <stdlib.h> /* for malloc() */
47 #include <string.h> /* for memcpy() */
48 #include <sys/types.h> /* for off_t */
49 #if defined _MSC_VER || defined __BORLANDC__ || defined __MINGW32__
50 #if _MSC_VER <= 1600 || defined __BORLANDC__ /* @@@ [2G limit] */
51 #define fseeko fseek
52 #define ftello ftell
53 #endif
54 #endif
55 #include "FLAC/assert.h"
56 #include "FLAC/stream_decoder.h"
57 #include "protected/stream_encoder.h"
58 #include "private/bitwriter.h"
59 #include "private/bitmath.h"
60 #include "private/crc.h"
61 #include "private/cpu.h"
62 #include "private/fixed.h"
63 #include "private/format.h"
64 #include "private/lpc.h"
65 #include "private/md5.h"
66 #include "private/memory.h"
67 #if FLAC__HAS_OGG
68 #include "private/ogg_helper.h"
69 #include "private/ogg_mapping.h"
70 #endif
71 #include "private/stream_encoder_framing.h"
72 #include "private/window.h"
73
74 #ifdef min
75 #undef min
76 #endif
77 #define min(x,y) ((x)<(y)?(x):(y))
78
79 #ifdef max
80 #undef max
81 #endif
82 #define max(x,y) ((x)>(y)?(x):(y))
83
84 /* Exact Rice codeword length calculation is off by default.  The simple
85  * (and fast) estimation (of how many bits a residual value will be
86  * encoded with) in this encoder is very good, almost always yielding
87  * compression within 0.1% of exact calculation.
88  */
89 #undef EXACT_RICE_BITS_CALCULATION
90 /* Rice parameter searching is off by default.  The simple (and fast)
91  * parameter estimation in this encoder is very good, almost always
92  * yielding compression within 0.1% of the optimal parameters.
93  */
94 #undef ENABLE_RICE_PARAMETER_SEARCH 
95
96 typedef struct {
97         FLAC__int32 *data[FLAC__MAX_CHANNELS];
98         unsigned size; /* of each data[] in samples */
99         unsigned tail;
100 } verify_input_fifo;
101
102 typedef struct {
103         const FLAC__byte *data;
104         unsigned capacity;
105         unsigned bytes;
106 } verify_output;
107
108 typedef enum {
109         ENCODER_IN_MAGIC = 0,
110         ENCODER_IN_METADATA = 1,
111         ENCODER_IN_AUDIO = 2
112 } EncoderStateHint;
113
114 static struct CompressionLevels {
115         FLAC__bool do_mid_side_stereo;
116         FLAC__bool loose_mid_side_stereo;
117         unsigned max_lpc_order;
118         unsigned qlp_coeff_precision;
119         FLAC__bool do_qlp_coeff_prec_search;
120         FLAC__bool do_escape_coding;
121         FLAC__bool do_exhaustive_model_search;
122         unsigned min_residual_partition_order;
123         unsigned max_residual_partition_order;
124         unsigned rice_parameter_search_dist;
125 } compression_levels_[] = {
126         { false, false,  0, 0, false, false, false, 2, 2, 0 },
127         { true , true ,  0, 0, false, false, false, 2, 2, 0 },
128         { true , false,  0, 0, false, false, false, 0, 3, 0 },
129         { false, false,  6, 0, false, false, false, 3, 3, 0 },
130         { true , true ,  8, 0, false, false, false, 3, 3, 0 },
131         { true , false,  8, 0, false, false, false, 3, 3, 0 },
132         { true , false,  8, 0, false, false, false, 0, 4, 0 },
133         { true , false,  8, 0, false, false, true , 0, 6, 0 },
134         { true , false, 12, 0, false, false, true , 0, 6, 0 }
135 };
136
137
138 /***********************************************************************
139  *
140  * Private class method prototypes
141  *
142  ***********************************************************************/
143
144 static void set_defaults_(FLAC__StreamEncoder *encoder);
145 static void free_(FLAC__StreamEncoder *encoder);
146 static FLAC__bool resize_buffers_(FLAC__StreamEncoder *encoder, unsigned new_blocksize);
147 static FLAC__bool write_bitbuffer_(FLAC__StreamEncoder *encoder, unsigned samples, FLAC__bool is_last_block);
148 static FLAC__StreamEncoderWriteStatus write_frame_(FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, FLAC__bool is_last_block);
149 static void update_metadata_(const FLAC__StreamEncoder *encoder);
150 #if FLAC__HAS_OGG
151 static void update_ogg_metadata_(FLAC__StreamEncoder *encoder);
152 #endif
153 static FLAC__bool process_frame_(FLAC__StreamEncoder *encoder, FLAC__bool is_fractional_block, FLAC__bool is_last_block);
154 static FLAC__bool process_subframes_(FLAC__StreamEncoder *encoder, FLAC__bool is_fractional_block);
155
156 static FLAC__bool process_subframe_(
157         FLAC__StreamEncoder *encoder,
158         unsigned min_partition_order,
159         unsigned max_partition_order,
160         const FLAC__FrameHeader *frame_header,
161         unsigned subframe_bps,
162         const FLAC__int32 integer_signal[],
163 #ifndef FLAC__INTEGER_ONLY_LIBRARY
164         const FLAC__real real_signal[],
165 #endif
166         FLAC__Subframe *subframe[2],
167         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents[2],
168         FLAC__int32 *residual[2],
169         unsigned *best_subframe,
170         unsigned *best_bits
171 );
172
173 static FLAC__bool add_subframe_(
174         FLAC__StreamEncoder *encoder,
175         unsigned blocksize,
176         unsigned subframe_bps,
177         const FLAC__Subframe *subframe,
178         FLAC__BitWriter *frame
179 );
180
181 static unsigned evaluate_constant_subframe_(
182         FLAC__StreamEncoder *encoder,
183         const FLAC__int32 signal,
184         unsigned blocksize,
185         unsigned subframe_bps,
186         FLAC__Subframe *subframe
187 );
188
189 static unsigned evaluate_fixed_subframe_(
190         FLAC__StreamEncoder *encoder,
191         const FLAC__int32 signal[],
192         FLAC__int32 residual[],
193         FLAC__uint64 abs_residual_partition_sums[],
194         unsigned raw_bits_per_partition[],
195         unsigned blocksize,
196         unsigned subframe_bps,
197         unsigned order,
198         unsigned rice_parameter,
199         unsigned min_partition_order,
200         unsigned max_partition_order,
201         FLAC__bool do_escape_coding,
202         unsigned rice_parameter_search_dist,
203         FLAC__Subframe *subframe,
204         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents
205 );
206
207 #ifndef FLAC__INTEGER_ONLY_LIBRARY
208 static unsigned evaluate_lpc_subframe_(
209         FLAC__StreamEncoder *encoder,
210         const FLAC__int32 signal[],
211         FLAC__int32 residual[],
212         FLAC__uint64 abs_residual_partition_sums[],
213         unsigned raw_bits_per_partition[],
214         const FLAC__real lp_coeff[],
215         unsigned blocksize,
216         unsigned subframe_bps,
217         unsigned order,
218         unsigned qlp_coeff_precision,
219         unsigned rice_parameter,
220         unsigned min_partition_order,
221         unsigned max_partition_order,
222         FLAC__bool do_escape_coding,
223         unsigned rice_parameter_search_dist,
224         FLAC__Subframe *subframe,
225         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents
226 );
227 #endif
228
229 static unsigned evaluate_verbatim_subframe_(
230         FLAC__StreamEncoder *encoder, 
231         const FLAC__int32 signal[],
232         unsigned blocksize,
233         unsigned subframe_bps,
234         FLAC__Subframe *subframe
235 );
236
237 static unsigned find_best_partition_order_(
238         struct FLAC__StreamEncoderPrivate *private_,
239         const FLAC__int32 residual[],
240         FLAC__uint64 abs_residual_partition_sums[],
241         unsigned raw_bits_per_partition[],
242         unsigned residual_samples,
243         unsigned predictor_order,
244         unsigned rice_parameter,
245         unsigned min_partition_order,
246         unsigned max_partition_order,
247         FLAC__bool do_escape_coding,
248         unsigned rice_parameter_search_dist,
249         FLAC__EntropyCodingMethod_PartitionedRice *best_partitioned_rice
250 );
251
252 static void precompute_partition_info_sums_(
253         const FLAC__int32 residual[],
254         FLAC__uint64 abs_residual_partition_sums[],
255         unsigned residual_samples,
256         unsigned predictor_order,
257         unsigned min_partition_order,
258         unsigned max_partition_order
259 );
260
261 static void precompute_partition_info_escapes_(
262         const FLAC__int32 residual[],
263         unsigned raw_bits_per_partition[],
264         unsigned residual_samples,
265         unsigned predictor_order,
266         unsigned min_partition_order,
267         unsigned max_partition_order
268 );
269
270 static FLAC__bool set_partitioned_rice_(
271 #ifdef EXACT_RICE_BITS_CALCULATION
272         const FLAC__int32 residual[],
273 #endif
274         const FLAC__uint64 abs_residual_partition_sums[],
275         const unsigned raw_bits_per_partition[],
276         const unsigned residual_samples,
277         const unsigned predictor_order,
278         const unsigned suggested_rice_parameter,
279         const unsigned rice_parameter_search_dist,
280         const unsigned partition_order,
281         const FLAC__bool search_for_escapes,
282         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents,
283         unsigned *bits
284 );
285
286 static unsigned get_wasted_bits_(FLAC__int32 signal[], unsigned samples);
287
288 /* verify-related routines: */
289 static void append_to_verify_fifo_(
290         verify_input_fifo *fifo,
291         const FLAC__int32 * const input[],
292         unsigned input_offset,
293         unsigned channels,
294         unsigned wide_samples
295 );
296
297 static void append_to_verify_fifo_interleaved_(
298         verify_input_fifo *fifo,
299         const FLAC__int32 input[],
300         unsigned input_offset,
301         unsigned channels,
302         unsigned wide_samples
303 );
304
305 static FLAC__StreamDecoderReadStatus verify_read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
306 static FLAC__StreamDecoderWriteStatus verify_write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
307 static void verify_metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
308 static void verify_error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
309
310 static FLAC__StreamEncoderReadStatus file_read_callback_(const FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
311 static FLAC__StreamEncoderSeekStatus file_seek_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
312 static FLAC__StreamEncoderTellStatus file_tell_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
313 static FLAC__StreamEncoderWriteStatus file_write_callback_(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame, void *client_data);
314 static FILE *get_binary_stdout_(void);
315
316
317 /***********************************************************************
318  *
319  * Private class data
320  *
321  ***********************************************************************/
322
323 typedef struct FLAC__StreamEncoderPrivate {
324         unsigned input_capacity;                          /* current size (in samples) of the signal and residual buffers */
325         FLAC__int32 *integer_signal[FLAC__MAX_CHANNELS];  /* the integer version of the input signal */
326         FLAC__int32 *integer_signal_mid_side[2];          /* the integer version of the mid-side input signal (stereo only) */
327 #ifndef FLAC__INTEGER_ONLY_LIBRARY
328         FLAC__real *real_signal[FLAC__MAX_CHANNELS];      /* the floating-point version of the input signal */
329         FLAC__real *real_signal_mid_side[2];              /* the floating-point version of the mid-side input signal (stereo only) */
330         FLAC__real *window[FLAC__MAX_APODIZATION_FUNCTIONS]; /* the pre-computed floating-point window for each apodization function */
331         FLAC__real *windowed_signal;                      /* the real_signal[] * current window[] */
332 #endif
333         unsigned subframe_bps[FLAC__MAX_CHANNELS];        /* the effective bits per sample of the input signal (stream bps - wasted bits) */
334         unsigned subframe_bps_mid_side[2];                /* the effective bits per sample of the mid-side input signal (stream bps - wasted bits + 0/1) */
335         FLAC__int32 *residual_workspace[FLAC__MAX_CHANNELS][2]; /* each channel has a candidate and best workspace where the subframe residual signals will be stored */
336         FLAC__int32 *residual_workspace_mid_side[2][2];
337         FLAC__Subframe subframe_workspace[FLAC__MAX_CHANNELS][2];
338         FLAC__Subframe subframe_workspace_mid_side[2][2];
339         FLAC__Subframe *subframe_workspace_ptr[FLAC__MAX_CHANNELS][2];
340         FLAC__Subframe *subframe_workspace_ptr_mid_side[2][2];
341         FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents_workspace[FLAC__MAX_CHANNELS][2];
342         FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents_workspace_mid_side[FLAC__MAX_CHANNELS][2];
343         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents_workspace_ptr[FLAC__MAX_CHANNELS][2];
344         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents_workspace_ptr_mid_side[FLAC__MAX_CHANNELS][2];
345         unsigned best_subframe[FLAC__MAX_CHANNELS];       /* index (0 or 1) into 2nd dimension of the above workspaces */
346         unsigned best_subframe_mid_side[2];
347         unsigned best_subframe_bits[FLAC__MAX_CHANNELS];  /* size in bits of the best subframe for each channel */
348         unsigned best_subframe_bits_mid_side[2];
349         FLAC__uint64 *abs_residual_partition_sums;        /* workspace where the sum of abs(candidate residual) for each partition is stored */
350         unsigned *raw_bits_per_partition;                 /* workspace where the sum of silog2(candidate residual) for each partition is stored */
351         FLAC__BitWriter *frame;                           /* the current frame being worked on */
352         unsigned loose_mid_side_stereo_frames;            /* rounded number of frames the encoder will use before trying both independent and mid/side frames again */
353         unsigned loose_mid_side_stereo_frame_count;       /* number of frames using the current channel assignment */
354         FLAC__ChannelAssignment last_channel_assignment;
355         FLAC__StreamMetadata streaminfo;                  /* scratchpad for STREAMINFO as it is built */
356         FLAC__StreamMetadata_SeekTable *seek_table;       /* pointer into encoder->protected_->metadata_ where the seek table is */
357         unsigned current_sample_number;
358         unsigned current_frame_number;
359         struct FLAC__MD5Context md5context;
360         FLAC__CPUInfo cpuinfo;
361 #ifndef FLAC__INTEGER_ONLY_LIBRARY
362         unsigned (*local_fixed_compute_best_predictor)(const FLAC__int32 data[], unsigned data_len, FLAC__float residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
363 #else
364         unsigned (*local_fixed_compute_best_predictor)(const FLAC__int32 data[], unsigned data_len, FLAC__fixedpoint residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
365 #endif
366 #ifndef FLAC__INTEGER_ONLY_LIBRARY
367         void (*local_lpc_compute_autocorrelation)(const FLAC__real data[], unsigned data_len, unsigned lag, FLAC__real autoc[]);
368         void (*local_lpc_compute_residual_from_qlp_coefficients)(const FLAC__int32 *data, unsigned data_len, const FLAC__int32 qlp_coeff[], unsigned order, int lp_quantization, FLAC__int32 residual[]);
369         void (*local_lpc_compute_residual_from_qlp_coefficients_64bit)(const FLAC__int32 *data, unsigned data_len, const FLAC__int32 qlp_coeff[], unsigned order, int lp_quantization, FLAC__int32 residual[]);
370         void (*local_lpc_compute_residual_from_qlp_coefficients_16bit)(const FLAC__int32 *data, unsigned data_len, const FLAC__int32 qlp_coeff[], unsigned order, int lp_quantization, FLAC__int32 residual[]);
371 #endif
372         FLAC__bool use_wide_by_block;          /* use slow 64-bit versions of some functions because of the block size */
373         FLAC__bool use_wide_by_partition;      /* use slow 64-bit versions of some functions because of the min partition order and blocksize */
374         FLAC__bool use_wide_by_order;          /* use slow 64-bit versions of some functions because of the lpc order */
375         FLAC__bool disable_constant_subframes;
376         FLAC__bool disable_fixed_subframes;
377         FLAC__bool disable_verbatim_subframes;
378 #if FLAC__HAS_OGG
379         FLAC__bool is_ogg;
380 #endif
381         FLAC__StreamEncoderReadCallback read_callback; /* currently only needed for Ogg FLAC */
382         FLAC__StreamEncoderSeekCallback seek_callback;
383         FLAC__StreamEncoderTellCallback tell_callback;
384         FLAC__StreamEncoderWriteCallback write_callback;
385         FLAC__StreamEncoderMetadataCallback metadata_callback;
386         FLAC__StreamEncoderProgressCallback progress_callback;
387         void *client_data;
388         unsigned first_seekpoint_to_check;
389         FILE *file;                            /* only used when encoding to a file */
390         FLAC__uint64 bytes_written;
391         FLAC__uint64 samples_written;
392         unsigned frames_written;
393         unsigned total_frames_estimate;
394         /* unaligned (original) pointers to allocated data */
395         FLAC__int32 *integer_signal_unaligned[FLAC__MAX_CHANNELS];
396         FLAC__int32 *integer_signal_mid_side_unaligned[2];
397 #ifndef FLAC__INTEGER_ONLY_LIBRARY
398         FLAC__real *real_signal_unaligned[FLAC__MAX_CHANNELS];
399         FLAC__real *real_signal_mid_side_unaligned[2];
400         FLAC__real *window_unaligned[FLAC__MAX_APODIZATION_FUNCTIONS];
401         FLAC__real *windowed_signal_unaligned;
402 #endif
403         FLAC__int32 *residual_workspace_unaligned[FLAC__MAX_CHANNELS][2];
404         FLAC__int32 *residual_workspace_mid_side_unaligned[2][2];
405         FLAC__uint64 *abs_residual_partition_sums_unaligned;
406         unsigned *raw_bits_per_partition_unaligned;
407         /*
408          * These fields have been moved here from private function local
409          * declarations merely to save stack space during encoding.
410          */
411 #ifndef FLAC__INTEGER_ONLY_LIBRARY
412         FLAC__real lp_coeff[FLAC__MAX_LPC_ORDER][FLAC__MAX_LPC_ORDER]; /* from process_subframe_() */
413 #endif
414         FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents_extra[2]; /* from find_best_partition_order_() */
415         /*
416          * The data for the verify section
417          */
418         struct {
419                 FLAC__StreamDecoder *decoder;
420                 EncoderStateHint state_hint;
421                 FLAC__bool needs_magic_hack;
422                 verify_input_fifo input_fifo;
423                 verify_output output;
424                 struct {
425                         FLAC__uint64 absolute_sample;
426                         unsigned frame_number;
427                         unsigned channel;
428                         unsigned sample;
429                         FLAC__int32 expected;
430                         FLAC__int32 got;
431                 } error_stats;
432         } verify;
433         FLAC__bool is_being_deleted; /* if true, call to ..._finish() from ..._delete() will not call the callbacks */
434 } FLAC__StreamEncoderPrivate;
435
436 /***********************************************************************
437  *
438  * Public static class data
439  *
440  ***********************************************************************/
441
442 FLAC_API const char * const FLAC__StreamEncoderStateString[] = {
443         "FLAC__STREAM_ENCODER_OK",
444         "FLAC__STREAM_ENCODER_UNINITIALIZED",
445         "FLAC__STREAM_ENCODER_OGG_ERROR",
446         "FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR",
447         "FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA",
448         "FLAC__STREAM_ENCODER_CLIENT_ERROR",
449         "FLAC__STREAM_ENCODER_IO_ERROR",
450         "FLAC__STREAM_ENCODER_FRAMING_ERROR",
451         "FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR"
452 };
453
454 FLAC_API const char * const FLAC__StreamEncoderInitStatusString[] = {
455         "FLAC__STREAM_ENCODER_INIT_STATUS_OK",
456         "FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR",
457         "FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER",
458         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS",
459         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS",
460         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE",
461         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE",
462         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE",
463         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER",
464         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION",
465         "FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER",
466         "FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE",
467         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA",
468         "FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED"
469 };
470
471 FLAC_API const char * const FLAC__treamEncoderReadStatusString[] = {
472         "FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE",
473         "FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM",
474         "FLAC__STREAM_ENCODER_READ_STATUS_ABORT",
475         "FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED"
476 };
477
478 FLAC_API const char * const FLAC__StreamEncoderWriteStatusString[] = {
479         "FLAC__STREAM_ENCODER_WRITE_STATUS_OK",
480         "FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR"
481 };
482
483 FLAC_API const char * const FLAC__StreamEncoderSeekStatusString[] = {
484         "FLAC__STREAM_ENCODER_SEEK_STATUS_OK",
485         "FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR",
486         "FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED"
487 };
488
489 FLAC_API const char * const FLAC__StreamEncoderTellStatusString[] = {
490         "FLAC__STREAM_ENCODER_TELL_STATUS_OK",
491         "FLAC__STREAM_ENCODER_TELL_STATUS_ERROR",
492         "FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED"
493 };
494
495 /* Number of samples that will be overread to watch for end of stream.  By
496  * 'overread', we mean that the FLAC__stream_encoder_process*() calls will
497  * always try to read blocksize+1 samples before encoding a block, so that
498  * even if the stream has a total sample count that is an integral multiple
499  * of the blocksize, we will still notice when we are encoding the last
500  * block.  This is needed, for example, to correctly set the end-of-stream
501  * marker in Ogg FLAC.
502  *
503  * WATCHOUT: some parts of the code assert that OVERREAD_ == 1 and there's
504  * not really any reason to change it.
505  */
506 static const unsigned OVERREAD_ = 1;
507
508 /***********************************************************************
509  *
510  * Class constructor/destructor
511  *
512  */
513 FLAC_API FLAC__StreamEncoder *FLAC__stream_encoder_new(void)
514 {
515         FLAC__StreamEncoder *encoder;
516         unsigned i;
517
518         FLAC__ASSERT(sizeof(int) >= 4); /* we want to die right away if this is not true */
519
520         encoder = (FLAC__StreamEncoder*)calloc(1, sizeof(FLAC__StreamEncoder));
521         if(encoder == 0) {
522                 return 0;
523         }
524
525         encoder->protected_ = (FLAC__StreamEncoderProtected*)calloc(1, sizeof(FLAC__StreamEncoderProtected));
526         if(encoder->protected_ == 0) {
527                 free(encoder);
528                 return 0;
529         }
530
531         encoder->private_ = (FLAC__StreamEncoderPrivate*)calloc(1, sizeof(FLAC__StreamEncoderPrivate));
532         if(encoder->private_ == 0) {
533                 free(encoder->protected_);
534                 free(encoder);
535                 return 0;
536         }
537
538         encoder->private_->frame = FLAC__bitwriter_new();
539         if(encoder->private_->frame == 0) {
540                 free(encoder->private_);
541                 free(encoder->protected_);
542                 free(encoder);
543                 return 0;
544         }
545
546         encoder->private_->file = 0;
547
548         set_defaults_(encoder);
549
550         encoder->private_->is_being_deleted = false;
551
552         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
553                 encoder->private_->subframe_workspace_ptr[i][0] = &encoder->private_->subframe_workspace[i][0];
554                 encoder->private_->subframe_workspace_ptr[i][1] = &encoder->private_->subframe_workspace[i][1];
555         }
556         for(i = 0; i < 2; i++) {
557                 encoder->private_->subframe_workspace_ptr_mid_side[i][0] = &encoder->private_->subframe_workspace_mid_side[i][0];
558                 encoder->private_->subframe_workspace_ptr_mid_side[i][1] = &encoder->private_->subframe_workspace_mid_side[i][1];
559         }
560         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
561                 encoder->private_->partitioned_rice_contents_workspace_ptr[i][0] = &encoder->private_->partitioned_rice_contents_workspace[i][0];
562                 encoder->private_->partitioned_rice_contents_workspace_ptr[i][1] = &encoder->private_->partitioned_rice_contents_workspace[i][1];
563         }
564         for(i = 0; i < 2; i++) {
565                 encoder->private_->partitioned_rice_contents_workspace_ptr_mid_side[i][0] = &encoder->private_->partitioned_rice_contents_workspace_mid_side[i][0];
566                 encoder->private_->partitioned_rice_contents_workspace_ptr_mid_side[i][1] = &encoder->private_->partitioned_rice_contents_workspace_mid_side[i][1];
567         }
568
569         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
570                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_workspace[i][0]);
571                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_workspace[i][1]);
572         }
573         for(i = 0; i < 2; i++) {
574                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_workspace_mid_side[i][0]);
575                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_workspace_mid_side[i][1]);
576         }
577         for(i = 0; i < 2; i++)
578                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_extra[i]);
579
580         encoder->protected_->state = FLAC__STREAM_ENCODER_UNINITIALIZED;
581
582         return encoder;
583 }
584
585 FLAC_API void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder)
586 {
587         unsigned i;
588
589         FLAC__ASSERT(0 != encoder);
590         FLAC__ASSERT(0 != encoder->protected_);
591         FLAC__ASSERT(0 != encoder->private_);
592         FLAC__ASSERT(0 != encoder->private_->frame);
593
594         encoder->private_->is_being_deleted = true;
595
596         (void)FLAC__stream_encoder_finish(encoder);
597
598         if(0 != encoder->private_->verify.decoder)
599                 FLAC__stream_decoder_delete(encoder->private_->verify.decoder);
600
601         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
602                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_workspace[i][0]);
603                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_workspace[i][1]);
604         }
605         for(i = 0; i < 2; i++) {
606                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_workspace_mid_side[i][0]);
607                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_workspace_mid_side[i][1]);
608         }
609         for(i = 0; i < 2; i++)
610                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_extra[i]);
611
612         FLAC__bitwriter_delete(encoder->private_->frame);
613         free(encoder->private_);
614         free(encoder->protected_);
615         free(encoder);
616 }
617
618 /***********************************************************************
619  *
620  * Public class methods
621  *
622  ***********************************************************************/
623
624 static FLAC__StreamEncoderInitStatus init_stream_internal_(
625         FLAC__StreamEncoder *encoder,
626         FLAC__StreamEncoderReadCallback read_callback,
627         FLAC__StreamEncoderWriteCallback write_callback,
628         FLAC__StreamEncoderSeekCallback seek_callback,
629         FLAC__StreamEncoderTellCallback tell_callback,
630         FLAC__StreamEncoderMetadataCallback metadata_callback,
631         void *client_data,
632         FLAC__bool is_ogg
633 )
634 {
635         unsigned i;
636         FLAC__bool metadata_has_seektable, metadata_has_vorbis_comment, metadata_picture_has_type1, metadata_picture_has_type2;
637
638         FLAC__ASSERT(0 != encoder);
639
640         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
641                 return FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED;
642
643 #if !FLAC__HAS_OGG
644         if(is_ogg)
645                 return FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER;
646 #endif
647
648         if(0 == write_callback || (seek_callback && 0 == tell_callback))
649                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS;
650
651         if(encoder->protected_->channels == 0 || encoder->protected_->channels > FLAC__MAX_CHANNELS)
652                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS;
653
654         if(encoder->protected_->channels != 2) {
655                 encoder->protected_->do_mid_side_stereo = false;
656                 encoder->protected_->loose_mid_side_stereo = false;
657         }
658         else if(!encoder->protected_->do_mid_side_stereo)
659                 encoder->protected_->loose_mid_side_stereo = false;
660
661         if(encoder->protected_->bits_per_sample >= 32)
662                 encoder->protected_->do_mid_side_stereo = false; /* since we currenty do 32-bit math, the side channel would have 33 bps and overflow */
663
664         if(encoder->protected_->bits_per_sample < FLAC__MIN_BITS_PER_SAMPLE || encoder->protected_->bits_per_sample > FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE)
665                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE;
666
667         if(!FLAC__format_sample_rate_is_valid(encoder->protected_->sample_rate))
668                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE;
669
670         if(encoder->protected_->blocksize == 0) {
671                 if(encoder->protected_->max_lpc_order == 0)
672                         encoder->protected_->blocksize = 1152;
673                 else
674                         encoder->protected_->blocksize = 4608;
675         }
676
677         if(encoder->protected_->blocksize < FLAC__MIN_BLOCK_SIZE || encoder->protected_->blocksize > FLAC__MAX_BLOCK_SIZE)
678                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE;
679
680         if(encoder->protected_->max_lpc_order > FLAC__MAX_LPC_ORDER)
681                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER;
682
683         if(encoder->protected_->blocksize < encoder->protected_->max_lpc_order)
684                 return FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER;
685
686         if(encoder->protected_->qlp_coeff_precision == 0) {
687                 if(encoder->protected_->bits_per_sample < 16) {
688                         /* @@@ need some data about how to set this here w.r.t. blocksize and sample rate */
689                         /* @@@ until then we'll make a guess */
690                         encoder->protected_->qlp_coeff_precision = max(FLAC__MIN_QLP_COEFF_PRECISION, 2 + encoder->protected_->bits_per_sample / 2);
691                 }
692                 else if(encoder->protected_->bits_per_sample == 16) {
693                         if(encoder->protected_->blocksize <= 192)
694                                 encoder->protected_->qlp_coeff_precision = 7;
695                         else if(encoder->protected_->blocksize <= 384)
696                                 encoder->protected_->qlp_coeff_precision = 8;
697                         else if(encoder->protected_->blocksize <= 576)
698                                 encoder->protected_->qlp_coeff_precision = 9;
699                         else if(encoder->protected_->blocksize <= 1152)
700                                 encoder->protected_->qlp_coeff_precision = 10;
701                         else if(encoder->protected_->blocksize <= 2304)
702                                 encoder->protected_->qlp_coeff_precision = 11;
703                         else if(encoder->protected_->blocksize <= 4608)
704                                 encoder->protected_->qlp_coeff_precision = 12;
705                         else
706                                 encoder->protected_->qlp_coeff_precision = 13;
707                 }
708                 else {
709                         if(encoder->protected_->blocksize <= 384)
710                                 encoder->protected_->qlp_coeff_precision = FLAC__MAX_QLP_COEFF_PRECISION-2;
711                         else if(encoder->protected_->blocksize <= 1152)
712                                 encoder->protected_->qlp_coeff_precision = FLAC__MAX_QLP_COEFF_PRECISION-1;
713                         else
714                                 encoder->protected_->qlp_coeff_precision = FLAC__MAX_QLP_COEFF_PRECISION;
715                 }
716                 FLAC__ASSERT(encoder->protected_->qlp_coeff_precision <= FLAC__MAX_QLP_COEFF_PRECISION);
717         }
718         else if(encoder->protected_->qlp_coeff_precision < FLAC__MIN_QLP_COEFF_PRECISION || encoder->protected_->qlp_coeff_precision > FLAC__MAX_QLP_COEFF_PRECISION)
719                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION;
720
721         if(encoder->protected_->streamable_subset) {
722                 if(
723                         encoder->protected_->blocksize != 192 &&
724                         encoder->protected_->blocksize != 576 &&
725                         encoder->protected_->blocksize != 1152 &&
726                         encoder->protected_->blocksize != 2304 &&
727                         encoder->protected_->blocksize != 4608 &&
728                         encoder->protected_->blocksize != 256 &&
729                         encoder->protected_->blocksize != 512 &&
730                         encoder->protected_->blocksize != 1024 &&
731                         encoder->protected_->blocksize != 2048 &&
732                         encoder->protected_->blocksize != 4096 &&
733                         encoder->protected_->blocksize != 8192 &&
734                         encoder->protected_->blocksize != 16384
735                 )
736                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
737                 if(
738                         encoder->protected_->sample_rate != 8000 &&
739                         encoder->protected_->sample_rate != 16000 &&
740                         encoder->protected_->sample_rate != 22050 &&
741                         encoder->protected_->sample_rate != 24000 &&
742                         encoder->protected_->sample_rate != 32000 &&
743                         encoder->protected_->sample_rate != 44100 &&
744                         encoder->protected_->sample_rate != 48000 &&
745                         encoder->protected_->sample_rate != 96000
746                 )
747                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
748                 if(
749                         encoder->protected_->bits_per_sample != 8 &&
750                         encoder->protected_->bits_per_sample != 12 &&
751                         encoder->protected_->bits_per_sample != 16 &&
752                         encoder->protected_->bits_per_sample != 20 &&
753                         encoder->protected_->bits_per_sample != 24
754                 )
755                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
756                 if(encoder->protected_->max_residual_partition_order > FLAC__SUBSET_MAX_RICE_PARTITION_ORDER)
757                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
758                 if(
759                         encoder->protected_->sample_rate <= 48000 &&
760                         (
761                                 encoder->protected_->blocksize > FLAC__SUBSET_MAX_BLOCK_SIZE_48000HZ ||
762                                 encoder->protected_->max_lpc_order > FLAC__SUBSET_MAX_LPC_ORDER_48000HZ
763                         )
764                 ) {
765                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
766                 }
767         }
768
769         if(encoder->protected_->max_residual_partition_order >= (1u << FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
770                 encoder->protected_->max_residual_partition_order = (1u << FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN) - 1;
771         if(encoder->protected_->min_residual_partition_order >= encoder->protected_->max_residual_partition_order)
772                 encoder->protected_->min_residual_partition_order = encoder->protected_->max_residual_partition_order;
773
774 #if FLAC__HAS_OGG
775         /* reorder metadata if necessary to ensure that any VORBIS_COMMENT is the first, according to the mapping spec */
776         if(is_ogg && 0 != encoder->protected_->metadata && encoder->protected_->num_metadata_blocks > 1) {
777                 unsigned i;
778                 for(i = 1; i < encoder->protected_->num_metadata_blocks; i++) {
779                         if(0 != encoder->protected_->metadata[i] && encoder->protected_->metadata[i]->type == FLAC__METADATA_TYPE_VORBIS_COMMENT) {
780                                 FLAC__StreamMetadata *vc = encoder->protected_->metadata[i];
781                                 for( ; i > 0; i--)
782                                         encoder->protected_->metadata[i] = encoder->protected_->metadata[i-1];
783                                 encoder->protected_->metadata[0] = vc;
784                                 break;
785                         }
786                 }
787         }
788 #endif
789         /* keep track of any SEEKTABLE block */
790         if(0 != encoder->protected_->metadata && encoder->protected_->num_metadata_blocks > 0) {
791                 unsigned i;
792                 for(i = 0; i < encoder->protected_->num_metadata_blocks; i++) {
793                         if(0 != encoder->protected_->metadata[i] && encoder->protected_->metadata[i]->type == FLAC__METADATA_TYPE_SEEKTABLE) {
794                                 encoder->private_->seek_table = &encoder->protected_->metadata[i]->data.seek_table;
795                                 break; /* take only the first one */
796                         }
797                 }
798         }
799
800         /* validate metadata */
801         if(0 == encoder->protected_->metadata && encoder->protected_->num_metadata_blocks > 0)
802                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
803         metadata_has_seektable = false;
804         metadata_has_vorbis_comment = false;
805         metadata_picture_has_type1 = false;
806         metadata_picture_has_type2 = false;
807         for(i = 0; i < encoder->protected_->num_metadata_blocks; i++) {
808                 const FLAC__StreamMetadata *m = encoder->protected_->metadata[i];
809                 if(m->type == FLAC__METADATA_TYPE_STREAMINFO)
810                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
811                 else if(m->type == FLAC__METADATA_TYPE_SEEKTABLE) {
812                         if(metadata_has_seektable) /* only one is allowed */
813                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
814                         metadata_has_seektable = true;
815                         if(!FLAC__format_seektable_is_legal(&m->data.seek_table))
816                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
817                 }
818                 else if(m->type == FLAC__METADATA_TYPE_VORBIS_COMMENT) {
819                         if(metadata_has_vorbis_comment) /* only one is allowed */
820                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
821                         metadata_has_vorbis_comment = true;
822                 }
823                 else if(m->type == FLAC__METADATA_TYPE_CUESHEET) {
824                         if(!FLAC__format_cuesheet_is_legal(&m->data.cue_sheet, m->data.cue_sheet.is_cd, /*violation=*/0))
825                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
826                 }
827                 else if(m->type == FLAC__METADATA_TYPE_PICTURE) {
828                         if(!FLAC__format_picture_is_legal(&m->data.picture, /*violation=*/0))
829                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
830                         if(m->data.picture.type == FLAC__STREAM_METADATA_PICTURE_TYPE_FILE_ICON_STANDARD) {
831                                 if(metadata_picture_has_type1) /* there should only be 1 per stream */
832                                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
833                                 metadata_picture_has_type1 = true;
834                                 /* standard icon must be 32x32 pixel PNG */
835                                 if(
836                                         m->data.picture.type == FLAC__STREAM_METADATA_PICTURE_TYPE_FILE_ICON_STANDARD && 
837                                         (
838                                                 (strcmp(m->data.picture.mime_type, "image/png") && strcmp(m->data.picture.mime_type, "-->")) ||
839                                                 m->data.picture.width != 32 ||
840                                                 m->data.picture.height != 32
841                                         )
842                                 )
843                                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
844                         }
845                         else if(m->data.picture.type == FLAC__STREAM_METADATA_PICTURE_TYPE_FILE_ICON) {
846                                 if(metadata_picture_has_type2) /* there should only be 1 per stream */
847                                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
848                                 metadata_picture_has_type2 = true;
849                         }
850                 }
851         }
852
853         encoder->private_->input_capacity = 0;
854         for(i = 0; i < encoder->protected_->channels; i++) {
855                 encoder->private_->integer_signal_unaligned[i] = encoder->private_->integer_signal[i] = 0;
856 #ifndef FLAC__INTEGER_ONLY_LIBRARY
857                 encoder->private_->real_signal_unaligned[i] = encoder->private_->real_signal[i] = 0;
858 #endif
859         }
860         for(i = 0; i < 2; i++) {
861                 encoder->private_->integer_signal_mid_side_unaligned[i] = encoder->private_->integer_signal_mid_side[i] = 0;
862 #ifndef FLAC__INTEGER_ONLY_LIBRARY
863                 encoder->private_->real_signal_mid_side_unaligned[i] = encoder->private_->real_signal_mid_side[i] = 0;
864 #endif
865         }
866 #ifndef FLAC__INTEGER_ONLY_LIBRARY
867         for(i = 0; i < encoder->protected_->num_apodizations; i++)
868                 encoder->private_->window_unaligned[i] = encoder->private_->window[i] = 0;
869         encoder->private_->windowed_signal_unaligned = encoder->private_->windowed_signal = 0;
870 #endif
871         for(i = 0; i < encoder->protected_->channels; i++) {
872                 encoder->private_->residual_workspace_unaligned[i][0] = encoder->private_->residual_workspace[i][0] = 0;
873                 encoder->private_->residual_workspace_unaligned[i][1] = encoder->private_->residual_workspace[i][1] = 0;
874                 encoder->private_->best_subframe[i] = 0;
875         }
876         for(i = 0; i < 2; i++) {
877                 encoder->private_->residual_workspace_mid_side_unaligned[i][0] = encoder->private_->residual_workspace_mid_side[i][0] = 0;
878                 encoder->private_->residual_workspace_mid_side_unaligned[i][1] = encoder->private_->residual_workspace_mid_side[i][1] = 0;
879                 encoder->private_->best_subframe_mid_side[i] = 0;
880         }
881         encoder->private_->abs_residual_partition_sums_unaligned = encoder->private_->abs_residual_partition_sums = 0;
882         encoder->private_->raw_bits_per_partition_unaligned = encoder->private_->raw_bits_per_partition = 0;
883 #ifndef FLAC__INTEGER_ONLY_LIBRARY
884         encoder->private_->loose_mid_side_stereo_frames = (unsigned)((FLAC__double)encoder->protected_->sample_rate * 0.4 / (FLAC__double)encoder->protected_->blocksize + 0.5);
885 #else
886         /* 26214 is the approximate fixed-point equivalent to 0.4 (0.4 * 2^16) */
887         /* sample rate can be up to 655350 Hz, and thus use 20 bits, so we do the multiply&divide by hand */
888         FLAC__ASSERT(FLAC__MAX_SAMPLE_RATE <= 655350);
889         FLAC__ASSERT(FLAC__MAX_BLOCK_SIZE <= 65535);
890         FLAC__ASSERT(encoder->protected_->sample_rate <= 655350);
891         FLAC__ASSERT(encoder->protected_->blocksize <= 65535);
892         encoder->private_->loose_mid_side_stereo_frames = (unsigned)FLAC__fixedpoint_trunc((((FLAC__uint64)(encoder->protected_->sample_rate) * (FLAC__uint64)(26214)) << 16) / (encoder->protected_->blocksize<<16) + FLAC__FP_ONE_HALF);
893 #endif
894         if(encoder->private_->loose_mid_side_stereo_frames == 0)
895                 encoder->private_->loose_mid_side_stereo_frames = 1;
896         encoder->private_->loose_mid_side_stereo_frame_count = 0;
897         encoder->private_->current_sample_number = 0;
898         encoder->private_->current_frame_number = 0;
899
900         encoder->private_->use_wide_by_block = (encoder->protected_->bits_per_sample + FLAC__bitmath_ilog2(encoder->protected_->blocksize)+1 > 30);
901         encoder->private_->use_wide_by_order = (encoder->protected_->bits_per_sample + FLAC__bitmath_ilog2(max(encoder->protected_->max_lpc_order, FLAC__MAX_FIXED_ORDER))+1 > 30); /*@@@ need to use this? */
902         encoder->private_->use_wide_by_partition = (false); /*@@@ need to set this */
903
904         /*
905          * get the CPU info and set the function pointers
906          */
907         FLAC__cpu_info(&encoder->private_->cpuinfo);
908         /* first default to the non-asm routines */
909 #ifndef FLAC__INTEGER_ONLY_LIBRARY
910         encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation;
911 #endif
912         encoder->private_->local_fixed_compute_best_predictor = FLAC__fixed_compute_best_predictor;
913 #ifndef FLAC__INTEGER_ONLY_LIBRARY
914         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients = FLAC__lpc_compute_residual_from_qlp_coefficients;
915         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_64bit = FLAC__lpc_compute_residual_from_qlp_coefficients_wide;
916         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_16bit = FLAC__lpc_compute_residual_from_qlp_coefficients;
917 #endif
918         /* now override with asm where appropriate */
919 #ifndef FLAC__INTEGER_ONLY_LIBRARY
920 # ifndef FLAC__NO_ASM
921         if(encoder->private_->cpuinfo.use_asm) {
922 #  ifdef FLAC__CPU_IA32
923                 FLAC__ASSERT(encoder->private_->cpuinfo.type == FLAC__CPUINFO_TYPE_IA32);
924 #   ifdef FLAC__HAS_NASM
925 #    ifdef FLAC__SSE_OS
926                 if(encoder->private_->cpuinfo.data.ia32.sse) {
927                         if(encoder->protected_->max_lpc_order < 4)
928                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_sse_lag_4;
929                         else if(encoder->protected_->max_lpc_order < 8)
930                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_sse_lag_8;
931                         else if(encoder->protected_->max_lpc_order < 12)
932                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_sse_lag_12;
933                         else
934                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32;
935                 }
936                 else
937 #    endif /* FLAC__SSE_OS */
938                 if(encoder->private_->cpuinfo.data.ia32._3dnow)
939                         encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_3dnow;
940                 else
941                         encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32;
942                 if(encoder->private_->cpuinfo.data.ia32.mmx) {
943                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32;
944                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_16bit = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32_mmx;
945                 }
946                 else {
947                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32;
948                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_16bit = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32;
949                 }
950                 if(encoder->private_->cpuinfo.data.ia32.mmx && encoder->private_->cpuinfo.data.ia32.cmov)
951                         encoder->private_->local_fixed_compute_best_predictor = FLAC__fixed_compute_best_predictor_asm_ia32_mmx_cmov;
952 #   endif /* FLAC__HAS_NASM */
953 #  endif /* FLAC__CPU_IA32 */
954         }
955 # endif /* !FLAC__NO_ASM */
956 #endif /* !FLAC__INTEGER_ONLY_LIBRARY */
957         /* finally override based on wide-ness if necessary */
958         if(encoder->private_->use_wide_by_block) {
959                 encoder->private_->local_fixed_compute_best_predictor = FLAC__fixed_compute_best_predictor_wide;
960         }
961
962         /* set state to OK; from here on, errors are fatal and we'll override the state then */
963         encoder->protected_->state = FLAC__STREAM_ENCODER_OK;
964
965 #if FLAC__HAS_OGG
966         encoder->private_->is_ogg = is_ogg;
967         if(is_ogg && !FLAC__ogg_encoder_aspect_init(&encoder->protected_->ogg_encoder_aspect)) {
968                 encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
969                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
970         }
971 #endif
972
973         encoder->private_->read_callback = read_callback;
974         encoder->private_->write_callback = write_callback;
975         encoder->private_->seek_callback = seek_callback;
976         encoder->private_->tell_callback = tell_callback;
977         encoder->private_->metadata_callback = metadata_callback;
978         encoder->private_->client_data = client_data;
979
980         if(!resize_buffers_(encoder, encoder->protected_->blocksize)) {
981                 /* the above function sets the state for us in case of an error */
982                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
983         }
984
985         if(!FLAC__bitwriter_init(encoder->private_->frame)) {
986                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
987                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
988         }
989
990         /*
991          * Set up the verify stuff if necessary
992          */
993         if(encoder->protected_->verify) {
994                 /*
995                  * First, set up the fifo which will hold the
996                  * original signal to compare against
997                  */
998                 encoder->private_->verify.input_fifo.size = encoder->protected_->blocksize+OVERREAD_;
999                 for(i = 0; i < encoder->protected_->channels; i++) {
1000                         if(0 == (encoder->private_->verify.input_fifo.data[i] = (FLAC__int32*)malloc(sizeof(FLAC__int32) * encoder->private_->verify.input_fifo.size))) {
1001                                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
1002                                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1003                         }
1004                 }
1005                 encoder->private_->verify.input_fifo.tail = 0;
1006
1007                 /*
1008                  * Now set up a stream decoder for verification
1009                  */
1010                 encoder->private_->verify.decoder = FLAC__stream_decoder_new();
1011                 if(0 == encoder->private_->verify.decoder) {
1012                         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR;
1013                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1014                 }
1015
1016                 if(FLAC__stream_decoder_init_stream(encoder->private_->verify.decoder, verify_read_callback_, /*seek_callback=*/0, /*tell_callback=*/0, /*length_callback=*/0, /*eof_callback=*/0, verify_write_callback_, verify_metadata_callback_, verify_error_callback_, /*client_data=*/encoder) != FLAC__STREAM_DECODER_INIT_STATUS_OK) {
1017                         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR;
1018                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1019                 }
1020         }
1021         encoder->private_->verify.error_stats.absolute_sample = 0;
1022         encoder->private_->verify.error_stats.frame_number = 0;
1023         encoder->private_->verify.error_stats.channel = 0;
1024         encoder->private_->verify.error_stats.sample = 0;
1025         encoder->private_->verify.error_stats.expected = 0;
1026         encoder->private_->verify.error_stats.got = 0;
1027
1028         /*
1029          * These must be done before we write any metadata, because that
1030          * calls the write_callback, which uses these values.
1031          */
1032         encoder->private_->first_seekpoint_to_check = 0;
1033         encoder->private_->samples_written = 0;
1034         encoder->protected_->streaminfo_offset = 0;
1035         encoder->protected_->seektable_offset = 0;
1036         encoder->protected_->audio_offset = 0;
1037
1038         /*
1039          * write the stream header
1040          */
1041         if(encoder->protected_->verify)
1042                 encoder->private_->verify.state_hint = ENCODER_IN_MAGIC;
1043         if(!FLAC__bitwriter_write_raw_uint32(encoder->private_->frame, FLAC__STREAM_SYNC, FLAC__STREAM_SYNC_LEN)) {
1044                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1045                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1046         }
1047         if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1048                 /* the above function sets the state for us in case of an error */
1049                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1050         }
1051
1052         /*
1053          * write the STREAMINFO metadata block
1054          */
1055         if(encoder->protected_->verify)
1056                 encoder->private_->verify.state_hint = ENCODER_IN_METADATA;
1057         encoder->private_->streaminfo.type = FLAC__METADATA_TYPE_STREAMINFO;
1058         encoder->private_->streaminfo.is_last = false; /* we will have at a minimum a VORBIS_COMMENT afterwards */
1059         encoder->private_->streaminfo.length = FLAC__STREAM_METADATA_STREAMINFO_LENGTH;
1060         encoder->private_->streaminfo.data.stream_info.min_blocksize = encoder->protected_->blocksize; /* this encoder uses the same blocksize for the whole stream */
1061         encoder->private_->streaminfo.data.stream_info.max_blocksize = encoder->protected_->blocksize;
1062         encoder->private_->streaminfo.data.stream_info.min_framesize = 0; /* we don't know this yet; have to fill it in later */
1063         encoder->private_->streaminfo.data.stream_info.max_framesize = 0; /* we don't know this yet; have to fill it in later */
1064         encoder->private_->streaminfo.data.stream_info.sample_rate = encoder->protected_->sample_rate;
1065         encoder->private_->streaminfo.data.stream_info.channels = encoder->protected_->channels;
1066         encoder->private_->streaminfo.data.stream_info.bits_per_sample = encoder->protected_->bits_per_sample;
1067         encoder->private_->streaminfo.data.stream_info.total_samples = encoder->protected_->total_samples_estimate; /* we will replace this later with the real total */
1068         memset(encoder->private_->streaminfo.data.stream_info.md5sum, 0, 16); /* we don't know this yet; have to fill it in later */
1069         FLAC__MD5Init(&encoder->private_->md5context);
1070         if(!FLAC__add_metadata_block(&encoder->private_->streaminfo, encoder->private_->frame)) {
1071                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1072                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1073         }
1074         if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1075                 /* the above function sets the state for us in case of an error */
1076                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1077         }
1078
1079         /*
1080          * Now that the STREAMINFO block is written, we can init this to an
1081          * absurdly-high value...
1082          */
1083         encoder->private_->streaminfo.data.stream_info.min_framesize = (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN) - 1;
1084         /* ... and clear this to 0 */
1085         encoder->private_->streaminfo.data.stream_info.total_samples = 0;
1086
1087         /*
1088          * Check to see if the supplied metadata contains a VORBIS_COMMENT;
1089          * if not, we will write an empty one (FLAC__add_metadata_block()
1090          * automatically supplies the vendor string).
1091          *
1092          * WATCHOUT: the Ogg FLAC mapping requires us to write this block after
1093          * the STREAMINFO.  (In the case that metadata_has_vorbis_comment is
1094          * true it will have already insured that the metadata list is properly
1095          * ordered.)
1096          */
1097         if(!metadata_has_vorbis_comment) {
1098                 FLAC__StreamMetadata vorbis_comment;
1099                 vorbis_comment.type = FLAC__METADATA_TYPE_VORBIS_COMMENT;
1100                 vorbis_comment.is_last = (encoder->protected_->num_metadata_blocks == 0);
1101                 vorbis_comment.length = 4 + 4; /* MAGIC NUMBER */
1102                 vorbis_comment.data.vorbis_comment.vendor_string.length = 0;
1103                 vorbis_comment.data.vorbis_comment.vendor_string.entry = 0;
1104                 vorbis_comment.data.vorbis_comment.num_comments = 0;
1105                 vorbis_comment.data.vorbis_comment.comments = 0;
1106                 if(!FLAC__add_metadata_block(&vorbis_comment, encoder->private_->frame)) {
1107                         encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1108                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1109                 }
1110                 if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1111                         /* the above function sets the state for us in case of an error */
1112                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1113                 }
1114         }
1115
1116         /*
1117          * write the user's metadata blocks
1118          */
1119         for(i = 0; i < encoder->protected_->num_metadata_blocks; i++) {
1120                 encoder->protected_->metadata[i]->is_last = (i == encoder->protected_->num_metadata_blocks - 1);
1121                 if(!FLAC__add_metadata_block(encoder->protected_->metadata[i], encoder->private_->frame)) {
1122                         encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1123                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1124                 }
1125                 if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1126                         /* the above function sets the state for us in case of an error */
1127                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1128                 }
1129         }
1130
1131         /* now that all the metadata is written, we save the stream offset */
1132         if(encoder->private_->tell_callback && encoder->private_->tell_callback(encoder, &encoder->protected_->audio_offset, encoder->private_->client_data) == FLAC__STREAM_ENCODER_TELL_STATUS_ERROR) { /* FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED just means we didn't get the offset; no error */
1133                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
1134                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1135         }
1136
1137         if(encoder->protected_->verify)
1138                 encoder->private_->verify.state_hint = ENCODER_IN_AUDIO;
1139
1140         return FLAC__STREAM_ENCODER_INIT_STATUS_OK;
1141 }
1142
1143 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_stream(
1144         FLAC__StreamEncoder *encoder,
1145         FLAC__StreamEncoderWriteCallback write_callback,
1146         FLAC__StreamEncoderSeekCallback seek_callback,
1147         FLAC__StreamEncoderTellCallback tell_callback,
1148         FLAC__StreamEncoderMetadataCallback metadata_callback,
1149         void *client_data
1150 )
1151 {
1152         return init_stream_internal_(
1153                 encoder,
1154                 /*read_callback=*/0,
1155                 write_callback,
1156                 seek_callback,
1157                 tell_callback,
1158                 metadata_callback,
1159                 client_data,
1160                 /*is_ogg=*/false
1161         );
1162 }
1163
1164 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_stream(
1165         FLAC__StreamEncoder *encoder,
1166         FLAC__StreamEncoderReadCallback read_callback,
1167         FLAC__StreamEncoderWriteCallback write_callback,
1168         FLAC__StreamEncoderSeekCallback seek_callback,
1169         FLAC__StreamEncoderTellCallback tell_callback,
1170         FLAC__StreamEncoderMetadataCallback metadata_callback,
1171         void *client_data
1172 )
1173 {
1174         return init_stream_internal_(
1175                 encoder,
1176                 read_callback,
1177                 write_callback,
1178                 seek_callback,
1179                 tell_callback,
1180                 metadata_callback,
1181                 client_data,
1182                 /*is_ogg=*/true
1183         );
1184 }
1185  
1186 static FLAC__StreamEncoderInitStatus init_FILE_internal_(
1187         FLAC__StreamEncoder *encoder,
1188         FILE *file,
1189         FLAC__StreamEncoderProgressCallback progress_callback,
1190         void *client_data,
1191         FLAC__bool is_ogg
1192 )
1193 {
1194         FLAC__StreamEncoderInitStatus init_status;
1195
1196         FLAC__ASSERT(0 != encoder);
1197         FLAC__ASSERT(0 != file);
1198
1199         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1200                 return FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED;
1201
1202         /* double protection */
1203         if(file == 0) {
1204                 encoder->protected_->state = FLAC__STREAM_ENCODER_IO_ERROR;
1205                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1206         }
1207
1208         /*
1209          * To make sure that our file does not go unclosed after an error, we
1210          * must assign the FILE pointer before any further error can occur in
1211          * this routine.
1212          */
1213         if(file == stdout)
1214                 file = get_binary_stdout_(); /* just to be safe */
1215
1216         encoder->private_->file = file;
1217
1218         encoder->private_->progress_callback = progress_callback;
1219         encoder->private_->bytes_written = 0;
1220         encoder->private_->samples_written = 0;
1221         encoder->private_->frames_written = 0;
1222
1223         init_status = init_stream_internal_(
1224                 encoder,
1225                 encoder->private_->file == stdout? 0 : is_ogg? file_read_callback_ : 0,
1226                 file_write_callback_,
1227                 encoder->private_->file == stdout? 0 : file_seek_callback_,
1228                 encoder->private_->file == stdout? 0 : file_tell_callback_,
1229                 /*metadata_callback=*/0,
1230                 client_data,
1231                 is_ogg
1232         );
1233         if(init_status != FLAC__STREAM_ENCODER_INIT_STATUS_OK) {
1234                 /* the above function sets the state for us in case of an error */
1235                 return init_status;
1236         }
1237
1238         {
1239                 unsigned blocksize = FLAC__stream_encoder_get_blocksize(encoder);
1240
1241                 FLAC__ASSERT(blocksize != 0);
1242                 encoder->private_->total_frames_estimate = (unsigned)((FLAC__stream_encoder_get_total_samples_estimate(encoder) + blocksize - 1) / blocksize);
1243         }
1244
1245         return init_status;
1246 }
1247  
1248 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_FILE(
1249         FLAC__StreamEncoder *encoder,
1250         FILE *file,
1251         FLAC__StreamEncoderProgressCallback progress_callback,
1252         void *client_data
1253 )
1254 {
1255         return init_FILE_internal_(encoder, file, progress_callback, client_data, /*is_ogg=*/false);
1256 }
1257  
1258 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_FILE(
1259         FLAC__StreamEncoder *encoder,
1260         FILE *file,
1261         FLAC__StreamEncoderProgressCallback progress_callback,
1262         void *client_data
1263 )
1264 {
1265         return init_FILE_internal_(encoder, file, progress_callback, client_data, /*is_ogg=*/true);
1266 }
1267
1268 static FLAC__StreamEncoderInitStatus init_file_internal_(
1269         FLAC__StreamEncoder *encoder,
1270         const char *filename,
1271         FLAC__StreamEncoderProgressCallback progress_callback,
1272         void *client_data,
1273         FLAC__bool is_ogg
1274 )
1275 {
1276         FILE *file;
1277
1278         FLAC__ASSERT(0 != encoder);
1279
1280         /*
1281          * To make sure that our file does not go unclosed after an error, we
1282          * have to do the same entrance checks here that are later performed
1283          * in FLAC__stream_encoder_init_FILE() before the FILE* is assigned.
1284          */
1285         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1286                 return FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED;
1287
1288         file = filename? fopen(filename, "w+b") : stdout;
1289
1290         if(file == 0) {
1291                 encoder->protected_->state = FLAC__STREAM_ENCODER_IO_ERROR;
1292                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1293         }
1294
1295         return init_FILE_internal_(encoder, file, progress_callback, client_data, is_ogg);
1296 }
1297
1298 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_file(
1299         FLAC__StreamEncoder *encoder,
1300         const char *filename,
1301         FLAC__StreamEncoderProgressCallback progress_callback,
1302         void *client_data
1303 )
1304 {
1305         return init_file_internal_(encoder, filename, progress_callback, client_data, /*is_ogg=*/false);
1306 }
1307
1308 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_file(
1309         FLAC__StreamEncoder *encoder,
1310         const char *filename,
1311         FLAC__StreamEncoderProgressCallback progress_callback,
1312         void *client_data
1313 )
1314 {
1315         return init_file_internal_(encoder, filename, progress_callback, client_data, /*is_ogg=*/true);
1316 }
1317
1318 FLAC_API FLAC__bool FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder)
1319 {
1320         FLAC__bool error = false;
1321
1322         FLAC__ASSERT(0 != encoder);
1323         FLAC__ASSERT(0 != encoder->private_);
1324         FLAC__ASSERT(0 != encoder->protected_);
1325
1326         if(encoder->protected_->state == FLAC__STREAM_ENCODER_UNINITIALIZED)
1327                 return true;
1328
1329         if(encoder->protected_->state == FLAC__STREAM_ENCODER_OK && !encoder->private_->is_being_deleted) {
1330                 if(encoder->private_->current_sample_number != 0) {
1331                         const FLAC__bool is_fractional_block = encoder->protected_->blocksize != encoder->private_->current_sample_number;
1332                         encoder->protected_->blocksize = encoder->private_->current_sample_number;
1333                         if(!process_frame_(encoder, is_fractional_block, /*is_last_block=*/true))
1334                                 error = true;
1335                 }
1336         }
1337
1338         FLAC__MD5Final(encoder->private_->streaminfo.data.stream_info.md5sum, &encoder->private_->md5context);
1339
1340         if(!encoder->private_->is_being_deleted) {
1341                 if(encoder->protected_->state == FLAC__STREAM_ENCODER_OK) {
1342                         if(encoder->private_->seek_callback) {
1343 #if FLAC__HAS_OGG
1344                                 if(encoder->private_->is_ogg)
1345                                         update_ogg_metadata_(encoder);
1346                                 else
1347 #endif
1348                                 update_metadata_(encoder);
1349
1350                                 /* check if an error occurred while updating metadata */
1351                                 if(encoder->protected_->state != FLAC__STREAM_ENCODER_OK)
1352                                         error = true;
1353                         }
1354                         if(encoder->private_->metadata_callback)
1355                                 encoder->private_->metadata_callback(encoder, &encoder->private_->streaminfo, encoder->private_->client_data);
1356                 }
1357
1358                 if(encoder->protected_->verify && 0 != encoder->private_->verify.decoder && !FLAC__stream_decoder_finish(encoder->private_->verify.decoder)) {
1359                         if(!error)
1360                                 encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA;
1361                         error = true;
1362                 }
1363         }
1364
1365         if(0 != encoder->private_->file) {
1366                 if(encoder->private_->file != stdout)
1367                         fclose(encoder->private_->file);
1368                 encoder->private_->file = 0;
1369         }
1370
1371 #if FLAC__HAS_OGG
1372         if(encoder->private_->is_ogg)
1373                 FLAC__ogg_encoder_aspect_finish(&encoder->protected_->ogg_encoder_aspect);
1374 #endif
1375
1376         free_(encoder);
1377         set_defaults_(encoder);
1378
1379         if(!error)
1380                 encoder->protected_->state = FLAC__STREAM_ENCODER_UNINITIALIZED;
1381
1382         return !error;
1383 }
1384
1385 FLAC_API FLAC__bool FLAC__stream_encoder_set_ogg_serial_number(FLAC__StreamEncoder *encoder, long value)
1386 {
1387         FLAC__ASSERT(0 != encoder);
1388         FLAC__ASSERT(0 != encoder->private_);
1389         FLAC__ASSERT(0 != encoder->protected_);
1390         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1391                 return false;
1392 #if FLAC__HAS_OGG
1393         /* can't check encoder->private_->is_ogg since that's not set until init time */
1394         FLAC__ogg_encoder_aspect_set_serial_number(&encoder->protected_->ogg_encoder_aspect, value);
1395         return true;
1396 #else
1397         (void)value;
1398         return false;
1399 #endif
1400 }
1401
1402 FLAC_API FLAC__bool FLAC__stream_encoder_set_verify(FLAC__StreamEncoder *encoder, FLAC__bool value)
1403 {
1404         FLAC__ASSERT(0 != encoder);
1405         FLAC__ASSERT(0 != encoder->private_);
1406         FLAC__ASSERT(0 != encoder->protected_);
1407         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1408                 return false;
1409 #ifndef FLAC__MANDATORY_VERIFY_WHILE_ENCODING
1410         encoder->protected_->verify = value;
1411 #endif
1412         return true;
1413 }
1414
1415 FLAC_API FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value)
1416 {
1417         FLAC__ASSERT(0 != encoder);
1418         FLAC__ASSERT(0 != encoder->private_);
1419         FLAC__ASSERT(0 != encoder->protected_);
1420         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1421                 return false;
1422         encoder->protected_->streamable_subset = value;
1423         return true;
1424 }
1425
1426 FLAC_API FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, unsigned value)
1427 {
1428         FLAC__ASSERT(0 != encoder);
1429         FLAC__ASSERT(0 != encoder->private_);
1430         FLAC__ASSERT(0 != encoder->protected_);
1431         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1432                 return false;
1433         encoder->protected_->channels = value;
1434         return true;
1435 }
1436
1437 FLAC_API FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, unsigned value)
1438 {
1439         FLAC__ASSERT(0 != encoder);
1440         FLAC__ASSERT(0 != encoder->private_);
1441         FLAC__ASSERT(0 != encoder->protected_);
1442         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1443                 return false;
1444         encoder->protected_->bits_per_sample = value;
1445         return true;
1446 }
1447
1448 FLAC_API FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, unsigned value)
1449 {
1450         FLAC__ASSERT(0 != encoder);
1451         FLAC__ASSERT(0 != encoder->private_);
1452         FLAC__ASSERT(0 != encoder->protected_);
1453         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1454                 return false;
1455         encoder->protected_->sample_rate = value;
1456         return true;
1457 }
1458
1459 FLAC_API FLAC__bool FLAC__stream_encoder_set_compression_level(FLAC__StreamEncoder *encoder, unsigned value)
1460 {
1461         FLAC__bool ok = true;
1462         FLAC__ASSERT(0 != encoder);
1463         FLAC__ASSERT(0 != encoder->private_);
1464         FLAC__ASSERT(0 != encoder->protected_);
1465         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1466                 return false;
1467         if(value >= sizeof(compression_levels_)/sizeof(compression_levels_[0]))
1468                 value = sizeof(compression_levels_)/sizeof(compression_levels_[0]) - 1;
1469         ok &= FLAC__stream_encoder_set_do_mid_side_stereo          (encoder, compression_levels_[value].do_mid_side_stereo);
1470         ok &= FLAC__stream_encoder_set_loose_mid_side_stereo       (encoder, compression_levels_[value].loose_mid_side_stereo);
1471 #if 0
1472         /* was: */
1473         ok &= FLAC__stream_encoder_set_apodization                 (encoder, compression_levels_[value].apodization);
1474         /* but it's too hard to specify the string in a locale-specific way */
1475 #else
1476         encoder->protected_->num_apodizations = 1;
1477         encoder->protected_->apodizations[0].type = FLAC__APODIZATION_TUKEY;
1478         encoder->protected_->apodizations[0].parameters.tukey.p = 0.5;
1479 #endif
1480         ok &= FLAC__stream_encoder_set_max_lpc_order               (encoder, compression_levels_[value].max_lpc_order);
1481         ok &= FLAC__stream_encoder_set_qlp_coeff_precision         (encoder, compression_levels_[value].qlp_coeff_precision);
1482         ok &= FLAC__stream_encoder_set_do_qlp_coeff_prec_search    (encoder, compression_levels_[value].do_qlp_coeff_prec_search);
1483         ok &= FLAC__stream_encoder_set_do_escape_coding            (encoder, compression_levels_[value].do_escape_coding);
1484         ok &= FLAC__stream_encoder_set_do_exhaustive_model_search  (encoder, compression_levels_[value].do_exhaustive_model_search);
1485         ok &= FLAC__stream_encoder_set_min_residual_partition_order(encoder, compression_levels_[value].min_residual_partition_order);
1486         ok &= FLAC__stream_encoder_set_max_residual_partition_order(encoder, compression_levels_[value].max_residual_partition_order);
1487         ok &= FLAC__stream_encoder_set_rice_parameter_search_dist  (encoder, compression_levels_[value].rice_parameter_search_dist);
1488         return ok;
1489 }
1490
1491 FLAC_API FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, unsigned value)
1492 {
1493         FLAC__ASSERT(0 != encoder);
1494         FLAC__ASSERT(0 != encoder->private_);
1495         FLAC__ASSERT(0 != encoder->protected_);
1496         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1497                 return false;
1498         encoder->protected_->blocksize = value;
1499         return true;
1500 }
1501
1502 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value)
1503 {
1504         FLAC__ASSERT(0 != encoder);
1505         FLAC__ASSERT(0 != encoder->private_);
1506         FLAC__ASSERT(0 != encoder->protected_);
1507         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1508                 return false;
1509         encoder->protected_->do_mid_side_stereo = value;
1510         return true;
1511 }
1512
1513 FLAC_API FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value)
1514 {
1515         FLAC__ASSERT(0 != encoder);
1516         FLAC__ASSERT(0 != encoder->private_);
1517         FLAC__ASSERT(0 != encoder->protected_);
1518         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1519                 return false;
1520         encoder->protected_->loose_mid_side_stereo = value;
1521         return true;
1522 }
1523
1524 FLAC_API FLAC__bool FLAC__stream_encoder_set_apodization(FLAC__StreamEncoder *encoder, const char *specification)
1525 {
1526         FLAC__ASSERT(0 != encoder);
1527         FLAC__ASSERT(0 != encoder->private_);
1528         FLAC__ASSERT(0 != encoder->protected_);
1529         FLAC__ASSERT(0 != specification);
1530         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1531                 return false;
1532 #ifdef FLAC__INTEGER_ONLY_LIBRARY
1533         (void)specification; /* silently ignore since we haven't integerized; will always use a rectangular window */
1534 #else
1535         encoder->protected_->num_apodizations = 0;
1536         while(1) {
1537                 const char *s = strchr(specification, ';');
1538                 const size_t n = s? (size_t)(s - specification) : strlen(specification);
1539                 if     (n==8  && 0 == strncmp("bartlett"     , specification, n))
1540                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BARTLETT;
1541                 else if(n==13 && 0 == strncmp("bartlett_hann", specification, n))
1542                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BARTLETT_HANN;
1543                 else if(n==8  && 0 == strncmp("blackman"     , specification, n))
1544                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BLACKMAN;
1545                 else if(n==26 && 0 == strncmp("blackman_harris_4term_92db", specification, n))
1546                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BLACKMAN_HARRIS_4TERM_92DB_SIDELOBE;
1547                 else if(n==6  && 0 == strncmp("connes"       , specification, n))
1548                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_CONNES;
1549                 else if(n==7  && 0 == strncmp("flattop"      , specification, n))
1550                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_FLATTOP;
1551                 else if(n>7   && 0 == strncmp("gauss("       , specification, 6)) {
1552                         FLAC__real stddev = (FLAC__real)strtod(specification+6, 0);
1553                         if (stddev > 0.0 && stddev <= 0.5) {
1554                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations].parameters.gauss.stddev = stddev;
1555                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_GAUSS;
1556                         }
1557                 }
1558                 else if(n==7  && 0 == strncmp("hamming"      , specification, n))
1559                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_HAMMING;
1560                 else if(n==4  && 0 == strncmp("hann"         , specification, n))
1561                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_HANN;
1562                 else if(n==13 && 0 == strncmp("kaiser_bessel", specification, n))
1563                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_KAISER_BESSEL;
1564                 else if(n==7  && 0 == strncmp("nuttall"      , specification, n))
1565                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_NUTTALL;
1566                 else if(n==9  && 0 == strncmp("rectangle"    , specification, n))
1567                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_RECTANGLE;
1568                 else if(n==8  && 0 == strncmp("triangle"     , specification, n))
1569                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_TRIANGLE;
1570                 else if(n>7   && 0 == strncmp("tukey("       , specification, 6)) {
1571                         FLAC__real p = (FLAC__real)strtod(specification+6, 0);
1572                         if (p >= 0.0 && p <= 1.0) {
1573                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations].parameters.tukey.p = p;
1574                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_TUKEY;
1575                         }
1576                 }
1577                 else if(n==5  && 0 == strncmp("welch"        , specification, n))
1578                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_WELCH;
1579                 if (encoder->protected_->num_apodizations == 32)
1580                         break;
1581                 if (s)
1582                         specification = s+1;
1583                 else
1584                         break;
1585         }
1586         if(encoder->protected_->num_apodizations == 0) {
1587                 encoder->protected_->num_apodizations = 1;
1588                 encoder->protected_->apodizations[0].type = FLAC__APODIZATION_TUKEY;
1589                 encoder->protected_->apodizations[0].parameters.tukey.p = 0.5;
1590         }
1591 #endif
1592         return true;
1593 }
1594
1595 FLAC_API FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, unsigned value)
1596 {
1597         FLAC__ASSERT(0 != encoder);
1598         FLAC__ASSERT(0 != encoder->private_);
1599         FLAC__ASSERT(0 != encoder->protected_);
1600         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1601                 return false;
1602         encoder->protected_->max_lpc_order = value;
1603         return true;
1604 }
1605
1606 FLAC_API FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, unsigned value)
1607 {
1608         FLAC__ASSERT(0 != encoder);
1609         FLAC__ASSERT(0 != encoder->private_);
1610         FLAC__ASSERT(0 != encoder->protected_);
1611         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1612                 return false;
1613         encoder->protected_->qlp_coeff_precision = value;
1614         return true;
1615 }
1616
1617 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value)
1618 {
1619         FLAC__ASSERT(0 != encoder);
1620         FLAC__ASSERT(0 != encoder->private_);
1621         FLAC__ASSERT(0 != encoder->protected_);
1622         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1623                 return false;
1624         encoder->protected_->do_qlp_coeff_prec_search = value;
1625         return true;
1626 }
1627
1628 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value)
1629 {
1630         FLAC__ASSERT(0 != encoder);
1631         FLAC__ASSERT(0 != encoder->private_);
1632         FLAC__ASSERT(0 != encoder->protected_);
1633         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1634                 return false;
1635 #if 0
1636         /*@@@ deprecated: */
1637         encoder->protected_->do_escape_coding = value;
1638 #else
1639         (void)value;
1640 #endif
1641         return true;
1642 }
1643
1644 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value)
1645 {
1646         FLAC__ASSERT(0 != encoder);
1647         FLAC__ASSERT(0 != encoder->private_);
1648         FLAC__ASSERT(0 != encoder->protected_);
1649         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1650                 return false;
1651         encoder->protected_->do_exhaustive_model_search = value;
1652         return true;
1653 }
1654
1655 FLAC_API FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value)
1656 {
1657         FLAC__ASSERT(0 != encoder);
1658         FLAC__ASSERT(0 != encoder->private_);
1659         FLAC__ASSERT(0 != encoder->protected_);
1660         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1661                 return false;
1662         encoder->protected_->min_residual_partition_order = value;
1663         return true;
1664 }
1665
1666 FLAC_API FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value)
1667 {
1668         FLAC__ASSERT(0 != encoder);
1669         FLAC__ASSERT(0 != encoder->private_);
1670         FLAC__ASSERT(0 != encoder->protected_);
1671         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1672                 return false;
1673         encoder->protected_->max_residual_partition_order = value;
1674         return true;
1675 }
1676
1677 FLAC_API FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, unsigned value)
1678 {
1679         FLAC__ASSERT(0 != encoder);
1680         FLAC__ASSERT(0 != encoder->private_);
1681         FLAC__ASSERT(0 != encoder->protected_);
1682         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1683                 return false;
1684 #if 0
1685         /*@@@ deprecated: */
1686         encoder->protected_->rice_parameter_search_dist = value;
1687 #else
1688         (void)value;
1689 #endif
1690         return true;
1691 }
1692
1693 FLAC_API FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value)
1694 {
1695         FLAC__ASSERT(0 != encoder);
1696         FLAC__ASSERT(0 != encoder->private_);
1697         FLAC__ASSERT(0 != encoder->protected_);
1698         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1699                 return false;
1700         encoder->protected_->total_samples_estimate = value;
1701         return true;
1702 }
1703
1704 FLAC_API FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks)
1705 {
1706         FLAC__ASSERT(0 != encoder);
1707         FLAC__ASSERT(0 != encoder->private_);
1708         FLAC__ASSERT(0 != encoder->protected_);
1709         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1710                 return false;
1711         if(0 == metadata)
1712                 num_blocks = 0;
1713         if(0 == num_blocks)
1714                 metadata = 0;
1715         /* realloc() does not do exactly what we want so... */
1716         if(encoder->protected_->metadata) {
1717                 free(encoder->protected_->metadata);
1718                 encoder->protected_->metadata = 0;
1719                 encoder->protected_->num_metadata_blocks = 0;
1720         }
1721         if(num_blocks) {
1722                 FLAC__StreamMetadata **m;
1723                 if(0 == (m = (FLAC__StreamMetadata**)malloc(sizeof(m[0]) * num_blocks)))
1724                         return false;
1725                 memcpy(m, metadata, sizeof(m[0]) * num_blocks);
1726                 encoder->protected_->metadata = m;
1727                 encoder->protected_->num_metadata_blocks = num_blocks;
1728         }
1729 #if FLAC__HAS_OGG
1730         if(!FLAC__ogg_encoder_aspect_set_num_metadata(&encoder->protected_->ogg_encoder_aspect, num_blocks))
1731                 return false;
1732 #endif
1733         return true;
1734 }
1735
1736 /*
1737  * These three functions are not static, but not publically exposed in
1738  * include/FLAC/ either.  They are used by the test suite.
1739  */
1740 FLAC_API FLAC__bool FLAC__stream_encoder_disable_constant_subframes(FLAC__StreamEncoder *encoder, FLAC__bool value)
1741 {
1742         FLAC__ASSERT(0 != encoder);
1743         FLAC__ASSERT(0 != encoder->private_);
1744         FLAC__ASSERT(0 != encoder->protected_);
1745         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1746                 return false;
1747         encoder->private_->disable_constant_subframes = value;
1748         return true;
1749 }
1750
1751 FLAC_API FLAC__bool FLAC__stream_encoder_disable_fixed_subframes(FLAC__StreamEncoder *encoder, FLAC__bool value)
1752 {
1753         FLAC__ASSERT(0 != encoder);
1754         FLAC__ASSERT(0 != encoder->private_);
1755         FLAC__ASSERT(0 != encoder->protected_);
1756         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1757                 return false;
1758         encoder->private_->disable_fixed_subframes = value;
1759         return true;
1760 }
1761
1762 FLAC_API FLAC__bool FLAC__stream_encoder_disable_verbatim_subframes(FLAC__StreamEncoder *encoder, FLAC__bool value)
1763 {
1764         FLAC__ASSERT(0 != encoder);
1765         FLAC__ASSERT(0 != encoder->private_);
1766         FLAC__ASSERT(0 != encoder->protected_);
1767         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1768                 return false;
1769         encoder->private_->disable_verbatim_subframes = value;
1770         return true;
1771 }
1772
1773 FLAC_API FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder)
1774 {
1775         FLAC__ASSERT(0 != encoder);
1776         FLAC__ASSERT(0 != encoder->private_);
1777         FLAC__ASSERT(0 != encoder->protected_);
1778         return encoder->protected_->state;
1779 }
1780
1781 FLAC_API FLAC__StreamDecoderState FLAC__stream_encoder_get_verify_decoder_state(const FLAC__StreamEncoder *encoder)
1782 {
1783         FLAC__ASSERT(0 != encoder);
1784         FLAC__ASSERT(0 != encoder->private_);
1785         FLAC__ASSERT(0 != encoder->protected_);
1786         if(encoder->protected_->verify)
1787                 return FLAC__stream_decoder_get_state(encoder->private_->verify.decoder);
1788         else
1789                 return FLAC__STREAM_DECODER_UNINITIALIZED;
1790 }
1791
1792 FLAC_API const char *FLAC__stream_encoder_get_resolved_state_string(const FLAC__StreamEncoder *encoder)
1793 {
1794         FLAC__ASSERT(0 != encoder);
1795         FLAC__ASSERT(0 != encoder->private_);
1796         FLAC__ASSERT(0 != encoder->protected_);
1797         if(encoder->protected_->state != FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR)
1798                 return FLAC__StreamEncoderStateString[encoder->protected_->state];
1799         else
1800                 return FLAC__stream_decoder_get_resolved_state_string(encoder->private_->verify.decoder);
1801 }
1802
1803 FLAC_API void FLAC__stream_encoder_get_verify_decoder_error_stats(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got)
1804 {
1805         FLAC__ASSERT(0 != encoder);
1806         FLAC__ASSERT(0 != encoder->private_);
1807         FLAC__ASSERT(0 != encoder->protected_);
1808         if(0 != absolute_sample)
1809                 *absolute_sample = encoder->private_->verify.error_stats.absolute_sample;
1810         if(0 != frame_number)
1811                 *frame_number = encoder->private_->verify.error_stats.frame_number;
1812         if(0 != channel)
1813                 *channel = encoder->private_->verify.error_stats.channel;
1814         if(0 != sample)
1815                 *sample = encoder->private_->verify.error_stats.sample;
1816         if(0 != expected)
1817                 *expected = encoder->private_->verify.error_stats.expected;
1818         if(0 != got)
1819                 *got = encoder->private_->verify.error_stats.got;
1820 }
1821
1822 FLAC_API FLAC__bool FLAC__stream_encoder_get_verify(const FLAC__StreamEncoder *encoder)
1823 {
1824         FLAC__ASSERT(0 != encoder);
1825         FLAC__ASSERT(0 != encoder->private_);
1826         FLAC__ASSERT(0 != encoder->protected_);
1827         return encoder->protected_->verify;
1828 }
1829
1830 FLAC_API FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder)
1831 {
1832         FLAC__ASSERT(0 != encoder);
1833         FLAC__ASSERT(0 != encoder->private_);
1834         FLAC__ASSERT(0 != encoder->protected_);
1835         return encoder->protected_->streamable_subset;
1836 }
1837
1838 FLAC_API unsigned FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder)
1839 {
1840         FLAC__ASSERT(0 != encoder);
1841         FLAC__ASSERT(0 != encoder->private_);
1842         FLAC__ASSERT(0 != encoder->protected_);
1843         return encoder->protected_->channels;
1844 }
1845
1846 FLAC_API unsigned FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder)
1847 {
1848         FLAC__ASSERT(0 != encoder);
1849         FLAC__ASSERT(0 != encoder->private_);
1850         FLAC__ASSERT(0 != encoder->protected_);
1851         return encoder->protected_->bits_per_sample;
1852 }
1853
1854 FLAC_API unsigned FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder)
1855 {
1856         FLAC__ASSERT(0 != encoder);
1857         FLAC__ASSERT(0 != encoder->private_);
1858         FLAC__ASSERT(0 != encoder->protected_);
1859         return encoder->protected_->sample_rate;
1860 }
1861
1862 FLAC_API unsigned FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder)
1863 {
1864         FLAC__ASSERT(0 != encoder);
1865         FLAC__ASSERT(0 != encoder->private_);
1866         FLAC__ASSERT(0 != encoder->protected_);
1867         return encoder->protected_->blocksize;
1868 }
1869
1870 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder)
1871 {
1872         FLAC__ASSERT(0 != encoder);
1873         FLAC__ASSERT(0 != encoder->private_);
1874         FLAC__ASSERT(0 != encoder->protected_);
1875         return encoder->protected_->do_mid_side_stereo;
1876 }
1877
1878 FLAC_API FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder)
1879 {
1880         FLAC__ASSERT(0 != encoder);
1881         FLAC__ASSERT(0 != encoder->private_);
1882         FLAC__ASSERT(0 != encoder->protected_);
1883         return encoder->protected_->loose_mid_side_stereo;
1884 }
1885
1886 FLAC_API unsigned FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder)
1887 {
1888         FLAC__ASSERT(0 != encoder);
1889         FLAC__ASSERT(0 != encoder->private_);
1890         FLAC__ASSERT(0 != encoder->protected_);
1891         return encoder->protected_->max_lpc_order;
1892 }
1893
1894 FLAC_API unsigned FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder)
1895 {
1896         FLAC__ASSERT(0 != encoder);
1897         FLAC__ASSERT(0 != encoder->private_);
1898         FLAC__ASSERT(0 != encoder->protected_);
1899         return encoder->protected_->qlp_coeff_precision;
1900 }
1901
1902 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder)
1903 {
1904         FLAC__ASSERT(0 != encoder);
1905         FLAC__ASSERT(0 != encoder->private_);
1906         FLAC__ASSERT(0 != encoder->protected_);
1907         return encoder->protected_->do_qlp_coeff_prec_search;
1908 }
1909
1910 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder)
1911 {
1912         FLAC__ASSERT(0 != encoder);
1913         FLAC__ASSERT(0 != encoder->private_);
1914         FLAC__ASSERT(0 != encoder->protected_);
1915         return encoder->protected_->do_escape_coding;
1916 }
1917
1918 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder)
1919 {
1920         FLAC__ASSERT(0 != encoder);
1921         FLAC__ASSERT(0 != encoder->private_);
1922         FLAC__ASSERT(0 != encoder->protected_);
1923         return encoder->protected_->do_exhaustive_model_search;
1924 }
1925
1926 FLAC_API unsigned FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder)
1927 {
1928         FLAC__ASSERT(0 != encoder);
1929         FLAC__ASSERT(0 != encoder->private_);
1930         FLAC__ASSERT(0 != encoder->protected_);
1931         return encoder->protected_->min_residual_partition_order;
1932 }
1933
1934 FLAC_API unsigned FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder)
1935 {
1936         FLAC__ASSERT(0 != encoder);
1937         FLAC__ASSERT(0 != encoder->private_);
1938         FLAC__ASSERT(0 != encoder->protected_);
1939         return encoder->protected_->max_residual_partition_order;
1940 }
1941
1942 FLAC_API unsigned FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder)
1943 {
1944         FLAC__ASSERT(0 != encoder);
1945         FLAC__ASSERT(0 != encoder->private_);
1946         FLAC__ASSERT(0 != encoder->protected_);
1947         return encoder->protected_->rice_parameter_search_dist;
1948 }
1949
1950 FLAC_API FLAC__uint64 FLAC__stream_encoder_get_total_samples_estimate(const FLAC__StreamEncoder *encoder)
1951 {
1952         FLAC__ASSERT(0 != encoder);
1953         FLAC__ASSERT(0 != encoder->private_);
1954         FLAC__ASSERT(0 != encoder->protected_);
1955         return encoder->protected_->total_samples_estimate;
1956 }
1957
1958 FLAC_API FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples)
1959 {
1960         unsigned i, j, channel;
1961         FLAC__int32 x, mid, side;
1962         const unsigned channels = encoder->protected_->channels, blocksize = encoder->protected_->blocksize;
1963
1964         FLAC__ASSERT(0 != encoder);
1965         FLAC__ASSERT(0 != encoder->private_);
1966         FLAC__ASSERT(0 != encoder->protected_);
1967         FLAC__ASSERT(encoder->protected_->state == FLAC__STREAM_ENCODER_OK);
1968
1969         j = 0;
1970         /*
1971          * we have several flavors of the same basic loop, optimized for
1972          * different conditions:
1973          */
1974         if(encoder->protected_->max_lpc_order > 0) {
1975                 if(encoder->protected_->do_mid_side_stereo && channels == 2) {
1976                         /*
1977                          * stereo coding: unroll channel loop
1978                          * with LPC: calculate floating point version of signal
1979                          */
1980                         do {
1981                                 if(encoder->protected_->verify)
1982                                         append_to_verify_fifo_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
1983
1984                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
1985                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
1986                                         x = mid = side = buffer[0][j];
1987                                         encoder->private_->integer_signal[0][i] = x;
1988 #ifndef FLAC__INTEGER_ONLY_LIBRARY
1989                                         encoder->private_->real_signal[0][i] = (FLAC__real)x;
1990 #endif
1991                                         x = buffer[1][j];
1992                                         encoder->private_->integer_signal[1][i] = x;
1993 #ifndef FLAC__INTEGER_ONLY_LIBRARY
1994                                         encoder->private_->real_signal[1][i] = (FLAC__real)x;
1995 #endif
1996                                         mid += x;
1997                                         side -= x;
1998                                         mid >>= 1; /* NOTE: not the same as 'mid = (buffer[0][j] + buffer[1][j]) / 2' ! */
1999                                         encoder->private_->integer_signal_mid_side[1][i] = side;
2000                                         encoder->private_->integer_signal_mid_side[0][i] = mid;
2001 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2002                                         encoder->private_->real_signal_mid_side[1][i] = (FLAC__real)side;
2003                                         encoder->private_->real_signal_mid_side[0][i] = (FLAC__real)mid;
2004 #endif
2005                                         encoder->private_->current_sample_number++;
2006                                 }
2007                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2008                                 if(i > blocksize) {
2009                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2010                                                 return false;
2011                                         /* move unprocessed overread samples to beginnings of arrays */
2012                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2013                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2014                                         i--;
2015                                         encoder->private_->integer_signal[0][0] = encoder->private_->integer_signal[0][i];
2016                                         encoder->private_->integer_signal[1][0] = encoder->private_->integer_signal[1][i];
2017                                         encoder->private_->integer_signal_mid_side[0][0] = encoder->private_->integer_signal_mid_side[0][i];
2018                                         encoder->private_->integer_signal_mid_side[1][0] = encoder->private_->integer_signal_mid_side[1][i];
2019 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2020                                         encoder->private_->real_signal[0][0] = encoder->private_->real_signal[0][i];
2021                                         encoder->private_->real_signal[1][0] = encoder->private_->real_signal[1][i];
2022                                         encoder->private_->real_signal_mid_side[0][0] = encoder->private_->real_signal_mid_side[0][i];
2023                                         encoder->private_->real_signal_mid_side[1][0] = encoder->private_->real_signal_mid_side[1][i];
2024 #endif
2025                                         encoder->private_->current_sample_number = 1;
2026                                 }
2027                         } while(j < samples);
2028                 }
2029                 else {
2030                         /*
2031                          * independent channel coding: buffer each channel in inner loop
2032                          * with LPC: calculate floating point version of signal
2033                          */
2034                         do {
2035                                 if(encoder->protected_->verify)
2036                                         append_to_verify_fifo_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
2037
2038                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2039                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2040                                         for(channel = 0; channel < channels; channel++) {
2041                                                 x = buffer[channel][j];
2042                                                 encoder->private_->integer_signal[channel][i] = x;
2043 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2044                                                 encoder->private_->real_signal[channel][i] = (FLAC__real)x;
2045 #endif
2046                                         }
2047                                         encoder->private_->current_sample_number++;
2048                                 }
2049                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2050                                 if(i > blocksize) {
2051                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2052                                                 return false;
2053                                         /* move unprocessed overread samples to beginnings of arrays */
2054                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2055                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2056                                         i--;
2057                                         for(channel = 0; channel < channels; channel++) {
2058                                                 encoder->private_->integer_signal[channel][0] = encoder->private_->integer_signal[channel][i];
2059 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2060                                                 encoder->private_->real_signal[channel][0] = encoder->private_->real_signal[channel][i];
2061 #endif
2062                                         }
2063                                         encoder->private_->current_sample_number = 1;
2064                                 }
2065                         } while(j < samples);
2066                 }
2067         }
2068         else {
2069                 if(encoder->protected_->do_mid_side_stereo && channels == 2) {
2070                         /*
2071                          * stereo coding: unroll channel loop
2072                          * without LPC: no need to calculate floating point version of signal
2073                          */
2074                         do {
2075                                 if(encoder->protected_->verify)
2076                                         append_to_verify_fifo_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
2077
2078                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2079                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2080                                         encoder->private_->integer_signal[0][i] = mid = side = buffer[0][j];
2081                                         x = buffer[1][j];
2082                                         encoder->private_->integer_signal[1][i] = x;
2083                                         mid += x;
2084                                         side -= x;
2085                                         mid >>= 1; /* NOTE: not the same as 'mid = (buffer[0][j] + buffer[1][j]) / 2' ! */
2086                                         encoder->private_->integer_signal_mid_side[1][i] = side;
2087                                         encoder->private_->integer_signal_mid_side[0][i] = mid;
2088                                         encoder->private_->current_sample_number++;
2089                                 }
2090                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2091                                 if(i > blocksize) {
2092                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2093                                                 return false;
2094                                         /* move unprocessed overread samples to beginnings of arrays */
2095                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2096                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2097                                         i--;
2098                                         encoder->private_->integer_signal[0][0] = encoder->private_->integer_signal[0][i];
2099                                         encoder->private_->integer_signal[1][0] = encoder->private_->integer_signal[1][i];
2100                                         encoder->private_->integer_signal_mid_side[0][0] = encoder->private_->integer_signal_mid_side[0][i];
2101                                         encoder->private_->integer_signal_mid_side[1][0] = encoder->private_->integer_signal_mid_side[1][i];
2102                                         encoder->private_->current_sample_number = 1;
2103                                 }
2104                         } while(j < samples);
2105                 }
2106                 else {
2107                         /*
2108                          * independent channel coding: buffer each channel in inner loop
2109                          * without LPC: no need to calculate floating point version of signal
2110                          */
2111                         do {
2112                                 if(encoder->protected_->verify)
2113                                         append_to_verify_fifo_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
2114
2115                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2116                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2117                                         for(channel = 0; channel < channels; channel++)
2118                                                 encoder->private_->integer_signal[channel][i] = buffer[channel][j];
2119                                         encoder->private_->current_sample_number++;
2120                                 }
2121                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2122                                 if(i > blocksize) {
2123                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2124                                                 return false;
2125                                         /* move unprocessed overread samples to beginnings of arrays */
2126                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2127                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2128                                         i--;
2129                                         for(channel = 0; channel < channels; channel++)
2130                                                 encoder->private_->integer_signal[channel][0] = encoder->private_->integer_signal[channel][i];
2131                                         encoder->private_->current_sample_number = 1;
2132                                 }
2133                         } while(j < samples);
2134                 }
2135         }
2136
2137         return true;
2138 }
2139
2140 FLAC_API FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples)
2141 {
2142         unsigned i, j, k, channel;
2143         FLAC__int32 x, mid, side;
2144         const unsigned channels = encoder->protected_->channels, blocksize = encoder->protected_->blocksize;
2145
2146         FLAC__ASSERT(0 != encoder);
2147         FLAC__ASSERT(0 != encoder->private_);
2148         FLAC__ASSERT(0 != encoder->protected_);
2149         FLAC__ASSERT(encoder->protected_->state == FLAC__STREAM_ENCODER_OK);
2150
2151         j = k = 0;
2152         /*
2153          * we have several flavors of the same basic loop, optimized for
2154          * different conditions:
2155          */
2156         if(encoder->protected_->max_lpc_order > 0) {
2157                 if(encoder->protected_->do_mid_side_stereo && channels == 2) {
2158                         /*
2159                          * stereo coding: unroll channel loop
2160                          * with LPC: calculate floating point version of signal
2161                          */
2162                         do {
2163                                 if(encoder->protected_->verify)
2164                                         append_to_verify_fifo_interleaved_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
2165
2166                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2167                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2168                                         x = mid = side = buffer[k++];
2169                                         encoder->private_->integer_signal[0][i] = x;
2170 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2171                                         encoder->private_->real_signal[0][i] = (FLAC__real)x;
2172 #endif
2173                                         x = buffer[k++];
2174                                         encoder->private_->integer_signal[1][i] = x;
2175 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2176                                         encoder->private_->real_signal[1][i] = (FLAC__real)x;
2177 #endif
2178                                         mid += x;
2179                                         side -= x;
2180                                         mid >>= 1; /* NOTE: not the same as 'mid = (left + right) / 2' ! */
2181                                         encoder->private_->integer_signal_mid_side[1][i] = side;
2182                                         encoder->private_->integer_signal_mid_side[0][i] = mid;
2183 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2184                                         encoder->private_->real_signal_mid_side[1][i] = (FLAC__real)side;
2185                                         encoder->private_->real_signal_mid_side[0][i] = (FLAC__real)mid;
2186 #endif
2187                                         encoder->private_->current_sample_number++;
2188                                 }
2189                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2190                                 if(i > blocksize) {
2191                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2192                                                 return false;
2193                                         /* move unprocessed overread samples to beginnings of arrays */
2194                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2195                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2196                                         i--;
2197                                         encoder->private_->integer_signal[0][0] = encoder->private_->integer_signal[0][i];
2198                                         encoder->private_->integer_signal[1][0] = encoder->private_->integer_signal[1][i];
2199                                         encoder->private_->integer_signal_mid_side[0][0] = encoder->private_->integer_signal_mid_side[0][i];
2200                                         encoder->private_->integer_signal_mid_side[1][0] = encoder->private_->integer_signal_mid_side[1][i];
2201 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2202                                         encoder->private_->real_signal[0][0] = encoder->private_->real_signal[0][i];
2203                                         encoder->private_->real_signal[1][0] = encoder->private_->real_signal[1][i];
2204                                         encoder->private_->real_signal_mid_side[0][0] = encoder->private_->real_signal_mid_side[0][i];
2205                                         encoder->private_->real_signal_mid_side[1][0] = encoder->private_->real_signal_mid_side[1][i];
2206 #endif
2207                                         encoder->private_->current_sample_number = 1;
2208                                 }
2209                         } while(j < samples);
2210                 }
2211                 else {
2212                         /*
2213                          * independent channel coding: buffer each channel in inner loop
2214                          * with LPC: calculate floating point version of signal
2215                          */
2216                         do {
2217                                 if(encoder->protected_->verify)
2218                                         append_to_verify_fifo_interleaved_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
2219
2220                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2221                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2222                                         for(channel = 0; channel < channels; channel++) {
2223                                                 x = buffer[k++];
2224                                                 encoder->private_->integer_signal[channel][i] = x;
2225 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2226                                                 encoder->private_->real_signal[channel][i] = (FLAC__real)x;
2227 #endif
2228                                         }
2229                                         encoder->private_->current_sample_number++;
2230                                 }
2231                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2232                                 if(i > blocksize) {
2233                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2234                                                 return false;
2235                                         /* move unprocessed overread samples to beginnings of arrays */
2236                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2237                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2238                                         i--;
2239                                         for(channel = 0; channel < channels; channel++) {
2240                                                 encoder->private_->integer_signal[channel][0] = encoder->private_->integer_signal[channel][i];
2241 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2242                                                 encoder->private_->real_signal[channel][0] = encoder->private_->real_signal[channel][i];
2243 #endif
2244                                         }
2245                                         encoder->private_->current_sample_number = 1;
2246                                 }
2247                         } while(j < samples);
2248                 }
2249         }
2250         else {
2251                 if(encoder->protected_->do_mid_side_stereo && channels == 2) {
2252                         /*
2253                          * stereo coding: unroll channel loop
2254                          * without LPC: no need to calculate floating point version of signal
2255                          */
2256                         do {
2257                                 if(encoder->protected_->verify)
2258                                         append_to_verify_fifo_interleaved_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
2259
2260                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2261                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2262                                         encoder->private_->integer_signal[0][i] = mid = side = buffer[k++];
2263                                         x = buffer[k++];
2264                                         encoder->private_->integer_signal[1][i] = x;
2265                                         mid += x;
2266                                         side -= x;
2267                                         mid >>= 1; /* NOTE: not the same as 'mid = (left + right) / 2' ! */
2268                                         encoder->private_->integer_signal_mid_side[1][i] = side;
2269                                         encoder->private_->integer_signal_mid_side[0][i] = mid;
2270                                         encoder->private_->current_sample_number++;
2271                                 }
2272                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2273                                 if(i > blocksize) {
2274                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2275                                                 return false;
2276                                         /* move unprocessed overread samples to beginnings of arrays */
2277                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2278                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2279                                         i--;
2280                                         encoder->private_->integer_signal[0][0] = encoder->private_->integer_signal[0][i];
2281                                         encoder->private_->integer_signal[1][0] = encoder->private_->integer_signal[1][i];
2282                                         encoder->private_->integer_signal_mid_side[0][0] = encoder->private_->integer_signal_mid_side[0][i];
2283                                         encoder->private_->integer_signal_mid_side[1][0] = encoder->private_->integer_signal_mid_side[1][i];
2284                                         encoder->private_->current_sample_number = 1;
2285                                 }
2286                         } while(j < samples);
2287                 }
2288                 else {
2289                         /*
2290                          * independent channel coding: buffer each channel in inner loop
2291                          * without LPC: no need to calculate floating point version of signal
2292                          */
2293                         do {
2294                                 if(encoder->protected_->verify)
2295                                         append_to_verify_fifo_interleaved_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+1-encoder->private_->current_sample_number, samples-j));
2296
2297                                 /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2298                                 for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2299                                         for(channel = 0; channel < channels; channel++)
2300                                                 encoder->private_->integer_signal[channel][i] = buffer[k++];
2301                                         encoder->private_->current_sample_number++;
2302                                 }
2303                                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2304                                 if(i > blocksize) {
2305                                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2306                                                 return false;
2307                                         /* move unprocessed overread samples to beginnings of arrays */
2308                                         FLAC__ASSERT(i == blocksize+OVERREAD_);
2309                                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2310                                         i--;
2311                                         for(channel = 0; channel < channels; channel++)
2312                                                 encoder->private_->integer_signal[channel][0] = encoder->private_->integer_signal[channel][i];
2313                                         encoder->private_->current_sample_number = 1;
2314                                 }
2315                         } while(j < samples);
2316                 }
2317         }
2318
2319         return true;
2320 }
2321
2322 /***********************************************************************
2323  *
2324  * Private class methods
2325  *
2326  ***********************************************************************/
2327
2328 void set_defaults_(FLAC__StreamEncoder *encoder)
2329 {
2330         FLAC__ASSERT(0 != encoder);
2331
2332 #ifdef FLAC__MANDATORY_VERIFY_WHILE_ENCODING
2333         encoder->protected_->verify = true;
2334 #else
2335         encoder->protected_->verify = false;
2336 #endif
2337         encoder->protected_->streamable_subset = true;
2338         encoder->protected_->do_mid_side_stereo = false;
2339         encoder->protected_->loose_mid_side_stereo = false;
2340         encoder->protected_->channels = 2;
2341         encoder->protected_->bits_per_sample = 16;
2342         encoder->protected_->sample_rate = 44100;
2343         encoder->protected_->blocksize = 0;
2344 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2345         encoder->protected_->num_apodizations = 1;
2346         encoder->protected_->apodizations[0].type = FLAC__APODIZATION_TUKEY;
2347         encoder->protected_->apodizations[0].parameters.tukey.p = 0.5;
2348 #endif
2349         encoder->protected_->max_lpc_order = 0;
2350         encoder->protected_->qlp_coeff_precision = 0;
2351         encoder->protected_->do_qlp_coeff_prec_search = false;
2352         encoder->protected_->do_exhaustive_model_search = false;
2353         encoder->protected_->do_escape_coding = false;
2354         encoder->protected_->min_residual_partition_order = 0;
2355         encoder->protected_->max_residual_partition_order = 0;
2356         encoder->protected_->rice_parameter_search_dist = 0;
2357         encoder->protected_->total_samples_estimate = 0;
2358         encoder->protected_->metadata = 0;
2359         encoder->protected_->num_metadata_blocks = 0;
2360
2361         encoder->private_->seek_table = 0;
2362         encoder->private_->disable_constant_subframes = false;
2363         encoder->private_->disable_fixed_subframes = false;
2364         encoder->private_->disable_verbatim_subframes = false;
2365 #if FLAC__HAS_OGG
2366         encoder->private_->is_ogg = false;
2367 #endif
2368         encoder->private_->read_callback = 0;
2369         encoder->private_->write_callback = 0;
2370         encoder->private_->seek_callback = 0;
2371         encoder->private_->tell_callback = 0;
2372         encoder->private_->metadata_callback = 0;
2373         encoder->private_->progress_callback = 0;
2374         encoder->private_->client_data = 0;
2375
2376 #if FLAC__HAS_OGG
2377         FLAC__ogg_encoder_aspect_set_defaults(&encoder->protected_->ogg_encoder_aspect);
2378 #endif
2379 }
2380
2381 void free_(FLAC__StreamEncoder *encoder)
2382 {
2383         unsigned i, channel;
2384
2385         FLAC__ASSERT(0 != encoder);
2386         if(encoder->protected_->metadata) {
2387                 free(encoder->protected_->metadata);
2388                 encoder->protected_->metadata = 0;
2389                 encoder->protected_->num_metadata_blocks = 0;
2390         }
2391         for(i = 0; i < encoder->protected_->channels; i++) {
2392                 if(0 != encoder->private_->integer_signal_unaligned[i]) {
2393                         free(encoder->private_->integer_signal_unaligned[i]);
2394                         encoder->private_->integer_signal_unaligned[i] = 0;
2395                 }
2396 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2397                 if(0 != encoder->private_->real_signal_unaligned[i]) {
2398                         free(encoder->private_->real_signal_unaligned[i]);
2399                         encoder->private_->real_signal_unaligned[i] = 0;
2400                 }
2401 #endif
2402         }
2403         for(i = 0; i < 2; i++) {
2404                 if(0 != encoder->private_->integer_signal_mid_side_unaligned[i]) {
2405                         free(encoder->private_->integer_signal_mid_side_unaligned[i]);
2406                         encoder->private_->integer_signal_mid_side_unaligned[i] = 0;
2407                 }
2408 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2409                 if(0 != encoder->private_->real_signal_mid_side_unaligned[i]) {
2410                         free(encoder->private_->real_signal_mid_side_unaligned[i]);
2411                         encoder->private_->real_signal_mid_side_unaligned[i] = 0;
2412                 }
2413 #endif
2414         }
2415 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2416         for(i = 0; i < encoder->protected_->num_apodizations; i++) {
2417                 if(0 != encoder->private_->window_unaligned[i]) {
2418                         free(encoder->private_->window_unaligned[i]);
2419                         encoder->private_->window_unaligned[i] = 0;
2420                 }
2421         }
2422         if(0 != encoder->private_->windowed_signal_unaligned) {
2423                 free(encoder->private_->windowed_signal_unaligned);
2424                 encoder->private_->windowed_signal_unaligned = 0;
2425         }
2426 #endif
2427         for(channel = 0; channel < encoder->protected_->channels; channel++) {
2428                 for(i = 0; i < 2; i++) {
2429                         if(0 != encoder->private_->residual_workspace_unaligned[channel][i]) {
2430                                 free(encoder->private_->residual_workspace_unaligned[channel][i]);
2431                                 encoder->private_->residual_workspace_unaligned[channel][i] = 0;
2432                         }
2433                 }
2434         }
2435         for(channel = 0; channel < 2; channel++) {
2436                 for(i = 0; i < 2; i++) {
2437                         if(0 != encoder->private_->residual_workspace_mid_side_unaligned[channel][i]) {
2438                                 free(encoder->private_->residual_workspace_mid_side_unaligned[channel][i]);
2439                                 encoder->private_->residual_workspace_mid_side_unaligned[channel][i] = 0;
2440                         }
2441                 }
2442         }
2443         if(0 != encoder->private_->abs_residual_partition_sums_unaligned) {
2444                 free(encoder->private_->abs_residual_partition_sums_unaligned);
2445                 encoder->private_->abs_residual_partition_sums_unaligned = 0;
2446         }
2447         if(0 != encoder->private_->raw_bits_per_partition_unaligned) {
2448                 free(encoder->private_->raw_bits_per_partition_unaligned);
2449                 encoder->private_->raw_bits_per_partition_unaligned = 0;
2450         }
2451         if(encoder->protected_->verify) {
2452                 for(i = 0; i < encoder->protected_->channels; i++) {
2453                         if(0 != encoder->private_->verify.input_fifo.data[i]) {
2454                                 free(encoder->private_->verify.input_fifo.data[i]);
2455                                 encoder->private_->verify.input_fifo.data[i] = 0;
2456                         }
2457                 }
2458         }
2459         FLAC__bitwriter_free(encoder->private_->frame);
2460 }
2461
2462 FLAC__bool resize_buffers_(FLAC__StreamEncoder *encoder, unsigned new_blocksize)
2463 {
2464         FLAC__bool ok;
2465         unsigned i, channel;
2466
2467         FLAC__ASSERT(new_blocksize > 0);
2468         FLAC__ASSERT(encoder->protected_->state == FLAC__STREAM_ENCODER_OK);
2469         FLAC__ASSERT(encoder->private_->current_sample_number == 0);
2470
2471         /* To avoid excessive malloc'ing, we only grow the buffer; no shrinking. */
2472         if(new_blocksize <= encoder->private_->input_capacity)
2473                 return true;
2474
2475         ok = true;
2476
2477         /* WATCHOUT: FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32_mmx()
2478          * requires that the input arrays (in our case the integer signals)
2479          * have a buffer of up to 3 zeroes in front (at negative indices) for
2480          * alignment purposes; we use 4 in front to keep the data well-aligned.
2481          */
2482
2483         for(i = 0; ok && i < encoder->protected_->channels; i++) {
2484                 ok = ok && FLAC__memory_alloc_aligned_int32_array(new_blocksize+4+OVERREAD_, &encoder->private_->integer_signal_unaligned[i], &encoder->private_->integer_signal[i]);
2485                 memset(encoder->private_->integer_signal[i], 0, sizeof(FLAC__int32)*4);
2486                 encoder->private_->integer_signal[i] += 4;
2487 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2488                 if(encoder->protected_->max_lpc_order > 0)
2489                         ok = ok && FLAC__memory_alloc_aligned_real_array(new_blocksize+OVERREAD_, &encoder->private_->real_signal_unaligned[i], &encoder->private_->real_signal[i]);
2490 #endif
2491         }
2492         for(i = 0; ok && i < 2; i++) {
2493                 ok = ok && FLAC__memory_alloc_aligned_int32_array(new_blocksize+4+OVERREAD_, &encoder->private_->integer_signal_mid_side_unaligned[i], &encoder->private_->integer_signal_mid_side[i]);
2494                 memset(encoder->private_->integer_signal_mid_side[i], 0, sizeof(FLAC__int32)*4);
2495                 encoder->private_->integer_signal_mid_side[i] += 4;
2496 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2497                 if(encoder->protected_->max_lpc_order > 0)
2498                         ok = ok && FLAC__memory_alloc_aligned_real_array(new_blocksize+OVERREAD_, &encoder->private_->real_signal_mid_side_unaligned[i], &encoder->private_->real_signal_mid_side[i]);
2499 #endif
2500         }
2501 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2502         if(ok && encoder->protected_->max_lpc_order > 0) {
2503                 for(i = 0; ok && i < encoder->protected_->num_apodizations; i++)
2504                         ok = ok && FLAC__memory_alloc_aligned_real_array(new_blocksize, &encoder->private_->window_unaligned[i], &encoder->private_->window[i]);
2505                 ok = ok && FLAC__memory_alloc_aligned_real_array(new_blocksize, &encoder->private_->windowed_signal_unaligned, &encoder->private_->windowed_signal);
2506         }
2507 #endif
2508         for(channel = 0; ok && channel < encoder->protected_->channels; channel++) {
2509                 for(i = 0; ok && i < 2; i++) {
2510                         ok = ok && FLAC__memory_alloc_aligned_int32_array(new_blocksize, &encoder->private_->residual_workspace_unaligned[channel][i], &encoder->private_->residual_workspace[channel][i]);
2511                 }
2512         }
2513         for(channel = 0; ok && channel < 2; channel++) {
2514                 for(i = 0; ok && i < 2; i++) {
2515                         ok = ok && FLAC__memory_alloc_aligned_int32_array(new_blocksize, &encoder->private_->residual_workspace_mid_side_unaligned[channel][i], &encoder->private_->residual_workspace_mid_side[channel][i]);
2516                 }
2517         }
2518         /* @@@@@@@@@ blocksize*2 is too pessimistic, but to fix, we need smarter logic because a smaller new_blocksize can actually increase the # of partitions */
2519         ok = ok && FLAC__memory_alloc_aligned_uint64_array(new_blocksize * 2, &encoder->private_->abs_residual_partition_sums_unaligned, &encoder->private_->abs_residual_partition_sums);
2520         if(encoder->protected_->do_escape_coding)
2521                 ok = ok && FLAC__memory_alloc_aligned_unsigned_array(new_blocksize * 2, &encoder->private_->raw_bits_per_partition_unaligned, &encoder->private_->raw_bits_per_partition);
2522
2523         /* now adjust the windows if the blocksize has changed */
2524 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2525         if(ok && new_blocksize != encoder->private_->input_capacity && encoder->protected_->max_lpc_order > 0) {
2526                 for(i = 0; ok && i < encoder->protected_->num_apodizations; i++) {
2527                         switch(encoder->protected_->apodizations[i].type) {
2528                                 case FLAC__APODIZATION_BARTLETT:
2529                                         FLAC__window_bartlett(encoder->private_->window[i], new_blocksize);
2530                                         break;
2531                                 case FLAC__APODIZATION_BARTLETT_HANN:
2532                                         FLAC__window_bartlett_hann(encoder->private_->window[i], new_blocksize);
2533                                         break;
2534                                 case FLAC__APODIZATION_BLACKMAN:
2535                                         FLAC__window_blackman(encoder->private_->window[i], new_blocksize);
2536                                         break;
2537                                 case FLAC__APODIZATION_BLACKMAN_HARRIS_4TERM_92DB_SIDELOBE:
2538                                         FLAC__window_blackman_harris_4term_92db_sidelobe(encoder->private_->window[i], new_blocksize);
2539                                         break;
2540                                 case FLAC__APODIZATION_CONNES:
2541                                         FLAC__window_connes(encoder->private_->window[i], new_blocksize);
2542                                         break;
2543                                 case FLAC__APODIZATION_FLATTOP:
2544                                         FLAC__window_flattop(encoder->private_->window[i], new_blocksize);
2545                                         break;
2546                                 case FLAC__APODIZATION_GAUSS:
2547                                         FLAC__window_gauss(encoder->private_->window[i], new_blocksize, encoder->protected_->apodizations[i].parameters.gauss.stddev);
2548                                         break;
2549                                 case FLAC__APODIZATION_HAMMING:
2550                                         FLAC__window_hamming(encoder->private_->window[i], new_blocksize);
2551                                         break;
2552                                 case FLAC__APODIZATION_HANN:
2553                                         FLAC__window_hann(encoder->private_->window[i], new_blocksize);
2554                                         break;
2555                                 case FLAC__APODIZATION_KAISER_BESSEL:
2556                                         FLAC__window_kaiser_bessel(encoder->private_->window[i], new_blocksize);
2557                                         break;
2558                                 case FLAC__APODIZATION_NUTTALL:
2559                                         FLAC__window_nuttall(encoder->private_->window[i], new_blocksize);
2560                                         break;
2561                                 case FLAC__APODIZATION_RECTANGLE:
2562                                         FLAC__window_rectangle(encoder->private_->window[i], new_blocksize);
2563                                         break;
2564                                 case FLAC__APODIZATION_TRIANGLE:
2565                                         FLAC__window_triangle(encoder->private_->window[i], new_blocksize);
2566                                         break;
2567                                 case FLAC__APODIZATION_TUKEY:
2568                                         FLAC__window_tukey(encoder->private_->window[i], new_blocksize, encoder->protected_->apodizations[i].parameters.tukey.p);
2569                                         break;
2570                                 case FLAC__APODIZATION_WELCH:
2571                                         FLAC__window_welch(encoder->private_->window[i], new_blocksize);
2572                                         break;
2573                                 default:
2574                                         FLAC__ASSERT(0);
2575                                         /* double protection */
2576                                         FLAC__window_hann(encoder->private_->window[i], new_blocksize);
2577                                         break;
2578                         }
2579                 }
2580         }
2581 #endif
2582
2583         if(ok)
2584                 encoder->private_->input_capacity = new_blocksize;
2585         else
2586                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
2587
2588         return ok;
2589 }
2590
2591 FLAC__bool write_bitbuffer_(FLAC__StreamEncoder *encoder, unsigned samples, FLAC__bool is_last_block)
2592 {
2593         const FLAC__byte *buffer;
2594         size_t bytes;
2595
2596         FLAC__ASSERT(FLAC__bitwriter_is_byte_aligned(encoder->private_->frame));
2597
2598         if(!FLAC__bitwriter_get_buffer(encoder->private_->frame, &buffer, &bytes)) {
2599                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
2600                 return false;
2601         }
2602
2603         if(encoder->protected_->verify) {
2604                 encoder->private_->verify.output.data = buffer;
2605                 encoder->private_->verify.output.bytes = bytes;
2606                 if(encoder->private_->verify.state_hint == ENCODER_IN_MAGIC) {
2607                         encoder->private_->verify.needs_magic_hack = true;
2608                 }
2609                 else {
2610                         if(!FLAC__stream_decoder_process_single(encoder->private_->verify.decoder)) {
2611                                 FLAC__bitwriter_release_buffer(encoder->private_->frame);
2612                                 FLAC__bitwriter_clear(encoder->private_->frame);
2613                                 if(encoder->protected_->state != FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA)
2614                                         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR;
2615                                 return false;
2616                         }
2617                 }
2618         }
2619
2620         if(write_frame_(encoder, buffer, bytes, samples, is_last_block) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2621                 FLAC__bitwriter_release_buffer(encoder->private_->frame);
2622                 FLAC__bitwriter_clear(encoder->private_->frame);
2623                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2624                 return false;
2625         }
2626
2627         FLAC__bitwriter_release_buffer(encoder->private_->frame);
2628         FLAC__bitwriter_clear(encoder->private_->frame);
2629
2630         if(samples > 0) {
2631                 encoder->private_->streaminfo.data.stream_info.min_framesize = min(bytes, encoder->private_->streaminfo.data.stream_info.min_framesize);
2632                 encoder->private_->streaminfo.data.stream_info.max_framesize = max(bytes, encoder->private_->streaminfo.data.stream_info.max_framesize);
2633         }
2634
2635         return true;
2636 }
2637
2638 FLAC__StreamEncoderWriteStatus write_frame_(FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, FLAC__bool is_last_block)
2639 {
2640         FLAC__StreamEncoderWriteStatus status;
2641         FLAC__uint64 output_position = 0;
2642
2643         /* FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED just means we didn't get the offset; no error */
2644         if(encoder->private_->tell_callback && encoder->private_->tell_callback(encoder, &output_position, encoder->private_->client_data) == FLAC__STREAM_ENCODER_TELL_STATUS_ERROR) {
2645                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2646                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
2647         }
2648
2649         /*
2650          * Watch for the STREAMINFO block and first SEEKTABLE block to go by and store their offsets.
2651          */
2652         if(samples == 0) {
2653                 FLAC__MetadataType type = (buffer[0] & 0x7f);
2654                 if(type == FLAC__METADATA_TYPE_STREAMINFO)
2655                         encoder->protected_->streaminfo_offset = output_position;
2656                 else if(type == FLAC__METADATA_TYPE_SEEKTABLE && encoder->protected_->seektable_offset == 0)
2657                         encoder->protected_->seektable_offset = output_position;
2658         }
2659
2660         /*
2661          * Mark the current seek point if hit (if audio_offset == 0 that
2662          * means we're still writing metadata and haven't hit the first
2663          * frame yet)
2664          */
2665         if(0 != encoder->private_->seek_table && encoder->protected_->audio_offset > 0 && encoder->private_->seek_table->num_points > 0) {
2666                 const unsigned blocksize = FLAC__stream_encoder_get_blocksize(encoder);
2667                 const FLAC__uint64 frame_first_sample = encoder->private_->samples_written;
2668                 const FLAC__uint64 frame_last_sample = frame_first_sample + (FLAC__uint64)blocksize - 1;
2669                 FLAC__uint64 test_sample;
2670                 unsigned i;
2671                 for(i = encoder->private_->first_seekpoint_to_check; i < encoder->private_->seek_table->num_points; i++) {
2672                         test_sample = encoder->private_->seek_table->points[i].sample_number;
2673                         if(test_sample > frame_last_sample) {
2674                                 break;
2675                         }
2676                         else if(test_sample >= frame_first_sample) {
2677                                 encoder->private_->seek_table->points[i].sample_number = frame_first_sample;
2678                                 encoder->private_->seek_table->points[i].stream_offset = output_position - encoder->protected_->audio_offset;
2679                                 encoder->private_->seek_table->points[i].frame_samples = blocksize;
2680                                 encoder->private_->first_seekpoint_to_check++;
2681                                 /* DO NOT: "break;" and here's why:
2682                                  * The seektable template may contain more than one target
2683                                  * sample for any given frame; we will keep looping, generating
2684                                  * duplicate seekpoints for them, and we'll clean it up later,
2685                                  * just before writing the seektable back to the metadata.
2686                                  */
2687                         }
2688                         else {
2689                                 encoder->private_->first_seekpoint_to_check++;
2690                         }
2691                 }
2692         }
2693
2694 #if FLAC__HAS_OGG
2695         if(encoder->private_->is_ogg) {
2696                 status = FLAC__ogg_encoder_aspect_write_callback_wrapper(
2697                         &encoder->protected_->ogg_encoder_aspect,
2698                         buffer,
2699                         bytes,
2700                         samples,
2701                         encoder->private_->current_frame_number,
2702                         is_last_block,
2703                         (FLAC__OggEncoderAspectWriteCallbackProxy)encoder->private_->write_callback,
2704                         encoder,
2705                         encoder->private_->client_data
2706                 );
2707         }
2708         else
2709 #endif
2710         status = encoder->private_->write_callback(encoder, buffer, bytes, samples, encoder->private_->current_frame_number, encoder->private_->client_data);
2711
2712         if(status == FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2713                 encoder->private_->bytes_written += bytes;
2714                 encoder->private_->samples_written += samples;
2715                 /* we keep a high watermark on the number of frames written because
2716                  * when the encoder goes back to write metadata, 'current_frame'
2717                  * will drop back to 0.
2718                  */
2719                 encoder->private_->frames_written = max(encoder->private_->frames_written, encoder->private_->current_frame_number+1);
2720         }
2721         else
2722                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2723
2724         return status;
2725 }
2726
2727 /* Gets called when the encoding process has finished so that we can update the STREAMINFO and SEEKTABLE blocks.  */
2728 void update_metadata_(const FLAC__StreamEncoder *encoder)
2729 {
2730         FLAC__byte b[max(6, FLAC__STREAM_METADATA_SEEKPOINT_LENGTH)];
2731         const FLAC__StreamMetadata *metadata = &encoder->private_->streaminfo;
2732         const FLAC__uint64 samples = metadata->data.stream_info.total_samples;
2733         const unsigned min_framesize = metadata->data.stream_info.min_framesize;
2734         const unsigned max_framesize = metadata->data.stream_info.max_framesize;
2735         const unsigned bps = metadata->data.stream_info.bits_per_sample;
2736         FLAC__StreamEncoderSeekStatus seek_status;
2737
2738         FLAC__ASSERT(metadata->type == FLAC__METADATA_TYPE_STREAMINFO);
2739
2740         /* All this is based on intimate knowledge of the stream header
2741          * layout, but a change to the header format that would break this
2742          * would also break all streams encoded in the previous format.
2743          */
2744
2745         /*
2746          * Write MD5 signature
2747          */
2748         {
2749                 const unsigned md5_offset =
2750                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2751                         (
2752                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2753                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2754                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2755                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2756                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2757                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2758                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN +
2759                                 FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN
2760                         ) / 8;
2761
2762                 if((seek_status = encoder->private_->seek_callback(encoder, encoder->protected_->streaminfo_offset + md5_offset, encoder->private_->client_data)) != FLAC__STREAM_ENCODER_SEEK_STATUS_OK) {
2763                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2764                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2765                         return;
2766                 }
2767                 if(encoder->private_->write_callback(encoder, metadata->data.stream_info.md5sum, 16, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2768                         encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2769                         return;
2770                 }
2771         }
2772
2773         /*
2774          * Write total samples
2775          */
2776         {
2777                 const unsigned total_samples_byte_offset =
2778                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2779                         (
2780                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2781                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2782                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2783                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2784                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2785                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2786                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN
2787                                 - 4
2788                         ) / 8;
2789
2790                 b[0] = ((FLAC__byte)(bps-1) << 4) | (FLAC__byte)((samples >> 32) & 0x0F);
2791                 b[1] = (FLAC__byte)((samples >> 24) & 0xFF);
2792                 b[2] = (FLAC__byte)((samples >> 16) & 0xFF);
2793                 b[3] = (FLAC__byte)((samples >> 8) & 0xFF);
2794                 b[4] = (FLAC__byte)(samples & 0xFF);
2795                 if((seek_status = encoder->private_->seek_callback(encoder, encoder->protected_->streaminfo_offset + total_samples_byte_offset, encoder->private_->client_data)) != FLAC__STREAM_ENCODER_SEEK_STATUS_OK) {
2796                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2797                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2798                         return;
2799                 }
2800                 if(encoder->private_->write_callback(encoder, b, 5, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2801                         encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2802                         return;
2803                 }
2804         }
2805
2806         /*
2807          * Write min/max framesize
2808          */
2809         {
2810                 const unsigned min_framesize_offset =
2811                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2812                         (
2813                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2814                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN
2815                         ) / 8;
2816
2817                 b[0] = (FLAC__byte)((min_framesize >> 16) & 0xFF);
2818                 b[1] = (FLAC__byte)((min_framesize >> 8) & 0xFF);
2819                 b[2] = (FLAC__byte)(min_framesize & 0xFF);
2820                 b[3] = (FLAC__byte)((max_framesize >> 16) & 0xFF);
2821                 b[4] = (FLAC__byte)((max_framesize >> 8) & 0xFF);
2822                 b[5] = (FLAC__byte)(max_framesize & 0xFF);
2823                 if((seek_status = encoder->private_->seek_callback(encoder, encoder->protected_->streaminfo_offset + min_framesize_offset, encoder->private_->client_data)) != FLAC__STREAM_ENCODER_SEEK_STATUS_OK) {
2824                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2825                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2826                         return;
2827                 }
2828                 if(encoder->private_->write_callback(encoder, b, 6, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2829                         encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2830                         return;
2831                 }
2832         }
2833
2834         /*
2835          * Write seektable
2836          */
2837         if(0 != encoder->private_->seek_table && encoder->private_->seek_table->num_points > 0 && encoder->protected_->seektable_offset > 0) {
2838                 unsigned i;
2839
2840                 FLAC__format_seektable_sort(encoder->private_->seek_table);
2841
2842                 FLAC__ASSERT(FLAC__format_seektable_is_legal(encoder->private_->seek_table));
2843
2844                 if((seek_status = encoder->private_->seek_callback(encoder, encoder->protected_->seektable_offset + FLAC__STREAM_METADATA_HEADER_LENGTH, encoder->private_->client_data)) != FLAC__STREAM_ENCODER_SEEK_STATUS_OK) {
2845                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2846                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2847                         return;
2848                 }
2849
2850                 for(i = 0; i < encoder->private_->seek_table->num_points; i++) {
2851                         FLAC__uint64 xx;
2852                         unsigned x;
2853                         xx = encoder->private_->seek_table->points[i].sample_number;
2854                         b[7] = (FLAC__byte)xx; xx >>= 8;
2855                         b[6] = (FLAC__byte)xx; xx >>= 8;
2856                         b[5] = (FLAC__byte)xx; xx >>= 8;
2857                         b[4] = (FLAC__byte)xx; xx >>= 8;
2858                         b[3] = (FLAC__byte)xx; xx >>= 8;
2859                         b[2] = (FLAC__byte)xx; xx >>= 8;
2860                         b[1] = (FLAC__byte)xx; xx >>= 8;
2861                         b[0] = (FLAC__byte)xx; xx >>= 8;
2862                         xx = encoder->private_->seek_table->points[i].stream_offset;
2863                         b[15] = (FLAC__byte)xx; xx >>= 8;
2864                         b[14] = (FLAC__byte)xx; xx >>= 8;
2865                         b[13] = (FLAC__byte)xx; xx >>= 8;
2866                         b[12] = (FLAC__byte)xx; xx >>= 8;
2867                         b[11] = (FLAC__byte)xx; xx >>= 8;
2868                         b[10] = (FLAC__byte)xx; xx >>= 8;
2869                         b[9] = (FLAC__byte)xx; xx >>= 8;
2870                         b[8] = (FLAC__byte)xx; xx >>= 8;
2871                         x = encoder->private_->seek_table->points[i].frame_samples;
2872                         b[17] = (FLAC__byte)x; x >>= 8;
2873                         b[16] = (FLAC__byte)x; x >>= 8;
2874                         if(encoder->private_->write_callback(encoder, b, 18, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2875                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2876                                 return;
2877                         }
2878                 }
2879         }
2880 }
2881
2882 #if FLAC__HAS_OGG
2883 /* Gets called when the encoding process has finished so that we can update the STREAMINFO and SEEKTABLE blocks.  */
2884 void update_ogg_metadata_(FLAC__StreamEncoder *encoder)
2885 {
2886         /* the # of bytes in the 1st packet that precede the STREAMINFO */
2887         static const unsigned FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH =
2888                 FLAC__OGG_MAPPING_PACKET_TYPE_LENGTH +
2889                 FLAC__OGG_MAPPING_MAGIC_LENGTH +
2890                 FLAC__OGG_MAPPING_VERSION_MAJOR_LENGTH +
2891                 FLAC__OGG_MAPPING_VERSION_MINOR_LENGTH +
2892                 FLAC__OGG_MAPPING_NUM_HEADERS_LENGTH +
2893                 FLAC__STREAM_SYNC_LENGTH
2894         ;
2895         FLAC__byte b[max(6, FLAC__STREAM_METADATA_SEEKPOINT_LENGTH)];
2896         const FLAC__StreamMetadata *metadata = &encoder->private_->streaminfo;
2897         const FLAC__uint64 samples = metadata->data.stream_info.total_samples;
2898         const unsigned min_framesize = metadata->data.stream_info.min_framesize;
2899         const unsigned max_framesize = metadata->data.stream_info.max_framesize;
2900         ogg_page page;
2901
2902         FLAC__ASSERT(metadata->type == FLAC__METADATA_TYPE_STREAMINFO);
2903         FLAC__ASSERT(0 != encoder->private_->seek_callback);
2904
2905         /* Pre-check that client supports seeking, since we don't want the
2906          * ogg_helper code to ever have to deal with this condition.
2907          */
2908         if(encoder->private_->seek_callback(encoder, 0, encoder->private_->client_data) == FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED)
2909                 return;
2910
2911         /* All this is based on intimate knowledge of the stream header
2912          * layout, but a change to the header format that would break this
2913          * would also break all streams encoded in the previous format.
2914          */
2915
2916         /**
2917          ** Write STREAMINFO stats
2918          **/
2919         simple_ogg_page__init(&page);
2920         if(!simple_ogg_page__get_at(encoder, encoder->protected_->streaminfo_offset, &page, encoder->private_->seek_callback, encoder->private_->read_callback, encoder->private_->client_data)) {
2921                 simple_ogg_page__clear(&page);
2922                 return; /* state already set */
2923         }
2924
2925         /*
2926          * Write MD5 signature
2927          */
2928         {
2929                 const unsigned md5_offset =
2930                         FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH +
2931                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2932                         (
2933                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2934                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2935                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2936                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2937                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2938                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2939                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN +
2940                                 FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN
2941                         ) / 8;
2942
2943                 if(md5_offset + 16 > (unsigned)page.body_len) {
2944                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
2945                         simple_ogg_page__clear(&page);
2946                         return;
2947                 }
2948                 memcpy(page.body + md5_offset, metadata->data.stream_info.md5sum, 16);
2949         }
2950
2951         /*
2952          * Write total samples
2953          */
2954         {
2955                 const unsigned total_samples_byte_offset =
2956                         FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH +
2957                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2958                         (
2959                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2960                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2961                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2962                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2963                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2964                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2965                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN
2966                                 - 4
2967                         ) / 8;
2968
2969                 if(total_samples_byte_offset + 5 > (unsigned)page.body_len) {
2970                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
2971                         simple_ogg_page__clear(&page);
2972                         return;
2973                 }
2974                 b[0] = (FLAC__byte)page.body[total_samples_byte_offset] & 0xF0;
2975                 b[0] |= (FLAC__byte)((samples >> 32) & 0x0F);
2976                 b[1] = (FLAC__byte)((samples >> 24) & 0xFF);
2977                 b[2] = (FLAC__byte)((samples >> 16) & 0xFF);
2978                 b[3] = (FLAC__byte)((samples >> 8) & 0xFF);
2979                 b[4] = (FLAC__byte)(samples & 0xFF);
2980                 memcpy(page.body + total_samples_byte_offset, b, 5);
2981         }
2982
2983         /*
2984          * Write min/max framesize
2985          */
2986         {
2987                 const unsigned min_framesize_offset =
2988                         FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH +
2989                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2990                         (
2991                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2992                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN
2993                         ) / 8;
2994
2995                 if(min_framesize_offset + 6 > (unsigned)page.body_len) {
2996                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
2997                         simple_ogg_page__clear(&page);
2998                         return;
2999                 }
3000                 b[0] = (FLAC__byte)((min_framesize >> 16) & 0xFF);
3001                 b[1] = (FLAC__byte)((min_framesize >> 8) & 0xFF);
3002                 b[2] = (FLAC__byte)(min_framesize & 0xFF);
3003                 b[3] = (FLAC__byte)((max_framesize >> 16) & 0xFF);
3004                 b[4] = (FLAC__byte)((max_framesize >> 8) & 0xFF);
3005                 b[5] = (FLAC__byte)(max_framesize & 0xFF);
3006                 memcpy(page.body + min_framesize_offset, b, 6);
3007         }
3008         if(!simple_ogg_page__set_at(encoder, encoder->protected_->streaminfo_offset, &page, encoder->private_->seek_callback, encoder->private_->write_callback, encoder->private_->client_data)) {
3009                 simple_ogg_page__clear(&page);
3010                 return; /* state already set */
3011         }
3012         simple_ogg_page__clear(&page);
3013
3014         /*
3015          * Write seektable
3016          */
3017         if(0 != encoder->private_->seek_table && encoder->private_->seek_table->num_points > 0 && encoder->protected_->seektable_offset > 0) {
3018                 unsigned i;
3019                 FLAC__byte *p;
3020
3021                 FLAC__format_seektable_sort(encoder->private_->seek_table);
3022
3023                 FLAC__ASSERT(FLAC__format_seektable_is_legal(encoder->private_->seek_table));
3024
3025                 simple_ogg_page__init(&page);
3026                 if(!simple_ogg_page__get_at(encoder, encoder->protected_->seektable_offset, &page, encoder->private_->seek_callback, encoder->private_->read_callback, encoder->private_->client_data)) {
3027                         simple_ogg_page__clear(&page);
3028                         return; /* state already set */
3029                 }
3030
3031                 if((FLAC__STREAM_METADATA_HEADER_LENGTH + 18*encoder->private_->seek_table->num_points) != (unsigned)page.body_len) {
3032                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
3033                         simple_ogg_page__clear(&page);
3034                         return;
3035                 }
3036
3037                 for(i = 0, p = page.body + FLAC__STREAM_METADATA_HEADER_LENGTH; i < encoder->private_->seek_table->num_points; i++, p += 18) {
3038                         FLAC__uint64 xx;
3039                         unsigned x;
3040                         xx = encoder->private_->seek_table->points[i].sample_number;
3041                         b[7] = (FLAC__byte)xx; xx >>= 8;
3042                         b[6] = (FLAC__byte)xx; xx >>= 8;
3043                         b[5] = (FLAC__byte)xx; xx >>= 8;
3044                         b[4] = (FLAC__byte)xx; xx >>= 8;
3045                         b[3] = (FLAC__byte)xx; xx >>= 8;
3046                         b[2] = (FLAC__byte)xx; xx >>= 8;
3047                         b[1] = (FLAC__byte)xx; xx >>= 8;
3048                         b[0] = (FLAC__byte)xx; xx >>= 8;
3049                         xx = encoder->private_->seek_table->points[i].stream_offset;
3050                         b[15] = (FLAC__byte)xx; xx >>= 8;
3051                         b[14] = (FLAC__byte)xx; xx >>= 8;
3052                         b[13] = (FLAC__byte)xx; xx >>= 8;
3053                         b[12] = (FLAC__byte)xx; xx >>= 8;
3054                   &