/* * Carla Plugin Host * Copyright (C) 2011-2014 Filipe Coelho * * 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 2 of * the License, or 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. * * For a full copy of the GNU General Public License see the GPL.txt file */ #include "CarlaEngineGraph.hpp" #include "CarlaEngineInternal.hpp" #include "CarlaBackendUtils.hpp" #include "CarlaStringList.hpp" #include "RtLinkedList.hpp" #include "juce_audio_devices.h" using namespace juce; CARLA_BACKEND_START_NAMESPACE // ------------------------------------------------------------------------------------------------------------------- // Global static data static CharStringListPtr gDeviceNames; static OwnedArray gDeviceTypes; struct JuceCleanup : public DeletedAtShutdown { JuceCleanup() noexcept {} ~JuceCleanup() { gDeviceTypes.clear(true); } }; // ------------------------------------------------------------------------------------------------------------------- // Cleanup static void initJuceDevicesIfNeeded() { static AudioDeviceManager sDeviceManager; if (gDeviceTypes.size() != 0) return; sDeviceManager.createAudioDeviceTypes(gDeviceTypes); CARLA_SAFE_ASSERT_RETURN(gDeviceTypes.size() != 0,); new JuceCleanup(); // remove JACK from device list for (int i=0, count=gDeviceTypes.size(); i < count; ++i) { if (gDeviceTypes[i]->getTypeName() == "JACK") { gDeviceTypes.remove(i, true); break; } } } // ------------------------------------------------------------------------------------------------------------------- // Juce Engine class CarlaEngineJuce : public CarlaEngine, public AudioIODeviceCallback, public MidiInputCallback { public: CarlaEngineJuce(AudioIODeviceType* const devType) : CarlaEngine(), AudioIODeviceCallback(), fDevice(), fDeviceType(devType), fMidiIns(), fMidiInEvents(), fMidiOuts(), fMidiOutMutex(), leakDetector_CarlaEngineJuce() { carla_debug("CarlaEngineJuce::CarlaEngineJuce(%p)", devType); // just to make sure pData->options.transportMode = ENGINE_TRANSPORT_MODE_INTERNAL; } ~CarlaEngineJuce() override { carla_debug("CarlaEngineJuce::~CarlaEngineJuce()"); } // ------------------------------------- bool init(const char* const clientName) override { CARLA_SAFE_ASSERT_RETURN(clientName != nullptr && clientName[0] != '\0', false); carla_debug("CarlaEngineJuce::init(\"%s\")", clientName); if (pData->options.processMode != ENGINE_PROCESS_MODE_CONTINUOUS_RACK && pData->options.processMode != ENGINE_PROCESS_MODE_PATCHBAY) { setLastError("Invalid process mode"); return false; } String deviceName; if (pData->options.audioDevice != nullptr && pData->options.audioDevice[0] != '\0') { deviceName = pData->options.audioDevice; } else { const int defaultIndex(fDeviceType->getDefaultDeviceIndex(false)); StringArray deviceNames(fDeviceType->getDeviceNames()); if (defaultIndex >= 0 && defaultIndex < deviceNames.size()) deviceName = deviceNames[defaultIndex]; } if (deviceName.isEmpty()) { setLastError("Audio device has not been selected yet and a default one is not available"); return false; } fDevice = fDeviceType->createDevice(deviceName, deviceName); if (fDevice == nullptr) { setLastError("Failed to create device"); return false; } StringArray inputNames(fDevice->getInputChannelNames()); StringArray outputNames(fDevice->getOutputChannelNames()); if (inputNames.size() < 0 || outputNames.size() <= 0) { setLastError("Selected device does not have any outputs"); return false; } BigInteger inputChannels; inputChannels.setRange(0, inputNames.size(), true); BigInteger outputChannels; outputChannels.setRange(0, outputNames.size(), true); String error = fDevice->open(inputChannels, outputChannels, pData->options.audioSampleRate, static_cast(pData->options.audioBufferSize)); if (error.isNotEmpty()) { setLastError(error.toUTF8()); fDevice = nullptr; return false; } if (! pData->init(clientName)) { close(); setLastError("Failed to init internal data"); return false; } pData->bufferSize = static_cast(fDevice->getCurrentBufferSizeSamples()); pData->sampleRate = fDevice->getCurrentSampleRate(); pData->graph.create(static_cast(inputNames.size()), static_cast(outputNames.size())); fDevice->start(this); patchbayRefresh(false); if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY) refreshExternalGraphPorts(pData->graph.getPatchbayGraph(), false); callback(ENGINE_CALLBACK_ENGINE_STARTED, 0, pData->options.processMode, pData->options.transportMode, 0.0f, getCurrentDriverName()); return true; } bool close() override { carla_debug("CarlaEngineJuce::close()"); bool hasError = false; // stop stream first if (fDevice != nullptr && fDevice->isPlaying()) fDevice->stop(); // clear engine data CarlaEngine::close(); pData->graph.destroy(); for (LinkedList::Itenerator it = fMidiIns.begin(); it.valid(); it.next()) { MidiInPort& inPort(it.getValue()); CARLA_SAFE_ASSERT_CONTINUE(inPort.port != nullptr); inPort.port->stop(); delete inPort.port; } fMidiIns.clear(); fMidiInEvents.clear(); fMidiOutMutex.lock(); for (LinkedList::Itenerator it = fMidiOuts.begin(); it.valid(); it.next()) { MidiOutPort& outPort(it.getValue()); CARLA_SAFE_ASSERT_CONTINUE(outPort.port != nullptr); outPort.port->stopBackgroundThread(); delete outPort.port; } fMidiOuts.clear(); fMidiOutMutex.unlock(); // close stream if (fDevice != nullptr) { if (fDevice->isOpen()) fDevice->close(); fDevice = nullptr; } return !hasError; } bool isRunning() const noexcept override { return fDevice != nullptr && fDevice->isOpen(); } bool isOffline() const noexcept override { return false; } EngineType getType() const noexcept override { return kEngineTypeJuce; } const char* getCurrentDriverName() const noexcept override { return fDeviceType->getTypeName().toRawUTF8(); } // ------------------------------------------------------------------- // Patchbay template bool refreshExternalGraphPorts(Graph* const graph, const bool sendCallback) { CARLA_SAFE_ASSERT_RETURN(graph != nullptr, false); char strBuf[STR_MAX+1]; strBuf[STR_MAX] = '\0'; ExternalGraph& extGraph(graph->extGraph); // --------------------------------------------------------------- // clear last ports extGraph.clear(); // --------------------------------------------------------------- // fill in new ones // Audio In { StringArray inputNames(fDevice->getInputChannelNames()); for (int i=0, count=inputNames.size(); igetOutputChannelNames()); for (int i=0, count=outputNames.size(); igetName()); if (deviceName.isNotEmpty()) deviceName = deviceName.dropLastCharacters(deviceName.fromFirstOccurrenceOf(", ", true, false).length()); graph->refresh(deviceName.toRawUTF8()); } // --------------------------------------------------------------- // add midi connections for (LinkedList::Itenerator it=fMidiIns.begin(); it.valid(); it.next()) { const MidiInPort& inPort(it.getValue()); const uint portId(extGraph.midiPorts.getPortId(true, inPort.name)); CARLA_SAFE_ASSERT_CONTINUE(portId < extGraph.midiPorts.ins.count()); ConnectionToId connectionToId; connectionToId.setData(++(extGraph.connections.lastId), kExternalGraphGroupMidiIn, portId, kExternalGraphGroupCarla, kExternalGraphCarlaPortMidiIn); std::snprintf(strBuf, STR_MAX, "%i:%i:%i:%i", connectionToId.groupA, connectionToId.portA, connectionToId.groupB, connectionToId.portB); callback(ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED, connectionToId.id, 0, 0, 0.0f, strBuf); extGraph.connections.list.append(connectionToId); } fMidiOutMutex.lock(); for (LinkedList::Itenerator it=fMidiOuts.begin(); it.valid(); it.next()) { const MidiOutPort& outPort(it.getValue()); const uint portId(extGraph.midiPorts.getPortId(false, outPort.name)); CARLA_SAFE_ASSERT_CONTINUE(portId < extGraph.midiPorts.outs.count()); ConnectionToId connectionToId; connectionToId.setData(++(extGraph.connections.lastId), kExternalGraphGroupCarla, kExternalGraphCarlaPortMidiOut, kExternalGraphGroupMidiOut, portId); std::snprintf(strBuf, STR_MAX, "%i:%i:%i:%i", connectionToId.groupA, connectionToId.portA, connectionToId.groupB, connectionToId.portB); callback(ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED, connectionToId.id, 0, 0, 0.0f, strBuf); extGraph.connections.list.append(connectionToId); } fMidiOutMutex.unlock(); return true; } bool patchbayRefresh(const bool external) override { CARLA_SAFE_ASSERT_RETURN(pData->graph.isReady(), false); if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK) { return refreshExternalGraphPorts(pData->graph.getRackGraph(), true); } else { pData->graph.setUsingExternal(external); if (external) return refreshExternalGraphPorts(pData->graph.getPatchbayGraph(), true); else return CarlaEngine::patchbayRefresh(false); } return false; } // ------------------------------------------------------------------- protected: void audioDeviceIOCallback(const float** inputChannelData, int numInputChannels, float** outputChannelData, int numOutputChannels, int numSamples) override { const PendingRtEventsRunner prt(this); // assert juce buffers CARLA_SAFE_ASSERT_RETURN(numInputChannels >= 0,); CARLA_SAFE_ASSERT_RETURN(numOutputChannels > 0,); CARLA_SAFE_ASSERT_RETURN(outputChannelData != nullptr,); CARLA_SAFE_ASSERT_RETURN(numSamples == static_cast(pData->bufferSize),); const uint32_t nframes(static_cast(numSamples)); // initialize juce output for (int i=0; i < numOutputChannels; ++i) FloatVectorOperations::clear(outputChannelData[i], numSamples); // initialize events carla_zeroStruct(pData->events.in, kMaxEngineEventInternalCount); carla_zeroStruct(pData->events.out, kMaxEngineEventInternalCount); if (fMidiInEvents.mutex.tryLock()) { uint32_t engineEventIndex = 0; fMidiInEvents.splice(); for (LinkedList::Itenerator it = fMidiInEvents.data.begin(); it.valid(); it.next()) { const RtMidiEvent& midiEvent(it.getValue()); EngineEvent& engineEvent(pData->events.in[engineEventIndex++]); if (midiEvent.time < pData->timeInfo.frame) { engineEvent.time = 0; } else if (midiEvent.time >= pData->timeInfo.frame + nframes) { carla_stderr("MIDI Event in the future!, %i vs %i", engineEvent.time, pData->timeInfo.frame); engineEvent.time = static_cast(pData->timeInfo.frame) + nframes - 1; } else engineEvent.time = static_cast(midiEvent.time - pData->timeInfo.frame); engineEvent.fillFromMidiData(midiEvent.size, midiEvent.data); if (engineEventIndex >= kMaxEngineEventInternalCount) break; } fMidiInEvents.data.clear(); fMidiInEvents.mutex.unlock(); } pData->graph.process(pData, inputChannelData, outputChannelData, static_cast(numSamples)); fMidiOutMutex.lock(); if (fMidiOuts.count() > 0) { uint8_t size = 0; uint8_t data[3] = { 0, 0, 0 }; const uint8_t* dataPtr = data; for (ushort i=0; i < kMaxEngineEventInternalCount; ++i) { const EngineEvent& engineEvent(pData->events.out[i]); if (engineEvent.type == kEngineEventTypeNull) break; else if (engineEvent.type == kEngineEventTypeControl) { const EngineControlEvent& ctrlEvent(engineEvent.ctrl); ctrlEvent.convertToMidiData(engineEvent.channel, size, data); dataPtr = data; } else if (engineEvent.type == kEngineEventTypeMidi) { const EngineMidiEvent& midiEvent(engineEvent.midi); size = midiEvent.size; if (size > EngineMidiEvent::kDataSize && midiEvent.dataExt != nullptr) dataPtr = midiEvent.dataExt; else dataPtr = midiEvent.data; } else { continue; } if (size > 0) { MidiMessage message(static_cast(dataPtr), static_cast(size), static_cast(engineEvent.time)/nframes); for (LinkedList::Itenerator it=fMidiOuts.begin(); it.valid(); it.next()) { MidiOutPort& outPort(it.getValue()); CARLA_SAFE_ASSERT_CONTINUE(outPort.port != nullptr); outPort.port->sendMessageNow(message); } } } } fMidiOutMutex.unlock(); } void audioDeviceAboutToStart(AudioIODevice* /*device*/) override { } void audioDeviceStopped() override { } void audioDeviceError(const String& errorMessage) override { callback(ENGINE_CALLBACK_ERROR, 0, 0, 0, 0.0f, errorMessage.toRawUTF8()); } // ------------------------------------------------------------------- void handleIncomingMidiMessage(MidiInput* /*source*/, const MidiMessage& message) override { const int messageSize(message.getRawDataSize()); if (messageSize <= 0 || messageSize > EngineMidiEvent::kDataSize) return; const uint8_t* const messageData(message.getRawData()); RtMidiEvent midiEvent; midiEvent.time = 0; // TODO midiEvent.size = static_cast(messageSize); int i=0; for (; i < messageSize; ++i) midiEvent.data[i] = messageData[i]; for (; i < EngineMidiEvent::kDataSize; ++i) midiEvent.data[i] = 0; fMidiInEvents.append(midiEvent); } // ------------------------------------------------------------------- bool connectExternalGraphPort(const uint connectionType, const uint portId, const char* const portName) override { CARLA_SAFE_ASSERT_RETURN(connectionType != 0 || (portName != nullptr && portName[0] != '\0'), false); carla_stdout("CarlaEngineJuce::connectExternalGraphPort(%u, %u, \"%s\")", connectionType, portId, portName); switch (connectionType) { case kExternalGraphConnectionAudioIn1: case kExternalGraphConnectionAudioIn2: case kExternalGraphConnectionAudioOut1: case kExternalGraphConnectionAudioOut2: return CarlaEngine::connectExternalGraphPort(connectionType, portId, portName); case kExternalGraphConnectionMidiInput: { StringArray midiIns(MidiInput::getDevices()); if (! midiIns.contains(portName)) return false; MidiInput* const juceMidiIn(MidiInput::openDevice(midiIns.indexOf(portName), this)); juceMidiIn->start(); MidiInPort midiPort; midiPort.port = juceMidiIn; std::strncpy(midiPort.name, portName, STR_MAX); midiPort.name[STR_MAX] = '\0'; fMidiIns.append(midiPort); return true; } break; case kExternalGraphConnectionMidiOutput: { StringArray midiOuts(MidiOutput::getDevices()); if (! midiOuts.contains(portName)) return false; MidiOutput* const juceMidiOut(MidiOutput::openDevice(midiOuts.indexOf(portName))); juceMidiOut->startBackgroundThread(); MidiOutPort midiPort; midiPort.port = juceMidiOut; std::strncpy(midiPort.name, portName, STR_MAX); midiPort.name[STR_MAX] = '\0'; const CarlaMutexLocker cml(fMidiOutMutex); fMidiOuts.append(midiPort); return true; } break; } return false; } bool disconnectExternalGraphPort(const uint connectionType, const uint portId, const char* const portName) override { CARLA_SAFE_ASSERT_RETURN(connectionType != 0 || (portName != nullptr && portName[0] != '\0'), false); carla_debug("CarlaEngineJuce::disconnectExternalGraphPort(%u, %u, \"%s\")", connectionType, portId, portName); switch (connectionType) { case kExternalGraphConnectionAudioIn1: case kExternalGraphConnectionAudioIn2: case kExternalGraphConnectionAudioOut1: case kExternalGraphConnectionAudioOut2: return CarlaEngine::disconnectExternalGraphPort(connectionType, portId, portName); case kExternalGraphConnectionMidiInput: for (LinkedList::Itenerator it=fMidiIns.begin(); it.valid(); it.next()) { MidiInPort& inPort(it.getValue()); CARLA_SAFE_ASSERT_CONTINUE(inPort.port != nullptr); if (std::strcmp(inPort.name, portName) != 0) continue; inPort.port->stop(); delete inPort.port; fMidiIns.remove(it); return true; } break; case kExternalGraphConnectionMidiOutput: { const CarlaMutexLocker cml(fMidiOutMutex); for (LinkedList::Itenerator it=fMidiOuts.begin(); it.valid(); it.next()) { MidiOutPort& outPort(it.getValue()); CARLA_SAFE_ASSERT_CONTINUE(outPort.port != nullptr); if (std::strcmp(outPort.name, portName) != 0) continue; outPort.port->stopBackgroundThread(); delete outPort.port; fMidiOuts.remove(it); return true; } } break; } return false; } // ------------------------------------- private: ScopedPointer fDevice; AudioIODeviceType* const fDeviceType; struct MidiInPort { MidiInput* port; char name[STR_MAX+1]; }; struct MidiOutPort { MidiOutput* port; char name[STR_MAX+1]; }; struct RtMidiEvent { uint64_t time; // needs to compare to internal time uint8_t size; uint8_t data[EngineMidiEvent::kDataSize]; }; struct RtMidiEvents { CarlaMutex mutex; RtLinkedList::Pool dataPool; RtLinkedList data; RtLinkedList dataPending; RtMidiEvents() : mutex(), dataPool(512, 512), data(dataPool), dataPending(dataPool) {} ~RtMidiEvents() { clear(); } void append(const RtMidiEvent& event) { mutex.lock(); dataPending.append(event); mutex.unlock(); } void clear() { mutex.lock(); data.clear(); dataPending.clear(); mutex.unlock(); } void splice() { if (dataPending.count() > 0) dataPending.moveTo(data, true /* append */); } }; LinkedList fMidiIns; RtMidiEvents fMidiInEvents; LinkedList fMidiOuts; CarlaMutex fMidiOutMutex; CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJuce) }; // ----------------------------------------- CarlaEngine* CarlaEngine::newJuce(const AudioApi api) { initJuceDevicesIfNeeded(); String juceApi; switch (api) { case AUDIO_API_NULL: case AUDIO_API_OSS: case AUDIO_API_PULSE: break; case AUDIO_API_JACK: juceApi = "JACK"; break; case AUDIO_API_ALSA: juceApi = "ALSA"; break; case AUDIO_API_CORE: juceApi = "CoreAudio"; break; case AUDIO_API_ASIO: juceApi = "ASIO"; break; case AUDIO_API_DS: juceApi = "DirectSound"; break; } if (juceApi.isEmpty()) return nullptr; AudioIODeviceType* deviceType = nullptr; for (int i=0, count=gDeviceTypes.size(); i < count; ++i) { deviceType = gDeviceTypes[i]; if (deviceType == nullptr || deviceType->getTypeName() == juceApi) break; } if (deviceType == nullptr) return nullptr; deviceType->scanForDevices(); return new CarlaEngineJuce(deviceType); } uint CarlaEngine::getJuceApiCount() { initJuceDevicesIfNeeded(); return static_cast(gDeviceTypes.size()); } const char* CarlaEngine::getJuceApiName(const uint uindex) { initJuceDevicesIfNeeded(); const int index(static_cast(uindex)); CARLA_SAFE_ASSERT_RETURN(index < gDeviceTypes.size(), nullptr); AudioIODeviceType* const deviceType(gDeviceTypes[index]); CARLA_SAFE_ASSERT_RETURN(deviceType != nullptr, nullptr); return deviceType->getTypeName().toRawUTF8(); } const char* const* CarlaEngine::getJuceApiDeviceNames(const uint uindex) { initJuceDevicesIfNeeded(); const int index(static_cast(uindex)); CARLA_SAFE_ASSERT_RETURN(index < gDeviceTypes.size(), nullptr); AudioIODeviceType* const deviceType(gDeviceTypes[index]); CARLA_SAFE_ASSERT_RETURN(deviceType != nullptr, nullptr); deviceType->scanForDevices(); StringArray juceDeviceNames(deviceType->getDeviceNames()); const int juceDeviceNameCount(juceDeviceNames.size()); if (juceDeviceNameCount <= 0) return nullptr; CarlaStringList devNames; for (int i=0; i < juceDeviceNameCount; ++i) devNames.append(juceDeviceNames[i].toRawUTF8()); gDeviceNames = devNames.toCharStringListPtr(); return gDeviceNames; } const EngineDriverDeviceInfo* CarlaEngine::getJuceDeviceInfo(const uint uindex, const char* const deviceName) { initJuceDevicesIfNeeded(); const int index(static_cast(uindex)); CARLA_SAFE_ASSERT_RETURN(index < gDeviceTypes.size(), nullptr); AudioIODeviceType* const deviceType(gDeviceTypes[index]); CARLA_SAFE_ASSERT_RETURN(deviceType != nullptr, nullptr); deviceType->scanForDevices(); ScopedPointer device(deviceType->createDevice(deviceName, deviceName)); if (device == nullptr) return nullptr; static EngineDriverDeviceInfo devInfo = { 0x0, nullptr, nullptr }; static uint32_t dummyBufferSizes[11] = { 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 0 }; static double dummySampleRates[14] = { 22050.0, 32000.0, 44100.0, 48000.0, 88200.0, 96000.0, 176400.0, 192000.0, 0.0 }; // reset devInfo.hints = ENGINE_DRIVER_DEVICE_VARIABLE_BUFFER_SIZE | ENGINE_DRIVER_DEVICE_VARIABLE_SAMPLE_RATE; // cleanup if (devInfo.bufferSizes != nullptr && devInfo.bufferSizes != dummyBufferSizes) { delete[] devInfo.bufferSizes; devInfo.bufferSizes = nullptr; } if (devInfo.sampleRates != nullptr && devInfo.sampleRates != dummySampleRates) { delete[] devInfo.sampleRates; devInfo.sampleRates = nullptr; } if (device->hasControlPanel()) devInfo.hints |= ENGINE_DRIVER_DEVICE_HAS_CONTROL_PANEL; Array juceBufferSizes = device->getAvailableBufferSizes(); if (int bufferSizesCount = juceBufferSizes.size()) { uint32_t* const bufferSizes(new uint32_t[bufferSizesCount+1]); for (int i=0; i < bufferSizesCount; ++i) bufferSizes[i] = static_cast(juceBufferSizes[i]); bufferSizes[bufferSizesCount] = 0; devInfo.bufferSizes = bufferSizes; } else { devInfo.bufferSizes = dummyBufferSizes; } Array juceSampleRates = device->getAvailableSampleRates(); if (int sampleRatesCount = juceSampleRates.size()) { double* const sampleRates(new double[sampleRatesCount+1]); for (int i=0; i < sampleRatesCount; ++i) sampleRates[i] = juceSampleRates[i]; sampleRates[sampleRatesCount] = 0.0; devInfo.sampleRates = sampleRates; } else { devInfo.sampleRates = dummySampleRates; } return &devInfo; } // ----------------------------------------- CARLA_BACKEND_END_NAMESPACE