src/libFLAC/stream_encoder.c

   1 /* libFLAC - Free Lossless Audio Codec library
   2  * Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007  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 #ifndef FLaC__INLINE
  75 #define FLaC__INLINE
  76 #endif
  77
  78 #ifdef min
  79 #undef min
  80 #endif
  81 #define min(x,y) ((x)<(y)?(x):(y))
  82
  83 #ifdef max
  84 #undef max
  85 #endif
  86 #define max(x,y) ((x)>(y)?(x):(y))
  87
  88 /* Exact Rice codeword length calculation is off by default.  The simple
  89  * (and fast) estimation (of how many bits a residual value will be
  90  * encoded with) in this encoder is very good, almost always yielding
  91  * compression within 0.1% of exact calculation.
  92  */
  93 #undef EXACT_RICE_BITS_CALCULATION
  94 /* Rice parameter searching is off by default.  The simple (and fast)
  95  * parameter estimation in this encoder is very good, almost always
  96  * yielding compression within 0.1% of the optimal parameters.
  97  */
  98 #undef ENABLE_RICE_PARAMETER_SEARCH
  99
 100
 101 typedef struct {
 102         FLAC__int32 *data[FLAC__MAX_CHANNELS];
 103         unsigned size; /* of each data[] in samples */
 104         unsigned tail;
 105 } verify_input_fifo;
 106
 107 typedef struct {
 108         const FLAC__byte *data;
 109         unsigned capacity;
 110         unsigned bytes;
 111 } verify_output;
 112
 113 typedef enum {
 114         ENCODER_IN_MAGIC = 0,
 115         ENCODER_IN_METADATA = 1,
 116         ENCODER_IN_AUDIO = 2
 117 } EncoderStateHint;
 118
 119 static struct CompressionLevels {
 120         FLAC__bool do_mid_side_stereo;
 121         FLAC__bool loose_mid_side_stereo;
 122         unsigned max_lpc_order;
 123         unsigned qlp_coeff_precision;
 124         FLAC__bool do_qlp_coeff_prec_search;
 125         FLAC__bool do_escape_coding;
 126         FLAC__bool do_exhaustive_model_search;
 127         unsigned min_residual_partition_order;
 128         unsigned max_residual_partition_order;
 129         unsigned rice_parameter_search_dist;
 130 } compression_levels_[] = {
 131         { false, false,  0, 0, false, false, false, 0, 3, 0 },
 132         { true , true ,  0, 0, false, false, false, 0, 3, 0 },
 133         { true , false,  0, 0, false, false, false, 0, 3, 0 },
 134         { false, false,  6, 0, false, false, false, 0, 4, 0 },
 135         { true , true ,  8, 0, false, false, false, 0, 4, 0 },
 136         { true , false,  8, 0, false, false, false, 0, 5, 0 },
 137         { true , false,  8, 0, false, false, false, 0, 6, 0 },
 138         { true , false,  8, 0, false, false, true , 0, 6, 0 },
 139         { true , false, 12, 0, false, false, true , 0, 6, 0 }
 140 };
 141
 142
 143 /***********************************************************************
 144  *
 145  * Private class method prototypes
 146  *
 147  ***********************************************************************/
 148
 149 static void set_defaults_(FLAC__StreamEncoder *encoder);
 150 static void free_(FLAC__StreamEncoder *encoder);
 151 static FLAC__bool resize_buffers_(FLAC__StreamEncoder *encoder, unsigned new_blocksize);
 152 static FLAC__bool write_bitbuffer_(FLAC__StreamEncoder *encoder, unsigned samples, FLAC__bool is_last_block);
 153 static FLAC__StreamEncoderWriteStatus write_frame_(FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, FLAC__bool is_last_block);
 154 static void update_metadata_(const FLAC__StreamEncoder *encoder);
 155 #if FLAC__HAS_OGG
 156 static void update_ogg_metadata_(FLAC__StreamEncoder *encoder);
 157 #endif
 158 static FLAC__bool process_frame_(FLAC__StreamEncoder *encoder, FLAC__bool is_fractional_block, FLAC__bool is_last_block);
 159 static FLAC__bool process_subframes_(FLAC__StreamEncoder *encoder, FLAC__bool is_fractional_block);
 160
 161 static FLAC__bool process_subframe_(
 162         FLAC__StreamEncoder *encoder,
 163         unsigned min_partition_order,
 164         unsigned max_partition_order,
 165         const FLAC__FrameHeader *frame_header,
 166         unsigned subframe_bps,
 167         const FLAC__int32 integer_signal[],
 168         FLAC__Subframe *subframe[2],
 169         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents[2],
 170         FLAC__int32 *residual[2],
 171         unsigned *best_subframe,
 172         unsigned *best_bits
 173 );
 174
 175 static FLAC__bool add_subframe_(
 176         FLAC__StreamEncoder *encoder,
 177         unsigned blocksize,
 178         unsigned subframe_bps,
 179         const FLAC__Subframe *subframe,
 180         FLAC__BitWriter *frame
 181 );
 182
 183 static unsigned evaluate_constant_subframe_(
 184         FLAC__StreamEncoder *encoder,
 185         const FLAC__int32 signal,
 186         unsigned blocksize,
 187         unsigned subframe_bps,
 188         FLAC__Subframe *subframe
 189 );
 190
 191 static unsigned evaluate_fixed_subframe_(
 192         FLAC__StreamEncoder *encoder,
 193         const FLAC__int32 signal[],
 194         FLAC__int32 residual[],
 195         FLAC__uint64 abs_residual_partition_sums[],
 196         unsigned raw_bits_per_partition[],
 197         unsigned blocksize,
 198         unsigned subframe_bps,
 199         unsigned order,
 200         unsigned rice_parameter,
 201         unsigned min_partition_order,
 202         unsigned max_partition_order,
 203         FLAC__bool do_escape_coding,
 204         unsigned rice_parameter_search_dist,
 205         FLAC__Subframe *subframe,
 206         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents
 207 );
 208
 209 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 210 static unsigned evaluate_lpc_subframe_(
 211         FLAC__StreamEncoder *encoder,
 212         const FLAC__int32 signal[],
 213         FLAC__int32 residual[],
 214         FLAC__uint64 abs_residual_partition_sums[],
 215         unsigned raw_bits_per_partition[],
 216         const FLAC__real lp_coeff[],
 217         unsigned blocksize,
 218         unsigned subframe_bps,
 219         unsigned order,
 220         unsigned qlp_coeff_precision,
 221         unsigned rice_parameter,
 222         unsigned min_partition_order,
 223         unsigned max_partition_order,
 224         FLAC__bool do_escape_coding,
 225         unsigned rice_parameter_search_dist,
 226         FLAC__Subframe *subframe,
 227         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents
 228 );
 229 #endif
 230
 231 static unsigned evaluate_verbatim_subframe_(
 232         FLAC__StreamEncoder *encoder,
 233         const FLAC__int32 signal[],
 234         unsigned blocksize,
 235         unsigned subframe_bps,
 236         FLAC__Subframe *subframe
 237 );
 238
 239 static unsigned find_best_partition_order_(
 240         struct FLAC__StreamEncoderPrivate *private_,
 241         const FLAC__int32 residual[],
 242         FLAC__uint64 abs_residual_partition_sums[],
 243         unsigned raw_bits_per_partition[],
 244         unsigned residual_samples,
 245         unsigned predictor_order,
 246         unsigned rice_parameter,
 247         unsigned min_partition_order,
 248         unsigned max_partition_order,
 249         unsigned bps,
 250         FLAC__bool do_escape_coding,
 251         unsigned rice_parameter_search_dist,
 252         FLAC__EntropyCodingMethod_PartitionedRice *best_partitioned_rice
 253 );
 254
 255 static void precompute_partition_info_sums_(
 256         const FLAC__int32 residual[],
 257         FLAC__uint64 abs_residual_partition_sums[],
 258         unsigned residual_samples,
 259         unsigned predictor_order,
 260         unsigned min_partition_order,
 261         unsigned max_partition_order,
 262         unsigned bps
 263 );
 264
 265 static void precompute_partition_info_escapes_(
 266         const FLAC__int32 residual[],
 267         unsigned raw_bits_per_partition[],
 268         unsigned residual_samples,
 269         unsigned predictor_order,
 270         unsigned min_partition_order,
 271         unsigned max_partition_order
 272 );
 273
 274 static FLAC__bool set_partitioned_rice_(
 275 #ifdef EXACT_RICE_BITS_CALCULATION
 276         const FLAC__int32 residual[],
 277 #endif
 278         const FLAC__uint64 abs_residual_partition_sums[],
 279         const unsigned raw_bits_per_partition[],
 280         const unsigned residual_samples,
 281         const unsigned predictor_order,
 282         const unsigned suggested_rice_parameter,
 283         const unsigned rice_parameter_search_dist,
 284         const unsigned partition_order,
 285         const FLAC__bool search_for_escapes,
 286         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents,
 287         unsigned *bits
 288 );
 289
 290 static unsigned get_wasted_bits_(FLAC__int32 signal[], unsigned samples);
 291
 292 /* verify-related routines: */
 293 static void append_to_verify_fifo_(
 294         verify_input_fifo *fifo,
 295         const FLAC__int32 * const input[],
 296         unsigned input_offset,
 297         unsigned channels,
 298         unsigned wide_samples
 299 );
 300
 301 static void append_to_verify_fifo_interleaved_(
 302         verify_input_fifo *fifo,
 303         const FLAC__int32 input[],
 304         unsigned input_offset,
 305         unsigned channels,
 306         unsigned wide_samples
 307 );
 308
 309 static FLAC__StreamDecoderReadStatus verify_read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
 310 static FLAC__StreamDecoderWriteStatus verify_write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
 311 static void verify_metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
 312 static void verify_error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
 313
 314 static FLAC__StreamEncoderReadStatus file_read_callback_(const FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
 315 static FLAC__StreamEncoderSeekStatus file_seek_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
 316 static FLAC__StreamEncoderTellStatus file_tell_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
 317 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);
 318 static FILE *get_binary_stdout_(void);
 319
 320
 321 /***********************************************************************
 322  *
 323  * Private class data
 324  *
 325  ***********************************************************************/
 326
 327 typedef struct FLAC__StreamEncoderPrivate {
 328         unsigned input_capacity;                          /* current size (in samples) of the signal and residual buffers */
 329         FLAC__int32 *integer_signal[FLAC__MAX_CHANNELS];  /* the integer version of the input signal */
 330         FLAC__int32 *integer_signal_mid_side[2];          /* the integer version of the mid-side input signal (stereo only) */
 331 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 332         FLAC__real *real_signal[FLAC__MAX_CHANNELS];      /* (@@@ currently unused) the floating-point version of the input signal */
 333         FLAC__real *real_signal_mid_side[2];              /* (@@@ currently unused) the floating-point version of the mid-side input signal (stereo only) */
 334         FLAC__real *window[FLAC__MAX_APODIZATION_FUNCTIONS]; /* the pre-computed floating-point window for each apodization function */
 335         FLAC__real *windowed_signal;                      /* the integer_signal[] * current window[] */
 336 #endif
 337         unsigned subframe_bps[FLAC__MAX_CHANNELS];        /* the effective bits per sample of the input signal (stream bps - wasted bits) */
 338         unsigned subframe_bps_mid_side[2];                /* the effective bits per sample of the mid-side input signal (stream bps - wasted bits + 0/1) */
 339         FLAC__int32 *residual_workspace[FLAC__MAX_CHANNELS][2]; /* each channel has a candidate and best workspace where the subframe residual signals will be stored */
 340         FLAC__int32 *residual_workspace_mid_side[2][2];
 341         FLAC__Subframe subframe_workspace[FLAC__MAX_CHANNELS][2];
 342         FLAC__Subframe subframe_workspace_mid_side[2][2];
 343         FLAC__Subframe *subframe_workspace_ptr[FLAC__MAX_CHANNELS][2];
 344         FLAC__Subframe *subframe_workspace_ptr_mid_side[2][2];
 345         FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents_workspace[FLAC__MAX_CHANNELS][2];
 346         FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents_workspace_mid_side[FLAC__MAX_CHANNELS][2];
 347         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents_workspace_ptr[FLAC__MAX_CHANNELS][2];
 348         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents_workspace_ptr_mid_side[FLAC__MAX_CHANNELS][2];
 349         unsigned best_subframe[FLAC__MAX_CHANNELS];       /* index (0 or 1) into 2nd dimension of the above workspaces */
 350         unsigned best_subframe_mid_side[2];
 351         unsigned best_subframe_bits[FLAC__MAX_CHANNELS];  /* size in bits of the best subframe for each channel */
 352         unsigned best_subframe_bits_mid_side[2];
 353         FLAC__uint64 *abs_residual_partition_sums;        /* workspace where the sum of abs(candidate residual) for each partition is stored */
 354         unsigned *raw_bits_per_partition;                 /* workspace where the sum of silog2(candidate residual) for each partition is stored */
 355         FLAC__BitWriter *frame;                           /* the current frame being worked on */
 356         unsigned loose_mid_side_stereo_frames;            /* rounded number of frames the encoder will use before trying both independent and mid/side frames again */
 357         unsigned loose_mid_side_stereo_frame_count;       /* number of frames using the current channel assignment */
 358         FLAC__ChannelAssignment last_channel_assignment;
 359         FLAC__StreamMetadata streaminfo;                  /* scratchpad for STREAMINFO as it is built */
 360         FLAC__StreamMetadata_SeekTable *seek_table;       /* pointer into encoder->protected_->metadata_ where the seek table is */
 361         unsigned current_sample_number;
 362         unsigned current_frame_number;
 363         FLAC__MD5Context md5context;
 364         FLAC__CPUInfo cpuinfo;
 365 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 366         unsigned (*local_fixed_compute_best_predictor)(const FLAC__int32 data[], unsigned data_len, FLAC__float residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
 367 #else
 368         unsigned (*local_fixed_compute_best_predictor)(const FLAC__int32 data[], unsigned data_len, FLAC__fixedpoint residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
 369 #endif
 370 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 371         void (*local_lpc_compute_autocorrelation)(const FLAC__real data[], unsigned data_len, unsigned lag, FLAC__real autoc[]);
 372         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[]);
 373         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[]);
 374         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[]);
 375 #endif
 376         FLAC__bool use_wide_by_block;          /* use slow 64-bit versions of some functions because of the block size */
 377         FLAC__bool use_wide_by_partition;      /* use slow 64-bit versions of some functions because of the min partition order and blocksize */
 378         FLAC__bool use_wide_by_order;          /* use slow 64-bit versions of some functions because of the lpc order */
 379         FLAC__bool disable_constant_subframes;
 380         FLAC__bool disable_fixed_subframes;
 381         FLAC__bool disable_verbatim_subframes;
 382 #if FLAC__HAS_OGG
 383         FLAC__bool is_ogg;
 384 #endif
 385         FLAC__StreamEncoderReadCallback read_callback; /* currently only needed for Ogg FLAC */
 386         FLAC__StreamEncoderSeekCallback seek_callback;
 387         FLAC__StreamEncoderTellCallback tell_callback;
 388         FLAC__StreamEncoderWriteCallback write_callback;
 389         FLAC__StreamEncoderMetadataCallback metadata_callback;
 390         FLAC__StreamEncoderProgressCallback progress_callback;
 391         void *client_data;
 392         unsigned first_seekpoint_to_check;
 393         FILE *file;                            /* only used when encoding to a file */
 394         FLAC__uint64 bytes_written;
 395         FLAC__uint64 samples_written;
 396         unsigned frames_written;
 397         unsigned total_frames_estimate;
 398         /* unaligned (original) pointers to allocated data */
 399         FLAC__int32 *integer_signal_unaligned[FLAC__MAX_CHANNELS];
 400         FLAC__int32 *integer_signal_mid_side_unaligned[2];
 401 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 402         FLAC__real *real_signal_unaligned[FLAC__MAX_CHANNELS]; /* (@@@ currently unused) */
 403         FLAC__real *real_signal_mid_side_unaligned[2]; /* (@@@ currently unused) */
 404         FLAC__real *window_unaligned[FLAC__MAX_APODIZATION_FUNCTIONS];
 405         FLAC__real *windowed_signal_unaligned;
 406 #endif
 407         FLAC__int32 *residual_workspace_unaligned[FLAC__MAX_CHANNELS][2];
 408         FLAC__int32 *residual_workspace_mid_side_unaligned[2][2];
 409         FLAC__uint64 *abs_residual_partition_sums_unaligned;
 410         unsigned *raw_bits_per_partition_unaligned;
 411         /*
 412          * These fields have been moved here from private function local
 413          * declarations merely to save stack space during encoding.
 414          */
 415 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 416         FLAC__real lp_coeff[FLAC__MAX_LPC_ORDER][FLAC__MAX_LPC_ORDER]; /* from process_subframe_() */
 417 #endif
 418         FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents_extra[2]; /* from find_best_partition_order_() */
 419         /*
 420          * The data for the verify section
 421          */
 422         struct {
 423                 FLAC__StreamDecoder *decoder;
 424                 EncoderStateHint state_hint;
 425                 FLAC__bool needs_magic_hack;
 426                 verify_input_fifo input_fifo;
 427                 verify_output output;
 428                 struct {
 429                         FLAC__uint64 absolute_sample;
 430                         unsigned frame_number;
 431                         unsigned channel;
 432                         unsigned sample;
 433                         FLAC__int32 expected;
 434                         FLAC__int32 got;
 435                 } error_stats;
 436         } verify;
 437         FLAC__bool is_being_deleted; /* if true, call to ..._finish() from ..._delete() will not call the callbacks */
 438 } FLAC__StreamEncoderPrivate;
 439
 440 /***********************************************************************
 441  *
 442  * Public static class data
 443  *
 444  ***********************************************************************/
 445
 446 FLAC_API const char * const FLAC__StreamEncoderStateString[] = {
 447         "FLAC__STREAM_ENCODER_OK",
 448         "FLAC__STREAM_ENCODER_UNINITIALIZED",
 449         "FLAC__STREAM_ENCODER_OGG_ERROR",
 450         "FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR",
 451         "FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA",
 452         "FLAC__STREAM_ENCODER_CLIENT_ERROR",
 453         "FLAC__STREAM_ENCODER_IO_ERROR",
 454         "FLAC__STREAM_ENCODER_FRAMING_ERROR",
 455         "FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR"
 456 };
 457
 458 FLAC_API const char * const FLAC__StreamEncoderInitStatusString[] = {
 459         "FLAC__STREAM_ENCODER_INIT_STATUS_OK",
 460         "FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR",
 461         "FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER",
 462         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS",
 463         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS",
 464         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE",
 465         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE",
 466         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE",
 467         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER",
 468         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION",
 469         "FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER",
 470         "FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE",
 471         "FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA",
 472         "FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED"
 473 };
 474
 475 FLAC_API const char * const FLAC__treamEncoderReadStatusString[] = {
 476         "FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE",
 477         "FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM",
 478         "FLAC__STREAM_ENCODER_READ_STATUS_ABORT",
 479         "FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED"
 480 };
 481
 482 FLAC_API const char * const FLAC__StreamEncoderWriteStatusString[] = {
 483         "FLAC__STREAM_ENCODER_WRITE_STATUS_OK",
 484         "FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR"
 485 };
 486
 487 FLAC_API const char * const FLAC__StreamEncoderSeekStatusString[] = {
 488         "FLAC__STREAM_ENCODER_SEEK_STATUS_OK",
 489         "FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR",
 490         "FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED"
 491 };
 492
 493 FLAC_API const char * const FLAC__StreamEncoderTellStatusString[] = {
 494         "FLAC__STREAM_ENCODER_TELL_STATUS_OK",
 495         "FLAC__STREAM_ENCODER_TELL_STATUS_ERROR",
 496         "FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED"
 497 };
 498
 499 /* Number of samples that will be overread to watch for end of stream.  By
 500  * 'overread', we mean that the FLAC__stream_encoder_process*() calls will
 501  * always try to read blocksize+1 samples before encoding a block, so that
 502  * even if the stream has a total sample count that is an integral multiple
 503  * of the blocksize, we will still notice when we are encoding the last
 504  * block.  This is needed, for example, to correctly set the end-of-stream
 505  * marker in Ogg FLAC.
 506  *
 507  * WATCHOUT: some parts of the code assert that OVERREAD_ == 1 and there's
 508  * not really any reason to change it.
 509  */
 510 static const unsigned OVERREAD_ = 1;
 511
 512 /***********************************************************************
 513  *
 514  * Class constructor/destructor
 515  *
 516  */
 517 FLAC_API FLAC__StreamEncoder *FLAC__stream_encoder_new(void)
 518 {
 519         FLAC__StreamEncoder *encoder;
 520         unsigned i;
 521
 522         FLAC__ASSERT(sizeof(int) >= 4); /* we want to die right away if this is not true */
 523
 524         encoder = (FLAC__StreamEncoder*)calloc(1, sizeof(FLAC__StreamEncoder));
 525         if(encoder == 0) {
 526                 return 0;
 527         }
 528
 529         encoder->protected_ = (FLAC__StreamEncoderProtected*)calloc(1, sizeof(FLAC__StreamEncoderProtected));
 530         if(encoder->protected_ == 0) {
 531                 free(encoder);
 532                 return 0;
 533         }
 534
 535         encoder->private_ = (FLAC__StreamEncoderPrivate*)calloc(1, sizeof(FLAC__StreamEncoderPrivate));
 536         if(encoder->private_ == 0) {
 537                 free(encoder->protected_);
 538                 free(encoder);
 539                 return 0;
 540         }
 541
 542         encoder->private_->frame = FLAC__bitwriter_new();
 543         if(encoder->private_->frame == 0) {
 544                 free(encoder->private_);
 545                 free(encoder->protected_);
 546                 free(encoder);
 547                 return 0;
 548         }
 549
 550         encoder->private_->file = 0;
 551
 552         set_defaults_(encoder);
 553
 554         encoder->private_->is_being_deleted = false;
 555
 556         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
 557                 encoder->private_->subframe_workspace_ptr[i][0] = &encoder->private_->subframe_workspace[i][0];
 558                 encoder->private_->subframe_workspace_ptr[i][1] = &encoder->private_->subframe_workspace[i][1];
 559         }
 560         for(i = 0; i < 2; i++) {
 561                 encoder->private_->subframe_workspace_ptr_mid_side[i][0] = &encoder->private_->subframe_workspace_mid_side[i][0];
 562                 encoder->private_->subframe_workspace_ptr_mid_side[i][1] = &encoder->private_->subframe_workspace_mid_side[i][1];
 563         }
 564         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
 565                 encoder->private_->partitioned_rice_contents_workspace_ptr[i][0] = &encoder->private_->partitioned_rice_contents_workspace[i][0];
 566                 encoder->private_->partitioned_rice_contents_workspace_ptr[i][1] = &encoder->private_->partitioned_rice_contents_workspace[i][1];
 567         }
 568         for(i = 0; i < 2; i++) {
 569                 encoder->private_->partitioned_rice_contents_workspace_ptr_mid_side[i][0] = &encoder->private_->partitioned_rice_contents_workspace_mid_side[i][0];
 570                 encoder->private_->partitioned_rice_contents_workspace_ptr_mid_side[i][1] = &encoder->private_->partitioned_rice_contents_workspace_mid_side[i][1];
 571         }
 572
 573         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
 574                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_workspace[i][0]);
 575                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_workspace[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_workspace_mid_side[i][0]);
 579                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_workspace_mid_side[i][1]);
 580         }
 581         for(i = 0; i < 2; i++)
 582                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&encoder->private_->partitioned_rice_contents_extra[i]);
 583
 584         encoder->protected_->state = FLAC__STREAM_ENCODER_UNINITIALIZED;
 585
 586         return encoder;
 587 }
 588
 589 FLAC_API void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder)
 590 {
 591         unsigned i;
 592
 593         FLAC__ASSERT(0 != encoder);
 594         FLAC__ASSERT(0 != encoder->protected_);
 595         FLAC__ASSERT(0 != encoder->private_);
 596         FLAC__ASSERT(0 != encoder->private_->frame);
 597
 598         encoder->private_->is_being_deleted = true;
 599
 600         (void)FLAC__stream_encoder_finish(encoder);
 601
 602         if(0 != encoder->private_->verify.decoder)
 603                 FLAC__stream_decoder_delete(encoder->private_->verify.decoder);
 604
 605         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
 606                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_workspace[i][0]);
 607                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_workspace[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_workspace_mid_side[i][0]);
 611                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_workspace_mid_side[i][1]);
 612         }
 613         for(i = 0; i < 2; i++)
 614                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&encoder->private_->partitioned_rice_contents_extra[i]);
 615
 616         FLAC__bitwriter_delete(encoder->private_->frame);
 617         free(encoder->private_);
 618         free(encoder->protected_);
 619         free(encoder);
 620 }
 621
 622 /***********************************************************************
 623  *
 624  * Public class methods
 625  *
 626  ***********************************************************************/
 627
 628 static FLAC__StreamEncoderInitStatus init_stream_internal_(
 629         FLAC__StreamEncoder *encoder,
 630         FLAC__StreamEncoderReadCallback read_callback,
 631         FLAC__StreamEncoderWriteCallback write_callback,
 632         FLAC__StreamEncoderSeekCallback seek_callback,
 633         FLAC__StreamEncoderTellCallback tell_callback,
 634         FLAC__StreamEncoderMetadataCallback metadata_callback,
 635         void *client_data,
 636         FLAC__bool is_ogg
 637 )
 638 {
 639         unsigned i;
 640         FLAC__bool metadata_has_seektable, metadata_has_vorbis_comment, metadata_picture_has_type1, metadata_picture_has_type2;
 641
 642         FLAC__ASSERT(0 != encoder);
 643
 644         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
 645                 return FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED;
 646
 647 #if !FLAC__HAS_OGG
 648         if(is_ogg)
 649                 return FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER;
 650 #endif
 651
 652         if(0 == write_callback || (seek_callback && 0 == tell_callback))
 653                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS;
 654
 655         if(encoder->protected_->channels == 0 || encoder->protected_->channels > FLAC__MAX_CHANNELS)
 656                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS;
 657
 658         if(encoder->protected_->channels != 2) {
 659                 encoder->protected_->do_mid_side_stereo = false;
 660                 encoder->protected_->loose_mid_side_stereo = false;
 661         }
 662         else if(!encoder->protected_->do_mid_side_stereo)
 663                 encoder->protected_->loose_mid_side_stereo = false;
 664
 665         if(encoder->protected_->bits_per_sample >= 32)
 666                 encoder->protected_->do_mid_side_stereo = false; /* since we currenty do 32-bit math, the side channel would have 33 bps and overflow */
 667
 668         if(encoder->protected_->bits_per_sample < FLAC__MIN_BITS_PER_SAMPLE || encoder->protected_->bits_per_sample > FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE)
 669                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE;
 670
 671         if(!FLAC__format_sample_rate_is_valid(encoder->protected_->sample_rate))
 672                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE;
 673
 674         if(encoder->protected_->blocksize == 0) {
 675                 if(encoder->protected_->max_lpc_order == 0)
 676                         encoder->protected_->blocksize = 1152;
 677                 else
 678                         encoder->protected_->blocksize = 4096;
 679         }
 680
 681         if(encoder->protected_->blocksize < FLAC__MIN_BLOCK_SIZE || encoder->protected_->blocksize > FLAC__MAX_BLOCK_SIZE)
 682                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE;
 683
 684         if(encoder->protected_->max_lpc_order > FLAC__MAX_LPC_ORDER)
 685                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER;
 686
 687         if(encoder->protected_->blocksize < encoder->protected_->max_lpc_order)
 688                 return FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER;
 689
 690         if(encoder->protected_->qlp_coeff_precision == 0) {
 691                 if(encoder->protected_->bits_per_sample < 16) {
 692                         /* @@@ need some data about how to set this here w.r.t. blocksize and sample rate */
 693                         /* @@@ until then we'll make a guess */
 694                         encoder->protected_->qlp_coeff_precision = max(FLAC__MIN_QLP_COEFF_PRECISION, 2 + encoder->protected_->bits_per_sample / 2);
 695                 }
 696                 else if(encoder->protected_->bits_per_sample == 16) {
 697                         if(encoder->protected_->blocksize <= 192)
 698                                 encoder->protected_->qlp_coeff_precision = 7;
 699                         else if(encoder->protected_->blocksize <= 384)
 700                                 encoder->protected_->qlp_coeff_precision = 8;
 701                         else if(encoder->protected_->blocksize <= 576)
 702                                 encoder->protected_->qlp_coeff_precision = 9;
 703                         else if(encoder->protected_->blocksize <= 1152)
 704                                 encoder->protected_->qlp_coeff_precision = 10;
 705                         else if(encoder->protected_->blocksize <= 2304)
 706                                 encoder->protected_->qlp_coeff_precision = 11;
 707                         else if(encoder->protected_->blocksize <= 4608)
 708                                 encoder->protected_->qlp_coeff_precision = 12;
 709                         else
 710                                 encoder->protected_->qlp_coeff_precision = 13;
 711                 }
 712                 else {
 713                         if(encoder->protected_->blocksize <= 384)
 714                                 encoder->protected_->qlp_coeff_precision = FLAC__MAX_QLP_COEFF_PRECISION-2;
 715                         else if(encoder->protected_->blocksize <= 1152)
 716                                 encoder->protected_->qlp_coeff_precision = FLAC__MAX_QLP_COEFF_PRECISION-1;
 717                         else
 718                                 encoder->protected_->qlp_coeff_precision = FLAC__MAX_QLP_COEFF_PRECISION;
 719                 }
 720                 FLAC__ASSERT(encoder->protected_->qlp_coeff_precision <= FLAC__MAX_QLP_COEFF_PRECISION);
 721         }
 722         else if(encoder->protected_->qlp_coeff_precision < FLAC__MIN_QLP_COEFF_PRECISION || encoder->protected_->qlp_coeff_precision > FLAC__MAX_QLP_COEFF_PRECISION)
 723                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION;
 724
 725         if(encoder->protected_->streamable_subset) {
 726                 if(
 727                         encoder->protected_->blocksize != 192 &&
 728                         encoder->protected_->blocksize != 576 &&
 729                         encoder->protected_->blocksize != 1152 &&
 730                         encoder->protected_->blocksize != 2304 &&
 731                         encoder->protected_->blocksize != 4608 &&
 732                         encoder->protected_->blocksize != 256 &&
 733                         encoder->protected_->blocksize != 512 &&
 734                         encoder->protected_->blocksize != 1024 &&
 735                         encoder->protected_->blocksize != 2048 &&
 736                         encoder->protected_->blocksize != 4096 &&
 737                         encoder->protected_->blocksize != 8192 &&
 738                         encoder->protected_->blocksize != 16384
 739                 )
 740                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
 741                 if(!FLAC__format_sample_rate_is_subset(encoder->protected_->sample_rate))
 742                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
 743                 if(
 744                         encoder->protected_->bits_per_sample != 8 &&
 745                         encoder->protected_->bits_per_sample != 12 &&
 746                         encoder->protected_->bits_per_sample != 16 &&
 747                         encoder->protected_->bits_per_sample != 20 &&
 748                         encoder->protected_->bits_per_sample != 24
 749                 )
 750                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
 751                 if(encoder->protected_->max_residual_partition_order > FLAC__SUBSET_MAX_RICE_PARTITION_ORDER)
 752                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
 753                 if(
 754                         encoder->protected_->sample_rate <= 48000 &&
 755                         (
 756                                 encoder->protected_->blocksize > FLAC__SUBSET_MAX_BLOCK_SIZE_48000HZ ||
 757                                 encoder->protected_->max_lpc_order > FLAC__SUBSET_MAX_LPC_ORDER_48000HZ
 758                         )
 759                 ) {
 760                         return FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE;
 761                 }
 762         }
 763
 764         if(encoder->protected_->max_residual_partition_order >= (1u << FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
 765                 encoder->protected_->max_residual_partition_order = (1u << FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN) - 1;
 766         if(encoder->protected_->min_residual_partition_order >= encoder->protected_->max_residual_partition_order)
 767                 encoder->protected_->min_residual_partition_order = encoder->protected_->max_residual_partition_order;
 768
 769 #if FLAC__HAS_OGG
 770         /* reorder metadata if necessary to ensure that any VORBIS_COMMENT is the first, according to the mapping spec */
 771         if(is_ogg && 0 != encoder->protected_->metadata && encoder->protected_->num_metadata_blocks > 1) {
 772                 unsigned i;
 773                 for(i = 1; i < encoder->protected_->num_metadata_blocks; i++) {
 774                         if(0 != encoder->protected_->metadata[i] && encoder->protected_->metadata[i]->type == FLAC__METADATA_TYPE_VORBIS_COMMENT) {
 775                                 FLAC__StreamMetadata *vc = encoder->protected_->metadata[i];
 776                                 for( ; i > 0; i--)
 777                                         encoder->protected_->metadata[i] = encoder->protected_->metadata[i-1];
 778                                 encoder->protected_->metadata[0] = vc;
 779                                 break;
 780                         }
 781                 }
 782         }
 783 #endif
 784         /* keep track of any SEEKTABLE block */
 785         if(0 != encoder->protected_->metadata && encoder->protected_->num_metadata_blocks > 0) {
 786                 unsigned i;
 787                 for(i = 0; i < encoder->protected_->num_metadata_blocks; i++) {
 788                         if(0 != encoder->protected_->metadata[i] && encoder->protected_->metadata[i]->type == FLAC__METADATA_TYPE_SEEKTABLE) {
 789                                 encoder->private_->seek_table = &encoder->protected_->metadata[i]->data.seek_table;
 790                                 break; /* take only the first one */
 791                         }
 792                 }
 793         }
 794
 795         /* validate metadata */
 796         if(0 == encoder->protected_->metadata && encoder->protected_->num_metadata_blocks > 0)
 797                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 798         metadata_has_seektable = false;
 799         metadata_has_vorbis_comment = false;
 800         metadata_picture_has_type1 = false;
 801         metadata_picture_has_type2 = false;
 802         for(i = 0; i < encoder->protected_->num_metadata_blocks; i++) {
 803                 const FLAC__StreamMetadata *m = encoder->protected_->metadata[i];
 804                 if(m->type == FLAC__METADATA_TYPE_STREAMINFO)
 805                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 806                 else if(m->type == FLAC__METADATA_TYPE_SEEKTABLE) {
 807                         if(metadata_has_seektable) /* only one is allowed */
 808                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 809                         metadata_has_seektable = true;
 810                         if(!FLAC__format_seektable_is_legal(&m->data.seek_table))
 811                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 812                 }
 813                 else if(m->type == FLAC__METADATA_TYPE_VORBIS_COMMENT) {
 814                         if(metadata_has_vorbis_comment) /* only one is allowed */
 815                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 816                         metadata_has_vorbis_comment = true;
 817                 }
 818                 else if(m->type == FLAC__METADATA_TYPE_CUESHEET) {
 819                         if(!FLAC__format_cuesheet_is_legal(&m->data.cue_sheet, m->data.cue_sheet.is_cd, /*violation=*/0))
 820                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 821                 }
 822                 else if(m->type == FLAC__METADATA_TYPE_PICTURE) {
 823                         if(!FLAC__format_picture_is_legal(&m->data.picture, /*violation=*/0))
 824                                 return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 825                         if(m->data.picture.type == FLAC__STREAM_METADATA_PICTURE_TYPE_FILE_ICON_STANDARD) {
 826                                 if(metadata_picture_has_type1) /* there should only be 1 per stream */
 827                                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 828                                 metadata_picture_has_type1 = true;
 829                                 /* standard icon must be 32x32 pixel PNG */
 830                                 if(
 831                                         m->data.picture.type == FLAC__STREAM_METADATA_PICTURE_TYPE_FILE_ICON_STANDARD &&
 832                                         (
 833                                                 (strcmp(m->data.picture.mime_type, "image/png") && strcmp(m->data.picture.mime_type, "-->")) ||
 834                                                 m->data.picture.width != 32 ||
 835                                                 m->data.picture.height != 32
 836                                         )
 837                                 )
 838                                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 839                         }
 840                         else if(m->data.picture.type == FLAC__STREAM_METADATA_PICTURE_TYPE_FILE_ICON) {
 841                                 if(metadata_picture_has_type2) /* there should only be 1 per stream */
 842                                         return FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA;
 843                                 metadata_picture_has_type2 = true;
 844                         }
 845                 }
 846         }
 847
 848         encoder->private_->input_capacity = 0;
 849         for(i = 0; i < encoder->protected_->channels; i++) {
 850                 encoder->private_->integer_signal_unaligned[i] = encoder->private_->integer_signal[i] = 0;
 851 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 852                 encoder->private_->real_signal_unaligned[i] = encoder->private_->real_signal[i] = 0;
 853 #endif
 854         }
 855         for(i = 0; i < 2; i++) {
 856                 encoder->private_->integer_signal_mid_side_unaligned[i] = encoder->private_->integer_signal_mid_side[i] = 0;
 857 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 858                 encoder->private_->real_signal_mid_side_unaligned[i] = encoder->private_->real_signal_mid_side[i] = 0;
 859 #endif
 860         }
 861 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 862         for(i = 0; i < encoder->protected_->num_apodizations; i++)
 863                 encoder->private_->window_unaligned[i] = encoder->private_->window[i] = 0;
 864         encoder->private_->windowed_signal_unaligned = encoder->private_->windowed_signal = 0;
 865 #endif
 866         for(i = 0; i < encoder->protected_->channels; i++) {
 867                 encoder->private_->residual_workspace_unaligned[i][0] = encoder->private_->residual_workspace[i][0] = 0;
 868                 encoder->private_->residual_workspace_unaligned[i][1] = encoder->private_->residual_workspace[i][1] = 0;
 869                 encoder->private_->best_subframe[i] = 0;
 870         }
 871         for(i = 0; i < 2; i++) {
 872                 encoder->private_->residual_workspace_mid_side_unaligned[i][0] = encoder->private_->residual_workspace_mid_side[i][0] = 0;
 873                 encoder->private_->residual_workspace_mid_side_unaligned[i][1] = encoder->private_->residual_workspace_mid_side[i][1] = 0;
 874                 encoder->private_->best_subframe_mid_side[i] = 0;
 875         }
 876         encoder->private_->abs_residual_partition_sums_unaligned = encoder->private_->abs_residual_partition_sums = 0;
 877         encoder->private_->raw_bits_per_partition_unaligned = encoder->private_->raw_bits_per_partition = 0;
 878 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 879         encoder->private_->loose_mid_side_stereo_frames = (unsigned)((FLAC__double)encoder->protected_->sample_rate * 0.4 / (FLAC__double)encoder->protected_->blocksize + 0.5);
 880 #else
 881         /* 26214 is the approximate fixed-point equivalent to 0.4 (0.4 * 2^16) */
 882         /* sample rate can be up to 655350 Hz, and thus use 20 bits, so we do the multiply&divide by hand */
 883         FLAC__ASSERT(FLAC__MAX_SAMPLE_RATE <= 655350);
 884         FLAC__ASSERT(FLAC__MAX_BLOCK_SIZE <= 65535);
 885         FLAC__ASSERT(encoder->protected_->sample_rate <= 655350);
 886         FLAC__ASSERT(encoder->protected_->blocksize <= 65535);
 887         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);
 888 #endif
 889         if(encoder->private_->loose_mid_side_stereo_frames == 0)
 890                 encoder->private_->loose_mid_side_stereo_frames = 1;
 891         encoder->private_->loose_mid_side_stereo_frame_count = 0;
 892         encoder->private_->current_sample_number = 0;
 893         encoder->private_->current_frame_number = 0;
 894
 895         encoder->private_->use_wide_by_block = (encoder->protected_->bits_per_sample + FLAC__bitmath_ilog2(encoder->protected_->blocksize)+1 > 30);
 896         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? */
 897         encoder->private_->use_wide_by_partition = (false); /*@@@ need to set this */
 898
 899         /*
 900          * get the CPU info and set the function pointers
 901          */
 902         FLAC__cpu_info(&encoder->private_->cpuinfo);
 903         /* first default to the non-asm routines */
 904 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 905         encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation;
 906 #endif
 907         encoder->private_->local_fixed_compute_best_predictor = FLAC__fixed_compute_best_predictor;
 908 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 909         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients = FLAC__lpc_compute_residual_from_qlp_coefficients;
 910         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_64bit = FLAC__lpc_compute_residual_from_qlp_coefficients_wide;
 911         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_16bit = FLAC__lpc_compute_residual_from_qlp_coefficients;
 912 #endif
 913         /* now override with asm where appropriate */
 914 #ifndef FLAC__INTEGER_ONLY_LIBRARY
 915 # ifndef FLAC__NO_ASM
 916         if(encoder->private_->cpuinfo.use_asm) {
 917 #  ifdef FLAC__CPU_IA32
 918                 FLAC__ASSERT(encoder->private_->cpuinfo.type == FLAC__CPUINFO_TYPE_IA32);
 919 #   ifdef FLAC__HAS_NASM
 920                 if(encoder->private_->cpuinfo.data.ia32.sse) {
 921                         if(encoder->protected_->max_lpc_order < 4)
 922                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_sse_lag_4;
 923                         else if(encoder->protected_->max_lpc_order < 8)
 924                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_sse_lag_8;
 925                         else if(encoder->protected_->max_lpc_order < 12)
 926                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_sse_lag_12;
 927                         else
 928                                 encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32;
 929                 }
 930                 else if(encoder->private_->cpuinfo.data.ia32._3dnow)
 931                         encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32_3dnow;
 932                 else
 933                         encoder->private_->local_lpc_compute_autocorrelation = FLAC__lpc_compute_autocorrelation_asm_ia32;
 934                 if(encoder->private_->cpuinfo.data.ia32.mmx) {
 935                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32;
 936                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_16bit = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32_mmx;
 937                 }
 938                 else {
 939                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32;
 940                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_16bit = FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32;
 941                 }
 942                 if(encoder->private_->cpuinfo.data.ia32.mmx && encoder->private_->cpuinfo.data.ia32.cmov)
 943                         encoder->private_->local_fixed_compute_best_predictor = FLAC__fixed_compute_best_predictor_asm_ia32_mmx_cmov;
 944 #   endif /* FLAC__HAS_NASM */
 945 #  endif /* FLAC__CPU_IA32 */
 946         }
 947 # endif /* !FLAC__NO_ASM */
 948 #endif /* !FLAC__INTEGER_ONLY_LIBRARY */
 949         /* finally override based on wide-ness if necessary */
 950         if(encoder->private_->use_wide_by_block) {
 951                 encoder->private_->local_fixed_compute_best_predictor = FLAC__fixed_compute_best_predictor_wide;
 952         }
 953
 954         /* set state to OK; from here on, errors are fatal and we'll override the state then */
 955         encoder->protected_->state = FLAC__STREAM_ENCODER_OK;
 956
 957 #if FLAC__HAS_OGG
 958         encoder->private_->is_ogg = is_ogg;
 959         if(is_ogg && !FLAC__ogg_encoder_aspect_init(&encoder->protected_->ogg_encoder_aspect)) {
 960                 encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
 961                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
 962         }
 963 #endif
 964
 965         encoder->private_->read_callback = read_callback;
 966         encoder->private_->write_callback = write_callback;
 967         encoder->private_->seek_callback = seek_callback;
 968         encoder->private_->tell_callback = tell_callback;
 969         encoder->private_->metadata_callback = metadata_callback;
 970         encoder->private_->client_data = client_data;
 971
 972         if(!resize_buffers_(encoder, encoder->protected_->blocksize)) {
 973                 /* the above function sets the state for us in case of an error */
 974                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
 975         }
 976
 977         if(!FLAC__bitwriter_init(encoder->private_->frame)) {
 978                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
 979                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
 980         }
 981
 982         /*
 983          * Set up the verify stuff if necessary
 984          */
 985         if(encoder->protected_->verify) {
 986                 /*
 987                  * First, set up the fifo which will hold the
 988                  * original signal to compare against
 989                  */
 990                 encoder->private_->verify.input_fifo.size = encoder->protected_->blocksize+OVERREAD_;
 991                 for(i = 0; i < encoder->protected_->channels; i++) {
 992                         if(0 == (encoder->private_->verify.input_fifo.data[i] = (FLAC__int32*)malloc(sizeof(FLAC__int32) * encoder->private_->verify.input_fifo.size))) {
 993                                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
 994                                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
 995                         }
 996                 }
 997                 encoder->private_->verify.input_fifo.tail = 0;
 998
 999                 /*
1000                  * Now set up a stream decoder for verification
1001                  */
1002                 encoder->private_->verify.decoder = FLAC__stream_decoder_new();
1003                 if(0 == encoder->private_->verify.decoder) {
1004                         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR;
1005                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1006                 }
1007
1008                 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) {
1009                         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR;
1010                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1011                 }
1012         }
1013         encoder->private_->verify.error_stats.absolute_sample = 0;
1014         encoder->private_->verify.error_stats.frame_number = 0;
1015         encoder->private_->verify.error_stats.channel = 0;
1016         encoder->private_->verify.error_stats.sample = 0;
1017         encoder->private_->verify.error_stats.expected = 0;
1018         encoder->private_->verify.error_stats.got = 0;
1019
1020         /*
1021          * These must be done before we write any metadata, because that
1022          * calls the write_callback, which uses these values.
1023          */
1024         encoder->private_->first_seekpoint_to_check = 0;
1025         encoder->private_->samples_written = 0;
1026         encoder->protected_->streaminfo_offset = 0;
1027         encoder->protected_->seektable_offset = 0;
1028         encoder->protected_->audio_offset = 0;
1029
1030         /*
1031          * write the stream header
1032          */
1033         if(encoder->protected_->verify)
1034                 encoder->private_->verify.state_hint = ENCODER_IN_MAGIC;
1035         if(!FLAC__bitwriter_write_raw_uint32(encoder->private_->frame, FLAC__STREAM_SYNC, FLAC__STREAM_SYNC_LEN)) {
1036                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1037                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1038         }
1039         if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1040                 /* the above function sets the state for us in case of an error */
1041                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1042         }
1043
1044         /*
1045          * write the STREAMINFO metadata block
1046          */
1047         if(encoder->protected_->verify)
1048                 encoder->private_->verify.state_hint = ENCODER_IN_METADATA;
1049         encoder->private_->streaminfo.type = FLAC__METADATA_TYPE_STREAMINFO;
1050         encoder->private_->streaminfo.is_last = false; /* we will have at a minimum a VORBIS_COMMENT afterwards */
1051         encoder->private_->streaminfo.length = FLAC__STREAM_METADATA_STREAMINFO_LENGTH;
1052         encoder->private_->streaminfo.data.stream_info.min_blocksize = encoder->protected_->blocksize; /* this encoder uses the same blocksize for the whole stream */
1053         encoder->private_->streaminfo.data.stream_info.max_blocksize = encoder->protected_->blocksize;
1054         encoder->private_->streaminfo.data.stream_info.min_framesize = 0; /* we don't know this yet; have to fill it in later */
1055         encoder->private_->streaminfo.data.stream_info.max_framesize = 0; /* we don't know this yet; have to fill it in later */
1056         encoder->private_->streaminfo.data.stream_info.sample_rate = encoder->protected_->sample_rate;
1057         encoder->private_->streaminfo.data.stream_info.channels = encoder->protected_->channels;
1058         encoder->private_->streaminfo.data.stream_info.bits_per_sample = encoder->protected_->bits_per_sample;
1059         encoder->private_->streaminfo.data.stream_info.total_samples = encoder->protected_->total_samples_estimate; /* we will replace this later with the real total */
1060         memset(encoder->private_->streaminfo.data.stream_info.md5sum, 0, 16); /* we don't know this yet; have to fill it in later */
1061         if(encoder->protected_->do_md5)
1062                 FLAC__MD5Init(&encoder->private_->md5context);
1063         if(!FLAC__add_metadata_block(&encoder->private_->streaminfo, encoder->private_->frame)) {
1064                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1065                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1066         }
1067         if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1068                 /* the above function sets the state for us in case of an error */
1069                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1070         }
1071
1072         /*
1073          * Now that the STREAMINFO block is written, we can init this to an
1074          * absurdly-high value...
1075          */
1076         encoder->private_->streaminfo.data.stream_info.min_framesize = (1u << FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN) - 1;
1077         /* ... and clear this to 0 */
1078         encoder->private_->streaminfo.data.stream_info.total_samples = 0;
1079
1080         /*
1081          * Check to see if the supplied metadata contains a VORBIS_COMMENT;
1082          * if not, we will write an empty one (FLAC__add_metadata_block()
1083          * automatically supplies the vendor string).
1084          *
1085          * WATCHOUT: the Ogg FLAC mapping requires us to write this block after
1086          * the STREAMINFO.  (In the case that metadata_has_vorbis_comment is
1087          * true it will have already insured that the metadata list is properly
1088          * ordered.)
1089          */
1090         if(!metadata_has_vorbis_comment) {
1091                 FLAC__StreamMetadata vorbis_comment;
1092                 vorbis_comment.type = FLAC__METADATA_TYPE_VORBIS_COMMENT;
1093                 vorbis_comment.is_last = (encoder->protected_->num_metadata_blocks == 0);
1094                 vorbis_comment.length = 4 + 4; /* MAGIC NUMBER */
1095                 vorbis_comment.data.vorbis_comment.vendor_string.length = 0;
1096                 vorbis_comment.data.vorbis_comment.vendor_string.entry = 0;
1097                 vorbis_comment.data.vorbis_comment.num_comments = 0;
1098                 vorbis_comment.data.vorbis_comment.comments = 0;
1099                 if(!FLAC__add_metadata_block(&vorbis_comment, encoder->private_->frame)) {
1100                         encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1101                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1102                 }
1103                 if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1104                         /* the above function sets the state for us in case of an error */
1105                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1106                 }
1107         }
1108
1109         /*
1110          * write the user's metadata blocks
1111          */
1112         for(i = 0; i < encoder->protected_->num_metadata_blocks; i++) {
1113                 encoder->protected_->metadata[i]->is_last = (i == encoder->protected_->num_metadata_blocks - 1);
1114                 if(!FLAC__add_metadata_block(encoder->protected_->metadata[i], encoder->private_->frame)) {
1115                         encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
1116                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1117                 }
1118                 if(!write_bitbuffer_(encoder, 0, /*is_last_block=*/false)) {
1119                         /* the above function sets the state for us in case of an error */
1120                         return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1121                 }
1122         }
1123
1124         /* now that all the metadata is written, we save the stream offset */
1125         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 */
1126                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
1127                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1128         }
1129
1130         if(encoder->protected_->verify)
1131                 encoder->private_->verify.state_hint = ENCODER_IN_AUDIO;
1132
1133         return FLAC__STREAM_ENCODER_INIT_STATUS_OK;
1134 }
1135
1136 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_stream(
1137         FLAC__StreamEncoder *encoder,
1138         FLAC__StreamEncoderWriteCallback write_callback,
1139         FLAC__StreamEncoderSeekCallback seek_callback,
1140         FLAC__StreamEncoderTellCallback tell_callback,
1141         FLAC__StreamEncoderMetadataCallback metadata_callback,
1142         void *client_data
1143 )
1144 {
1145         return init_stream_internal_(
1146                 encoder,
1147                 /*read_callback=*/0,
1148                 write_callback,
1149                 seek_callback,
1150                 tell_callback,
1151                 metadata_callback,
1152                 client_data,
1153                 /*is_ogg=*/false
1154         );
1155 }
1156
1157 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_stream(
1158         FLAC__StreamEncoder *encoder,
1159         FLAC__StreamEncoderReadCallback read_callback,
1160         FLAC__StreamEncoderWriteCallback write_callback,
1161         FLAC__StreamEncoderSeekCallback seek_callback,
1162         FLAC__StreamEncoderTellCallback tell_callback,
1163         FLAC__StreamEncoderMetadataCallback metadata_callback,
1164         void *client_data
1165 )
1166 {
1167         return init_stream_internal_(
1168                 encoder,
1169                 read_callback,
1170                 write_callback,
1171                 seek_callback,
1172                 tell_callback,
1173                 metadata_callback,
1174                 client_data,
1175                 /*is_ogg=*/true
1176         );
1177 }
1178
1179 static FLAC__StreamEncoderInitStatus init_FILE_internal_(
1180         FLAC__StreamEncoder *encoder,
1181         FILE *file,
1182         FLAC__StreamEncoderProgressCallback progress_callback,
1183         void *client_data,
1184         FLAC__bool is_ogg
1185 )
1186 {
1187         FLAC__StreamEncoderInitStatus init_status;
1188
1189         FLAC__ASSERT(0 != encoder);
1190         FLAC__ASSERT(0 != file);
1191
1192         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1193                 return FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED;
1194
1195         /* double protection */
1196         if(file == 0) {
1197                 encoder->protected_->state = FLAC__STREAM_ENCODER_IO_ERROR;
1198                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1199         }
1200
1201         /*
1202          * To make sure that our file does not go unclosed after an error, we
1203          * must assign the FILE pointer before any further error can occur in
1204          * this routine.
1205          */
1206         if(file == stdout)
1207                 file = get_binary_stdout_(); /* just to be safe */
1208
1209         encoder->private_->file = file;
1210
1211         encoder->private_->progress_callback = progress_callback;
1212         encoder->private_->bytes_written = 0;
1213         encoder->private_->samples_written = 0;
1214         encoder->private_->frames_written = 0;
1215
1216         init_status = init_stream_internal_(
1217                 encoder,
1218                 encoder->private_->file == stdout? 0 : is_ogg? file_read_callback_ : 0,
1219                 file_write_callback_,
1220                 encoder->private_->file == stdout? 0 : file_seek_callback_,
1221                 encoder->private_->file == stdout? 0 : file_tell_callback_,
1222                 /*metadata_callback=*/0,
1223                 client_data,
1224                 is_ogg
1225         );
1226         if(init_status != FLAC__STREAM_ENCODER_INIT_STATUS_OK) {
1227                 /* the above function sets the state for us in case of an error */
1228                 return init_status;
1229         }
1230
1231         {
1232                 unsigned blocksize = FLAC__stream_encoder_get_blocksize(encoder);
1233
1234                 FLAC__ASSERT(blocksize != 0);
1235                 encoder->private_->total_frames_estimate = (unsigned)((FLAC__stream_encoder_get_total_samples_estimate(encoder) + blocksize - 1) / blocksize);
1236         }
1237
1238         return init_status;
1239 }
1240
1241 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_FILE(
1242         FLAC__StreamEncoder *encoder,
1243         FILE *file,
1244         FLAC__StreamEncoderProgressCallback progress_callback,
1245         void *client_data
1246 )
1247 {
1248         return init_FILE_internal_(encoder, file, progress_callback, client_data, /*is_ogg=*/false);
1249 }
1250
1251 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_FILE(
1252         FLAC__StreamEncoder *encoder,
1253         FILE *file,
1254         FLAC__StreamEncoderProgressCallback progress_callback,
1255         void *client_data
1256 )
1257 {
1258         return init_FILE_internal_(encoder, file, progress_callback, client_data, /*is_ogg=*/true);
1259 }
1260
1261 static FLAC__StreamEncoderInitStatus init_file_internal_(
1262         FLAC__StreamEncoder *encoder,
1263         const char *filename,
1264         FLAC__StreamEncoderProgressCallback progress_callback,
1265         void *client_data,
1266         FLAC__bool is_ogg
1267 )
1268 {
1269         FILE *file;
1270
1271         FLAC__ASSERT(0 != encoder);
1272
1273         /*
1274          * To make sure that our file does not go unclosed after an error, we
1275          * have to do the same entrance checks here that are later performed
1276          * in FLAC__stream_encoder_init_FILE() before the FILE* is assigned.
1277          */
1278         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1279                 return FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED;
1280
1281         file = filename? fopen(filename, "w+b") : stdout;
1282
1283         if(file == 0) {
1284                 encoder->protected_->state = FLAC__STREAM_ENCODER_IO_ERROR;
1285                 return FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR;
1286         }
1287
1288         return init_FILE_internal_(encoder, file, progress_callback, client_data, is_ogg);
1289 }
1290
1291 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_file(
1292         FLAC__StreamEncoder *encoder,
1293         const char *filename,
1294         FLAC__StreamEncoderProgressCallback progress_callback,
1295         void *client_data
1296 )
1297 {
1298         return init_file_internal_(encoder, filename, progress_callback, client_data, /*is_ogg=*/false);
1299 }
1300
1301 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_file(
1302         FLAC__StreamEncoder *encoder,
1303         const char *filename,
1304         FLAC__StreamEncoderProgressCallback progress_callback,
1305         void *client_data
1306 )
1307 {
1308         return init_file_internal_(encoder, filename, progress_callback, client_data, /*is_ogg=*/true);
1309 }
1310
1311 FLAC_API FLAC__bool FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder)
1312 {
1313         FLAC__bool error = false;
1314
1315         FLAC__ASSERT(0 != encoder);
1316         FLAC__ASSERT(0 != encoder->private_);
1317         FLAC__ASSERT(0 != encoder->protected_);
1318
1319         if(encoder->protected_->state == FLAC__STREAM_ENCODER_UNINITIALIZED)
1320                 return true;
1321
1322         if(encoder->protected_->state == FLAC__STREAM_ENCODER_OK && !encoder->private_->is_being_deleted) {
1323                 if(encoder->private_->current_sample_number != 0) {
1324                         const FLAC__bool is_fractional_block = encoder->protected_->blocksize != encoder->private_->current_sample_number;
1325                         encoder->protected_->blocksize = encoder->private_->current_sample_number;
1326                         if(!process_frame_(encoder, is_fractional_block, /*is_last_block=*/true))
1327                                 error = true;
1328                 }
1329         }
1330
1331         if(encoder->protected_->do_md5)
1332                 FLAC__MD5Final(encoder->private_->streaminfo.data.stream_info.md5sum, &encoder->private_->md5context);
1333
1334         if(!encoder->private_->is_being_deleted) {
1335                 if(encoder->protected_->state == FLAC__STREAM_ENCODER_OK) {
1336                         if(encoder->private_->seek_callback) {
1337 #if FLAC__HAS_OGG
1338                                 if(encoder->private_->is_ogg)
1339                                         update_ogg_metadata_(encoder);
1340                                 else
1341 #endif
1342                                 update_metadata_(encoder);
1343
1344                                 /* check if an error occurred while updating metadata */
1345                                 if(encoder->protected_->state != FLAC__STREAM_ENCODER_OK)
1346                                         error = true;
1347                         }
1348                         if(encoder->private_->metadata_callback)
1349                                 encoder->private_->metadata_callback(encoder, &encoder->private_->streaminfo, encoder->private_->client_data);
1350                 }
1351
1352                 if(encoder->protected_->verify && 0 != encoder->private_->verify.decoder && !FLAC__stream_decoder_finish(encoder->private_->verify.decoder)) {
1353                         if(!error)
1354                                 encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA;
1355                         error = true;
1356                 }
1357         }
1358
1359         if(0 != encoder->private_->file) {
1360                 if(encoder->private_->file != stdout)
1361                         fclose(encoder->private_->file);
1362                 encoder->private_->file = 0;
1363         }
1364
1365 #if FLAC__HAS_OGG
1366         if(encoder->private_->is_ogg)
1367                 FLAC__ogg_encoder_aspect_finish(&encoder->protected_->ogg_encoder_aspect);
1368 #endif
1369
1370         free_(encoder);
1371         set_defaults_(encoder);
1372
1373         if(!error)
1374                 encoder->protected_->state = FLAC__STREAM_ENCODER_UNINITIALIZED;
1375
1376         return !error;
1377 }
1378
1379 FLAC_API FLAC__bool FLAC__stream_encoder_set_ogg_serial_number(FLAC__StreamEncoder *encoder, long value)
1380 {
1381         FLAC__ASSERT(0 != encoder);
1382         FLAC__ASSERT(0 != encoder->private_);
1383         FLAC__ASSERT(0 != encoder->protected_);
1384         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1385                 return false;
1386 #if FLAC__HAS_OGG
1387         /* can't check encoder->private_->is_ogg since that's not set until init time */
1388         FLAC__ogg_encoder_aspect_set_serial_number(&encoder->protected_->ogg_encoder_aspect, value);
1389         return true;
1390 #else
1391         (void)value;
1392         return false;
1393 #endif
1394 }
1395
1396 FLAC_API FLAC__bool FLAC__stream_encoder_set_verify(FLAC__StreamEncoder *encoder, FLAC__bool value)
1397 {
1398         FLAC__ASSERT(0 != encoder);
1399         FLAC__ASSERT(0 != encoder->private_);
1400         FLAC__ASSERT(0 != encoder->protected_);
1401         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1402                 return false;
1403 #ifndef FLAC__MANDATORY_VERIFY_WHILE_ENCODING
1404         encoder->protected_->verify = value;
1405 #endif
1406         return true;
1407 }
1408
1409 FLAC_API FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value)
1410 {
1411         FLAC__ASSERT(0 != encoder);
1412         FLAC__ASSERT(0 != encoder->private_);
1413         FLAC__ASSERT(0 != encoder->protected_);
1414         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1415                 return false;
1416         encoder->protected_->streamable_subset = value;
1417         return true;
1418 }
1419
1420 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_md5(FLAC__StreamEncoder *encoder, FLAC__bool value)
1421 {
1422         FLAC__ASSERT(0 != encoder);
1423         FLAC__ASSERT(0 != encoder->private_);
1424         FLAC__ASSERT(0 != encoder->protected_);
1425         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1426                 return false;
1427         encoder->protected_->do_md5 = value;
1428         return true;
1429 }
1430
1431 FLAC_API FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, unsigned value)
1432 {
1433         FLAC__ASSERT(0 != encoder);
1434         FLAC__ASSERT(0 != encoder->private_);
1435         FLAC__ASSERT(0 != encoder->protected_);
1436         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1437                 return false;
1438         encoder->protected_->channels = value;
1439         return true;
1440 }
1441
1442 FLAC_API FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, unsigned value)
1443 {
1444         FLAC__ASSERT(0 != encoder);
1445         FLAC__ASSERT(0 != encoder->private_);
1446         FLAC__ASSERT(0 != encoder->protected_);
1447         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1448                 return false;
1449         encoder->protected_->bits_per_sample = value;
1450         return true;
1451 }
1452
1453 FLAC_API FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, unsigned value)
1454 {
1455         FLAC__ASSERT(0 != encoder);
1456         FLAC__ASSERT(0 != encoder->private_);
1457         FLAC__ASSERT(0 != encoder->protected_);
1458         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1459                 return false;
1460         encoder->protected_->sample_rate = value;
1461         return true;
1462 }
1463
1464 FLAC_API FLAC__bool FLAC__stream_encoder_set_compression_level(FLAC__StreamEncoder *encoder, unsigned value)
1465 {
1466         FLAC__bool ok = true;
1467         FLAC__ASSERT(0 != encoder);
1468         FLAC__ASSERT(0 != encoder->private_);
1469         FLAC__ASSERT(0 != encoder->protected_);
1470         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1471                 return false;
1472         if(value >= sizeof(compression_levels_)/sizeof(compression_levels_[0]))
1473                 value = sizeof(compression_levels_)/sizeof(compression_levels_[0]) - 1;
1474         ok &= FLAC__stream_encoder_set_do_mid_side_stereo          (encoder, compression_levels_[value].do_mid_side_stereo);
1475         ok &= FLAC__stream_encoder_set_loose_mid_side_stereo       (encoder, compression_levels_[value].loose_mid_side_stereo);
1476 #if 0
1477         /* was: */
1478         ok &= FLAC__stream_encoder_set_apodization                 (encoder, compression_levels_[value].apodization);
1479         /* but it's too hard to specify the string in a locale-specific way */
1480 #else
1481         encoder->protected_->num_apodizations = 1;
1482         encoder->protected_->apodizations[0].type = FLAC__APODIZATION_TUKEY;
1483         encoder->protected_->apodizations[0].parameters.tukey.p = 0.5;
1484 #endif
1485         ok &= FLAC__stream_encoder_set_max_lpc_order               (encoder, compression_levels_[value].max_lpc_order);
1486         ok &= FLAC__stream_encoder_set_qlp_coeff_precision         (encoder, compression_levels_[value].qlp_coeff_precision);
1487         ok &= FLAC__stream_encoder_set_do_qlp_coeff_prec_search    (encoder, compression_levels_[value].do_qlp_coeff_prec_search);
1488         ok &= FLAC__stream_encoder_set_do_escape_coding            (encoder, compression_levels_[value].do_escape_coding);
1489         ok &= FLAC__stream_encoder_set_do_exhaustive_model_search  (encoder, compression_levels_[value].do_exhaustive_model_search);
1490         ok &= FLAC__stream_encoder_set_min_residual_partition_order(encoder, compression_levels_[value].min_residual_partition_order);
1491         ok &= FLAC__stream_encoder_set_max_residual_partition_order(encoder, compression_levels_[value].max_residual_partition_order);
1492         ok &= FLAC__stream_encoder_set_rice_parameter_search_dist  (encoder, compression_levels_[value].rice_parameter_search_dist);
1493         return ok;
1494 }
1495
1496 FLAC_API FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, unsigned value)
1497 {
1498         FLAC__ASSERT(0 != encoder);
1499         FLAC__ASSERT(0 != encoder->private_);
1500         FLAC__ASSERT(0 != encoder->protected_);
1501         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1502                 return false;
1503         encoder->protected_->blocksize = value;
1504         return true;
1505 }
1506
1507 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value)
1508 {
1509         FLAC__ASSERT(0 != encoder);
1510         FLAC__ASSERT(0 != encoder->private_);
1511         FLAC__ASSERT(0 != encoder->protected_);
1512         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1513                 return false;
1514         encoder->protected_->do_mid_side_stereo = value;
1515         return true;
1516 }
1517
1518 FLAC_API FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value)
1519 {
1520         FLAC__ASSERT(0 != encoder);
1521         FLAC__ASSERT(0 != encoder->private_);
1522         FLAC__ASSERT(0 != encoder->protected_);
1523         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1524                 return false;
1525         encoder->protected_->loose_mid_side_stereo = value;
1526         return true;
1527 }
1528
1529 FLAC_API FLAC__bool FLAC__stream_encoder_set_apodization(FLAC__StreamEncoder *encoder, const char *specification)
1530 {
1531         FLAC__ASSERT(0 != encoder);
1532         FLAC__ASSERT(0 != encoder->private_);
1533         FLAC__ASSERT(0 != encoder->protected_);
1534         FLAC__ASSERT(0 != specification);
1535         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1536                 return false;
1537 #ifdef FLAC__INTEGER_ONLY_LIBRARY
1538         (void)specification; /* silently ignore since we haven't integerized; will always use a rectangular window */
1539 #else
1540         encoder->protected_->num_apodizations = 0;
1541         while(1) {
1542                 const char *s = strchr(specification, ';');
1543                 const size_t n = s? (size_t)(s - specification) : strlen(specification);
1544                 if     (n==8  && 0 == strncmp("bartlett"     , specification, n))
1545                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BARTLETT;
1546                 else if(n==13 && 0 == strncmp("bartlett_hann", specification, n))
1547                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BARTLETT_HANN;
1548                 else if(n==8  && 0 == strncmp("blackman"     , specification, n))
1549                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BLACKMAN;
1550                 else if(n==26 && 0 == strncmp("blackman_harris_4term_92db", specification, n))
1551                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_BLACKMAN_HARRIS_4TERM_92DB_SIDELOBE;
1552                 else if(n==6  && 0 == strncmp("connes"       , specification, n))
1553                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_CONNES;
1554                 else if(n==7  && 0 == strncmp("flattop"      , specification, n))
1555                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_FLATTOP;
1556                 else if(n>7   && 0 == strncmp("gauss("       , specification, 6)) {
1557                         FLAC__real stddev = (FLAC__real)strtod(specification+6, 0);
1558                         if (stddev > 0.0 && stddev <= 0.5) {
1559                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations].parameters.gauss.stddev = stddev;
1560                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_GAUSS;
1561                         }
1562                 }
1563                 else if(n==7  && 0 == strncmp("hamming"      , specification, n))
1564                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_HAMMING;
1565                 else if(n==4  && 0 == strncmp("hann"         , specification, n))
1566                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_HANN;
1567                 else if(n==13 && 0 == strncmp("kaiser_bessel", specification, n))
1568                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_KAISER_BESSEL;
1569                 else if(n==7  && 0 == strncmp("nuttall"      , specification, n))
1570                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_NUTTALL;
1571                 else if(n==9  && 0 == strncmp("rectangle"    , specification, n))
1572                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_RECTANGLE;
1573                 else if(n==8  && 0 == strncmp("triangle"     , specification, n))
1574                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_TRIANGLE;
1575                 else if(n>7   && 0 == strncmp("tukey("       , specification, 6)) {
1576                         FLAC__real p = (FLAC__real)strtod(specification+6, 0);
1577                         if (p >= 0.0 && p <= 1.0) {
1578                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations].parameters.tukey.p = p;
1579                                 encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_TUKEY;
1580                         }
1581                 }
1582                 else if(n==5  && 0 == strncmp("welch"        , specification, n))
1583                         encoder->protected_->apodizations[encoder->protected_->num_apodizations++].type = FLAC__APODIZATION_WELCH;
1584                 if (encoder->protected_->num_apodizations == 32)
1585                         break;
1586                 if (s)
1587                         specification = s+1;
1588                 else
1589                         break;
1590         }
1591         if(encoder->protected_->num_apodizations == 0) {
1592                 encoder->protected_->num_apodizations = 1;
1593                 encoder->protected_->apodizations[0].type = FLAC__APODIZATION_TUKEY;
1594                 encoder->protected_->apodizations[0].parameters.tukey.p = 0.5;
1595         }
1596 #endif
1597         return true;
1598 }
1599
1600 FLAC_API FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, unsigned value)
1601 {
1602         FLAC__ASSERT(0 != encoder);
1603         FLAC__ASSERT(0 != encoder->private_);
1604         FLAC__ASSERT(0 != encoder->protected_);
1605         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1606                 return false;
1607         encoder->protected_->max_lpc_order = value;
1608         return true;
1609 }
1610
1611 FLAC_API FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, unsigned value)
1612 {
1613         FLAC__ASSERT(0 != encoder);
1614         FLAC__ASSERT(0 != encoder->private_);
1615         FLAC__ASSERT(0 != encoder->protected_);
1616         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1617                 return false;
1618         encoder->protected_->qlp_coeff_precision = value;
1619         return true;
1620 }
1621
1622 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value)
1623 {
1624         FLAC__ASSERT(0 != encoder);
1625         FLAC__ASSERT(0 != encoder->private_);
1626         FLAC__ASSERT(0 != encoder->protected_);
1627         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1628                 return false;
1629         encoder->protected_->do_qlp_coeff_prec_search = value;
1630         return true;
1631 }
1632
1633 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value)
1634 {
1635         FLAC__ASSERT(0 != encoder);
1636         FLAC__ASSERT(0 != encoder->private_);
1637         FLAC__ASSERT(0 != encoder->protected_);
1638         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1639                 return false;
1640 #if 0
1641         /*@@@ deprecated: */
1642         encoder->protected_->do_escape_coding = value;
1643 #else
1644         (void)value;
1645 #endif
1646         return true;
1647 }
1648
1649 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value)
1650 {
1651         FLAC__ASSERT(0 != encoder);
1652         FLAC__ASSERT(0 != encoder->private_);
1653         FLAC__ASSERT(0 != encoder->protected_);
1654         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1655                 return false;
1656         encoder->protected_->do_exhaustive_model_search = value;
1657         return true;
1658 }
1659
1660 FLAC_API FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value)
1661 {
1662         FLAC__ASSERT(0 != encoder);
1663         FLAC__ASSERT(0 != encoder->private_);
1664         FLAC__ASSERT(0 != encoder->protected_);
1665         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1666                 return false;
1667         encoder->protected_->min_residual_partition_order = value;
1668         return true;
1669 }
1670
1671 FLAC_API FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value)
1672 {
1673         FLAC__ASSERT(0 != encoder);
1674         FLAC__ASSERT(0 != encoder->private_);
1675         FLAC__ASSERT(0 != encoder->protected_);
1676         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1677                 return false;
1678         encoder->protected_->max_residual_partition_order = value;
1679         return true;
1680 }
1681
1682 FLAC_API FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, unsigned value)
1683 {
1684         FLAC__ASSERT(0 != encoder);
1685         FLAC__ASSERT(0 != encoder->private_);
1686         FLAC__ASSERT(0 != encoder->protected_);
1687         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1688                 return false;
1689 #if 0
1690         /*@@@ deprecated: */
1691         encoder->protected_->rice_parameter_search_dist = value;
1692 #else
1693         (void)value;
1694 #endif
1695         return true;
1696 }
1697
1698 FLAC_API FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value)
1699 {
1700         FLAC__ASSERT(0 != encoder);
1701         FLAC__ASSERT(0 != encoder->private_);
1702         FLAC__ASSERT(0 != encoder->protected_);
1703         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1704                 return false;
1705         encoder->protected_->total_samples_estimate = value;
1706         return true;
1707 }
1708
1709 FLAC_API FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks)
1710 {
1711         FLAC__ASSERT(0 != encoder);
1712         FLAC__ASSERT(0 != encoder->private_);
1713         FLAC__ASSERT(0 != encoder->protected_);
1714         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1715                 return false;
1716         if(0 == metadata)
1717                 num_blocks = 0;
1718         if(0 == num_blocks)
1719                 metadata = 0;
1720         /* realloc() does not do exactly what we want so... */
1721         if(encoder->protected_->metadata) {
1722                 free(encoder->protected_->metadata);
1723                 encoder->protected_->metadata = 0;
1724                 encoder->protected_->num_metadata_blocks = 0;
1725         }
1726         if(num_blocks) {
1727                 FLAC__StreamMetadata **m;
1728                 if(0 == (m = (FLAC__StreamMetadata**)malloc(sizeof(m[0]) * num_blocks)))
1729                         return false;
1730                 memcpy(m, metadata, sizeof(m[0]) * num_blocks);
1731                 encoder->protected_->metadata = m;
1732                 encoder->protected_->num_metadata_blocks = num_blocks;
1733         }
1734 #if FLAC__HAS_OGG
1735         if(!FLAC__ogg_encoder_aspect_set_num_metadata(&encoder->protected_->ogg_encoder_aspect, num_blocks))
1736                 return false;
1737 #endif
1738         return true;
1739 }
1740
1741 /*
1742  * These three functions are not static, but not publically exposed in
1743  * include/FLAC/ either.  They are used by the test suite.
1744  */
1745 FLAC_API FLAC__bool FLAC__stream_encoder_disable_constant_subframes(FLAC__StreamEncoder *encoder, FLAC__bool value)
1746 {
1747         FLAC__ASSERT(0 != encoder);
1748         FLAC__ASSERT(0 != encoder->private_);
1749         FLAC__ASSERT(0 != encoder->protected_);
1750         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1751                 return false;
1752         encoder->private_->disable_constant_subframes = value;
1753         return true;
1754 }
1755
1756 FLAC_API FLAC__bool FLAC__stream_encoder_disable_fixed_subframes(FLAC__StreamEncoder *encoder, FLAC__bool value)
1757 {
1758         FLAC__ASSERT(0 != encoder);
1759         FLAC__ASSERT(0 != encoder->private_);
1760         FLAC__ASSERT(0 != encoder->protected_);
1761         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1762                 return false;
1763         encoder->private_->disable_fixed_subframes = value;
1764         return true;
1765 }
1766
1767 FLAC_API FLAC__bool FLAC__stream_encoder_disable_verbatim_subframes(FLAC__StreamEncoder *encoder, FLAC__bool value)
1768 {
1769         FLAC__ASSERT(0 != encoder);
1770         FLAC__ASSERT(0 != encoder->private_);
1771         FLAC__ASSERT(0 != encoder->protected_);
1772         if(encoder->protected_->state != FLAC__STREAM_ENCODER_UNINITIALIZED)
1773                 return false;
1774         encoder->private_->disable_verbatim_subframes = value;
1775         return true;
1776 }
1777
1778 FLAC_API FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder)
1779 {
1780         FLAC__ASSERT(0 != encoder);
1781         FLAC__ASSERT(0 != encoder->private_);
1782         FLAC__ASSERT(0 != encoder->protected_);
1783         return encoder->protected_->state;
1784 }
1785
1786 FLAC_API FLAC__StreamDecoderState FLAC__stream_encoder_get_verify_decoder_state(const FLAC__StreamEncoder *encoder)
1787 {
1788         FLAC__ASSERT(0 != encoder);
1789         FLAC__ASSERT(0 != encoder->private_);
1790         FLAC__ASSERT(0 != encoder->protected_);
1791         if(encoder->protected_->verify)
1792                 return FLAC__stream_decoder_get_state(encoder->private_->verify.decoder);
1793         else
1794                 return FLAC__STREAM_DECODER_UNINITIALIZED;
1795 }
1796
1797 FLAC_API const char *FLAC__stream_encoder_get_resolved_state_string(const FLAC__StreamEncoder *encoder)
1798 {
1799         FLAC__ASSERT(0 != encoder);
1800         FLAC__ASSERT(0 != encoder->private_);
1801         FLAC__ASSERT(0 != encoder->protected_);
1802         if(encoder->protected_->state != FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR)
1803                 return FLAC__StreamEncoderStateString[encoder->protected_->state];
1804         else
1805                 return FLAC__stream_decoder_get_resolved_state_string(encoder->private_->verify.decoder);
1806 }
1807
1808 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)
1809 {
1810         FLAC__ASSERT(0 != encoder);
1811         FLAC__ASSERT(0 != encoder->private_);
1812         FLAC__ASSERT(0 != encoder->protected_);
1813         if(0 != absolute_sample)
1814                 *absolute_sample = encoder->private_->verify.error_stats.absolute_sample;
1815         if(0 != frame_number)
1816                 *frame_number = encoder->private_->verify.error_stats.frame_number;
1817         if(0 != channel)
1818                 *channel = encoder->private_->verify.error_stats.channel;
1819         if(0 != sample)
1820                 *sample = encoder->private_->verify.error_stats.sample;
1821         if(0 != expected)
1822                 *expected = encoder->private_->verify.error_stats.expected;
1823         if(0 != got)
1824                 *got = encoder->private_->verify.error_stats.got;
1825 }
1826
1827 FLAC_API FLAC__bool FLAC__stream_encoder_get_verify(const FLAC__StreamEncoder *encoder)
1828 {
1829         FLAC__ASSERT(0 != encoder);
1830         FLAC__ASSERT(0 != encoder->private_);
1831         FLAC__ASSERT(0 != encoder->protected_);
1832         return encoder->protected_->verify;
1833 }
1834
1835 FLAC_API FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder)
1836 {
1837         FLAC__ASSERT(0 != encoder);
1838         FLAC__ASSERT(0 != encoder->private_);
1839         FLAC__ASSERT(0 != encoder->protected_);
1840         return encoder->protected_->streamable_subset;
1841 }
1842
1843 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_md5(const FLAC__StreamEncoder *encoder)
1844 {
1845         FLAC__ASSERT(0 != encoder);
1846         FLAC__ASSERT(0 != encoder->private_);
1847         FLAC__ASSERT(0 != encoder->protected_);
1848         return encoder->protected_->do_md5;
1849 }
1850
1851 FLAC_API unsigned FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder)
1852 {
1853         FLAC__ASSERT(0 != encoder);
1854         FLAC__ASSERT(0 != encoder->private_);
1855         FLAC__ASSERT(0 != encoder->protected_);
1856         return encoder->protected_->channels;
1857 }
1858
1859 FLAC_API unsigned FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder)
1860 {
1861         FLAC__ASSERT(0 != encoder);
1862         FLAC__ASSERT(0 != encoder->private_);
1863         FLAC__ASSERT(0 != encoder->protected_);
1864         return encoder->protected_->bits_per_sample;
1865 }
1866
1867 FLAC_API unsigned FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder)
1868 {
1869         FLAC__ASSERT(0 != encoder);
1870         FLAC__ASSERT(0 != encoder->private_);
1871         FLAC__ASSERT(0 != encoder->protected_);
1872         return encoder->protected_->sample_rate;
1873 }
1874
1875 FLAC_API unsigned FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder)
1876 {
1877         FLAC__ASSERT(0 != encoder);
1878         FLAC__ASSERT(0 != encoder->private_);
1879         FLAC__ASSERT(0 != encoder->protected_);
1880         return encoder->protected_->blocksize;
1881 }
1882
1883 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder)
1884 {
1885         FLAC__ASSERT(0 != encoder);
1886         FLAC__ASSERT(0 != encoder->private_);
1887         FLAC__ASSERT(0 != encoder->protected_);
1888         return encoder->protected_->do_mid_side_stereo;
1889 }
1890
1891 FLAC_API FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder)
1892 {
1893         FLAC__ASSERT(0 != encoder);
1894         FLAC__ASSERT(0 != encoder->private_);
1895         FLAC__ASSERT(0 != encoder->protected_);
1896         return encoder->protected_->loose_mid_side_stereo;
1897 }
1898
1899 FLAC_API unsigned FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder)
1900 {
1901         FLAC__ASSERT(0 != encoder);
1902         FLAC__ASSERT(0 != encoder->private_);
1903         FLAC__ASSERT(0 != encoder->protected_);
1904         return encoder->protected_->max_lpc_order;
1905 }
1906
1907 FLAC_API unsigned FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder)
1908 {
1909         FLAC__ASSERT(0 != encoder);
1910         FLAC__ASSERT(0 != encoder->private_);
1911         FLAC__ASSERT(0 != encoder->protected_);
1912         return encoder->protected_->qlp_coeff_precision;
1913 }
1914
1915 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder)
1916 {
1917         FLAC__ASSERT(0 != encoder);
1918         FLAC__ASSERT(0 != encoder->private_);
1919         FLAC__ASSERT(0 != encoder->protected_);
1920         return encoder->protected_->do_qlp_coeff_prec_search;
1921 }
1922
1923 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder)
1924 {
1925         FLAC__ASSERT(0 != encoder);
1926         FLAC__ASSERT(0 != encoder->private_);
1927         FLAC__ASSERT(0 != encoder->protected_);
1928         return encoder->protected_->do_escape_coding;
1929 }
1930
1931 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder)
1932 {
1933         FLAC__ASSERT(0 != encoder);
1934         FLAC__ASSERT(0 != encoder->private_);
1935         FLAC__ASSERT(0 != encoder->protected_);
1936         return encoder->protected_->do_exhaustive_model_search;
1937 }
1938
1939 FLAC_API unsigned FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder)
1940 {
1941         FLAC__ASSERT(0 != encoder);
1942         FLAC__ASSERT(0 != encoder->private_);
1943         FLAC__ASSERT(0 != encoder->protected_);
1944         return encoder->protected_->min_residual_partition_order;
1945 }
1946
1947 FLAC_API unsigned FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder)
1948 {
1949         FLAC__ASSERT(0 != encoder);
1950         FLAC__ASSERT(0 != encoder->private_);
1951         FLAC__ASSERT(0 != encoder->protected_);
1952         return encoder->protected_->max_residual_partition_order;
1953 }
1954
1955 FLAC_API unsigned FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder)
1956 {
1957         FLAC__ASSERT(0 != encoder);
1958         FLAC__ASSERT(0 != encoder->private_);
1959         FLAC__ASSERT(0 != encoder->protected_);
1960         return encoder->protected_->rice_parameter_search_dist;
1961 }
1962
1963 FLAC_API FLAC__uint64 FLAC__stream_encoder_get_total_samples_estimate(const FLAC__StreamEncoder *encoder)
1964 {
1965         FLAC__ASSERT(0 != encoder);
1966         FLAC__ASSERT(0 != encoder->private_);
1967         FLAC__ASSERT(0 != encoder->protected_);
1968         return encoder->protected_->total_samples_estimate;
1969 }
1970
1971 FLAC_API FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples)
1972 {
1973         unsigned i, j = 0, channel;
1974         const unsigned channels = encoder->protected_->channels, blocksize = encoder->protected_->blocksize;
1975
1976         FLAC__ASSERT(0 != encoder);
1977         FLAC__ASSERT(0 != encoder->private_);
1978         FLAC__ASSERT(0 != encoder->protected_);
1979         FLAC__ASSERT(encoder->protected_->state == FLAC__STREAM_ENCODER_OK);
1980
1981         do {
1982                 const unsigned n = min(blocksize+OVERREAD_-encoder->private_->current_sample_number, samples-j);
1983
1984                 if(encoder->protected_->verify)
1985                         append_to_verify_fifo_(&encoder->private_->verify.input_fifo, buffer, j, channels, n);
1986
1987                 for(channel = 0; channel < channels; channel++)
1988                         memcpy(&encoder->private_->integer_signal[channel][encoder->private_->current_sample_number], &buffer[channel][j], sizeof(buffer[channel][0]) * n);
1989
1990                 if(encoder->protected_->do_mid_side_stereo) {
1991                         FLAC__ASSERT(channels == 2);
1992                         /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
1993                         for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
1994                                 encoder->private_->integer_signal_mid_side[1][i] = buffer[0][j] - buffer[1][j];
1995                                 encoder->private_->integer_signal_mid_side[0][i] = (buffer[0][j] + buffer[1][j]) >> 1; /* NOTE: not the same as 'mid = (buffer[0][j] + buffer[1][j]) / 2' ! */
1996                         }
1997                 }
1998                 else
1999                         j += n;
2000
2001                 encoder->private_->current_sample_number += n;
2002
2003                 /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2004                 if(encoder->private_->current_sample_number > blocksize) {
2005                         FLAC__ASSERT(encoder->private_->current_sample_number == blocksize+OVERREAD_);
2006                         FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2007                         if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2008                                 return false;
2009                         /* move unprocessed overread samples to beginnings of arrays */
2010                         for(channel = 0; channel < channels; channel++)
2011                                 encoder->private_->integer_signal[channel][0] = encoder->private_->integer_signal[channel][blocksize];
2012                         if(encoder->protected_->do_mid_side_stereo) {
2013                                 encoder->private_->integer_signal_mid_side[0][0] = encoder->private_->integer_signal_mid_side[0][blocksize];
2014                                 encoder->private_->integer_signal_mid_side[1][0] = encoder->private_->integer_signal_mid_side[1][blocksize];
2015                         }
2016                         encoder->private_->current_sample_number = 1;
2017                 }
2018         } while(j < samples);
2019
2020         return true;
2021 }
2022
2023 FLAC_API FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples)
2024 {
2025         unsigned i, j, k, channel;
2026         FLAC__int32 x, mid, side;
2027         const unsigned channels = encoder->protected_->channels, blocksize = encoder->protected_->blocksize;
2028
2029         FLAC__ASSERT(0 != encoder);
2030         FLAC__ASSERT(0 != encoder->private_);
2031         FLAC__ASSERT(0 != encoder->protected_);
2032         FLAC__ASSERT(encoder->protected_->state == FLAC__STREAM_ENCODER_OK);
2033
2034         j = k = 0;
2035         /*
2036          * we have several flavors of the same basic loop, optimized for
2037          * different conditions:
2038          */
2039         if(encoder->protected_->do_mid_side_stereo && channels == 2) {
2040                 /*
2041                  * stereo coding: unroll channel loop
2042                  */
2043                 do {
2044                         if(encoder->protected_->verify)
2045                                 append_to_verify_fifo_interleaved_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+OVERREAD_-encoder->private_->current_sample_number, samples-j));
2046
2047                         /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2048                         for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2049                                 encoder->private_->integer_signal[0][i] = mid = side = buffer[k++];
2050                                 x = buffer[k++];
2051                                 encoder->private_->integer_signal[1][i] = x;
2052                                 mid += x;
2053                                 side -= x;
2054                                 mid >>= 1; /* NOTE: not the same as 'mid = (left + right) / 2' ! */
2055                                 encoder->private_->integer_signal_mid_side[1][i] = side;
2056                                 encoder->private_->integer_signal_mid_side[0][i] = mid;
2057                         }
2058                         encoder->private_->current_sample_number = i;
2059                         /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2060                         if(i > blocksize) {
2061                                 if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2062                                         return false;
2063                                 /* move unprocessed overread samples to beginnings of arrays */
2064                                 FLAC__ASSERT(i == blocksize+OVERREAD_);
2065                                 FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2066                                 encoder->private_->integer_signal[0][0] = encoder->private_->integer_signal[0][blocksize];
2067                                 encoder->private_->integer_signal[1][0] = encoder->private_->integer_signal[1][blocksize];
2068                                 encoder->private_->integer_signal_mid_side[0][0] = encoder->private_->integer_signal_mid_side[0][blocksize];
2069                                 encoder->private_->integer_signal_mid_side[1][0] = encoder->private_->integer_signal_mid_side[1][blocksize];
2070                                 encoder->private_->current_sample_number = 1;
2071                         }
2072                 } while(j < samples);
2073         }
2074         else {
2075                 /*
2076                  * independent channel coding: buffer each channel in inner loop
2077                  */
2078                 do {
2079                         if(encoder->protected_->verify)
2080                                 append_to_verify_fifo_interleaved_(&encoder->private_->verify.input_fifo, buffer, j, channels, min(blocksize+OVERREAD_-encoder->private_->current_sample_number, samples-j));
2081
2082                         /* "i <= blocksize" to overread 1 sample; see comment in OVERREAD_ decl */
2083                         for(i = encoder->private_->current_sample_number; i <= blocksize && j < samples; i++, j++) {
2084                                 for(channel = 0; channel < channels; channel++)
2085                                         encoder->private_->integer_signal[channel][i] = buffer[k++];
2086                         }
2087                         encoder->private_->current_sample_number = i;
2088                         /* we only process if we have a full block + 1 extra sample; final block is always handled by FLAC__stream_encoder_finish() */
2089                         if(i > blocksize) {
2090                                 if(!process_frame_(encoder, /*is_fractional_block=*/false, /*is_last_block=*/false))
2091                                         return false;
2092                                 /* move unprocessed overread samples to beginnings of arrays */
2093                                 FLAC__ASSERT(i == blocksize+OVERREAD_);
2094                                 FLAC__ASSERT(OVERREAD_ == 1); /* assert we only overread 1 sample which simplifies the rest of the code below */
2095                                 for(channel = 0; channel < channels; channel++)
2096                                         encoder->private_->integer_signal[channel][0] = encoder->private_->integer_signal[channel][blocksize];
2097                                 encoder->private_->current_sample_number = 1;
2098                         }
2099                 } while(j < samples);
2100         }
2101
2102         return true;
2103 }
2104
2105 /***********************************************************************
2106  *
2107  * Private class methods
2108  *
2109  ***********************************************************************/
2110
2111 void set_defaults_(FLAC__StreamEncoder *encoder)
2112 {
2113         FLAC__ASSERT(0 != encoder);
2114
2115 #ifdef FLAC__MANDATORY_VERIFY_WHILE_ENCODING
2116         encoder->protected_->verify = true;
2117 #else
2118         encoder->protected_->verify = false;
2119 #endif
2120         encoder->protected_->streamable_subset = true;
2121         encoder->protected_->do_md5 = true;
2122         encoder->protected_->do_mid_side_stereo = false;
2123         encoder->protected_->loose_mid_side_stereo = false;
2124         encoder->protected_->channels = 2;
2125         encoder->protected_->bits_per_sample = 16;
2126         encoder->protected_->sample_rate = 44100;
2127         encoder->protected_->blocksize = 0;
2128 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2129         encoder->protected_->num_apodizations = 1;
2130         encoder->protected_->apodizations[0].type = FLAC__APODIZATION_TUKEY;
2131         encoder->protected_->apodizations[0].parameters.tukey.p = 0.5;
2132 #endif
2133         encoder->protected_->max_lpc_order = 0;
2134         encoder->protected_->qlp_coeff_precision = 0;
2135         encoder->protected_->do_qlp_coeff_prec_search = false;
2136         encoder->protected_->do_exhaustive_model_search = false;
2137         encoder->protected_->do_escape_coding = false;
2138         encoder->protected_->min_residual_partition_order = 0;
2139         encoder->protected_->max_residual_partition_order = 0;
2140         encoder->protected_->rice_parameter_search_dist = 0;
2141         encoder->protected_->total_samples_estimate = 0;
2142         encoder->protected_->metadata = 0;
2143         encoder->protected_->num_metadata_blocks = 0;
2144
2145         encoder->private_->seek_table = 0;
2146         encoder->private_->disable_constant_subframes = false;
2147         encoder->private_->disable_fixed_subframes = false;
2148         encoder->private_->disable_verbatim_subframes = false;
2149 #if FLAC__HAS_OGG
2150         encoder->private_->is_ogg = false;
2151 #endif
2152         encoder->private_->read_callback = 0;
2153         encoder->private_->write_callback = 0;
2154         encoder->private_->seek_callback = 0;
2155         encoder->private_->tell_callback = 0;
2156         encoder->private_->metadata_callback = 0;
2157         encoder->private_->progress_callback = 0;
2158         encoder->private_->client_data = 0;
2159
2160 #if FLAC__HAS_OGG
2161         FLAC__ogg_encoder_aspect_set_defaults(&encoder->protected_->ogg_encoder_aspect);
2162 #endif
2163 }
2164
2165 void free_(FLAC__StreamEncoder *encoder)
2166 {
2167         unsigned i, channel;
2168
2169         FLAC__ASSERT(0 != encoder);
2170         if(encoder->protected_->metadata) {
2171                 free(encoder->protected_->metadata);
2172                 encoder->protected_->metadata = 0;
2173                 encoder->protected_->num_metadata_blocks = 0;
2174         }
2175         for(i = 0; i < encoder->protected_->channels; i++) {
2176                 if(0 != encoder->private_->integer_signal_unaligned[i]) {
2177                         free(encoder->private_->integer_signal_unaligned[i]);
2178                         encoder->private_->integer_signal_unaligned[i] = 0;
2179                 }
2180 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2181                 if(0 != encoder->private_->real_signal_unaligned[i]) {
2182                         free(encoder->private_->real_signal_unaligned[i]);
2183                         encoder->private_->real_signal_unaligned[i] = 0;
2184                 }
2185 #endif
2186         }
2187         for(i = 0; i < 2; i++) {
2188                 if(0 != encoder->private_->integer_signal_mid_side_unaligned[i]) {
2189                         free(encoder->private_->integer_signal_mid_side_unaligned[i]);
2190                         encoder->private_->integer_signal_mid_side_unaligned[i] = 0;
2191                 }
2192 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2193                 if(0 != encoder->private_->real_signal_mid_side_unaligned[i]) {
2194                         free(encoder->private_->real_signal_mid_side_unaligned[i]);
2195                         encoder->private_->real_signal_mid_side_unaligned[i] = 0;
2196                 }
2197 #endif
2198         }
2199 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2200         for(i = 0; i < encoder->protected_->num_apodizations; i++) {
2201                 if(0 != encoder->private_->window_unaligned[i]) {
2202                         free(encoder->private_->window_unaligned[i]);
2203                         encoder->private_->window_unaligned[i] = 0;
2204                 }
2205         }
2206         if(0 != encoder->private_->windowed_signal_unaligned) {
2207                 free(encoder->private_->windowed_signal_unaligned);
2208                 encoder->private_->windowed_signal_unaligned = 0;
2209         }
2210 #endif
2211         for(channel = 0; channel < encoder->protected_->channels; channel++) {
2212                 for(i = 0; i < 2; i++) {
2213                         if(0 != encoder->private_->residual_workspace_unaligned[channel][i]) {
2214                                 free(encoder->private_->residual_workspace_unaligned[channel][i]);
2215                                 encoder->private_->residual_workspace_unaligned[channel][i] = 0;
2216                         }
2217                 }
2218         }
2219         for(channel = 0; channel < 2; channel++) {
2220                 for(i = 0; i < 2; i++) {
2221                         if(0 != encoder->private_->residual_workspace_mid_side_unaligned[channel][i]) {
2222                                 free(encoder->private_->residual_workspace_mid_side_unaligned[channel][i]);
2223                                 encoder->private_->residual_workspace_mid_side_unaligned[channel][i] = 0;
2224                         }
2225                 }
2226         }
2227         if(0 != encoder->private_->abs_residual_partition_sums_unaligned) {
2228                 free(encoder->private_->abs_residual_partition_sums_unaligned);
2229                 encoder->private_->abs_residual_partition_sums_unaligned = 0;
2230         }
2231         if(0 != encoder->private_->raw_bits_per_partition_unaligned) {
2232                 free(encoder->private_->raw_bits_per_partition_unaligned);
2233                 encoder->private_->raw_bits_per_partition_unaligned = 0;
2234         }
2235         if(encoder->protected_->verify) {
2236                 for(i = 0; i < encoder->protected_->channels; i++) {
2237                         if(0 != encoder->private_->verify.input_fifo.data[i]) {
2238                                 free(encoder->private_->verify.input_fifo.data[i]);
2239                                 encoder->private_->verify.input_fifo.data[i] = 0;
2240                         }
2241                 }
2242         }
2243         FLAC__bitwriter_free(encoder->private_->frame);
2244 }
2245
2246 FLAC__bool resize_buffers_(FLAC__StreamEncoder *encoder, unsigned new_blocksize)
2247 {
2248         FLAC__bool ok;
2249         unsigned i, channel;
2250
2251         FLAC__ASSERT(new_blocksize > 0);
2252         FLAC__ASSERT(encoder->protected_->state == FLAC__STREAM_ENCODER_OK);
2253         FLAC__ASSERT(encoder->private_->current_sample_number == 0);
2254
2255         /* To avoid excessive malloc'ing, we only grow the buffer; no shrinking. */
2256         if(new_blocksize <= encoder->private_->input_capacity)
2257                 return true;
2258
2259         ok = true;
2260
2261         /* WATCHOUT: FLAC__lpc_compute_residual_from_qlp_coefficients_asm_ia32_mmx()
2262          * requires that the input arrays (in our case the integer signals)
2263          * have a buffer of up to 3 zeroes in front (at negative indices) for
2264          * alignment purposes; we use 4 in front to keep the data well-aligned.
2265          */
2266
2267         for(i = 0; ok && i < encoder->protected_->channels; i++) {
2268                 ok = ok && FLAC__memory_alloc_aligned_int32_array(new_blocksize+4+OVERREAD_, &encoder->private_->integer_signal_unaligned[i], &encoder->private_->integer_signal[i]);
2269                 memset(encoder->private_->integer_signal[i], 0, sizeof(FLAC__int32)*4);
2270                 encoder->private_->integer_signal[i] += 4;
2271 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2272 #if 0 /* @@@ currently unused */
2273                 if(encoder->protected_->max_lpc_order > 0)
2274                         ok = ok && FLAC__memory_alloc_aligned_real_array(new_blocksize+OVERREAD_, &encoder->private_->real_signal_unaligned[i], &encoder->private_->real_signal[i]);
2275 #endif
2276 #endif
2277         }
2278         for(i = 0; ok && i < 2; i++) {
2279                 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]);
2280                 memset(encoder->private_->integer_signal_mid_side[i], 0, sizeof(FLAC__int32)*4);
2281                 encoder->private_->integer_signal_mid_side[i] += 4;
2282 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2283 #if 0 /* @@@ currently unused */
2284                 if(encoder->protected_->max_lpc_order > 0)
2285                         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]);
2286 #endif
2287 #endif
2288         }
2289 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2290         if(ok && encoder->protected_->max_lpc_order > 0) {
2291                 for(i = 0; ok && i < encoder->protected_->num_apodizations; i++)
2292                         ok = ok && FLAC__memory_alloc_aligned_real_array(new_blocksize, &encoder->private_->window_unaligned[i], &encoder->private_->window[i]);
2293                 ok = ok && FLAC__memory_alloc_aligned_real_array(new_blocksize, &encoder->private_->windowed_signal_unaligned, &encoder->private_->windowed_signal);
2294         }
2295 #endif
2296         for(channel = 0; ok && channel < encoder->protected_->channels; channel++) {
2297                 for(i = 0; ok && i < 2; i++) {
2298                         ok = ok && FLAC__memory_alloc_aligned_int32_array(new_blocksize, &encoder->private_->residual_workspace_unaligned[channel][i], &encoder->private_->residual_workspace[channel][i]);
2299                 }
2300         }
2301         for(channel = 0; ok && channel < 2; channel++) {
2302                 for(i = 0; ok && i < 2; i++) {
2303                         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]);
2304                 }
2305         }
2306         /* the *2 is an approximation to the series 1 + 1/2 + 1/4 + ... that sums tree occupies in a flat array */
2307         /*@@@ new_blocksize*2 is too pessimistic, but to fix, we need smarter logic because a smaller new_blocksize can actually increase the # of partitions; would require moving this out into a separate function, then checking its capacity against the need of the current blocksize&min/max_partition_order (and maybe predictor order) */
2308         ok = ok && FLAC__memory_alloc_aligned_uint64_array(new_blocksize * 2, &encoder->private_->abs_residual_partition_sums_unaligned, &encoder->private_->abs_residual_partition_sums);
2309         if(encoder->protected_->do_escape_coding)
2310                 ok = ok && FLAC__memory_alloc_aligned_unsigned_array(new_blocksize * 2, &encoder->private_->raw_bits_per_partition_unaligned, &encoder->private_->raw_bits_per_partition);
2311
2312         /* now adjust the windows if the blocksize has changed */
2313 #ifndef FLAC__INTEGER_ONLY_LIBRARY
2314         if(ok && new_blocksize != encoder->private_->input_capacity && encoder->protected_->max_lpc_order > 0) {
2315                 for(i = 0; ok && i < encoder->protected_->num_apodizations; i++) {
2316                         switch(encoder->protected_->apodizations[i].type) {
2317                                 case FLAC__APODIZATION_BARTLETT:
2318                                         FLAC__window_bartlett(encoder->private_->window[i], new_blocksize);
2319                                         break;
2320                                 case FLAC__APODIZATION_BARTLETT_HANN:
2321                                         FLAC__window_bartlett_hann(encoder->private_->window[i], new_blocksize);
2322                                         break;
2323                                 case FLAC__APODIZATION_BLACKMAN:
2324                                         FLAC__window_blackman(encoder->private_->window[i], new_blocksize);
2325                                         break;
2326                                 case FLAC__APODIZATION_BLACKMAN_HARRIS_4TERM_92DB_SIDELOBE:
2327                                         FLAC__window_blackman_harris_4term_92db_sidelobe(encoder->private_->window[i], new_blocksize);
2328                                         break;
2329                                 case FLAC__APODIZATION_CONNES:
2330                                         FLAC__window_connes(encoder->private_->window[i], new_blocksize);
2331                                         break;
2332                                 case FLAC__APODIZATION_FLATTOP:
2333                                         FLAC__window_flattop(encoder->private_->window[i], new_blocksize);
2334                                         break;
2335                                 case FLAC__APODIZATION_GAUSS:
2336                                         FLAC__window_gauss(encoder->private_->window[i], new_blocksize, encoder->protected_->apodizations[i].parameters.gauss.stddev);
2337                                         break;
2338                                 case FLAC__APODIZATION_HAMMING:
2339                                         FLAC__window_hamming(encoder->private_->window[i], new_blocksize);
2340                                         break;
2341                                 case FLAC__APODIZATION_HANN:
2342                                         FLAC__window_hann(encoder->private_->window[i], new_blocksize);
2343                                         break;
2344                                 case FLAC__APODIZATION_KAISER_BESSEL:
2345                                         FLAC__window_kaiser_bessel(encoder->private_->window[i], new_blocksize);
2346                                         break;
2347                                 case FLAC__APODIZATION_NUTTALL:
2348                                         FLAC__window_nuttall(encoder->private_->window[i], new_blocksize);
2349                                         break;
2350                                 case FLAC__APODIZATION_RECTANGLE:
2351                                         FLAC__window_rectangle(encoder->private_->window[i], new_blocksize);
2352                                         break;
2353                                 case FLAC__APODIZATION_TRIANGLE:
2354                                         FLAC__window_triangle(encoder->private_->window[i], new_blocksize);
2355                                         break;
2356                                 case FLAC__APODIZATION_TUKEY:
2357                                         FLAC__window_tukey(encoder->private_->window[i], new_blocksize, encoder->protected_->apodizations[i].parameters.tukey.p);
2358                                         break;
2359                                 case FLAC__APODIZATION_WELCH:
2360                                         FLAC__window_welch(encoder->private_->window[i], new_blocksize);
2361                                         break;
2362                                 default:
2363                                         FLAC__ASSERT(0);
2364                                         /* double protection */
2365                                         FLAC__window_hann(encoder->private_->window[i], new_blocksize);
2366                                         break;
2367                         }
2368                 }
2369         }
2370 #endif
2371
2372         if(ok)
2373                 encoder->private_->input_capacity = new_blocksize;
2374         else
2375                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
2376
2377         return ok;
2378 }
2379
2380 FLAC__bool write_bitbuffer_(FLAC__StreamEncoder *encoder, unsigned samples, FLAC__bool is_last_block)
2381 {
2382         const FLAC__byte *buffer;
2383         size_t bytes;
2384
2385         FLAC__ASSERT(FLAC__bitwriter_is_byte_aligned(encoder->private_->frame));
2386
2387         if(!FLAC__bitwriter_get_buffer(encoder->private_->frame, &buffer, &bytes)) {
2388                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
2389                 return false;
2390         }
2391
2392         if(encoder->protected_->verify) {
2393                 encoder->private_->verify.output.data = buffer;
2394                 encoder->private_->verify.output.bytes = bytes;
2395                 if(encoder->private_->verify.state_hint == ENCODER_IN_MAGIC) {
2396                         encoder->private_->verify.needs_magic_hack = true;
2397                 }
2398                 else {
2399                         if(!FLAC__stream_decoder_process_single(encoder->private_->verify.decoder)) {
2400                                 FLAC__bitwriter_release_buffer(encoder->private_->frame);
2401                                 FLAC__bitwriter_clear(encoder->private_->frame);
2402                                 if(encoder->protected_->state != FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA)
2403                                         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR;
2404                                 return false;
2405                         }
2406                 }
2407         }
2408
2409         if(write_frame_(encoder, buffer, bytes, samples, is_last_block) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2410                 FLAC__bitwriter_release_buffer(encoder->private_->frame);
2411                 FLAC__bitwriter_clear(encoder->private_->frame);
2412                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2413                 return false;
2414         }
2415
2416         FLAC__bitwriter_release_buffer(encoder->private_->frame);
2417         FLAC__bitwriter_clear(encoder->private_->frame);
2418
2419         if(samples > 0) {
2420                 encoder->private_->streaminfo.data.stream_info.min_framesize = min(bytes, encoder->private_->streaminfo.data.stream_info.min_framesize);
2421                 encoder->private_->streaminfo.data.stream_info.max_framesize = max(bytes, encoder->private_->streaminfo.data.stream_info.max_framesize);
2422         }
2423
2424         return true;
2425 }
2426
2427 FLAC__StreamEncoderWriteStatus write_frame_(FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, FLAC__bool is_last_block)
2428 {
2429         FLAC__StreamEncoderWriteStatus status;
2430         FLAC__uint64 output_position = 0;
2431
2432         /* FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED just means we didn't get the offset; no error */
2433         if(encoder->private_->tell_callback && encoder->private_->tell_callback(encoder, &output_position, encoder->private_->client_data) == FLAC__STREAM_ENCODER_TELL_STATUS_ERROR) {
2434                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2435                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
2436         }
2437
2438         /*
2439          * Watch for the STREAMINFO block and first SEEKTABLE block to go by and store their offsets.
2440          */
2441         if(samples == 0) {
2442                 FLAC__MetadataType type = (buffer[0] & 0x7f);
2443                 if(type == FLAC__METADATA_TYPE_STREAMINFO)
2444                         encoder->protected_->streaminfo_offset = output_position;
2445                 else if(type == FLAC__METADATA_TYPE_SEEKTABLE && encoder->protected_->seektable_offset == 0)
2446                         encoder->protected_->seektable_offset = output_position;
2447         }
2448
2449         /*
2450          * Mark the current seek point if hit (if audio_offset == 0 that
2451          * means we're still writing metadata and haven't hit the first
2452          * frame yet)
2453          */
2454         if(0 != encoder->private_->seek_table && encoder->protected_->audio_offset > 0 && encoder->private_->seek_table->num_points > 0) {
2455                 const unsigned blocksize = FLAC__stream_encoder_get_blocksize(encoder);
2456                 const FLAC__uint64 frame_first_sample = encoder->private_->samples_written;
2457                 const FLAC__uint64 frame_last_sample = frame_first_sample + (FLAC__uint64)blocksize - 1;
2458                 FLAC__uint64 test_sample;
2459                 unsigned i;
2460                 for(i = encoder->private_->first_seekpoint_to_check; i < encoder->private_->seek_table->num_points; i++) {
2461                         test_sample = encoder->private_->seek_table->points[i].sample_number;
2462                         if(test_sample > frame_last_sample) {
2463                                 break;
2464                         }
2465                         else if(test_sample >= frame_first_sample) {
2466                                 encoder->private_->seek_table->points[i].sample_number = frame_first_sample;
2467                                 encoder->private_->seek_table->points[i].stream_offset = output_position - encoder->protected_->audio_offset;
2468                                 encoder->private_->seek_table->points[i].frame_samples = blocksize;
2469                                 encoder->private_->first_seekpoint_to_check++;
2470                                 /* DO NOT: "break;" and here's why:
2471                                  * The seektable template may contain more than one target
2472                                  * sample for any given frame; we will keep looping, generating
2473                                  * duplicate seekpoints for them, and we'll clean it up later,
2474                                  * just before writing the seektable back to the metadata.
2475                                  */
2476                         }
2477                         else {
2478                                 encoder->private_->first_seekpoint_to_check++;
2479                         }
2480                 }
2481         }
2482
2483 #if FLAC__HAS_OGG
2484         if(encoder->private_->is_ogg) {
2485                 status = FLAC__ogg_encoder_aspect_write_callback_wrapper(
2486                         &encoder->protected_->ogg_encoder_aspect,
2487                         buffer,
2488                         bytes,
2489                         samples,
2490                         encoder->private_->current_frame_number,
2491                         is_last_block,
2492                         (FLAC__OggEncoderAspectWriteCallbackProxy)encoder->private_->write_callback,
2493                         encoder,
2494                         encoder->private_->client_data
2495                 );
2496         }
2497         else
2498 #endif
2499         status = encoder->private_->write_callback(encoder, buffer, bytes, samples, encoder->private_->current_frame_number, encoder->private_->client_data);
2500
2501         if(status == FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2502                 encoder->private_->bytes_written += bytes;
2503                 encoder->private_->samples_written += samples;
2504                 /* we keep a high watermark on the number of frames written because
2505                  * when the encoder goes back to write metadata, 'current_frame'
2506                  * will drop back to 0.
2507                  */
2508                 encoder->private_->frames_written = max(encoder->private_->frames_written, encoder->private_->current_frame_number+1);
2509         }
2510         else
2511                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2512
2513         return status;
2514 }
2515
2516 /* Gets called when the encoding process has finished so that we can update the STREAMINFO and SEEKTABLE blocks.  */
2517 void update_metadata_(const FLAC__StreamEncoder *encoder)
2518 {
2519         FLAC__byte b[max(6, FLAC__STREAM_METADATA_SEEKPOINT_LENGTH)];
2520         const FLAC__StreamMetadata *metadata = &encoder->private_->streaminfo;
2521         const FLAC__uint64 samples = metadata->data.stream_info.total_samples;
2522         const unsigned min_framesize = metadata->data.stream_info.min_framesize;
2523         const unsigned max_framesize = metadata->data.stream_info.max_framesize;
2524         const unsigned bps = metadata->data.stream_info.bits_per_sample;
2525         FLAC__StreamEncoderSeekStatus seek_status;
2526
2527         FLAC__ASSERT(metadata->type == FLAC__METADATA_TYPE_STREAMINFO);
2528
2529         /* All this is based on intimate knowledge of the stream header
2530          * layout, but a change to the header format that would break this
2531          * would also break all streams encoded in the previous format.
2532          */
2533
2534         /*
2535          * Write MD5 signature
2536          */
2537         {
2538                 const unsigned md5_offset =
2539                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2540                         (
2541                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2542                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2543                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2544                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2545                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2546                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2547                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN +
2548                                 FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN
2549                         ) / 8;
2550
2551                 if((seek_status = encoder->private_->seek_callback(encoder, encoder->protected_->streaminfo_offset + md5_offset, encoder->private_->client_data)) != FLAC__STREAM_ENCODER_SEEK_STATUS_OK) {
2552                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2553                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2554                         return;
2555                 }
2556                 if(encoder->private_->write_callback(encoder, metadata->data.stream_info.md5sum, 16, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2557                         encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2558                         return;
2559                 }
2560         }
2561
2562         /*
2563          * Write total samples
2564          */
2565         {
2566                 const unsigned total_samples_byte_offset =
2567                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2568                         (
2569                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2570                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2571                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2572                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2573                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2574                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2575                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN
2576                                 - 4
2577                         ) / 8;
2578
2579                 b[0] = ((FLAC__byte)(bps-1) << 4) | (FLAC__byte)((samples >> 32) & 0x0F);
2580                 b[1] = (FLAC__byte)((samples >> 24) & 0xFF);
2581                 b[2] = (FLAC__byte)((samples >> 16) & 0xFF);
2582                 b[3] = (FLAC__byte)((samples >> 8) & 0xFF);
2583                 b[4] = (FLAC__byte)(samples & 0xFF);
2584                 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) {
2585                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2586                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2587                         return;
2588                 }
2589                 if(encoder->private_->write_callback(encoder, b, 5, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2590                         encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2591                         return;
2592                 }
2593         }
2594
2595         /*
2596          * Write min/max framesize
2597          */
2598         {
2599                 const unsigned min_framesize_offset =
2600                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2601                         (
2602                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2603                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN
2604                         ) / 8;
2605
2606                 b[0] = (FLAC__byte)((min_framesize >> 16) & 0xFF);
2607                 b[1] = (FLAC__byte)((min_framesize >> 8) & 0xFF);
2608                 b[2] = (FLAC__byte)(min_framesize & 0xFF);
2609                 b[3] = (FLAC__byte)((max_framesize >> 16) & 0xFF);
2610                 b[4] = (FLAC__byte)((max_framesize >> 8) & 0xFF);
2611                 b[5] = (FLAC__byte)(max_framesize & 0xFF);
2612                 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) {
2613                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2614                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2615                         return;
2616                 }
2617                 if(encoder->private_->write_callback(encoder, b, 6, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2618                         encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2619                         return;
2620                 }
2621         }
2622
2623         /*
2624          * Write seektable
2625          */
2626         if(0 != encoder->private_->seek_table && encoder->private_->seek_table->num_points > 0 && encoder->protected_->seektable_offset > 0) {
2627                 unsigned i;
2628
2629                 FLAC__format_seektable_sort(encoder->private_->seek_table);
2630
2631                 FLAC__ASSERT(FLAC__format_seektable_is_legal(encoder->private_->seek_table));
2632
2633                 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) {
2634                         if(seek_status == FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR)
2635                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2636                         return;
2637                 }
2638
2639                 for(i = 0; i < encoder->private_->seek_table->num_points; i++) {
2640                         FLAC__uint64 xx;
2641                         unsigned x;
2642                         xx = encoder->private_->seek_table->points[i].sample_number;
2643                         b[7] = (FLAC__byte)xx; xx >>= 8;
2644                         b[6] = (FLAC__byte)xx; xx >>= 8;
2645                         b[5] = (FLAC__byte)xx; xx >>= 8;
2646                         b[4] = (FLAC__byte)xx; xx >>= 8;
2647                         b[3] = (FLAC__byte)xx; xx >>= 8;
2648                         b[2] = (FLAC__byte)xx; xx >>= 8;
2649                         b[1] = (FLAC__byte)xx; xx >>= 8;
2650                         b[0] = (FLAC__byte)xx; xx >>= 8;
2651                         xx = encoder->private_->seek_table->points[i].stream_offset;
2652                         b[15] = (FLAC__byte)xx; xx >>= 8;
2653                         b[14] = (FLAC__byte)xx; xx >>= 8;
2654                         b[13] = (FLAC__byte)xx; xx >>= 8;
2655                         b[12] = (FLAC__byte)xx; xx >>= 8;
2656                         b[11] = (FLAC__byte)xx; xx >>= 8;
2657                         b[10] = (FLAC__byte)xx; xx >>= 8;
2658                         b[9] = (FLAC__byte)xx; xx >>= 8;
2659                         b[8] = (FLAC__byte)xx; xx >>= 8;
2660                         x = encoder->private_->seek_table->points[i].frame_samples;
2661                         b[17] = (FLAC__byte)x; x >>= 8;
2662                         b[16] = (FLAC__byte)x; x >>= 8;
2663                         if(encoder->private_->write_callback(encoder, b, 18, 0, 0, encoder->private_->client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK) {
2664                                 encoder->protected_->state = FLAC__STREAM_ENCODER_CLIENT_ERROR;
2665                                 return;
2666                         }
2667                 }
2668         }
2669 }
2670
2671 #if FLAC__HAS_OGG
2672 /* Gets called when the encoding process has finished so that we can update the STREAMINFO and SEEKTABLE blocks.  */
2673 void update_ogg_metadata_(FLAC__StreamEncoder *encoder)
2674 {
2675         /* the # of bytes in the 1st packet that precede the STREAMINFO */
2676         static const unsigned FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH =
2677                 FLAC__OGG_MAPPING_PACKET_TYPE_LENGTH +
2678                 FLAC__OGG_MAPPING_MAGIC_LENGTH +
2679                 FLAC__OGG_MAPPING_VERSION_MAJOR_LENGTH +
2680                 FLAC__OGG_MAPPING_VERSION_MINOR_LENGTH +
2681                 FLAC__OGG_MAPPING_NUM_HEADERS_LENGTH +
2682                 FLAC__STREAM_SYNC_LENGTH
2683         ;
2684         FLAC__byte b[max(6, FLAC__STREAM_METADATA_SEEKPOINT_LENGTH)];
2685         const FLAC__StreamMetadata *metadata = &encoder->private_->streaminfo;
2686         const FLAC__uint64 samples = metadata->data.stream_info.total_samples;
2687         const unsigned min_framesize = metadata->data.stream_info.min_framesize;
2688         const unsigned max_framesize = metadata->data.stream_info.max_framesize;
2689         ogg_page page;
2690
2691         FLAC__ASSERT(metadata->type == FLAC__METADATA_TYPE_STREAMINFO);
2692         FLAC__ASSERT(0 != encoder->private_->seek_callback);
2693
2694         /* Pre-check that client supports seeking, since we don't want the
2695          * ogg_helper code to ever have to deal with this condition.
2696          */
2697         if(encoder->private_->seek_callback(encoder, 0, encoder->private_->client_data) == FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED)
2698                 return;
2699
2700         /* All this is based on intimate knowledge of the stream header
2701          * layout, but a change to the header format that would break this
2702          * would also break all streams encoded in the previous format.
2703          */
2704
2705         /**
2706          ** Write STREAMINFO stats
2707          **/
2708         simple_ogg_page__init(&page);
2709         if(!simple_ogg_page__get_at(encoder, encoder->protected_->streaminfo_offset, &page, encoder->private_->seek_callback, encoder->private_->read_callback, encoder->private_->client_data)) {
2710                 simple_ogg_page__clear(&page);
2711                 return; /* state already set */
2712         }
2713
2714         /*
2715          * Write MD5 signature
2716          */
2717         {
2718                 const unsigned md5_offset =
2719                         FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH +
2720                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2721                         (
2722                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2723                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2724                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2725                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2726                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2727                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2728                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN +
2729                                 FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN
2730                         ) / 8;
2731
2732                 if(md5_offset + 16 > (unsigned)page.body_len) {
2733                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
2734                         simple_ogg_page__clear(&page);
2735                         return;
2736                 }
2737                 memcpy(page.body + md5_offset, metadata->data.stream_info.md5sum, 16);
2738         }
2739
2740         /*
2741          * Write total samples
2742          */
2743         {
2744                 const unsigned total_samples_byte_offset =
2745                         FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH +
2746                         FLAC__STREAM_METADATA_HEADER_LENGTH +
2747                         (
2748                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN +
2749                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN +
2750                                 FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN +
2751                                 FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN +
2752                                 FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN +
2753                                 FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN +
2754                                 FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN
2755                                 - 4
2756                         ) / 8;
2757
2758                 if(total_samples_byte_offset + 5 > (unsigned)page.body_len) {
2759                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
2760                         simple_ogg_page__clear(&page);
2761                         return;
2762                 }
2763                 b[0] = (FLAC__byte)page.body[total_samples_byte_offset] & 0xF0;
2764                 b[0] |= (FLAC__byte)((samples >> 32) & 0x0F);
2765                 b[1] = (FLAC__byte)((samples >> 24) & 0xFF);
2766                 b[2] = (FLAC__byte)((samples >> 16) & 0xFF);
2767                 b[3] = (FLAC__byte)((samples >> 8) & 0xFF);
2768                 b[4] = (FLAC__byte)(samples & 0xFF);
2769                 memcpy(page.body + total_samples_byte_offset, b, 5);
2770         }
2771
2772         /*
2773          * Write min/max framesize
2774          */
2775         {
2776                 const unsigned min_framesize_offset =
2777                         FIRST_OGG_PACKET_STREAMINFO_PREFIX_LENGTH +
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                         ) / 8;
2783
2784                 if(min_framesize_offset + 6 > (unsigned)page.body_len) {
2785                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
2786                         simple_ogg_page__clear(&page);
2787                         return;
2788                 }
2789                 b[0] = (FLAC__byte)((min_framesize >> 16) & 0xFF);
2790                 b[1] = (FLAC__byte)((min_framesize >> 8) & 0xFF);
2791                 b[2] = (FLAC__byte)(min_framesize & 0xFF);
2792                 b[3] = (FLAC__byte)((max_framesize >> 16) & 0xFF);
2793                 b[4] = (FLAC__byte)((max_framesize >> 8) & 0xFF);
2794                 b[5] = (FLAC__byte)(max_framesize & 0xFF);
2795                 memcpy(page.body + min_framesize_offset, b, 6);
2796         }
2797         if(!simple_ogg_page__set_at(encoder, encoder->protected_->streaminfo_offset, &page, encoder->private_->seek_callback, encoder->private_->write_callback, encoder->private_->client_data)) {
2798                 simple_ogg_page__clear(&page);
2799                 return; /* state already set */
2800         }
2801         simple_ogg_page__clear(&page);
2802
2803         /*
2804          * Write seektable
2805          */
2806         if(0 != encoder->private_->seek_table && encoder->private_->seek_table->num_points > 0 && encoder->protected_->seektable_offset > 0) {
2807                 unsigned i;
2808                 FLAC__byte *p;
2809
2810                 FLAC__format_seektable_sort(encoder->private_->seek_table);
2811
2812                 FLAC__ASSERT(FLAC__format_seektable_is_legal(encoder->private_->seek_table));
2813
2814                 simple_ogg_page__init(&page);
2815                 if(!simple_ogg_page__get_at(encoder, encoder->protected_->seektable_offset, &page, encoder->private_->seek_callback, encoder->private_->read_callback, encoder->private_->client_data)) {
2816                         simple_ogg_page__clear(&page);
2817                         return; /* state already set */
2818                 }
2819
2820                 if((FLAC__STREAM_METADATA_HEADER_LENGTH + 18*encoder->private_->seek_table->num_points) != (unsigned)page.body_len) {
2821                         encoder->protected_->state = FLAC__STREAM_ENCODER_OGG_ERROR;
2822                         simple_ogg_page__clear(&page);
2823                         return;
2824                 }
2825
2826                 for(i = 0, p = page.body + FLAC__STREAM_METADATA_HEADER_LENGTH; i < encoder->private_->seek_table->num_points; i++, p += 18) {
2827                         FLAC__uint64 xx;
2828                         unsigned x;
2829                         xx = encoder->private_->seek_table->points[i].sample_number;
2830                         b[7] = (FLAC__byte)xx; xx >>= 8;
2831                         b[6] = (FLAC__byte)xx; xx >>= 8;
2832                         b[5] = (FLAC__byte)xx; xx >>= 8;
2833                         b[4] = (FLAC__byte)xx; xx >>= 8;
2834                         b[3] = (FLAC__byte)xx; xx >>= 8;
2835                         b[2] = (FLAC__byte)xx; xx >>= 8;
2836                         b[1] = (FLAC__byte)xx; xx >>= 8;
2837                         b[0] = (FLAC__byte)xx; xx >>= 8;
2838                         xx = encoder->private_->seek_table->points[i].stream_offset;
2839                         b[15] = (FLAC__byte)xx; xx >>= 8;
2840                         b[14] = (FLAC__byte)xx; xx >>= 8;
2841                         b[13] = (FLAC__byte)xx; xx >>= 8;
2842                         b[12] = (FLAC__byte)xx; xx >>= 8;
2843                         b[11] = (FLAC__byte)xx; xx >>= 8;
2844                         b[10] = (FLAC__byte)xx; xx >>= 8;
2845                         b[9] = (FLAC__byte)xx; xx >>= 8;
2846                         b[8] = (FLAC__byte)xx; xx >>= 8;
2847                         x = encoder->private_->seek_table->points[i].frame_samples;
2848                         b[17] = (FLAC__byte)x; x >>= 8;
2849                         b[16] = (FLAC__byte)x; x >>= 8;
2850                         memcpy(p, b, 18);
2851                 }
2852
2853                 if(!simple_ogg_page__set_at(encoder, encoder->protected_->seektable_offset, &page, encoder->private_->seek_callback, encoder->private_->write_callback, encoder->private_->client_data)) {
2854                         simple_ogg_page__clear(&page);
2855                         return; /* state already set */
2856                 }
2857                 simple_ogg_page__clear(&page);
2858         }
2859 }
2860 #endif
2861
2862 FLAC__bool process_frame_(FLAC__StreamEncoder *encoder, FLAC__bool is_fractional_block, FLAC__bool is_last_block)
2863 {
2864         FLAC__uint16 crc;
2865         FLAC__ASSERT(encoder->protected_->state == FLAC__STREAM_ENCODER_OK);
2866
2867         /*
2868          * Accumulate raw signal to the MD5 signature
2869          */
2870         if(encoder->protected_->do_md5 && !FLAC__MD5Accumulate(&encoder->private_->md5context, (const FLAC__int32 * const *)encoder->private_->integer_signal, encoder->protected_->channels, encoder->protected_->blocksize, (encoder->protected_->bits_per_sample+7) / 8)) {
2871                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
2872                 return false;
2873         }
2874
2875         /*
2876          * Process the frame header and subframes into the frame bitbuffer
2877          */
2878         if(!process_subframes_(encoder, is_fractional_block)) {
2879                 /* the above function sets the state for us in case of an error */
2880                 return false;
2881         }
2882
2883         /*
2884          * Zero-pad the frame to a byte_boundary
2885          */
2886         if(!FLAC__bitwriter_zero_pad_to_byte_boundary(encoder->private_->frame)) {
2887                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
2888                 return false;
2889         }
2890
2891         /*
2892          * CRC-16 the whole thing
2893          */
2894         FLAC__ASSERT(FLAC__bitwriter_is_byte_aligned(encoder->private_->frame));
2895         if(
2896                 !FLAC__bitwriter_get_write_crc16(encoder->private_->frame, &crc) ||
2897                 !FLAC__bitwriter_write_raw_uint32(encoder->private_->frame, crc, FLAC__FRAME_FOOTER_CRC_LEN)
2898         ) {
2899                 encoder->protected_->state = FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR;
2900                 return false;
2901         }
2902
2903         /*
2904          * Write it
2905          */
2906         if(!write_bitbuffer_(encoder, encoder->protected_->blocksize, is_last_block)) {
2907                 /* the above function sets the state for us in case of an error */
2908                 return false;
2909         }
2910
2911         /*
2912          * Get ready for the next frame
2913          */
2914         encoder->private_->current_sample_number = 0;
2915         encoder->private_->current_frame_number++;
2916         encoder->private_->streaminfo.data.stream_info.total_samples += (FLAC__uint64)encoder->protected_->blocksize;
2917
2918         return true;
2919 }
2920
2921 FLAC__bool process_subframes_(FLAC__StreamEncoder *encoder, FLAC__bool is_fractional_block)
2922 {
2923         FLAC__FrameHeader frame_header;
2924         unsigned channel, min_partition_order = encoder->protected_->min_residual_partition_order, max_partition_order;
2925         FLAC__bool do_independent, do_mid_side;
2926
2927         /*
2928          * Calculate the min,max Rice partition orders
2929          */
2930         if(is_fractional_block) {
2931                 max_partition_order = 0;
2932         }
2933         else {
2934                 max_partition_order = FLAC__format_get_max_rice_partition_order_from_blocksize(encoder->protected_->blocksize);
2935                 max_partition_order = min(max_partition_order, encoder->protected_->max_residual_partition_order);
2936         }
2937         min_partition_order = min(min_partition_order, max_partition_order);
2938
2939         /*
2940          * Setup the frame
2941          */
2942         frame_header.blocksize = encoder->protected_->blocksize;
2943         frame_header.sample_rate = encoder->protected_->sample_rate;
2944         frame_header.channels = encoder->protected_->channels;
2945         frame_header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT; /* the default unless the encoder determines otherwise */
2946         frame_header.bits_per_sample = encoder->protected_->bits_per_sample;
2947         frame_header.number_type = FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER;
2948         frame_header.number.frame_number = encoder->private_->current_frame_number;
2949
2950         /*
2951          * Figure out what channel assignments to try
2952          */
2953         if(encoder->protected_->do_mid_side_stereo) {
2954                 if(encoder->protected_->loose_mid_side_stereo) {
2955                         if(encoder->private_->loose_mid_side_stereo_frame_count == 0) {
2956                                 do_independent = true;
2957                                 do_mid_side = true;
2958                         }
2959                         else {
2960                                 do_independent = (encoder->private_->last_channel_assignment == FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT);
2961                                 do_mid_side = !do_independent;
2962                         }
2963                 }
2964                 else {
2965                         do_independent = true;
2966                         do_mid_side = true;
2967                 }
2968         }
2969         else {
2970                 do_independent = true;
2971                 do_mid_side = false;
2972         }
2973
2974         FLAC__ASSERT(do_independent || do_mid_side);
2975
2976         /*
2977          * Check for wasted bits; set effective bps for each subframe
2978          */
2979         if(do_independent) {
2980                 for(channel = 0; channel < encoder->protected_->channels; channel++) {
2981                         const unsigned w = get_wasted_bits_(encoder->private_->integer_signal[channel], encoder->protected_->blocksize);
2982                         encoder->private_->subframe_workspace[channel][0].wasted_bits = encoder->private_->subframe_workspace[channel][1].wasted_bits = w;
2983                         encoder->private_->subframe_bps[channel] = encoder->protected_->bits_per_sample - w;
2984                 }
2985         }
2986         if(do_mid_side) {
2987                 FLAC__ASSERT(encoder->protected_->channels == 2);
2988                 for(channel = 0; channel < 2; channel++) {
2989                         const unsigned w = get_wasted_bits_(encoder->private_->integer_signal_mid_side[channel], encoder->protected_->blocksize);
2990                         encoder->private_->subframe_workspace_mid_side[channel][0].wasted_bits = encoder->private_->subframe_workspace_mid_side[channel][1].wasted_bits = w;
2991                         encoder->private_->subframe_bps_mid_side[channel] = encoder->protected_->bits_per_sample - w + (channel==0? 0:1);
2992                 }
2993         }
2994
2995         /*
2996          * First do a normal encoding pass of each independent channel
2997          */
2998         if(do_independent) {
2999                 for(channel = 0; channel < encoder->protected_->channels; channel++) {
3000                         if(!
3001                                 process_subframe_(
3002                                         encoder,
3003                                         min_partition_order,
3004                                         max_partition_order,
3005                                         &frame_header,
3006                                         encoder->private_->subframe_bps[channel],
3007                                         encoder->private_->integer_signal[channel],
3008                                         encoder->private_->subframe_workspace_ptr[channel],
3009                                         encoder->private_->partitioned_rice_contents_workspace_ptr[channel],
3010                                         encoder->private_->residual_workspace[channel],
3011                                         encoder->private_->best_subframe+channel,
3012                                         encoder->private_->best_subframe_bits+channel
3013                                 )
3014                         )
3015                                 return false;
3016                 }
3017         }
3018
3019         /*
3020          * Now do mid and side channels if requested
3021          */
3022         if(do_mid_side) {
3023                 FLAC__ASSERT(encoder->protected_->channels == 2);
3024
3025                 for(channel = 0; channel < 2; channel++) {
3026                         if(!
3027                                 process_subframe_(
3028                                         encoder,
3029                                         min_partition_order,
3030                                         max_partition_order,
3031                                         &frame_header,
3032                                         encoder->private_->subframe_bps_mid_side[channel],
3033                                         encoder->private_->integer_signal_mid_side[channel],
3034                                         encoder->private_->subframe_workspace_ptr_mid_side[channel],
3035                                         encoder->private_->partitioned_rice_contents_workspace_ptr_mid_side[channel],
3036                                         encoder->private_->residual_workspace_mid_side[channel],
3037                                         encoder->private_->best_subframe_mid_side+channel,
3038                                         encoder->private_->best_subframe_bits_mid_side+channel
3039                                 )
3040                         )
3041                                 return false;
3042                 }
3043         }
3044
3045         /*
3046          * Compose the frame bitbuffer
3047          */
3048         if(do_mid_side) {
3049                 unsigned left_bps = 0, right_bps = 0; /* initialized only to prevent superfluous compiler warning */
3050                 FLAC__Subframe *left_subframe = 0, *right_subframe = 0; /* initialized only to prevent superfluous compiler warning */
3051                 FLAC__ChannelAssignment channel_assignment;
3052
3053                 FLAC__ASSERT(encoder->protected_->channels == 2);
3054
3055                 if(encoder->protected_->loose_mid_side_stereo && encoder->private_->loose_mid_side_stereo_frame_count > 0) {
3056                         channel_assignment = (encoder->private_->last_channel_assignment == FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT? FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT : FLAC__CHANNEL_ASSIGNMENT_MID_SIDE);
3057                 }
3058                 else {
3059                         unsigned bits[4]; /* WATCHOUT - indexed by FLAC__ChannelAssignment */
3060                         unsigned min_bits;
3061                         int ca;
3062
3063                         FLAC__ASSERT(FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT == 0);
3064                         FLAC__ASSERT(FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE   == 1);
3065                         FLAC__ASSERT(FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE  == 2);
3066                         FLAC__ASSERT(FLAC__CHANNEL_ASSIGNMENT_MID_SIDE    == 3);
3067                         FLAC__ASSERT(do_independent && do_mid_side);
3068
3069                         /* We have to figure out which channel assignent results in the smallest frame */
3070                         bits[FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT] = encoder->private_->best_subframe_bits         [0] + encoder->private_->best_subframe_bits         [1];
3071                         bits[FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE  ] = encoder->private_->best_subframe_bits         [0] + encoder->private_->best_subframe_bits_mid_side[1];
3072                         bits[FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE ] = encoder->private_->best_subframe_bits         [1] + encoder->private_->best_subframe_bits_mid_side[1];
3073                         bits[FLAC__CHANNEL_ASSIGNMENT_MID_SIDE   ] = encoder->private_->best_subframe_bits_mid_side[0] + encoder->private_->best_subframe_bits_mid_side[1];
3074
3075                         channel_assignment = FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT;
3076                         min_bits = bits[channel_assignment];
3077                         for(ca = 1; ca <= 3; ca++) {
3078                                 if(bits[ca] < min_bits) {
3079                                         min_bits = bits[ca];
3080                                         channel_assignment = (FLAC__ChannelAssignment)ca;
3081                                 }
3082                         }
3083                 }
3084
3085                 frame_header.channel_assignment = channel_assignment;
3086
3087                 if(!FLAC__frame_add_header(&frame_header, encoder->private_->frame)) {
3088                         encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
3089                         return false;
3090                 }
3091
3092                 switch(channel_assignment) {
3093                         case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
3094                                 left_subframe  = &encoder->private_->subframe_workspace         [0][encoder->private_->best_subframe         [0]];
3095                                 right_subframe = &encoder->private_->subframe_workspace         [1][encoder->private_->best_subframe         [1]];
3096                                 break;
3097                         case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
3098                                 left_subframe  = &encoder->private_->subframe_workspace         [0][encoder->private_->best_subframe         [0]];
3099                                 right_subframe = &encoder->private_->subframe_workspace_mid_side[1][encoder->private_->best_subframe_mid_side[1]];
3100                                 break;
3101                         case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
3102                                 left_subframe  = &encoder->private_->subframe_workspace_mid_side[1][encoder->private_->best_subframe_mid_side[1]];
3103                                 right_subframe = &encoder->private_->subframe_workspace         [1][encoder->private_->best_subframe         [1]];
3104                                 break;
3105                         case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
3106                                 left_subframe  = &encoder->private_->subframe_workspace_mid_side[0][encoder->private_->best_subframe_mid_side[0]];
3107                                 right_subframe = &encoder->private_->subframe_workspace_mid_side[1][encoder->private_->best_subframe_mid_side[1]];
3108                                 break;
3109                         default:
3110                                 FLAC__ASSERT(0);
3111                 }
3112
3113                 switch(channel_assignment) {
3114                         case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
3115                                 left_bps  = encoder->private_->subframe_bps         [0];
3116                                 right_bps = encoder->private_->subframe_bps         [1];
3117                                 break;
3118                         case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
3119                                 left_bps  = encoder->private_->subframe_bps         [0];
3120                                 right_bps = encoder->private_->subframe_bps_mid_side[1];
3121                                 break;
3122                         case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
3123                                 left_bps  = encoder->private_->subframe_bps_mid_side[1];
3124                                 right_bps = encoder->private_->subframe_bps         [1];
3125                                 break;
3126                         case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
3127                                 left_bps  = encoder->private_->subframe_bps_mid_side[0];
3128                                 right_bps = encoder->private_->subframe_bps_mid_side[1];
3129                                 break;
3130                         default:
3131                                 FLAC__ASSERT(0);
3132                 }
3133
3134                 /* note that encoder_add_subframe_ sets the state for us in case of an error */
3135                 if(!add_subframe_(encoder, frame_header.blocksize, left_bps , left_subframe , encoder->private_->frame))
3136                         return false;
3137                 if(!add_subframe_(encoder, frame_header.blocksize, right_bps, right_subframe, encoder->private_->frame))
3138                         return false;
3139         }
3140         else {
3141                 if(!FLAC__frame_add_header(&frame_header, encoder->private_->frame)) {
3142                         encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
3143                         return false;
3144                 }
3145
3146                 for(channel = 0; channel < encoder->protected_->channels; channel++) {
3147                         if(!add_subframe_(encoder, frame_header.blocksize, encoder->private_->subframe_bps[channel], &encoder->private_->subframe_workspace[channel][encoder->private_->best_subframe[channel]], encoder->private_->frame)) {
3148                                 /* the above function sets the state for us in case of an error */
3149                                 return false;
3150                         }
3151                 }
3152         }
3153
3154         if(encoder->protected_->loose_mid_side_stereo) {
3155                 encoder->private_->loose_mid_side_stereo_frame_count++;
3156                 if(encoder->private_->loose_mid_side_stereo_frame_count >= encoder->private_->loose_mid_side_stereo_frames)
3157                         encoder->private_->loose_mid_side_stereo_frame_count = 0;
3158         }
3159
3160         encoder->private_->last_channel_assignment = frame_header.channel_assignment;
3161
3162         return true;
3163 }
3164
3165 FLAC__bool process_subframe_(
3166         FLAC__StreamEncoder *encoder,
3167         unsigned min_partition_order,
3168         unsigned max_partition_order,
3169         const FLAC__FrameHeader *frame_header,
3170         unsigned subframe_bps,
3171         const FLAC__int32 integer_signal[],
3172         FLAC__Subframe *subframe[2],
3173         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents[2],
3174         FLAC__int32 *residual[2],
3175         unsigned *best_subframe,
3176         unsigned *best_bits
3177 )
3178 {
3179 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3180         FLAC__float fixed_residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1];
3181 #else
3182         FLAC__fixedpoint fixed_residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1];
3183 #endif
3184 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3185         FLAC__double lpc_residual_bits_per_sample;
3186         FLAC__real autoc[FLAC__MAX_LPC_ORDER+1]; /* WATCHOUT: the size is important even though encoder->protected_->max_lpc_order might be less; some asm routines need all the space */
3187         FLAC__double lpc_error[FLAC__MAX_LPC_ORDER];
3188         unsigned min_lpc_order, max_lpc_order, lpc_order;
3189         unsigned min_qlp_coeff_precision, max_qlp_coeff_precision, qlp_coeff_precision;
3190 #endif
3191         unsigned min_fixed_order, max_fixed_order, guess_fixed_order, fixed_order;
3192         unsigned rice_parameter;
3193         unsigned _candidate_bits, _best_bits;
3194         unsigned _best_subframe;
3195
3196         FLAC__ASSERT(frame_header->blocksize > 0);
3197
3198         /* verbatim subframe is the baseline against which we measure other compressed subframes */
3199         _best_subframe = 0;
3200         if(encoder->private_->disable_verbatim_subframes && frame_header->blocksize >= FLAC__MAX_FIXED_ORDER)
3201                 _best_bits = UINT_MAX;
3202         else
3203                 _best_bits = evaluate_verbatim_subframe_(encoder, integer_signal, frame_header->blocksize, subframe_bps, subframe[_best_subframe]);
3204
3205         if(frame_header->blocksize >= FLAC__MAX_FIXED_ORDER) {
3206                 unsigned signal_is_constant = false;
3207                 guess_fixed_order = encoder->private_->local_fixed_compute_best_predictor(integer_signal+FLAC__MAX_FIXED_ORDER, frame_header->blocksize-FLAC__MAX_FIXED_ORDER, fixed_residual_bits_per_sample);
3208                 /* check for constant subframe */
3209                 if(
3210                         !encoder->private_->disable_constant_subframes &&
3211 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3212                         fixed_residual_bits_per_sample[1] == 0.0
3213 #else
3214                         fixed_residual_bits_per_sample[1] == FLAC__FP_ZERO
3215 #endif
3216                 ) {
3217                         /* the above means it's possible all samples are the same value; now double-check it: */
3218                         unsigned i;
3219                         signal_is_constant = true;
3220                         for(i = 1; i < frame_header->blocksize; i++) {
3221                                 if(integer_signal[0] != integer_signal[i]) {
3222                                         signal_is_constant = false;
3223                                         break;
3224                                 }
3225                         }
3226                 }
3227                 if(signal_is_constant) {
3228                         _candidate_bits = evaluate_constant_subframe_(encoder, integer_signal[0], frame_header->blocksize, subframe_bps, subframe[!_best_subframe]);
3229                         if(_candidate_bits < _best_bits) {
3230                                 _best_subframe = !_best_subframe;
3231                                 _best_bits = _candidate_bits;
3232                         }
3233                 }
3234                 else {
3235                         if(!encoder->private_->disable_fixed_subframes || (encoder->protected_->max_lpc_order == 0 && _best_bits == UINT_MAX)) {
3236                                 /* encode fixed */
3237                                 if(encoder->protected_->do_exhaustive_model_search) {
3238                                         min_fixed_order = 0;
3239                                         max_fixed_order = FLAC__MAX_FIXED_ORDER;
3240                                 }
3241                                 else {
3242                                         min_fixed_order = max_fixed_order = guess_fixed_order;
3243                                 }
3244                                 if(max_fixed_order >= frame_header->blocksize)
3245                                         max_fixed_order = frame_header->blocksize - 1;
3246                                 for(fixed_order = min_fixed_order; fixed_order <= max_fixed_order; fixed_order++) {
3247 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3248                                         if(fixed_residual_bits_per_sample[fixed_order] >= (FLAC__float)subframe_bps)
3249                                                 continue; /* don't even try */
3250                                         rice_parameter = (fixed_residual_bits_per_sample[fixed_order] > 0.0)? (unsigned)(fixed_residual_bits_per_sample[fixed_order]+0.5) : 0; /* 0.5 is for rounding */
3251 #else
3252                                         if(FLAC__fixedpoint_trunc(fixed_residual_bits_per_sample[fixed_order]) >= (int)subframe_bps)
3253                                                 continue; /* don't even try */
3254                                         rice_parameter = (fixed_residual_bits_per_sample[fixed_order] > FLAC__FP_ZERO)? (unsigned)FLAC__fixedpoint_trunc(fixed_residual_bits_per_sample[fixed_order]+FLAC__FP_ONE_HALF) : 0; /* 0.5 is for rounding */
3255 #endif
3256                                         rice_parameter++; /* to account for the signed->unsigned conversion during rice coding */
3257                                         if(rice_parameter >= FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
3258 #ifdef DEBUG_VERBOSE
3259                                                 fprintf(stderr, "clipping rice_parameter (%u -> %u) @0\n", rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1);
3260 #endif
3261                                                 rice_parameter = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1;
3262                                         }
3263                                         _candidate_bits =
3264                                                 evaluate_fixed_subframe_(
3265                                                         encoder,
3266                                                         integer_signal,
3267                                                         residual[!_best_subframe],
3268                                                         encoder->private_->abs_residual_partition_sums,
3269                                                         encoder->private_->raw_bits_per_partition,
3270                                                         frame_header->blocksize,
3271                                                         subframe_bps,
3272                                                         fixed_order,
3273                                                         rice_parameter,
3274                                                         min_partition_order,
3275                                                         max_partition_order,
3276                                                         encoder->protected_->do_escape_coding,
3277                                                         encoder->protected_->rice_parameter_search_dist,
3278                                                         subframe[!_best_subframe],
3279                                                         partitioned_rice_contents[!_best_subframe]
3280                                                 );
3281                                         if(_candidate_bits < _best_bits) {
3282                                                 _best_subframe = !_best_subframe;
3283                                                 _best_bits = _candidate_bits;
3284                                         }
3285                                 }
3286                         }
3287
3288 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3289                         /* encode lpc */
3290                         if(encoder->protected_->max_lpc_order > 0) {
3291                                 if(encoder->protected_->max_lpc_order >= frame_header->blocksize)
3292                                         max_lpc_order = frame_header->blocksize-1;
3293                                 else
3294                                         max_lpc_order = encoder->protected_->max_lpc_order;
3295                                 if(max_lpc_order > 0) {
3296                                         unsigned a;
3297                                         for (a = 0; a < encoder->protected_->num_apodizations; a++) {
3298                                                 FLAC__lpc_window_data(integer_signal, encoder->private_->window[a], encoder->private_->windowed_signal, frame_header->blocksize);
3299                                                 encoder->private_->local_lpc_compute_autocorrelation(encoder->private_->windowed_signal, frame_header->blocksize, max_lpc_order+1, autoc);
3300                                                 /* if autoc[0] == 0.0, the signal is constant and we usually won't get here, but it can happen */
3301                                                 if(autoc[0] != 0.0) {
3302                                                         FLAC__lpc_compute_lp_coefficients(autoc, &max_lpc_order, encoder->private_->lp_coeff, lpc_error);
3303                                                         if(encoder->protected_->do_exhaustive_model_search) {
3304                                                                 min_lpc_order = 1;
3305                                                         }
3306                                                         else {
3307                                                                 const unsigned guess_lpc_order =
3308                                                                         FLAC__lpc_compute_best_order(
3309                                                                                 lpc_error,
3310                                                                                 max_lpc_order,
3311                                                                                 frame_header->blocksize,
3312                                                                                 subframe_bps + (
3313                                                                                         encoder->protected_->do_qlp_coeff_prec_search?
3314                                                                                                 FLAC__MIN_QLP_COEFF_PRECISION : /* have to guess; use the min possible size to avoid accidentally favoring lower orders */
3315                                                                                                 encoder->protected_->qlp_coeff_precision
3316                                                                                 )
3317                                                                         );
3318                                                                 min_lpc_order = max_lpc_order = guess_lpc_order;
3319                                                         }
3320                                                         if(max_lpc_order >= frame_header->blocksize)
3321                                                                 max_lpc_order = frame_header->blocksize - 1;
3322                                                         for(lpc_order = min_lpc_order; lpc_order <= max_lpc_order; lpc_order++) {
3323                                                                 lpc_residual_bits_per_sample = FLAC__lpc_compute_expected_bits_per_residual_sample(lpc_error[lpc_order-1], frame_header->blocksize-lpc_order);
3324                                                                 if(lpc_residual_bits_per_sample >= (FLAC__double)subframe_bps)
3325                                                                         continue; /* don't even try */
3326                                                                 rice_parameter = (lpc_residual_bits_per_sample > 0.0)? (unsigned)(lpc_residual_bits_per_sample+0.5) : 0; /* 0.5 is for rounding */
3327                                                                 rice_parameter++; /* to account for the signed->unsigned conversion during rice coding */
3328                                                                 if(rice_parameter >= FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
3329 #ifdef DEBUG_VERBOSE
3330                                                                         fprintf(stderr, "clipping rice_parameter (%u -> %u) @1\n", rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1);
3331 #endif
3332                                                                         rice_parameter = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1;
3333                                                                 }
3334                                                                 if(encoder->protected_->do_qlp_coeff_prec_search) {
3335                                                                         min_qlp_coeff_precision = FLAC__MIN_QLP_COEFF_PRECISION;
3336                                                                         /* try to ensure a 32-bit datapath throughout for 16bps(+1bps for side channel) or less */
3337                                                                         if(subframe_bps <= 17) {
3338                                                                                 max_qlp_coeff_precision = min(32 - subframe_bps - lpc_order, FLAC__MAX_QLP_COEFF_PRECISION);
3339                                                                                 max_qlp_coeff_precision = max(max_qlp_coeff_precision, min_qlp_coeff_precision);
3340                                                                         }
3341                                                                         else
3342                                                                                 max_qlp_coeff_precision = FLAC__MAX_QLP_COEFF_PRECISION;
3343                                                                 }
3344                                                                 else {
3345                                                                         min_qlp_coeff_precision = max_qlp_coeff_precision = encoder->protected_->qlp_coeff_precision;
3346                                                                 }
3347                                                                 for(qlp_coeff_precision = min_qlp_coeff_precision; qlp_coeff_precision <= max_qlp_coeff_precision; qlp_coeff_precision++) {
3348                                                                         _candidate_bits =
3349                                                                                 evaluate_lpc_subframe_(
3350                                                                                         encoder,
3351                                                                                         integer_signal,
3352                                                                                         residual[!_best_subframe],
3353                                                                                         encoder->private_->abs_residual_partition_sums,
3354                                                                                         encoder->private_->raw_bits_per_partition,
3355                                                                                         encoder->private_->lp_coeff[lpc_order-1],
3356                                                                                         frame_header->blocksize,
3357                                                                                         subframe_bps,
3358                                                                                         lpc_order,
3359                                                                                         qlp_coeff_precision,
3360                                                                                         rice_parameter,
3361                                                                                         min_partition_order,
3362                                                                                         max_partition_order,
3363                                                                                         encoder->protected_->do_escape_coding,
3364                                                                                         encoder->protected_->rice_parameter_search_dist,
3365                                                                                         subframe[!_best_subframe],
3366                                                                                         partitioned_rice_contents[!_best_subframe]
3367                                                                                 );
3368                                                                         if(_candidate_bits > 0) { /* if == 0, there was a problem quantizing the lpcoeffs */
3369                                                                                 if(_candidate_bits < _best_bits) {
3370                                                                                         _best_subframe = !_best_subframe;
3371                                                                                         _best_bits = _candidate_bits;
3372                                                                                 }
3373                                                                         }
3374                                                                 }
3375                                                         }
3376                                                 }
3377                                         }
3378                                 }
3379                         }
3380 #endif /* !defined FLAC__INTEGER_ONLY_LIBRARY */
3381                 }
3382         }
3383
3384         /* under rare circumstances this can happen when all but lpc subframe types are disabled: */
3385         if(_best_bits == UINT_MAX) {
3386                 FLAC__ASSERT(_best_subframe == 0);
3387                 _best_bits = evaluate_verbatim_subframe_(encoder, integer_signal, frame_header->blocksize, subframe_bps, subframe[_best_subframe]);
3388         }
3389
3390         *best_subframe = _best_subframe;
3391         *best_bits = _best_bits;
3392
3393         return true;
3394 }
3395
3396 FLAC__bool add_subframe_(
3397         FLAC__StreamEncoder *encoder,
3398         unsigned blocksize,
3399         unsigned subframe_bps,
3400         const FLAC__Subframe *subframe,
3401         FLAC__BitWriter *frame
3402 )
3403 {
3404         switch(subframe->type) {
3405                 case FLAC__SUBFRAME_TYPE_CONSTANT:
3406                         if(!FLAC__subframe_add_constant(&(subframe->data.constant), subframe_bps, subframe->wasted_bits, frame)) {
3407                                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
3408                                 return false;
3409                         }
3410                         break;
3411                 case FLAC__SUBFRAME_TYPE_FIXED:
3412                         if(!FLAC__subframe_add_fixed(&(subframe->data.fixed), blocksize - subframe->data.fixed.order, subframe_bps, subframe->wasted_bits, frame)) {
3413                                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
3414                                 return false;
3415                         }
3416                         break;
3417                 case FLAC__SUBFRAME_TYPE_LPC:
3418                         if(!FLAC__subframe_add_lpc(&(subframe->data.lpc), blocksize - subframe->data.lpc.order, subframe_bps, subframe->wasted_bits, frame)) {
3419                                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
3420                                 return false;
3421                         }
3422                         break;
3423                 case FLAC__SUBFRAME_TYPE_VERBATIM:
3424                         if(!FLAC__subframe_add_verbatim(&(subframe->data.verbatim), blocksize, subframe_bps, subframe->wasted_bits, frame)) {
3425                                 encoder->protected_->state = FLAC__STREAM_ENCODER_FRAMING_ERROR;
3426                                 return false;
3427                         }
3428                         break;
3429                 default:
3430                         FLAC__ASSERT(0);
3431         }
3432
3433         return true;
3434 }
3435
3436 #define SPOTCHECK_ESTIMATE 0
3437 #if SPOTCHECK_ESTIMATE
3438 static void spotcheck_subframe_estimate_(
3439         FLAC__StreamEncoder *encoder,
3440         unsigned blocksize,
3441         unsigned subframe_bps,
3442         const FLAC__Subframe *subframe,
3443         unsigned estimate
3444 )
3445 {
3446         FLAC__bool ret;
3447         FLAC__BitWriter *frame = FLAC__bitwriter_new();
3448         if(frame == 0) {
3449                 fprintf(stderr, "EST: can't allocate frame\n");
3450                 return;
3451         }
3452         if(!FLAC__bitwriter_init(frame)) {
3453                 fprintf(stderr, "EST: can't init frame\n");
3454                 return;
3455         }
3456         ret = add_subframe_(encoder, blocksize, subframe_bps, subframe, frame);
3457         FLAC__ASSERT(ret);
3458         {
3459                 const unsigned actual = FLAC__bitwriter_get_input_bits_unconsumed(frame);
3460                 if(estimate != actual)
3461                         fprintf(stderr, "EST: bad, frame#%u sub#%%d type=%8s est=%u, actual=%u, delta=%d\n", encoder->private_->current_frame_number, FLAC__SubframeTypeString[subframe->type], estimate, actual, (int)actual-(int)estimate);
3462         }
3463         FLAC__bitwriter_delete(frame);
3464 }
3465 #endif
3466
3467 unsigned evaluate_constant_subframe_(
3468         FLAC__StreamEncoder *encoder,
3469         const FLAC__int32 signal,
3470         unsigned blocksize,
3471         unsigned subframe_bps,
3472         FLAC__Subframe *subframe
3473 )
3474 {
3475         unsigned estimate;
3476         subframe->type = FLAC__SUBFRAME_TYPE_CONSTANT;
3477         subframe->data.constant.value = signal;
3478
3479         estimate = FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN + subframe->wasted_bits + subframe_bps;
3480
3481 #if SPOTCHECK_ESTIMATE
3482         spotcheck_subframe_estimate_(encoder, blocksize, subframe_bps, subframe, estimate);
3483 #else
3484         (void)encoder, (void)blocksize;
3485 #endif
3486
3487         return estimate;
3488 }
3489
3490 unsigned evaluate_fixed_subframe_(
3491         FLAC__StreamEncoder *encoder,
3492         const FLAC__int32 signal[],
3493         FLAC__int32 residual[],
3494         FLAC__uint64 abs_residual_partition_sums[],
3495         unsigned raw_bits_per_partition[],
3496         unsigned blocksize,
3497         unsigned subframe_bps,
3498         unsigned order,
3499         unsigned rice_parameter,
3500         unsigned min_partition_order,
3501         unsigned max_partition_order,
3502         FLAC__bool do_escape_coding,
3503         unsigned rice_parameter_search_dist,
3504         FLAC__Subframe *subframe,
3505         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents
3506 )
3507 {
3508         unsigned i, residual_bits, estimate;
3509         const unsigned residual_samples = blocksize - order;
3510
3511         FLAC__fixed_compute_residual(signal+order, residual_samples, order, residual);
3512
3513         subframe->type = FLAC__SUBFRAME_TYPE_FIXED;
3514
3515         subframe->data.fixed.entropy_coding_method.type = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE;
3516         subframe->data.fixed.entropy_coding_method.data.partitioned_rice.contents = partitioned_rice_contents;
3517         subframe->data.fixed.residual = residual;
3518
3519         residual_bits =
3520                 find_best_partition_order_(
3521                         encoder->private_,
3522                         residual,
3523                         abs_residual_partition_sums,
3524                         raw_bits_per_partition,
3525                         residual_samples,
3526                         order,
3527                         rice_parameter,
3528                         min_partition_order,
3529                         max_partition_order,
3530                         subframe_bps,
3531                         do_escape_coding,
3532                         rice_parameter_search_dist,
3533                         &subframe->data.fixed.entropy_coding_method.data.partitioned_rice
3534                 );
3535
3536         subframe->data.fixed.order = order;
3537         for(i = 0; i < order; i++)
3538                 subframe->data.fixed.warmup[i] = signal[i];
3539
3540         estimate = FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN + subframe->wasted_bits + (order * subframe_bps) + residual_bits;
3541
3542 #if SPOTCHECK_ESTIMATE
3543         spotcheck_subframe_estimate_(encoder, blocksize, subframe_bps, subframe, estimate);
3544 #endif
3545
3546         return estimate;
3547 }
3548
3549 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3550 unsigned evaluate_lpc_subframe_(
3551         FLAC__StreamEncoder *encoder,
3552         const FLAC__int32 signal[],
3553         FLAC__int32 residual[],
3554         FLAC__uint64 abs_residual_partition_sums[],
3555         unsigned raw_bits_per_partition[],
3556         const FLAC__real lp_coeff[],
3557         unsigned blocksize,
3558         unsigned subframe_bps,
3559         unsigned order,
3560         unsigned qlp_coeff_precision,
3561         unsigned rice_parameter,
3562         unsigned min_partition_order,
3563         unsigned max_partition_order,
3564         FLAC__bool do_escape_coding,
3565         unsigned rice_parameter_search_dist,
3566         FLAC__Subframe *subframe,
3567         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents
3568 )
3569 {
3570         FLAC__int32 qlp_coeff[FLAC__MAX_LPC_ORDER];
3571         unsigned i, residual_bits, estimate;
3572         int quantization, ret;
3573         const unsigned residual_samples = blocksize - order;
3574
3575         /* try to keep qlp coeff precision such that only 32-bit math is required for decode of <=16bps streams */
3576         if(subframe_bps <= 16) {
3577                 FLAC__ASSERT(order > 0);
3578                 FLAC__ASSERT(order <= FLAC__MAX_LPC_ORDER);
3579                 qlp_coeff_precision = min(qlp_coeff_precision, 32 - subframe_bps - FLAC__bitmath_ilog2(order));
3580         }
3581
3582         ret = FLAC__lpc_quantize_coefficients(lp_coeff, order, qlp_coeff_precision, qlp_coeff, &quantization);
3583         if(ret != 0)
3584                 return 0; /* this is a hack to indicate to the caller that we can't do lp at this order on this subframe */
3585
3586         if(subframe_bps + qlp_coeff_precision + FLAC__bitmath_ilog2(order) <= 32)
3587                 if(subframe_bps <= 16 && qlp_coeff_precision <= 16)
3588                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_16bit(signal+order, residual_samples, qlp_coeff, order, quantization, residual);
3589                 else
3590                         encoder->private_->local_lpc_compute_residual_from_qlp_coefficients(signal+order, residual_samples, qlp_coeff, order, quantization, residual);
3591         else
3592                 encoder->private_->local_lpc_compute_residual_from_qlp_coefficients_64bit(signal+order, residual_samples, qlp_coeff, order, quantization, residual);
3593
3594         subframe->type = FLAC__SUBFRAME_TYPE_LPC;
3595
3596         subframe->data.lpc.entropy_coding_method.type = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE;
3597         subframe->data.lpc.entropy_coding_method.data.partitioned_rice.contents = partitioned_rice_contents;
3598         subframe->data.lpc.residual = residual;
3599
3600         residual_bits =
3601                 find_best_partition_order_(
3602                         encoder->private_,
3603                         residual,
3604                         abs_residual_partition_sums,
3605                         raw_bits_per_partition,
3606                         residual_samples,
3607                         order,
3608                         rice_parameter,
3609                         min_partition_order,
3610                         max_partition_order,
3611                         subframe_bps,
3612                         do_escape_coding,
3613                         rice_parameter_search_dist,
3614                         &subframe->data.lpc.entropy_coding_method.data.partitioned_rice
3615                 );
3616
3617         subframe->data.lpc.order = order;
3618         subframe->data.lpc.qlp_coeff_precision = qlp_coeff_precision;
3619         subframe->data.lpc.quantization_level = quantization;
3620         memcpy(subframe->data.lpc.qlp_coeff, qlp_coeff, sizeof(FLAC__int32)*FLAC__MAX_LPC_ORDER);
3621         for(i = 0; i < order; i++)
3622                 subframe->data.lpc.warmup[i] = signal[i];
3623
3624         estimate = FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN + subframe->wasted_bits + FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN + FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN + (order * (qlp_coeff_precision + subframe_bps)) + residual_bits;
3625
3626 #if SPOTCHECK_ESTIMATE
3627         spotcheck_subframe_estimate_(encoder, blocksize, subframe_bps, subframe, estimate);
3628 #endif
3629
3630         return estimate;
3631 }
3632 #endif
3633
3634 unsigned evaluate_verbatim_subframe_(
3635         FLAC__StreamEncoder *encoder,
3636         const FLAC__int32 signal[],
3637         unsigned blocksize,
3638         unsigned subframe_bps,
3639         FLAC__Subframe *subframe
3640 )
3641 {
3642         unsigned estimate;
3643
3644         subframe->type = FLAC__SUBFRAME_TYPE_VERBATIM;
3645
3646         subframe->data.verbatim.data = signal;
3647
3648         estimate = FLAC__SUBFRAME_ZERO_PAD_LEN + FLAC__SUBFRAME_TYPE_LEN + FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN + subframe->wasted_bits + (blocksize * subframe_bps);
3649
3650 #if SPOTCHECK_ESTIMATE
3651         spotcheck_subframe_estimate_(encoder, blocksize, subframe_bps, subframe, estimate);
3652 #else
3653         (void)encoder;
3654 #endif
3655
3656         return estimate;
3657 }
3658
3659 unsigned find_best_partition_order_(
3660         FLAC__StreamEncoderPrivate *private_,
3661         const FLAC__int32 residual[],
3662         FLAC__uint64 abs_residual_partition_sums[],
3663         unsigned raw_bits_per_partition[],
3664         unsigned residual_samples,
3665         unsigned predictor_order,
3666         unsigned rice_parameter,
3667         unsigned min_partition_order,
3668         unsigned max_partition_order,
3669         unsigned bps,
3670         FLAC__bool do_escape_coding,
3671         unsigned rice_parameter_search_dist,
3672         FLAC__EntropyCodingMethod_PartitionedRice *best_partitioned_rice
3673 )
3674 {
3675         unsigned residual_bits, best_residual_bits = 0;
3676         unsigned best_parameters_index = 0;
3677         const unsigned blocksize = residual_samples + predictor_order;
3678
3679         max_partition_order = FLAC__format_get_max_rice_partition_order_from_blocksize_limited_max_and_predictor_order(max_partition_order, blocksize, predictor_order);
3680         min_partition_order = min(min_partition_order, max_partition_order);
3681
3682         precompute_partition_info_sums_(residual, abs_residual_partition_sums, residual_samples, predictor_order, min_partition_order, max_partition_order, bps);
3683
3684         if(do_escape_coding)
3685                 precompute_partition_info_escapes_(residual, raw_bits_per_partition, residual_samples, predictor_order, min_partition_order, max_partition_order);
3686
3687         {
3688                 int partition_order;
3689                 unsigned sum;
3690
3691                 for(partition_order = (int)max_partition_order, sum = 0; partition_order >= (int)min_partition_order; partition_order--) {
3692                         if(!
3693                                 set_partitioned_rice_(
3694 #ifdef EXACT_RICE_BITS_CALCULATION
3695                                         residual,
3696 #endif
3697                                         abs_residual_partition_sums+sum,
3698                                         raw_bits_per_partition+sum,
3699                                         residual_samples,
3700                                         predictor_order,
3701                                         rice_parameter,
3702                                         rice_parameter_search_dist,
3703                                         (unsigned)partition_order,
3704                                         do_escape_coding,
3705                                         &private_->partitioned_rice_contents_extra[!best_parameters_index],
3706                                         &residual_bits
3707                                 )
3708                         )
3709                         {
3710                                 FLAC__ASSERT(best_residual_bits != 0);
3711                                 break;
3712                         }
3713                         sum += 1u << partition_order;
3714                         if(best_residual_bits == 0 || residual_bits < best_residual_bits) {
3715                                 best_residual_bits = residual_bits;
3716                                 best_parameters_index = !best_parameters_index;
3717                                 best_partitioned_rice->order = partition_order;
3718                         }
3719                 }
3720         }
3721
3722         /*
3723          * We are allowed to de-const the pointer based on our special knowledge;
3724          * it is const to the outside world.
3725          */
3726         {
3727                 FLAC__EntropyCodingMethod_PartitionedRiceContents* best_partitioned_rice_contents = (FLAC__EntropyCodingMethod_PartitionedRiceContents*)best_partitioned_rice->contents;
3728                 FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(best_partitioned_rice_contents, max(6, best_partitioned_rice->order));
3729                 memcpy(best_partitioned_rice_contents->parameters, private_->partitioned_rice_contents_extra[best_parameters_index].parameters, sizeof(unsigned)*(1<<(best_partitioned_rice->order)));
3730                 memcpy(best_partitioned_rice_contents->raw_bits, private_->partitioned_rice_contents_extra[best_parameters_index].raw_bits, sizeof(unsigned)*(1<<(best_partitioned_rice->order)));
3731         }
3732
3733         return best_residual_bits;
3734 }
3735
3736 #if defined(FLAC__CPU_IA32) && !defined FLAC__NO_ASM && defined FLAC__HAS_NASM
3737 extern void precompute_partition_info_sums_32bit_asm_ia32_(
3738         const FLAC__int32 residual[],
3739         FLAC__uint64 abs_residual_partition_sums[],
3740         unsigned blocksize,
3741         unsigned predictor_order,
3742         unsigned min_partition_order,
3743         unsigned max_partition_order
3744 );
3745 #endif
3746
3747 void precompute_partition_info_sums_(
3748         const FLAC__int32 residual[],
3749         FLAC__uint64 abs_residual_partition_sums[],
3750         unsigned residual_samples,
3751         unsigned predictor_order,
3752         unsigned min_partition_order,
3753         unsigned max_partition_order,
3754         unsigned bps
3755 )
3756 {
3757         const unsigned default_partition_samples = (residual_samples + predictor_order) >> max_partition_order;
3758         unsigned partitions = 1u << max_partition_order;
3759
3760         FLAC__ASSERT(default_partition_samples > predictor_order);
3761
3762 #if defined(FLAC__CPU_IA32) && !defined FLAC__NO_ASM && defined FLAC__HAS_NASM
3763         /* slightly pessimistic but still catches all common cases */
3764         /* WATCHOUT: "+ bps" is an assumption that the average residual magnitude will not be more than "bps" bits */
3765         if(FLAC__bitmath_ilog2(default_partition_samples) + bps < 32) {
3766                 precompute_partition_info_sums_32bit_asm_ia32_(residual, abs_residual_partition_sums, residual_samples + predictor_order, predictor_order, min_partition_order, max_partition_order);
3767                 return;
3768         }
3769 #endif
3770
3771         /* first do max_partition_order */
3772         {
3773                 unsigned partition, residual_sample, end = (unsigned)(-(int)predictor_order);
3774                 /* slightly pessimistic but still catches all common cases */
3775                 /* WATCHOUT: "+ bps" is an assumption that the average residual magnitude will not be more than "bps" bits */
3776                 if(FLAC__bitmath_ilog2(default_partition_samples) + bps < 32) {
3777                         FLAC__uint32 abs_residual_partition_sum;
3778
3779                         for(partition = residual_sample = 0; partition < partitions; partition++) {
3780                                 end += default_partition_samples;
3781                                 abs_residual_partition_sum = 0;
3782                                 for( ; residual_sample < end; residual_sample++)
3783                                         abs_residual_partition_sum += abs(residual[residual_sample]); /* abs(INT_MIN) is undefined, but if the residual is INT_MIN we have bigger problems */
3784                                 abs_residual_partition_sums[partition] = abs_residual_partition_sum;
3785                         }
3786                 }
3787                 else { /* have to pessimistically use 64 bits for accumulator */
3788                         FLAC__uint64 abs_residual_partition_sum;
3789
3790                         for(partition = residual_sample = 0; partition < partitions; partition++) {
3791                                 end += default_partition_samples;
3792                                 abs_residual_partition_sum = 0;
3793                                 for( ; residual_sample < end; residual_sample++)
3794                                         abs_residual_partition_sum += abs(residual[residual_sample]); /* abs(INT_MIN) is undefined, but if the residual is INT_MIN we have bigger problems */
3795                                 abs_residual_partition_sums[partition] = abs_residual_partition_sum;
3796                         }
3797                 }
3798         }
3799
3800         /* now merge partitions for lower orders */
3801         {
3802                 unsigned from_partition = 0, to_partition = partitions;
3803                 int partition_order;
3804                 for(partition_order = (int)max_partition_order - 1; partition_order >= (int)min_partition_order; partition_order--) {
3805                         unsigned i;
3806                         partitions >>= 1;
3807                         for(i = 0; i < partitions; i++) {
3808                                 abs_residual_partition_sums[to_partition++] =
3809                                         abs_residual_partition_sums[from_partition  ] +
3810                                         abs_residual_partition_sums[from_partition+1];
3811                                 from_partition += 2;
3812                         }
3813                 }
3814         }
3815 }
3816
3817 void precompute_partition_info_escapes_(
3818         const FLAC__int32 residual[],
3819         unsigned raw_bits_per_partition[],
3820         unsigned residual_samples,
3821         unsigned predictor_order,
3822         unsigned min_partition_order,
3823         unsigned max_partition_order
3824 )
3825 {
3826         int partition_order;
3827         unsigned from_partition, to_partition = 0;
3828         const unsigned blocksize = residual_samples + predictor_order;
3829
3830         /* first do max_partition_order */
3831         for(partition_order = (int)max_partition_order; partition_order >= 0; partition_order--) {
3832                 FLAC__int32 r;
3833                 FLAC__uint32 rmax;
3834                 unsigned partition, partition_sample, partition_samples, residual_sample;
3835                 const unsigned partitions = 1u << partition_order;
3836                 const unsigned default_partition_samples = blocksize >> partition_order;
3837
3838                 FLAC__ASSERT(default_partition_samples > predictor_order);
3839
3840                 for(partition = residual_sample = 0; partition < partitions; partition++) {
3841                         partition_samples = default_partition_samples;
3842                         if(partition == 0)
3843                                 partition_samples -= predictor_order;
3844                         rmax = 0;
3845                         for(partition_sample = 0; partition_sample < partition_samples; partition_sample++) {
3846                                 r = residual[residual_sample++];
3847                                 /* OPT: maybe faster: rmax |= r ^ (r>>31) */
3848                                 if(r < 0)
3849                                         rmax |= ~r;
3850                                 else
3851                                         rmax |= r;
3852                         }
3853                         /* now we know all residual values are in the range [-rmax-1,rmax] */
3854                         raw_bits_per_partition[partition] = rmax? FLAC__bitmath_ilog2(rmax) + 2 : 1;
3855                 }
3856                 to_partition = partitions;
3857                 break; /*@@@ yuck, should remove the 'for' loop instead */
3858         }
3859
3860         /* now merge partitions for lower orders */
3861         for(from_partition = 0, --partition_order; partition_order >= (int)min_partition_order; partition_order--) {
3862                 unsigned m;
3863                 unsigned i;
3864                 const unsigned partitions = 1u << partition_order;
3865                 for(i = 0; i < partitions; i++) {
3866                         m = raw_bits_per_partition[from_partition];
3867                         from_partition++;
3868                         raw_bits_per_partition[to_partition] = max(m, raw_bits_per_partition[from_partition]);
3869                         from_partition++;
3870                         to_partition++;
3871                 }
3872         }
3873 }
3874
3875 #ifdef EXACT_RICE_BITS_CALCULATION
3876 static FLaC__INLINE unsigned count_rice_bits_in_partition_(
3877         const unsigned rice_parameter,
3878         const unsigned partition_samples,
3879         const FLAC__int32 *residual
3880 )
3881 {
3882         unsigned i, partition_bits =
3883                 FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN +
3884                 (1+rice_parameter) * partition_samples /* 1 for unary stop bit + rice_parameter for the binary portion */
3885         ;
3886         for(i = 0; i < partition_samples; i++)
3887                 partition_bits += ( (FLAC__uint32)((residual[i]<<1)^(residual[i]>>31)) >> rice_parameter );
3888         return partition_bits;
3889 }
3890 #else
3891 static FLaC__INLINE unsigned count_rice_bits_in_partition_(
3892         const unsigned rice_parameter,
3893         const unsigned partition_samples,
3894         const FLAC__uint64 abs_residual_partition_sum
3895 )
3896 {
3897         return
3898                 FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN +
3899                 (1+rice_parameter) * partition_samples + /* 1 for unary stop bit + rice_parameter for the binary portion */
3900                 (
3901                         rice_parameter?
3902                                 (unsigned)(abs_residual_partition_sum >> (rice_parameter-1)) /* rice_parameter-1 because the real coder sign-folds instead of using a sign bit */
3903                                 : (unsigned)(abs_residual_partition_sum << 1) /* can't shift by negative number, so reverse */
3904                 )
3905                 - (partition_samples >> 1)
3906                 /* -(partition_samples>>1) to subtract out extra contributions to the abs_residual_partition_sum.
3907                  * The actual number of bits used is closer to the sum(for all i in the partition) of  abs(residual[i])>>(rice_parameter-1)
3908                  * By using the abs_residual_partition sum, we also add in bits in the LSBs that would normally be shifted out.
3909                  * So the subtraction term tries to guess how many extra bits were contributed.
3910                  * If the LSBs are randomly distributed, this should average to 0.5 extra bits per sample.
3911                  */
3912         ;
3913 }
3914 #endif
3915
3916 FLAC__bool set_partitioned_rice_(
3917 #ifdef EXACT_RICE_BITS_CALCULATION
3918         const FLAC__int32 residual[],
3919 #endif
3920         const FLAC__uint64 abs_residual_partition_sums[],
3921         const unsigned raw_bits_per_partition[],
3922         const unsigned residual_samples,
3923         const unsigned predictor_order,
3924         const unsigned suggested_rice_parameter,
3925         const unsigned rice_parameter_search_dist,
3926         const unsigned partition_order,
3927         const FLAC__bool search_for_escapes,
3928         FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents,
3929         unsigned *bits
3930 )
3931 {
3932         unsigned rice_parameter, partition_bits;
3933         unsigned best_partition_bits, best_rice_parameter = 0;
3934         unsigned bits_ = FLAC__ENTROPY_CODING_METHOD_TYPE_LEN + FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN;
3935         unsigned *parameters, *raw_bits;
3936 #ifdef ENABLE_RICE_PARAMETER_SEARCH
3937         unsigned min_rice_parameter, max_rice_parameter;
3938 #else
3939         (void)rice_parameter_search_dist;
3940 #endif
3941
3942         FLAC__ASSERT(suggested_rice_parameter < FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER);
3943
3944         FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(partitioned_rice_contents, max(6, partition_order));
3945         parameters = partitioned_rice_contents->parameters;
3946         raw_bits = partitioned_rice_contents->raw_bits;
3947
3948         if(partition_order == 0) {
3949                 best_partition_bits = (unsigned)(-1);
3950 #ifdef ENABLE_RICE_PARAMETER_SEARCH
3951                 if(rice_parameter_search_dist) {
3952                         if(suggested_rice_parameter < rice_parameter_search_dist)
3953                                 min_rice_parameter = 0;
3954                         else
3955                                 min_rice_parameter = suggested_rice_parameter - rice_parameter_search_dist;
3956                         max_rice_parameter = suggested_rice_parameter + rice_parameter_search_dist;
3957                         if(max_rice_parameter >= FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
3958 #ifdef DEBUG_VERBOSE
3959                                 fprintf(stderr, "clipping rice_parameter (%u -> %u) @5\n", max_rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1);
3960 #endif
3961                                 max_rice_parameter = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1;
3962                         }
3963                 }
3964                 else
3965                         min_rice_parameter = max_rice_parameter = suggested_rice_parameter;
3966
3967                 for(rice_parameter = min_rice_parameter; rice_parameter <= max_rice_parameter; rice_parameter++) {
3968 #else
3969                         rice_parameter = suggested_rice_parameter;
3970 #endif
3971 #ifdef EXACT_RICE_BITS_CALCULATION
3972                         partition_bits = count_rice_bits_in_partition_(rice_parameter, residual_samples, residual);
3973 #else
3974                         partition_bits = count_rice_bits_in_partition_(rice_parameter, residual_samples, abs_residual_partition_sums[0]);
3975 #endif
3976                         if(partition_bits < best_partition_bits) {
3977                                 best_rice_parameter = rice_parameter;
3978                                 best_partition_bits = partition_bits;
3979                         }
3980 #ifdef ENABLE_RICE_PARAMETER_SEARCH
3981                 }
3982 #endif
3983                 if(search_for_escapes) {
3984                         partition_bits = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN + FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN + raw_bits_per_partition[0] * residual_samples;
3985                         if(partition_bits <= best_partition_bits) {
3986                                 raw_bits[0] = raw_bits_per_partition[0];
3987                                 best_rice_parameter = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER;
3988                                 best_partition_bits = partition_bits;
3989                         }
3990                 }
3991                 parameters[0] = best_rice_parameter;
3992                 bits_ += best_partition_bits;
3993         }
3994         else {
3995                 unsigned partition, residual_sample;
3996                 unsigned partition_samples;
3997                 FLAC__uint64 mean, k;
3998                 const unsigned partitions = 1u << partition_order;
3999                 for(partition = residual_sample = 0; partition < partitions; partition++) {
4000                         partition_samples = (residual_samples+predictor_order) >> partition_order;
4001                         if(partition == 0) {
4002                                 if(partition_samples <= predictor_order)
4003                                         return false;
4004                                 else
4005                                         partition_samples -= predictor_order;
4006                         }
4007                         mean = abs_residual_partition_sums[partition];
4008                         /* we are basically calculating the size in bits of the
4009                          * average residual magnitude in the partition:
4010                          *   rice_parameter = floor(log2(mean/partition_samples))
4011                          * 'mean' is not a good name for the variable, it is
4012                          * actually the sum of magnitudes of all residual values
4013                          * in the partition, so the actual mean is
4014                          * mean/partition_samples
4015                          */
4016                         for(rice_parameter = 0, k = partition_samples; k < mean; rice_parameter++, k <<= 1)
4017                                 ;
4018                         if(rice_parameter >= FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
4019 #ifdef DEBUG_VERBOSE
4020                                 fprintf(stderr, "clipping rice_parameter (%u -> %u) @6\n", rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1);
4021 #endif
4022                                 rice_parameter = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1;
4023                         }
4024
4025                         best_partition_bits = (unsigned)(-1);
4026 #ifdef ENABLE_RICE_PARAMETER_SEARCH
4027                         if(rice_parameter_search_dist) {
4028                                 if(rice_parameter < rice_parameter_search_dist)
4029                                         min_rice_parameter = 0;
4030                                 else
4031                                         min_rice_parameter = rice_parameter - rice_parameter_search_dist;
4032                                 max_rice_parameter = rice_parameter + rice_parameter_search_dist;
4033                                 if(max_rice_parameter >= FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER) {
4034 #ifdef DEBUG_VERBOSE
4035                                         fprintf(stderr, "clipping rice_parameter (%u -> %u) @7\n", max_rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1);
4036 #endif
4037                                         max_rice_parameter = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER - 1;
4038                                 }
4039                         }
4040                         else
4041                                 min_rice_parameter = max_rice_parameter = rice_parameter;
4042
4043                         for(rice_parameter = min_rice_parameter; rice_parameter <= max_rice_parameter; rice_parameter++) {
4044 #endif
4045 #ifdef EXACT_RICE_BITS_CALCULATION
4046                                 partition_bits = count_rice_bits_in_partition_(rice_parameter, partition_samples, residual+residual_sample);
4047 #else
4048                                 partition_bits = count_rice_bits_in_partition_(rice_parameter, partition_samples, abs_residual_partition_sums[partition]);
4049 #endif
4050                                 if(partition_bits < best_partition_bits) {
4051                                         best_rice_parameter = rice_parameter;
4052                                         best_partition_bits = partition_bits;
4053                                 }
4054 #ifdef ENABLE_RICE_PARAMETER_SEARCH
4055                         }
4056 #endif
4057                         if(search_for_escapes) {
4058                                 partition_bits = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN + FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN + raw_bits_per_partition[partition] * partition_samples;
4059                                 if(partition_bits <= best_partition_bits) {
4060                                         raw_bits[partition] = raw_bits_per_partition[partition];
4061                                         best_rice_parameter = FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER;
4062                                         best_partition_bits = partition_bits;
4063                                 }
4064                         }
4065                         parameters[partition] = best_rice_parameter;
4066                         bits_ += best_partition_bits;
4067                         residual_sample += partition_samples;
4068                 }
4069         }
4070
4071         *bits = bits_;
4072         return true;
4073 }
4074
4075 unsigned get_wasted_bits_(FLAC__int32 signal[], unsigned samples)
4076 {
4077         unsigned i, shift;
4078         FLAC__int32 x = 0;
4079
4080         for(i = 0; i < samples && !(x&1); i++)
4081                 x |= signal[i];
4082
4083         if(x == 0) {
4084                 shift = 0;
4085         }
4086         else {
4087                 for(shift = 0; !(x&1); shift++)
4088                         x >>= 1;
4089         }
4090
4091         if(shift > 0) {
4092                 for(i = 0; i < samples; i++)
4093                          signal[i] >>= shift;
4094         }
4095
4096         return shift;
4097 }
4098
4099 void append_to_verify_fifo_(verify_input_fifo *fifo, const FLAC__int32 * const input[], unsigned input_offset, unsigned channels, unsigned wide_samples)
4100 {
4101         unsigned channel;
4102
4103         for(channel = 0; channel < channels; channel++)
4104                 memcpy(&fifo->data[channel][fifo->tail], &input[channel][input_offset], sizeof(FLAC__int32) * wide_samples);
4105
4106         fifo->tail += wide_samples;
4107
4108         FLAC__ASSERT(fifo->tail <= fifo->size);
4109 }
4110
4111 void append_to_verify_fifo_interleaved_(verify_input_fifo *fifo, const FLAC__int32 input[], unsigned input_offset, unsigned channels, unsigned wide_samples)
4112 {
4113         unsigned channel;
4114         unsigned sample, wide_sample;
4115         unsigned tail = fifo->tail;
4116
4117         sample = input_offset * channels;
4118         for(wide_sample = 0; wide_sample < wide_samples; wide_sample++) {
4119                 for(channel = 0; channel < channels; channel++)
4120                         fifo->data[channel][tail] = input[sample++];
4121                 tail++;
4122         }
4123         fifo->tail = tail;
4124
4125         FLAC__ASSERT(fifo->tail <= fifo->size);
4126 }
4127
4128 FLAC__StreamDecoderReadStatus verify_read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
4129 {
4130         FLAC__StreamEncoder *encoder = (FLAC__StreamEncoder*)client_data;
4131         const size_t encoded_bytes = encoder->private_->verify.output.bytes;
4132         (void)decoder;
4133
4134         if(encoder->private_->verify.needs_magic_hack) {
4135                 FLAC__ASSERT(*bytes >= FLAC__STREAM_SYNC_LENGTH);
4136                 *bytes = FLAC__STREAM_SYNC_LENGTH;
4137                 memcpy(buffer, FLAC__STREAM_SYNC_STRING, *bytes);
4138                 encoder->private_->verify.needs_magic_hack = false;
4139         }
4140         else {
4141                 if(encoded_bytes == 0) {
4142                         /*
4143                          * If we get here, a FIFO underflow has occurred,
4144                          * which means there is a bug somewhere.
4145                          */
4146                         FLAC__ASSERT(0);
4147                         return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
4148                 }
4149                 else if(encoded_bytes < *bytes)
4150                         *bytes = encoded_bytes;
4151                 memcpy(buffer, encoder->private_->verify.output.data, *bytes);
4152                 encoder->private_->verify.output.data += *bytes;
4153                 encoder->private_->verify.output.bytes -= *bytes;
4154         }
4155
4156         return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
4157 }
4158
4159 FLAC__StreamDecoderWriteStatus verify_write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
4160 {
4161         FLAC__StreamEncoder *encoder = (FLAC__StreamEncoder *)client_data;
4162         unsigned channel;
4163         const unsigned channels = frame->header.channels;
4164         const unsigned blocksize = frame->header.blocksize;
4165         const unsigned bytes_per_block = sizeof(FLAC__int32) * blocksize;
4166
4167         (void)decoder;
4168
4169         for(channel = 0; channel < channels; channel++) {
4170                 if(0 != memcmp(buffer[channel], encoder->private_->verify.input_fifo.data[channel], bytes_per_block)) {
4171                         unsigned i, sample = 0;
4172                         FLAC__int32 expect = 0, got = 0;
4173
4174                         for(i = 0; i < blocksize; i++) {
4175                                 if(buffer[channel][i] != encoder->private_->verify.input_fifo.data[channel][i]) {
4176                                         sample = i;
4177                                         expect = (FLAC__int32)encoder->private_->verify.input_fifo.data[channel][i];
4178                                         got = (FLAC__int32)buffer[channel][i];
4179                                         break;
4180                                 }
4181                         }
4182                         FLAC__ASSERT(i < blocksize);
4183                         FLAC__ASSERT(frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
4184                         encoder->private_->verify.error_stats.absolute_sample = frame->header.number.sample_number + sample;
4185                         encoder->private_->verify.error_stats.frame_number = (unsigned)(frame->header.number.sample_number / blocksize);
4186                         encoder->private_->verify.error_stats.channel = channel;
4187                         encoder->private_->verify.error_stats.sample = sample;
4188                         encoder->private_->verify.error_stats.expected = expect;
4189                         encoder->private_->verify.error_stats.got = got;
4190                         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA;
4191                         return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
4192                 }
4193         }
4194         /* dequeue the frame from the fifo */
4195         encoder->private_->verify.input_fifo.tail -= blocksize;
4196         FLAC__ASSERT(encoder->private_->verify.input_fifo.tail <= OVERREAD_);
4197         for(channel = 0; channel < channels; channel++)
4198                 memmove(&encoder->private_->verify.input_fifo.data[channel][0], &encoder->private_->verify.input_fifo.data[channel][blocksize], encoder->private_->verify.input_fifo.tail * sizeof(encoder->private_->verify.input_fifo.data[0][0]));
4199         return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
4200 }
4201
4202 void verify_metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
4203 {
4204         (void)decoder, (void)metadata, (void)client_data;
4205 }
4206
4207 void verify_error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
4208 {
4209         FLAC__StreamEncoder *encoder = (FLAC__StreamEncoder*)client_data;
4210         (void)decoder, (void)status;
4211         encoder->protected_->state = FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR;
4212 }
4213
4214 FLAC__StreamEncoderReadStatus file_read_callback_(const FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
4215 {
4216         (void)client_data;
4217
4218         *bytes = fread(buffer, 1, *bytes, encoder->private_->file);
4219         if (*bytes == 0) {
4220                 if (feof(encoder->private_->file))
4221                         return FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM;
4222                 else if (ferror(encoder->private_->file))
4223                         return FLAC__STREAM_ENCODER_READ_STATUS_ABORT;
4224         }
4225         return FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE;
4226 }
4227
4228 FLAC__StreamEncoderSeekStatus file_seek_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)
4229 {
4230         (void)client_data;
4231
4232         if(fseeko(encoder->private_->file, (off_t)absolute_byte_offset, SEEK_SET) < 0)
4233                 return FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR;
4234         else
4235                 return FLAC__STREAM_ENCODER_SEEK_STATUS_OK;
4236 }
4237
4238 FLAC__StreamEncoderTellStatus file_tell_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)
4239 {
4240         off_t offset;
4241
4242         (void)client_data;
4243
4244         offset = ftello(encoder->private_->file);
4245
4246         if(offset < 0) {
4247                 return FLAC__STREAM_ENCODER_TELL_STATUS_ERROR;
4248         }
4249         else {
4250                 *absolute_byte_offset = (FLAC__uint64)offset;
4251                 return FLAC__STREAM_ENCODER_TELL_STATUS_OK;
4252         }
4253 }
4254
4255 #ifdef FLAC__VALGRIND_TESTING
4256 static size_t local__fwrite(const void *ptr, size_t size, size_t nmemb, FILE *stream)
4257 {
4258         size_t ret = fwrite(ptr, size, nmemb, stream);
4259         if(!ferror(stream))
4260                 fflush(stream);
4261         return ret;
4262 }
4263 #else
4264 #define local__fwrite fwrite
4265 #endif
4266
4267 FLAC__StreamEncoderWriteStatus file_write_callback_(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame, void *client_data)
4268 {
4269         (void)client_data, (void)current_frame;
4270
4271         if(local__fwrite(buffer, sizeof(FLAC__byte), bytes, encoder->private_->file) == bytes) {
4272                 FLAC__bool call_it = 0 != encoder->private_->progress_callback && (
4273 #if FLAC__HAS_OGG
4274                         /* We would like to be able to use 'samples > 0' in the
4275                          * clause here but currently because of the nature of our
4276                          * Ogg writing implementation, 'samples' is always 0 (see
4277                          * ogg_encoder_aspect.c).  The downside is extra progress
4278                          * callbacks.
4279                          */
4280                         encoder->private_->is_ogg? true :
4281 #endif
4282                         samples > 0
4283                 );
4284                 if(call_it) {
4285                         /* NOTE: We have to add +bytes, +samples, and +1 to the stats
4286                          * because at this point in the callback chain, the stats
4287                          * have not been updated.  Only after we return and control
4288                          * gets back to write_frame_() are the stats updated
4289                          */
4290                         encoder->private_->progress_callback(encoder, encoder->private_->bytes_written+bytes, encoder->private_->samples_written+samples, encoder->private_->frames_written+(samples?1:0), encoder->private_->total_frames_estimate, encoder->private_->client_data);
4291                 }
4292                 return FLAC__STREAM_ENCODER_WRITE_STATUS_OK;
4293         }
4294         else
4295                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
4296 }
4297
4298 /*
4299  * This will forcibly set stdout to binary mode (for OSes that require it)
4300  */
4301 FILE *get_binary_stdout_(void)
4302 {
4303         /* if something breaks here it is probably due to the presence or
4304          * absence of an underscore before the identifiers 'setmode',
4305          * 'fileno', and/or 'O_BINARY'; check your system header files.
4306          */
4307 #if defined _MSC_VER || defined __MINGW32__
4308         _setmode(_fileno(stdout), _O_BINARY);
4309 #elif defined __CYGWIN__
4310         /* almost certainly not needed for any modern Cygwin, but let's be safe... */
4311         setmode(_fileno(stdout), _O_BINARY);
4312 #elif defined __EMX__
4313         setmode(fileno(stdout), O_BINARY);
4314 #endif
4315
4316         return stdout;
4317 }