FLAC 1.5.0
Free Lossless Audio Codec
FLAC::Decoder::File Class Referenceabstract

#include <decoder.h>

Inheritance diagram for FLAC::Decoder::File:
FLAC::Decoder::Stream

Public Member Functions

virtual::FLAC__StreamDecoderInitStatus init (FILE *file)
virtual::FLAC__StreamDecoderInitStatus init (const char *filename)
virtual::FLAC__StreamDecoderInitStatus init (const std::string &filename)
virtual::FLAC__StreamDecoderInitStatus init_ogg (FILE *file)
virtual::FLAC__StreamDecoderInitStatus init_ogg (const char *filename)
virtual::FLAC__StreamDecoderInitStatus init_ogg (const std::string &filename)
virtual::FLAC__StreamDecoderInitStatus init ()
virtual::FLAC__StreamDecoderInitStatus init_ogg ()
virtual bool is_valid () const
 operator bool () const
virtual bool set_ogg_serial_number (long value)
virtual bool set_decode_chained_stream (bool value)
virtual bool set_md5_checking (bool value)
virtual bool set_metadata_respond (::FLAC__MetadataType type)
virtual bool set_metadata_respond_application (const FLAC__byte id[4])
virtual bool set_metadata_respond_all ()
virtual bool set_metadata_ignore (::FLAC__MetadataType type)
virtual bool set_metadata_ignore_application (const FLAC__byte id[4])
virtual bool set_metadata_ignore_all ()
State get_state () const
virtual bool get_decode_chained_stream () const
virtual bool get_md5_checking () const
virtual FLAC__uint64 get_total_samples () const
virtual FLAC__uint64 find_total_samples ()
virtual uint32_t get_channels () const
virtual::FLAC__ChannelAssignment get_channel_assignment () const
virtual uint32_t get_bits_per_sample () const
virtual uint32_t get_sample_rate () const
virtual uint32_t get_blocksize () const
virtual bool get_decode_position (FLAC__uint64 *position) const
virtual int32_t get_link_lengths (FLAC__uint64 **link_lengths)
virtual bool finish ()
virtual bool finish_link ()
virtual bool flush ()
virtual bool reset ()
virtual bool process_single ()
virtual bool process_until_end_of_metadata ()
virtual bool process_until_end_of_link ()
virtual bool process_until_end_of_stream ()
virtual bool skip_single_frame ()
virtual bool skip_single_link ()
virtual bool seek_absolute (FLAC__uint64 sample)

Protected Member Functions

virtual::FLAC__StreamDecoderReadStatus read_callback (FLAC__byte buffer[], size_t *bytes)
virtual::FLAC__StreamDecoderSeekStatus seek_callback (FLAC__uint64 absolute_byte_offset)
virtual::FLAC__StreamDecoderTellStatus tell_callback (FLAC__uint64 *absolute_byte_offset)
virtual::FLAC__StreamDecoderLengthStatus length_callback (FLAC__uint64 *stream_length)
virtual bool eof_callback ()
virtual::FLAC__StreamDecoderWriteStatus write_callback (const ::FLAC__Frame *frame, const FLAC__int32 *const buffer[])=0
virtual void metadata_callback (const ::FLAC__StreamMetadata *metadata)
virtual void error_callback (::FLAC__StreamDecoderErrorStatus status)=0

Static Protected Member Functions

::FLAC__StreamDecoderReadStatus read_callback_ (const ::FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
::FLAC__StreamDecoderSeekStatus seek_callback_ (const ::FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data)
::FLAC__StreamDecoderTellStatus tell_callback_ (const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data)
::FLAC__StreamDecoderLengthStatus length_callback_ (const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data)
static FLAC__bool eof_callback_ (const ::FLAC__StreamDecoder *decoder, void *client_data)
::FLAC__StreamDecoderWriteStatus write_callback_ (const ::FLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 *const buffer[], void *client_data)
static void metadata_callback_ (const ::FLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data)
static void error_callback_ (const ::FLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data)

Protected Attributes

::FLAC__StreamDecoderdecoder_

Detailed Description

This class wraps the FLAC__StreamDecoder. If you are not decoding from a file, you may need to use FLAC::Decoder::Stream.

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

Only the write, and error callbacks from FLAC::Decoder::Stream are mandatory. The others are optional; this class provides full working implementations for all other callbacks and supports seeking.

Member Function Documentation

◆ init() [1/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::File::init ( FILE * file)

◆ init() [2/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::File::init ( const char * filename)

◆ init() [3/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::File::init ( const std::string & filename)

◆ init_ogg() [1/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::File::init_ogg ( FILE * file)

◆ init_ogg() [2/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::File::init_ogg ( const char * filename)

◆ init_ogg() [3/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::File::init_ogg ( const std::string & filename)

◆ read_callback()

virtual::FLAC__StreamDecoderReadStatus FLAC::Decoder::File::read_callback ( FLAC__byte buffer[],
size_t * bytes )
protectedvirtual

◆ init() [4/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::Stream::init ( )

◆ init_ogg() [4/4]

virtual::FLAC__StreamDecoderInitStatus FLAC::Decoder::Stream::init_ogg ( )

◆ is_valid()

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

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

Referenced by operator bool().

◆ operator bool()

FLAC::Decoder::Stream::operator bool ( ) const
inlineinherited

See is_valid()

References is_valid().

◆ set_ogg_serial_number()

virtual bool FLAC::Decoder::Stream::set_ogg_serial_number ( long value)
virtualinherited

◆ set_decode_chained_stream()

virtual bool FLAC::Decoder::Stream::set_decode_chained_stream ( bool value)
virtualinherited

◆ set_md5_checking()

virtual bool FLAC::Decoder::Stream::set_md5_checking ( bool value)
virtualinherited

◆ set_metadata_respond()

virtual bool FLAC::Decoder::Stream::set_metadata_respond ( ::FLAC__MetadataType type)
virtualinherited

◆ set_metadata_respond_application()

virtual bool FLAC::Decoder::Stream::set_metadata_respond_application ( const FLAC__byte id[4])
virtualinherited

◆ set_metadata_respond_all()

virtual bool FLAC::Decoder::Stream::set_metadata_respond_all ( )
virtualinherited

◆ set_metadata_ignore()

virtual bool FLAC::Decoder::Stream::set_metadata_ignore ( ::FLAC__MetadataType type)
virtualinherited

◆ set_metadata_ignore_application()

virtual bool FLAC::Decoder::Stream::set_metadata_ignore_application ( const FLAC__byte id[4])
virtualinherited

◆ set_metadata_ignore_all()

virtual bool FLAC::Decoder::Stream::set_metadata_ignore_all ( )
virtualinherited

◆ get_state()

State FLAC::Decoder::Stream::get_state ( ) const
inherited

◆ get_decode_chained_stream()

virtual bool FLAC::Decoder::Stream::get_decode_chained_stream ( ) const
virtualinherited

◆ get_md5_checking()

virtual bool FLAC::Decoder::Stream::get_md5_checking ( ) const
virtualinherited

◆ get_total_samples()

virtual FLAC__uint64 FLAC::Decoder::Stream::get_total_samples ( ) const
virtualinherited

◆ find_total_samples()

virtual FLAC__uint64 FLAC::Decoder::Stream::find_total_samples ( )
virtualinherited

◆ get_channels()

virtual uint32_t FLAC::Decoder::Stream::get_channels ( ) const
virtualinherited

◆ get_channel_assignment()

virtual::FLAC__ChannelAssignment FLAC::Decoder::Stream::get_channel_assignment ( ) const
inherited

◆ get_bits_per_sample()

virtual uint32_t FLAC::Decoder::Stream::get_bits_per_sample ( ) const
virtualinherited

◆ get_sample_rate()

virtual uint32_t FLAC::Decoder::Stream::get_sample_rate ( ) const
virtualinherited

◆ get_blocksize()

virtual uint32_t FLAC::Decoder::Stream::get_blocksize ( ) const
virtualinherited

◆ get_decode_position()

virtual bool FLAC::Decoder::Stream::get_decode_position ( FLAC__uint64 * position) const
virtualinherited

◆ get_link_lengths()

virtual int32_t FLAC::Decoder::Stream::get_link_lengths ( FLAC__uint64 ** link_lengths)
virtualinherited

◆ finish()

virtual bool FLAC::Decoder::Stream::finish ( )
virtualinherited

◆ finish_link()

virtual bool FLAC::Decoder::Stream::finish_link ( )
virtualinherited

◆ flush()

virtual bool FLAC::Decoder::Stream::flush ( )
virtualinherited

◆ reset()

virtual bool FLAC::Decoder::Stream::reset ( )
virtualinherited

◆ process_single()

virtual bool FLAC::Decoder::Stream::process_single ( )
virtualinherited

◆ process_until_end_of_metadata()

virtual bool FLAC::Decoder::Stream::process_until_end_of_metadata ( )
virtualinherited

◆ process_until_end_of_link()

virtual bool FLAC::Decoder::Stream::process_until_end_of_link ( )
virtualinherited

◆ process_until_end_of_stream()

virtual bool FLAC::Decoder::Stream::process_until_end_of_stream ( )
virtualinherited

◆ skip_single_frame()

virtual bool FLAC::Decoder::Stream::skip_single_frame ( )
virtualinherited

◆ skip_single_link()

virtual bool FLAC::Decoder::Stream::skip_single_link ( )
virtualinherited

◆ seek_absolute()

virtual bool FLAC::Decoder::Stream::seek_absolute ( FLAC__uint64 sample)
virtualinherited

◆ seek_callback()

virtual::FLAC__StreamDecoderSeekStatus FLAC::Decoder::Stream::seek_callback ( FLAC__uint64 absolute_byte_offset)
protectedinherited

◆ tell_callback()

virtual::FLAC__StreamDecoderTellStatus FLAC::Decoder::Stream::tell_callback ( FLAC__uint64 * absolute_byte_offset)
protectedinherited

◆ length_callback()

virtual::FLAC__StreamDecoderLengthStatus FLAC::Decoder::Stream::length_callback ( FLAC__uint64 * stream_length)
protectedinherited

◆ eof_callback()

virtual bool FLAC::Decoder::Stream::eof_callback ( )
protectedvirtualinherited

◆ write_callback()

virtual::FLAC__StreamDecoderWriteStatus FLAC::Decoder::Stream::write_callback ( const ::FLAC__Frame * frame,
const FLAC__int32 *const buffer[] )
protectedpure virtualinherited

◆ metadata_callback()

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

◆ error_callback()

virtual void FLAC::Decoder::Stream::error_callback ( ::FLAC__StreamDecoderErrorStatus status)
protectedpure virtualinherited

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

Copyright (c) 2000-2009 Josh Coalson Copyright (c) 2011-2025 Xiph.Org Foundation