Buzzer.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later

 
#pragma once
 
#include "App/Element/GraphicElements/AudioOutputElement.h"
 
class QAudioSink;
class ToneGenerator;

class Buzzer : public AudioOutputElement
{
    Q_OBJECT
 
public:
    static constexpr double kDefaultFrequency = 1047.0;

    static constexpr float kDefaultVolume = 0.35f;

    explicit Buzzer(QGraphicsItem *parent = nullptr);

    Buzzer(const Buzzer &other) : Buzzer(other.parentItem()) {}
 
    // --- State Queries ---

    double frequency() const override;
 
    // --- Playback Control ---

    void setFrequency(double freq) override;
    void setAudio(const QString &note) override;
 
    // --- Serialization ---

    void load(QDataStream &stream, SerializationContext &context) override;
    void save(QDataStream &stream, SerializationOptions options) const override;

    static int noteToFrequency(const QString &note);
 
protected:
    // --- AudioOutputElement hooks ---
 
    void startAudio() override;
    void stopAudio() override;
    void applyVolume() override;
    void applyMute() override;
 
private:
    QAudioSink *m_sink = nullptr;
    ToneGenerator *m_generator = nullptr;
    double m_frequency = kDefaultFrequency;
};