FLAC  1.2.1
decoder.h
Go to the documentation of this file.
1 /* libFLAC++ - Free Lossless Audio Codec library
2  * Copyright (C) 2002,2003,2004,2005,2006,2007,2008,2009 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 <string>
38 #include "FLAC/stream_decoder.h"
39 
40 
77 namespace FLAC {
78  namespace Decoder {
79 
99  class FLACPP_API Stream {
100  public:
103  class FLACPP_API State {
104  public:
105  inline State(::FLAC__StreamDecoderState state): state_(state) { }
106  inline operator ::FLAC__StreamDecoderState() const { return state_; }
107  inline const char *as_cstring() const { return ::FLAC__StreamDecoderStateString[state_]; }
108  inline const char *resolved_as_cstring(const Stream &decoder) const { return ::FLAC__stream_decoder_get_resolved_state_string(decoder.decoder_); }
109  protected:
111  };
112 
113  Stream();
114  virtual ~Stream();
115 
117 
120  virtual bool is_valid() const;
121  inline operator bool() const { return is_valid(); }
122 
123 
124  virtual bool set_ogg_serial_number(long value);
125  virtual bool set_md5_checking(bool value);
126  virtual bool set_metadata_respond(::FLAC__MetadataType type);
127  virtual bool set_metadata_respond_application(const FLAC__byte id[4]);
128  virtual bool set_metadata_respond_all();
129  virtual bool set_metadata_ignore(::FLAC__MetadataType type);
130  virtual bool set_metadata_ignore_application(const FLAC__byte id[4]);
131  virtual bool set_metadata_ignore_all();
132 
133  /* get_state() is not virtual since we want subclasses to be able to return their own state */
134  State get_state() const;
135  virtual bool get_md5_checking() const;
136  virtual FLAC__uint64 get_total_samples() const;
137  virtual unsigned get_channels() const;
138  virtual ::FLAC__ChannelAssignment get_channel_assignment() const;
139  virtual unsigned get_bits_per_sample() const;
140  virtual unsigned get_sample_rate() const;
141  virtual unsigned get_blocksize() const;
142  virtual bool get_decode_position(FLAC__uint64 *position) const;
143 
146 
147  virtual bool finish();
148 
149  virtual bool flush();
150  virtual bool reset();
151 
152  virtual bool process_single();
153  virtual bool process_until_end_of_metadata();
154  virtual bool process_until_end_of_stream();
155  virtual bool skip_single_frame();
156 
157  virtual bool seek_absolute(FLAC__uint64 sample);
158  protected:
160  virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes) = 0;
161 
163  virtual ::FLAC__StreamDecoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
164 
166  virtual ::FLAC__StreamDecoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
167 
169  virtual ::FLAC__StreamDecoderLengthStatus length_callback(FLAC__uint64 *stream_length);
170 
172  virtual bool eof_callback();
173 
175  virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
176 
178  virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata);
179 
181  virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
182 
183 #if (defined _MSC_VER) || (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)
184  // lame hack: some MSVC/GCC versions can't see a protected decoder_ from nested State::resolved_as_cstring()
185  friend State;
186 #endif
187  ::FLAC__StreamDecoder *decoder_;
188 
189  static ::FLAC__StreamDecoderReadStatus read_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
190  static ::FLAC__StreamDecoderSeekStatus seek_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
191  static ::FLAC__StreamDecoderTellStatus tell_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
192  static ::FLAC__StreamDecoderLengthStatus length_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
193  static FLAC__bool eof_callback_(const ::FLAC__StreamDecoder *decoder, void *client_data);
194  static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
195  static void metadata_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
196  static void error_callback_(const ::FLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
197  private:
198  // Private and undefined so you can't use them:
199  Stream(const Stream &);
200  void operator=(const Stream &);
201  };
202 
222  class FLACPP_API File: public Stream {
223  public:
224  File();
225  virtual ~File();
226 
227  virtual ::FLAC__StreamDecoderInitStatus init(FILE *file);
228  virtual ::FLAC__StreamDecoderInitStatus init(const char *filename);
229  virtual ::FLAC__StreamDecoderInitStatus init(const std::string &filename);
230  virtual ::FLAC__StreamDecoderInitStatus init_ogg(FILE *file);
231  virtual ::FLAC__StreamDecoderInitStatus init_ogg(const char *filename);
232  virtual ::FLAC__StreamDecoderInitStatus init_ogg(const std::string &filename);
233  protected:
234  // this is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied internally by the C layer
235  virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
236  private:
237  // Private and undefined so you can't use them:
238  File(const File &);
239  void operator=(const File &);
240  };
241 
242  }
243 }
244 
245 #endif