source/utils/CarlaJsfxUtils.hpp

   1 /*
   2  * Carla JSFX utils
   3  * Copyright (C) 2021 Jean Pierre Cimalando
   4  * Copyright (C) 2021-2022 Filipe Coelho <falktx@falktx.com>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of
   9  * the License, or any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  17  */
  18
  19 #ifndef CARLA_JSFX_UTILS_HPP_INCLUDED
  20 #define CARLA_JSFX_UTILS_HPP_INCLUDED
  21
  22 #include "CarlaDefines.h"
  23 #include "CarlaBackend.h"
  24 #include "CarlaUtils.hpp"
  25 #include "CarlaJuceUtils.hpp"
  26
  27 #include "water/files/File.h"
  28 #include "water/text/String.h"
  29
  30 #ifdef YSFX_API
  31 # error YSFX_API is not private
  32 #endif
  33 #include "ysfx/include/ysfx.h"
  34
  35 #include <memory>
  36
  37 CARLA_BACKEND_START_NAMESPACE
  38
  39 // --------------------------------------------------------------------------------------------------------------------
  40
  41 struct CarlaJsfxLogging
  42 {
  43     static void logAll(intptr_t, const ysfx_log_level level, const char* const message)
  44     {
  45         switch (level)
  46         {
  47         case ysfx_log_info:
  48             carla_stdout("%s: %s", ysfx_log_level_string(level), message);
  49             break;
  50         case ysfx_log_warning:
  51             carla_stderr("%s: %s", ysfx_log_level_string(level), message);
  52             break;
  53         case ysfx_log_error:
  54             carla_stderr2("%s: %s", ysfx_log_level_string(level), message);
  55             break;
  56         }
  57     };
  58
  59     static void logErrorsOnly(intptr_t, const ysfx_log_level level, const char* const message)
  60     {
  61         switch (level)
  62         {
  63         case ysfx_log_info:
  64             break;
  65         case ysfx_log_warning:
  66             carla_stderr("%s: %s", ysfx_log_level_string(level), message);
  67             break;
  68         case ysfx_log_error:
  69             carla_stderr2("%s: %s", ysfx_log_level_string(level), message);
  70             break;
  71         }
  72     };
  73 };
  74
  75 // --------------------------------------------------------------------------------------------------------------------
  76
  77 struct CarlaJsfxCategories
  78 {
  79     static PluginCategory getFromEffect(ysfx_t* effect)
  80     {
  81         PluginCategory category = PLUGIN_CATEGORY_OTHER;
  82
  83         if (const uint32_t tagCount = ysfx_get_tags(effect, nullptr, 0))
  84         {
  85             std::vector<const char*> tags;
  86             tags.resize(tagCount);
  87             ysfx_get_tags(effect, tags.data(), tagCount);
  88
  89             for (uint32_t i=0; i<tagCount && category == PLUGIN_CATEGORY_OTHER; ++i)
  90             {
  91                 water::CharPointer_UTF8 tag(tags[i]);
  92                 PluginCategory current = getFromTag(tag);
  93                 if (current != PLUGIN_CATEGORY_NONE)
  94                     category = current;
  95             }
  96         }
  97
  98         return category;
  99     }
 100
 101     static PluginCategory getFromTag(const water::CharPointer_UTF8 tag)
 102     {
 103         if (tag.compareIgnoreCase(water::CharPointer_UTF8("synthesis")) == 0)
 104             return PLUGIN_CATEGORY_SYNTH;
 105
 106         if (tag.compareIgnoreCase(water::CharPointer_UTF8("delay")) == 0)
 107             return PLUGIN_CATEGORY_DELAY;
 108
 109         if (tag.compareIgnoreCase(water::CharPointer_UTF8("equalizer")) == 0)
 110             return PLUGIN_CATEGORY_EQ;
 111
 112         if (tag.compareIgnoreCase(water::CharPointer_UTF8("filter")) == 0)
 113             return PLUGIN_CATEGORY_FILTER;
 114
 115         if (tag.compareIgnoreCase(water::CharPointer_UTF8("distortion")) == 0)
 116             return PLUGIN_CATEGORY_DISTORTION;
 117
 118         if (tag.compareIgnoreCase(water::CharPointer_UTF8("dynamics")) == 0)
 119             return PLUGIN_CATEGORY_DYNAMICS;
 120
 121         if (tag.compareIgnoreCase(water::CharPointer_UTF8("modulation")) == 0)
 122             return PLUGIN_CATEGORY_MODULATOR;
 123
 124         if (tag.compareIgnoreCase(water::CharPointer_UTF8("utility")) == 0)
 125             return PLUGIN_CATEGORY_UTILITY;
 126
 127         return PLUGIN_CATEGORY_NONE;
 128     }
 129 };
 130
 131 // --------------------------------------------------------------------------------------------------------------------
 132
 133 class CarlaJsfxUnit
 134 {
 135     static water::String createFileId(const water::File& rootPath, const water::File& filePath)
 136     {
 137         water::String fileId(filePath.getRelativePathFrom(rootPath));
 138 #ifdef CARLA_OS_WIN
 139         fileId.replaceCharacter('\\', '/');
 140 #endif
 141         return fileId;
 142     }
 143
 144 public:
 145     CarlaJsfxUnit() noexcept
 146         : fFileId(),
 147           fFilePath(),
 148           fRootPath() {}
 149
 150     CarlaJsfxUnit(const water::File& rootPath, const water::File& filePath)
 151         : fFileId(createFileId(rootPath, filePath)),
 152           fFilePath(rootPath.getChildFile(fFileId).getFullPathName()),
 153           fRootPath(rootPath.getFullPathName()) {}
 154
 155     explicit operator bool() const noexcept
 156     {
 157         return fFileId.isNotEmpty();
 158     }
 159
 160     const water::String& getFileId() const noexcept
 161     {
 162         return fFileId;
 163     }
 164
 165     const water::String& getFilePath() const noexcept
 166     {
 167         return fFilePath;
 168     }
 169
 170     const water::String& getRootPath() const noexcept
 171     {
 172         return fRootPath;
 173     }
 174
 175 private:
 176     water::String fFileId;
 177     water::String fFilePath;
 178     water::String fRootPath;
 179 };
 180
 181 // --------------------------------------------------------------------------------------------------------------------
 182
 183 CARLA_BACKEND_END_NAMESPACE
 184
 185 #endif // CARLA_JSFX_UTILS_HPP_INCLUDED