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