SoundDevice.hh

Go to the documentation of this file.

#ifndef SOUNDDEVICE_HH
#define SOUNDDEVICE_HH

#include "MSXMixer.hh"
#include "EmuTime.hh"
#include "FixedPoint.hh"
#include "string_view.hh"
#include <memory>

namespace openmsx {

class DeviceConfig;
class Wav16Writer;
class Filename;
class DynamicClock;

class SoundDevice
{
public:
        using VolumeType = FixedPoint<MSXMixer::AMP_BITS>;
        static const unsigned MAX_CHANNELS = 24;

        const std::string& getName() const { return name; }

        const std::string& getDescription() const { return description; }

        bool isStereo() const;

        std::pair<VolumeType, VolumeType> getAmplificationFactor() const {
                auto f = getAmplificationFactorImpl();
                return std::make_pair(f * softwareVolumeLeft,
                                      f * softwareVolumeRight);
        }

        void setSoftwareVolume(VolumeType volume, EmuTime::param time);
        void setSoftwareVolume(VolumeType left, VolumeType right, EmuTime::param time);

        void recordChannel(unsigned channel, const Filename& filename);
        void muteChannel  (unsigned channel, bool muted);

protected:
        SoundDevice(MSXMixer& mixer, string_view name, string_view description,
                    unsigned numChannels, bool stereo = false);
        ~SoundDevice();

        virtual int getAmplificationFactorImpl() const;

        void registerSound(const DeviceConfig& config);

        void unregisterSound();

        void updateStream(EmuTime::param time);

        void setInputRate(unsigned sampleRate) { inputSampleRate = sampleRate; }
        unsigned getInputRate() const { return inputSampleRate; }

public: // Will be called by Mixer:
        virtual void setOutputRate(unsigned sampleRate) = 0;

        virtual bool updateBuffer(unsigned length, int* buffer,
                                  EmuTime::param time) = 0;

protected:
        static void addFill(int*& buffer, int value, unsigned num);

        virtual void generateChannels(int** buffers, unsigned num) = 0;

        bool mixChannels(int* dataOut, unsigned num);

        const DynamicClock& getHostSampleClock() const;
        double getEffectiveSpeed() const;

private:
        MSXMixer& mixer;
        const std::string name;
        const std::string description;

        std::unique_ptr<Wav16Writer> writer[MAX_CHANNELS];

        VolumeType softwareVolumeLeft{1};
        VolumeType softwareVolumeRight{1};
        unsigned inputSampleRate;
        const unsigned numChannels;
        const unsigned stereo;
        unsigned numRecordChannels;
        int channelBalance[MAX_CHANNELS];
        bool channelMuted[MAX_CHANNELS];
        bool balanceCenter;
};

} // namespace openmsx

#endif