DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
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.
360 Commits
7 Branches
57MB
Tree: 4dbfbb043e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4dbfbb043e'
${ noResults }
DPF/distrho/src/DistrhoPluginLV2export.cpp

411 lines
17KB
Raw Blame History 

  1. /*

  2.  * DISTRHO Plugin Framework (DPF)

  3.  * Copyright (C) 2012-2014 Filipe Coelho <falktx@falktx.com>

  4.  *

  5.  * Permission to use, copy, modify, and/or distribute this software for any purpose with

  6.  * or without fee is hereby granted, provided that the above copyright notice and this

  7.  * permission notice appear in all copies.

  8.  *

  9.  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD

  10.  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN

  11.  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL

  12.  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER

  13.  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN

  14.  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

  15.  */

  16. 

  17. #include "DistrhoPluginInternal.hpp"

  18. 

  19. #include "lv2/atom.h"

  20. #include "lv2/buf-size.h"

  21. #include "lv2/data-access.h"

  22. #include "lv2/instance-access.h"

  23. #include "lv2/midi.h"

  24. #include "lv2/options.h"

  25. #include "lv2/port-props.h"

  26. #include "lv2/resize-port.h"

  27. #include "lv2/state.h"

  28. #include "lv2/time.h"

  29. #include "lv2/ui.h"

  30. #include "lv2/units.h"

  31. #include "lv2/urid.h"

  32. #include "lv2/worker.h"

  33. #include "lv2/lv2_kxstudio_properties.h"

  34. #include "lv2/lv2_programs.h"

  35. 

  36. #include <fstream>

  37. #include <iostream>

  38. 

  39. #ifndef DISTRHO_PLUGIN_URI

  40. # error DISTRHO_PLUGIN_URI undefined!

  41. #endif

  42. 

  43. #ifndef DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE

  44. # define DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE 2048

  45. #endif

  46. 

  47. #if DISTRHO_PLUGIN_HAS_UI && ! defined(HAVE_DGL)

  48. # undef DISTRHO_PLUGIN_HAS_UI

  49. # define DISTRHO_PLUGIN_HAS_UI 0

  50. #endif

  51. 

  52. #define DISTRHO_LV2_USE_EVENTS_IN  (DISTRHO_PLUGIN_HAS_MIDI_INPUT || DISTRHO_PLUGIN_WANT_TIMEPOS || (DISTRHO_PLUGIN_WANT_STATE && DISTRHO_PLUGIN_HAS_UI))

  53. #define DISTRHO_LV2_USE_EVENTS_OUT (DISTRHO_PLUGIN_HAS_MIDI_OUTPUT || (DISTRHO_PLUGIN_WANT_STATE && DISTRHO_PLUGIN_HAS_UI))

  54. 

  55. // -----------------------------------------------------------------------

  56. 

  57. DISTRHO_PLUGIN_EXPORT

  58. void lv2_generate_ttl(const char* const basename)

  59. {

  60.     USE_NAMESPACE_DISTRHO

  61. 

  62.     // Dummy plugin to get data from

  63.     d_lastBufferSize = 512;

  64.     d_lastSampleRate = 44100.0;

  65.     PluginExporter plugin;

  66.     d_lastBufferSize = 0;

  67.     d_lastSampleRate = 0.0;

  68. 

  69.     d_string pluginDLL(basename);

  70.     d_string pluginTTL(pluginDLL + ".ttl");

  71. 

  72.     // ---------------------------------------------

  73. 

  74.     {

  75.         std::cout << "Writing manifest.ttl..."; std::cout.flush();

  76.         std::fstream manifestFile("manifest.ttl", std::ios::out);

  77. 

  78.         d_string manifestString;

  79.         manifestString += "@prefix lv2:  <" LV2_CORE_PREFIX "> .\n";

  80.         manifestString += "@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n";

  81. #if DISTRHO_PLUGIN_HAS_UI

  82.         manifestString += "@prefix ui:   <" LV2_UI_PREFIX "> .\n";

  83. #endif

  84.         manifestString += "\n";

  85. 

  86.         manifestString += "<" DISTRHO_PLUGIN_URI ">\n";

  87.         manifestString += "    a lv2:Plugin ;\n";

  88.         manifestString += "    lv2:binary <" + pluginDLL + "." DISTRHO_DLL_EXTENSION "> ;\n";

  89.         manifestString += "    rdfs:seeAlso <" + pluginTTL + "> .\n";

  90.         manifestString += "\n";

  91. 

  92. #if DISTRHO_PLUGIN_HAS_UI

  93.         manifestString += "<" DISTRHO_UI_URI ">\n";

  94. # if DISTRHO_OS_HAIKU

  95.         manifestString += "    a ui:BeUI ;\n";

  96. # elif DISTRHO_OS_MAC

  97.         manifestString += "    a ui:CocoaUI ;\n";

  98. # elif DISTRHO_OS_WINDOWS

  99.         manifestString += "    a ui:WindowsUI ;\n";

  100. # else

  101.         manifestString += "    a ui:X11UI ;\n";

  102. # endif

  103. # if ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS

  104.         d_string pluginUI(pluginDLL);

  105.         pluginUI.truncate(pluginDLL.rfind("_dsp"));

  106.         pluginUI += "_ui";

  107. 

  108.         manifestString += "    ui:binary <" + pluginUI + "." DISTRHO_DLL_EXTENSION "> ;\n";

  109. # else

  110.         manifestString += "    ui:binary <" + pluginDLL + "." DISTRHO_DLL_EXTENSION "> ;\n";

  111. #endif

  112.         manifestString += "    lv2:extensionData ui:idleInterface ,\n";

  113. # if DISTRHO_PLUGIN_WANT_PROGRAMS

  114.         manifestString += "                      ui:showInterface ,\n";

  115.         manifestString += "                      <" LV2_PROGRAMS__Interface "> ;\n";

  116. # else

  117.         manifestString += "                      ui:showInterface ;\n";

  118. # endif

  119.         manifestString += "    lv2:optionalFeature ui:noUserResize ,\n";

  120.         manifestString += "                        ui:resize ,\n";

  121.         manifestString += "                        ui:touch ;\n";

  122. # if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS

  123.         manifestString += "    lv2:requiredFeature <" LV2_DATA_ACCESS_URI "> ,\n";

  124.         manifestString += "                        <" LV2_INSTANCE_ACCESS_URI "> ,\n";

  125.         manifestString += "                        <" LV2_OPTIONS__options "> ,\n";

  126. # else

  127.         manifestString += "    lv2:requiredFeature <" LV2_OPTIONS__options "> ,\n";

  128. # endif

  129.         manifestString += "                        <" LV2_URID__map "> .\n";

  130. #endif

  131. 

  132.         manifestFile << manifestString << std::endl;

  133.         manifestFile.close();

  134.         std::cout << " done!" << std::endl;

  135.     }

  136. 

  137.     // ---------------------------------------------

  138. 

  139.     {

  140.         std::cout << "Writing " << pluginTTL << "..."; std::cout.flush();

  141.         std::fstream pluginFile(pluginTTL, std::ios::out);

  142. 

  143.         d_string pluginString;

  144. 

  145.         // header

  146. #if DISTRHO_LV2_USE_EVENTS_IN

  147.         pluginString += "@prefix atom: <" LV2_ATOM_PREFIX "> .\n";

  148. #endif

  149.         pluginString += "@prefix doap: <http://usefulinc.com/ns/doap#> .\n";

  150.         pluginString += "@prefix foaf: <http://xmlns.com/foaf/0.1/> .\n";

  151.         pluginString += "@prefix lv2:  <" LV2_CORE_PREFIX "> .\n";

  152.         pluginString += "@prefix rsz:  <" LV2_RESIZE_PORT_PREFIX "> .\n";

  153. #if DISTRHO_PLUGIN_HAS_UI

  154.         pluginString += "@prefix ui:   <" LV2_UI_PREFIX "> .\n";

  155. #endif

  156.         pluginString += "@prefix unit: <" LV2_UNITS_PREFIX "> .\n";

  157.         pluginString += "\n";

  158. 

  159.         // plugin

  160.         pluginString += "<" DISTRHO_PLUGIN_URI ">\n";

  161. #if DISTRHO_PLUGIN_IS_SYNTH

  162.         pluginString += "    a lv2:InstrumentPlugin, lv2:Plugin ;\n";

  163. #else

  164.         pluginString += "    a lv2:Plugin ;\n";

  165. #endif

  166.         pluginString += "\n";

  167. 

  168.         // extensionData

  169.         pluginString += "    lv2:extensionData <" LV2_STATE__interface "> ";

  170. #if DISTRHO_PLUGIN_WANT_STATE

  171.         pluginString += ",\n                      <" LV2_OPTIONS__interface "> ";

  172.         pluginString += ",\n                      <" LV2_WORKER__interface "> ";

  173. #endif

  174. #if DISTRHO_PLUGIN_WANT_PROGRAMS

  175.         pluginString += ",\n                      <" LV2_PROGRAMS__Interface "> ";

  176. #endif

  177.         pluginString += ";\n\n";

  178. 

  179.         // optionalFeatures

  180. #if DISTRHO_PLUGIN_IS_RT_SAFE

  181.         pluginString += "    lv2:optionalFeature <" LV2_CORE__hardRTCapable "> ,\n";

  182.         pluginString += "                        <" LV2_BUF_SIZE__boundedBlockLength "> ;\n";

  183. #else

  184.         pluginString += "    lv2:optionalFeature <" LV2_BUF_SIZE__boundedBlockLength "> ;\n";

  185. #endif

  186.         pluginString += "\n";

  187. 

  188.         // requiredFeatures

  189.         pluginString += "    lv2:requiredFeature <" LV2_OPTIONS__options "> ";

  190.         pluginString += ",\n                        <" LV2_URID__map "> ";

  191. #if DISTRHO_PLUGIN_WANT_STATE

  192.         pluginString += ",\n                        <" LV2_WORKER__schedule "> ";

  193. #endif

  194.         pluginString += ";\n\n";

  195. 

  196.         // UI

  197. #if DISTRHO_PLUGIN_HAS_UI

  198.         pluginString += "    ui:ui <" DISTRHO_UI_URI "> ;\n";

  199.         pluginString += "\n";

  200. #endif

  201. 

  202.         {

  203.             uint32_t portIndex = 0;

  204. 

  205. #if DISTRHO_PLUGIN_NUM_INPUTS > 0

  206.             for (uint32_t i=0; i < DISTRHO_PLUGIN_NUM_INPUTS; ++i, ++portIndex)

  207.             {

  208.                 if (i == 0)

  209.                     pluginString += "    lv2:port [\n";

  210.                 else

  211.                     pluginString += "    [\n";

  212. 

  213.                 pluginString += "        a lv2:InputPort, lv2:AudioPort ;\n";

  214.                 pluginString += "        lv2:index " + d_string(portIndex) + " ;\n";

  215.                 pluginString += "        lv2:symbol \"lv2_audio_in_" + d_string(i+1) + "\" ;\n";

  216.                 pluginString += "        lv2:name \"Audio Input " + d_string(i+1) + "\" ;\n";

  217. 

  218.                 if (i+1 == DISTRHO_PLUGIN_NUM_INPUTS)

  219.                     pluginString += "    ] ;\n\n";

  220.                 else

  221.                     pluginString += "    ] ,\n";

  222.             }

  223.             pluginString += "\n";

  224. #endif

  225. 

  226. #if DISTRHO_PLUGIN_NUM_OUTPUTS > 0

  227.             for (uint32_t i=0; i < DISTRHO_PLUGIN_NUM_OUTPUTS; ++i, ++portIndex)

  228.             {

  229.                 if (i == 0)

  230.                     pluginString += "    lv2:port [\n";

  231.                 else

  232.                     pluginString += "    [\n";

  233. 

  234.                 pluginString += "        a lv2:OutputPort, lv2:AudioPort ;\n";

  235.                 pluginString += "        lv2:index " + d_string(portIndex) + " ;\n";

  236.                 pluginString += "        lv2:symbol \"lv2_audio_out_" + d_string(i+1) + "\" ;\n";

  237.                 pluginString += "        lv2:name \"Audio Output " + d_string(i+1) + "\" ;\n";

  238. 

  239.                 if (i+1 == DISTRHO_PLUGIN_NUM_OUTPUTS)

  240.                     pluginString += "    ] ;\n\n";

  241.                 else

  242.                     pluginString += "    ] ,\n";

  243.             }

  244.             pluginString += "\n";

  245. #endif

  246. 

  247. #if DISTRHO_LV2_USE_EVENTS_IN

  248.             pluginString += "    lv2:port [\n";

  249.             pluginString += "        a lv2:InputPort, atom:AtomPort ;\n";

  250.             pluginString += "        lv2:index " + d_string(portIndex) + " ;\n";

  251.             pluginString += "        lv2:name \"Events Input\" ;\n";

  252.             pluginString += "        lv2:symbol \"lv2_events_in\" ;\n";

  253.             pluginString += "        rsz:minimumSize " + d_string(DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE) + " ;\n";

  254.             pluginString += "        atom:bufferType atom:Sequence ;\n";

  255. # if (DISTRHO_PLUGIN_WANT_STATE && DISTRHO_PLUGIN_HAS_UI)

  256.             pluginString += "        atom:supports <" LV2_ATOM__String "> ;\n";

  257. # endif

  258. # if DISTRHO_PLUGIN_HAS_MIDI_INPUT

  259.             pluginString += "        atom:supports <" LV2_MIDI__MidiEvent "> ;\n";

  260. # endif

  261. # if DISTRHO_PLUGIN_WANT_TIMEPOS

  262.             pluginString += "        atom:supports <" LV2_TIME__Position "> ;\n";

  263. # endif

  264.             pluginString += "    ] ;\n\n";

  265.             ++portIndex;

  266. #endif

  267. 

  268. #if DISTRHO_LV2_USE_EVENTS_OUT

  269.             pluginString += "    lv2:port [\n";

  270.             pluginString += "        a lv2:OutputPort, atom:AtomPort ;\n";

  271.             pluginString += "        lv2:index " + d_string(portIndex) + " ;\n";

  272.             pluginString += "        lv2:name \"Events Output\" ;\n";

  273.             pluginString += "        lv2:symbol \"lv2_events_out\" ;\n";

  274.             pluginString += "        rsz:minimumSize " + d_string(DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE) + " ;\n";

  275.             pluginString += "        atom:bufferType atom:Sequence ;\n";

  276. # if (DISTRHO_PLUGIN_WANT_STATE && DISTRHO_PLUGIN_HAS_UI)

  277.             pluginString += "        atom:supports <" LV2_ATOM__String "> ;\n";

  278. # endif

  279. # if DISTRHO_PLUGIN_HAS_MIDI_OUTPUT

  280.             pluginString += "        atom:supports <" LV2_MIDI__MidiEvent "> ;\n";

  281. # endif

  282.             pluginString += "    ] ;\n\n";

  283.             ++portIndex;

  284. #endif

  285. 

  286. #if DISTRHO_PLUGIN_WANT_LATENCY

  287.             pluginString += "    lv2:port [\n";

  288.             pluginString += "        a lv2:OutputPort, lv2:ControlPort ;\n";

  289.             pluginString += "        lv2:index " + d_string(portIndex) + " ;\n";

  290.             pluginString += "        lv2:name \"Latency\" ;\n";

  291.             pluginString += "        lv2:symbol \"lv2_latency\" ;\n";

  292.             pluginString += "        lv2:designation lv2:latency ;\n";

  293.             pluginString += "        lv2:portProperty lv2:reportsLatency, lv2:integer ;\n";

  294.             pluginString += "    ] ;\n\n";

  295.             ++portIndex;

  296. #endif

  297. 

  298.             for (uint32_t i=0, count=plugin.getParameterCount(); i < count; ++i, ++portIndex)

  299.             {

  300.                 if (i == 0)

  301.                     pluginString += "    lv2:port [\n";

  302.                 else

  303.                     pluginString += "    [\n";

  304. 

  305.                 if (plugin.isParameterOutput(i))

  306.                     pluginString += "        a lv2:OutputPort, lv2:ControlPort ;\n";

  307.                 else

  308.                     pluginString += "        a lv2:InputPort, lv2:ControlPort ;\n";

  309. 

  310.                 pluginString += "        lv2:index " + d_string(portIndex) + " ;\n";

  311.                 pluginString += "        lv2:name \"" + plugin.getParameterName(i) + "\" ;\n";

  312. 

  313.                 // symbol

  314.                 {

  315.                     d_string symbol(plugin.getParameterSymbol(i));

  316. 

  317.                     if (symbol.isEmpty())

  318.                         symbol = "lv2_port_" + d_string(portIndex-1);

  319. 

  320.                     pluginString += "        lv2:symbol \"" + symbol + "\" ;\n";

  321.                 }

  322. 

  323.                 // ranges

  324.                 {

  325.                     const ParameterRanges& ranges(plugin.getParameterRanges(i));

  326. 

  327.                     if (plugin.getParameterHints(i) & kParameterIsInteger)

  328.                     {

  329.                         pluginString += "        lv2:default " + d_string(int(plugin.getParameterValue(i))) + " ;\n";

  330.                         pluginString += "        lv2:minimum " + d_string(int(ranges.min)) + " ;\n";

  331.                         pluginString += "        lv2:maximum " + d_string(int(ranges.max)) + " ;\n";

  332.                     }

  333.                     else

  334.                     {

  335.                         pluginString += "        lv2:default " + d_string(plugin.getParameterValue(i)) + " ;\n";

  336.                         pluginString += "        lv2:minimum " + d_string(ranges.min) + " ;\n";

  337.                         pluginString += "        lv2:maximum " + d_string(ranges.max) + " ;\n";

  338.                     }

  339.                 }

  340. 

  341.                 // unit

  342.                 {

  343.                     const d_string& unit(plugin.getParameterUnit(i));

  344. 

  345.                     if (! unit.isEmpty())

  346.                     {

  347.                         if (unit == "db" || unit == "dB")

  348.                         {

  349.                             pluginString += "        unit:unit unit:db ;\n";

  350.                         }

  351.                         else if (unit == "hz" || unit == "Hz")

  352.                         {

  353.                             pluginString += "        unit:unit unit:hz ;\n";

  354.                         }

  355.                         else if (unit == "khz" || unit == "kHz")

  356.                         {

  357.                             pluginString += "        unit:unit unit:khz ;\n";

  358.                         }

  359.                         else if (unit == "mhz" || unit == "mHz")

  360.                         {

  361.                             pluginString += "        unit:unit unit:mhz ;\n";

  362.                         }

  363.                         else if (unit == "%")

  364.                         {

  365.                             pluginString += "        unit:unit unit:pc ;\n";

  366.                         }

  367.                         else

  368.                         {

  369.                             pluginString += "        unit:unit [\n";

  370.                             pluginString += "            a unit:Unit ;\n";

  371.                             pluginString += "            unit:name   \"" + unit + "\" ;\n";

  372.                             pluginString += "            unit:symbol \"" + unit + "\" ;\n";

  373.                             pluginString += "            unit:render \"%f " + unit + "\" ;\n";

  374.                             pluginString += "        ] ;\n";

  375.                         }

  376.                     }

  377.                 }

  378. 

  379.                 // hints

  380.                 {

  381.                     const uint32_t hints(plugin.getParameterHints(i));

  382. 

  383.                     if (hints & kParameterIsBoolean)

  384.                         pluginString += "        lv2:portProperty lv2:toggled ;\n";

  385.                     if (hints & kParameterIsInteger)

  386.                         pluginString += "        lv2:portProperty lv2:integer ;\n";

  387.                     if (hints & kParameterIsLogarithmic)

  388.                         pluginString += "        lv2:portProperty <" LV2_PORT_PROPS__logarithmic "> ;\n";

  389.                     if ((hints & kParameterIsAutomable) == 0 && ! plugin.isParameterOutput(i))

  390.                     {

  391.                         pluginString += "        lv2:portProperty <" LV2_PORT_PROPS__expensive "> ,\n";

  392.                         pluginString += "                         <" LV2_KXSTUDIO_PROPERTIES__NonAutomable "> ;\n";

  393.                     }

  394.                 }

  395. 

  396.                 if (i+1 == count)

  397.                     pluginString += "    ] ;\n\n";

  398.                 else

  399.                     pluginString += "    ] ,\n";

  400.             }

  401.         }

  402. 

  403.         pluginString += "    doap:name \"" + d_string(plugin.getName()) + "\" ;\n";

  404.         pluginString += "    doap:maintainer [ foaf:name \"" + d_string(plugin.getMaker()) + "\" ] .\n";

  405. 

  406.         pluginFile << pluginString << std::endl;

  407.         pluginFile.close();

  408.         std::cout << " done!" << std::endl;

  409.     }

  410. }