Audio class. More...

#include <mlt_audio.h>

Public Member Functions
void	mlt_audio_alloc_data (mlt_audio self)
	Allocate the data field based on the other properties of the Audio. More...

int	mlt_audio_calculate_size (mlt_audio self)
	Calculate the number of bytes needed for the Audio data. More...

void	mlt_audio_close (mlt_audio self)
	Destroy an audio object created by mlt_audio_new(). More...

void	mlt_audio_free_data (mlt_audio self)
	Free the data field using the destructor function. More...

void	mlt_audio_get_planes (mlt_audio self, uint8_t **planes)
	Populate an array of pointers each pointing to the beginning of an audio plane. More...

void	mlt_audio_get_values (mlt_audio self, void *data, int frequency, mlt_audio_format format, int samples, int *channels)
	Get the most common values for the audio. More...

int	mlt_audio_plane_count (mlt_audio self)
	Get the number of planes for the audio type. More...

int	mlt_audio_plane_size (mlt_audio self)
	Get the size of an audio plane. More...

void	mlt_audio_reverse (mlt_audio self)
	Reverse the audio samples. More...

void	mlt_audio_set_values (mlt_audio self, void *data, int frequency, mlt_audio_format format, int samples, int channels)
	Set the most common values for the audio. More...

void	mlt_audio_shrink (mlt_audio self, int samples)
	Shrink the audio to the new number of samples. More...

Data Fields
int	channels

mlt_destructor	close

void *	data

mlt_audio_format	format

int	frequency

mlt_channel_layout	layout

mlt_destructor	release_data

int	samples

Detailed Description

Audio class.

Audio is the data object that represents audio for a period of time.

Member Function Documentation

◆ mlt_audio_alloc_data()

void mlt_audio_alloc_data ( mlt_audio self )

Allocate the data field based on the other properties of the Audio.

If the data field is already set, and a destructor function exists, the data will be released. Else, the data pointer will be overwritten without being released.

After this function call, the release_data field will be set and can be used to release the data when necessary.

Parameters

self	the Audio object

◆ mlt_audio_calculate_size()

int mlt_audio_calculate_size ( mlt_audio self )

Calculate the number of bytes needed for the Audio data.

Parameters

self	the Audio object

Returns: the number of bytes

◆ mlt_audio_close()

void mlt_audio_close ( mlt_audio self )

Destroy an audio object created by mlt_audio_new().

Parameters

self	the Audio object

◆ mlt_audio_free_data()

void mlt_audio_free_data ( mlt_audio self )

Free the data field using the destructor function.

If the constructor function does not exist, the value will be set to NULL without being released.

After this function call, the data and release_data fields will be NULL.

Parameters

self	the Audio object

◆ mlt_audio_get_planes()

void mlt_audio_get_planes	(	mlt_audio	self,
		uint8_t **	planes
	)

Populate an array of pointers each pointing to the beginning of an audio plane.

Parameters

	self	the Audio object
[out]	planes	the array of pointers to populate

◆ mlt_audio_get_values()

void mlt_audio_get_values	(	mlt_audio	self,
		void **	data,
		int *	frequency,
		mlt_audio_format *	format,
		int *	samples,
		int *	channels
	)

Get the most common values for the audio.

Parameters

	self	the Audio object
[out]	data	the buffer that contains the audio data
[out]	frequency	the sample rate
[out]	format	the audio format
[out]	samples	the number of samples in the data
[out]	channels	the number of audio channels

◆ mlt_audio_plane_count()

int mlt_audio_plane_count ( mlt_audio self )

Get the number of planes for the audio type.

Parameters

self	the Audio object

Returns: the number of planes.

◆ mlt_audio_plane_size()

int mlt_audio_plane_size ( mlt_audio self )

Get the size of an audio plane.

Parameters

self	the Audio object

Returns: the size of a plane.

◆ mlt_audio_reverse()

void mlt_audio_reverse ( mlt_audio self )

Reverse the audio samples.

Parameters

self	the Audio object

◆ mlt_audio_set_values()

void mlt_audio_set_values	(	mlt_audio	self,
		void *	data,
		int	frequency,
		mlt_audio_format	format,
		int	samples,
		int	channels
	)

Set the most common values for the audio.

Less common values will be set to reasonable defaults.

You should use the mlt_audio_calculate_frame_samples to determine the number of samples you want.

Parameters

self	the Audio object
data	the buffer that contains the audio data
frequency	the sample rate
format	the audio format
samples	the number of samples in the data
channels	the number of audio channels

◆ mlt_audio_shrink()

void mlt_audio_shrink	(	mlt_audio	self,
		int	samples
	)

Shrink the audio to the new number of samples.

Existing samples will be moved as necessary to ensure that the audio planes immediately follow each other. The samples field will be updated to match the new number.

Parameters

self	the Audio object
samples	the new number of samples to shrink to

Field Documentation

◆ channels

int mlt_audio_s::channels

◆ close

mlt_destructor mlt_audio_s::close

◆ data

void* mlt_audio_s::data

◆ format

mlt_audio_format mlt_audio_s::format

◆ frequency

int mlt_audio_s::frequency

◆ layout

mlt_channel_layout mlt_audio_s::layout

◆ release_data

mlt_destructor mlt_audio_s::release_data

◆ samples

int mlt_audio_s::samples

The documentation for this struct was generated from the following files:

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ mlt_audio_alloc_data()

◆ mlt_audio_calculate_size()

◆ mlt_audio_close()

◆ mlt_audio_free_data()

◆ mlt_audio_get_planes()

◆ mlt_audio_get_values()

◆ mlt_audio_plane_count()

◆ mlt_audio_plane_size()

◆ mlt_audio_reverse()

◆ mlt_audio_set_values()

◆ mlt_audio_shrink()

Field Documentation

◆ channels

◆ close

◆ data

◆ format

◆ frequency

◆ layout

◆ release_data

◆ samples