BpmDetectPlugin Class Reference

#include <bpmdetectplugin.h>

Inheritance diagram for BpmDetectPlugin:

Collaboration diagram for BpmDetectPlugin:

Protected Member Functions
const char *	getLabel () const override
const char *	getDescription () const override
const char *	getMaker () const override
const char *	getHomePage () const override
const char *	getLicense () const override
uint32_t	getVersion () const override
int64_t	getUniqueId () const override
void	initParameter (uint32_t index, Parameter &parameter) override
float	getParameterValue (uint32_t index) const override
void	setParameterValue (uint32_t index, float value) override
void	activate () override
void	run (const float **inputs, float **outputs, uint32_t frames) override
void	bufferSizeChanged (uint32_t newBufferSize) override
void	sampleRateChanged (double newSampleRate) override

Detailed Description

Analyser plugin that estimates the tempo of incoming audio with SoundTouch's BPM detector.

Audio passes through unmodified. The real-time thread only copies samples into a lock-free ring buffer; a worker thread feeds the detector and publishes the estimate through the read-only 'Detected BPM' output parameter, folded into the configured tempo range by halving or doubling.

Member Function Documentation

activate()

void BpmDetectPlugin::activate ( )

overrideprotected

Prepares for processing; requests a fresh detector.

bufferSizeChanged()

void BpmDetectPlugin::bufferSizeChanged ( uint32_t newBufferSize )

overrideprotected

Resizes the interleave buffer to match the host buffer size.

getDescription()

const char * BpmDetectPlugin::getDescription ( ) const

overrideprotected

Returns the plugin description.

getHomePage()

const char * BpmDetectPlugin::getHomePage ( ) const

overrideprotected

Returns the project homepage.

getLabel()

const char * BpmDetectPlugin::getLabel ( ) const

overrideprotected

Returns the plugin label.

getLicense()

const char * BpmDetectPlugin::getLicense ( ) const

overrideprotected

Returns the licence identifier.

getMaker()

const char * BpmDetectPlugin::getMaker ( ) const

overrideprotected

Returns the author name.

getParameterValue()

float BpmDetectPlugin::getParameterValue ( uint32_t index ) const

overrideprotected

Returns the current value of a parameter.

getUniqueId()

int64_t BpmDetectPlugin::getUniqueId ( ) const

overrideprotected

Returns the unique identifier used by some plugin formats.

getVersion()

uint32_t BpmDetectPlugin::getVersion ( ) const

overrideprotected

Returns the plugin version.

initParameter()

void BpmDetectPlugin::initParameter ( uint32_t index, Parameter & parameter )

overrideprotected

Describes a parameter to the host.

run()

void BpmDetectPlugin::run ( const float ** inputs, float ** outputs, uint32_t frames )

overrideprotected

Processes one block: passes audio through and queues it for analysis.

sampleRateChanged()

void BpmDetectPlugin::sampleRateChanged ( double newSampleRate )

overrideprotected

Records the new sample rate and requests a fresh detector.

setParameterValue()

void BpmDetectPlugin::setParameterValue ( uint32_t index, float value )

overrideprotected

Applies a parameter change from the host.

---

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

• plugin/bpmdetectplugin.h
• plugin/bpmdetectplugin.cpp