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