juce_AudioIODevice.h

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
class AudioIODevice;

struct AudioIODeviceCallbackContext
{
    const uint64_t* hostTimeNs = nullptr;
};
 
//==============================================================================
class JUCE_API  AudioIODeviceCallback
{
public:
    virtual ~AudioIODeviceCallback()  = default;

    virtual void audioDeviceIOCallbackWithContext (const float* const* inputChannelData,
                                                   int numInputChannels,
                                                   float* const* outputChannelData,
                                                   int numOutputChannels,
                                                   int numSamples,
                                                   const AudioIODeviceCallbackContext& context);

    virtual void audioDeviceAboutToStart (AudioIODevice* device) = 0;

    virtual void audioDeviceStopped() = 0;

    virtual void audioDeviceError (const String& errorMessage);
};
 
//==============================================================================
class JUCE_API  AudioIODevice
{
public:
    virtual ~AudioIODevice();
 
    //==============================================================================
    const String& getName() const noexcept                          { return name; }

    const String& getTypeName() const noexcept                      { return typeName; }
 
    //==============================================================================
    virtual StringArray getOutputChannelNames() = 0;

    virtual StringArray getInputChannelNames() = 0;
 
    //==============================================================================
    virtual std::optional<BigInteger> getDefaultOutputChannels() const { return {}; }

    virtual std::optional<BigInteger> getDefaultInputChannels()  const { return {}; }
 
    //==============================================================================
    virtual Array<double> getAvailableSampleRates() = 0;

    virtual Array<int> getAvailableBufferSizes() = 0;

    virtual int getDefaultBufferSize() = 0;
 
    //==============================================================================
    virtual String open (const BigInteger& inputChannels,
                         const BigInteger& outputChannels,
                         double sampleRate,
                         int bufferSizeSamples) = 0;

    virtual void close() = 0;

    virtual bool isOpen() = 0;

    virtual void start (AudioIODeviceCallback* callback) = 0;

    virtual void stop() = 0;

    virtual bool isPlaying() = 0;

    virtual String getLastError() = 0;
 
    //==============================================================================
    virtual int getCurrentBufferSizeSamples() = 0;

    virtual double getCurrentSampleRate() = 0;

    virtual int getCurrentBitDepth() = 0;

    virtual BigInteger getActiveOutputChannels() const = 0;

    virtual BigInteger getActiveInputChannels() const = 0;

    virtual int getOutputLatencyInSamples() = 0;

    virtual int getInputLatencyInSamples() = 0;

    virtual AudioWorkgroup getWorkgroup() const { return {}; }
 
    //==============================================================================
    virtual bool hasControlPanel() const;

    virtual bool showControlPanel();

    virtual bool setAudioPreprocessingEnabled (bool shouldBeEnabled);
 
    //==============================================================================
    virtual int getXRunCount() const noexcept;
 
    //==============================================================================
protected:
    AudioIODevice (const String& deviceName,
                   const String& typeName);

    String name, typeName;
};
 
} // namespace juce