falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 42 Activity
Audio plugin host https://kx.studio/carla
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1971 Commits
16 Branches
141MB
Tree: fa40698e68
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'fa40698e68'
${ noResults }
Carla/source/utils/CarlaStateUtils.cpp

567 lines
20KB
Raw Blame History 

  1. /*

  2.  * Carla State utils

  3.  * Copyright (C) 2012-2014 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. #include "CarlaStateUtils.hpp"

  19. 

  20. #include "CarlaBackendUtils.hpp"

  21. #include "CarlaMathUtils.hpp"

  22. #include "CarlaMIDI.h"

  23. 

  24. #include "juce_core.h"

  25. using juce::String;

  26. using juce::XmlElement;

  27. 

  28. CARLA_BACKEND_START_NAMESPACE

  29. 

  30. // -----------------------------------------------------------------------

  31. // xmlSafeString

  32. 

  33. static String xmlSafeString(const String& string, const bool toXml)

  34. {

  35.     String newString(string);

  36. 

  37.     if (toXml)

  38.         return newString.replace("&","&amp;").replace("<","&lt;").replace(">","&gt;").replace("'","&apos;").replace("\"","&quot;");

  39.     else

  40.         return newString.replace("&lt;","<").replace("&gt;",">").replace("&apos;","'").replace("&quot;","\"").replace("&amp;","&");

  41. }

  42. 

  43. // -----------------------------------------------------------------------

  44. // xmlSafeStringCharDup

  45. 

  46. static const char* xmlSafeStringCharDup(const String& string, const bool toXml)

  47. {

  48.     return carla_strdup(xmlSafeString(string, toXml).toRawUTF8());

  49. }

  50. 

  51. // -----------------------------------------------------------------------

  52. // StateParameter

  53. 

  54. StateParameter::StateParameter() noexcept

  55.     : isInput(true),

  56.       index(-1),

  57.       name(nullptr),

  58.       symbol(nullptr),

  59.       value(0.0f),

  60.       midiChannel(0),

  61.       midiCC(-1) {}

  62. 

  63. StateParameter::~StateParameter() noexcept

  64. {

  65.     if (name != nullptr)

  66.     {

  67.         delete[] name;

  68.         name = nullptr;

  69.     }

  70.     if (symbol != nullptr)

  71.     {

  72.         delete[] symbol;

  73.         symbol = nullptr;

  74.     }

  75. }

  76. 

  77. // -----------------------------------------------------------------------

  78. // StateCustomData

  79. 

  80. StateCustomData::StateCustomData() noexcept

  81.     : type(nullptr),

  82.       key(nullptr),

  83.       value(nullptr) {}

  84. 

  85. StateCustomData::~StateCustomData() noexcept

  86. {

  87.     if (type != nullptr)

  88.     {

  89.         delete[] type;

  90.         type = nullptr;

  91.     }

  92.     if (key != nullptr)

  93.     {

  94.         delete[] key;

  95.         key = nullptr;

  96.     }

  97.     if (value != nullptr)

  98.     {

  99.         delete[] value;

  100.         value = nullptr;

  101.     }

  102. }

  103. 

  104. // -----------------------------------------------------------------------

  105. // StateSave

  106. 

  107. StateSave::StateSave() noexcept

  108.     : type(nullptr),

  109.       name(nullptr),

  110.       label(nullptr),

  111.       binary(nullptr),

  112.       uniqueId(0),

  113.       active(false),

  114.       dryWet(1.0f),

  115.       volume(1.0f),

  116.       balanceLeft(-1.0f),

  117.       balanceRight(1.0f),

  118.       panning(0.0f),

  119.       ctrlChannel(-1),

  120.       currentProgramIndex(-1),

  121.       currentProgramName(nullptr),

  122.       currentMidiBank(-1),

  123.       currentMidiProgram(-1),

  124.       chunk(nullptr) {}

  125. 

  126. StateSave::~StateSave() noexcept

  127. {

  128.     clear();

  129. }

  130. 

  131. void StateSave::clear() noexcept

  132. {

  133.     if (type != nullptr)

  134.     {

  135.         delete[] type;

  136.         type = nullptr;

  137.     }

  138.     if (name != nullptr)

  139.     {

  140.         delete[] name;

  141.         name = nullptr;

  142.     }

  143.     if (label != nullptr)

  144.     {

  145.         delete[] label;

  146.         label = nullptr;

  147.     }

  148.     if (binary != nullptr)

  149.     {

  150.         delete[] binary;

  151.         binary = nullptr;

  152.     }

  153.     if (currentProgramName != nullptr)

  154.     {

  155.         delete[] currentProgramName;

  156.         currentProgramName = nullptr;

  157.     }

  158.     if (chunk != nullptr)

  159.     {

  160.         delete[] chunk;

  161.         chunk = nullptr;

  162.     }

  163. 

  164.     uniqueId = 0;

  165.     active = false;

  166.     dryWet = 1.0f;

  167.     volume = 1.0f;

  168.     balanceLeft  = -1.0f;

  169.     balanceRight = 1.0f;

  170.     panning      = 0.0f;

  171.     ctrlChannel  = -1;

  172.     currentProgramIndex = -1;

  173.     currentMidiBank     = -1;

  174.     currentMidiProgram  = -1;

  175. 

  176.     for (StateParameterItenerator it = parameters.begin(); it.valid(); it.next())

  177.     {

  178.         StateParameter* const stateParameter(it.getValue());

  179.         delete stateParameter;

  180.     }

  181. 

  182.     for (StateCustomDataItenerator it = customData.begin(); it.valid(); it.next())

  183.     {

  184.         StateCustomData* const stateCustomData(it.getValue());

  185.         delete stateCustomData;

  186.     }

  187. 

  188.     parameters.clear();

  189.     customData.clear();

  190. }

  191. 

  192. // -----------------------------------------------------------------------

  193. // fillFromXmlElement

  194. 

  195. bool StateSave::fillFromXmlElement(const XmlElement* const xmlElement)

  196. {

  197.     CARLA_SAFE_ASSERT_RETURN(xmlElement != nullptr, false);

  198. 

  199.     clear();

  200. 

  201.     for (XmlElement* elem = xmlElement->getFirstChildElement(); elem != nullptr; elem = elem->getNextElement())

  202.     {

  203.         const String& tagName(elem->getTagName());

  204. 

  205.         // ---------------------------------------------------------------

  206.         // Info

  207. 

  208.         if (tagName.equalsIgnoreCase("info"))

  209.         {

  210.             for (XmlElement* xmlInfo = elem->getFirstChildElement(); xmlInfo != nullptr; xmlInfo = xmlInfo->getNextElement())

  211.             {

  212.                 const String& tag(xmlInfo->getTagName());

  213.                 const String  text(xmlInfo->getAllSubText().trim());

  214. 

  215.                 if (tag.equalsIgnoreCase("type"))

  216.                     type = xmlSafeStringCharDup(text, false);

  217.                 else if (tag.equalsIgnoreCase("name"))

  218.                     name = xmlSafeStringCharDup(text, false);

  219.                 else if (tag.equalsIgnoreCase("label") || tag.equalsIgnoreCase("uri"))

  220.                     label = xmlSafeStringCharDup(text, false);

  221.                 else if (tag.equalsIgnoreCase("binary") || tag.equalsIgnoreCase("bundle") || tag.equalsIgnoreCase("filename"))

  222.                     binary = xmlSafeStringCharDup(text, false);

  223.                 else if (tag.equalsIgnoreCase("uniqueid"))

  224.                     uniqueId = text.getLargeIntValue();

  225.             }

  226.         }

  227. 

  228.         // ---------------------------------------------------------------

  229.         // Data

  230. 

  231.         else if (tagName.equalsIgnoreCase("data"))

  232.         {

  233.             for (XmlElement* xmlData = elem->getFirstChildElement(); xmlData != nullptr; xmlData = xmlData->getNextElement())

  234.             {

  235.                 const String& tag(xmlData->getTagName());

  236.                 const String  text(xmlData->getAllSubText().trim());

  237. 

  238.                 // -------------------------------------------------------

  239.                 // Internal Data

  240. 

  241.                 if (tag.equalsIgnoreCase("active"))

  242.                 {

  243.                     active = (text.equalsIgnoreCase("yes") || text.equalsIgnoreCase("true"));

  244.                 }

  245.                 else if (tag.equalsIgnoreCase("drywet"))

  246.                 {

  247.                     dryWet = carla_fixValue(0.0f, 1.0f, text.getFloatValue());

  248.                 }

  249.                 else if (tag.equalsIgnoreCase("volume"))

  250.                 {

  251.                     volume = carla_fixValue(0.0f, 1.27f, text.getFloatValue());

  252.                 }

  253.                 else if (tag.equalsIgnoreCase("balanceleft") || tag.equalsIgnoreCase("balance-left"))

  254.                 {

  255.                     balanceLeft = carla_fixValue(-1.0f, 1.0f, text.getFloatValue());

  256.                 }

  257.                 else if (tag.equalsIgnoreCase("balanceright") || tag.equalsIgnoreCase("balance-right"))

  258.                 {

  259.                     balanceRight = carla_fixValue(-1.0f, 1.0f, text.getFloatValue());

  260.                 }

  261.                 else if (tag.equalsIgnoreCase("panning"))

  262.                 {

  263.                     panning = carla_fixValue(-1.0f, 1.0f, text.getFloatValue());

  264.                 }

  265.                 else if (tag.equalsIgnoreCase("controlchannel") || tag.equalsIgnoreCase("control-channel"))

  266.                 {

  267.                     const int value(text.getIntValue());

  268.                     if (value >= 1 && value <= MAX_MIDI_CHANNELS)

  269.                         ctrlChannel = static_cast<int8_t>(value-1);

  270.                 }

  271. 

  272.                 // -------------------------------------------------------

  273.                 // Program (current)

  274. 

  275.                 else if (tag.equalsIgnoreCase("currentprogramindex") || tag.equalsIgnoreCase("current-program-index"))

  276.                 {

  277.                     const int value(text.getIntValue());

  278.                     if (value >= 1)

  279.                         currentProgramIndex = value-1;

  280.                 }

  281.                 else if (tag.equalsIgnoreCase("currentprogramname") || tag.equalsIgnoreCase("current-program-name"))

  282.                 {

  283.                     currentProgramName = xmlSafeStringCharDup(text, false);

  284.                 }

  285. 

  286.                 // -------------------------------------------------------

  287.                 // Midi Program (current)

  288. 

  289.                 else if (tag.equalsIgnoreCase("currentmidibank") || tag.equalsIgnoreCase("current-midi-bank"))

  290.                 {

  291.                     const int value(text.getIntValue());

  292.                     if (value >= 1)

  293.                         currentMidiBank = value-1;

  294.                 }

  295.                 else if (tag.equalsIgnoreCase("currentmidiprogram") || tag.equalsIgnoreCase("current-midi-program"))

  296.                 {

  297.                     const int value(text.getIntValue());

  298.                     if (value >= 1)

  299.                         currentMidiProgram = value-1;

  300.                 }

  301. 

  302.                 // -------------------------------------------------------

  303.                 // Parameters

  304. 

  305.                 else if (tag.equalsIgnoreCase("parameter"))

  306.                 {

  307.                     StateParameter* const stateParameter(new StateParameter());

  308. 

  309.                     for (XmlElement* xmlSubData = xmlData->getFirstChildElement(); xmlSubData != nullptr; xmlSubData = xmlSubData->getNextElement())

  310.                     {

  311.                         const String& pTag(xmlSubData->getTagName());

  312.                         const String  pText(xmlSubData->getAllSubText().trim());

  313. 

  314.                         if (pTag.equalsIgnoreCase("index"))

  315.                         {

  316.                             const int index(pText.getIntValue());

  317.                             if (index >= 0)

  318.                                 stateParameter->index = index;

  319.                         }

  320.                         else if (pTag.equalsIgnoreCase("name"))

  321.                         {

  322.                             stateParameter->name = xmlSafeStringCharDup(pText, false);

  323.                         }

  324.                         else if (pTag.equalsIgnoreCase("symbol"))

  325.                         {

  326.                             stateParameter->symbol = xmlSafeStringCharDup(pText, false);

  327.                         }

  328.                         else if (pTag.equalsIgnoreCase("value"))

  329.                         {

  330.                             stateParameter->value = pText.getFloatValue();

  331.                         }

  332.                         else if (pTag.equalsIgnoreCase("midichannel") || pTag.equalsIgnoreCase("midi-channel"))

  333.                         {

  334.                             const int channel(pText.getIntValue());

  335.                             if (channel >= 1 && channel <= MAX_MIDI_CHANNELS)

  336.                                 stateParameter->midiChannel = static_cast<uint8_t>(channel-1);

  337.                         }

  338.                         else if (pTag.equalsIgnoreCase("midicc") || pTag.equalsIgnoreCase("midi-cc"))

  339.                         {

  340.                             const int cc(pText.getIntValue());

  341.                             if (cc >= 1 && cc < 0x5F)

  342.                                 stateParameter->midiCC = static_cast<int16_t>(cc);

  343.                         }

  344.                     }

  345. 

  346.                     parameters.append(stateParameter);

  347.                 }

  348. 

  349.                 // -------------------------------------------------------

  350.                 // Custom Data

  351. 

  352.                 else if (tag.equalsIgnoreCase("customdata") || tag.equalsIgnoreCase("custom-data"))

  353.                 {

  354.                     StateCustomData* const stateCustomData(new StateCustomData());

  355. 

  356.                     for (XmlElement* xmlSubData = xmlData->getFirstChildElement(); xmlSubData != nullptr; xmlSubData = xmlSubData->getNextElement())

  357.                     {

  358.                         const String& cTag(xmlSubData->getTagName());

  359.                         const String  cText(xmlSubData->getAllSubText().trim());

  360. 

  361.                         if (cTag.equalsIgnoreCase("type"))

  362.                             stateCustomData->type = xmlSafeStringCharDup(cText, false);

  363.                         else if (cTag.equalsIgnoreCase("key"))

  364.                             stateCustomData->key = xmlSafeStringCharDup(cText, false);

  365.                         else if (cTag.equalsIgnoreCase("value"))

  366.                             stateCustomData->value = xmlSafeStringCharDup(cText, false);

  367.                     }

  368. 

  369.                     customData.append(stateCustomData);

  370.                 }

  371. 

  372.                 // -------------------------------------------------------

  373.                 // Chunk

  374. 

  375.                 else if (tag.equalsIgnoreCase("chunk"))

  376.                 {

  377.                     chunk = xmlSafeStringCharDup(text, false);

  378.                 }

  379.             }

  380.         }

  381.     }

  382. 

  383.     return true;

  384. }

  385. 

  386. // -----------------------------------------------------------------------

  387. // fillXmlStringFromStateSave

  388. 

  389. String StateSave::toString() const

  390. {

  391.     String content;

  392. 

  393.     {

  394.         String infoXml("  <Info>\n");

  395. 

  396.         infoXml << "   <Type>" << String(type != nullptr ? type : "") << "</Type>\n";

  397.         infoXml << "   <Name>" << xmlSafeString(name, true) << "</Name>\n";

  398. 

  399.         switch (getPluginTypeFromString(type))

  400.         {

  401.         case PLUGIN_NONE:

  402.             break;

  403.         case PLUGIN_INTERNAL:

  404.             infoXml << "    <Label>"    << xmlSafeString(label, true)  << "</Label>\n";

  405.             break;

  406.         case PLUGIN_LADSPA:

  407.             infoXml << "    <Binary>"   << xmlSafeString(binary, true) << "</Binary>\n";

  408.             infoXml << "    <Label>"    << xmlSafeString(label, true)  << "</Label>\n";

  409.             infoXml << "    <UniqueID>" << uniqueId                    << "</UniqueID>\n";

  410.             break;

  411.         case PLUGIN_DSSI:

  412.             infoXml << "    <Binary>"   << xmlSafeString(binary, true) << "</Binary>\n";

  413.             infoXml << "    <Label>"    << xmlSafeString(label, true)  << "</Label>\n";

  414.             break;

  415.         case PLUGIN_LV2:

  416.             infoXml << "    <Bundle>"   << xmlSafeString(binary, true) << "</Bundle>\n";

  417.             infoXml << "    <URI>"      << xmlSafeString(label, true)  << "</URI>\n";

  418.             break;

  419.         case PLUGIN_VST:

  420.             infoXml << "    <Binary>"   << xmlSafeString(binary, true) << "</Binary>\n";

  421.             infoXml << "    <UniqueID>" << uniqueId                    << "</UniqueID>\n";

  422.             break;

  423.         case PLUGIN_VST3:

  424.             // TODO?

  425.             infoXml << "    <Binary>"   << xmlSafeString(binary, true) << "</Binary>\n";

  426.             infoXml << "    <UniqueID>" << uniqueId                    << "</UniqueID>\n";

  427.             break;

  428.         case PLUGIN_AU:

  429.             // TODO?

  430.             infoXml << "    <Binary>"   << xmlSafeString(binary, true) << "</Binary>\n";

  431.             infoXml << "    <UniqueID>" << uniqueId                    << "</UniqueID>\n";

  432.             break;

  433.         case PLUGIN_GIG:

  434.         case PLUGIN_SF2:

  435.             infoXml << "    <Filename>"   << xmlSafeString(binary, true) << "</Filename>\n";

  436.             infoXml << "    <Label>"      << xmlSafeString(label, true)  << "</Label>\n";

  437.             break;

  438.         case PLUGIN_SFZ:

  439.             infoXml << "    <Filename>"   << xmlSafeString(binary, true) << "</Filename>\n";

  440.             break;

  441.         }

  442. 

  443.         infoXml << "  </Info>\n\n";

  444. 

  445.         content << infoXml;

  446.     }

  447. 

  448.     content << "  <Data>\n";

  449. 

  450.     {

  451.         String dataXml;

  452. 

  453.         dataXml << "   <Active>" << (active ? "Yes" : "No") << "</Active>\n";

  454. 

  455.         if (dryWet != 1.0f)

  456.             dataXml << "   <DryWet>"        << String(dryWet, 7)       << "</DryWet>\n";

  457.         if (volume != 1.0f)

  458.             dataXml << "   <Volume>"        << String(volume, 7)       << "</Volume>\n";

  459.         if (balanceLeft != -1.0f)

  460.             dataXml << "   <Balance-Left>"  << String(balanceLeft, 7)  << "</Balance-Left>\n";

  461.         if (balanceRight != 1.0f)

  462.             dataXml << "   <Balance-Right>" << String(balanceRight, 7) << "</Balance-Right>\n";

  463.         if (panning != 0.0f)

  464.             dataXml << "   <Panning>"       << String(panning, 7)      << "</Panning>\n";

  465. 

  466.         if (ctrlChannel < 0)

  467.             dataXml << "   <ControlChannel>N</ControlChannel>\n";

  468.         else

  469.             dataXml << "   <ControlChannel>" << int(ctrlChannel+1) << "</ControlChannel>\n";

  470. 

  471.         content << dataXml;

  472.     }

  473. 

  474.     for (StateParameterItenerator it = parameters.begin(); it.valid(); it.next())

  475.     {

  476.         StateParameter* const stateParameter(it.getValue());

  477. 

  478.         String parameterXml("\n""   <Parameter>\n");

  479. 

  480.         parameterXml << "    <Index>" << String(stateParameter->index)             << "</Index>\n";

  481.         parameterXml << "    <Name>"  << xmlSafeString(stateParameter->name, true) << "</Name>\n";

  482. 

  483.         if (stateParameter->symbol != nullptr && stateParameter->symbol[0] != '\0')

  484.             parameterXml << "    <Symbol>" << xmlSafeString(stateParameter->symbol, true) << "</Symbol>\n";

  485. 

  486.         if (stateParameter->isInput)

  487.             parameterXml << "    <Value>" << String(stateParameter->value, 15) << "</Value>\n";

  488. 

  489.         if (stateParameter->midiCC > 0)

  490.         {

  491.             parameterXml << "    <MidiCC>"      << stateParameter->midiCC        << "</MidiCC>\n";

  492.             parameterXml << "    <MidiChannel>" << stateParameter->midiChannel+1 << "</MidiChannel>\n";

  493.         }

  494. 

  495.         parameterXml << "   </Parameter>\n";

  496. 

  497.         content << parameterXml;

  498.     }

  499. 

  500.     if (currentProgramIndex >= 0 && currentProgramName != nullptr && currentProgramName[0] != '\0')

  501.     {

  502.         // ignore 'default' program

  503.         if (currentProgramIndex > 0 || ! String(currentProgramName).equalsIgnoreCase("default"))

  504.         {

  505.             String programXml("\n");

  506.             programXml << "   <CurrentProgramIndex>" << currentProgramIndex+1                   << "</CurrentProgramIndex>\n";

  507.             programXml << "   <CurrentProgramName>"  << xmlSafeString(currentProgramName, true) << "</CurrentProgramName>\n";

  508. 

  509.             content << programXml;

  510.         }

  511.     }

  512. 

  513.     if (currentMidiBank >= 0 && currentMidiProgram >= 0)

  514.     {

  515.         String midiProgramXml("\n");

  516.         midiProgramXml << "   <CurrentMidiBank>"    << currentMidiBank+1    << "</CurrentMidiBank>\n";

  517.         midiProgramXml << "   <CurrentMidiProgram>" << currentMidiProgram+1 << "</CurrentMidiProgram>\n";

  518. 

  519.         content << midiProgramXml;

  520.     }

  521. 

  522.     for (StateCustomDataItenerator it = customData.begin(); it.valid(); it.next())

  523.     {

  524.         StateCustomData* const stateCustomData(it.getValue());

  525.         CARLA_SAFE_ASSERT_CONTINUE(stateCustomData->type  != nullptr && stateCustomData->type[0] != '\0');

  526.         CARLA_SAFE_ASSERT_CONTINUE(stateCustomData->key   != nullptr && stateCustomData->key[0]  != '\0');

  527.         CARLA_SAFE_ASSERT_CONTINUE(stateCustomData->value != nullptr);

  528. 

  529.         String customDataXml("\n""   <CustomData>\n");

  530.         customDataXml << "    <Type>" << xmlSafeString(stateCustomData->type, true) << "</Type>\n";

  531.         customDataXml << "    <Key>"  << xmlSafeString(stateCustomData->key, true)  << "</Key>\n";

  532. 

  533.         if (std::strcmp(stateCustomData->type, CUSTOM_DATA_TYPE_CHUNK) == 0 || std::strlen(stateCustomData->value) >= 128)

  534.         {

  535.             customDataXml << "    <Value>\n";

  536.             customDataXml << xmlSafeString(stateCustomData->value, true);

  537.             customDataXml << "\n    </Value>\n";

  538.         }

  539.         else

  540.         {

  541.             customDataXml << "    <Value>";

  542.             customDataXml << xmlSafeString(stateCustomData->value, true);

  543.             customDataXml << "</Value>\n";

  544.         }

  545. 

  546.         customDataXml << "   </CustomData>\n";

  547. 

  548.         content << customDataXml;

  549.     }

  550. 

  551.     if (chunk != nullptr && chunk[0] != '\0')

  552.     {

  553.         String chunkXml("\n""   <Chunk>\n");

  554.         chunkXml << chunk << "\n   </Chunk>\n";

  555. 

  556.         content << chunkXml;

  557.     }

  558. 

  559.     content << "  </Data>\n";

  560. 

  561.     return content;

  562. }

  563. 

  564. // -----------------------------------------------------------------------

  565. 

  566. CARLA_BACKEND_END_NAMESPACE