The interface here is nearly identical to FLAC's file encoder, including the callbacks, with the addition of OggFLAC__file_encoder_set_serial_number(). See the FLAC file encoder module for full documentation.
|
Signature for the progress callback. See OggFLAC__file_encoder_set_progress_callback() and FLAC__FileEncoderProgressCallback for more info.
|
|
State values for a OggFLAC__FileEncoder The encoder's state can be obtained by calling OggFLAC__file_encoder_get_state().
|
|
Create a new file encoder instance. The instance is created with default settings; see the individual OggFLAC__file_encoder_set_*() functions for each setting's default.
|
|
Free an encoder instance. Deletes the object pointed to by encoder.
encoder != NULL |
|
Set the serial number for the FLAC stream.
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_verify().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_streamable_subset().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_do_mid_side_stereo().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_loose_mid_side_stereo().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_channels().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_bits_per_sample().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_sample_rate().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_blocksize().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_max_lpc_order().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_qlp_coeff_precision().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_do_escape_coding().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_do_exhaustive_model_search().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_min_residual_partition_order().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_max_residual_partition_order().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_rice_parameter_search_dist().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_total_samples_estimate().
encoder != NULL
|
|
This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_set_metadata().
encoder != NULL
|
|
Set the output file name encode to.
encoder != NULL value != NULL
|
|
Set the progress callback. The supplied function will be called when the encoder has finished writing a frame. The
encoder != NULL value != NULL
|
|
Set the client data to be passed back to callbacks. This value will be supplied to callbacks in their client_data argument.
encoder != NULL
|
|
Get the current encoder state.
encoder != NULL
|
|
Get the state of the underlying seekable stream encoder. Useful when the file encoder state is
encoder != NULL
|
|
Get the state of the underlying FLAC seekable stream encoder. Useful when the file encoder state is
encoder != NULL
|
|
Get the state of the underlying FLAC stream encoder. Useful when the file encoder state is
encoder != NULL
|
|
Get the state of the underlying stream encoder's verify decoder. Useful when the file encoder state is
encoder != NULL
|
|
Get the current encoder state as a C string. This version automatically resolves
encoder != NULL
|
|
Get relevant values about the nature of a verify decoder error. Inherited from OggFLAC__seekable_stream_encoder_get_verify_decoder_error_stats(). Useful when the file encoder state is
encoder != NULL |
|
Get the "verify" flag. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_verify().
encoder != NULL
|
|
Get the "streamable subset" flag. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_streamable_subset().
encoder != NULL
|
|
Get the "mid/side stereo coding" flag. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_do_mid_side_stereo().
encoder != NULL
|
|
Get the "adaptive mid/side switching" flag. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_loose_mid_side_stereo().
encoder != NULL
|
|
Get the number of input channels being processed. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_channels().
encoder != NULL
|
|
Get the input sample resolution setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_bits_per_sample().
encoder != NULL
|
|
Get the input sample rate setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_sample_rate().
encoder != NULL
|
|
Get the blocksize setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_blocksize().
encoder != NULL
|
|
Get the maximum LPC order setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_max_lpc_order().
encoder != NULL
|
|
Get the quantized linear predictor coefficient precision setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_qlp_coeff_precision().
encoder != NULL
|
|
Get the qlp coefficient precision search flag. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search().
encoder != NULL
|
|
Get the "escape coding" flag. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_do_escape_coding().
encoder != NULL
|
|
Get the exhaustive model search flag. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_do_exhaustive_model_search().
encoder != NULL
|
|
Get the minimum residual partition order setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_min_residual_partition_order().
encoder != NULL
|
|
Get maximum residual partition order setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_max_residual_partition_order().
encoder != NULL
|
|
Get the Rice parameter search distance setting. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_rice_parameter_search_dist().
encoder != NULL
|
|
Get the previously set estimate of the total samples to be encoded. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_get_total_samples_estimate().
encoder != NULL
|
|
Initialize the encoder instance. Should be called after OggFLAC__file_encoder_new() and OggFLAC__file_encoder_set_*() but before OggFLAC__file_encoder_process() or OggFLAC__file_encoder_process_interleaved(). Will set and return the encoder state, which will be OggFLAC__FILE_ENCODER_OK if initialization succeeded.
encoder != NULL
|
|
Finish the encoding process. Flushes the encoding buffer, releases resources, resets the encoder settings to their defaults, and returns the encoder state to OggFLAC__FILE_ENCODER_UNINITIALIZED. In the event of a prematurely-terminated encode, it is not strictly necessary to call this immediately before OggFLAC__file_encoder_delete() but it is good practice to match every OggFLAC__file_encoder_init() with a OggFLAC__file_encoder_finish().
encoder != NULL |
|
Submit data for encoding. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_process().
encoder != NULL
|
|
Submit data for encoding. This is inherited from OggFLAC__SeekableStreamEncoder; see OggFLAC__seekable_stream_encoder_process_interleaved().
encoder != NULL
|
|
Maps a FLAC__FileEncoderState to a C string. Using a FLAC__FileEncoderState as the index to this array will give the string equivalent. The contents should not be modified. |