FLAC 1.3.4
Free Lossless Audio Codec
stream_encoder.h
Go to the documentation of this file.
1/* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000-2009 Josh Coalson
3 * Copyright (C) 2011-2016 Xiph.Org Foundation
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * - Neither the name of the Xiph.org Foundation nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33#ifndef FLAC__STREAM_ENCODER_H
34#define FLAC__STREAM_ENCODER_H
35
36#include <stdio.h> /* for FILE */
37#include "export.h"
38#include "format.h"
39#include "stream_decoder.h"
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45
241typedef enum {
242
282
288extern FLAC_API const char * const FLAC__StreamEncoderStateString[];
289
290
293typedef enum {
294
352
358extern FLAC_API const char * const FLAC__StreamEncoderInitStatusString[];
359
360
363typedef enum {
364
378
384extern FLAC_API const char * const FLAC__StreamEncoderReadStatusString[];
385
386
389typedef enum {
390
398
404extern FLAC_API const char * const FLAC__StreamEncoderWriteStatusString[];
405
406
409typedef enum {
410
421
427extern FLAC_API const char * const FLAC__StreamEncoderSeekStatusString[];
428
429
432typedef enum {
433
444
450extern FLAC_API const char * const FLAC__StreamEncoderTellStatusString[];
451
452
453/***********************************************************************
454 *
455 * class FLAC__StreamEncoder
456 *
457 ***********************************************************************/
458
459struct FLAC__StreamEncoderProtected;
460struct FLAC__StreamEncoderPrivate;
465typedef struct {
466 struct FLAC__StreamEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */
467 struct FLAC__StreamEncoderPrivate *private_; /* avoid the C++ keyword 'private' */
469
519typedef FLAC__StreamEncoderReadStatus (*FLAC__StreamEncoderReadCallback)(const FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
520
557typedef FLAC__StreamEncoderWriteStatus (*FLAC__StreamEncoderWriteCallback)(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void *client_data);
558
591typedef FLAC__StreamEncoderSeekStatus (*FLAC__StreamEncoderSeekCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
592
636typedef FLAC__StreamEncoderTellStatus (*FLAC__StreamEncoderTellCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
637
655typedef void (*FLAC__StreamEncoderMetadataCallback)(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data);
656
678typedef void (*FLAC__StreamEncoderProgressCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate, void *client_data);
679
680
681/***********************************************************************
682 *
683 * Class constructor/destructor
684 *
685 ***********************************************************************/
686
695
703
704
705/***********************************************************************
706 *
707 * Public class method prototypes
708 *
709 ***********************************************************************/
710
728FLAC_API FLAC__bool FLAC__stream_encoder_set_ogg_serial_number(FLAC__StreamEncoder *encoder, long serial_number);
729
744FLAC_API FLAC__bool FLAC__stream_encoder_set_verify(FLAC__StreamEncoder *encoder, FLAC__bool value);
745
762FLAC_API FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value);
763
774FLAC_API FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, uint32_t value);
775
790FLAC_API FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, uint32_t value);
791
802FLAC_API FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, uint32_t value);
803
865FLAC_API FLAC__bool FLAC__stream_encoder_set_compression_level(FLAC__StreamEncoder *encoder, uint32_t value);
866
880FLAC_API FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, uint32_t value);
881
894FLAC_API FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
895
910FLAC_API FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
911
976FLAC_API FLAC__bool FLAC__stream_encoder_set_apodization(FLAC__StreamEncoder *encoder, const char *specification);
977
988FLAC_API FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, uint32_t value);
989
1006FLAC_API FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, uint32_t value);
1007
1020FLAC_API FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
1021
1032FLAC_API FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value);
1033
1046FLAC_API FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
1047
1070
1093
1105
1120FLAC_API FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value);
1121
1203FLAC_API FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, uint32_t num_blocks);
1204
1214
1226
1239
1257FLAC_API void FLAC__stream_encoder_get_verify_decoder_error_stats(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_sample, uint32_t *frame_number, uint32_t *channel, uint32_t *sample, FLAC__int32 *expected, FLAC__int32 *got);
1258
1267FLAC_API FLAC__bool FLAC__stream_encoder_get_verify(const FLAC__StreamEncoder *encoder);
1268
1278
1288
1298
1308
1318
1328
1338
1348
1358
1368
1378
1388
1398
1408
1418
1431
1494
1562
1597
1632
1663FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_file(FLAC__StreamEncoder *encoder, const char *filename, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data);
1664
1695FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_file(FLAC__StreamEncoder *encoder, const char *filename, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data);
1696
1724
1750FLAC_API FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], uint32_t samples);
1751
1782FLAC_API FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], uint32_t samples);
1783
1784/* \} */
1785
1786#ifdef __cplusplus
1787}
1788#endif
1789
1790#endif
This module contains #defines and symbols for exporting function calls, and providing version informa...
This module contains structure definitions for the representation of FLAC format components in memory...
FLAC__StreamDecoderState
Definition: stream_decoder.h:202
FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value)
FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder)
void(* FLAC__StreamEncoderMetadataCallback)(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data)
Definition: stream_encoder.h:655
FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder)
const char *const FLAC__StreamEncoderInitStatusString[]
FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_FILE(FLAC__StreamEncoder *encoder, FILE *file, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data)
const char *const FLAC__StreamEncoderStateString[]
FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder)
FLAC__StreamEncoder * FLAC__stream_encoder_new(void)
const char *const FLAC__StreamEncoderReadStatusString[]
uint32_t FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, uint32_t value)
FLAC__StreamEncoderReadStatus(* FLAC__StreamEncoderReadCallback)(const FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
Definition: stream_encoder.h:519
FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder)
void FLAC__stream_encoder_get_verify_decoder_error_stats(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_sample, uint32_t *frame_number, uint32_t *channel, uint32_t *sample, FLAC__int32 *expected, FLAC__int32 *got)
FLAC__StreamEncoderWriteStatus(* FLAC__StreamEncoderWriteCallback)(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void *client_data)
Definition: stream_encoder.h:557
FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, uint32_t value)
FLAC__StreamEncoderReadStatus
Definition: stream_encoder.h:363
FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value)
FLAC__StreamEncoderWriteStatus
Definition: stream_encoder.h:389
FLAC__StreamEncoderInitStatus
Definition: stream_encoder.h:293
FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value)
uint32_t FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder)
void(* FLAC__StreamEncoderProgressCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate, void *client_data)
Definition: stream_encoder.h:678
FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_file(FLAC__StreamEncoder *encoder, const char *filename, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data)
FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value)
uint32_t FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder)
FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_FILE(FLAC__StreamEncoder *encoder, FILE *file, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data)
uint32_t FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_set_apodization(FLAC__StreamEncoder *encoder, const char *specification)
FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder)
FLAC__StreamEncoderSeekStatus
Definition: stream_encoder.h:409
FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], uint32_t samples)
uint32_t FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder)
FLAC__StreamEncoderSeekStatus(* FLAC__StreamEncoderSeekCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)
Definition: stream_encoder.h:591
void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, uint32_t value)
FLAC__bool FLAC__stream_encoder_set_verify(FLAC__StreamEncoder *encoder, FLAC__bool value)
FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value)
FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder)
FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_stream(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderWriteCallback write_callback, FLAC__StreamEncoderSeekCallback seek_callback, FLAC__StreamEncoderTellCallback tell_callback, FLAC__StreamEncoderMetadataCallback metadata_callback, void *client_data)
FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, uint32_t num_blocks)
FLAC__StreamDecoderState FLAC__stream_encoder_get_verify_decoder_state(const FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 *const buffer[], uint32_t samples)
FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, uint32_t value)
uint32_t FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder)
FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_stream(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderReadCallback read_callback, FLAC__StreamEncoderWriteCallback write_callback, FLAC__StreamEncoderSeekCallback seek_callback, FLAC__StreamEncoderTellCallback tell_callback, FLAC__StreamEncoderMetadataCallback metadata_callback, void *client_data)
FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_file(FLAC__StreamEncoder *encoder, const char *filename, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data)
FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, uint32_t value)
FLAC__bool FLAC__stream_encoder_get_verify(const FLAC__StreamEncoder *encoder)
const char *const FLAC__StreamEncoderWriteStatusString[]
FLAC__uint64 FLAC__stream_encoder_get_total_samples_estimate(const FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, uint32_t value)
FLAC__bool FLAC__stream_encoder_set_compression_level(FLAC__StreamEncoder *encoder, uint32_t value)
FLAC__StreamEncoderTellStatus
Definition: stream_encoder.h:432
FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value)
FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, uint32_t value)
const char *const FLAC__StreamEncoderSeekStatusString[]
FLAC__StreamEncoderTellStatus(* FLAC__StreamEncoderTellCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)
Definition: stream_encoder.h:636
FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, uint32_t value)
FLAC__StreamEncoderState
Definition: stream_encoder.h:241
uint32_t FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, uint32_t value)
uint32_t FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder)
FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value)
FLAC__bool FLAC__stream_encoder_set_ogg_serial_number(FLAC__StreamEncoder *encoder, long serial_number)
uint32_t FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder)
const char *const FLAC__StreamEncoderTellStatusString[]
const char * FLAC__stream_encoder_get_resolved_state_string(const FLAC__StreamEncoder *encoder)
@ FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE
Definition: stream_encoder.h:365
@ FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM
Definition: stream_encoder.h:368
@ FLAC__STREAM_ENCODER_READ_STATUS_ABORT
Definition: stream_encoder.h:371
@ FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED
Definition: stream_encoder.h:374
@ FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR
Definition: stream_encoder.h:394
@ FLAC__STREAM_ENCODER_WRITE_STATUS_OK
Definition: stream_encoder.h:391
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS
Definition: stream_encoder.h:309
@ FLAC__STREAM_ENCODER_INIT_STATUS_OK
Definition: stream_encoder.h:295
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER
Definition: stream_encoder.h:324
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION
Definition: stream_encoder.h:327
@ FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER
Definition: stream_encoder.h:330
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE
Definition: stream_encoder.h:321
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE
Definition: stream_encoder.h:318
@ FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER
Definition: stream_encoder.h:301
@ FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR
Definition: stream_encoder.h:298
@ FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE
Definition: stream_encoder.h:333
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA
Definition: stream_encoder.h:336
@ FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED
Definition: stream_encoder.h:345
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS
Definition: stream_encoder.h:306
@ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE
Definition: stream_encoder.h:312
@ FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED
Definition: stream_encoder.h:417
@ FLAC__STREAM_ENCODER_SEEK_STATUS_OK
Definition: stream_encoder.h:411
@ FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR
Definition: stream_encoder.h:414
@ FLAC__STREAM_ENCODER_TELL_STATUS_OK
Definition: stream_encoder.h:434
@ FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED
Definition: stream_encoder.h:440
@ FLAC__STREAM_ENCODER_TELL_STATUS_ERROR
Definition: stream_encoder.h:437
@ FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA
Definition: stream_encoder.h:260
@ FLAC__STREAM_ENCODER_UNINITIALIZED
Definition: stream_encoder.h:246
@ FLAC__STREAM_ENCODER_FRAMING_ERROR
Definition: stream_encoder.h:273
@ FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR
Definition: stream_encoder.h:278
@ FLAC__STREAM_ENCODER_OK
Definition: stream_encoder.h:243
@ FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR
Definition: stream_encoder.h:255
@ FLAC__STREAM_ENCODER_CLIENT_ERROR
Definition: stream_encoder.h:265
@ FLAC__STREAM_ENCODER_OGG_ERROR
Definition: stream_encoder.h:252
@ FLAC__STREAM_ENCODER_IO_ERROR
Definition: stream_encoder.h:268
This module contains the functions which implement the stream decoder.
Definition: stream_encoder.h:465
Definition: format.h:834