FLAC  1.5.0
FreeLosslessAudioCodec
decoder.h
Go to the documentation of this file.
1 /* libFLAC++ - Free Lossless Audio Codec library
2  * Copyright (C) 2002-2009 Josh Coalson
3  * Copyright (C) 2011-2025 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 
78 namespace FLAC {
79  namespace Decoder {
80 
101  public:
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:
112  };
113 
114  Stream();
115  virtual ~Stream();
116 
118 
121  virtual bool is_valid() const;
122  inline operator bool() const { return is_valid(); }
123 
124 
125  virtual bool set_ogg_serial_number(long value);
126  virtual bool set_decode_chained_stream(bool value);
127  virtual bool set_md5_checking(bool value);
128  virtual bool set_metadata_respond(::FLAC__MetadataType type);
129  virtual bool set_metadata_respond_application(const FLAC__byte id[4]);
130  virtual bool set_metadata_respond_all();
131  virtual bool set_metadata_ignore(::FLAC__MetadataType type);
132  virtual bool set_metadata_ignore_application(const FLAC__byte id[4]);
133  virtual bool set_metadata_ignore_all();
134 
135  /* get_state() is not virtual since we want subclasses to be able to return their own state */
136  State get_state() const;
137  virtual bool get_decode_chained_stream() const;
138  virtual bool get_md5_checking() const;
139  virtual FLAC__uint64 get_total_samples() const;
140  virtual FLAC__uint64 find_total_samples();
141  virtual uint32_t get_channels() const;
142  virtual ::FLAC__ChannelAssignment get_channel_assignment() const;
143  virtual uint32_t get_bits_per_sample() const;
144  virtual uint32_t get_sample_rate() const;
145  virtual uint32_t get_blocksize() const;
146  virtual bool get_decode_position(FLAC__uint64 *position) const;
147  virtual int32_t get_link_lengths(FLAC__uint64 **link_lengths);
148 
151 
152  virtual bool finish();
153  virtual bool finish_link();
154 
155  virtual bool flush();
156  virtual bool reset();
157 
158  virtual bool process_single();
159  virtual bool process_until_end_of_metadata();
160  virtual bool process_until_end_of_link();
161  virtual bool process_until_end_of_stream();
162  virtual bool skip_single_frame();
163  virtual bool skip_single_link();
164 
165  virtual bool seek_absolute(FLAC__uint64 sample);
166  protected:
168  virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes) = 0;
169 
171  virtual ::FLAC__StreamDecoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
172 
174  virtual ::FLAC__StreamDecoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
175 
177  virtual ::FLAC__StreamDecoderLengthStatus length_callback(FLAC__uint64 *stream_length);
178 
180  virtual bool eof_callback();
181 
183  virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
184 
186  virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata);
187 
189  virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
190 
191 #if (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)
192  // lame hack: some compilers can't see a protected decoder_ from nested State::resolved_as_cstring()
193  friend State;
194 #endif
195  ::FLAC__StreamDecoder *decoder_;
196 
197  static ::FLAC__StreamDecoderReadStatus read_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
198  static ::FLAC__StreamDecoderSeekStatus seek_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
199  static ::FLAC__StreamDecoderTellStatus tell_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
200  static ::FLAC__StreamDecoderLengthStatus length_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
201  static FLAC__bool eof_callback_(const ::FLAC__StreamDecoder *decoder, void *client_data);
202  static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
203  static void metadata_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
204  static void error_callback_(const ::FLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
205  private:
206  // Private and undefined so you can't use them:
207  Stream(const Stream &);
208  void operator=(const Stream &);
209  };
210 
230  class FLACPP_API File: public Stream {
231  public:
232  File();
233  virtual ~File();
234 
235  using Stream::init;
236  virtual ::FLAC__StreamDecoderInitStatus init(FILE *file);
237  virtual ::FLAC__StreamDecoderInitStatus init(const char *filename);
238  virtual ::FLAC__StreamDecoderInitStatus init(const std::string &filename);
239  using Stream::init_ogg;
240  virtual ::FLAC__StreamDecoderInitStatus init_ogg(FILE *file);
241  virtual ::FLAC__StreamDecoderInitStatus init_ogg(const char *filename);
242  virtual ::FLAC__StreamDecoderInitStatus init_ogg(const std::string &filename);
243  protected:
244  // this is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied internally by the C layer
245  virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
246  private:
247  // Private and undefined so you can't use them:
248  File(const File &);
249  void operator=(const File &);
250  };
251 
252  }
253 }
254 
255 #endif
const char * FLAC__stream_decoder_get_resolved_state_string(const FLAC__StreamDecoder *decoder)
Definition: decoder.h:78
This class wraps the FLAC__StreamDecoder. If you are decoding from a file, FLAC::Decoder::File may be...
Definition: decoder.h:100
FLAC__StreamDecoderTellStatus
Definition: stream_decoder.h:361
const char *const FLAC__StreamDecoderStateString[]
FLAC__StreamDecoderErrorStatus
Definition: stream_decoder.h:444
Definition: stream_decoder.h:495
This class wraps the FLAC__StreamDecoder. If you are not decoding from a file, you may need to use FL...
Definition: decoder.h:230
virtual ::FLAC__StreamDecoderInitStatus init_ogg()
Seek FLAC__stream_decoder_init_ogg_stream()
FLAC__StreamDecoderInitStatus
Definition: stream_decoder.h:264
FLAC__StreamDecoderWriteStatus
Definition: stream_decoder.h:407
struct FLAC__StreamMetadata FLAC__StreamMetadata
This module contains #defines and symbols for exporting function calls, and providing version informa...
#define FLACPP_API
Definition: export.h:88
FLAC__MetadataType
Definition: format.h:496
FLAC__StreamDecoderReadStatus
Definition: stream_decoder.h:302
FLAC__StreamDecoderState
Definition: stream_decoder.h:202
FLAC__StreamDecoderLengthStatus
Definition: stream_decoder.h:384
FLAC__ChannelAssignment
Definition: format.h:388
Definition: decoder.h:104
virtual ::FLAC__StreamDecoderInitStatus init()
Seek FLAC__stream_decoder_init_stream()
FLAC__StreamDecoderSeekStatus
Definition: stream_decoder.h:338
This module contains the functions which implement the stream decoder.

Copyright (c) 2000-2009 Josh Coalson Copyright (c) 2011-2025 Xiph.Org Foundation