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