include/FLAC++/decoder.h

   1 /* libFLAC++ - Free Lossless Audio Codec library
   2  * Copyright (C) 2002-2009  Josh Coalson
   3  * Copyright (C) 2011-2013  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 FLACPP__DECODER_H
  34 #define FLACPP__DECODER_H
  35
  36 #include "export.h"
  37
  38 #include <string>
  39 #include "FLAC/stream_decoder.h"
  40
  41
  42 /** \file include/FLAC++/decoder.h
  43  *
  44  *  \brief
  45  *  This module contains the classes which implement the various
  46  *  decoders.
  47  *
  48  *  See the detailed documentation in the
  49  *  \link flacpp_decoder decoder \endlink module.
  50  */
  51
  52 /** \defgroup flacpp_decoder FLAC++/decoder.h: decoder classes
  53  *  \ingroup flacpp
  54  *
  55  *  \brief
  56  *  This module describes the decoder layers provided by libFLAC++.
  57  *
  58  * The libFLAC++ decoder classes are object wrappers around their
  59  * counterparts in libFLAC.  All decoding layers available in
  60  * libFLAC are also provided here.  The interface is very similar;
  61  * make sure to read the \link flac_decoder libFLAC decoder module \endlink.
  62  *
  63  * There are only two significant differences here.  First, instead of
  64  * passing in C function pointers for callbacks, you inherit from the
  65  * decoder class and provide implementations for the callbacks in your
  66  * derived class; because of this there is no need for a 'client_data'
  67  * property.
  68  *
  69  * Second, there are two stream decoder classes.  FLAC::Decoder::Stream
  70  * is used for the same cases that FLAC__stream_decoder_init_stream() /
  71  * FLAC__stream_decoder_init_ogg_stream() are used, and FLAC::Decoder::File
  72  * is used for the same cases that
  73  * FLAC__stream_decoder_init_FILE() and FLAC__stream_decoder_init_file() /
  74  * FLAC__stream_decoder_init_ogg_FILE() and FLAC__stream_decoder_init_ogg_file()
  75  * are used.
  76  */
  77
  78 namespace FLAC {
  79         namespace Decoder {
  80
  81                 /** \ingroup flacpp_decoder
  82                  *  \brief
  83                  *  This class wraps the ::FLAC__StreamDecoder.  If you are
  84                  *  decoding from a file, FLAC::Decoder::File may be more
  85                  *  convenient.
  86                  *
  87                  * The usage of this class is similar to FLAC__StreamDecoder,
  88                  * except instead of providing callbacks to
  89                  * FLAC__stream_decoder_init*_stream(), you will inherit from this
  90                  * class and override the virtual callback functions with your
  91                  * own implementations, then call init() or init_ogg().  The rest
  92                  * of the calls work the same as in the C layer.
  93                  *
  94                  * Only the read, write, and error callbacks are mandatory.  The
  95                  * others are optional; this class provides default
  96                  * implementations that do nothing.  In order for seeking to work
  97                  * you must overide seek_callback(), tell_callback(),
  98                  * length_callback(), and eof_callback().
  99                  */
 100                 class FLACPP_API Stream {
 101                 public:
 102                         /** This class is a wrapper around FLAC__StreamDecoderState.
 103                          */
 104                         class FLACPP_API State {
 105                         public:
 106                                 inline State(::FLAC__StreamDecoderState state): state_(state) { }
 107                                 inline operator ::FLAC__StreamDecoderState() const { return state_; }
 108                                 inline const char *as_cstring() const { return ::FLAC__StreamDecoderStateString[state_]; }
 109                                 inline const char *resolved_as_cstring(const Stream &decoder) const { return ::FLAC__stream_decoder_get_resolved_state_string(decoder.decoder_); }
 110                         protected:
 111                                 ::FLAC__StreamDecoderState state_;
 112                         };
 113
 114                         Stream();
 115                         virtual ~Stream();
 116
 117                         //@{
 118                         /** Call after construction to check the that the object was created
 119                          *  successfully.  If not, use get_state() to find out why not.
 120                          */
 121                         virtual bool is_valid() const;
 122                         inline operator bool() const { return is_valid(); } ///< See is_valid()
 123                         //@}
 124
 125                         virtual bool set_ogg_serial_number(long value);                        ///< See FLAC__stream_decoder_set_ogg_serial_number()
 126                         virtual bool set_md5_checking(bool value);                             ///< See FLAC__stream_decoder_set_md5_checking()
 127                         virtual bool set_metadata_respond(::FLAC__MetadataType type);          ///< See FLAC__stream_decoder_set_metadata_respond()
 128                         virtual bool set_metadata_respond_application(const FLAC__byte id[4]); ///< See FLAC__stream_decoder_set_metadata_respond_application()
 129                         virtual bool set_metadata_respond_all();                               ///< See FLAC__stream_decoder_set_metadata_respond_all()
 130                         virtual bool set_metadata_ignore(::FLAC__MetadataType type);           ///< See FLAC__stream_decoder_set_metadata_ignore()
 131                         virtual bool set_metadata_ignore_application(const FLAC__byte id[4]);  ///< See FLAC__stream_decoder_set_metadata_ignore_application()
 132                         virtual bool set_metadata_ignore_all();                                ///< See FLAC__stream_decoder_set_metadata_ignore_all()
 133
 134                         /* get_state() is not virtual since we want subclasses to be able to return their own state */
 135                         State get_state() const;                                          ///< See FLAC__stream_decoder_get_state()
 136                         virtual bool get_md5_checking() const;                            ///< See FLAC__stream_decoder_get_md5_checking()
 137                         virtual FLAC__uint64 get_total_samples() const;                   ///< See FLAC__stream_decoder_get_total_samples()
 138                         virtual unsigned get_channels() const;                            ///< See FLAC__stream_decoder_get_channels()
 139                         virtual ::FLAC__ChannelAssignment get_channel_assignment() const; ///< See FLAC__stream_decoder_get_channel_assignment()
 140                         virtual unsigned get_bits_per_sample() const;                     ///< See FLAC__stream_decoder_get_bits_per_sample()
 141                         virtual unsigned get_sample_rate() const;                         ///< See FLAC__stream_decoder_get_sample_rate()
 142                         virtual unsigned get_blocksize() const;                           ///< See FLAC__stream_decoder_get_blocksize()
 143                         virtual bool get_decode_position(FLAC__uint64 *position) const;   ///< See FLAC__stream_decoder_get_decode_position()
 144
 145                         virtual ::FLAC__StreamDecoderInitStatus init();      ///< Seek FLAC__stream_decoder_init_stream()
 146                         virtual ::FLAC__StreamDecoderInitStatus init_ogg();  ///< Seek FLAC__stream_decoder_init_ogg_stream()
 147
 148                         virtual bool finish(); ///< See FLAC__stream_decoder_finish()
 149
 150                         virtual bool flush(); ///< See FLAC__stream_decoder_flush()
 151                         virtual bool reset(); ///< See FLAC__stream_decoder_reset()
 152
 153                         virtual bool process_single();                ///< See FLAC__stream_decoder_process_single()
 154                         virtual bool process_until_end_of_metadata(); ///< See FLAC__stream_decoder_process_until_end_of_metadata()
 155                         virtual bool process_until_end_of_stream();   ///< See FLAC__stream_decoder_process_until_end_of_stream()
 156                         virtual bool skip_single_frame();             ///< See FLAC__stream_decoder_skip_single_frame()
 157
 158                         virtual bool seek_absolute(FLAC__uint64 sample); ///< See FLAC__stream_decoder_seek_absolute()
 159                 protected:
 160                         /// see FLAC__StreamDecoderReadCallback
 161                         virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes) = 0;
 162
 163                         /// see FLAC__StreamDecoderSeekCallback
 164                         virtual ::FLAC__StreamDecoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
 165
 166                         /// see FLAC__StreamDecoderTellCallback
 167                         virtual ::FLAC__StreamDecoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
 168
 169                         /// see FLAC__StreamDecoderLengthCallback
 170                         virtual ::FLAC__StreamDecoderLengthStatus length_callback(FLAC__uint64 *stream_length);
 171
 172                         /// see FLAC__StreamDecoderEofCallback
 173                         virtual bool eof_callback();
 174
 175                         /// see FLAC__StreamDecoderWriteCallback
 176                         virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
 177
 178                         /// see FLAC__StreamDecoderMetadataCallback
 179                         virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata);
 180
 181                         /// see FLAC__StreamDecoderErrorCallback
 182                         virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
 183
 184 #if (defined _MSC_VER) || (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)
 185                         // lame hack: some MSVC/GCC versions can't see a protected decoder_ from nested State::resolved_as_cstring()
 186                         friend State;
 187 #endif
 188                         ::FLAC__StreamDecoder *decoder_;
 189
 190                         static ::FLAC__StreamDecoderReadStatus read_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
 191                         static ::FLAC__StreamDecoderSeekStatus seek_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
 192                         static ::FLAC__StreamDecoderTellStatus tell_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
 193                         static ::FLAC__StreamDecoderLengthStatus length_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
 194                         static FLAC__bool eof_callback_(const ::FLAC__StreamDecoder *decoder, void *client_data);
 195                         static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
 196                         static void metadata_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
 197                         static void error_callback_(const ::FLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
 198                 private:
 199                         // Private and undefined so you can't use them:
 200                         Stream(const Stream &);
 201                         void operator=(const Stream &);
 202                 };
 203
 204                 /** \ingroup flacpp_decoder
 205                  *  \brief
 206                  *  This class wraps the ::FLAC__StreamDecoder.  If you are
 207                  *  not decoding from a file, you may need to use
 208                  *  FLAC::Decoder::Stream.
 209                  *
 210                  * The usage of this class is similar to FLAC__StreamDecoder,
 211                  * except instead of providing callbacks to
 212                  * FLAC__stream_decoder_init*_FILE() or
 213                  * FLAC__stream_decoder_init*_file(), you will inherit from this
 214                  * class and override the virtual callback functions with your
 215                  * own implementations, then call init() or init_off().  The rest
 216                  * of the calls work the same as in the C layer.
 217                  *
 218                  * Only the write, and error callbacks from FLAC::Decoder::Stream
 219                  * are mandatory.  The others are optional; this class provides
 220                  * full working implementations for all other callbacks and
 221                  * supports seeking.
 222                  */
 223                 class FLACPP_API File: public Stream {
 224                 public:
 225                         File();
 226                         virtual ~File();
 227
 228                         virtual ::FLAC__StreamDecoderInitStatus init(FILE *file);                      ///< See FLAC__stream_decoder_init_FILE()
 229                         virtual ::FLAC__StreamDecoderInitStatus init(const char *filename);            ///< See FLAC__stream_decoder_init_file()
 230                         virtual ::FLAC__StreamDecoderInitStatus init(const std::string &filename);     ///< See FLAC__stream_decoder_init_file()
 231                         virtual ::FLAC__StreamDecoderInitStatus init_ogg(FILE *file);                  ///< See FLAC__stream_decoder_init_ogg_FILE()
 232                         virtual ::FLAC__StreamDecoderInitStatus init_ogg(const char *filename);        ///< See FLAC__stream_decoder_init_ogg_file()
 233                         virtual ::FLAC__StreamDecoderInitStatus init_ogg(const std::string &filename); ///< See FLAC__stream_decoder_init_ogg_file()
 234                 protected:
 235                         // this is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied internally by the C layer
 236                         virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
 237                 private:
 238                         // Private and undefined so you can't use them:
 239                         File(const File &);
 240                         void operator=(const File &);
 241                 };
 242
 243         }
 244 }
 245
 246 #endif