include/FLAC/stream_encoder.h

   1 /* libFLAC - Free Lossless Audio Codec library
   2  * Copyright (C) 2000,2001,2002  Josh Coalson
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA  02111-1307, USA.
  18  */
  19
  20 #ifndef FLAC__STREAM_ENCODER_H
  21 #define FLAC__STREAM_ENCODER_H
  22
  23 #include "format.h"
  24 #include "stream_decoder.h"
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30
  31 /** \file include/FLAC/stream_encoder.h
  32  *
  33  *  \brief
  34  *  This module contains the functions which implement the stream
  35  *  encoder.
  36  *
  37  *  See the detailed documentation in the
  38  *  \link flac_stream_encoder stream encoder \endlink module.
  39  */
  40
  41 /** \defgroup flac_encoder FLAC/ *_encoder.h: encoder interfaces
  42  *  \ingroup flac
  43  *
  44  *  \brief
  45  *  This module describes the two encoder layers provided by libFLAC.
  46  *
  47  * For encoding FLAC streams, libFLAC provides two layers of access.  The
  48  * lowest layer is stream-level encoding, and the highest is file-level
  49  * encoding.  The interfaces are described in the \link flac_stream_encoder
  50  * stream encoder \endlink and \link flac_file_encoder file encoder \endlink
  51  * modules respectively.  Typically you will choose the highest layer that
  52  * your output source will support.
  53  *
  54  * The stream encoder relies on callbacks for writing the data and
  55  * metadata. The file encoder provides these callbacks internally and you
  56  * need only supply the filename.
  57  */
  58
  59 /** \defgroup flac_stream_encoder FLAC/stream_encoder.h: stream encoder interface
  60  *  \ingroup flac_encoder
  61  *
  62  *  \brief
  63  *  This module contains the functions which implement the stream
  64  *  encoder.
  65  *
  66  * The basic usage of this encoder is as follows:
  67  * - The program creates an instance of an encoder using
  68  *   FLAC__stream_encoder_new().
  69  * - The program overrides the default settings and sets callbacks using
  70  *   FLAC__stream_encoder_set_*() functions.
  71  * - The program initializes the instance to validate the settings and
  72  *   prepare for encoding using FLAC__stream_encoder_init().
  73  * - The program calls FLAC__stream_encoder_process() or
  74  *   FLAC__stream_encoder_process_interleaved() to encode data, which
  75  *   subsequently calls the callbacks when there is encoder data ready
  76  *   to be written.
  77  * - The program finishes the encoding with FLAC__stream_encoder_finish(),
  78  *   which causes the encoder to encode any data still in its input pipe,
  79  *   call the metadata callback with the final encoding statistics, and
  80  *   finally reset the encoder to the uninitialized state.
  81  * - The instance may be used again or deleted with
  82  *   FLAC__stream_encoder_delete().
  83  *
  84  * In more detail, the stream encoder functions similarly to the
  85  * \link flac_stream_decoder stream decoder \endlink, but has fewer
  86  * callbacks and more options.  Typically the user will create a new
  87  * instance by calling FLAC__stream_encoder_new(), then set the necessary
  88  * parameters and callbacks with FLAC__stream_encoder_set_*(), and
  89  * initialize it by calling FLAC__stream_encoder_init().
  90  *
  91  * Unlike the decoders, the stream encoder has many options that can
  92  * affect the speed and compression ratio.  When setting these parameters
  93  * you should have some basic knowledge of the format (see the
  94  * <A HREF="../documentation.html#format">user-level documentation</A>
  95  * or the <A HREF="../format.html">formal description</A>).  The
  96  * FLAC__stream_encoder_set_*() functions themselves do not validate the
  97  * values as many are interdependent.  The FLAC__stream_encoder_init()
  98  * function will do this, so make sure to pay attention to the state
  99  * returned by FLAC__stream_encoder_init() to make sure that it is
 100  * FLAC__STREAM_ENCODER_OK.  Any parameters that are not set before
 101  * FLAC__stream_encoder_init() will take on the defaults from the
 102  * constructor.
 103  *
 104  * The user must provide function pointers for the following callbacks:
 105  *
 106  * - Write callback - This function is called by the encoder anytime there
 107  *   is raw encoded data to write.  It may include metadata mixed with
 108  *   encoded audio frames and the data is not guaranteed to be aligned on
 109  *   frame or metadata block boundaries.
 110  * - Metadata callback - This function is called once at the end of
 111  *   encoding with the populated STREAMINFO structure.  This is so file
 112  *   encoders can seek back to the beginning of the file and write the
 113  *   STREAMINFO block with the correct statistics after encoding (like
 114  *   minimum/maximum frame size).
 115  *
 116  * The call to FLAC__stream_encoder_init() currently will also immediately
 117  * call the write callback several times, once with the \c fLaC signature,
 118  * and once for each encoded metadata block.
 119  *
 120  * After initializing the instance, the user may feed audio data to the
 121  * encoder in one of two ways:
 122  *
 123  * - Channel separate, through FLAC__stream_encoder_process() - The user
 124  *   will pass an array of pointers to buffers, one for each channel, to
 125  *   the encoder, each of the same length.  The samples need not be
 126  *   block-aligned.
 127  * - Channel interleaved, through
 128  *   FLAC__stream_encoder_process_interleaved() - The user will pass a single
 129  *   pointer to data that is channel-interleaved (i.e. channel0_sample0,
 130  *   channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
 131  *   Again, the samples need not be block-aligned but they must be
 132  *   sample-aligned, i.e. the first value should be channel0_sample0 and
 133  *   the last value channelN_sampleM.
 134  *
 135  * When the user is finished encoding data, it calls
 136  * FLAC__stream_encoder_finish(), which causes the encoder to encode any
 137  * data still in its input pipe, and call the metadata callback with the
 138  * final encoding statistics.  Then the instance may be deleted with
 139  * FLAC__stream_encoder_delete() or initialized again to encode another
 140  * stream.
 141  *
 142  * For programs that write their own metadata, but that do not know the
 143  * actual metadata until after encoding, it is advantageous to instruct
 144  * the encoder to write a PADDING block of the correct size, so that
 145  * instead of rewriting the whole stream after encoding, the program can
 146  * just overwrite the PADDING block.  If only the maximum size of the
 147  * metadata is known, the program can write a slightly larger padding
 148  * block, then split it after encoding.
 149  *
 150  * Make sure you understand how lengths are calculated.  All FLAC metadata
 151  * blocks have a 4 byte header which contains the type and length.  This
 152  * length does not include the 4 bytes of the header.  See the format page
 153  * for the specification of metadata blocks and their lengths.
 154  *
 155  * \note
 156  * The "set" functions may only be called when the encoder is in the
 157  * state FLAC__STREAM_ENCODER_UNINITIALIZED, i.e. after
 158  * FLAC__stream_encoder_new() or FLAC__stream_encoder_finish(), but
 159  * before FLAC__stream_encoder_init().  If this is the case they will
 160  * return \c true, otherwise \c false.
 161  *
 162  * \note
 163  * FLAC__stream_encoder_finish() resets all settings to the constructor
 164  * defaults, including the callbacks.
 165  *
 166  * \{
 167  */
 168
 169
 170 /** State values for a FLAC__StreamEncoder
 171  *
 172  *  The encoder's state can be obtained by calling FLAC__stream_encoder_get_state().
 173  */
 174 typedef enum {
 175
 176         FLAC__STREAM_ENCODER_OK = 0,
 177         /**< The encoder is in the normal OK state. */
 178
 179         FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR,
 180         /**< An error occurred in the underlying verify stream decoder;
 181          * check FLAC__stream_encoder_get_verify_decoder_state().
 182          */
 183
 184         FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA,
 185         /**< The verify decoder detected a mismatch between the original
 186          * audio signal and the decoded audio signal.
 187          */
 188
 189         FLAC__STREAM_ENCODER_INVALID_CALLBACK,
 190         /**< The encoder was initialized before setting all the required callbacks. */
 191
 192         FLAC__STREAM_ENCODER_INVALID_NUMBER_OF_CHANNELS,
 193         /**< The encoder has an invalid setting for number of channels. */
 194
 195         FLAC__STREAM_ENCODER_INVALID_BITS_PER_SAMPLE,
 196         /**< The encoder has an invalid setting for bits-per-sample.
 197          * FLAC supports 4-32 bps but the reference encoder currently supports
 198          * only up to 24 bps.
 199          */
 200
 201         FLAC__STREAM_ENCODER_INVALID_SAMPLE_RATE,
 202         /**< The encoder has an invalid setting for the input sample rate. */
 203
 204         FLAC__STREAM_ENCODER_INVALID_BLOCK_SIZE,
 205         /**< The encoder has an invalid setting for the block size. */
 206
 207         FLAC__STREAM_ENCODER_INVALID_MAX_LPC_ORDER,
 208         /**< The encoder has an invalid setting for the maximum LPC order. */
 209
 210         FLAC__STREAM_ENCODER_INVALID_QLP_COEFF_PRECISION,
 211         /**< The encoder has an invalid setting for the precision of the quantized linear predictor coefficients. */
 212
 213         FLAC__STREAM_ENCODER_MID_SIDE_CHANNELS_MISMATCH,
 214         /**< Mid/side coding was specified but the number of channels is not equal to 2. */
 215
 216         FLAC__STREAM_ENCODER_MID_SIDE_SAMPLE_SIZE_MISMATCH,
 217         /**< Deprecated. */
 218
 219         FLAC__STREAM_ENCODER_ILLEGAL_MID_SIDE_FORCE,
 220         /**< Loose mid/side coding was specified but mid/side coding was not. */
 221
 222         FLAC__STREAM_ENCODER_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER,
 223         /**< The specified block size is less than the maximum LPC order. */
 224
 225         FLAC__STREAM_ENCODER_NOT_STREAMABLE,
 226         /**< The encoder is bound to the "streamable subset" but other settings violate it. */
 227
 228         FLAC__STREAM_ENCODER_FRAMING_ERROR,
 229         /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
 230
 231         FLAC__STREAM_ENCODER_INVALID_METADATA,
 232         /**< The metadata input to the encoder is invalid, in one of the following ways:
 233          * - FLAC__stream_encoder_set_metadata() was called with a null pointer but a block count > 0
 234          * - It contains an illegal SEEKTABLE as checked by FLAC__format_seektable_is_legal()
 235          * - It contains more than one SEEKTABLE block or more than one VORBIS_COMMENT block
 236          */
 237
 238         FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_ENCODING,
 239         /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
 240
 241         FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_WRITING,
 242         /**< The write_callback returned an error. */
 243
 244         FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR,
 245         /**< Memory allocation failed. */
 246
 247         FLAC__STREAM_ENCODER_ALREADY_INITIALIZED,
 248         /**< FLAC__stream_encoder_init() was called when the encoder was
 249          * already initialized, usually because
 250          * FLAC__stream_encoder_finish() was not called.
 251          */
 252
 253         FLAC__STREAM_ENCODER_UNINITIALIZED
 254         /**< The encoder is in the uninitialized state. */
 255
 256 } FLAC__StreamEncoderState;
 257
 258 /** Maps a FLAC__StreamEncoderState to a C string.
 259  *
 260  *  Using a FLAC__StreamEncoderState as the index to this array
 261  *  will give the string equivalent.  The contents should not be modified.
 262  */
 263 extern const char * const FLAC__StreamEncoderStateString[];
 264
 265 /** Return values for the FLAC__StreamEncoder write callback.
 266  */
 267 typedef enum {
 268
 269         FLAC__STREAM_ENCODER_WRITE_STATUS_OK = 0,
 270         /**< The write was OK and encoding can continue. */
 271
 272         FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR
 273         /**< An unrecoverable error occurred.  The encoder will return from the process call. */
 274
 275 } FLAC__StreamEncoderWriteStatus;
 276
 277 /** Maps a FLAC__StreamEncoderWriteStatus to a C string.
 278  *
 279  *  Using a FLAC__StreamEncoderWriteStatus as the index to this array
 280  *  will give the string equivalent.  The contents should not be modified.
 281  */
 282 extern const char * const FLAC__StreamEncoderWriteStatusString[];
 283
 284
 285 /***********************************************************************
 286  *
 287  * class FLAC__StreamEncoder
 288  *
 289  ***********************************************************************/
 290
 291 struct FLAC__StreamEncoderProtected;
 292 struct FLAC__StreamEncoderPrivate;
 293 /** The opaque structure definition for the stream encoder type.
 294  *  See the \link flac_stream_encoder stream encoder module \endlink
 295  *  for a detailed description.
 296  */
 297 typedef struct {
 298         struct FLAC__StreamEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */
 299         struct FLAC__StreamEncoderPrivate *private_; /* avoid the C++ keyword 'private' */
 300 } FLAC__StreamEncoder;
 301
 302 /** Signature for the write callback.
 303  *  See FLAC__stream_encoder_set_write_callback() for more info.
 304  *
 305  * \param  encoder  The encoder instance calling the callback.
 306  * \param  buffer   An array of encoded data of length \a bytes.
 307  * \param  bytes    The byte length of \a buffer.
 308  * \param  samples  The number of samples encoded by \a buffer.
 309  *                  \c 0 has a special meaning; see
 310  *                  FLAC__stream_encoder_set_write_callback().
 311  * \param  current_frame  The number of the current frame being encoded.
 312  * \param  client_data  The callee's client data set through
 313  *                      FLAC__stream_encoder_set_client_data().
 314  * \retval FLAC__StreamDecoderWriteStatus
 315  *    The callee's return status.
 316  */
 317 typedef FLAC__StreamEncoderWriteStatus (*FLAC__StreamEncoderWriteCallback)(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data);
 318
 319 /** Signature for the metadata callback.
 320  *  See FLAC__stream_encoder_set_metadata_callback() for more info.
 321  *
 322  * \param  encoder      The encoder instance calling the callback.
 323  * \param  metadata     The final populated STREAMINFO block.
 324  * \param  client_data  The callee's client data set through
 325  *                      FLAC__stream_encoder_set_client_data().
 326  */
 327 typedef void (*FLAC__StreamEncoderMetadataCallback)(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data);
 328
 329
 330 /***********************************************************************
 331  *
 332  * Class constructor/destructor
 333  *
 334  ***********************************************************************/
 335
 336 /** Create a new stream encoder instance.  The instance is created with
 337  *  default settings; see the individual FLAC__stream_encoder_set_*()
 338  *  functions for each setting's default.
 339  *
 340  * \retval FLAC__StreamEncoder*
 341  *    \c NULL if there was an error allocating memory, else the new instance.
 342  */
 343 FLAC__StreamEncoder *FLAC__stream_encoder_new();
 344
 345 /** Free an encoder instance.  Deletes the object pointed to by \a encoder.
 346  *
 347  * \param encoder  A pointer to an existing encoder.
 348  * \assert
 349  *    \code encoder != NULL \endcode
 350  */
 351 void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder);
 352
 353 /***********************************************************************
 354  *
 355  * Public class method prototypes
 356  *
 357  ***********************************************************************/
 358
 359 /** Set the "verify" flag.  If \c true, the encoder will verify it's own
 360  *  encoded output by feeding it through an internal decoder and comparing
 361  *  the original signal against the decoded signal.  If a mismatch occurs,
 362  *  the process call will return \c false.  Note that this will slow the
 363  *  encoding process by the extra time required for decoding and comparison.
 364  *
 365  * \default \c false
 366  * \param  encoder  An encoder instance to set.
 367  * \param  value    Flag value (see above).
 368  * \assert
 369  *    \code encoder != NULL \endcode
 370  * \retval FLAC__bool
 371  *    \c false if the encoder is already initialized, else \c true.
 372  */
 373 FLAC__bool FLAC__stream_encoder_set_verify(FLAC__StreamEncoder *encoder, FLAC__bool value);
 374
 375 /** Set the "streamable subset" flag.  If \c true, the encoder will comply
 376  *  with the subset (see the format specification) and will check the
 377  *  settings during FLAC__stream_encoder_init() to see if all settings
 378  *  comply.  If \c false, the settings may take advantage of the full
 379  *  range that the format allows.
 380  *
 381  *  Make sure you know what it entails before setting this to \c false.
 382  *
 383  * \default \c true
 384  * \param  encoder  An encoder instance to set.
 385  * \param  value    Flag value (see above).
 386  * \assert
 387  *    \code encoder != NULL \endcode
 388  * \retval FLAC__bool
 389  *    \c false if the encoder is already initialized, else \c true.
 390  */
 391 FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value);
 392
 393 /** Set to \c true to enable mid-side encoding on stereo input.  The
 394  *  number of channels must be 2.  Set to \c false to use only
 395  *  independent channel coding.
 396  *
 397  * \default \c false
 398  * \param  encoder  An encoder instance to set.
 399  * \param  value    Flag value (see above).
 400  * \assert
 401  *    \code encoder != NULL \endcode
 402  * \retval FLAC__bool
 403  *    \c false if the encoder is already initialized, else \c true.
 404  */
 405 FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
 406
 407 /** Set to \c true to enable adaptive switching between mid-side and
 408  *  left-right encoding on stereo input.  The number of channels must
 409  *  be 2.  Set to \c false to use exhaustive searching.  In either
 410  *  case, the mid/side stereo setting must be \c true.
 411  *
 412  * \default \c false
 413  * \param  encoder  An encoder instance to set.
 414  * \param  value    Flag value (see above).
 415  * \assert
 416  *    \code encoder != NULL \endcode
 417  * \retval FLAC__bool
 418  *    \c false if the encoder is already initialized, else \c true.
 419  */
 420 FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
 421
 422 /** Set the number of channels to be encoded.
 423  *
 424  * \default \c 2
 425  * \param  encoder  An encoder instance to set.
 426  * \param  value    See above.
 427  * \assert
 428  *    \code encoder != NULL \endcode
 429  * \retval FLAC__bool
 430  *    \c false if the encoder is already initialized, else \c true.
 431  */
 432 FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, unsigned value);
 433
 434 /** Set the sample resolution of the input to be encoded.
 435  *
 436  * \warning
 437  * Do not feed the encoder data that is wider than the value you
 438  * set here or you will generate an invalid stream.
 439  *
 440  * \default \c 16
 441  * \param  encoder  An encoder instance to set.
 442  * \param  value    See above.
 443  * \assert
 444  *    \code encoder != NULL \endcode
 445  * \retval FLAC__bool
 446  *    \c false if the encoder is already initialized, else \c true.
 447  */
 448 FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, unsigned value);
 449
 450 /** Set the sample rate (in Hz) of the input to be encoded.
 451  *
 452  * \default \c 44100
 453  * \param  encoder  An encoder instance to set.
 454  * \param  value    See above.
 455  * \assert
 456  *    \code encoder != NULL \endcode
 457  * \retval FLAC__bool
 458  *    \c false if the encoder is already initialized, else \c true.
 459  */
 460 FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, unsigned value);
 461
 462 /** Set the blocksize to use while encoding.
 463  *
 464  * \default \c 1152
 465  * \param  encoder  An encoder instance to set.
 466  * \param  value    See above.
 467  * \assert
 468  *    \code encoder != NULL \endcode
 469  * \retval FLAC__bool
 470  *    \c false if the encoder is already initialized, else \c true.
 471  */
 472 FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, unsigned value);
 473
 474 /** Set the maximum LPC order, or \c 0 to use only the fixed predictors.
 475  *
 476  * \default \c 0
 477  * \param  encoder  An encoder instance to set.
 478  * \param  value    See above.
 479  * \assert
 480  *    \code encoder != NULL \endcode
 481  * \retval FLAC__bool
 482  *    \c false if the encoder is already initialized, else \c true.
 483  */
 484 FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, unsigned value);
 485
 486 /** Set the precision, in bits, of the quantized linear predictor
 487  *  coefficients, or \c 0 to let the encoder select it based on the
 488  *  blocksize.
 489  *
 490  * \note
 491  * In the current implementation, qlp_coeff_precision + bits_per_sample must
 492  * be less than 32.
 493  *
 494  * \default \c 0
 495  * \param  encoder  An encoder instance to set.
 496  * \param  value    See above.
 497  * \assert
 498  *    \code encoder != NULL \endcode
 499  * \retval FLAC__bool
 500  *    \c false if the encoder is already initialized, else \c true.
 501  */
 502 FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, unsigned value);
 503
 504 /** Set to \c false to use only the specified quantized linear predictor
 505  *  coefficient precision, or \c true to search neighboring precision
 506  *  values and use the best one.
 507  *
 508  * \default \c false
 509  * \param  encoder  An encoder instance to set.
 510  * \param  value    See above.
 511  * \assert
 512  *    \code encoder != NULL \endcode
 513  * \retval FLAC__bool
 514  *    \c false if the encoder is already initialized, else \c true.
 515  */
 516 FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
 517
 518 /** Deprecated.  Setting this value has no effect.
 519  *
 520  * \default \c false
 521  * \param  encoder  An encoder instance to set.
 522  * \param  value    See above.
 523  * \assert
 524  *    \code encoder != NULL \endcode
 525  * \retval FLAC__bool
 526  *    \c false if the encoder is already initialized, else \c true.
 527  */
 528 FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value);
 529
 530 /** Set to \c false to let the encoder estimate the best model order
 531  *  based on the residual signal energy, or \c true to force the
 532  *  encoder to evaluate all order models and select the best.
 533  *
 534  * \default \c false
 535  * \param  encoder  An encoder instance to set.
 536  * \param  value    See above.
 537  * \assert
 538  *    \code encoder != NULL \endcode
 539  * \retval FLAC__bool
 540  *    \c false if the encoder is already initialized, else \c true.
 541  */
 542 FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
 543
 544 /** Set the minimum partition order to search when coding the residual.
 545  *  This is used in tandem with
 546  *  FLAC__stream_encoder_set_max_residual_partition_order().
 547  *
 548  *  The partition order determines the context size in the residual.
 549  *  The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
 550  *
 551  *  Set both min and max values to \c 0 to force a single context,
 552  *  whose Rice parameter is based on the residual signal variance.
 553  *  Otherwise, set a min and max order, and the encoder will search
 554  *  all orders, using the mean of each context for its Rice parameter,
 555  *  and use the best.
 556  *
 557  * \default \c 0
 558  * \param  encoder  An encoder instance to set.
 559  * \param  value    See above.
 560  * \assert
 561  *    \code encoder != NULL \endcode
 562  * \retval FLAC__bool
 563  *    \c false if the encoder is already initialized, else \c true.
 564  */
 565 FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
 566
 567 /** Set the minimum partition order to search when coding the residual.
 568  *  This is used in tandem with
 569  *  FLAC__stream_encoder_set_min_residual_partition_order().
 570  *
 571  *  The partition order determines the context size in the residual.
 572  *  The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
 573  *
 574  *  Set both min and max values to \c 0 to force a single context,
 575  *  whose Rice parameter is based on the residual signal variance.
 576  *  Otherwise, set a min and max order, and the encoder will search
 577  *  all orders, using the mean of each context for its Rice parameter,
 578  *  and use the best.
 579  *
 580  * \default \c 0
 581  * \param  encoder  An encoder instance to set.
 582  * \param  value    See above.
 583  * \assert
 584  *    \code encoder != NULL \endcode
 585  * \retval FLAC__bool
 586  *    \c false if the encoder is already initialized, else \c true.
 587  */
 588 FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
 589
 590 /** Deprecated.  Setting this value has no effect.
 591  *
 592  * \default \c 0
 593  * \param  encoder  An encoder instance to set.
 594  * \param  value    See above.
 595  * \assert
 596  *    \code encoder != NULL \endcode
 597  * \retval FLAC__bool
 598  *    \c false if the encoder is already initialized, else \c true.
 599  */
 600 FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, unsigned value);
 601
 602 /** Set an estimate of the total samples that will be encoded.
 603  *  This is merely an estimate and may be set to \c 0 if unknown.
 604  *  This value will be written to the STREAMINFO block before encoding,
 605  *  and can remove the need for the caller to rewrite the value later
 606  *  if the value is known before encoding.
 607  *
 608  * \default \c 0
 609  * \param  encoder  An encoder instance to set.
 610  * \param  value    See above.
 611  * \assert
 612  *    \code encoder != NULL \endcode
 613  * \retval FLAC__bool
 614  *    \c false if the encoder is already initialized, else \c true.
 615  */
 616 FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value);
 617
 618 /** Set the metadata blocks to be emitted to the stream before encoding.
 619  *  A value of \c NULL, \c 0 implies no metadata; otherwise, supply an
 620  *  array of pointers to metadata blocks.  The array is non-const since
 621  *  the encoder may need to change the \a is_last flag inside them.
 622  *  Otherwise, the encoder will not modify or free the blocks.  It is up
 623  *  to the caller to free the metadata blocks after encoding.
 624  *
 625  * \note
 626  * The encoder stores only the \a metadata pointer; the passed-in array
 627  * must survive at least until after FLAC__stream_encoder_init() returns.
 628  * Do not modify the array or free the blocks until then.
 629  *
 630  * \note
 631  * The STREAMINFO block is always written and no STREAMINFO block may
 632  * occur in the supplied array.
 633  *
 634  * \note
 635  * A VORBIS_COMMENT block may be supplied.  The vendor string in it
 636  * will be ignored.  libFLAC will use it's own vendor string. libFLAC
 637  * will not modify the passed-in VORBIS_COMMENT's vendor string, it
 638  * will simply write it's own into the stream.  If no VORBIS_COMMENT
 639  * block is present in the \a metadata array, libFLAC will write an
 640  * empty one, containing only the vendor string.
 641  *
 642  * \default \c NULL, 0
 643  * \param  encoder     An encoder instance to set.
 644  * \param  metadata    See above.
 645  * \param  num_blocks  See above.
 646  * \assert
 647  *    \code encoder != NULL \endcode
 648  * \retval FLAC__bool
 649  *    \c false if the encoder is already initialized, else \c true.
 650  */
 651 FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks);
 652
 653 /** Set the write callback.
 654  *  The supplied function will be called by the encoder anytime there is raw
 655  *  encoded data ready to write.  It may include metadata mixed with encoded
 656  *  audio frames and the data is not guaranteed to be aligned on frame or
 657  *  metadata block boundaries.
 658  *
 659  *  The only duty of the callback is to write out the \a bytes worth of data
 660  *  in \a buffer to the current position in the output stream.  The arguments
 661  *  \a samples and \a current_frame are purely informational.  If \a samples
 662  *  is greater than \c 0, then \a current_frame will hold the current frame
 663  *  number that is being written; otherwise, the write callback is being called
 664  *  to write metadata.
 665  *
 666  * \note
 667  * The callback is mandatory and must be set before initialization.
 668  *
 669  * \default \c NULL
 670  * \param  encoder  An encoder instance to set.
 671  * \param  value    See above.
 672  * \assert
 673  *    \code encoder != NULL \endcode
 674  *    \code value != NULL \endcode
 675  * \retval FLAC__bool
 676  *    \c false if the encoder is already initialized, else \c true.
 677  */
 678 FLAC__bool FLAC__stream_encoder_set_write_callback(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderWriteCallback value);
 679
 680 /** Set the metadata callback.
 681  *  The supplied function will be called once at the end of encoding with
 682  *  the populated STREAMINFO structure.  This is so file encoders can seek
 683  *  back to the beginning of the file and write the STREAMINFO block with
 684  *  the correct statistics after encoding (like minimum/maximum frame size
 685  *  and total samples).
 686  *
 687  * \note
 688  * The callback is mandatory and must be set before initialization.
 689  *
 690  * \default \c NULL
 691  * \param  encoder  An encoder instance to set.
 692  * \param  value    See above.
 693  * \assert
 694  *    \code encoder != NULL \endcode
 695  *    \code value != NULL \endcode
 696  * \retval FLAC__bool
 697  *    \c false if the encoder is already initialized, else \c true.
 698  */
 699 FLAC__bool FLAC__stream_encoder_set_metadata_callback(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderMetadataCallback value);
 700
 701 /** Set the client data to be passed back to callbacks.
 702  *  This value will be supplied to callbacks in their \a client_data
 703  *  argument.
 704  *
 705  * \default \c NULL
 706  * \param  encoder  An encoder instance to set.
 707  * \param  value    See above.
 708  * \assert
 709  *    \code encoder != NULL \endcode
 710  * \retval FLAC__bool
 711  *    \c false if the encoder is already initialized, else \c true.
 712  */
 713 FLAC__bool FLAC__stream_encoder_set_client_data(FLAC__StreamEncoder *encoder, void *value);
 714
 715 /** Get the current encoder state.
 716  *
 717  * \param  encoder  An encoder instance to query.
 718  * \assert
 719  *    \code encoder != NULL \endcode
 720  * \retval FLAC__StreamEncoderState
 721  *    The current encoder state.
 722  */
 723 FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder);
 724
 725 /** Get the state of the verify stream decoder.
 726  *  Useful when the stream encoder state is
 727  *  \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR.
 728  *
 729  * \param  encoder  An encoder instance to query.
 730  * \assert
 731  *    \code encoder != NULL \endcode
 732  * \retval FLAC__StreamDecoderState
 733  *    The verify stream decoder state.
 734  */
 735 FLAC__StreamDecoderState FLAC__stream_encoder_get_verify_decoder_state(const FLAC__StreamEncoder *encoder);
 736
 737 /** Get relevant values about the nature of a verify decoder error.
 738  *  Useful when the stream encoder state is
 739  *  \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR.  The arguments should
 740  *  be addresses in which the stats will be returned, or NULL if value
 741  *  is not desired.
 742  *
 743  * \param  encoder  An encoder instance to query.
 744  * \param  absolute_sample  The absolute sample number of the mismatch.
 745  * \param  frame_number  The number of the frame in which the mismatch occurred.
 746  * \param  channel       The channel in which the mismatch occurred.
 747  * \param  sample        The number of the sample (relative to the frame) in
 748  *                       which the mismatch occurred.
 749  * \param  expected      The expected value for the sample in question.
 750  * \param  got           The actual value returned by the decoder.
 751  * \assert
 752  *    \code encoder != NULL \endcode
 753  */
 754 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);
 755
 756 /** Get the "verify" flag.
 757  *
 758  * \param  encoder  An encoder instance to query.
 759  * \assert
 760  *    \code encoder != NULL \endcode
 761  * \retval FLAC__bool
 762  *    See FLAC__stream_encoder_set_verify().
 763  */
 764 FLAC__bool FLAC__stream_encoder_get_verify(const FLAC__StreamEncoder *encoder);
 765
 766 /** Get the "streamable subset" flag.
 767  *
 768  * \param  encoder  An encoder instance to query.
 769  * \assert
 770  *    \code encoder != NULL \endcode
 771  * \retval FLAC__bool
 772  *    See FLAC__stream_encoder_set_streamable_subset().
 773  */
 774 FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder);
 775
 776 /** Get the "mid/side stereo coding" flag.
 777  *
 778  * \param  encoder  An encoder instance to query.
 779  * \assert
 780  *    \code encoder != NULL \endcode
 781  * \retval FLAC__bool
 782  *    See FLAC__stream_encoder_get_do_mid_side_stereo().
 783  */
 784 FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder);
 785
 786 /** Get the "adaptive mid/side switching" flag.
 787  *
 788  * \param  encoder  An encoder instance to query.
 789  * \assert
 790  *    \code encoder != NULL \endcode
 791  * \retval FLAC__bool
 792  *    See FLAC__stream_encoder_set_loose_mid_side_stereo().
 793  */
 794 FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder);
 795
 796 /** Get the number of input channels being processed.
 797  *
 798  * \param  encoder  An encoder instance to query.
 799  * \assert
 800  *    \code encoder != NULL \endcode
 801  * \retval unsigned
 802  *    See FLAC__stream_encoder_set_channels().
 803  */
 804 unsigned FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder);
 805
 806 /** Get the input sample resolution setting.
 807  *
 808  * \param  encoder  An encoder instance to query.
 809  * \assert
 810  *    \code encoder != NULL \endcode
 811  * \retval unsigned
 812  *    See FLAC__stream_encoder_set_bits_per_sample().
 813  */
 814 unsigned FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder);
 815
 816 /** Get the input sample rate setting.
 817  *
 818  * \param  encoder  An encoder instance to query.
 819  * \assert
 820  *    \code encoder != NULL \endcode
 821  * \retval unsigned
 822  *    See FLAC__stream_encoder_set_sample_rate().
 823  */
 824 unsigned FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder);
 825
 826 /** Get the blocksize setting.
 827  *
 828  * \param  encoder  An encoder instance to query.
 829  * \assert
 830  *    \code encoder != NULL \endcode
 831  * \retval unsigned
 832  *    See FLAC__stream_encoder_set_blocksize().
 833  */
 834 unsigned FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder);
 835
 836 /** Get the maximum LPC order setting.
 837  *
 838  * \param  encoder  An encoder instance to query.
 839  * \assert
 840  *    \code encoder != NULL \endcode
 841  * \retval unsigned
 842  *    See FLAC__stream_encoder_set_max_lpc_order().
 843  */
 844 unsigned FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder);
 845
 846 /** Get the quantized linear predictor coefficient precision setting.
 847  *
 848  * \param  encoder  An encoder instance to query.
 849  * \assert
 850  *    \code encoder != NULL \endcode
 851  * \retval unsigned
 852  *    See FLAC__stream_encoder_set_qlp_coeff_precision().
 853  */
 854 unsigned FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder);
 855
 856 /** Get the qlp coefficient precision search flag.
 857  *
 858  * \param  encoder  An encoder instance to query.
 859  * \assert
 860  *    \code encoder != NULL \endcode
 861  * \retval FLAC__bool
 862  *    See FLAC__stream_encoder_set_do_qlp_coeff_prec_search().
 863  */
 864 FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder);
 865
 866 /** Get the "escape coding" flag.
 867  *
 868  * \param  encoder  An encoder instance to query.
 869  * \assert
 870  *    \code encoder != NULL \endcode
 871  * \retval FLAC__bool
 872  *    See FLAC__stream_encoder_set_do_escape_coding().
 873  */
 874 FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder);
 875
 876 /** Get the exhaustive model search flag.
 877  *
 878  * \param  encoder  An encoder instance to query.
 879  * \assert
 880  *    \code encoder != NULL \endcode
 881  * \retval FLAC__bool
 882  *    See FLAC__stream_encoder_set_do_exhaustive_model_search().
 883  */
 884 FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder);
 885
 886 /** Get the minimum residual partition order setting.
 887  *
 888  * \param  encoder  An encoder instance to query.
 889  * \assert
 890  *    \code encoder != NULL \endcode
 891  * \retval unsigned
 892  *    See FLAC__stream_encoder_set_min_residual_partition_order().
 893  */
 894 unsigned FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder);
 895
 896 /** Get maximum residual partition order setting.
 897  *
 898  * \param  encoder  An encoder instance to query.
 899  * \assert
 900  *    \code encoder != NULL \endcode
 901  * \retval unsigned
 902  *    See FLAC__stream_encoder_set_max_residual_partition_order().
 903  */
 904 unsigned FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder);
 905
 906 /** Get the Rice parameter search distance setting.
 907  *
 908  * \param  encoder  An encoder instance to query.
 909  * \assert
 910  *    \code encoder != NULL \endcode
 911  * \retval unsigned
 912  *    See FLAC__stream_encoder_set_rice_parameter_search_dist().
 913  */
 914 unsigned FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder);
 915
 916 /** Get the previously set estimate of the total samples to be encoded.
 917  *  The encoder merely mimics back the value given to
 918  *  FLAC__stream_encoder_set_total_samples_estimate() since it has no
 919  *  other way of knowing how many samples the user will encode.
 920  *
 921  * \param  encoder  An encoder instance to set.
 922  * \assert
 923  *    \code encoder != NULL \endcode
 924  * \retval FLAC__uint64
 925  *    See FLAC__stream_encoder_get_total_samples_estimate().
 926  */
 927 FLAC__uint64 FLAC__stream_encoder_get_total_samples_estimate(const FLAC__StreamEncoder *encoder);
 928
 929 /** Initialize the encoder instance.
 930  *  Should be called after FLAC__stream_encoder_new() and
 931  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
 932  *  or FLAC__stream_encoder_process_interleaved().  Will set and return
 933  *  the encoder state, which will be FLAC__STREAM_ENCODER_OK if
 934  *  initialization succeeded.
 935  *
 936  *  The call to FLAC__stream_encoder_init() currently will also immediately
 937  *  call the write callback several times, once with the \c fLaC signature,
 938  *  and once for each encoded metadata block.
 939  *
 940  * \param  encoder  An uninitialized encoder instance.
 941  * \assert
 942  *    \code encoder != NULL \endcode
 943  * \retval FLAC__StreamEncoderState
 944  *    \c FLAC__STREAM_ENCODER_OK if initialization was successful; see
 945  *    FLAC__StreamEncoderState for the meanings of other return values.
 946  */
 947 FLAC__StreamEncoderState FLAC__stream_encoder_init(FLAC__StreamEncoder *encoder);
 948
 949 /** Finish the encoding process.
 950  *  Flushes the encoding buffer, releases resources, resets the encoder
 951  *  settings to their defaults, and returns the encoder state to
 952  *  FLAC__STREAM_ENCODER_UNINITIALIZED.  Note that this can generate
 953  *  one or more write callbacks before returning, and will generate
 954  *  a metadata callback.
 955  *
 956  *  In the event of a prematurely-terminated encode, it is not strictly
 957  *  necessary to call this immediately before FLAC__stream_encoder_delete()
 958  *  but it is good practice to match every FLAC__stream_encoder_init()
 959  *  with a FLAC__stream_encoder_finish().
 960  *
 961  * \param  encoder  An uninitialized encoder instance.
 962  * \assert
 963  *    \code encoder != NULL \endcode
 964  */
 965 void FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder);
 966
 967 /** Submit data for encoding.
 968  *  This version allows you to supply the input data via an array of
 969  *  pointers, each pointer pointing to an array of \a samples samples
 970  *  representing one channel.  The samples need not be block-aligned,
 971  *  but each channel should have the same number of samples.
 972  *
 973  * \param  encoder  An initialized encoder instance in the OK state.
 974  * \param  buffer   An array of pointers to each channel's signal.
 975  * \param  samples  The number of samples in one channel.
 976  * \assert
 977  *    \code encoder != NULL \endcode
 978  *    \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
 979  * \retval FLAC__bool
 980  *    \c true if successful, else \c false; in this case, check the
 981  *    encoder state with FLAC__stream_encoder_get_state() to see what
 982  *    went wrong.
 983  */
 984 FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples);
 985
 986 /** Submit data for encoding.
 987  *  This version allows you to supply the input data where the channels
 988  *  are interleaved into a single array (i.e. channel0_sample0,
 989  *  channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
 990  *  The samples need not be block-aligned but they must be
 991  *  sample-aligned, i.e. the first value should be channel0_sample0
 992  *  and the last value channelN_sampleM.
 993  *
 994  * \param  encoder  An initialized encoder instance in the OK state.
 995  * \param  buffer   An array of channel-interleaved data (see above).
 996  * \param  samples  The number of samples in one channel, the same as for
 997  *                  FLAC__stream_encoder_process().  For example, if
 998  *                  encoding two channels, \c 1000 \a samples corresponds
 999  *                  to a \a buffer of 2000 values.
1000  * \assert
1001  *    \code encoder != NULL \endcode
1002  *    \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
1003  * \retval FLAC__bool
1004  *    \c true if successful, else \c false; in this case, check the
1005  *    encoder state with FLAC__stream_encoder_get_state() to see what
1006  *    went wrong.
1007  */
1008 FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples);
1009
1010 /* \} */
1011
1012 #ifdef __cplusplus
1013 }
1014 #endif
1015
1016 #endif