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/pathscanner.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         PathScanner scanner;
  94         std::vector<std::string *> *panner_modules;
  95         std::string search_path = panner_search_path().to_string();
  96
  97         DEBUG_TRACE (DEBUG::Panning, string_compose (_("looking for panners in %1\n"), search_path));
  98
  99         panner_modules = scanner (search_path, panner_filter, 0, false, true, 1, true);
 100
 101         for (vector<std::string *>::iterator i = panner_modules->begin(); i != panner_modules->end(); ++i) {
 102                 panner_discover (**i);
 103         }
 104
 105         vector_delete (panner_modules);
 106 }
 107
 108 int
 109 PannerManager::panner_discover (string path)
 110 {
 111         PannerInfo* pinfo;
 112
 113         if ((pinfo = get_descriptor (path)) != 0) {
 114
 115                 list<PannerInfo*>::iterator i;
 116
 117                 for (i = panner_info.begin(); i != panner_info.end(); ++i) {
 118                         if (pinfo->descriptor.name == (*i)->descriptor.name) {
 119                                 break;
 120                         }
 121                 }
 122
 123                 if (i == panner_info.end()) {
 124                         panner_info.push_back (pinfo);
 125                         DEBUG_TRACE (DEBUG::Panning, string_compose(_("Panner discovered: \"%1\" in %2\n"), pinfo->descriptor.name, path));
 126                 }
 127         }
 128
 129         return 0;
 130 }
 131
 132 PannerInfo*
 133 PannerManager::get_descriptor (string path)
 134 {
 135         Glib::Module* module = new Glib::Module(path);
 136         PannerInfo* info = 0;
 137         PanPluginDescriptor *descriptor = 0;
 138         PanPluginDescriptor* (*dfunc)(void);
 139         void* func = 0;
 140
 141         if (!module) {
 142                 error << string_compose(_("PannerManager: cannot load module \"%1\" (%2)"), path,
 143                                 Glib::Module::get_last_error()) << endmsg;
 144                 delete module;
 145                 return 0;
 146         }
 147
 148         if (!module->get_symbol("panner_descriptor", func)) {
 149                 error << string_compose(_("PannerManager: module \"%1\" has no descriptor function."), path) << endmsg;
 150                 error << Glib::Module::get_last_error() << endmsg;
 151                 delete module;
 152                 return 0;
 153         }
 154
 155         dfunc = (PanPluginDescriptor* (*)(void))func;
 156         descriptor = dfunc();
 157
 158         if (descriptor) {
 159                 info = new PannerInfo (*descriptor, module);
 160         } else {
 161                 delete module;
 162         }
 163
 164         return info;
 165 }
 166
 167 PannerInfo*
 168 PannerManager::select_panner (ChanCount in, ChanCount out, std::string const uri)
 169 {
 170         PannerInfo* rv = NULL;
 171         PanPluginDescriptor* d;
 172         int32_t nin = in.n_audio();
 173         int32_t nout = out.n_audio();
 174         uint32_t priority = 0;
 175
 176         /* look for user-preference -- check if channels match */
 177         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 178                 d = &(*p)->descriptor;
 179                 if (d->panner_uri != uri) continue;
 180                 if (d->in != nin && d->in != -1) continue;
 181                 if (d->out != nout && d->out != -1) continue;
 182                 return *p;
 183         }
 184
 185         /* look for exact match first */
 186
 187         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 188                 d = &(*p)->descriptor;
 189
 190                 if (d->in == nin && d->out == nout && d->priority > priority) {
 191                         priority = d->priority;
 192                         rv = *p;
 193                 }
 194         }
 195         if (rv) { return rv; }
 196
 197         /* no exact match, look for good fit on inputs and variable on outputs */
 198
 199         priority = 0;
 200         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 201                 d = &(*p)->descriptor;
 202
 203                 if (d->in == nin && d->out == -1 && d->priority > priority) {
 204                         priority = d->priority;
 205                         rv = *p;
 206                 }
 207         }
 208         if (rv) { return rv; }
 209
 210         /* no exact match, look for good fit on outputs and variable on inputs */
 211
 212         priority = 0;
 213         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 214                 d = &(*p)->descriptor;
 215
 216                 if (d->in == -1 && d->out == nout && d->priority > priority) {
 217                         priority = d->priority;
 218                         rv = *p;
 219                 }
 220         }
 221         if (rv) { return rv; }
 222
 223         /* no exact match, look for variable fit on inputs and outputs */
 224
 225         priority = 0;
 226         for (list<PannerInfo*>::iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 227                 d = &(*p)->descriptor;
 228
 229                 if (d->in == -1 && d->out == -1 && d->priority > priority) {
 230                         priority = d->priority;
 231                         rv = *p;
 232                 }
 233         }
 234         if (rv) { return rv; }
 235
 236         warning << string_compose (_("no panner discovered for in/out = %1/%2"), nin, nout) << endmsg;
 237
 238         return 0;
 239 }
 240
 241 PannerInfo*
 242 PannerManager::get_by_uri (std::string uri) const
 243 {
 244         PannerInfo* pi = NULL;
 245         for (list<PannerInfo*>::const_iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 246                 if ((*p)->descriptor.panner_uri != uri) continue;
 247                 pi = (*p);
 248                 break;
 249         }
 250         return pi;
 251 }
 252
 253 PannerUriMap
 254 PannerManager::get_available_panners(uint32_t const a_in, uint32_t const a_out) const
 255 {
 256         int const in = a_in;
 257         int const out = a_out;
 258         PannerUriMap panner_list;
 259
 260         if (out < 2 || in == 0) {
 261                 return panner_list;
 262         }
 263
 264         /* get available panners for current configuration. */
 265         for (list<PannerInfo*>::const_iterator p = panner_info.begin(); p != panner_info.end(); ++p) {
 266                  PanPluginDescriptor* d = &(*p)->descriptor;
 267                  if (d->in != -1 && d->in != in) continue;
 268                  if (d->out != -1 && d->out != out) continue;
 269                  if (d->in == -1 && d->out == -1 && out <= 2) continue;
 270                  panner_list.insert(std::pair<std::string,std::string>(d->panner_uri,d->name));
 271         }
 272         return panner_list;
 273 }