pc_speaker.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef MM_SHARED_CLASSIC_PC_SPEAKER_H
#define MM_SHARED_CLASSIC_PC_SPEAKER_H

#include "common/scummsys.h"

namespace Audio {
class PCSpeaker;
}

namespace MM {
namespace Shared {
namespace Classic {

struct PitSequenceEntry {
    uint16 durationTicks;
    uint16 pitDivisor;
};

struct FrequencySequenceEntry {
    uint32 lengthUs;
    float frequency;
};

class PcSpeaker {
private:
    Audio::PCSpeaker *_speaker = nullptr;
    const PitSequenceEntry *_loopingPitSequence = nullptr;
    uint32 _loopingPitTickMicros = 0;
    bool _ready = false;

    void queuePitSequence(const PitSequenceEntry *sequence, uint32 tickMicros);

public:
    PcSpeaker();
    ~PcSpeaker();

    bool init();
    void stop();
    bool isPlaying() const;

    void playTone(int frequency, int32 lengthMs);
    void queueTone(float frequency, uint32 lengthUs);
    void queueSilence(uint32 lengthUs);
    void playPitSequence(const PitSequenceEntry *sequence, uint32 tickMicros, bool append = false, bool loop = false);
    void playFrequencySequence(const FrequencySequenceEntry *sequence);
    void update();
};

} // namespace Classic
} // namespace Shared
} // namespace MM

#endif