LtcEncoder Class Reference

Encodes timecode values into LTC (Linear Timecode) audio samples. More...

#include <ltcencoder.h>

Public Member Functions
	LtcEncoder (int sampleRate, float level=0.5f)
	Constructs an LTC encoder.
	~LtcEncoder ()=default
	Destructor.
	LtcEncoder (const LtcEncoder &)=delete
LtcEncoder &	operator= (const LtcEncoder &)=delete
	LtcEncoder (LtcEncoder &&)=default
LtcEncoder &	operator= (LtcEncoder &&)=default
int	sampleRate () const
	Returns the configured sample rate.
float	level () const
	Returns the output amplitude level.
void	setLevel (float level)
	Sets the output amplitude.
Audio	encode (const Timecode &tc)
	Encodes one timecode frame into mono int8_t audio.
size_t	frameSizeApprox (const VtcFormat *format) const
	Returns the approximate number of samples per LTC frame.

Detailed Description

Encodes timecode values into LTC (Linear Timecode) audio samples.

Wraps libvtc's VtcLTCEncoder to produce biphase-mark-encoded audio representing SMPTE timecode. The output is mono int8_t audio suitable for mixing into an audio stream or output on a dedicated channel.

Not copyable (owns encoder state). Movable.

Example

LtcEncoder enc(48000, 0.5f);
Timecode tc(Timecode::NDF24, 1, 0, 0, 0);
Audio audio = enc.encode(tc);
// audio contains ~2000 int8_t samples of LTC for this frame

Constructor & Destructor Documentation

LtcEncoder()

LtcEncoder::LtcEncoder	(	int	sampleRate,
		float	level = 0.5f
	)

Constructs an LTC encoder.

Parameters

sampleRate	Audio sample rate (e.g. 48000).
level	Output amplitude 0.0-1.0 (default: 0.5).

Member Function Documentation

encode()

Audio LtcEncoder::encode

(

const Timecode &

tc

)

Encodes one timecode frame into mono int8_t audio.

Parameters

tc	The timecode value to encode.

Returns

An Audio object containing the LTC samples (mono, PCMI_S8).

frameSizeApprox()

size_t LtcEncoder::frameSizeApprox

(

const VtcFormat *

format

)

const

Returns the approximate number of samples per LTC frame.

Useful for buffer pre-allocation. Actual encoded size may vary slightly.

Parameters

format

The timecode format to estimate for.

Returns

Approximate sample count.

level()

float LtcEncoder::level ( ) const

inline

Returns the output amplitude level.

Returns

The level 0.0-1.0.

sampleRate()

int LtcEncoder::sampleRate ( ) const

inline

Returns the configured sample rate.

Returns

The sample rate in Hz.

setLevel()

void LtcEncoder::setLevel

(

float

level

)

Sets the output amplitude.

Parameters

level

Output amplitude 0.0-1.0.

---

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

• include/promeki/proav/ltcencoder.h