Microphone that converts the audio of a source microphone to a different sample rate. More...

#include <resampler_microphone.h>

Inheritance diagram for esphome::resampler::ResamplerMicrophone:

Public Member Functions
	ResamplerMicrophone (microphone::MicrophoneSource *source)

void	setup () override

void	loop () override

void	dump_config () override

void	start () override

void	stop () override

void	set_target_sample_rate (uint32_t target_sample_rate)

void	set_filters (uint16_t filters)

void	set_taps (uint16_t taps)

Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Public Member Functions inherited from esphome::microphone::Microphone
template<typename F >
void	add_data_callback (F &&data_callback)

bool	is_running () const

bool	is_stopped () const

void	set_mute_state (bool is_muted)

bool	get_mute_state ()

audio::AudioStreamInfo	get_audio_stream_info ()

Protected Member Functions
bool	init_resampler_ (const audio::AudioStreamInfo &input_stream_info)
	Sets up the resampler for the given input format.

void	process_audio_ (const std::vector< uint8_t > &data)
	Resamples a chunk of source audio and passes it to the data callbacks. Source microphone task only.

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
microphone::MicrophoneSource *	source_

std::unique_ptr< esp_audio_libs::resampler::Resampler >	resampler_

std::vector< uint8_t >	output_buffer_

audio::AudioStreamInfo	input_stream_info_

uint32_t	target_sample_rate_

uint16_t	taps_

uint16_t	filters_

uint8_t	active_listeners_ {0}

bool	resampler_ready_ {false}

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Protected Attributes inherited from esphome::microphone::Microphone
State	state_ {STATE_STOPPED}

bool	mute_state_ {false}

audio::AudioStreamInfo	audio_stream_info_

CallbackManager< void(const std::vector< uint8_t > &)>	data_callbacks_ {}

Additional Inherited Members
Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Detailed Description

Microphone that converts the audio of a source microphone to a different sample rate.

The bits per sample and channels are selected by the source's MicrophoneSource; only the sample rate changes. Resampling runs in the source microphone's data callback, so it needs no task or ring buffer of its own.

Definition at line 21 of file resampler_microphone.h.

Constructor & Destructor Documentation

◆ ResamplerMicrophone()

esphome::resampler::ResamplerMicrophone::ResamplerMicrophone ( microphone::MicrophoneSource * source )

inlineexplicit

Definition at line 23 of file resampler_microphone.h.

Member Function Documentation

◆ dump_config()

void esphome::resampler::ResamplerMicrophone::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file resampler_microphone.cpp.

◆ init_resampler_()

bool esphome::resampler::ResamplerMicrophone::init_resampler_ ( const audio::AudioStreamInfo & input_stream_info )

protected

Sets up the resampler for the given input format.

No resampler is needed if the sample rates match.

Returns: false if the resampler failed to allocate; the audio is then dropped

Definition at line 87 of file resampler_microphone.cpp.

◆ loop()

void esphome::resampler::ResamplerMicrophone::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 56 of file resampler_microphone.cpp.

◆ process_audio_()

void esphome::resampler::ResamplerMicrophone::process_audio_ ( const std::vector< uint8_t > & data )

protected

Resamples a chunk of source audio and passes it to the data callbacks. Source microphone task only.

Definition at line 130 of file resampler_microphone.cpp.

◆ set_filters()

void esphome::resampler::ResamplerMicrophone::set_filters ( uint16_t filters )

inline

Definition at line 33 of file resampler_microphone.h.

◆ set_taps()

void esphome::resampler::ResamplerMicrophone::set_taps ( uint16_t taps )

inline

Definition at line 34 of file resampler_microphone.h.

◆ set_target_sample_rate()

void esphome::resampler::ResamplerMicrophone::set_target_sample_rate ( uint32_t target_sample_rate )

inline

Definition at line 32 of file resampler_microphone.h.

◆ setup()

void esphome::resampler::ResamplerMicrophone::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file resampler_microphone.cpp.

◆ start()

void esphome::resampler::ResamplerMicrophone::start ( )

overridevirtual

Implements esphome::microphone::Microphone.

Definition at line 42 of file resampler_microphone.cpp.

◆ stop()

void esphome::resampler::ResamplerMicrophone::stop ( )

overridevirtual

Implements esphome::microphone::Microphone.

Definition at line 49 of file resampler_microphone.cpp.

Field Documentation

◆ active_listeners_

uint8_t esphome::resampler::ResamplerMicrophone::active_listeners_ {0}

protected

Definition at line 56 of file resampler_microphone.h.

◆ filters_

uint16_t esphome::resampler::ResamplerMicrophone::filters_

protected

Definition at line 54 of file resampler_microphone.h.

◆ input_stream_info_

audio::AudioStreamInfo esphome::resampler::ResamplerMicrophone::input_stream_info_

protected

Definition at line 50 of file resampler_microphone.h.

◆ output_buffer_

std::vector<uint8_t> esphome::resampler::ResamplerMicrophone::output_buffer_

protected

Definition at line 47 of file resampler_microphone.h.

◆ resampler_

std::unique_ptr<esp_audio_libs::resampler::Resampler> esphome::resampler::ResamplerMicrophone::resampler_

protected

Definition at line 45 of file resampler_microphone.h.

◆ resampler_ready_

bool esphome::resampler::ResamplerMicrophone::resampler_ready_ {false}

protected

Definition at line 57 of file resampler_microphone.h.

◆ source_

microphone::MicrophoneSource* esphome::resampler::ResamplerMicrophone::source_

protected

Definition at line 44 of file resampler_microphone.h.

◆ taps_

uint16_t esphome::resampler::ResamplerMicrophone::taps_

protected

Definition at line 53 of file resampler_microphone.h.

◆ target_sample_rate_

uint32_t esphome::resampler::ResamplerMicrophone::target_sample_rate_

protected

Definition at line 52 of file resampler_microphone.h.

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

esphome/components/resampler/microphone/resampler_microphone.h
esphome/components/resampler/microphone/resampler_microphone.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ResamplerMicrophone()

Member Function Documentation

◆ dump_config()

◆ init_resampler_()

◆ loop()

◆ process_audio_()

◆ set_filters()

◆ set_taps()

◆ set_target_sample_rate()

◆ setup()

◆ start()

◆ stop()

Field Documentation

◆ active_listeners_

◆ filters_

◆ input_stream_info_

◆ output_buffer_

◆ resampler_

◆ resampler_ready_

◆ source_

◆ taps_

◆ target_sample_rate_