~ubuntu-branches/ubuntu/utopic/flac/utopic-updates

<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>

<a class="el" href="dir_000000.html">include</a> / <a class="el" href="dir_000001.html">FLAC++</a></div>

<h1>encoder.h</h1><a href="encoder_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 /* libFLAC++ - Free Lossless Audio Codec library

00003 *

00004 * Redistribution and use in source and binary forms, with or without

00005 * modification, are permitted provided that the following conditions

00006 * are met:

00007 *

00008 * - Redistributions of source code must retain the above copyright

00009 * notice, this list of conditions and the following disclaimer.

00010 *

00011 * - Redistributions in binary form must reproduce the above copyright

00012 * notice, this list of conditions and the following disclaimer in the

00013 * documentation and/or other materials provided with the distribution.

00014 *

00015 * - Neither the name of the Xiph.org Foundation nor the names of its

00016 * contributors may be used to endorse or promote products derived from

00017 * this software without specific prior written permission.

00018 *

00019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

00020 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

00021 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

00022 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR

00023 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

00024 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

00025 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

00026 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

00027 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

00028 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

00029 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

00030 */

00031

00032 #ifndef FLACPP__ENCODER_H

00033 #define FLACPP__ENCODER_H

00034

00035 #include "<a class="code" href="+_2export_8h.html">export.h</a>"

00036

00037 #include "<a class="code" href="stream__encoder_8h.html">FLAC/stream_encoder.h</a>"

00038 #include "<a class="code" href="decoder_8h.html">decoder.h</a>"

00039 #include "<a class="code" href="+_2metadata_8h.html">metadata.h</a>"

00040

00041

00078 namespace FLAC {

00079 namespace Encoder {

00080

<a name="l00101"></a><a class="code" href="classFLAC_1_1Encoder_1_1Stream.html">00101</a> class FLACPP_API Stream {

00102 public:

<a name="l00105"></a><a class="code" href="classFLAC_1_1Encoder_1_1Stream_1_1State.html">00105</a> class FLACPP_API State {

00106 public:

00107 inline State(::<a class="code" href="group__flac__stream__encoder.html#ga65">FLAC__StreamEncoderState</a> state): state_(state) { }

00108 inline <a class="code" href="group__flac__stream__encoder.html#ga65">operator ::FLAC__StreamEncoderState</a>() const { return state_; }

00109 inline const char *as_cstring() const { <a class="code" href="group__flac__stream__encoder.html#ga0">return ::FLAC__StreamEncoderStateString</a>[state_]; }

00110 inline const char *resolved_as_cstring(const Stream &encoder) const { <a class="code" href="group__flac__stream__encoder.html#ga37">return ::FLAC__stream_encoder_get_resolved_state_string</a>(encoder.<a class="code" href="classFLAC_1_1Encoder_1_1Stream.html#FLAC_1_1Encoder_1_1Streamp0">encoder_</a>); }

00111 protected:<a class="code" href="group__flac__stream__encoder.html#ga65"></a>

00112 <a class="code" href="group__flac__stream__encoder.html#ga65"> ::FLAC__StreamEncoderState</a> state_;

00113 };

00114

00115 Stream();

00116 virtual ~Stream();

00117

00119

00123 virtual bool is_valid() const;

<a name="l00124"></a><a class="code" href="classFLAC_1_1Encoder_1_1Stream.html#FLAC_1_1Encoder_1_1Streama3">00124</a> inline operator bool() const { return is_valid(); }

00125

00126

00127 virtual bool set_ogg_serial_number(long value);

00128 virtual bool set_verify(bool value);

00129 virtual bool set_streamable_subset(bool value);

00130 virtual bool set_channels(unsigned value);

00131 virtual bool set_bits_per_sample(unsigned value);

00132 virtual bool set_sample_rate(unsigned value);

00133 virtual bool set_compression_level(unsigned value);

00134 virtual bool set_blocksize(unsigned value);

00135 virtual bool set_do_mid_side_stereo(bool value);

00136 virtual bool set_loose_mid_side_stereo(bool value);

00137 virtual bool set_apodization(const char *specification);

00138 virtual bool set_max_lpc_order(unsigned value);

00139 virtual bool set_qlp_coeff_precision(unsigned value);

00140 virtual bool set_do_qlp_coeff_prec_search(bool value);

00141 virtual bool set_do_escape_coding(bool value);

00142 virtual bool set_do_exhaustive_model_search(bool value);

00143 virtual bool set_min_residual_partition_order(unsigned value);

00144 virtual bool set_max_residual_partition_order(unsigned value);

00145 virtual bool set_rice_parameter_search_dist(unsigned value);

00146 virtual bool set_total_samples_estimate(FLAC__uint64 value);

00147 virtual bool set_metadata(::<a class="code" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, unsigned num_blocks);

00148 virtual bool set_metadata(<a class="code" href="classFLAC_1_1Metadata_1_1Prototype.html">FLAC::Metadata::Prototype</a> **metadata, unsigned num_blocks);

00149

00150 /* get_state() is not virtual since we want subclasses to be able to return their own state */

00151 State get_state() const;

00152 virtual <a class="code" href="classFLAC_1_1Decoder_1_1Stream_1_1State.html">Decoder::Stream::State</a> get_verify_decoder_state() const;

100

00153 virtual void get_verify_decoder_error_stats(FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got);

101

00154 virtual bool get_verify() const;

102

00155 virtual bool get_streamable_subset() const;

103

00156 virtual bool get_do_mid_side_stereo() const;

104

00157 virtual bool get_loose_mid_side_stereo() const;

105

00158 virtual unsigned get_channels() const;

106

00159 virtual unsigned get_bits_per_sample() const;

107

00160 virtual unsigned get_sample_rate() const;

108

00161 virtual unsigned get_blocksize() const;

109

00162 virtual unsigned get_max_lpc_order() const;

110

00163 virtual unsigned get_qlp_coeff_precision() const;

111

00164 virtual bool get_do_qlp_coeff_prec_search() const;

112

00165 virtual bool get_do_escape_coding() const;

113

00166 virtual bool get_do_exhaustive_model_search() const;

114

00167 virtual unsigned get_min_residual_partition_order() const;

115

00168 virtual unsigned get_max_residual_partition_order() const;

116

00169 virtual unsigned get_rice_parameter_search_dist() const;

117

00170 virtual FLAC__uint64 get_total_samples_estimate() const;

118

00171

119

00172 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init();

120

00173 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init_ogg();

121

00174

122

00175 virtual bool finish();

123

00176

124

00177 virtual bool process(const FLAC__int32 * const buffer[], unsigned samples);

125

00178 virtual bool process_interleaved(const FLAC__int32 buffer[], unsigned samples);

126

00179 protected:

127

00181 <a class="code" href="group__flac__stream__encoder.html#ga67">virtual ::FLAC__StreamEncoderReadStatus</a> read_callback(FLAC__byte buffer[], size_t *bytes);

128

00182

129

00184 <a class="code" href="group__flac__stream__encoder.html#ga68">virtual ::FLAC__StreamEncoderWriteStatus</a> write_callback(const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame) = 0;

130

00185

131

00187 <a class="code" href="group__flac__stream__encoder.html#ga69">virtual ::FLAC__StreamEncoderSeekStatus</a> seek_callback(FLAC__uint64 absolute_byte_offset);

132

00188

133

00190 <a class="code" href="group__flac__stream__encoder.html#ga70">virtual ::FLAC__StreamEncoderTellStatus</a> tell_callback(FLAC__uint64 *absolute_byte_offset);

134

00191

135

00193 virtual void metadata_callback(const ::<a class="code" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata);

136

00194

137

00195 #if (defined _MSC_VER) || (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)

138

00196 // lame hack: some MSVC/GCC versions can't see a protected encoder_ from nested State::resolved_as_cstring()

139

00197 friend State;

140

00198 #endif

141

00199 ::FLAC__StreamEncoder *encoder_;

142

00200

143

00201 <a class="code" href="group__flac__stream__encoder.html#ga67">static ::FLAC__StreamEncoderReadStatus</a> read_callback_(const ::<a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);

144

00202 <a class="code" href="group__flac__stream__encoder.html#ga68">static ::FLAC__StreamEncoderWriteStatus</a> write_callback_(const ::<a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame, void *client_data);

145

00203 <a class="code" href="group__flac__stream__encoder.html#ga69">static ::FLAC__StreamEncoderSeekStatus</a> seek_callback_(const <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);

146

00204 <a class="code" href="group__flac__stream__encoder.html#ga70">static ::FLAC__StreamEncoderTellStatus</a> tell_callback_(const <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);

147

00205 static void metadata_callback_(const ::<a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const ::<a class="code" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data);

148

00206 private:

149

00207 // Private and undefined so you can't use them:

150

00208 Stream(const Stream &);

151

00209 void operator=(const Stream &);

152

00210 };

153

00211

154

<a name="l00232"></a><a class="code" href="classFLAC_1_1Encoder_1_1File.html">00232</a> class FLACPP_API File: public Stream {

155

00233 public:

156

00234 File();

157

00235 virtual ~File();

158

00236

159

00237 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init(FILE *file);

160

00238 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init(const char *filename);

161

00239 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init(const std::string &filename);

162

00240 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init_ogg(FILE *file);

163

00241 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init_ogg(const char *filename);

164

00242 <a class="code" href="group__flac__stream__encoder.html#ga66">virtual ::FLAC__StreamEncoderInitStatus</a> init_ogg(const std::string &filename);

165

00243 protected:

166

00245 virtual void progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate);

167

00246

168

00248 <a class="code" href="group__flac__stream__encoder.html#ga68">virtual ::FLAC__StreamEncoderWriteStatus</a> write_callback(const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame);

169

00249 private:

170

00250 static void progress_callback_(const ::<a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data);

171

00251

172

00252 // Private and undefined so you can't use them:

173

00253 File(const Stream &);

174

00254 void operator=(const Stream &);

175

00255 };

176

00256

177

00257 }

178

00258 }

179

00259

180

00260 #endif

181

</pre></div>

182

183

184

185

<table>

186

<tr>

187

188

189

</td>

190

191

192

</td>

193

</tr>

194

</table>

195

</div>

196

197

198

199

200

201

202

</body>

203

</html>

Older »