Chris@1: /* libFLAC++ - Free Lossless Audio Codec library
Chris@1:  * Copyright (C) 2002,2003,2004,2005,2006,2007  Josh Coalson
Chris@1:  *
Chris@1:  * Redistribution and use in source and binary forms, with or without
Chris@1:  * modification, are permitted provided that the following conditions
Chris@1:  * are met:
Chris@1:  *
Chris@1:  * - Redistributions of source code must retain the above copyright
Chris@1:  * notice, this list of conditions and the following disclaimer.
Chris@1:  *
Chris@1:  * - Redistributions in binary form must reproduce the above copyright
Chris@1:  * notice, this list of conditions and the following disclaimer in the
Chris@1:  * documentation and/or other materials provided with the distribution.
Chris@1:  *
Chris@1:  * - Neither the name of the Xiph.org Foundation nor the names of its
Chris@1:  * contributors may be used to endorse or promote products derived from
Chris@1:  * this software without specific prior written permission.
Chris@1:  *
Chris@1:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@1:  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@1:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@1:  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
Chris@1:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
Chris@1:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
Chris@1:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
Chris@1:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
Chris@1:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
Chris@1:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Chris@1:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@1:  */
Chris@1: 
Chris@1: #ifndef FLACPP__DECODER_H
Chris@1: #define FLACPP__DECODER_H
Chris@1: 
Chris@1: #include "export.h"
Chris@1: 
Chris@1: #include <string>
Chris@1: #include "FLAC/stream_decoder.h"
Chris@1: 
Chris@1: 
Chris@1: /** \file include/FLAC++/decoder.h
Chris@1:  *
Chris@1:  *  \brief
Chris@1:  *  This module contains the classes which implement the various
Chris@1:  *  decoders.
Chris@1:  *
Chris@1:  *  See the detailed documentation in the
Chris@1:  *  \link flacpp_decoder decoder \endlink module.
Chris@1:  */
Chris@1: 
Chris@1: /** \defgroup flacpp_decoder FLAC++/decoder.h: decoder classes
Chris@1:  *  \ingroup flacpp
Chris@1:  *
Chris@1:  *  \brief
Chris@1:  *  This module describes the decoder layers provided by libFLAC++.
Chris@1:  *
Chris@1:  * The libFLAC++ decoder classes are object wrappers around their
Chris@1:  * counterparts in libFLAC.  All decoding layers available in
Chris@1:  * libFLAC are also provided here.  The interface is very similar;
Chris@1:  * make sure to read the \link flac_decoder libFLAC decoder module \endlink.
Chris@1:  *
Chris@1:  * There are only two significant differences here.  First, instead of
Chris@1:  * passing in C function pointers for callbacks, you inherit from the
Chris@1:  * decoder class and provide implementations for the callbacks in your
Chris@1:  * derived class; because of this there is no need for a 'client_data'
Chris@1:  * property.
Chris@1:  *
Chris@1:  * Second, there are two stream decoder classes.  FLAC::Decoder::Stream
Chris@1:  * is used for the same cases that FLAC__stream_decoder_init_stream() /
Chris@1:  * FLAC__stream_decoder_init_ogg_stream() are used, and FLAC::Decoder::File
Chris@1:  * is used for the same cases that
Chris@1:  * FLAC__stream_decoder_init_FILE() and FLAC__stream_decoder_init_file() /
Chris@1:  * FLAC__stream_decoder_init_ogg_FILE() and FLAC__stream_decoder_init_ogg_file()
Chris@1:  * are used.
Chris@1:  */
Chris@1: 
Chris@1: namespace FLAC {
Chris@1: 	namespace Decoder {
Chris@1: 
Chris@1: 		/** \ingroup flacpp_decoder
Chris@1: 		 *  \brief
Chris@1: 		 *  This class wraps the ::FLAC__StreamDecoder.  If you are
Chris@1: 		 *  decoding from a file, FLAC::Decoder::File may be more
Chris@1: 		 *  convenient.
Chris@1: 		 *
Chris@1: 		 * The usage of this class is similar to FLAC__StreamDecoder,
Chris@1: 		 * except instead of providing callbacks to
Chris@1: 		 * FLAC__stream_decoder_init*_stream(), you will inherit from this
Chris@1: 		 * class and override the virtual callback functions with your
Chris@1: 		 * own implementations, then call init() or init_ogg().  The rest
Chris@1: 		 * of the calls work the same as in the C layer.
Chris@1: 		 *
Chris@1: 		 * Only the read, write, and error callbacks are mandatory.  The
Chris@1: 		 * others are optional; this class provides default
Chris@1: 		 * implementations that do nothing.  In order for seeking to work
Chris@1: 		 * you must overide seek_callback(), tell_callback(),
Chris@1: 		 * length_callback(), and eof_callback().
Chris@1: 		 */
Chris@1: 		class FLACPP_API Stream {
Chris@1: 		public:
Chris@1: 			/** This class is a wrapper around FLAC__StreamDecoderState.
Chris@1: 			 */
Chris@1: 			class FLACPP_API State {
Chris@1: 			public:
Chris@1: 				inline State(::FLAC__StreamDecoderState state): state_(state) { }
Chris@1: 				inline operator ::FLAC__StreamDecoderState() const { return state_; }
Chris@1: 				inline const char *as_cstring() const { return ::FLAC__StreamDecoderStateString[state_]; }
Chris@1: 				inline const char *resolved_as_cstring(const Stream &decoder) const { return ::FLAC__stream_decoder_get_resolved_state_string(decoder.decoder_); }
Chris@1: 			protected:
Chris@1: 				::FLAC__StreamDecoderState state_;
Chris@1: 			};
Chris@1: 
Chris@1: 			Stream();
Chris@1: 			virtual ~Stream();
Chris@1: 
Chris@1: 			//@{
Chris@1: 			/** Call after construction to check the that the object was created
Chris@1: 			 *  successfully.  If not, use get_state() to find out why not.
Chris@1: 			 */
Chris@1: 			virtual bool is_valid() const;
Chris@1: 			inline operator bool() const { return is_valid(); } ///< See is_valid()
Chris@1: 			//@}
Chris@1: 
Chris@1: 			virtual bool set_ogg_serial_number(long value);                        ///< See FLAC__stream_decoder_set_ogg_serial_number()
Chris@1: 			virtual bool set_md5_checking(bool value);                             ///< See FLAC__stream_decoder_set_md5_checking()
Chris@1: 			virtual bool set_metadata_respond(::FLAC__MetadataType type);          ///< See FLAC__stream_decoder_set_metadata_respond()
Chris@1: 			virtual bool set_metadata_respond_application(const FLAC__byte id[4]); ///< See FLAC__stream_decoder_set_metadata_respond_application()
Chris@1: 			virtual bool set_metadata_respond_all();                               ///< See FLAC__stream_decoder_set_metadata_respond_all()
Chris@1: 			virtual bool set_metadata_ignore(::FLAC__MetadataType type);           ///< See FLAC__stream_decoder_set_metadata_ignore()
Chris@1: 			virtual bool set_metadata_ignore_application(const FLAC__byte id[4]);  ///< See FLAC__stream_decoder_set_metadata_ignore_application()
Chris@1: 			virtual bool set_metadata_ignore_all();                                ///< See FLAC__stream_decoder_set_metadata_ignore_all()
Chris@1: 
Chris@1: 			/* get_state() is not virtual since we want subclasses to be able to return their own state */
Chris@1: 			State get_state() const;                                          ///< See FLAC__stream_decoder_get_state()
Chris@1: 			virtual bool get_md5_checking() const;                            ///< See FLAC__stream_decoder_get_md5_checking()
Chris@1: 			virtual FLAC__uint64 get_total_samples() const;                   ///< See FLAC__stream_decoder_get_total_samples()
Chris@1: 			virtual unsigned get_channels() const;                            ///< See FLAC__stream_decoder_get_channels()
Chris@1: 			virtual ::FLAC__ChannelAssignment get_channel_assignment() const; ///< See FLAC__stream_decoder_get_channel_assignment()
Chris@1: 			virtual unsigned get_bits_per_sample() const;                     ///< See FLAC__stream_decoder_get_bits_per_sample()
Chris@1: 			virtual unsigned get_sample_rate() const;                         ///< See FLAC__stream_decoder_get_sample_rate()
Chris@1: 			virtual unsigned get_blocksize() const;                           ///< See FLAC__stream_decoder_get_blocksize()
Chris@1: 			virtual bool get_decode_position(FLAC__uint64 *position) const;   ///< See FLAC__stream_decoder_get_decode_position()
Chris@1: 
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init();      ///< Seek FLAC__stream_decoder_init_stream()
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init_ogg();  ///< Seek FLAC__stream_decoder_init_ogg_stream()
Chris@1: 
Chris@1: 			virtual bool finish(); ///< See FLAC__stream_decoder_finish()
Chris@1: 
Chris@1: 			virtual bool flush(); ///< See FLAC__stream_decoder_flush()
Chris@1: 			virtual bool reset(); ///< See FLAC__stream_decoder_reset()
Chris@1: 
Chris@1: 			virtual bool process_single();                ///< See FLAC__stream_decoder_process_single()
Chris@1: 			virtual bool process_until_end_of_metadata(); ///< See FLAC__stream_decoder_process_until_end_of_metadata()
Chris@1: 			virtual bool process_until_end_of_stream();   ///< See FLAC__stream_decoder_process_until_end_of_stream()
Chris@1: 			virtual bool skip_single_frame();             ///< See FLAC__stream_decoder_skip_single_frame()
Chris@1: 
Chris@1: 			virtual bool seek_absolute(FLAC__uint64 sample); ///< See FLAC__stream_decoder_seek_absolute()
Chris@1: 		protected:
Chris@1: 			/// see FLAC__StreamDecoderReadCallback
Chris@1: 			virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes) = 0;
Chris@1: 
Chris@1: 			/// see FLAC__StreamDecoderSeekCallback
Chris@1: 			virtual ::FLAC__StreamDecoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
Chris@1: 
Chris@1: 			/// see FLAC__StreamDecoderTellCallback
Chris@1: 			virtual ::FLAC__StreamDecoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
Chris@1: 
Chris@1: 			/// see FLAC__StreamDecoderLengthCallback
Chris@1: 			virtual ::FLAC__StreamDecoderLengthStatus length_callback(FLAC__uint64 *stream_length);
Chris@1: 
Chris@1: 			/// see FLAC__StreamDecoderEofCallback
Chris@1: 			virtual bool eof_callback();
Chris@1: 
Chris@1: 			/// see FLAC__StreamDecoderWriteCallback
Chris@1: 			virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
Chris@1: 
Chris@1: 			/// see FLAC__StreamDecoderMetadataCallback
Chris@1: 			virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata);
Chris@1: 
Chris@1: 			/// see FLAC__StreamDecoderErrorCallback
Chris@1: 			virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
Chris@1: 
Chris@1: #if (defined _MSC_VER) || (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)
Chris@1: 			// lame hack: some MSVC/GCC versions can't see a protected decoder_ from nested State::resolved_as_cstring()
Chris@1: 			friend State;
Chris@1: #endif
Chris@1: 			::FLAC__StreamDecoder *decoder_;
Chris@1: 
Chris@1: 			static ::FLAC__StreamDecoderReadStatus read_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
Chris@1: 			static ::FLAC__StreamDecoderSeekStatus seek_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
Chris@1: 			static ::FLAC__StreamDecoderTellStatus tell_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
Chris@1: 			static ::FLAC__StreamDecoderLengthStatus length_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
Chris@1: 			static FLAC__bool eof_callback_(const ::FLAC__StreamDecoder *decoder, void *client_data);
Chris@1: 			static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
Chris@1: 			static void metadata_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
Chris@1: 			static void error_callback_(const ::FLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
Chris@1: 		private:
Chris@1: 			// Private and undefined so you can't use them:
Chris@1: 			Stream(const Stream &);
Chris@1: 			void operator=(const Stream &);
Chris@1: 		};
Chris@1: 
Chris@1: 		/** \ingroup flacpp_decoder
Chris@1: 		 *  \brief
Chris@1: 		 *  This class wraps the ::FLAC__StreamDecoder.  If you are
Chris@1: 		 *  not decoding from a file, you may need to use
Chris@1: 		 *  FLAC::Decoder::Stream.
Chris@1: 		 *
Chris@1: 		 * The usage of this class is similar to FLAC__StreamDecoder,
Chris@1: 		 * except instead of providing callbacks to
Chris@1: 		 * FLAC__stream_decoder_init*_FILE() or
Chris@1: 		 * FLAC__stream_decoder_init*_file(), you will inherit from this
Chris@1: 		 * class and override the virtual callback functions with your
Chris@1: 		 * own implementations, then call init() or init_off().  The rest
Chris@1: 		 * of the calls work the same as in the C layer.
Chris@1: 		 *
Chris@1: 		 * Only the write, and error callbacks from FLAC::Decoder::Stream
Chris@1: 		 * are mandatory.  The others are optional; this class provides
Chris@1: 		 * full working implementations for all other callbacks and
Chris@1: 		 * supports seeking.
Chris@1: 		 */
Chris@1: 		class FLACPP_API File: public Stream {
Chris@1: 		public:
Chris@1: 			File();
Chris@1: 			virtual ~File();
Chris@1: 
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init(FILE *file);                      ///< See FLAC__stream_decoder_init_FILE()
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init(const char *filename);            ///< See FLAC__stream_decoder_init_file()
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init(const std::string &filename);     ///< See FLAC__stream_decoder_init_file()
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init_ogg(FILE *file);                  ///< See FLAC__stream_decoder_init_ogg_FILE()
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init_ogg(const char *filename);        ///< See FLAC__stream_decoder_init_ogg_file()
Chris@1: 			virtual ::FLAC__StreamDecoderInitStatus init_ogg(const std::string &filename); ///< See FLAC__stream_decoder_init_ogg_file()
Chris@1: 		protected:
Chris@1: 			// this is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied internally by the C layer
Chris@1: 			virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
Chris@1: 		private:
Chris@1: 			// Private and undefined so you can't use them:
Chris@1: 			File(const File &);
Chris@1: 			void operator=(const File &);
Chris@1: 		};
Chris@1: 
Chris@1: 	}
Chris@1: }
Chris@1: 
Chris@1: #endif