Carla/source/backend/engine/carla_engine_internal.hpp

/*
 * Carla Engine
 * Copyright (C) 2012-2013 Filipe Coelho <falktx@falktx.com>
 *
 * 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 COPYING file
 */

#ifndef __CARLA_ENGINE_INTERNAL_HPP__
#define __CARLA_ENGINE_INTERNAL_HPP__

#include "carla_engine.hpp"
#include "carla_engine_osc.hpp"
#include "carla_engine_thread.hpp"

#include "carla_plugin.hpp"

#include "rt_list.hpp"

#ifndef BUILD_BRIDGE
# include <QtCore/QProcessEnvironment>
#endif

CARLA_BACKEND_START_NAMESPACE

// -------------------------------------------------------------------------------------------------------------------

static inline
const char* CarlaEngineType2Str(const CarlaEngineType type)
{
    switch (type)
    {
    case CarlaEngineTypeNull:
        return "CarlaEngineTypeNull";
    case CarlaEngineTypeJack:
        return "CarlaEngineTypeJack";
    case CarlaEngineTypeRtAudio:
        return "CarlaEngineTypeRtAudio";
    case CarlaEngineTypePlugin:
        return "CarlaEngineTypePlugin";
    }

    qWarning("CarlaBackend::CarlaEngineType2Str(%i) - invalid type", type);
    return nullptr;
}

static inline
const char* CarlaEnginePortType2Str(const CarlaEnginePortType type)
{
    switch (type)
    {
    case CarlaEnginePortTypeNull:
        return "CarlaEnginePortTypeNull";
    case CarlaEnginePortTypeAudio:
        return "CarlaEnginePortTypeAudio";
    case CarlaEnginePortTypeControl:
        return "CarlaEnginePortTypeControl";
    case CarlaEnginePortTypeMIDI:
        return "CarlaEnginePortTypeMIDI";
    }

    qWarning("CarlaBackend::CarlaEnginePortType2Str(%i) - invalid type", type);
    return nullptr;
}

static inline
const char* CarlaEngineControlEventType2Str(const CarlaEngineControlEventType type)
{
    switch (type)
    {
    case CarlaEngineControlEventTypeNull:
        return "CarlaEngineNullEvent";
    case CarlaEngineControlEventTypeParameterChange:
        return "CarlaEngineControlEventTypeParameterChange";
    case CarlaEngineControlEventTypeMidiBankChange:
        return "CarlaEngineControlEventTypeMidiBankChange";
    case CarlaEngineControlEventTypeMidiProgramChange:
        return "CarlaEngineControlEventTypeMidiProgramChange";
    case CarlaEngineControlEventTypeAllSoundOff:
        return "CarlaEngineControlEventTypeAllSoundOff";
    case CarlaEngineControlEventTypeAllNotesOff:
        return "CarlaEngineControlEventTypeAllNotesOff";
    }

    qWarning("CarlaBackend::CarlaEngineControlEventType2Str(%i) - invalid type", type);
    return nullptr;
}

// -------------------------------------------------------------------------------------------------------------------

/*!
 * Maximum number of peaks per plugin.\n
 * \note There are both input and output peaks.
 */
/*static*/ const unsigned short MAX_PEAKS = 2;

const uint32_t       PATCHBAY_BUFFER_SIZE = 128;
const unsigned short PATCHBAY_EVENT_COUNT = 256;

enum EnginePostEventType {
    EnginePostEventNull,
    EnginePostEventDebug,
    PluginPostEventAddPlugin,   // id, ptr
    PluginPostEventRemovePlugin // id
};

struct EnginePostEvent {
    EnginePostEventType type;
    int32_t value1;
    void*   valuePtr;

    EnginePostEvent()
        : type(EnginePostEventNull),
          value1(-1),
          valuePtr(nullptr) {}
};

struct EnginePluginData {
    CarlaPlugin* const plugin;
    double insPeak[MAX_PEAKS];
    double outsPeak[MAX_PEAKS];

    EnginePluginData(CarlaPlugin* const plugin_)
        : plugin(plugin_),
          insPeak{0},
          outsPeak{0} {}

    EnginePluginData() = delete;
};

struct CarlaEnginePrivateData {
    CarlaEngineOsc    osc;
    CarlaEngineThread thread;

    ScopedPointer<const CarlaOscData> oscData;

    CallbackFunc callback;
    void*        callbackPtr;

    CarlaString  lastError;

#ifndef BUILD_BRIDGE
    QProcessEnvironment procEnv;
#endif

    // for postEvents
    CarlaMutex eventLock;

    // for external midi input (GUI and OSC)
    CarlaMutex midiLock;

    RtList<EnginePostEvent> postEvents;
    RtList<EnginePluginData> plugins;

    bool aboutToClose;
    unsigned int maxPluginNumber;
    unsigned int nextPluginId;

    CarlaEnginePrivateData(CarlaEngine* const engine)
        : osc(engine),
          thread(engine),
          oscData(nullptr),
          callback(nullptr),
          callbackPtr(nullptr),
          postEvents(1, 1),
          plugins(1, 1),
          aboutToClose(false),
          maxPluginNumber(0),
          nextPluginId(0) {}
};

CARLA_BACKEND_END_NAMESPACE

#endif // __CARLA_ENGINE_INTERNAL_HPP__