libs/ardour/panner_manager.cc

   1 /*
   2     Copyright (C) 2011 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
  20 #include <unistd.h>
  21
  22 #include <glibmm/pattern.h>
  23 #include <glibmm/fileutils.h>
  24
  25 #include "pbd/error.h"
  26 #include "pbd/compose.h"
  27 #include "pbd/file_utils.h"
  28 #include "pbd/stl_delete.h"
  29
  30 #include "ardour/debug.h"
  31 #include "ardour/panner_manager.h"
  32
  33 #include "ardour/search_paths.h"
  34
  35 #include "i18n.h"
  36
  37 using namespace std;
  38 using namespace ARDOUR;
  39 using namespace PBD;
  40
  41 PannerManager* PannerManager::_instance = 0;
  42
  43 PannerManager::PannerManager ()
  44 {
  45 }
  46
  47 PannerManager::~PannerManager ()
  48 {
  49         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
  50                 delete *p;
  51         }
  52 }
  53
  54 PannerManager&
  55 PannerManager::instance ()
  56 {
  57         if (_instance == 0) {
  58                 _instance = new PannerManager ();
  59         }
  60
  61         return *_instance;
  62 }
  63
  64 static bool panner_filter (const string& str, void */*arg*/)
  65 {
  66 #ifdef COMPILER_MSVC
  67    /**
  68     * Different build targets (Debug / Release etc) use different versions
  69     * of the 'C' runtime (which can't be 'mixed & matched'). Therefore, in
  70     * case the supplied search path contains multiple version(s) of a given
  71     * panner module, only select the one(s) which match the current build
  72     * target (otherwise, all hell will break loose !!)
  73     */
  74         #if defined (_DEBUG)
  75                 return str.length() > 12 && (str.find ("panner_") == 0) && (str.find ("D.dll") == (str.length() - 5));
  76         #elif defined (RDC_BUILD)
  77                 return str.length() > 14 && (str.find ("panner_") == 0) && (str.find ("RDC.dll") == (str.length() - 7));
  78         #elif defined (_WIN64)
  79                 return str.length() > 13 && (str.find ("panner_") == 0) && (str.find ("64.dll") == (str.length() - 6));
  80         #else
  81                 return str.length() > 13 && (str.find ("panner_") == 0) && (str.find ("32.dll") == (str.length() - 6));
  82         #endif
  83 #elif defined (__APPLE__)
  84         return str[0] != '.' && (str.length() > 6 && str.find (".dylib") == (str.length() - 6));
  85 #else
  86         return str[0] != '.' && (str.length() > 3 && (str.find (".so") == (str.length() - 3) || str.find (".dll") == (str.length() - 4)));
  87 #endif
  88 }
  89
  90 void
  91 PannerManager::discover_panners ()
  92 {
  93         std::vector<std::string> panner_modules;
  94         std::string search_path = panner_search_path().to_string();
  95
  96         DEBUG_TRACE (DEBUG::Panning, string_compose (_("looking for panners in %1\n"), search_path));
  97
  98         find_files_matching_filter (panner_modules, search_path, panner_filter, 0, false, true, true);
  99
 100         for (vector<std::string>::iterator i = panner_modules.begin(); i != panner_modules.end(); ++i) {
 101                 panner_discover (*i);
 102         }
 103 }
 104
 105 int
 106 PannerManager::panner_discover (string path)
 107 {
 108         PannerInfo* pinfo;
 109
 110         if ((pinfo = get_descriptor (path)) != 0) {
 111
 112                 list<PannerInfo*>::iterator i;
 113
 114                 for (i = panner_info.begin(); i != panner_info.end(); ++i) {
 115                         if (pinfo->descriptor.name == (*i)->descriptor.name) {
 116                                 break;
 117                         }
 118                 }
 119
 120                 if (i == panner_info.end()) {
 121                         panner_info.push_back (pinfo);
 122                         DEBUG_TRACE (DEBUG::Panning, string_compose(_("Panner discovered: \"%1\" in %2\n"), pinfo->descriptor.name, path));
 123                 } else {
 124                         delete pinfo;
 125                 }
 126         }
 127
 128         return 0;
 129 }
 130
 131 PannerInfo*
 132 PannerManager::get_descriptor (string path)
 133 {
 134         Glib::Module* module = new Glib::Module(path);
 135         PannerInfo* info = 0;
 136         PanPluginDescriptor *descriptor = 0;
 137         PanPluginDescriptor* (*dfunc)(void);
 138         void* func = 0;
 139
 140         if (!module) {
 141                 error << string_compose(_("PannerManager: cannot load module \"%1\" (%2)"), path,
 142                                 Glib::Module::get_last_error()) << endmsg;
 143                 delete module;
 144                 return 0;
 145         }
 146
 147         if (!module->get_symbol("panner_descriptor", func)) {
 148                 error << string_compose(_("PannerManager: module \"%1\" has no descriptor function."), path) << endmsg;
 149                 error << Glib::Module::get_last_error() << endmsg;
 150                 delete module;
 151                 return 0;
 152         }
 153
 154         dfunc = (PanPluginDescriptor* (*)(void))func;
 155         descriptor = dfunc();
 156
 157         if (descriptor) {
 158                 info = new PannerInfo (*descriptor, module);
 159         } else {
 160                 delete module;
 161         }
 162
 163         return info;
 164 }
 165
 166 PannerInfo*
 167 PannerManager::select_panner (ChanCount in, ChanCount out, std::string const uri)
 168 {
 169         PannerInfo* rv = NULL;
 170         PanPluginDescriptor* d;
 171         int32_t nin = in.n_audio();
 172         int32_t nout = out.n_audio();
 173         uint32_t priority = 0;
 174
 175         /* look for user-preference -- check if channels match */
 176         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 177                 d = &(*p)->descriptor;
 178                 if (d->panner_uri != uri) continue;
 179                 if (d->in != nin && d->in != -1) continue;
 180                 if (d->out != nout && d->out != -1) continue;
 181                 return *p;
 182         }
 183
 184         /* look for exact match first */
 185
 186         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 187                 d = &(*p)->descriptor;
 188
 189                 if (d->in == nin && d->out == nout && d->priority > priority) {
 190                         priority = d->priority;
 191                         rv = *p;
 192                 }
 193         }
 194         if (rv) { return rv; }
 195
 196         /* no exact match, look for good fit on inputs and variable on outputs */
 197
 198         priority = 0;
 199         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 200                 d = &(*p)->descriptor;
 201
 202                 if (d->in == nin && d->out == -1 && d->priority > priority) {
 203                         priority = d->priority;
 204                         rv = *p;
 205                 }
 206         }
 207         if (rv) { return rv; }
 208
 209         /* no exact match, look for good fit on outputs and variable on inputs */
 210
 211         priority = 0;
 212         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 213                 d = &(*p)->descriptor;
 214
 215                 if (d->in == -1 && d->out == nout && d->priority > priority) {
 216                         priority = d->priority;
 217                         rv = *p;
 218                 }
 219         }
 220         if (rv) { return rv; }
 221
 222         /* no exact match, look for variable fit on inputs and outputs */
 223
 224         priority = 0;
 225         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 226                 d = &(*p)->descriptor;
 227
 228                 if (d->in == -1 && d->out == -1 && d->priority > priority) {
 229                         priority = d->priority;
 230                         rv = *p;
 231                 }
 232         }
 233         if (rv) { return rv; }
 234
 235         warning << string_compose (_("no panner discovered for in/out = %1/%2"), nin, nout) << endmsg;
 236
 237         return 0;
 238 }
 239
 240 PannerInfo*
 241 PannerManager::get_by_uri (std::string uri) const
 242 {
 243         PannerInfo* pi = NULL;
 244         for (list<PannerInfo*>::const_iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 245                 if ((*p)->descriptor.panner_uri != uri) continue;
 246                 pi = (*p);
 247                 break;
 248         }
 249         return pi;
 250 }
 251
 252 PannerUriMap
 253 PannerManager::get_available_panners(uint32_t const a_in, uint32_t const a_out) const
 254 {
 255         int const in = a_in;
 256         int const out = a_out;
 257         PannerUriMap panner_list;
 258
 259         if (out < 2 || in == 0) {
 260                 return panner_list;
 261         }
 262
 263         /* get available panners for current configuration. */
 264         for (list<PannerInfo*>::const_iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 265                  PanPluginDescriptor* d = &(*p)->descriptor;
 266                  if (d->in != -1 && d->in != in) continue;
 267                  if (d->out != -1 && d->out != out) continue;
 268                  if (d->in == -1 && d->out == -1 && out <= 2) continue;
 269                  panner_list.insert(std::pair<std::string,std::string>(d->panner_uri,d->name));
 270         }
 271         return panner_list;
 272 }