libs/ardour/instrument_info.cc

   1 /*
   2     Copyright (C) 2012 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include <algorithm>
  20
  21 #include "pbd/compose.h"
  22
  23 #include "midi++/midnam_patch.h"
  24
  25 #include "ardour/instrument_info.h"
  26 #include "ardour/midi_patch_manager.h"
  27 #include "ardour/processor.h"
  28 #include "ardour/plugin.h"
  29 #include "ardour/plugin_insert.h"
  30 #include "ardour/rc_configuration.h"
  31
  32 #include "pbd/i18n.h"
  33
  34 using namespace ARDOUR;
  35 using namespace MIDI::Name;
  36 using std::string;
  37
  38 MIDI::Name::PatchNameList InstrumentInfo::_gm_patches;
  39
  40 InstrumentInfo::InstrumentInfo ()
  41         : external_instrument_model (_("Unknown"))
  42 {
  43 }
  44
  45 InstrumentInfo::~InstrumentInfo ()
  46 {
  47 }
  48
  49 void
  50 InstrumentInfo::set_external_instrument (const string& model, const string& mode)
  51 {
  52         external_instrument_model = model;
  53         external_instrument_mode = mode;
  54         internal_instrument.reset ();
  55         Changed(); /* EMIT SIGNAL */
  56 }
  57
  58 void
  59 InstrumentInfo::set_internal_instrument (boost::shared_ptr<Processor> p)
  60 {
  61         external_instrument_mode = "";
  62
  63         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(p);
  64         if (pi && pi->plugin ()->has_midnam ()) {
  65                 /* really back hack, following MidiTimeAxisView::model_changed()
  66                  *
  67                  * InstrumentInfo::get_plugin_patch_name() needs to be overhauled,
  68                  * it limits all PluginInsert to generic-midi or only numbers.
  69                  */
  70                 internal_instrument.reset ();
  71                 external_instrument_model = pi->plugin ()->midnam_model ();
  72                 const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (external_instrument_model);
  73                 if (device_modes.size() > 0) {
  74                         external_instrument_mode = device_modes.front();
  75                 }
  76         } else {
  77                 internal_instrument = p;
  78                 external_instrument_model = (_("Unknown"));
  79         }
  80         Changed(); /* EMIT SIGNAL */
  81 }
  82
  83 string
  84 InstrumentInfo::get_instrument_name () const
  85 {
  86         boost::shared_ptr<Processor> p = internal_instrument.lock();
  87         if (p) {
  88                 return p->name();
  89         }
  90
  91         if (external_instrument_mode.empty()) {
  92                 return external_instrument_model;
  93         } else {
  94                 return string_compose ("%1 (%2)", external_instrument_model, external_instrument_mode);
  95         }
  96 }
  97
  98 string
  99 InstrumentInfo::get_patch_name (uint16_t bank, uint8_t program, uint8_t channel) const
 100 {
 101         return get_patch_name (bank, program, channel, true);
 102 }
 103
 104 string
 105 InstrumentInfo::get_patch_name_without (uint16_t bank, uint8_t program, uint8_t channel) const
 106 {
 107         return get_patch_name (bank, program, channel, false);
 108 }
 109
 110 string
 111 InstrumentInfo::get_patch_name (uint16_t bank, uint8_t program, uint8_t channel, bool with_extra) const
 112 {
 113         boost::shared_ptr<Processor> p = internal_instrument.lock();
 114         if (p) {
 115                 return get_plugin_patch_name (p, bank, program, channel);
 116         }
 117
 118         MIDI::Name::PatchPrimaryKey patch_key (program, bank);
 119
 120         boost::shared_ptr<MIDI::Name::Patch> patch =
 121                 MIDI::Name::MidiPatchManager::instance().find_patch (external_instrument_model,
 122                                                                      external_instrument_mode, channel, patch_key);
 123
 124         if (patch) {
 125                 return patch->name();
 126         } else {
 127                 /* program and bank numbers are zero-based: convert to one-based: MIDI_BP_ZERO */
 128
 129 #define MIDI_BP_ZERO ((Config->get_first_midi_bank_is_zero())?0:1)
 130
 131                 if (with_extra) {
 132                         return string_compose ("prg %1 bnk %2",program + MIDI_BP_ZERO , bank + MIDI_BP_ZERO);
 133                 } else {
 134                         return string_compose ("%1", program + MIDI_BP_ZERO);
 135                 }
 136         }
 137 }
 138
 139 string
 140 InstrumentInfo::get_controller_name (Evoral::Parameter param) const
 141 {
 142         boost::shared_ptr<Processor> p = internal_instrument.lock();
 143         if (param.type() != MidiCCAutomation) {
 144                 return "";
 145         }
 146         if (p) {
 147                 return get_plugin_controller_name (p, param);
 148         }
 149
 150         boost::shared_ptr<MIDI::Name::MasterDeviceNames> dev_names(
 151                 MIDI::Name::MidiPatchManager::instance().master_device_by_model(
 152                         external_instrument_model));
 153         if (!dev_names) {
 154                 return "";
 155         }
 156
 157         boost::shared_ptr<ChannelNameSet> chan_names(
 158                 dev_names->channel_name_set_by_channel(
 159                         external_instrument_mode, param.channel()));
 160         if (!chan_names) {
 161                 return "";
 162         }
 163
 164         boost::shared_ptr<ControlNameList> control_names(
 165                 dev_names->control_name_list(chan_names->control_list_name()));
 166         if (!control_names) {
 167                 return "";
 168         }
 169         boost::shared_ptr<const Control> c = control_names->control(param.id());
 170
 171         if (c) {
 172                 return string_compose(c->name() + " [%1]", int(param.channel()) + 1);
 173         }
 174
 175         return "";
 176 }
 177
 178 boost::shared_ptr<MIDI::Name::ChannelNameSet>
 179 InstrumentInfo::get_patches (uint8_t channel)
 180 {
 181         boost::shared_ptr<Processor> p = internal_instrument.lock();
 182         if (p) {
 183                 return plugin_programs_to_channel_name_set (p);
 184         }
 185
 186         boost::shared_ptr<MIDI::Name::ChannelNameSet> channel_name_set =
 187                 MidiPatchManager::instance().find_channel_name_set (external_instrument_model,
 188                                                                                                                     external_instrument_mode,
 189                                                                                                                     channel);
 190
 191         //std::cerr << "got channel name set with name '" << channel_name_set->name() << std::endl;
 192
 193         return channel_name_set;
 194 }
 195
 196 boost::shared_ptr<MIDI::Name::ChannelNameSet>
 197 InstrumentInfo::plugin_programs_to_channel_name_set (boost::shared_ptr<Processor> p)
 198 {
 199         PatchNameList patch_list;
 200
 201         boost::shared_ptr<PluginInsert> insert = boost::dynamic_pointer_cast<PluginInsert> (p);
 202         if (!insert) {
 203                 return boost::shared_ptr<ChannelNameSet>();
 204         }
 205
 206         boost::shared_ptr<Plugin> pp = insert->plugin();
 207
 208         if (pp->current_preset_uses_general_midi()) {
 209
 210                 patch_list = InstrumentInfo::general_midi_patches ();
 211
 212         } else if (pp->presets_are_MIDI_programs()) {
 213
 214                 std::vector<Plugin::PresetRecord> presets = pp->get_presets ();
 215                 std::vector<Plugin::PresetRecord>::iterator i;
 216                 int n;
 217
 218                 for (n = 0, i = presets.begin(); i != presets.end(); ++i, ++n) {
 219                         if ((*i).valid) {
 220                                 patch_list.push_back (boost::shared_ptr<Patch> (new Patch ((*i).label, n)));
 221                         } else {
 222                                 patch_list.push_back (boost::shared_ptr<Patch> (new Patch (string_compose ("program %1", n), n)));
 223                         }
 224                 }
 225         } else {
 226                 for (int n = 0; n < 127; ++n) {
 227                         patch_list.push_back (boost::shared_ptr<Patch> (new Patch (string_compose ("program %1", n), n)));
 228                 }
 229         }
 230
 231         boost::shared_ptr<PatchBank> pb (new PatchBank (0, p->name()));
 232         pb->set_patch_name_list (patch_list);
 233
 234         ChannelNameSet::PatchBanks patch_banks;
 235         patch_banks.push_back (pb);
 236
 237         boost::shared_ptr<MIDI::Name::ChannelNameSet> cns (new ChannelNameSet);
 238         cns->set_patch_banks (patch_banks);
 239
 240         return cns;
 241 }
 242
 243 const MIDI::Name::PatchNameList&
 244 InstrumentInfo::general_midi_patches()
 245 {
 246         if (_gm_patches.empty()) {
 247                 for (int n = 0; n < 128; n++) {
 248                         _gm_patches.push_back (boost::shared_ptr<Patch> (new Patch (general_midi_program_names[n], n)));
 249                 }
 250         }
 251
 252         return _gm_patches;
 253 }
 254
 255 string
 256 InstrumentInfo::get_plugin_controller_name (boost::shared_ptr<ARDOUR::Processor>, Evoral::Parameter param) const
 257 {
 258         return "";
 259 }
 260
 261 string
 262 InstrumentInfo::get_plugin_patch_name (boost::shared_ptr<Processor> p, uint16_t bank, uint8_t program, uint8_t /*channel*/) const
 263 {
 264         boost::shared_ptr<PluginInsert> insert = boost::dynamic_pointer_cast<PluginInsert> (p);
 265         if (insert) {
 266                 boost::shared_ptr<Plugin> pp = insert->plugin();
 267
 268                 if (pp->current_preset_uses_general_midi()) {
 269                         return MIDI::Name::general_midi_program_names[std::min((uint8_t) 127,program)];
 270                 }
 271         }
 272
 273         return string_compose (_("preset %1 (bank %2)"), (int) program, (int) bank);
 274 }