source/utils/CarlaJsfxUtils.hpp

   1 /*
   2  * Carla JSFX utils
   3  * Copyright (C) 2021 Jean Pierre Cimalando
   4  * Copyright (C) 2021-2024 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 "CarlaBackend.h"
  23 #include "CarlaString.hpp"
  24
  25 #include "water/files/File.h"
  26
  27 #ifdef YSFX_API
  28 # error YSFX_API is not private
  29 #endif
  30 #include "ysfx/include/ysfx.h"
  31
  32 CARLA_BACKEND_START_NAMESPACE
  33
  34 // --------------------------------------------------------------------------------------------------------------------
  35
  36 struct CarlaJsfxLogging
  37 {
  38     static void logAll(intptr_t, const ysfx_log_level level, const char* const message)
  39     {
  40         switch (level)
  41         {
  42         case ysfx_log_info:
  43             carla_stdout("%s: %s", ysfx_log_level_string(level), message);
  44             break;
  45         case ysfx_log_warning:
  46             carla_stderr("%s: %s", ysfx_log_level_string(level), message);
  47             break;
  48         case ysfx_log_error:
  49             carla_stderr2("%s: %s", ysfx_log_level_string(level), message);
  50             break;
  51         }
  52     };
  53
  54     static void logErrorsOnly(intptr_t, const ysfx_log_level level, const char* const message)
  55     {
  56         switch (level)
  57         {
  58         case ysfx_log_info:
  59             break;
  60         case ysfx_log_warning:
  61             carla_stderr("%s: %s", ysfx_log_level_string(level), message);
  62             break;
  63         case ysfx_log_error:
  64             carla_stderr2("%s: %s", ysfx_log_level_string(level), message);
  65             break;
  66         }
  67     };
  68 };
  69
  70 // --------------------------------------------------------------------------------------------------------------------
  71
  72 struct CarlaJsfxCategories
  73 {
  74     static PluginCategory getFromEffect(ysfx_t* const effect)
  75     {
  76         PluginCategory category = PLUGIN_CATEGORY_OTHER;
  77
  78         if (const uint32_t tagCount = ysfx_get_tags(effect, nullptr, 0))
  79         {
  80             std::vector<const char*> tags;
  81             tags.resize(tagCount);
  82             ysfx_get_tags(effect, tags.data(), tagCount);
  83
  84             for (uint32_t i=0; i<tagCount && category == PLUGIN_CATEGORY_OTHER; ++i)
  85             {
  86                 PluginCategory current = getFromTag(tags[i]);
  87
  88                 if (current != PLUGIN_CATEGORY_NONE)
  89                     category = current;
  90             }
  91         }
  92
  93         return category;
  94     }
  95
  96     static PluginCategory getFromTag(const char* const tag)
  97     {
  98         if (carla_strcasecmp(tag, "synthesis") == 0)
  99             return PLUGIN_CATEGORY_SYNTH;
 100
 101         if (carla_strcasecmp(tag, "delay") == 0)
 102             return PLUGIN_CATEGORY_DELAY;
 103
 104         if (carla_strcasecmp(tag, "equalizer") == 0)
 105             return PLUGIN_CATEGORY_EQ;
 106
 107         if (carla_strcasecmp(tag, "filter") == 0)
 108             return PLUGIN_CATEGORY_FILTER;
 109
 110         if (carla_strcasecmp(tag, "distortion") == 0)
 111             return PLUGIN_CATEGORY_DISTORTION;
 112
 113         if (carla_strcasecmp(tag, "dynamics") == 0)
 114             return PLUGIN_CATEGORY_DYNAMICS;
 115
 116         if (carla_strcasecmp(tag, "modulation") == 0)
 117             return PLUGIN_CATEGORY_MODULATOR;
 118
 119         if (carla_strcasecmp(tag, "utility") == 0)
 120             return PLUGIN_CATEGORY_UTILITY;
 121
 122         return PLUGIN_CATEGORY_NONE;
 123     }
 124 };
 125
 126 // --------------------------------------------------------------------------------------------------------------------
 127
 128 class CarlaJsfxUnit
 129 {
 130     static CarlaString createFileId(const water::File& rootPath, const water::File& filePath)
 131     {
 132         CarlaString fileId(filePath.getRelativePathFrom(rootPath).toRawUTF8());
 133        #ifdef CARLA_OS_WIN
 134         fileId.replace('\\', '/');
 135        #endif
 136         return fileId;
 137     }
 138
 139 public:
 140     CarlaJsfxUnit() noexcept
 141         : fFileId(),
 142           fFilePath(),
 143           fRootPath() {}
 144
 145     CarlaJsfxUnit(const water::File& rootPath, const water::File& filePath)
 146         : fFileId(createFileId(rootPath, filePath)),
 147           fFilePath(rootPath.getChildFile(fFileId).getFullPathName().toRawUTF8()),
 148           fRootPath(rootPath.getFullPathName().toRawUTF8()) {}
 149
 150     explicit operator bool() const noexcept
 151     {
 152         return fFileId.isNotEmpty();
 153     }
 154
 155     const CarlaString& getFileId() const noexcept
 156     {
 157         return fFileId;
 158     }
 159
 160     const CarlaString& getFilePath() const noexcept
 161     {
 162         return fFilePath;
 163     }
 164
 165     const CarlaString& getRootPath() const noexcept
 166     {
 167         return fRootPath;
 168     }
 169
 170 private:
 171     CarlaString fFileId;
 172     CarlaString fFilePath;
 173     CarlaString fRootPath;
 174 };
 175
 176 // --------------------------------------------------------------------------------------------------------------------
 177
 178 CARLA_BACKEND_END_NAMESPACE
 179
 180 #endif // CARLA_JSFX_UTILS_HPP_INCLUDED