1 /* libFLAC++ - Free Lossless Audio Codec library
2 * Copyright (C) 2002,2003 Josh Coalson
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * - Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
32 #ifndef FLACPP__DECODER_H
33 #define FLACPP__DECODER_H
37 #include "FLAC/file_decoder.h"
38 #include "FLAC/seekable_stream_decoder.h"
39 #include "FLAC/stream_decoder.h"
42 /** \file include/FLAC++/decoder.h
45 * This module contains the classes which implement the various
48 * See the detailed documentation in the
49 * \link flacpp_decoder decoder \endlink module.
52 /** \defgroup flacpp_decoder FLAC++/decoder.h: decoder classes
56 * This module describes the three decoder layers provided by libFLAC++.
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.
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.
72 // ============================================================
74 // Equivalent: FLAC__StreamDecoder
76 // ============================================================
78 /** \defgroup flacpp_stream_decoder FLAC++/decoder.h: stream decoder class
79 * \ingroup flacpp_decoder
82 * This class wraps the ::FLAC__StreamDecoder.
84 * See the \link flac_stream_decoder libFLAC stream decoder module \endlink.
89 /** This class wraps the ::FLAC__StreamDecoder.
91 class FLACPP_API Stream {
93 class FLACPP_API State {
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 inline const char *resolved_as_cstring(const Stream &decoder) const { return ::FLAC__stream_decoder_get_resolved_state_string(decoder.decoder_); }
100 ::FLAC__StreamDecoderState state_;
106 bool is_valid() const;
107 inline operator bool() const { return is_valid(); }
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();
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;
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.
134 bool process_single();
135 bool process_until_end_of_metadata();
136 bool process_until_end_of_stream();
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;
144 //@@@@@@ lame hack: some MSVC versions can't see a protected decoder_ from nested State::resolved_as_cstring(); fix properly later
147 ::FLAC__StreamDecoder *decoder_;
149 static ::FLAC__StreamDecoderReadStatus read_callback_(const ::FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
150 static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
151 static void metadata_callback_(const ::FLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
152 static void error_callback_(const ::FLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
154 // Private and undefined so you can't use them:
155 Stream(const Stream &);
156 void operator=(const Stream &);
161 // ============================================================
163 // Equivalent: FLAC__SeekableStreamDecoder
165 // ============================================================
167 /** \defgroup flacpp_seekable_stream_decoder FLAC++/decoder.h: seekable stream decoder class
168 * \ingroup flacpp_decoder
171 * This class wraps the ::FLAC__SeekableStreamDecoder.
173 * See the \link flac_seekable_stream_decoder libFLAC seekable stream decoder module \endlink.
178 /** This class wraps the ::FLAC__SeekableStreamDecoder.
180 class FLACPP_API SeekableStream {
182 class FLACPP_API State {
184 inline State(::FLAC__SeekableStreamDecoderState state): state_(state) { }
185 inline operator ::FLAC__SeekableStreamDecoderState() const { return state_; }
186 inline const char *as_cstring() const { return ::FLAC__SeekableStreamDecoderStateString[state_]; }
187 inline const char *resolved_as_cstring(const SeekableStream &decoder) const { return ::FLAC__seekable_stream_decoder_get_resolved_state_string(decoder.decoder_); }
189 ::FLAC__SeekableStreamDecoderState state_;
193 virtual ~SeekableStream();
195 bool is_valid() const;
196 inline operator bool() const { return is_valid(); }
198 bool set_md5_checking(bool value);
199 bool set_metadata_respond(::FLAC__MetadataType type);
200 bool set_metadata_respond_application(const FLAC__byte id[4]);
201 bool set_metadata_respond_all();
202 bool set_metadata_ignore(::FLAC__MetadataType type);
203 bool set_metadata_ignore_application(const FLAC__byte id[4]);
204 bool set_metadata_ignore_all();
206 State get_state() const;
207 Stream::State get_stream_decoder_state() const;
208 bool get_md5_checking() const;
209 unsigned get_channels() const;
210 ::FLAC__ChannelAssignment get_channel_assignment() const;
211 unsigned get_bits_per_sample() const;
212 unsigned get_sample_rate() const;
213 unsigned get_blocksize() const;
222 bool process_single();
223 bool process_until_end_of_metadata();
224 bool process_until_end_of_stream();
226 bool seek_absolute(FLAC__uint64 sample);
228 virtual ::FLAC__SeekableStreamDecoderReadStatus read_callback(FLAC__byte buffer[], unsigned *bytes) = 0;
229 virtual ::FLAC__SeekableStreamDecoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset) = 0;
230 virtual ::FLAC__SeekableStreamDecoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset) = 0;
231 virtual ::FLAC__SeekableStreamDecoderLengthStatus length_callback(FLAC__uint64 *stream_length) = 0;
232 virtual bool eof_callback() = 0;
233 virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
234 virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata) = 0;
235 virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
238 //@@@@@@ lame hack: some MSVC versions can't see a protected decoder_ from nested State::resolved_as_cstring(); fix properly later
241 ::FLAC__SeekableStreamDecoder *decoder_;
243 static ::FLAC__SeekableStreamDecoderReadStatus read_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
244 static ::FLAC__SeekableStreamDecoderSeekStatus seek_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
245 static ::FLAC__SeekableStreamDecoderTellStatus tell_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
246 static ::FLAC__SeekableStreamDecoderLengthStatus length_callback_(const ::FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
247 static FLAC__bool eof_callback_(const ::FLAC__SeekableStreamDecoder *decoder, void *client_data);
248 static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__SeekableStreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
249 static void metadata_callback_(const ::FLAC__SeekableStreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
250 static void error_callback_(const ::FLAC__SeekableStreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
252 // Private and undefined so you can't use them:
253 SeekableStream(const SeekableStream &);
254 void operator=(const SeekableStream &);
259 // ============================================================
261 // Equivalent: FLAC__FileDecoder
263 // ============================================================
265 /** \defgroup flacpp_file_decoder FLAC++/decoder.h: file decoder class
266 * \ingroup flacpp_decoder
269 * This class wraps the ::FLAC__FileDecoder.
271 * See the \link flac_file_decoder libFLAC file decoder module \endlink.
276 /** This class wraps the ::FLAC__FileDecoder.
278 class FLACPP_API File {
280 class FLACPP_API State {
282 inline State(::FLAC__FileDecoderState state): state_(state) { }
283 inline operator ::FLAC__FileDecoderState() const { return state_; }
284 inline const char *as_cstring() const { return ::FLAC__FileDecoderStateString[state_]; }
285 inline const char *resolved_as_cstring(const File &decoder) const { return ::FLAC__file_decoder_get_resolved_state_string(decoder.decoder_); }
287 ::FLAC__FileDecoderState state_;
293 bool is_valid() const;
294 inline operator bool() const { return is_valid(); }
296 bool set_md5_checking(bool value);
297 bool set_filename(const char *value); //!< 'value' may not be \c NULL; use "-" for stdin
298 bool set_metadata_respond(::FLAC__MetadataType type);
299 bool set_metadata_respond_application(const FLAC__byte id[4]);
300 bool set_metadata_respond_all();
301 bool set_metadata_ignore(::FLAC__MetadataType type);
302 bool set_metadata_ignore_application(const FLAC__byte id[4]);
303 bool set_metadata_ignore_all();
305 State get_state() const;
306 SeekableStream::State get_seekable_stream_decoder_state() const;
307 Stream::State get_stream_decoder_state() const;
308 bool get_md5_checking() const;
309 unsigned get_channels() const;
310 ::FLAC__ChannelAssignment get_channel_assignment() const;
311 unsigned get_bits_per_sample() const;
312 unsigned get_sample_rate() const;
313 unsigned get_blocksize() const;
319 bool process_single();
320 bool process_until_end_of_metadata();
321 bool process_until_end_of_file();
323 bool seek_absolute(FLAC__uint64 sample);
325 virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
326 virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata) = 0;
327 virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;
330 //@@@@@@ lame hack: some MSVC versions can't see a protected decoder_ from nested State::resolved_as_cstring(); fix properly later
333 ::FLAC__FileDecoder *decoder_;
335 static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::FLAC__FileDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
336 static void metadata_callback_(const ::FLAC__FileDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
337 static void error_callback_(const ::FLAC__FileDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);
339 // Private and undefined so you can't use them:
341 void operator=(const File &);