FreeSurround Class Reference

#include <libmyth/audio/freesurround.h>

Collaboration diagram for FreeSurround:

Classes
struct	fsurround_params

Public Types
enum	SurroundMode : std::uint8_t { SurroundModePassive , SurroundModeActiveSimple , SurroundModeActiveLinear , SurroundModePassiveHall }

Public Member Functions
	FreeSurround (uint srate, bool moviemode, SurroundMode mode)
	~FreeSurround ()
uint	putFrames (void *buffer, uint numFrames, uint numChannels)
uint	receiveFrames (void *buffer, uint maxFrames)
void	flush ()
uint	numUnprocessedFrames () const
uint	numFrames () const
long long	getLatency ()
uint	frameLatency () const

Static Public Member Functions
static uint	framesPerBlock ()

Protected Member Functions
void	process_block ()
void	open ()
void	close ()
void	SetParams ()

Private Attributes
struct FreeSurround::fsurround_params	m_params
uint	m_srate
struct buffers *	m_bufs {nullptr}
class fsurround_decoder *	m_decoder {nullptr}
int	m_inCount {0}
int	m_outCount {0}
bool	m_processed {true}
int	m_processedSize {0}
SurroundMode	m_surroundMode {SurroundModePassive}
int	m_latencyFrames {0}
int	m_channels {0}

Detailed Description

Definition at line 28 of file freesurround.h.

Member Enumeration Documentation

SurroundMode

enum FreeSurround::SurroundMode : std::uint8_t

Enumerator
SurroundModePassive
SurroundModeActiveSimple
SurroundModeActiveLinear
SurroundModePassiveHall

Definition at line 31 of file freesurround.h.

Constructor & Destructor Documentation

FreeSurround()

FreeSurround::FreeSurround	(	uint	srate,
		bool	moviemode,
		SurroundMode	mode
	)

Definition at line 74 of file freesurround.cpp.

~FreeSurround()

FreeSurround::~FreeSurround

(

)

Definition at line 130 of file freesurround.cpp.

Member Function Documentation

close()

void FreeSurround::close ( )

protected

Definition at line 440 of file freesurround.cpp.

Referenced by ~FreeSurround().

flush()

void FreeSurround::flush

(

)

Definition at line 419 of file freesurround.cpp.

Referenced by AudioOutputBase::Reset().

frameLatency()

uint FreeSurround::frameLatency

(

)

const

Definition at line 456 of file freesurround.cpp.

Referenced by AudioOutputBase::SetAudiotime().

framesPerBlock()

uint FreeSurround::framesPerBlock ( )

static

Definition at line 463 of file freesurround.cpp.

getLatency()

long long FreeSurround::getLatency

(

)

Definition at line 409 of file freesurround.cpp.

numFrames()

uint FreeSurround::numFrames

(

)

const

Definition at line 451 of file freesurround.cpp.

Referenced by AudioOutputBase::CopyWithUpmix(), and putFrames().

numUnprocessedFrames()

uint FreeSurround::numUnprocessedFrames

(

)

const

Definition at line 446 of file freesurround.cpp.

Referenced by AudioOutputBase::AddData().

open()

void FreeSurround::open ( )

protected

Definition at line 427 of file freesurround.cpp.

Referenced by FreeSurround().

process_block()

void FreeSurround::process_block ( )

protected

Definition at line 387 of file freesurround.cpp.

Referenced by putFrames().

putFrames()

uint FreeSurround::putFrames	(	void *	buffer,
		uint	numFrames,
		uint	numChannels
	)

Definition at line 139 of file freesurround.cpp.

Referenced by AudioOutputBase::CopyWithUpmix().

receiveFrames()

uint FreeSurround::receiveFrames	(	void *	buffer,
		uint	maxFrames
	)

Definition at line 306 of file freesurround.cpp.

Referenced by AudioOutputBase::CopyWithUpmix().

SetParams()

void FreeSurround::SetParams ( )

protected

Definition at line 119 of file freesurround.cpp.

Referenced by open().

Member Data Documentation

m_bufs

struct buffers* FreeSurround::m_bufs {nullptr}

private

Definition at line 80 of file freesurround.h.

Referenced by flush(), FreeSurround(), open(), putFrames(), receiveFrames(), and ~FreeSurround().

m_channels

int FreeSurround::m_channels {0}

private

Definition at line 88 of file freesurround.h.

Referenced by putFrames(), and receiveFrames().

m_decoder

class fsurround_decoder* FreeSurround::m_decoder {nullptr}

private

Definition at line 81 of file freesurround.h.

Referenced by close(), flush(), getLatency(), open(), process_block(), putFrames(), receiveFrames(), and SetParams().

m_inCount

int FreeSurround::m_inCount {0}

private

Definition at line 82 of file freesurround.h.

Referenced by frameLatency(), getLatency(), numUnprocessedFrames(), and putFrames().

m_latencyFrames

int FreeSurround::m_latencyFrames {0}

private

Definition at line 87 of file freesurround.h.

Referenced by FreeSurround(), getLatency(), and putFrames().

m_outCount

int FreeSurround::m_outCount {0}

private

Definition at line 83 of file freesurround.h.

Referenced by frameLatency(), numFrames(), putFrames(), and receiveFrames().

m_params

struct FreeSurround::fsurround_params FreeSurround::m_params

private

Referenced by FreeSurround(), process_block(), and SetParams().

m_processed

bool FreeSurround::m_processed {true}

private

Definition at line 84 of file freesurround.h.

Referenced by frameLatency(), putFrames(), and receiveFrames().

m_processedSize

int FreeSurround::m_processedSize {0}

private

Definition at line 85 of file freesurround.h.

Referenced by putFrames(), and receiveFrames().

m_srate

uint FreeSurround::m_srate

private

Definition at line 77 of file freesurround.h.

Referenced by getLatency(), and open().

m_surroundMode

SurroundMode FreeSurround::m_surroundMode {SurroundModePassive}

private

Definition at line 86 of file freesurround.h.

Referenced by FreeSurround(), and putFrames().

---

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

• mythtv/libs/libmyth/audio/freesurround.h
• mythtv/libs/libmyth/audio/freesurround.cpp