diff --git a/libs/midi++2/midi++/midnam_patch.h b/libs/midi++2/midi++/midnam_patch.h index 316ac8fdb9..505245ae84 100644 --- a/libs/midi++2/midi++/midnam_patch.h +++ b/libs/midi++2/midi++/midnam_patch.h @@ -26,7 +26,6 @@ #include #include -#include "pbd/stateful.h" #include "midi++/event.h" #include "pbd/xml++.h" @@ -84,13 +83,12 @@ public: class PatchBank; -class Patch : public PBD::Stateful +class Patch { public: - Patch(PatchBank* a_bank = 0) : _bank(a_bank) {}; - Patch(std::string a_number, std::string a_name, PatchBank* a_bank = 0) - : _number(a_number), _name(a_name), _bank(a_bank) {}; + Patch (PatchBank* a_bank = 0); + Patch(std::string a_number, std::string a_name, PatchBank* a_bank = 0); virtual ~Patch() {}; const std::string& name() const { return _name; } @@ -102,17 +100,17 @@ public: const PatchPrimaryKey& patch_primary_key() const { return _id; } XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + int set_state (const XMLTree&, const XMLNode&); + + int use_bank_info (PatchBank*); private: std::string _number; std::string _name; - // cannot use a boost::shared_ptr here in order to avoid retain cycles - PatchBank* _bank; PatchPrimaryKey _id; }; -class PatchBank : public PBD::Stateful +class PatchBank { public: typedef std::list > PatchNameList; @@ -125,21 +123,25 @@ public: void set_name(const std::string a_name) { _name = a_name; } const PatchNameList& patch_name_list() const { return _patch_name_list; } - + const std::string& patch_list_name() const { return _patch_list_name; } + + int set_patch_name_list (const PatchNameList&); + const PatchPrimaryKey* patch_primary_key() const { return _id; } XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + int set_state (const XMLTree&, const XMLNode&); private: std::string _name; PatchNameList _patch_name_list; PatchPrimaryKey* _id; + std::string _patch_list_name; }; #include -class ChannelNameSet : public PBD::Stateful +class ChannelNameSet { public: typedef std::set AvailableForChannels; @@ -203,7 +205,7 @@ public: } XMLNode& get_state (void); - int set_state (const XMLNode& a_node, int version); + int set_state (const XMLTree&, const XMLNode&); private: std::string _name; @@ -211,9 +213,10 @@ private: PatchBanks _patch_banks; PatchMap _patch_map; PatchList _patch_list; + std::string _patch_list_name; }; -class Note : public PBD::Stateful +class Note { public: Note() {}; @@ -227,14 +230,14 @@ public: void set_number(const std::string a_number) { _number = a_number; } XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + int set_state (const XMLTree&, const XMLNode&); private: std::string _number; std::string _name; }; -class NoteNameList : public PBD::Stateful +class NoteNameList { public: typedef std::list > Notes; @@ -248,14 +251,14 @@ public: const Notes& notes() const { return _notes; } XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + int set_state (const XMLTree&, const XMLNode&); private: std::string _name; Notes _notes; }; -class CustomDeviceMode : public PBD::Stateful +class CustomDeviceMode { public: CustomDeviceMode() {}; @@ -266,7 +269,7 @@ public: XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + int set_state (const XMLTree&, const XMLNode&); std::string channel_name_set_name_by_channel(uint8_t channel) { assert(channel <= 15); @@ -280,7 +283,7 @@ private: std::string _channel_name_set_assignments[16]; }; -class MasterDeviceNames : public PBD::Stateful +class MasterDeviceNames { public: typedef std::list Models; @@ -290,7 +293,7 @@ public: /// maps name to ChannelNameSet typedef std::map > ChannelNameSets; typedef std::list > NoteNameLists; - + typedef std::map PatchNameLists; MasterDeviceNames() {}; virtual ~MasterDeviceNames() {}; @@ -317,7 +320,7 @@ public: } XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + int set_state (const XMLTree&, const XMLNode&); private: std::string _manufacturer; @@ -326,9 +329,10 @@ private: CustomDeviceModeNames _custom_device_mode_names; ChannelNameSets _channel_name_sets; NoteNameLists _note_name_lists; + PatchNameLists _patch_name_lists; }; -class MIDINameDocument : public PBD::Stateful +class MIDINameDocument { public: // Maps Model names to MasterDeviceNames @@ -346,7 +350,7 @@ public: const MasterDeviceNames::Models& all_models() const { return _all_models; } XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + int set_state (const XMLTree&, const XMLNode&); private: std::string _author; diff --git a/libs/midi++2/midnam_patch.cc b/libs/midi++2/midnam_patch.cc index b9a810ba58..efc6c1c6a0 100644 --- a/libs/midi++2/midnam_patch.cc +++ b/libs/midi++2/midnam_patch.cc @@ -22,9 +22,13 @@ #include #include "midi++/midnam_patch.h" +#include "pbd/compose.h" #include "pbd/convert.h" +#include "pbd/error.h" +#include "pbd/failed_constructor.h" using namespace std; +using PBD::error; namespace MIDI { @@ -32,6 +36,18 @@ namespace MIDI namespace Name { +Patch::Patch (PatchBank* b) +{ + use_bank_info (b); +} + +Patch::Patch (std::string a_number, std::string a_name, PatchBank* a_bank) + : _number (a_number) + , _name (a_name) +{ + use_bank_info (a_bank); +} + XMLNode& Patch::get_state (void) { @@ -51,7 +67,7 @@ Patch::get_state (void) return *node; } -void initialize_primary_key_from_commands (PatchPrimaryKey& id, const XMLNode* node) +int initialize_primary_key_from_commands (PatchPrimaryKey& id, const XMLNode* node) { const XMLNodeList events = node->children(); for (XMLNodeList::const_iterator i = events.begin(); i != events.end(); ++i) { @@ -73,34 +89,62 @@ void initialize_primary_key_from_commands (PatchPrimaryKey& id, const XMLNode* n id.program_number = PBD::atoi(number); } } + + return 0; } - int -Patch::set_state (const XMLNode& node, int /*version*/) +Patch::set_state (const XMLTree&, const XMLNode& node) { - assert(node.name() == "Patch"); - _number = node.property("Number")->value(); - _name = node.property("Name")->value(); + if (node.name() != "Patch") { + cerr << "Incorrect node " << node.name() << " handed to Patch" << endl; + return -1; + } + + const XMLProperty* prop = node.property ("Number"); + + if (!prop) { + return -1; + } + _number = prop->value(); + + prop = node.property ("Name"); + + if (!prop) { + return -1; + } + _name = prop->value(); + XMLNode* commands = node.child("PatchMIDICommands"); if (commands) { - initialize_primary_key_from_commands(_id, commands); + if (initialize_primary_key_from_commands(_id, commands)) { + return -1; + } } else { string program_change = node.property("ProgramChange")->value(); assert(program_change.length()); - assert(_bank); - assert(_bank->patch_primary_key()); - if ( _bank && _bank->patch_primary_key() ) { - _id.msb = _bank->patch_primary_key()->msb; - _id.lsb = _bank->patch_primary_key()->lsb; - _id.program_number = PBD::atoi(program_change); + _id.program_number = PBD::atoi(program_change); + } + + return 0; +} + +int +Patch::use_bank_info (PatchBank* bank) +{ + if (bank) { + if (bank->patch_primary_key() ) { + _id.msb = bank->patch_primary_key()->msb; + _id.lsb = bank->patch_primary_key()->lsb; + } else { + return -1; } } - cerr << "deserialized Patch: name: " << _name << " msb: " << _id.msb << " lsb: " << _id.lsb << " program " << _id.program_number << endl; - // TODO: handle that more gracefully - assert(_id.is_sane()); + if (!_id.is_sane()) { + return -1; + } return 0; } @@ -116,7 +160,7 @@ Note::get_state (void) } int -Note::set_state (const XMLNode& node, int /*version*/) +Note::set_state (const XMLTree&, const XMLNode& node) { assert(node.name() == "Note"); _number = node.property("Number")->value(); @@ -135,16 +179,15 @@ NoteNameList::get_state (void) } int -NoteNameList::set_state (const XMLNode& node, int version) +NoteNameList::set_state (const XMLTree& tree, const XMLNode& node) { assert(node.name() == "NoteNameList"); _name = node.property("Name")->value(); - boost::shared_ptr notes = - node.find("//Note"); + boost::shared_ptr notes = tree.find("//Note"); for (XMLSharedNodeList::const_iterator i = notes->begin(); i != notes->end(); ++i) { boost::shared_ptr note(new Note()); - note->set_state(*(*i), version); + note->set_state (tree, *(*i)); _notes.push_back(note); } @@ -168,7 +211,7 @@ PatchBank::get_state (void) } int -PatchBank::set_state (const XMLNode& node, int version) +PatchBank::set_state (const XMLTree& tree, const XMLNode& node) { assert(node.name() == "PatchBank"); _name = node.property("Name")->value(); @@ -176,16 +219,43 @@ PatchBank::set_state (const XMLNode& node, int version) XMLNode* commands = node.child("MIDICommands"); if (commands) { _id = new PatchPrimaryKey(); - initialize_primary_key_from_commands(*_id, commands); + if (initialize_primary_key_from_commands(*_id, commands)) { + return -1; + } } XMLNode* patch_name_list = node.child("PatchNameList"); - assert(patch_name_list); - const XMLNodeList patches = patch_name_list->children(); - for (XMLNodeList::const_iterator i = patches.begin(); i != patches.end(); ++i) { - boost::shared_ptr patch(new Patch(this)); - patch->set_state(*(*i), version); - _patch_name_list.push_back(patch); + + if (patch_name_list) { + const XMLNodeList patches = patch_name_list->children(); + for (XMLNodeList::const_iterator i = patches.begin(); i != patches.end(); ++i) { + boost::shared_ptr patch(new Patch(this)); + patch->set_state(tree, *(*i)); + _patch_name_list.push_back(patch); + } + } else { + XMLNode* use_patch_name_list = node.child ("UsesPatchNameList"); + if (use_patch_name_list) { + _patch_list_name = node.property ("Name")->value(); + } else { + error << "Patch without patch name list - patchfile will be ignored" << endmsg; + return -1; + } + } + + return 0; +} + +int +PatchBank::set_patch_name_list (const PatchNameList& pnl) +{ + _patch_name_list = pnl; + _patch_list_name = ""; + + for (PatchNameList::iterator p = _patch_name_list.begin(); p != _patch_name_list.end(); p++) { + if ((*p)->use_bank_info (this)) { + return -1; + } } return 0; @@ -223,35 +293,27 @@ ChannelNameSet::get_state (void) } int -ChannelNameSet::set_state (const XMLNode& node, int version) +ChannelNameSet::set_state (const XMLTree& tree, const XMLNode& node) { assert(node.name() == "ChannelNameSet"); _name = node.property("Name")->value(); - // cerr << "ChannelNameSet _name: " << _name << endl; const XMLNodeList children = node.children(); for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) { XMLNode* node = *i; assert(node); if (node->name() == "AvailableForChannels") { - // cerr << "AvailableForChannels" << endl; boost::shared_ptr channels = - node->find("//AvailableChannel[@Available = 'true']/@Channel"); - // cerr << "AvailableForChannels after find" << endl; + tree.find("//AvailableChannel[@Available = 'true']/@Channel"); for(XMLSharedNodeList::const_iterator i = channels->begin(); i != channels->end(); ++i) { - // cerr << "AvailableForChannels before insert" << endl; _available_for_channels.insert(atoi((*i)->attribute_value().c_str())); - // cerr << "AvailableForChannels after insert" << endl; } } - // cerr << "before PatchBank" << endl; - if (node->name() == "PatchBank") { - // cerr << "got PatchBank" << endl; boost::shared_ptr bank(new PatchBank()); - bank->set_state(*node, version); + bank->set_state(tree, *node); _patch_banks.push_back(bank); const PatchBank::PatchNameList& patches = bank->patch_name_list(); for (PatchBank::PatchNameList::const_iterator patch = patches.begin(); @@ -260,24 +322,21 @@ ChannelNameSet::set_state (const XMLNode& node, int version) _patch_map[(*patch)->patch_primary_key()] = *patch; _patch_list.push_back((*patch)->patch_primary_key()); } - // cerr << "after PatchBank pushback" << endl; } } - // cerr << "ChannelnameSet done" << endl; - return 0; } int -CustomDeviceMode::set_state(const XMLNode& a_node, int /*version*/) +CustomDeviceMode::set_state(const XMLTree& tree, const XMLNode& a_node) { assert(a_node.name() == "CustomDeviceMode"); _name = a_node.property("Name")->value(); boost::shared_ptr channel_name_set_assignments = - a_node.find("//ChannelNameSetAssign"); + tree.find("//ChannelNameSetAssign"); for(XMLSharedNodeList::const_iterator i = channel_name_set_assignments->begin(); i != channel_name_set_assignments->end(); ++i) { @@ -307,17 +366,15 @@ CustomDeviceMode::get_state(void) } int -MasterDeviceNames::set_state(const XMLNode& a_node, int version) +MasterDeviceNames::set_state(const XMLTree& tree, const XMLNode& a_node) { - // cerr << "MasterDeviceNames::set_state Manufacturer" << endl; // Manufacturer - boost::shared_ptr manufacturer = a_node.find("//Manufacturer"); + boost::shared_ptr manufacturer = tree.find("//Manufacturer"); assert(manufacturer->size() == 1); _manufacturer = manufacturer->front()->content(); - // cerr << "MasterDeviceNames::set_state models" << endl; // Models - boost::shared_ptr models = a_node.find("//Model"); + boost::shared_ptr models = tree.find("//Model"); assert(models->size() >= 1); for (XMLSharedNodeList::iterator i = models->begin(); i != models->end(); @@ -329,42 +386,80 @@ MasterDeviceNames::set_state(const XMLNode& a_node, int version) _models.push_back(content->content()); } - // cerr << "MasterDeviceNames::set_state CustomDeviceModes" << endl; // CustomDeviceModes - boost::shared_ptr custom_device_modes = a_node.find("//CustomDeviceMode"); + boost::shared_ptr custom_device_modes = tree.find("//CustomDeviceMode"); for (XMLSharedNodeList::iterator i = custom_device_modes->begin(); i != custom_device_modes->end(); ++i) { boost::shared_ptr custom_device_mode(new CustomDeviceMode()); - custom_device_mode->set_state(*(*i), version); + custom_device_mode->set_state(tree, *(*i)); _custom_device_modes[custom_device_mode->name()] = custom_device_mode; _custom_device_mode_names.push_back(custom_device_mode->name()); } - // cerr << "MasterDeviceNames::set_state ChannelNameSets" << endl; // ChannelNameSets - boost::shared_ptr channel_name_sets = a_node.find("//ChannelNameSet"); + boost::shared_ptr channel_name_sets = tree.find("//ChannelNameSet"); for (XMLSharedNodeList::iterator i = channel_name_sets->begin(); i != channel_name_sets->end(); ++i) { boost::shared_ptr channel_name_set(new ChannelNameSet()); - // cerr << "MasterDeviceNames::set_state ChannelNameSet before set_state" << endl; - channel_name_set->set_state(*(*i), version); + channel_name_set->set_state(tree, *(*i)); _channel_name_sets[channel_name_set->name()] = channel_name_set; } - // cerr << "MasterDeviceNames::set_state NoteNameLists" << endl; // NoteNameLists - boost::shared_ptr note_name_lists = a_node.find("//NoteNameList"); + boost::shared_ptr note_name_lists = tree.find("//NoteNameList"); for (XMLSharedNodeList::iterator i = note_name_lists->begin(); i != note_name_lists->end(); ++i) { boost::shared_ptr note_name_list(new NoteNameList()); - note_name_list->set_state(*(*i), version); + note_name_list->set_state (tree, *(*i)); _note_name_lists.push_back(note_name_list); } + // global/post-facto PatchNameLists + boost::shared_ptr patch_name_lists = tree.find("/child::MIDINameDocument/child::MasterDeviceNames/child::PatchNameList"); + for (XMLSharedNodeList::iterator i = patch_name_lists->begin(); + i != patch_name_lists->end(); + ++i) { + + PatchBank::PatchNameList patch_name_list; + const XMLNodeList patches = (*i)->children(); + + for (XMLNodeList::const_iterator p = patches.begin(); p != patches.end(); ++p) { + boost::shared_ptr patch(new Patch()); + patch->set_state(tree, *(*p)); + patch_name_list.push_back(patch); + } + + if (!patch_name_list.empty()) { + _patch_name_lists[(*i)->property ("Name")->value()] = patch_name_list; + } + } + + /* now traverse patches and hook up anything that used UsePatchNameList + * to the right patch list + */ + + for (ChannelNameSets::iterator cns = _channel_name_sets.begin(); cns != _channel_name_sets.end(); ++cns) { + ChannelNameSet::PatchBanks pbs = cns->second->patch_banks(); + for (ChannelNameSet::PatchBanks::iterator pb = pbs.begin(); pb != pbs.end(); ++pb) { + std::string pln = (*pb)->patch_list_name(); + if (!pln.empty()) { + PatchNameLists::iterator p = _patch_name_lists.find (pln); + if (p != _patch_name_lists.end()) { + if ((*pb)->set_patch_name_list (p->second)) { + return -1; + } + } else { + error << string_compose ("Patch list name %1 was not found - patch file ignored", pln) << endmsg; + return -1; + } + } + } + } + return 0; } @@ -376,39 +471,47 @@ MasterDeviceNames::get_state(void) } MIDINameDocument::MIDINameDocument (const string& filename) - : _document(XMLTree(filename)) { - set_state(*_document.root(), 0); + if (!_document.read (filename)) { + throw failed_constructor (); + } + + set_state (_document, *_document.root()); } int -MIDINameDocument::set_state(const XMLNode& a_node, int version) +MIDINameDocument::set_state (const XMLTree& tree, const XMLNode& a_node) { // Author - boost::shared_ptr author = a_node.find("//Author"); - assert(author->size() == 1); + + boost::shared_ptr author = tree.find("//Author"); + if (author->size() < 1) { + error << "No author information in MIDNAM file" << endmsg; + return -1; + } _author = author->front()->content(); - // cerr << "MIDINameDocument::set_state befor masterdevicenames" << endl; // MasterDeviceNames - boost::shared_ptr master_device_names_list = a_node.find("//MasterDeviceNames"); + + boost::shared_ptr master_device_names_list = tree.find ("//MasterDeviceNames"); + for (XMLSharedNodeList::iterator i = master_device_names_list->begin(); i != master_device_names_list->end(); ++i) { boost::shared_ptr master_device_names(new MasterDeviceNames()); - // cerr << "MIDINameDocument::set_state before masterdevicenames->set_state" << endl; - master_device_names->set_state(*(*i), version); - // cerr << "MIDINameDocument::set_state after masterdevicenames->set_state" << endl; + + if (master_device_names->set_state(tree, *(*i))) { + return -1; + } for (MasterDeviceNames::Models::const_iterator model = master_device_names->models().begin(); model != master_device_names->models().end(); ++model) { - // cerr << "MIDINameDocument::set_state inserting model " << *model << endl; - _master_device_names_list.insert( - std::pair > - (*model, master_device_names)); - - _all_models.push_back(*model); + _master_device_names_list.insert( + std::pair > + (*model, master_device_names)); + + _all_models.push_back(*model); } }