fix some small rtttl issues (#6817)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
NP v/d Spek 2024-08-15 06:51:44 +02:00 committed by GitHub
parent 965141fad7
commit 5c31ab4060
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 121 additions and 27 deletions

View file

@ -29,6 +29,13 @@ inline double deg2rad(double degrees) {
void Rtttl::dump_config() { ESP_LOGCONFIG(TAG, "Rtttl"); } void Rtttl::dump_config() { ESP_LOGCONFIG(TAG, "Rtttl"); }
void Rtttl::play(std::string rtttl) { void Rtttl::play(std::string rtttl) {
if (this->state_ != State::STATE_STOPPED && this->state_ != State::STATE_STOPPING) {
int pos = this->rtttl_.find(':');
auto name = this->rtttl_.substr(0, pos);
ESP_LOGW(TAG, "RTTL Component is already playing: %s", name.c_str());
return;
}
this->rtttl_ = std::move(rtttl); this->rtttl_ = std::move(rtttl);
this->default_duration_ = 4; this->default_duration_ = 4;
@ -98,13 +105,20 @@ void Rtttl::play(std::string rtttl) {
this->note_duration_ = 1; this->note_duration_ = 1;
#ifdef USE_SPEAKER #ifdef USE_SPEAKER
if (this->speaker_ != nullptr) {
this->set_state_(State::STATE_INIT);
this->samples_sent_ = 0; this->samples_sent_ = 0;
this->samples_count_ = 0; this->samples_count_ = 0;
}
#endif
#ifdef USE_OUTPUT
if (this->output_ != nullptr) {
this->set_state_(State::STATE_RUNNING);
}
#endif #endif
} }
void Rtttl::stop() { void Rtttl::stop() {
this->note_duration_ = 0;
#ifdef USE_OUTPUT #ifdef USE_OUTPUT
if (this->output_ != nullptr) { if (this->output_ != nullptr) {
this->output_->set_level(0.0); this->output_->set_level(0.0);
@ -117,16 +131,35 @@ void Rtttl::stop() {
} }
} }
#endif #endif
this->note_duration_ = 0;
this->set_state_(STATE_STOPPING);
} }
void Rtttl::loop() { void Rtttl::loop() {
if (this->note_duration_ == 0) if (this->note_duration_ == 0 || this->state_ == State::STATE_STOPPED)
return; return;
#ifdef USE_SPEAKER #ifdef USE_SPEAKER
if (this->speaker_ != nullptr) { if (this->speaker_ != nullptr) {
if (this->state_ == State::STATE_STOPPING) {
if (this->speaker_->is_stopped()) {
this->set_state_(State::STATE_STOPPED);
}
} else if (this->state_ == State::STATE_INIT) {
if (this->speaker_->is_stopped()) {
this->speaker_->start();
this->set_state_(State::STATE_STARTING);
}
} else if (this->state_ == State::STATE_STARTING) {
if (this->speaker_->is_running()) {
this->set_state_(State::STATE_RUNNING);
}
}
if (!this->speaker_->is_running()) {
return;
}
if (this->samples_sent_ != this->samples_count_) { if (this->samples_sent_ != this->samples_count_) {
SpeakerSample sample[SAMPLE_BUFFER_SIZE + 1]; SpeakerSample sample[SAMPLE_BUFFER_SIZE + 2];
int x = 0; int x = 0;
double rem = 0.0; double rem = 0.0;
@ -136,7 +169,7 @@ void Rtttl::loop() {
if (this->samples_per_wave_ != 0 && this->samples_sent_ >= this->samples_gap_) { // Play note// if (this->samples_per_wave_ != 0 && this->samples_sent_ >= this->samples_gap_) { // Play note//
rem = ((this->samples_sent_ << 10) % this->samples_per_wave_) * (360.0 / this->samples_per_wave_); rem = ((this->samples_sent_ << 10) % this->samples_per_wave_) * (360.0 / this->samples_per_wave_);
int16_t val = (49152 * this->gain_) * sin(deg2rad(rem)); int16_t val = (127 * this->gain_) * sin(deg2rad(rem)); // 16bit = 49152
sample[x].left = val; sample[x].left = val;
sample[x].right = val; sample[x].right = val;
@ -153,9 +186,9 @@ void Rtttl::loop() {
x++; x++;
} }
if (x > 0) { if (x > 0) {
int send = this->speaker_->play((uint8_t *) (&sample), x * 4); int send = this->speaker_->play((uint8_t *) (&sample), x * 2);
if (send != x * 4) { if (send != x * 4) {
this->samples_sent_ -= (x - (send / 4)); this->samples_sent_ -= (x - (send / 2));
} }
return; return;
} }
@ -167,14 +200,7 @@ void Rtttl::loop() {
return; return;
#endif #endif
if (!this->rtttl_[position_]) { if (!this->rtttl_[position_]) {
this->note_duration_ = 0; this->finish_();
#ifdef USE_OUTPUT
if (this->output_ != nullptr) {
this->output_->set_level(0.0);
}
#endif
ESP_LOGD(TAG, "Playback finished");
this->on_finished_playback_callback_.call();
return; return;
} }
@ -213,6 +239,7 @@ void Rtttl::loop() {
case 'a': case 'a':
note = 10; note = 10;
break; break;
case 'h':
case 'b': case 'b':
note = 12; note = 12;
break; break;
@ -238,14 +265,21 @@ void Rtttl::loop() {
uint8_t scale = get_integer_(); uint8_t scale = get_integer_();
if (scale == 0) if (scale == 0)
scale = this->default_octave_; scale = this->default_octave_;
if (scale < 4 || scale > 7) {
ESP_LOGE(TAG, "Octave out of valid range. Should be between 4 and 7. (Octave: %d)", scale);
this->finish_();
return;
}
bool need_note_gap = false; bool need_note_gap = false;
// Now play the note // Now play the note
if (note) { if (note) {
auto note_index = (scale - 4) * 12 + note; auto note_index = (scale - 4) * 12 + note;
if (note_index < 0 || note_index >= (int) sizeof(NOTES)) { if (note_index < 0 || note_index >= (int) sizeof(NOTES)) {
ESP_LOGE(TAG, "Note out of valid range"); ESP_LOGE(TAG, "Note out of valid range (note: %d, scale: %d, index: %d, max: %d)", note, scale, note_index,
this->note_duration_ = 0; (int) sizeof(NOTES));
this->finish_();
return; return;
} }
auto freq = NOTES[note_index]; auto freq = NOTES[note_index];
@ -285,14 +319,17 @@ void Rtttl::loop() {
this->samples_gap_ = (this->sample_rate_ * DOUBLE_NOTE_GAP_MS) / 1600; //(ms); this->samples_gap_ = (this->sample_rate_ * DOUBLE_NOTE_GAP_MS) / 1600; //(ms);
} }
if (this->output_freq_ != 0) { if (this->output_freq_ != 0) {
// make sure there is enough samples to add a full last sinus.
uint16_t samples_wish = this->samples_count_;
this->samples_per_wave_ = (this->sample_rate_ << 10) / this->output_freq_; this->samples_per_wave_ = (this->sample_rate_ << 10) / this->output_freq_;
// make sure there is enough samples to add a full last sinus.
uint16_t division = ((this->samples_count_ << 10) / this->samples_per_wave_) + 1; uint16_t division = ((this->samples_count_ << 10) / this->samples_per_wave_) + 1;
uint16_t x = this->samples_count_;
this->samples_count_ = (division * this->samples_per_wave_); this->samples_count_ = (division * this->samples_per_wave_);
ESP_LOGD(TAG, "play time old: %d div: %d new: %d %d", x, division, this->samples_count_, this->samples_per_wave_);
this->samples_count_ = this->samples_count_ >> 10; this->samples_count_ = this->samples_count_ >> 10;
ESP_LOGVV(TAG, "- Calc play time: wish: %d gets: %d (div: %d spw: %d)", samples_wish, this->samples_count_,
division, this->samples_per_wave_);
} }
// Convert from frequency in Hz to high and low samples in fixed point // Convert from frequency in Hz to high and low samples in fixed point
} }
@ -301,5 +338,53 @@ void Rtttl::loop() {
this->last_note_ = millis(); this->last_note_ = millis();
} }
void Rtttl::finish_() {
#ifdef USE_OUTPUT
if (this->output_ != nullptr) {
this->output_->set_level(0.0);
}
#endif
#ifdef USE_SPEAKER
if (this->speaker_ != nullptr) {
SpeakerSample sample[2];
sample[0].left = 0;
sample[0].right = 0;
sample[1].left = 0;
sample[1].right = 0;
this->speaker_->play((uint8_t *) (&sample), 8);
this->speaker_->finish();
}
#endif
this->set_state_(State::STATE_STOPPING);
this->note_duration_ = 0;
this->on_finished_playback_callback_.call();
ESP_LOGD(TAG, "Playback finished");
}
static const LogString *state_to_string(State state) {
switch (state) {
case STATE_STOPPED:
return LOG_STR("STATE_STOPPED");
case STATE_STARTING:
return LOG_STR("STATE_STARTING");
case STATE_RUNNING:
return LOG_STR("STATE_RUNNING");
case STATE_STOPPING:
return LOG_STR("STATE_STOPPING");
case STATE_INIT:
return LOG_STR("STATE_INIT");
default:
return LOG_STR("UNKNOWN");
}
};
void Rtttl::set_state_(State state) {
State old_state = this->state_;
this->state_ = state;
ESP_LOGD(TAG, "State changed from %s to %s", LOG_STR_ARG(state_to_string(old_state)),
LOG_STR_ARG(state_to_string(state)));
}
} // namespace rtttl } // namespace rtttl
} // namespace esphome } // namespace esphome

View file

@ -14,12 +14,20 @@
namespace esphome { namespace esphome {
namespace rtttl { namespace rtttl {
enum State : uint8_t {
STATE_STOPPED = 0,
STATE_INIT,
STATE_STARTING,
STATE_RUNNING,
STATE_STOPPING,
};
#ifdef USE_SPEAKER #ifdef USE_SPEAKER
static const size_t SAMPLE_BUFFER_SIZE = 512; static const size_t SAMPLE_BUFFER_SIZE = 2048;
struct SpeakerSample { struct SpeakerSample {
int16_t left{0}; int8_t left{0};
int16_t right{0}; int8_t right{0};
}; };
#endif #endif
@ -42,7 +50,7 @@ class Rtttl : public Component {
void stop(); void stop();
void dump_config() override; void dump_config() override;
bool is_playing() { return this->note_duration_ != 0; } bool is_playing() { return this->state_ != State::STATE_STOPPED; }
void loop() override; void loop() override;
void add_on_finished_playback_callback(std::function<void()> callback) { void add_on_finished_playback_callback(std::function<void()> callback) {
@ -57,6 +65,8 @@ class Rtttl : public Component {
} }
return ret; return ret;
} }
void finish_();
void set_state_(State state);
std::string rtttl_{""}; std::string rtttl_{""};
size_t position_{0}; size_t position_{0};
@ -68,13 +78,12 @@ class Rtttl : public Component {
uint32_t output_freq_; uint32_t output_freq_;
float gain_{0.6f}; float gain_{0.6f};
State state_{State::STATE_STOPPED};
#ifdef USE_OUTPUT #ifdef USE_OUTPUT
output::FloatOutput *output_; output::FloatOutput *output_;
#endif #endif
void play_output_();
#ifdef USE_SPEAKER #ifdef USE_SPEAKER
speaker::Speaker *speaker_{nullptr}; speaker::Speaker *speaker_{nullptr};
int sample_rate_{16000}; int sample_rate_{16000};