Struct FlacEncoderUnmovable

pub struct FlacEncoderUnmovable<'a, WriteSeek>
where
    WriteSeek: Write + Seek + Debug,
{ /* private fields */ }

• The flac encoder. The FlacEncoder is a wrapper for the FlacEncoderUnmovable what prevents the structure moves.

The encoder’s core structure, but can’t move after initialize() has been called.

Use a Box to contain it, or just don’t move it will be fine.

Implementations

impl<'a, WriteSeek> FlacEncoderUnmovable<'a, WriteSeek>

where WriteSeek: Write + Seek + Debug,

pub fn new( writer: WriteSeek, on_write: Box<dyn FnMut(&mut WriteSeek, &[u8]) -> Result<(), Error> + 'a>, on_seek: Box<dyn FnMut(&mut WriteSeek, u64) -> Result<(), Error> + 'a>, on_tell: Box<dyn FnMut(&mut WriteSeek) -> Result<u64, Error> + 'a>, params: &FlacEncoderParams, ) -> Result<Self, FlacEncoderError>

pub fn get_status_as_result( &self, function: &'static str, ) -> Result<(), FlacEncoderError>

• If the status code is ok then return Ok(()) else return Err()

pub fn get_status_as_error( &self, function: &'static str, ) -> Result<(), FlacEncoderError>

• Regardless of the status code, just return it as an Err()

pub fn as_ptr(&self) -> *const Self

• The pointer to the struct, as client_data to be transferred to a field of the libFLAC encoder private_ struct.
• All of the callback functions need the client_data to retrieve self, and libFLAC forgot to provide a function for us to change the client_data
• That’s why our struct is Unmovable

pub fn as_mut_ptr(&mut self) -> *mut Self

• The pointer to the struct, as client_data to be transferred to a field of the libFLAC encoder private_ struct.
• All of the callback functions need the client_data to retrieve self, and libFLAC forgot to provide a function for us to change the client_data
• That’s why our struct is Unmovable

pub fn insert_comments( &mut self, key: &'static str, value: &str, ) -> Result<(), FlacEncoderInitError>

• Insert a metadata key-value pair before calling to initialize()

pub fn insert_cue_sheet( &mut self, cue_sheet: &FlacCueSheet, ) -> Result<(), FlacEncoderInitError>

• Insert a cue sheet before calling to initialize()

pub fn add_picture( &mut self, picture_binary: &[u8], description: &str, mime_type: &str, width: u32, height: u32, depth: u32, colors: u32, ) -> Result<(), FlacEncoderInitError>

• Add a picture before calling to initialize()

pub fn inherit_metadata_from_id3( &mut self, tag: &Tag, ) -> Result<(), FlacEncoderInitError>

pub fn initialize(&mut self) -> Result<(), FlacEncoderError>

• The initialize() function. Sets up all of the callback functions, transfers all of the metadata to the encoder, and then sets client_data to the address of the self struct.

pub fn get_params(&self) -> FlacEncoderParams

• Retrieve the params from the encoder where you provided it for the creation of the encoder.

pub fn tell(&mut self) -> Result<u64, Error>

• Calls your on_tell() closure to get the current writing position.

pub fn write_interleaved_samples( &mut self, samples: &[i32], ) -> Result<(), FlacEncoderError>

• Encode the interleaved samples (interleaved by channels)
• See FlacEncoderParams for the information on how to provide your samples in the [i32] array.

pub fn write_mono_channel( &mut self, monos: &[i32], ) -> Result<(), FlacEncoderError>

• Encode mono audio. Regardless of the channel setting of the FLAC encoder, the sample will be duplicated to the number of channels to accomplish the encoding
• See FlacEncoderParams for the information on how to provide your samples in the [i32] array.

pub fn write_stereos( &mut self, stereos: &[(i32, i32)], ) -> Result<(), FlacEncoderError>

• Encode stereo audio, if the channels of the encoder are mono, the stereo samples will be turned to mono samples to encode.
• If the channels of the encoder are stereo, then the samples will be encoded as it is.
• If the encoder is multi-channel other than mono and stereo, an error is returned.
• See FlacEncoderParams for the information on how to provide your samples in the i32 way.

pub fn write_monos( &mut self, monos: &[Vec<i32>], ) -> Result<(), FlacEncoderError>

• Encode multiple mono channels into the multi-channel encoder.
• See FlacEncoderParams for the information on how to provide your samples in the i32 way.

pub fn write_frames( &mut self, frames: &[Vec<i32>], ) -> Result<(), FlacEncoderError>

• Encode samples by the audio frame array. Each audio frame contains one sample for every channel.
• See FlacEncoderParams for the information on how to provide your samples in the i32 way.

pub fn finish(&mut self) -> Result<(), FlacEncoderError>

• After sending all of the samples to encode, must call finish() to complete encoding.

pub fn finalize(self)

• Call this function if you don’t want the encoder anymore.

Trait Implementations

impl<'a, WriteSeek> Debug for FlacEncoderUnmovable<'_, WriteSeek>

where WriteSeek: Write + Seek + Debug,

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, WriteSeek> Drop for FlacEncoderUnmovable<'_, WriteSeek>

where WriteSeek: Write + Seek + Debug,

fn drop(&mut self)

Executes the destructor for this type.