juce_AudioDeviceManager.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   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 JUCE_API  AudioDeviceManager  : public ChangeBroadcaster
{
public:
    //==============================================================================
    AudioDeviceManager();

    ~AudioDeviceManager() override;
 
    //==============================================================================
    struct JUCE_API  AudioDeviceSetup
    {
        String outputDeviceName;

        String inputDeviceName;

        double sampleRate = 0;

        int bufferSize = 0;

        BigInteger inputChannels;

        bool useDefaultInputChannels = true;

        BigInteger outputChannels;

        bool useDefaultOutputChannels = true;
 
        bool operator== (const AudioDeviceSetup&) const;
        bool operator!= (const AudioDeviceSetup&) const;
    };
 
 
    //==============================================================================
    String initialise (int numInputChannelsNeeded,
                       int numOutputChannelsNeeded,
                       const XmlElement* savedState,
                       bool selectDefaultDeviceOnFailure,
                       const String& preferredDefaultDeviceName = String(),
                       const AudioDeviceSetup* preferredSetupOptions = nullptr);

    String initialiseWithDefaultDevices (int numInputChannelsNeeded,
                                         int numOutputChannelsNeeded);

    std::unique_ptr<XmlElement> createStateXml() const;
 
    //==============================================================================
    AudioDeviceSetup getAudioDeviceSetup() const;

    void getAudioDeviceSetup (AudioDeviceSetup& result) const;

    String setAudioDeviceSetup (const AudioDeviceSetup& newSetup, bool treatAsChosenDevice);
 

    AudioIODevice* getCurrentAudioDevice() const noexcept               { return currentAudioDevice.get(); }

    String getCurrentAudioDeviceType() const                            { return currentDeviceType; }

    AudioIODeviceType* getCurrentDeviceTypeObject() const;

    void setCurrentAudioDeviceType (const String& type, bool treatAsChosenDevice);

    void closeAudioDevice();

    void restartLastAudioDevice();
 
    //==============================================================================
    void addAudioCallback (AudioIODeviceCallback* newCallback);

    void removeAudioCallback (AudioIODeviceCallback* callback);
 
    //==============================================================================
    double getCpuUsage() const;
 
    //==============================================================================
    void setMidiInputDeviceEnabled (const String& deviceIdentifier, bool enabled);

    bool isMidiInputDeviceEnabled (const String& deviceIdentifier) const;

    void addMidiInputDeviceCallback (const String& deviceIdentifier,
                                     MidiInputCallback* callback);

    void removeMidiInputDeviceCallback (const String& deviceIdentifier,
                                        MidiInputCallback* callback);
 
    //==============================================================================
    void setDefaultMidiOutputDevice (const String& deviceIdentifier);

    const String& getDefaultMidiOutputIdentifier() const noexcept   { return defaultMidiOutputDeviceInfo.identifier; }

    MidiOutput* getDefaultMidiOutput() const noexcept               { return defaultMidiOutput.get(); }
 
    //==============================================================================
    const OwnedArray<AudioIODeviceType>& getAvailableDeviceTypes();

    virtual void createAudioDeviceTypes (OwnedArray<AudioIODeviceType>& types);

    void addAudioDeviceType (std::unique_ptr<AudioIODeviceType> newDeviceType);

    void removeAudioDeviceType (AudioIODeviceType* deviceTypeToRemove);
 
    //==============================================================================
    void playTestSound();
 
    //==============================================================================
    struct LevelMeter    : public ReferenceCountedObject
    {
        LevelMeter() noexcept;
        double getCurrentLevel() const noexcept;
 
        using Ptr = ReferenceCountedObjectPtr<LevelMeter>;
 
    private:
        friend class AudioDeviceManager;
 
        Atomic<float> level { 0 };
        void updateLevel (const float* const*, int numChannels, int numSamples) noexcept;
    };

    LevelMeter::Ptr getInputLevelGetter() noexcept          { return inputLevelGetter; }

    LevelMeter::Ptr getOutputLevelGetter() noexcept         { return outputLevelGetter; }
 
    //==============================================================================
    CriticalSection& getAudioCallbackLock() noexcept        { return audioCallbackLock; }

    CriticalSection& getMidiCallbackLock() noexcept         { return midiCallbackLock; }
 
    //==============================================================================
    int getXRunCount() const noexcept;
 
    //==============================================================================
   #ifndef DOXYGEN
    [[deprecated ("Use setMidiInputDeviceEnabled instead.")]]
    void setMidiInputEnabled (const String&, bool);
    [[deprecated ("Use isMidiInputDeviceEnabled instead.")]]
    bool isMidiInputEnabled (const String&) const;
    [[deprecated ("Use addMidiInputDeviceCallback instead.")]]
    void addMidiInputCallback (const String&, MidiInputCallback*);
    [[deprecated ("Use removeMidiInputDeviceCallback instead.")]]
    void removeMidiInputCallback (const String&, MidiInputCallback*);
    [[deprecated ("Use setDefaultMidiOutputDevice instead.")]]
    void setDefaultMidiOutput (const String&);
    [[deprecated ("Use getDefaultMidiOutputIdentifier instead.")]]
    const String& getDefaultMidiOutputName() const noexcept  { return defaultMidiOutputDeviceInfo.name; }
   #endif
 
private:
    //==============================================================================
    OwnedArray<AudioIODeviceType> availableDeviceTypes;
    OwnedArray<AudioDeviceSetup> lastDeviceTypeConfigs;
 
    AudioDeviceSetup currentSetup;
    std::unique_ptr<AudioIODevice> currentAudioDevice;
    Array<AudioIODeviceCallback*> callbacks;
    int numInputChansNeeded = 0, numOutputChansNeeded = 2;
    String preferredDeviceName, currentDeviceType;
    std::unique_ptr<XmlElement> lastExplicitSettings;
    mutable bool listNeedsScanning = true;
    AudioBuffer<float> tempBuffer;
 
    struct MidiCallbackInfo
    {
        String deviceIdentifier;
        MidiInputCallback* callback;
    };
 
    Array<MidiDeviceInfo> midiDeviceInfosFromXml;
    std::vector<std::unique_ptr<MidiInput>> enabledMidiInputs;
    Array<MidiCallbackInfo> midiCallbacks;
 
    MidiDeviceInfo defaultMidiOutputDeviceInfo;
    std::unique_ptr<MidiOutput> defaultMidiOutput;
    CriticalSection audioCallbackLock, midiCallbackLock;
 
    std::unique_ptr<AudioBuffer<float>> testSound;
    int testSoundPosition = 0;
 
    AudioProcessLoadMeasurer loadMeasurer;
 
    LevelMeter::Ptr inputLevelGetter   { new LevelMeter() },
                    outputLevelGetter  { new LevelMeter() };
 
    //==============================================================================
    class CallbackHandler;
    std::unique_ptr<CallbackHandler> callbackHandler;
 
    void audioDeviceIOCallbackInt (const float** inputChannelData,
                                   int totalNumInputChannels,
                                   float** outputChannelData,
                                   int totalNumOutputChannels,
                                   int numSamples,
                                   const AudioIODeviceCallbackContext& context);
    void audioDeviceAboutToStartInt (AudioIODevice*);
    void audioDeviceStoppedInt();
    void audioDeviceErrorInt (const String&);
    void handleIncomingMidiMessageInt (MidiInput*, const MidiMessage&);
    void audioDeviceListChanged();
 
    String restartDevice (int blockSizeToUse, double sampleRateToUse,
                          const BigInteger& ins, const BigInteger& outs);
    void stopDevice();
 
    void updateXml();
 
    void updateCurrentSetup();
    void createDeviceTypesIfNeeded();
    void scanDevicesIfNeeded();
    void deleteCurrentDevice();
    double chooseBestSampleRate (double preferred) const;
    int chooseBestBufferSize (int preferred) const;
    void insertDefaultDeviceNames (AudioDeviceSetup&) const;
    String initialiseDefault (const String& preferredDefaultDeviceName, const AudioDeviceSetup*);
    String initialiseFromXML (const XmlElement&, bool selectDefaultDeviceOnFailure,
                              const String& preferredDefaultDeviceName, const AudioDeviceSetup*);
 
    AudioIODeviceType* findType (const String& inputName, const String& outputName);
    AudioIODeviceType* findType (const String& typeName);
    void pickCurrentDeviceTypeWithDevices();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioDeviceManager)
};
 
} // namespace juce