#include <resampler_speaker.h>

Inheritance diagram for esphome::resampler::ResamplerSpeaker:

Public Member Functions
void	dump_config () override

void	setup () override

void	loop () override

size_t	play (const uint8_t *data, size_t length, TickType_t ticks_to_wait) override

size_t	play (const uint8_t *data, size_t length) override

void	start () override

void	stop () override

void	finish () override

void	set_pause_state (bool pause_state) override

bool	get_pause_state () const override

bool	has_buffered_data () const override

void	set_mute_state (bool mute_state) override
	Mute state changes are passed to the parent's output speaker.

bool	get_mute_state () override

void	set_volume (float volume) override
	Volume state changes are passed to the parent's output speaker.

float	get_volume () override

void	set_output_speaker (speaker::Speaker *speaker)

void	set_task_stack_in_psram (bool task_stack_in_psram)

void	set_target_bits_per_sample (uint8_t target_bits_per_sample)

void	set_target_sample_rate (uint32_t target_sample_rate)

void	set_passthrough_bits_per_sample (bool passthrough_bits_per_sample)
	When enabled, the input bits per sample are passed through to the output speaker unchanged instead of being converted to a fixed target.

void	set_filters (uint16_t filters)

void	set_taps (uint16_t taps)

void	set_buffer_duration (uint32_t buffer_duration_ms)

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)

bool	status_comm_result (bool ok)
	Clears the warning when `ok`, else sets it with `message` (default "Communication failed"); returns `ok`.

bool	status_comm_result (bool ok, 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::speaker::Speaker
size_t	play (const std::vector< uint8_t > &data)

bool	is_running () const

bool	is_stopped () const

void	set_audio_dac (audio_dac::AudioDac *audio_dac)

void	set_audio_stream_info (const audio::AudioStreamInfo &audio_stream_info)

audio::AudioStreamInfo &	get_audio_stream_info ()

template<typename F >
void	add_audio_output_callback (F &&callback)
	Callback function for sending the duration of the audio written to the speaker since the last callback.

Protected Member Functions
esp_err_t	start_ ()
	Starts the output speaker after setting the resampled stream info.

void	enter_stopping_state_ ()
	Transitions to STATE_STOPPING, records the stopping timestamp, sends the task stop command if the task is running, and stops the output speaker.

void	set_start_error_ (esp_err_t err)
	Sets the appropriate status error based on the start failure reason.

void	send_command_ (uint32_t command_bit, bool wake_loop=false)
	Sends a command via event group bits, enables the loop, and optionally wakes the main loop.

bool	requires_resampling_ () const

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 Member Functions inherited from esphome::speaker::Speaker
bool	is_silent_ () const
	Whether the output should be silent: muted, or the volume is effectively zero.

void	apply_audio_dac_mute_ ()
	Uses the audio dac's mute as the silence mechanism, since a dac's minimum volume is often audible.

Static Protected Member Functions
static void	resample_task (void *params)

Protected Attributes
EventGroupHandle_t	event_group_ {nullptr}

std::weak_ptr< ring_buffer::RingBuffer >	ring_buffer_

speaker::Speaker *	output_speaker_ {nullptr}

StaticTask	task_

audio::AudioStreamInfo	target_stream_info_

uint64_t	callback_remainder_ {0}

uint32_t	buffer_duration_ms_

uint32_t	state_start_ms_ {0}

uint32_t	target_sample_rate_

uint16_t	taps_

uint16_t	filters_

uint8_t	target_bits_per_sample_ {0}

bool	passthrough_bits_per_sample_ {false}

bool	task_stack_in_psram_ {false}

bool	waiting_for_output_ {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::speaker::Speaker
State	state_ {STATE_STOPPED}

bool	mute_state_ {false}

audio::AudioStreamInfo	audio_stream_info_

float	volume_ {1.0f}

audio_dac::AudioDac *	audio_dac_ {nullptr}

CallbackManager< void(uint32_t, int64_t)>	audio_output_callback_ {}

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

Detailed Description

Definition at line 17 of file resampler_speaker.h.

Member Function Documentation

◆ dump_config()

void esphome::resampler::ResamplerSpeaker::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file resampler_speaker.cpp.

◆ enter_stopping_state_()

void esphome::resampler::ResamplerSpeaker::enter_stopping_state_ ( )

protected

Transitions to STATE_STOPPING, records the stopping timestamp, sends the task stop command if the task is running, and stops the output speaker.

Definition at line 287 of file resampler_speaker.cpp.

◆ finish()

void esphome::resampler::ResamplerSpeaker::finish ( )

overridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 296 of file resampler_speaker.cpp.

◆ get_mute_state()

bool esphome::resampler::ResamplerSpeaker::get_mute_state ( )

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 37 of file resampler_speaker.h.

◆ get_pause_state()

bool esphome::resampler::ResamplerSpeaker::get_pause_state ( ) const

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 31 of file resampler_speaker.h.

◆ get_volume()

float esphome::resampler::ResamplerSpeaker::get_volume ( )

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 41 of file resampler_speaker.h.

◆ has_buffered_data()

bool esphome::resampler::ResamplerSpeaker::has_buffered_data ( ) const

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 298 of file resampler_speaker.cpp.

◆ loop()

void esphome::resampler::ResamplerSpeaker::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 83 of file resampler_speaker.cpp.

◆ play() [1/2]

size_t esphome::resampler::ResamplerSpeaker::play	(	const uint8_t *	data,
		size_t	length )

inlineoverridevirtual

Implements esphome::speaker::Speaker.

Definition at line 24 of file resampler_speaker.h.

◆ play() [2/2]

size_t esphome::resampler::ResamplerSpeaker::play	(	const uint8_t *	data,
		size_t	length,
		TickType_t	ticks_to_wait )

override

Definition at line 228 of file resampler_speaker.cpp.

◆ requires_resampling_()

bool esphome::resampler::ResamplerSpeaker::requires_resampling_ ( ) const

inlineprotected

Definition at line 319 of file resampler_speaker.cpp.

◆ resample_task()

void esphome::resampler::ResamplerSpeaker::resample_task ( void * params )

staticprotected

Definition at line 328 of file resampler_speaker.cpp.

◆ send_command_()

void esphome::resampler::ResamplerSpeaker::send_command_	(	uint32_t	command_bit,
		bool	wake_loop = false )

protected

Sends a command via event group bits, enables the loop, and optionally wakes the main loop.

Definition at line 250 of file resampler_speaker.cpp.

◆ set_buffer_duration()

void esphome::resampler::ResamplerSpeaker::set_buffer_duration ( uint32_t buffer_duration_ms )

inline

Definition at line 60 of file resampler_speaker.h.

◆ set_filters()

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

inline

Definition at line 57 of file resampler_speaker.h.

◆ set_mute_state()

void esphome::resampler::ResamplerSpeaker::set_mute_state ( bool mute_state )

overridevirtual

Mute state changes are passed to the parent's output speaker.

Reimplemented from esphome::speaker::Speaker.

Definition at line 309 of file resampler_speaker.cpp.

◆ set_output_speaker()

void esphome::resampler::ResamplerSpeaker::set_output_speaker ( speaker::Speaker * speaker )

inline

Definition at line 43 of file resampler_speaker.h.

◆ set_passthrough_bits_per_sample()

void esphome::resampler::ResamplerSpeaker::set_passthrough_bits_per_sample ( bool passthrough_bits_per_sample )

inline

When enabled, the input bits per sample are passed through to the output speaker unchanged instead of being converted to a fixed target.

Only the sample rate is resampled if it differs from the target.

Definition at line 53 of file resampler_speaker.h.

◆ set_pause_state()

void esphome::resampler::ResamplerSpeaker::set_pause_state ( bool pause_state )

inlineoverridevirtual

Reimplemented from esphome::speaker::Speaker.

Definition at line 30 of file resampler_speaker.h.

◆ set_start_error_()

void esphome::resampler::ResamplerSpeaker::set_start_error_ ( esp_err_t err )

protected

Sets the appropriate status error based on the start failure reason.

Definition at line 217 of file resampler_speaker.cpp.

◆ set_taps()

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

inline

Definition at line 58 of file resampler_speaker.h.

◆ set_target_bits_per_sample()

void esphome::resampler::ResamplerSpeaker::set_target_bits_per_sample ( uint8_t target_bits_per_sample )

inline

Definition at line 46 of file resampler_speaker.h.

◆ set_target_sample_rate()

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

inline

Definition at line 49 of file resampler_speaker.h.

◆ set_task_stack_in_psram()

void esphome::resampler::ResamplerSpeaker::set_task_stack_in_psram ( bool task_stack_in_psram )

inline

Definition at line 44 of file resampler_speaker.h.

◆ set_volume()

void esphome::resampler::ResamplerSpeaker::set_volume ( float volume )

overridevirtual

Volume state changes are passed to the parent's output speaker.

Reimplemented from esphome::speaker::Speaker.

Definition at line 314 of file resampler_speaker.cpp.

◆ setup()

void esphome::resampler::ResamplerSpeaker::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 58 of file resampler_speaker.cpp.

◆ start()

void esphome::resampler::ResamplerSpeaker::start ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 261 of file resampler_speaker.cpp.

◆ start_()

esp_err_t esphome::resampler::ResamplerSpeaker::start_ ( )

protected

Starts the output speaker after setting the resampled stream info.

If resampling is required, it starts the task.

Returns: ESP_OK if successful, ESP_ERR_NO_MEM if the resampler task couldn't be created

Definition at line 263 of file resampler_speaker.cpp.

◆ stop()

void esphome::resampler::ResamplerSpeaker::stop ( )

overridevirtual

Implements esphome::speaker::Speaker.

Definition at line 285 of file resampler_speaker.cpp.

Field Documentation

◆ buffer_duration_ms_

uint32_t esphome::resampler::ResamplerSpeaker::buffer_duration_ms_

protected

Definition at line 94 of file resampler_speaker.h.

◆ callback_remainder_

uint64_t esphome::resampler::ResamplerSpeaker::callback_remainder_ {0}

protected

Definition at line 92 of file resampler_speaker.h.

◆ event_group_

EventGroupHandle_t esphome::resampler::ResamplerSpeaker::event_group_ {nullptr}

protected

Definition at line 82 of file resampler_speaker.h.

◆ filters_

uint16_t esphome::resampler::ResamplerSpeaker::filters_

protected

Definition at line 99 of file resampler_speaker.h.

◆ output_speaker_

speaker::Speaker* esphome::resampler::ResamplerSpeaker::output_speaker_ {nullptr}

protected

Definition at line 86 of file resampler_speaker.h.

◆ passthrough_bits_per_sample_

bool esphome::resampler::ResamplerSpeaker::passthrough_bits_per_sample_ {false}

protected

Definition at line 103 of file resampler_speaker.h.

◆ ring_buffer_

std::weak_ptr<ring_buffer::RingBuffer> esphome::resampler::ResamplerSpeaker::ring_buffer_

protected

Definition at line 84 of file resampler_speaker.h.

◆ state_start_ms_

uint32_t esphome::resampler::ResamplerSpeaker::state_start_ms_ {0}

protected

Definition at line 95 of file resampler_speaker.h.

◆ taps_

uint16_t esphome::resampler::ResamplerSpeaker::taps_

protected

Definition at line 98 of file resampler_speaker.h.

◆ target_bits_per_sample_

uint8_t esphome::resampler::ResamplerSpeaker::target_bits_per_sample_ {0}

protected

Definition at line 101 of file resampler_speaker.h.

◆ target_sample_rate_

uint32_t esphome::resampler::ResamplerSpeaker::target_sample_rate_

protected

Definition at line 96 of file resampler_speaker.h.

◆ target_stream_info_

audio::AudioStreamInfo esphome::resampler::ResamplerSpeaker::target_stream_info_

protected

Definition at line 90 of file resampler_speaker.h.

◆ task_

StaticTask esphome::resampler::ResamplerSpeaker::task_

protected

Definition at line 88 of file resampler_speaker.h.

◆ task_stack_in_psram_

bool esphome::resampler::ResamplerSpeaker::task_stack_in_psram_ {false}

protected

Definition at line 104 of file resampler_speaker.h.

◆ waiting_for_output_

bool esphome::resampler::ResamplerSpeaker::waiting_for_output_ {false}

protected

Definition at line 105 of file resampler_speaker.h.

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

esphome/components/resampler/speaker/resampler_speaker.h
esphome/components/resampler/speaker/resampler_speaker.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ enter_stopping_state_()

◆ finish()

◆ get_mute_state()

◆ get_pause_state()

◆ get_volume()

◆ has_buffered_data()

◆ loop()

◆ play() [1/2]

◆ play() [2/2]

◆ requires_resampling_()

◆ resample_task()

◆ send_command_()

◆ set_buffer_duration()

◆ set_filters()

◆ set_mute_state()

◆ set_output_speaker()

◆ set_passthrough_bits_per_sample()

◆ set_pause_state()

◆ set_start_error_()

◆ set_taps()

◆ set_target_bits_per_sample()

◆ set_target_sample_rate()

◆ set_task_stack_in_psram()

◆ set_volume()

◆ setup()

◆ start()

◆ start_()

◆ stop()

Field Documentation

◆ buffer_duration_ms_

◆ callback_remainder_

◆ event_group_

◆ filters_

◆ output_speaker_

◆ passthrough_bits_per_sample_

◆ ring_buffer_

◆ state_start_ms_

◆ taps_

◆ target_bits_per_sample_

◆ target_sample_rate_

◆ target_stream_info_

◆ task_

◆ task_stack_in_psram_

◆ waiting_for_output_