FLAC  1.2.1
encoder.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__ENCODER_H
33 #define FLACPP__ENCODER_H
34 
35 #include "export.h"
36 
37 #include "FLAC/stream_encoder.h"
38 #include "decoder.h"
39 #include "metadata.h"
40 
41 
78 namespace FLAC {
79  namespace Encoder {
80 
101  class FLACPP_API Stream {
102  public:
105  class FLACPP_API State {
106  public:
107  inline State(::FLAC__StreamEncoderState state): state_(state) { }
108  inline operator ::FLAC__StreamEncoderState() const { return state_; }
109  inline const char *as_cstring() const { return ::FLAC__StreamEncoderStateString[state_]; }
110  inline const char *resolved_as_cstring(const Stream &encoder) const { return ::FLAC__stream_encoder_get_resolved_state_string(encoder.encoder_); }
111  protected:
113  };
114 
115  Stream();
116  virtual ~Stream();
117 
119 
123  virtual bool is_valid() const;
124  inline operator bool() const { return is_valid(); }
125 
126 
127  virtual bool set_ogg_serial_number(long value);
128  virtual bool set_verify(bool value);
129  virtual bool set_streamable_subset(bool value);
130  virtual bool set_channels(unsigned value);
131  virtual bool set_bits_per_sample(unsigned value);
132  virtual bool set_sample_rate(unsigned value);
133  virtual bool set_compression_level(unsigned value);
134  virtual bool set_blocksize(unsigned value);
135  virtual bool set_do_mid_side_stereo(bool value);
136  virtual bool set_loose_mid_side_stereo(bool value);
137  virtual bool set_apodization(const char *specification);
138  virtual bool set_max_lpc_order(unsigned value);
139  virtual bool set_qlp_coeff_precision(unsigned value);
140  virtual bool set_do_qlp_coeff_prec_search(bool value);
141  virtual bool set_do_escape_coding(bool value);
142  virtual bool set_do_exhaustive_model_search(bool value);
143  virtual bool set_min_residual_partition_order(unsigned value);
144  virtual bool set_max_residual_partition_order(unsigned value);
145  virtual bool set_rice_parameter_search_dist(unsigned value);
146  virtual bool set_total_samples_estimate(FLAC__uint64 value);
147  virtual bool set_metadata(::FLAC__StreamMetadata **metadata, unsigned num_blocks);
148  virtual bool set_metadata(FLAC::Metadata::Prototype **metadata, unsigned num_blocks);
149 
150  /* get_state() is not virtual since we want subclasses to be able to return their own state */
151  State get_state() const;
152  virtual Decoder::Stream::State get_verify_decoder_state() const;
153  virtual void get_verify_decoder_error_stats(FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got);
154  virtual bool get_verify() const;
155  virtual bool get_streamable_subset() const;
156  virtual bool get_do_mid_side_stereo() const;
157  virtual bool get_loose_mid_side_stereo() const;
158  virtual unsigned get_channels() const;
159  virtual unsigned get_bits_per_sample() const;
160  virtual unsigned get_sample_rate() const;
161  virtual unsigned get_blocksize() const;
162  virtual unsigned get_max_lpc_order() const;
163  virtual unsigned get_qlp_coeff_precision() const;
164  virtual bool get_do_qlp_coeff_prec_search() const;
165  virtual bool get_do_escape_coding() const;
166  virtual bool get_do_exhaustive_model_search() const;
167  virtual unsigned get_min_residual_partition_order() const;
168  virtual unsigned get_max_residual_partition_order() const;
169  virtual unsigned get_rice_parameter_search_dist() const;
170  virtual FLAC__uint64 get_total_samples_estimate() const;
171 
174 
175  virtual bool finish();
176 
177  virtual bool process(const FLAC__int32 * const buffer[], unsigned samples);
178  virtual bool process_interleaved(const FLAC__int32 buffer[], unsigned samples);
179  protected:
181  virtual ::FLAC__StreamEncoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
182 
184  virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame) = 0;
185 
187  virtual ::FLAC__StreamEncoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
188 
190  virtual ::FLAC__StreamEncoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
191 
193  virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata);
194 
195 #if (defined _MSC_VER) || (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)
196  // lame hack: some MSVC/GCC versions can't see a protected encoder_ from nested State::resolved_as_cstring()
197  friend State;
198 #endif
199  ::FLAC__StreamEncoder *encoder_;
200 
201  static ::FLAC__StreamEncoderReadStatus read_callback_(const ::FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
202  static ::FLAC__StreamEncoderWriteStatus write_callback_(const ::FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame, void *client_data);
203  static ::FLAC__StreamEncoderSeekStatus seek_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
204  static ::FLAC__StreamEncoderTellStatus tell_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
205  static void metadata_callback_(const ::FLAC__StreamEncoder *encoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
206  private:
207  // Private and undefined so you can't use them:
208  Stream(const Stream &);
209  void operator=(const Stream &);
210  };
211 
232  class FLACPP_API File: public Stream {
233  public:
234  File();
235  virtual ~File();
236 
237  virtual ::FLAC__StreamEncoderInitStatus init(FILE *file);
238  virtual ::FLAC__StreamEncoderInitStatus init(const char *filename);
239  virtual ::FLAC__StreamEncoderInitStatus init(const std::string &filename);
240  virtual ::FLAC__StreamEncoderInitStatus init_ogg(FILE *file);
241  virtual ::FLAC__StreamEncoderInitStatus init_ogg(const char *filename);
242  virtual ::FLAC__StreamEncoderInitStatus init_ogg(const std::string &filename);
243  protected:
245  virtual void progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate);
246 
248  virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame);
249  private:
250  static void progress_callback_(const ::FLAC__StreamEncoder *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data);
251 
252  // Private and undefined so you can't use them:
253  File(const Stream &);
254  void operator=(const Stream &);
255  };
256 
257  }
258 }
259 
260 #endif