source/bridges-ui/CarlaBridgeFormat.hpp

   1 /*
   2  * Carla Bridge UI
   3  * Copyright (C) 2011-2021 Filipe Coelho <falktx@falktx.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of
   8  * the License, or any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16  */
  17
  18 #ifndef CARLA_BRIDGE_FORMAT_HPP_INCLUDED
  19 #define CARLA_BRIDGE_FORMAT_HPP_INCLUDED
  20
  21 #include "CarlaBridgeUI.hpp"
  22
  23 #include "CarlaLibUtils.hpp"
  24 #include "CarlaPipeUtils.hpp"
  25 #include "CarlaString.hpp"
  26
  27 #include "lv2/atom.h"
  28 #include "lv2/urid.h"
  29
  30 #include <vector>
  31
  32 CARLA_BRIDGE_UI_START_NAMESPACE
  33
  34 /*!
  35  * @defgroup CarlaBridgeUIAPI Carla UI Bridge API
  36  *
  37  * The Carla UI Bridge API.
  38  * @{
  39  */
  40
  41 // -----------------------------------------------------------------------
  42
  43 class CarlaBridgeFormat : public CarlaPipeClient
  44 {
  45 protected:
  46     /*!
  47      * Constructor.
  48      */
  49     CarlaBridgeFormat() noexcept;
  50
  51     /*!
  52      * Destructor.
  53      */
  54     virtual ~CarlaBridgeFormat() /*noexcept*/;
  55
  56     // ---------------------------------------------------------------------
  57
  58     bool libOpen(const char* filename) noexcept;
  59     void* libSymbol(const char* symbol) const noexcept;
  60     const char* libError() const noexcept;
  61
  62     // ---------------------------------------------------------------------
  63     // DSP Callbacks
  64
  65     virtual void dspParameterChanged(uint32_t index, float value) = 0;
  66     virtual void dspParameterChanged(const char* uri, float value) = 0;
  67     virtual void dspProgramChanged(uint32_t index) = 0;
  68     virtual void dspMidiProgramChanged(uint32_t bank, uint32_t program) = 0;
  69     virtual void dspStateChanged(const char* key, const char* value) = 0;
  70     virtual void dspNoteReceived(bool onOff, uint8_t channel, uint8_t note, uint8_t velocity) = 0;
  71
  72     virtual void dspAtomReceived(uint32_t index, const LV2_Atom* atom) = 0;
  73     virtual void dspURIDReceived(LV2_URID urid, const char* uri) = 0;
  74
  75     struct BridgeFormatOptions {
  76         double sampleRate;
  77         uint32_t bgColor;
  78         uint32_t fgColor;
  79         float uiScale;
  80         bool isStandalone;
  81         bool useTheme;
  82         bool useThemeColors;
  83         const char* windowTitle;
  84         uintptr_t transientWindowId;
  85     };
  86
  87     virtual void uiOptionsChanged(const BridgeFormatOptions& opts) = 0;
  88
  89 public:
  90     // ---------------------------------------------------------------------
  91     // UI initialization
  92
  93     virtual bool init(int argc, const char* argv[]);
  94     virtual void exec(bool showUI);
  95     virtual void idleUI() {}
  96
  97     // ---------------------------------------------------------------------
  98     // UI management
  99
 100     /*!
 101      * Get the widget associated with this UI.
 102      * This can be a Gtk widget, Qt widget or a native Window handle depending on the compile target.
 103      */
 104     virtual void* getWidget() const noexcept = 0;
 105
 106 #ifndef CARLA_OS_MAC
 107     /*!
 108      * TESTING
 109      */
 110     virtual void setScaleFactor(double scaleFactor) = 0;
 111 #endif
 112
 113     /*!
 114      * TESTING
 115      */
 116     virtual void uiResized(uint width, uint height) = 0;
 117
 118     /*!
 119      * Options.
 120      */
 121     struct Options {
 122         /*!
 123          * UI is standalone, not controlled by another application.
 124          */
 125         bool isStandalone;
 126
 127         /*!
 128          * UI is resizable by the user.
 129          * The UI can still sometimes resize itself internally if this is false.
 130          */
 131         bool isResizable;
 132
 133         /*!
 134          * Use the Carla PRO theme if possible.
 135          */
 136         bool useTheme;
 137
 138         /*!
 139          * Use the Carla PRO theme colors if possible.
 140          * This implies useTheme to be true.
 141          */
 142         bool useThemeColors;
 143
 144         /*!
 145          * Window title.
 146          */
 147         CarlaString windowTitle;
 148
 149         /*!
 150          * Transient window id (parent), zero if unset.
 151          */
 152         uintptr_t transientWindowId;
 153
 154         /*!
 155          * Constructor for default options.
 156          */
 157         Options() noexcept
 158             : isStandalone(true),
 159               isResizable(true),
 160               useTheme(true),
 161               useThemeColors(true),
 162               windowTitle("TestUI"),
 163               transientWindowId(0) {}
 164     };
 165
 166     /*!
 167      * Get options associated with this UI.
 168      */
 169     virtual const Options& getOptions() const noexcept = 0;
 170
 171     // ---------------------------------------------------------------------
 172
 173 protected:
 174     bool fQuitReceived;
 175     bool fGotOptions;
 176     int  fLastMsgTimer;
 177     CarlaBridgeToolkit* fToolkit;
 178
 179     lib_t fLib;
 180     CarlaString fLibFilename;
 181     std::vector<uint8_t> fBase64ReservedChunk;
 182
 183     /*! @internal */
 184     bool msgReceived(const char* msg) noexcept override;
 185
 186     CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaBridgeFormat)
 187 };
 188
 189 /**@}*/
 190
 191 // -----------------------------------------------------------------------
 192
 193 CARLA_BRIDGE_UI_END_NAMESPACE
 194
 195 #endif // CARLA_BRIDGE_FORMAT_HPP_INCLUDED