FLAC  1.3.1
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
FLAC::Encoder::File Class Reference

#include <encoder.h>

Inheritance diagram for FLAC::Encoder::File:
FLAC::Encoder::Stream

Public Member Functions

virtual
::FLAC__StreamEncoderInitStatus 
init (FILE *file)
 
virtual
::FLAC__StreamEncoderInitStatus 
init (const char *filename)
 
virtual
::FLAC__StreamEncoderInitStatus 
init (const std::string &filename)
 
virtual
::FLAC__StreamEncoderInitStatus 
init_ogg (FILE *file)
 
virtual
::FLAC__StreamEncoderInitStatus 
init_ogg (const char *filename)
 
virtual
::FLAC__StreamEncoderInitStatus 
init_ogg (const std::string &filename)
 
virtual bool set_ogg_serial_number (long value)
 
virtual bool set_verify (bool value)
 
virtual bool set_streamable_subset (bool value)
 
virtual bool set_channels (unsigned value)
 
virtual bool set_bits_per_sample (unsigned value)
 
virtual bool set_sample_rate (unsigned value)
 
virtual bool set_compression_level (unsigned value)
 
virtual bool set_blocksize (unsigned value)
 
virtual bool set_do_mid_side_stereo (bool value)
 
virtual bool set_loose_mid_side_stereo (bool value)
 
virtual bool set_apodization (const char *specification)
 
virtual bool set_max_lpc_order (unsigned value)
 
virtual bool set_qlp_coeff_precision (unsigned value)
 
virtual bool set_do_qlp_coeff_prec_search (bool value)
 
virtual bool set_do_escape_coding (bool value)
 
virtual bool set_do_exhaustive_model_search (bool value)
 
virtual bool set_min_residual_partition_order (unsigned value)
 
virtual bool set_max_residual_partition_order (unsigned value)
 
virtual bool set_rice_parameter_search_dist (unsigned value)
 
virtual bool set_total_samples_estimate (FLAC__uint64 value)
 
virtual bool set_metadata (::FLAC__StreamMetadata **metadata, unsigned num_blocks)
 
virtual bool set_metadata (FLAC::Metadata::Prototype **metadata, unsigned num_blocks)
 
State get_state () const
 
virtual Decoder::Stream::State get_verify_decoder_state () const
 
virtual void get_verify_decoder_error_stats (FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got)
 
virtual bool get_verify () const
 
virtual bool get_streamable_subset () const
 
virtual bool get_do_mid_side_stereo () const
 
virtual bool get_loose_mid_side_stereo () const
 
virtual unsigned get_channels () const
 
virtual unsigned get_bits_per_sample () const
 
virtual unsigned get_sample_rate () const
 
virtual unsigned get_blocksize () const
 
virtual unsigned get_max_lpc_order () const
 
virtual unsigned get_qlp_coeff_precision () const
 
virtual bool get_do_qlp_coeff_prec_search () const
 
virtual bool get_do_escape_coding () const
 
virtual bool get_do_exhaustive_model_search () const
 
virtual unsigned get_min_residual_partition_order () const
 
virtual unsigned get_max_residual_partition_order () const
 
virtual unsigned get_rice_parameter_search_dist () const
 
virtual FLAC__uint64 get_total_samples_estimate () const
 
virtual
::FLAC__StreamEncoderInitStatus 
init ()
 
virtual
::FLAC__StreamEncoderInitStatus 
init_ogg ()
 
virtual bool finish ()
 
virtual bool process (const FLAC__int32 *const buffer[], unsigned samples)
 
virtual bool process_interleaved (const FLAC__int32 buffer[], unsigned samples)
 
virtual bool is_valid () const
 
 operator bool () const
 

Protected Member Functions

virtual void progress_callback (FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate)
 
virtual
::FLAC__StreamEncoderWriteStatus 
write_callback (const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame)
 
virtual
::FLAC__StreamEncoderReadStatus 
read_callback (FLAC__byte buffer[], size_t *bytes)
 
virtual
::FLAC__StreamEncoderSeekStatus 
seek_callback (FLAC__uint64 absolute_byte_offset)
 
virtual
::FLAC__StreamEncoderTellStatus 
tell_callback (FLAC__uint64 *absolute_byte_offset)
 
virtual void metadata_callback (const ::FLAC__StreamMetadata *metadata)
 

Static Protected Member Functions

::FLAC__StreamEncoderReadStatus read_callback_ (const ::FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
 
::FLAC__StreamEncoderWriteStatus write_callback_ (const ::FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame, void *client_data)
 
::FLAC__StreamEncoderSeekStatus seek_callback_ (const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)
 
::FLAC__StreamEncoderTellStatus tell_callback_ (const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)
 
static void metadata_callback_ (const ::FLAC__StreamEncoder *encoder, const ::FLAC__StreamMetadata *metadata, void *client_data)
 

Protected Attributes

::FLAC__StreamEncoderencoder_
 

Detailed Description

This class wraps the FLAC__StreamEncoder. If you are not encoding to a file, you may need to use FLAC::Encoder::Stream.

The usage of this class is similar to FLAC__StreamEncoder, except instead of providing callbacks to FLAC__stream_encoder_init*_FILE() or FLAC__stream_encoder_init*_file(), you will inherit from this class and override the virtual callback functions with your own implementations, then call init() or init_ogg(). The rest of the calls work the same as in the C layer.

There are no mandatory callbacks; all the callbacks from FLAC::Encoder::Stream are implemented here fully and support full post-encode STREAMINFO and SEEKTABLE updating. There is only an optional progress callback which you may override to get periodic reports on the progress of the encode.

Member Function Documentation

virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::File::init ( FILE *  file)
virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::File::init ( const char *  filename)
virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::File::init ( const std::string &  filename)
virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::File::init_ogg ( FILE *  file)
virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::File::init_ogg ( const char *  filename)
virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::File::init_ogg ( const std::string &  filename)
virtual void FLAC::Encoder::File::progress_callback ( FLAC__uint64  bytes_written,
FLAC__uint64  samples_written,
unsigned  frames_written,
unsigned  total_frames_estimate 
)
protectedvirtual

See FLAC__StreamEncoderProgressCallback.

virtual ::FLAC__StreamEncoderWriteStatus FLAC::Encoder::File::write_callback ( const FLAC__byte  buffer[],
size_t  bytes,
unsigned  samples,
unsigned  current_frame 
)
protectedvirtual

This is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied internally by the C layer.

Implements FLAC::Encoder::Stream.

virtual bool FLAC::Encoder::Stream::is_valid ( ) const
virtualinherited

Call after construction to check the that the object was created successfully. If not, use get_state() to find out why not.

FLAC::Encoder::Stream::operator bool ( ) const
inlineinherited
virtual bool FLAC::Encoder::Stream::set_ogg_serial_number ( long  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_verify ( bool  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_streamable_subset ( bool  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_channels ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_bits_per_sample ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_sample_rate ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_compression_level ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_blocksize ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_do_mid_side_stereo ( bool  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_loose_mid_side_stereo ( bool  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_apodization ( const char *  specification)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_max_lpc_order ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_qlp_coeff_precision ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_do_qlp_coeff_prec_search ( bool  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_do_escape_coding ( bool  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_do_exhaustive_model_search ( bool  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_min_residual_partition_order ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_max_residual_partition_order ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_rice_parameter_search_dist ( unsigned  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_total_samples_estimate ( FLAC__uint64  value)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_metadata ( ::FLAC__StreamMetadata **  metadata,
unsigned  num_blocks 
)
virtualinherited
virtual bool FLAC::Encoder::Stream::set_metadata ( FLAC::Metadata::Prototype **  metadata,
unsigned  num_blocks 
)
virtualinherited
State FLAC::Encoder::Stream::get_state ( ) const
inherited
virtual Decoder::Stream::State FLAC::Encoder::Stream::get_verify_decoder_state ( ) const
virtualinherited
virtual void FLAC::Encoder::Stream::get_verify_decoder_error_stats ( FLAC__uint64 *  absolute_sample,
unsigned *  frame_number,
unsigned *  channel,
unsigned *  sample,
FLAC__int32 *  expected,
FLAC__int32 *  got 
)
virtualinherited
virtual bool FLAC::Encoder::Stream::get_verify ( ) const
virtualinherited
virtual bool FLAC::Encoder::Stream::get_streamable_subset ( ) const
virtualinherited
virtual bool FLAC::Encoder::Stream::get_do_mid_side_stereo ( ) const
virtualinherited
virtual bool FLAC::Encoder::Stream::get_loose_mid_side_stereo ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_channels ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_bits_per_sample ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_sample_rate ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_blocksize ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_max_lpc_order ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_qlp_coeff_precision ( ) const
virtualinherited
virtual bool FLAC::Encoder::Stream::get_do_qlp_coeff_prec_search ( ) const
virtualinherited
virtual bool FLAC::Encoder::Stream::get_do_escape_coding ( ) const
virtualinherited
virtual bool FLAC::Encoder::Stream::get_do_exhaustive_model_search ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_min_residual_partition_order ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_max_residual_partition_order ( ) const
virtualinherited
virtual unsigned FLAC::Encoder::Stream::get_rice_parameter_search_dist ( ) const
virtualinherited
virtual FLAC__uint64 FLAC::Encoder::Stream::get_total_samples_estimate ( ) const
virtualinherited
virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::Stream::init ( )
inherited
virtual ::FLAC__StreamEncoderInitStatus FLAC::Encoder::Stream::init_ogg ( )
inherited
virtual bool FLAC::Encoder::Stream::finish ( )
virtualinherited
virtual bool FLAC::Encoder::Stream::process ( const FLAC__int32 *const  buffer[],
unsigned  samples 
)
virtualinherited
virtual bool FLAC::Encoder::Stream::process_interleaved ( const FLAC__int32  buffer[],
unsigned  samples 
)
virtualinherited
virtual ::FLAC__StreamEncoderReadStatus FLAC::Encoder::Stream::read_callback ( FLAC__byte  buffer[],
size_t *  bytes 
)
protectedinherited

See FLAC__StreamEncoderReadCallback.

virtual ::FLAC__StreamEncoderSeekStatus FLAC::Encoder::Stream::seek_callback ( FLAC__uint64  absolute_byte_offset)
protectedinherited

See FLAC__StreamEncoderSeekCallback.

virtual ::FLAC__StreamEncoderTellStatus FLAC::Encoder::Stream::tell_callback ( FLAC__uint64 *  absolute_byte_offset)
protectedinherited

See FLAC__StreamEncoderTellCallback.

virtual void FLAC::Encoder::Stream::metadata_callback ( const ::FLAC__StreamMetadata metadata)
protectedvirtualinherited

See FLAC__StreamEncoderMetadataCallback.


The documentation for this class was generated from the following file: