include/FLAC++/decoder.h

   1 /* libFLAC++ - Free Lossless Audio Codec library
   2  * Copyright (C) 2002,2003  Josh Coalson
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * - Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * - Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  *
  15  * - Neither the name of the Xiph.org Foundation nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef FLACPP__DECODER_H
  33 #define FLACPP__DECODER_H
  34
  35 #include "export.h"
  36
  37 #include "FLAC/file_decoder.h"
  38 #include "FLAC/seekable_stream_decoder.h"
  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 three decoder layers provided by libFLAC++.
  57  *
  58  * The libFLAC++ decoder classes are object wrappers around their
  59  * counterparts in libFLAC.  All three 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  * The only real difference here is that instead of passing in C function
  64  * pointers for callbacks, you inherit from the decoder class and provide
  65  * implementations for the callbacks in the derived class; because of this
  66  * there is no need for a 'client_data' property.
  67  */
  68
  69 namespace FLAC {
  70         namespace Decoder {
  71
  72                 // ============================================================
  73                 //
  74                 //  Equivalent: FLAC__StreamDecoder
  75                 //
  76                 // ============================================================
  77
  78                 /** \defgroup flacpp_stream_decoder FLAC++/decoder.h: stream decoder class
  79                  *  \ingroup flacpp_decoder
  80                  *
  81                  *  \brief
  82                  *  This class wraps the ::FLAC__StreamDecoder.
  83                  *
  84                  * See the \link flac_stream_decoder libFLAC stream decoder module \endlink.
  85                  *
  86                  * \{
  87                  */
  88
  89                 /** This class wraps the ::FLAC__StreamDecoder.
  90                  */
  91                 class FLACPP_API Stream {
  92                 public:
  93                         class FLACPP_API State {
  94                         public:
  95                                 inline State(::FLAC__StreamDecoderState state): state_(state) { }
  96                                 inline operator ::FLAC__StreamDecoderState() const { return state_; }
  97                                 inline const char *as_cstring() const { return ::FLAC__StreamDecoderStateString[state_]; }
  98                                 const char *resolved_as_cstring(const Stream &) const;
  99                         protected:
 100                                 ::FLAC__StreamDecoderState state_;
 101                         };
 102
 103                         Stream();
 104                         virtual ~Stream();
 105
 106                         bool is_valid() const;
 107                         inline operator bool() const { return is_valid(); }
 108
 109                         bool set_metadata_respond(::FLAC__MetadataType type);
 110                         bool set_metadata_respond_application(const FLAC__byte id[4]);
 111                         bool set_metadata_respond_all();
 112                         bool set_metadata_ignore(::FLAC__MetadataType type);
 113                         bool set_metadata_ignore_application(const FLAC__byte id[4]);
 114                         bool set_metadata_ignore_all();
 115
 116                         State get_state() const;
 117                         unsigned get_channels() const;
 118                         ::FLAC__ChannelAssignment get_channel_assignment() const;
 119                         unsigned get_bits_per_sample() const;
 120                         unsigned get_sample_rate() const;
 121                         unsigned get_blocksize() const;
 122
 123                         /** Initialize the instance; as with the C interface,
 124                          *  init() should be called after construction and 'set'
 125                          *  calls but before any of the 'process' calls.
 126                          */
 127                         State init();
 128
 129                         void finish();
 130
 131                         bool flush();
 132                         bool reset();
 133
 134                         bool process_single();
 135                         bool process_until_end_of_metadata();
 136                         bool process_until_end_of_stream();
 137                 protected:
 138                         virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], unsigned *bytes) = 0;
 139                         virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
 140                         virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata) = 0;
 141                         virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
 142
 143                         ::FLAC__StreamDecoder *decoder_;
 144                 private:
 145                         static ::FLAC__StreamDecoderReadStatus read_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
 146                         static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
 147                         static void metadata_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
 148                         static void error_callback_(const ::FLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
 149
 150                         // Private and undefined so you can't use them:
 151                         Stream(const Stream &);
 152                         void operator=(const Stream &);
 153                 };
 154
 155                 /* \} */
 156
 157
 158                 // ============================================================
 159                 //
 160                 //  Equivalent: FLAC__SeekableStreamDecoder
 161                 //
 162                 // ============================================================
 163
 164                 /** \defgroup flacpp_seekable_stream_decoder FLAC++/decoder.h: seekable stream decoder class
 165                  *  \ingroup flacpp_decoder
 166                  *
 167                  *  \brief
 168                  *  This class wraps the ::FLAC__SeekableStreamDecoder.
 169                  *
 170                  * See the \link flac_seekable_stream_decoder libFLAC seekable stream decoder module \endlink.
 171                  *
 172                  * \{
 173                  */
 174
 175                 /** This class wraps the ::FLAC__SeekableStreamDecoder.
 176                  */
 177                 class FLACPP_API SeekableStream {
 178                 public:
 179                         class FLACPP_API State {
 180                         public:
 181                                 inline State(::FLAC__SeekableStreamDecoderState state): state_(state) { }
 182                                 inline operator ::FLAC__SeekableStreamDecoderState() const { return state_; }
 183                                 inline const char *as_cstring() const { return ::FLAC__SeekableStreamDecoderStateString[state_]; }
 184                                 const char *resolved_as_cstring(const SeekableStream &) const;
 185                         protected:
 186                                 ::FLAC__SeekableStreamDecoderState state_;
 187                         };
 188
 189                         SeekableStream();
 190                         virtual ~SeekableStream();
 191
 192                         bool is_valid() const;
 193                         inline operator bool() const { return is_valid(); }
 194
 195                         bool set_md5_checking(bool value);
 196                         bool set_metadata_respond(::FLAC__MetadataType type);
 197                         bool set_metadata_respond_application(const FLAC__byte id[4]);
 198                         bool set_metadata_respond_all();
 199                         bool set_metadata_ignore(::FLAC__MetadataType type);
 200                         bool set_metadata_ignore_application(const FLAC__byte id[4]);
 201                         bool set_metadata_ignore_all();
 202
 203                         State get_state() const;
 204                         Stream::State get_stream_decoder_state() const;
 205                         bool get_md5_checking() const;
 206                         unsigned get_channels() const;
 207                         ::FLAC__ChannelAssignment get_channel_assignment() const;
 208                         unsigned get_bits_per_sample() const;
 209                         unsigned get_sample_rate() const;
 210                         unsigned get_blocksize() const;
 211
 212                         State init();
 213
 214                         bool finish();
 215
 216                         bool flush();
 217                         bool reset();
 218
 219                         bool process_single();
 220                         bool process_until_end_of_metadata();
 221                         bool process_until_end_of_stream();
 222
 223                         bool seek_absolute(FLAC__uint64 sample);
 224                 protected:
 225                         virtual ::FLAC__SeekableStreamDecoderReadStatus read_callback(FLAC__byte buffer[], unsigned *bytes) = 0;
 226                         virtual ::FLAC__SeekableStreamDecoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset) = 0;
 227                         virtual ::FLAC__SeekableStreamDecoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset) = 0;
 228                         virtual ::FLAC__SeekableStreamDecoderLengthStatus length_callback(FLAC__uint64 *stream_length) = 0;
 229                         virtual bool eof_callback() = 0;
 230                         virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
 231                         virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata) = 0;
 232                         virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
 233
 234                         ::FLAC__SeekableStreamDecoder *decoder_;
 235                 private:
 236                         static ::FLAC__SeekableStreamDecoderReadStatus read_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
 237                         static ::FLAC__SeekableStreamDecoderSeekStatus seek_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
 238                         static ::FLAC__SeekableStreamDecoderTellStatus tell_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
 239                         static ::FLAC__SeekableStreamDecoderLengthStatus length_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
 240                         static FLAC__bool eof_callback_(const ::FLAC__SeekableStreamDecoder *decoder, void *client_data);
 241                         static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__SeekableStreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
 242                         static void metadata_callback_(const ::FLAC__SeekableStreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
 243                         static void error_callback_(const ::FLAC__SeekableStreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
 244
 245                         // Private and undefined so you can't use them:
 246                         SeekableStream(const SeekableStream &);
 247                         void operator=(const SeekableStream &);
 248                 };
 249
 250                 /* \} */
 251
 252
 253                 // ============================================================
 254                 //
 255                 //  Equivalent: FLAC__FileDecoder
 256                 //
 257                 // ============================================================
 258
 259                 /** \defgroup flacpp_file_decoder FLAC++/decoder.h: file decoder class
 260                  *  \ingroup flacpp_decoder
 261                  *
 262                  *  \brief
 263                  *  This class wraps the ::FLAC__FileDecoder.
 264                  *
 265                  * See the \link flac_file_decoder libFLAC file decoder module \endlink.
 266                  *
 267                  * \{
 268                  */
 269
 270                 /** This class wraps the ::FLAC__FileDecoder.
 271                  */
 272                 class FLACPP_API File {
 273                 public:
 274                         class FLACPP_API State {
 275                         public:
 276                                 inline State(::FLAC__FileDecoderState state): state_(state) { }
 277                                 inline operator ::FLAC__FileDecoderState() const { return state_; }
 278                                 inline const char *as_cstring() const { return ::FLAC__FileDecoderStateString[state_]; }
 279                                 const char *resolved_as_cstring(const File &) const;
 280                         protected:
 281                                 ::FLAC__FileDecoderState state_;
 282                         };
 283
 284                         File();
 285                         virtual ~File();
 286
 287                         bool is_valid() const;
 288                         inline operator bool() const { return is_valid(); }
 289
 290                         bool set_md5_checking(bool value);
 291                         bool set_filename(const char *value); //!< 'value' may not be \c NULL; use "-" for stdin
 292                         bool set_metadata_respond(::FLAC__MetadataType type);
 293                         bool set_metadata_respond_application(const FLAC__byte id[4]);
 294                         bool set_metadata_respond_all();
 295                         bool set_metadata_ignore(::FLAC__MetadataType type);
 296                         bool set_metadata_ignore_application(const FLAC__byte id[4]);
 297                         bool set_metadata_ignore_all();
 298
 299                         State get_state() const;
 300                         SeekableStream::State get_seekable_stream_decoder_state() const;
 301                         Stream::State get_stream_decoder_state() const;
 302                         bool get_md5_checking() const;
 303                         unsigned get_channels() const;
 304                         ::FLAC__ChannelAssignment get_channel_assignment() const;
 305                         unsigned get_bits_per_sample() const;
 306                         unsigned get_sample_rate() const;
 307                         unsigned get_blocksize() const;
 308
 309                         State init();
 310
 311                         bool finish();
 312
 313                         bool process_single();
 314                         bool process_until_end_of_metadata();
 315                         bool process_until_end_of_file();
 316
 317                         bool seek_absolute(FLAC__uint64 sample);
 318                 protected:
 319                         virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
 320                         virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata) = 0;
 321                         virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
 322
 323                         ::FLAC__FileDecoder *decoder_;
 324                 private:
 325                         static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__FileDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
 326                         static void metadata_callback_(const ::FLAC__FileDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
 327                         static void error_callback_(const ::FLAC__FileDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
 328
 329                         // Private and undefined so you can't use them:
 330                         File(const File &);
 331                         void operator=(const File &);
 332                 };
 333
 334                 /* \} */
 335
 336         };
 337 };
 338
 339 #endif