add some assert for reloading saved plugin pin connections
[ardour.git] / 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 "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         internal_instrument = p;
62         external_instrument_model = (_("Unknown"));
63         external_instrument_mode = "";
64         Changed(); /* EMIT SIGNAL */
65 }
66
67 string
68 InstrumentInfo::get_instrument_name () const
69 {
70         boost::shared_ptr<Processor> p = internal_instrument.lock();
71         if (p) {
72                 return p->name();
73         }
74
75         if (external_instrument_mode.empty()) {
76                 return external_instrument_model;
77         } else {
78                 return string_compose ("%1 (%2)", external_instrument_model, external_instrument_mode);
79         }
80 }
81
82 string
83 InstrumentInfo::get_patch_name (uint16_t bank, uint8_t program, uint8_t channel) const
84 {
85         boost::shared_ptr<Processor> p = internal_instrument.lock();
86         if (p) {
87                 return get_plugin_patch_name (p, bank, program, channel);
88         }
89
90         MIDI::Name::PatchPrimaryKey patch_key (program, bank);
91
92         boost::shared_ptr<MIDI::Name::Patch> patch =
93                 MIDI::Name::MidiPatchManager::instance().find_patch (external_instrument_model,
94                                                                      external_instrument_mode, channel, patch_key);
95
96         if (patch) {
97                 return patch->name();
98         } else {
99                 /* program and bank numbers are zero-based: convert to one-based: MIDI_BP_ZERO */
100
101 #define MIDI_BP_ZERO ((Config->get_first_midi_bank_is_zero())?0:1)
102
103                 return string_compose ("prg %1 bnk %2",program + MIDI_BP_ZERO , bank + MIDI_BP_ZERO);
104         }
105 }
106
107 string
108 InstrumentInfo::get_controller_name (Evoral::Parameter param) const
109 {
110         boost::shared_ptr<Processor> p = internal_instrument.lock();
111         if (p || param.type() != MidiCCAutomation) {
112                 return "";
113         }
114
115         boost::shared_ptr<MIDI::Name::MasterDeviceNames> dev_names(
116                 MIDI::Name::MidiPatchManager::instance().master_device_by_model(
117                         external_instrument_model));
118         if (!dev_names) {
119                 return "";
120         }
121
122         boost::shared_ptr<ChannelNameSet> chan_names(
123                 dev_names->channel_name_set_by_channel(
124                         external_instrument_mode, param.channel()));
125         if (!chan_names) {
126                 return "";
127         }
128
129         boost::shared_ptr<ControlNameList> control_names(
130                 dev_names->control_name_list(chan_names->control_list_name()));
131         if (!control_names) {
132                 return "";
133         }
134
135         return control_names->control(param.id())->name();
136 }
137
138 boost::shared_ptr<MIDI::Name::ChannelNameSet>
139 InstrumentInfo::get_patches (uint8_t channel)
140 {
141         boost::shared_ptr<Processor> p = internal_instrument.lock();
142         if (p) {
143                 return plugin_programs_to_channel_name_set (p);
144         }
145
146         boost::shared_ptr<MIDI::Name::ChannelNameSet> channel_name_set =
147                 MidiPatchManager::instance().find_channel_name_set (external_instrument_model,
148                                                                                                                     external_instrument_mode,
149                                                                                                                     channel);
150
151         //std::cerr << "got channel name set with name '" << channel_name_set->name() << std::endl;
152
153         return channel_name_set;
154 }
155
156 boost::shared_ptr<MIDI::Name::ChannelNameSet>
157 InstrumentInfo::plugin_programs_to_channel_name_set (boost::shared_ptr<Processor> p)
158 {
159         PatchNameList patch_list;
160
161         boost::shared_ptr<PluginInsert> insert = boost::dynamic_pointer_cast<PluginInsert> (p);
162         if (!insert) {
163                 return boost::shared_ptr<ChannelNameSet>();
164         }
165
166         boost::shared_ptr<Plugin> pp = insert->plugin();
167
168         if (pp->current_preset_uses_general_midi()) {
169
170                 patch_list = InstrumentInfo::general_midi_patches ();
171
172         } else if (pp->presets_are_MIDI_programs()) {
173
174                 std::vector<Plugin::PresetRecord> presets = pp->get_presets ();
175                 std::vector<Plugin::PresetRecord>::iterator i;
176                 int n;
177
178                 for (n = 0, i = presets.begin(); i != presets.end(); ++i, ++n) {
179                         if ((*i).valid) {
180                                 patch_list.push_back (boost::shared_ptr<Patch> (new Patch ((*i).label, n)));
181                         } else {
182                                 patch_list.push_back (boost::shared_ptr<Patch> (new Patch (string_compose ("program %1", n), n)));
183                         }
184                 }
185         } else {
186                 for (int n = 0; n < 127; ++n) {
187                         patch_list.push_back (boost::shared_ptr<Patch> (new Patch (string_compose ("program %1", n), n)));
188                 }
189         }
190
191         boost::shared_ptr<PatchBank> pb (new PatchBank (0, p->name()));
192         pb->set_patch_name_list (patch_list);
193
194         ChannelNameSet::PatchBanks patch_banks;
195         patch_banks.push_back (pb);
196
197         boost::shared_ptr<MIDI::Name::ChannelNameSet> cns (new ChannelNameSet);
198         cns->set_patch_banks (patch_banks);
199
200         return cns;
201 }
202
203 const MIDI::Name::PatchNameList&
204 InstrumentInfo::general_midi_patches()
205 {
206         if (_gm_patches.empty()) {
207                 for (int n = 0; n < 128; n++) {
208                         _gm_patches.push_back (boost::shared_ptr<Patch> (new Patch (general_midi_program_names[n], n)));
209                 }
210         }
211
212         return _gm_patches;
213 }
214
215 string
216 InstrumentInfo::get_plugin_patch_name (boost::shared_ptr<Processor> p, uint16_t bank, uint8_t program, uint8_t /*channel*/) const
217 {
218         boost::shared_ptr<PluginInsert> insert = boost::dynamic_pointer_cast<PluginInsert> (p);
219         if (insert) {
220                 boost::shared_ptr<Plugin> pp = insert->plugin();
221
222                 if (pp->current_preset_uses_general_midi()) {
223                         return MIDI::Name::general_midi_program_names[std::min((uint8_t) 127,program)];
224                 }
225         }
226
227         return string_compose (_("preset %1 (bank %2)"), (int) program, (int) bank);
228 }