libs/ardour/audio_unit.cc

   1 /*
   2     Copyright (C) 2006-2009 Paul Davis
   3     Some portions Copyright (C) Sophia Poirier.
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <sstream>
  22 #include <fstream>
  23 #include <errno.h>
  24 #include <string.h>
  25 #include <math.h>
  26 #include <ctype.h>
  27
  28 #include "pbd/gstdio_compat.h"
  29 #include "pbd/transmitter.h"
  30 #include "pbd/xml++.h"
  31 #include "pbd/convert.h"
  32 #include "pbd/whitespace.h"
  33 #include "pbd/file_utils.h"
  34 #include "pbd/locale_guard.h"
  35
  36 #include <glibmm/threads.h>
  37 #include <glibmm/fileutils.h>
  38 #include <glibmm/miscutils.h>
  39
  40 #include "ardour/ardour.h"
  41 #include "ardour/audioengine.h"
  42 #include "ardour/audio_buffer.h"
  43 #include "ardour/debug.h"
  44 #include "ardour/midi_buffer.h"
  45 #include "ardour/filesystem_paths.h"
  46 #include "ardour/io.h"
  47 #include "ardour/audio_unit.h"
  48 #include "ardour/route.h"
  49 #include "ardour/session.h"
  50 #include "ardour/tempo.h"
  51 #include "ardour/utils.h"
  52
  53 #include "CAAudioUnit.h"
  54 #include "CAAUParameter.h"
  55
  56 #include <CoreFoundation/CoreFoundation.h>
  57 #include <CoreServices/CoreServices.h>
  58 #include <AudioUnit/AudioUnit.h>
  59 #include <AudioToolbox/AudioUnitUtilities.h>
  60 #ifdef WITH_CARBON
  61 #include <Carbon/Carbon.h>
  62 #endif
  63
  64 #ifdef COREAUDIO105
  65 #define ArdourComponent Component
  66 #define ArdourDescription ComponentDescription
  67 #define ArdourFindNext FindNextComponent
  68 #else
  69 #define ArdourComponent AudioComponent
  70 #define ArdourDescription AudioComponentDescription
  71 #define ArdourFindNext AudioComponentFindNext
  72 #endif
  73
  74 #include "i18n.h"
  75
  76 using namespace std;
  77 using namespace PBD;
  78 using namespace ARDOUR;
  79
  80 AUPluginInfo::CachedInfoMap AUPluginInfo::cached_info;
  81
  82 static string preset_search_path = "/Library/Audio/Presets:/Network/Library/Audio/Presets";
  83 static string preset_suffix = ".aupreset";
  84 static bool preset_search_path_initialized = false;
  85 FILE * AUPluginInfo::_crashlog_fd = NULL;
  86 bool AUPluginInfo::_scan_only = true;
  87
  88
  89 static void au_blacklist (std::string id)
  90 {
  91         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_blacklist.txt");
  92         FILE * blacklist_fd = NULL;
  93         if (! (blacklist_fd = fopen(fn.c_str(), "a"))) {
  94                 PBD::error << "Cannot append to AU blacklist for '"<< id <<"'\n";
  95                 return;
  96         }
  97         assert(id.find("\n") == string::npos);
  98         fprintf(blacklist_fd, "%s\n", id.c_str());
  99         ::fclose(blacklist_fd);
 100 }
 101
 102 static void au_unblacklist (std::string id)
 103 {
 104         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_blacklist.txt");
 105         if (!Glib::file_test (fn, Glib::FILE_TEST_EXISTS)) {
 106                 PBD::warning << "Expected Blacklist file does not exist.\n";
 107                 return;
 108         }
 109
 110         std::string bl;
 111         {
 112                 std::ifstream ifs(fn.c_str());
 113                 bl.assign ((std::istreambuf_iterator<char>(ifs)), (std::istreambuf_iterator<char>()));
 114         }
 115
 116         ::g_unlink (fn.c_str());
 117
 118         assert (!Glib::file_test (fn, Glib::FILE_TEST_EXISTS));
 119         assert(id.find("\n") == string::npos);
 120
 121         id += "\n"; // add separator
 122         const size_t rpl = bl.find(id);
 123         if (rpl != string::npos) {
 124                 bl.replace(rpl, id.size(), "");
 125         }
 126         if (bl.empty()) {
 127                 return;
 128         }
 129
 130         FILE * blacklist_fd = NULL;
 131         if (! (blacklist_fd = fopen(fn.c_str(), "w"))) {
 132                 PBD::error << "Cannot open AU blacklist.\n";
 133                 return;
 134         }
 135         fprintf(blacklist_fd, "%s", bl.c_str());
 136         ::fclose(blacklist_fd);
 137 }
 138
 139 static bool is_blacklisted (std::string id)
 140 {
 141         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_blacklist.txt");
 142         if (!Glib::file_test (fn, Glib::FILE_TEST_EXISTS)) {
 143                 return false;
 144         }
 145         std::string bl;
 146         std::ifstream ifs(fn.c_str());
 147         bl.assign ((std::istreambuf_iterator<char>(ifs)), (std::istreambuf_iterator<char>()));
 148
 149         assert(id.find("\n") == string::npos);
 150
 151         id += "\n"; // add separator
 152         const size_t rpl = bl.find(id);
 153         if (rpl != string::npos) {
 154                 return true;
 155         }
 156         return false;
 157 }
 158
 159
 160
 161 static OSStatus
 162 _render_callback(void *userData,
 163                  AudioUnitRenderActionFlags *ioActionFlags,
 164                  const AudioTimeStamp    *inTimeStamp,
 165                  UInt32       inBusNumber,
 166                  UInt32       inNumberFrames,
 167                  AudioBufferList*       ioData)
 168 {
 169         if (userData) {
 170                 return ((AUPlugin*)userData)->render_callback (ioActionFlags, inTimeStamp, inBusNumber, inNumberFrames, ioData);
 171         }
 172         return paramErr;
 173 }
 174
 175 static OSStatus
 176 _get_beat_and_tempo_callback (void*    userData,
 177                               Float64* outCurrentBeat,
 178                               Float64* outCurrentTempo)
 179 {
 180         if (userData) {
 181                 return ((AUPlugin*)userData)->get_beat_and_tempo_callback (outCurrentBeat, outCurrentTempo);
 182         }
 183
 184         return paramErr;
 185 }
 186
 187 static OSStatus
 188 _get_musical_time_location_callback (void *     userData,
 189                                      UInt32 *   outDeltaSampleOffsetToNextBeat,
 190                                      Float32 *  outTimeSig_Numerator,
 191                                      UInt32 *   outTimeSig_Denominator,
 192                                      Float64 *  outCurrentMeasureDownBeat)
 193 {
 194         if (userData) {
 195                 return ((AUPlugin*)userData)->get_musical_time_location_callback (outDeltaSampleOffsetToNextBeat,
 196                                                                                   outTimeSig_Numerator,
 197                                                                                   outTimeSig_Denominator,
 198                                                                                   outCurrentMeasureDownBeat);
 199         }
 200         return paramErr;
 201 }
 202
 203 static OSStatus
 204 _get_transport_state_callback (void*     userData,
 205                                Boolean*  outIsPlaying,
 206                                Boolean*  outTransportStateChanged,
 207                                Float64*  outCurrentSampleInTimeLine,
 208                                Boolean*  outIsCycling,
 209                                Float64*  outCycleStartBeat,
 210                                Float64*  outCycleEndBeat)
 211 {
 212         if (userData) {
 213                 return ((AUPlugin*)userData)->get_transport_state_callback (
 214                         outIsPlaying, outTransportStateChanged,
 215                         outCurrentSampleInTimeLine, outIsCycling,
 216                         outCycleStartBeat, outCycleEndBeat);
 217         }
 218         return paramErr;
 219 }
 220
 221
 222 static int
 223 save_property_list (CFPropertyListRef propertyList, Glib::ustring path)
 224
 225 {
 226         CFDataRef xmlData;
 227         int fd;
 228
 229         // Convert the property list into XML data.
 230
 231         xmlData = CFPropertyListCreateXMLData( kCFAllocatorDefault, propertyList);
 232
 233         if (!xmlData) {
 234                 error << _("Could not create XML version of property list") << endmsg;
 235                 return -1;
 236         }
 237
 238         // Write the XML data to the file.
 239
 240         fd = open (path.c_str(), O_WRONLY|O_CREAT|O_EXCL, 0664);
 241         while (fd < 0) {
 242                 if (errno == EEXIST) {
 243                         error << string_compose (_("Preset file %1 exists; not overwriting"),
 244                                                  path) << endmsg;
 245                 } else {
 246                         error << string_compose (_("Cannot open preset file %1 (%2)"),
 247                                                  path, strerror (errno)) << endmsg;
 248                 }
 249                 CFRelease (xmlData);
 250                 return -1;
 251         }
 252
 253         size_t cnt = CFDataGetLength (xmlData);
 254
 255         if (write (fd, CFDataGetBytePtr (xmlData), cnt) != (ssize_t) cnt) {
 256                 CFRelease (xmlData);
 257                 close (fd);
 258                 return -1;
 259         }
 260
 261         close (fd);
 262         return 0;
 263 }
 264
 265
 266 static CFPropertyListRef
 267 load_property_list (Glib::ustring path)
 268 {
 269         int fd;
 270         CFPropertyListRef propertyList = 0;
 271         CFDataRef         xmlData;
 272         CFStringRef       errorString;
 273
 274         // Read the XML file.
 275
 276         if ((fd = open (path.c_str(), O_RDONLY)) < 0) {
 277                 return propertyList;
 278
 279         }
 280
 281         off_t len = lseek (fd, 0, SEEK_END);
 282         char* buf = new char[len];
 283         lseek (fd, 0, SEEK_SET);
 284
 285         if (read (fd, buf, len) != len) {
 286                 delete [] buf;
 287                 close (fd);
 288                 return propertyList;
 289         }
 290
 291         close (fd);
 292
 293         xmlData = CFDataCreateWithBytesNoCopy (kCFAllocatorDefault, (UInt8*) buf, len, kCFAllocatorNull);
 294
 295         // Reconstitute the dictionary using the XML data.
 296
 297         propertyList = CFPropertyListCreateFromXMLData( kCFAllocatorDefault,
 298                                                         xmlData,
 299                                                         kCFPropertyListImmutable,
 300                                                         &errorString);
 301
 302         CFRelease (xmlData);
 303         delete [] buf;
 304
 305         return propertyList;
 306 }
 307
 308 //-----------------------------------------------------------------------------
 309 static void
 310 set_preset_name_in_plist (CFPropertyListRef plist, string preset_name)
 311 {
 312         if (!plist) {
 313                 return;
 314         }
 315         CFStringRef pn = CFStringCreateWithCString (kCFAllocatorDefault, preset_name.c_str(), kCFStringEncodingUTF8);
 316
 317         if (CFGetTypeID (plist) == CFDictionaryGetTypeID()) {
 318                 CFDictionarySetValue ((CFMutableDictionaryRef)plist, CFSTR(kAUPresetNameKey), pn);
 319         }
 320
 321         CFRelease (pn);
 322 }
 323
 324 //-----------------------------------------------------------------------------
 325 static std::string
 326 get_preset_name_in_plist (CFPropertyListRef plist)
 327 {
 328         std::string ret;
 329
 330         if (!plist) {
 331                 return ret;
 332         }
 333
 334         if (CFGetTypeID (plist) == CFDictionaryGetTypeID()) {
 335                 const void *p = CFDictionaryGetValue ((CFMutableDictionaryRef)plist, CFSTR(kAUPresetNameKey));
 336                 if (p) {
 337                         CFStringRef str = (CFStringRef) p;
 338                         int len = CFStringGetLength(str);
 339                         len =  (len * 2) + 1;
 340                         char local_buffer[len];
 341                         if (CFStringGetCString (str, local_buffer, len, kCFStringEncodingUTF8)) {
 342                                 ret = local_buffer;
 343                         }
 344                 }
 345         }
 346         return ret;
 347 }
 348
 349 //--------------------------------------------------------------------------
 350 // general implementation for ComponentDescriptionsMatch() and ComponentDescriptionsMatch_Loosely()
 351 // if inIgnoreType is true, then the type code is ignored in the ComponentDescriptions
 352 Boolean ComponentDescriptionsMatch_General(const ArdourDescription * inComponentDescription1, const ArdourDescription * inComponentDescription2, Boolean inIgnoreType);
 353 Boolean ComponentDescriptionsMatch_General(const ArdourDescription * inComponentDescription1, const ArdourDescription * inComponentDescription2, Boolean inIgnoreType)
 354 {
 355         if ( (inComponentDescription1 == NULL) || (inComponentDescription2 == NULL) )
 356                 return FALSE;
 357
 358         if ( (inComponentDescription1->componentSubType == inComponentDescription2->componentSubType)
 359                         && (inComponentDescription1->componentManufacturer == inComponentDescription2->componentManufacturer) )
 360         {
 361                 // only sub-type and manufacturer IDs need to be equal
 362                 if (inIgnoreType)
 363                         return TRUE;
 364                 // type, sub-type, and manufacturer IDs all need to be equal in order to call this a match
 365                 else if (inComponentDescription1->componentType == inComponentDescription2->componentType)
 366                         return TRUE;
 367         }
 368
 369         return FALSE;
 370 }
 371
 372 //--------------------------------------------------------------------------
 373 // general implementation for ComponentAndDescriptionMatch() and ComponentAndDescriptionMatch_Loosely()
 374 // if inIgnoreType is true, then the type code is ignored in the ComponentDescriptions
 375 Boolean ComponentAndDescriptionMatch_General(ArdourComponent inComponent, const ArdourDescription * inComponentDescription, Boolean inIgnoreType);
 376 Boolean ComponentAndDescriptionMatch_General(ArdourComponent inComponent, const ArdourDescription * inComponentDescription, Boolean inIgnoreType)
 377 {
 378         OSErr status;
 379         ArdourDescription desc;
 380
 381         if ( (inComponent == NULL) || (inComponentDescription == NULL) )
 382                 return FALSE;
 383
 384         // get the ComponentDescription of the input Component
 385 #ifdef COREAUDIO105
 386         status = GetComponentInfo(inComponent, &desc, NULL, NULL, NULL);
 387 #else
 388         status = AudioComponentGetDescription (inComponent, &desc);
 389 #endif
 390         if (status != noErr)
 391                 return FALSE;
 392
 393         // check if the Component's ComponentDescription matches the input ComponentDescription
 394         return ComponentDescriptionsMatch_General(&desc, inComponentDescription, inIgnoreType);
 395 }
 396
 397 //--------------------------------------------------------------------------
 398 // determine if 2 ComponentDescriptions are basically equal
 399 // (by that, I mean that the important identifying values are compared,
 400 // but not the ComponentDescription flags)
 401 Boolean ComponentDescriptionsMatch(const ArdourDescription * inComponentDescription1, const ArdourDescription * inComponentDescription2)
 402 {
 403         return ComponentDescriptionsMatch_General(inComponentDescription1, inComponentDescription2, FALSE);
 404 }
 405
 406 //--------------------------------------------------------------------------
 407 // determine if 2 ComponentDescriptions have matching sub-type and manufacturer codes
 408 Boolean ComponentDescriptionsMatch_Loose(const ArdourDescription * inComponentDescription1, const ArdourDescription * inComponentDescription2)
 409 {
 410         return ComponentDescriptionsMatch_General(inComponentDescription1, inComponentDescription2, TRUE);
 411 }
 412
 413 //--------------------------------------------------------------------------
 414 // determine if a ComponentDescription basically matches that of a particular Component
 415 Boolean ComponentAndDescriptionMatch(ArdourComponent inComponent, const ArdourDescription * inComponentDescription)
 416 {
 417         return ComponentAndDescriptionMatch_General(inComponent, inComponentDescription, FALSE);
 418 }
 419
 420 //--------------------------------------------------------------------------
 421 // determine if a ComponentDescription matches only the sub-type and manufacturer codes of a particular Component
 422 Boolean ComponentAndDescriptionMatch_Loosely(ArdourComponent inComponent, const ArdourDescription * inComponentDescription)
 423 {
 424         return ComponentAndDescriptionMatch_General(inComponent, inComponentDescription, TRUE);
 425 }
 426
 427
 428 AUPlugin::AUPlugin (AudioEngine& engine, Session& session, boost::shared_ptr<CAComponent> _comp)
 429         : Plugin (engine, session)
 430         , comp (_comp)
 431         , unit (new CAAudioUnit)
 432         , initialized (false)
 433         , _current_block_size (0)
 434         , _requires_fixed_size_buffers (false)
 435         , buffers (0)
 436         , input_maxbuf (0)
 437         , input_offset (0)
 438         , input_buffers (0)
 439         , input_map (0)
 440         , frames_processed (0)
 441         , audio_input_cnt (0)
 442         , _parameter_listener (0)
 443         , _parameter_listener_arg (0)
 444         , last_transport_rolling (false)
 445         , last_transport_speed (0.0)
 446 {
 447         if (!preset_search_path_initialized) {
 448                 Glib::ustring p = Glib::get_home_dir();
 449                 p += "/Library/Audio/Presets:";
 450                 p += preset_search_path;
 451                 preset_search_path = p;
 452                 preset_search_path_initialized = true;
 453                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Preset Path: %1\n", preset_search_path));
 454         }
 455
 456         init ();
 457 }
 458
 459
 460 AUPlugin::AUPlugin (const AUPlugin& other)
 461         : Plugin (other)
 462         , comp (other.get_comp())
 463         , unit (new CAAudioUnit)
 464         , initialized (false)
 465         , _current_block_size (0)
 466         , _last_nframes (0)
 467         , _requires_fixed_size_buffers (false)
 468         , buffers (0)
 469         , input_maxbuf (0)
 470         , input_offset (0)
 471         , input_buffers (0)
 472         , input_map (0)
 473         , frames_processed (0)
 474         , _parameter_listener (0)
 475         , _parameter_listener_arg (0)
 476
 477 {
 478         init ();
 479         for (size_t i = 0; i < descriptors.size(); ++i) {
 480                 set_parameter (i, other.get_parameter (i));
 481         }
 482 }
 483
 484 AUPlugin::~AUPlugin ()
 485 {
 486         if (_parameter_listener) {
 487                 AUListenerDispose (_parameter_listener);
 488                 _parameter_listener = 0;
 489         }
 490
 491         if (unit) {
 492                 DEBUG_TRACE (DEBUG::AudioUnits, "about to call uninitialize in plugin destructor\n");
 493                 unit->Uninitialize ();
 494         }
 495
 496         if (buffers) {
 497                 free (buffers);
 498         }
 499 }
 500
 501 void
 502 AUPlugin::discover_factory_presets ()
 503 {
 504         CFArrayRef presets;
 505         UInt32 dataSize;
 506         Boolean isWritable;
 507         OSStatus err;
 508
 509         if ((err = unit->GetPropertyInfo (kAudioUnitProperty_FactoryPresets, kAudioUnitScope_Global, 0, &dataSize, &isWritable)) != 0) {
 510                 DEBUG_TRACE (DEBUG::AudioUnits, "no factory presets for AU\n");
 511                 return;
 512         }
 513
 514         assert (dataSize == sizeof (presets));
 515
 516         if ((err = unit->GetProperty (kAudioUnitProperty_FactoryPresets, kAudioUnitScope_Global, 0, (void*) &presets, &dataSize)) != 0) {
 517                 error << string_compose (_("cannot get factory preset info: errcode %1"), err) << endmsg;
 518                 return;
 519         }
 520
 521         if (!presets) {
 522                 return;
 523         }
 524
 525         CFIndex cnt = CFArrayGetCount (presets);
 526
 527         for (CFIndex i = 0; i < cnt; ++i) {
 528                 AUPreset* preset = (AUPreset*) CFArrayGetValueAtIndex (presets, i);
 529
 530                 string name = CFStringRefToStdString (preset->presetName);
 531                 factory_preset_map[name] = preset->presetNumber;
 532                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Factory Preset: %1 > %2\n", name, preset->presetNumber));
 533         }
 534
 535         CFRelease (presets);
 536 }
 537
 538 void
 539 AUPlugin::init ()
 540 {
 541         OSErr err;
 542         CFStringRef itemName;
 543
 544         /* these keep track of *configured* channel set up,
 545            not potential set ups.
 546         */
 547
 548         input_channels = -1;
 549         output_channels = -1;
 550         {
 551                 CAComponentDescription temp;
 552 #ifdef COREAUDIO105
 553                 GetComponentInfo (comp.get()->Comp(), &temp, NULL, NULL, NULL);
 554 #else
 555                 AudioComponentGetDescription (comp.get()->Comp(), &temp);
 556 #endif
 557                 CFStringRef compTypeString = UTCreateStringForOSType(temp.componentType);
 558                 CFStringRef compSubTypeString = UTCreateStringForOSType(temp.componentSubType);
 559                 CFStringRef compManufacturerString = UTCreateStringForOSType(temp.componentManufacturer);
 560                 itemName = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR("%@ - %@ - %@"),
 561                                 compTypeString, compManufacturerString, compSubTypeString);
 562                 if (compTypeString != NULL) CFRelease(compTypeString);
 563                 if (compSubTypeString != NULL) CFRelease(compSubTypeString);
 564                 if (compManufacturerString != NULL) CFRelease(compManufacturerString);
 565         }
 566
 567         au_blacklist(CFStringRefToStdString(itemName));
 568
 569         try {
 570                 DEBUG_TRACE (DEBUG::AudioUnits, "opening AudioUnit\n");
 571                 err = CAAudioUnit::Open (*(comp.get()), *unit);
 572         } catch (...) {
 573                 error << _("Exception thrown during AudioUnit plugin loading - plugin ignored") << endmsg;
 574                 throw failed_constructor();
 575         }
 576
 577         if (err != noErr) {
 578                 error << _("AudioUnit: Could not convert CAComponent to CAAudioUnit") << endmsg;
 579                 throw failed_constructor ();
 580         }
 581
 582         DEBUG_TRACE (DEBUG::AudioUnits, "count global elements\n");
 583         unit->GetElementCount (kAudioUnitScope_Global, global_elements);
 584         DEBUG_TRACE (DEBUG::AudioUnits, "count input elements\n");
 585         unit->GetElementCount (kAudioUnitScope_Input, input_elements);
 586         DEBUG_TRACE (DEBUG::AudioUnits, "count output elements\n");
 587         unit->GetElementCount (kAudioUnitScope_Output, output_elements);
 588
 589         if (input_elements > 0) {
 590                 /* setup render callback: the plugin calls this to get input data
 591                  */
 592
 593                 AURenderCallbackStruct renderCallbackInfo;
 594
 595                 renderCallbackInfo.inputProc = _render_callback;
 596                 renderCallbackInfo.inputProcRefCon = this;
 597
 598                 DEBUG_TRACE (DEBUG::AudioUnits, "set render callback in input scope\n");
 599                 if ((err = unit->SetProperty (kAudioUnitProperty_SetRenderCallback, kAudioUnitScope_Input,
 600                                               0, (void*) &renderCallbackInfo, sizeof(renderCallbackInfo))) != 0) {
 601                         error << string_compose (_("cannot install render callback (err = %1)"), err) << endmsg;
 602                         throw failed_constructor();
 603                 }
 604         }
 605
 606         /* tell the plugin about tempo/meter/transport callbacks in case it wants them */
 607
 608         HostCallbackInfo info;
 609         memset (&info, 0, sizeof (HostCallbackInfo));
 610         info.hostUserData = this;
 611         info.beatAndTempoProc = _get_beat_and_tempo_callback;
 612         info.musicalTimeLocationProc = _get_musical_time_location_callback;
 613         info.transportStateProc = _get_transport_state_callback;
 614
 615         //ignore result of this - don't care if the property isn't supported
 616         DEBUG_TRACE (DEBUG::AudioUnits, "set host callbacks in global scope\n");
 617         unit->SetProperty (kAudioUnitProperty_HostCallbacks,
 618                            kAudioUnitScope_Global,
 619                            0, //elementID
 620                            &info,
 621                            sizeof (HostCallbackInfo));
 622
 623         if (set_block_size (_session.get_block_size())) {
 624                 error << _("AUPlugin: cannot set processing block size") << endmsg;
 625                 throw failed_constructor();
 626         }
 627
 628         create_parameter_listener (AUPlugin::_parameter_change_listener, this, 0.05);
 629         discover_parameters ();
 630         discover_factory_presets ();
 631
 632         // Plugin::setup_controls ();
 633
 634         au_unblacklist(CFStringRefToStdString(itemName));
 635         if (itemName != NULL) CFRelease(itemName);
 636 }
 637
 638 void
 639 AUPlugin::discover_parameters ()
 640 {
 641         /* discover writable parameters */
 642
 643         AudioUnitScope scopes[] = {
 644                 kAudioUnitScope_Global,
 645                 kAudioUnitScope_Output,
 646                 kAudioUnitScope_Input
 647         };
 648
 649         descriptors.clear ();
 650
 651         for (uint32_t i = 0; i < sizeof (scopes) / sizeof (scopes[0]); ++i) {
 652
 653                 AUParamInfo param_info (unit->AU(), false, /* include read only */ true, scopes[i]);
 654
 655                 for (uint32_t i = 0; i < param_info.NumParams(); ++i) {
 656
 657                         AUParameterDescriptor d;
 658
 659                         d.id = param_info.ParamID (i);
 660
 661                         const CAAUParameter* param = param_info.GetParamInfo (d.id);
 662                         const AudioUnitParameterInfo& info (param->ParamInfo());
 663
 664                         const int len = CFStringGetLength (param->GetName());
 665                         char local_buffer[len*2];
 666                         Boolean good = CFStringGetCString (param->GetName(), local_buffer ,len*2 , kCFStringEncodingUTF8);
 667                         if (!good) {
 668                                 d.label = "???";
 669                         } else {
 670                                 d.label = local_buffer;
 671                         }
 672
 673                         d.scope = param_info.GetScope ();
 674                         d.element = param_info.GetElement ();
 675
 676                         /* info.units to consider */
 677                         /*
 678                           kAudioUnitParameterUnit_Generic             = 0
 679                           kAudioUnitParameterUnit_Indexed             = 1
 680                           kAudioUnitParameterUnit_Boolean             = 2
 681                           kAudioUnitParameterUnit_Percent             = 3
 682                           kAudioUnitParameterUnit_Seconds             = 4
 683                           kAudioUnitParameterUnit_SampleFrames        = 5
 684                           kAudioUnitParameterUnit_Phase               = 6
 685                           kAudioUnitParameterUnit_Rate                = 7
 686                           kAudioUnitParameterUnit_Hertz               = 8
 687                           kAudioUnitParameterUnit_Cents               = 9
 688                           kAudioUnitParameterUnit_RelativeSemiTones   = 10
 689                           kAudioUnitParameterUnit_MIDINoteNumber      = 11
 690                           kAudioUnitParameterUnit_MIDIController      = 12
 691                           kAudioUnitParameterUnit_Decibels            = 13
 692                           kAudioUnitParameterUnit_LinearGain          = 14
 693                           kAudioUnitParameterUnit_Degrees             = 15
 694                           kAudioUnitParameterUnit_EqualPowerCrossfade = 16
 695                           kAudioUnitParameterUnit_MixerFaderCurve1    = 17
 696                           kAudioUnitParameterUnit_Pan                 = 18
 697                           kAudioUnitParameterUnit_Meters              = 19
 698                           kAudioUnitParameterUnit_AbsoluteCents       = 20
 699                           kAudioUnitParameterUnit_Octaves             = 21
 700                           kAudioUnitParameterUnit_BPM                 = 22
 701                           kAudioUnitParameterUnit_Beats               = 23
 702                           kAudioUnitParameterUnit_Milliseconds        = 24
 703                           kAudioUnitParameterUnit_Ratio               = 25
 704                         */
 705
 706                         /* info.flags to consider */
 707
 708                         /*
 709
 710                           kAudioUnitParameterFlag_CFNameRelease       = (1L << 4)
 711                           kAudioUnitParameterFlag_HasClump            = (1L << 20)
 712                           kAudioUnitParameterFlag_HasName             = (1L << 21)
 713                           kAudioUnitParameterFlag_DisplayLogarithmic  = (1L << 22)
 714                           kAudioUnitParameterFlag_IsHighResolution    = (1L << 23)
 715                           kAudioUnitParameterFlag_NonRealTime         = (1L << 24)
 716                           kAudioUnitParameterFlag_CanRamp             = (1L << 25)
 717                           kAudioUnitParameterFlag_ExpertMode          = (1L << 26)
 718                           kAudioUnitParameterFlag_HasCFNameString     = (1L << 27)
 719                           kAudioUnitParameterFlag_IsGlobalMeta        = (1L << 28)
 720                           kAudioUnitParameterFlag_IsElementMeta       = (1L << 29)
 721                           kAudioUnitParameterFlag_IsReadable          = (1L << 30)
 722                           kAudioUnitParameterFlag_IsWritable          = (1L << 31)
 723                         */
 724
 725                         d.lower = info.minValue;
 726                         d.upper = info.maxValue;
 727                         d.normal = info.defaultValue;
 728
 729                         d.integer_step = (info.unit == kAudioUnitParameterUnit_Indexed);
 730                         d.toggled = (info.unit == kAudioUnitParameterUnit_Boolean) ||
 731                                 (d.integer_step && ((d.upper - d.lower) == 1.0));
 732                         d.sr_dependent = (info.unit == kAudioUnitParameterUnit_SampleFrames);
 733                         d.automatable = /* !d.toggled && -- ardour can automate toggles, can AU ? */
 734                                 !(info.flags & kAudioUnitParameterFlag_NonRealTime) &&
 735                                 (info.flags & kAudioUnitParameterFlag_IsWritable);
 736
 737                         d.logarithmic = (info.flags & kAudioUnitParameterFlag_DisplayLogarithmic);
 738                         d.au_unit = info.unit;
 739                         switch (info.unit) {
 740                         case kAudioUnitParameterUnit_Decibels:
 741                                 d.unit = ParameterDescriptor::DB;
 742                                 break;
 743                         case kAudioUnitParameterUnit_MIDINoteNumber:
 744                                 d.unit = ParameterDescriptor::MIDI_NOTE;
 745                                 break;
 746                         case kAudioUnitParameterUnit_Hertz:
 747                                 d.unit = ParameterDescriptor::HZ;
 748                                 break;
 749                         }
 750
 751                         d.min_unbound = 0; // lower is bound
 752                         d.max_unbound = 0; // upper is bound
 753                         d.update_steps();
 754
 755                         descriptors.push_back (d);
 756
 757                         uint32_t last_param = descriptors.size() - 1;
 758                         parameter_map.insert (pair<uint32_t,uint32_t> (d.id, last_param));
 759                         listen_to_parameter (last_param);
 760                 }
 761         }
 762 }
 763
 764
 765 static unsigned int
 766 four_ints_to_four_byte_literal (unsigned char n[4])
 767 {
 768         /* this is actually implementation dependent. sigh. this is what gcc
 769            and quite a few others do.
 770          */
 771         return ((n[0] << 24) + (n[1] << 16) + (n[2] << 8) + n[3]);
 772 }
 773
 774 std::string
 775 AUPlugin::maybe_fix_broken_au_id (const std::string& id)
 776 {
 777         if (isdigit (id[0])) {
 778                 return id;
 779         }
 780
 781         /* ID format is xxxx-xxxx-xxxx
 782            where x maybe \xNN or a printable character.
 783
 784            Split at the '-' and and process each part into an integer.
 785            Then put it back together.
 786         */
 787
 788
 789         unsigned char nascent[4];
 790         const char* cstr = id.c_str();
 791         const char* estr = cstr + id.size();
 792         uint32_t n[3];
 793         int in;
 794         int next_int;
 795         char short_buf[3];
 796         stringstream s;
 797
 798         in = 0;
 799         next_int = 0;
 800         short_buf[2] = '\0';
 801
 802         while (*cstr && next_int < 4) {
 803
 804                 if (*cstr == '\\') {
 805
 806                         if (estr - cstr < 3) {
 807
 808                                 /* too close to the end for \xNN parsing: treat as literal characters */
 809
 810                                 nascent[in] = *cstr;
 811                                 ++cstr;
 812                                 ++in;
 813
 814                         } else {
 815
 816                                 if (cstr[1] == 'x' && isxdigit (cstr[2]) && isxdigit (cstr[3])) {
 817
 818                                         /* parse \xNN */
 819
 820                                         memcpy (short_buf, &cstr[2], 2);
 821                                         nascent[in] = strtol (short_buf, NULL, 16);
 822                                         cstr += 4;
 823                                         ++in;
 824
 825                                 } else {
 826
 827                                         /* treat as literal characters */
 828                                         nascent[in] = *cstr;
 829                                         ++cstr;
 830                                         ++in;
 831                                 }
 832                         }
 833
 834                 } else {
 835
 836                         nascent[in] = *cstr;
 837                         ++cstr;
 838                         ++in;
 839                 }
 840
 841                 if (in && (in % 4 == 0)) {
 842                         /* nascent is ready */
 843                         n[next_int] = four_ints_to_four_byte_literal (nascent);
 844                         in = 0;
 845                         next_int++;
 846
 847                         /* swallow space-hyphen-space */
 848
 849                         if (next_int < 3) {
 850                                 ++cstr;
 851                                 ++cstr;
 852                                 ++cstr;
 853                         }
 854                 }
 855         }
 856
 857         if (next_int != 3) {
 858                 goto err;
 859         }
 860
 861         s << n[0] << '-' << n[1] << '-' << n[2];
 862
 863         return s.str();
 864
 865 err:
 866         return string();
 867 }
 868
 869 string
 870 AUPlugin::unique_id () const
 871 {
 872         return AUPluginInfo::stringify_descriptor (comp->Desc());
 873 }
 874
 875 const char *
 876 AUPlugin::label () const
 877 {
 878         return _info->name.c_str();
 879 }
 880
 881 uint32_t
 882 AUPlugin::parameter_count () const
 883 {
 884         return descriptors.size();
 885 }
 886
 887 float
 888 AUPlugin::default_value (uint32_t port)
 889 {
 890         if (port < descriptors.size()) {
 891                 return descriptors[port].normal;
 892         }
 893
 894         return 0;
 895 }
 896
 897 framecnt_t
 898 AUPlugin::signal_latency () const
 899 {
 900         return unit->Latency() * _session.frame_rate();
 901 }
 902
 903 void
 904 AUPlugin::set_parameter (uint32_t which, float val)
 905 {
 906         if (which >= descriptors.size()) {
 907                 return;
 908         }
 909
 910         if (get_parameter(which) == val) {
 911                 return;
 912         }
 913
 914         const AUParameterDescriptor& d (descriptors[which]);
 915         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("set parameter %1 in scope %2 element %3 to %4\n", d.id, d.scope, d.element, val));
 916         unit->SetParameter (d.id, d.scope, d.element, val);
 917
 918         /* tell the world what we did */
 919
 920         AudioUnitEvent theEvent;
 921
 922         theEvent.mEventType = kAudioUnitEvent_ParameterValueChange;
 923         theEvent.mArgument.mParameter.mAudioUnit = unit->AU();
 924         theEvent.mArgument.mParameter.mParameterID = d.id;
 925         theEvent.mArgument.mParameter.mScope = d.scope;
 926         theEvent.mArgument.mParameter.mElement = d.element;
 927
 928         DEBUG_TRACE (DEBUG::AudioUnits, "notify about parameter change\n");
 929         /* Note the 1st argument, which means "Don't notify us about a change we made ourselves" */
 930         AUEventListenerNotify (_parameter_listener, NULL, &theEvent);
 931
 932         Plugin::set_parameter (which, val);
 933 }
 934
 935 float
 936 AUPlugin::get_parameter (uint32_t which) const
 937 {
 938         float val = 0.0;
 939         if (which < descriptors.size()) {
 940                 const AUParameterDescriptor& d (descriptors[which]);
 941                 // DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("get value of parameter %1 in scope %2 element %3\n", d.id, d.scope, d.element));
 942                 unit->GetParameter(d.id, d.scope, d.element, val);
 943         }
 944         return val;
 945 }
 946
 947 int
 948 AUPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& pd) const
 949 {
 950         if (which < descriptors.size()) {
 951                 pd = descriptors[which];
 952                 return 0;
 953         }
 954         return -1;
 955 }
 956
 957 uint32_t
 958 AUPlugin::nth_parameter (uint32_t which, bool& ok) const
 959 {
 960         if (which < descriptors.size()) {
 961                 ok = true;
 962                 return which;
 963         }
 964         ok = false;
 965         return 0;
 966 }
 967
 968 void
 969 AUPlugin::activate ()
 970 {
 971         if (!initialized) {
 972                 OSErr err;
 973                 DEBUG_TRACE (DEBUG::AudioUnits, "call Initialize in activate()\n");
 974                 if ((err = unit->Initialize()) != noErr) {
 975                         error << string_compose (_("AUPlugin: %1 cannot initialize plugin (err = %2)"), name(), err) << endmsg;
 976                 } else {
 977                         frames_processed = 0;
 978                         initialized = true;
 979                 }
 980         }
 981 }
 982
 983 void
 984 AUPlugin::deactivate ()
 985 {
 986         DEBUG_TRACE (DEBUG::AudioUnits, "call Uninitialize in deactivate()\n");
 987         unit->Uninitialize ();
 988         initialized = false;
 989 }
 990
 991 void
 992 AUPlugin::flush ()
 993 {
 994         DEBUG_TRACE (DEBUG::AudioUnits, "call Reset in flush()\n");
 995         unit->GlobalReset ();
 996 }
 997
 998 bool
 999 AUPlugin::requires_fixed_size_buffers() const
1000 {
1001         return _requires_fixed_size_buffers;
1002 }
1003
1004
1005 int
1006 AUPlugin::set_block_size (pframes_t nframes)
1007 {
1008         bool was_initialized = initialized;
1009         UInt32 numFrames = nframes;
1010         OSErr err;
1011
1012         if (initialized) {
1013                 deactivate ();
1014         }
1015
1016         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("set MaximumFramesPerSlice in global scope to %1\n", numFrames));
1017         if ((err = unit->SetProperty (kAudioUnitProperty_MaximumFramesPerSlice, kAudioUnitScope_Global,
1018                                       0, &numFrames, sizeof (numFrames))) != noErr) {
1019                 error << string_compose (_("AU: cannot set max frames (err = %1)"), err) << endmsg;
1020                 return -1;
1021         }
1022
1023         if (was_initialized) {
1024                 activate ();
1025         }
1026
1027         _current_block_size = nframes;
1028
1029         return 0;
1030 }
1031
1032 bool
1033 AUPlugin::configure_io (ChanCount in, ChanCount out)
1034 {
1035         AudioStreamBasicDescription streamFormat;
1036         bool was_initialized = initialized;
1037         int32_t audio_out = out.n_audio();
1038         if (audio_input_cnt > 0) {
1039                 in.set (DataType::AUDIO, audio_input_cnt);
1040         }
1041         int32_t audio_in = in.n_audio();
1042
1043         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("configure %1 for %2 in %3 out\n", name(), in, out));
1044
1045         if (initialized) {
1046                 //if we are already running with the requested i/o config, bail out here
1047                 if ( (audio_in==input_channels) && (audio_out==output_channels) ) {
1048                         return true;
1049                 } else {
1050                         deactivate ();
1051                 }
1052         }
1053
1054         streamFormat.mSampleRate = _session.frame_rate();
1055         streamFormat.mFormatID = kAudioFormatLinearPCM;
1056         streamFormat.mFormatFlags = kAudioFormatFlagIsFloat|kAudioFormatFlagIsPacked|kAudioFormatFlagIsNonInterleaved;
1057
1058 #ifdef __LITTLE_ENDIAN__
1059         /* relax */
1060 #else
1061         streamFormat.mFormatFlags |= kAudioFormatFlagIsBigEndian;
1062 #endif
1063
1064         streamFormat.mBitsPerChannel = 32;
1065         streamFormat.mFramesPerPacket = 1;
1066
1067         /* apple says that for non-interleaved data, these
1068            values always refer to a single channel.
1069         */
1070         streamFormat.mBytesPerPacket = 4;
1071         streamFormat.mBytesPerFrame = 4;
1072
1073         streamFormat.mChannelsPerFrame = audio_in;
1074
1075         if (set_input_format (streamFormat) != 0) {
1076                 return false;
1077         }
1078
1079         streamFormat.mChannelsPerFrame = audio_out;
1080
1081         if (set_output_format (streamFormat) != 0) {
1082                 return false;
1083         }
1084
1085         /* reset plugin info to show currently configured state */
1086
1087         _info->n_inputs = in;
1088         _info->n_outputs = out;
1089
1090         if (was_initialized) {
1091                 activate ();
1092         }
1093
1094         return true;
1095 }
1096
1097 ChanCount
1098 AUPlugin::input_streams() const
1099 {
1100         ChanCount c;
1101
1102
1103         if (input_channels < 0) {
1104                 // force PluginIoReConfigure -- see also commit msg e38eb06
1105                 c.set (DataType::AUDIO, 0);
1106                 c.set (DataType::MIDI, 0);
1107         } else {
1108                 c.set (DataType::AUDIO, input_channels);
1109                 c.set (DataType::MIDI, _has_midi_input ? 1 : 0);
1110         }
1111
1112         return c;
1113 }
1114
1115
1116 ChanCount
1117 AUPlugin::output_streams() const
1118 {
1119         ChanCount c;
1120
1121         if (output_channels < 0) {
1122                 // force PluginIoReConfigure - see also commit msg e38eb06
1123                 c.set (DataType::AUDIO, 0);
1124                 c.set (DataType::MIDI, 0);
1125         } else {
1126                 c.set (DataType::AUDIO, output_channels);
1127                 c.set (DataType::MIDI, _has_midi_output ? 1 : 0);
1128         }
1129
1130         return c;
1131 }
1132
1133 bool
1134 AUPlugin::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
1135 {
1136         // Note: We never attempt to multiply-instantiate plugins to meet io configurations.
1137
1138         const int32_t audio_in = in.n_audio();
1139         int32_t audio_out;
1140         AUPluginInfoPtr pinfo = boost::dynamic_pointer_cast<AUPluginInfo>(get_info());
1141
1142         /* lets check MIDI first */
1143
1144         if (in.n_midi() > 0 && !_has_midi_input && !imprecise) {
1145                 return false;
1146         }
1147
1148         vector<pair<int,int> >& io_configs = pinfo->cache.io_configs;
1149
1150         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1 has %2 IO configurations, looking for %3 in, %4 out\n",
1151                                                         name(), io_configs.size(), in, out));
1152
1153         // preferred setting (provided by plugin_insert)
1154         audio_out = out.n_audio ();
1155
1156         /* kAudioUnitProperty_SupportedNumChannels
1157          * https://developer.apple.com/library/mac/documentation/MusicAudio/Conceptual/AudioUnitProgrammingGuide/TheAudioUnit/TheAudioUnit.html#//apple_ref/doc/uid/TP40003278-CH12-SW20
1158          *
1159          * - both fields are -1
1160          *   e.g. inChannels = -1 outChannels = -1
1161          *    This is the default case. Any number of input and output channels, as long as the numbers match
1162          *
1163          * - one field is -1, the other field is positive
1164          *   e.g. inChannels = -1 outChannels = 2
1165          *    Any number of input channels, exactly two output channels
1166          *
1167          * - one field is -1, the other field is -2
1168          *   e.g. inChannels = -1 outChannels = -2
1169          *    Any number of input channels, any number of output channels
1170          *
1171          * - both fields have non-negative values
1172          *   e.g. inChannels = 2 outChannels = 6
1173          *    Exactly two input channels, exactly six output channels
1174          *   e.g. inChannels = 0 outChannels = 2
1175          *    No input channels, exactly two output channels (such as for an instrument unit with stereo output)
1176          *
1177          * - both fields have negative values, neither of which is –1 or –2
1178          *   e.g. inChannels = -4 outChannels = -8
1179          *    Up to four input channels and up to eight output channels
1180          */
1181
1182         for (vector<pair<int,int> >::iterator i = io_configs.begin(); i != io_configs.end(); ++i) {
1183
1184                 int32_t possible_in = i->first;
1185                 int32_t possible_out = i->second;
1186
1187                 if ((possible_in == audio_in) && (possible_out == audio_out)) {
1188                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tCHOSEN: %1 in %2 out to match in %3 out %4\n",
1189                                                                         possible_in, possible_out,
1190                                                                         in, out));
1191
1192                         out.set (DataType::MIDI, 0);
1193                         out.set (DataType::AUDIO, audio_out);
1194
1195                         return true;
1196                 }
1197         }
1198
1199         /* now allow potentially "imprecise" matches */
1200         audio_out = -1;
1201         bool found = false;
1202
1203         float penalty = 9999;
1204         const int preferred_out = out.n_audio ();
1205         int used_possible_in = 0;
1206
1207 #define FOUNDCFG(nch) {                                  \
1208         float p = fabsf ((float)(nch) - preferred_out);  \
1209         if ((nch) > preferred_out) { p *= 1.1; }         \
1210         if (p < penalty) {                               \
1211                 used_possible_in = possible_in;          \
1212                 audio_out = (nch);                       \
1213                 penalty = p;                             \
1214                 found = true;                            \
1215         }                                                \
1216 }
1217
1218         for (vector<pair<int,int> >::iterator i = io_configs.begin(); i != io_configs.end(); ++i) {
1219
1220                 int32_t possible_in = i->first;
1221                 int32_t possible_out = i->second;
1222
1223                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tpossible in %1 possible out %2\n", possible_in, possible_out));
1224
1225                 if (possible_out == 0) {
1226                         warning << string_compose (_("AU %1 has zero outputs - configuration ignored"), name()) << endmsg;
1227                         /* XXX surely this is just a send? (e.g. AUNetSend) */
1228                         continue;
1229                 }
1230
1231                 if (possible_in == 0) {
1232                         /* no inputs, generators & instruments */
1233                         if (possible_out == -1) {
1234                                 /* any configuration possible, provide stereo output */
1235                                 FOUNDCFG (preferred_out);
1236                         } else if (possible_out == -2) {
1237                                 /* invalid, should be (0, -1) */
1238                                 FOUNDCFG (preferred_out);
1239                         } else if (possible_out < -2) {
1240                                 /* variable number of outputs up to -N, */
1241                                 FOUNDCFG (min (-possible_out, preferred_out));
1242                         } else {
1243                                 /* exact number of outputs */
1244                                 FOUNDCFG (possible_out);
1245                         }
1246                 }
1247
1248                 if (possible_in == -1) {
1249                         /* wildcard for input */
1250                         if (possible_out == -1) {
1251                                 /* out must match in */
1252                                 FOUNDCFG (audio_in);
1253                         } else if (possible_out == -2) {
1254                                 /* any configuration possible, pick matching */
1255                                 FOUNDCFG (preferred_out);
1256                         } else if (possible_out < -2) {
1257                                 /* explicitly variable number of outputs, pick maximum */
1258                                 FOUNDCFG (max (-possible_out, preferred_out));
1259                                 /* and try min, too, in case the penalty is lower */
1260                                 FOUNDCFG (min (-possible_out, preferred_out));
1261                         } else {
1262                                 /* exact number of outputs */
1263                                 FOUNDCFG (possible_out);
1264                         }
1265                 }
1266
1267                 if (possible_in == -2) {
1268                         if (possible_out == -1) {
1269                                 /* any configuration possible, pick matching */
1270                                 FOUNDCFG (preferred_out);
1271                         } else if (possible_out == -2) {
1272                                 /* invalid. interpret as (-1, -1) */
1273                                 FOUNDCFG (preferred_out);
1274                         } else if (possible_out < -2) {
1275                                 /* invalid,  interpret as (<-2, <-2)
1276                                  * variable number of outputs up to -N, */
1277                                 FOUNDCFG (min (-possible_out, preferred_out));
1278                         } else {
1279                                 /* exact number of outputs */
1280                                 FOUNDCFG (possible_out);
1281                         }
1282                 }
1283
1284                 if (possible_in < -2) {
1285                         /* explicit variable number of inputs */
1286                         if (audio_in > -possible_in && imprecise != NULL) {
1287                                 // hide inputs ports
1288                                 imprecise->set (DataType::AUDIO, -possible_in);
1289                         }
1290
1291                         if (audio_in > -possible_in && imprecise == NULL) {
1292                                 /* request is too large */
1293                         } else if (possible_out == -1) {
1294                                 /* any output configuration possible, provide stereo out */
1295                                 FOUNDCFG (preferred_out);
1296                         } else if (possible_out == -2) {
1297                                 /* invalid. interpret as (<-2, -1) */
1298                                 FOUNDCFG (preferred_out);
1299                         } else if (possible_out < -2) {
1300                                 /* variable number of outputs up to -N, */
1301                                 FOUNDCFG (min (-possible_out, preferred_out));
1302                         } else {
1303                                 /* exact number of outputs */
1304                                 FOUNDCFG (possible_out);
1305                         }
1306                 }
1307
1308                 if (possible_in && (possible_in == audio_in)) {
1309                         /* exact number of inputs ... must match obviously */
1310                         if (possible_out == -1) {
1311                                 /* any output configuration possible */
1312                                 FOUNDCFG (preferred_out);
1313                         } else if (possible_out == -2) {
1314                                 /* plugins shouldn't really use (>0,-2) but might.
1315                                  * interpret as (>0,-1):
1316                                  */
1317                                 FOUNDCFG (preferred_out);
1318                         } else if (possible_out < -2) {
1319                                 /* > 0, < -2 is not specified
1320                                  * interpret as up to -N */
1321                                 FOUNDCFG (min (-possible_out, preferred_out));
1322                         } else {
1323                                 /* exact number of outputs */
1324                                 FOUNDCFG (possible_out);
1325                         }
1326                 }
1327         }
1328
1329         if (!found && imprecise) {
1330                 /* try harder */
1331                 for (vector<pair<int,int> >::iterator i = io_configs.begin(); i != io_configs.end(); ++i) {
1332                         int32_t possible_in = i->first;
1333                         int32_t possible_out = i->second;
1334
1335                         assert (possible_in > 0); // all other cases will have been matched above
1336                         assert (possible_out !=0 || possible_in !=0); // already handled above
1337
1338                         imprecise->set (DataType::AUDIO, possible_in);
1339                         if (possible_out == -1 || possible_out == -2) {
1340                                 FOUNDCFG (2);
1341                         } else if (possible_out < -2) {
1342                                 /* explicitly variable number of outputs, pick maximum */
1343                                 FOUNDCFG (min (-possible_out, preferred_out));
1344                         } else {
1345                                 /* exact number of outputs */
1346                                 FOUNDCFG (possible_out);
1347                         }
1348                         // ideally we'll also find the closest, best matching
1349                         // input configuration with minimal output penalty...
1350                 }
1351         }
1352
1353         if (found) {
1354                 if (used_possible_in < -2 && audio_in == 0) {
1355                         // input-port count cannot be zero, use as many ports
1356                         // as outputs, but at most abs(possible_in)
1357                         audio_input_cnt = max (1, min (audio_out, -used_possible_in));
1358                 }
1359
1360                 out.set (DataType::MIDI, 0); /// XXX
1361                 out.set (DataType::AUDIO, audio_out);
1362                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tCHOSEN: in %1 out %2\n", in, out));
1363         } else {
1364                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tFAIL: no io configs match %1\n", in));
1365                 return false;
1366         }
1367
1368         return true;
1369 }
1370
1371 int
1372 AUPlugin::set_input_format (AudioStreamBasicDescription& fmt)
1373 {
1374         return set_stream_format (kAudioUnitScope_Input, input_elements, fmt);
1375 }
1376
1377 int
1378 AUPlugin::set_output_format (AudioStreamBasicDescription& fmt)
1379 {
1380         if (set_stream_format (kAudioUnitScope_Output, output_elements, fmt) != 0) {
1381                 return -1;
1382         }
1383
1384         if (buffers) {
1385                 free (buffers);
1386                 buffers = 0;
1387         }
1388
1389         buffers = (AudioBufferList *) malloc (offsetof(AudioBufferList, mBuffers) +
1390                                               fmt.mChannelsPerFrame * sizeof(::AudioBuffer));
1391
1392         return 0;
1393 }
1394
1395 int
1396 AUPlugin::set_stream_format (int scope, uint32_t cnt, AudioStreamBasicDescription& fmt)
1397 {
1398         OSErr result;
1399
1400         for (uint32_t i = 0; i < cnt; ++i) {
1401                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("set stream format for %1, scope = %2 element %3\n",
1402                                                                 (scope == kAudioUnitScope_Input ? "input" : "output"),
1403                                                                 scope, cnt));
1404                 if ((result = unit->SetFormat (scope, i, fmt)) != 0) {
1405                         error << string_compose (_("AUPlugin: could not set stream format for %1/%2 (err = %3)"),
1406                                                  (scope == kAudioUnitScope_Input ? "input" : "output"), i, result) << endmsg;
1407                         return -1;
1408                 }
1409         }
1410
1411         if (scope == kAudioUnitScope_Input) {
1412                 input_channels = fmt.mChannelsPerFrame;
1413         } else {
1414                 output_channels = fmt.mChannelsPerFrame;
1415         }
1416
1417         return 0;
1418 }
1419
1420 OSStatus
1421 AUPlugin::render_callback(AudioUnitRenderActionFlags*,
1422                           const AudioTimeStamp*,
1423                           UInt32,
1424                           UInt32       inNumberFrames,
1425                           AudioBufferList*       ioData)
1426 {
1427         /* not much to do with audio - the data is already in the buffers given to us in connect_and_run() */
1428
1429         // DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1: render callback, frames %2 bufs %3\n",
1430         // name(), inNumberFrames, ioData->mNumberBuffers));
1431
1432         if (input_maxbuf == 0) {
1433                 DEBUG_TRACE (DEBUG::AudioUnits, "AUPlugin: render callback called illegally!");
1434                 error << _("AUPlugin: render callback called illegally!") << endmsg;
1435                 return kAudioUnitErr_CannotDoInCurrentContext;
1436         }
1437         uint32_t limit = min ((uint32_t) ioData->mNumberBuffers, input_maxbuf);
1438
1439         ChanCount bufs_count (DataType::AUDIO, 1);
1440         BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
1441
1442         for (uint32_t i = 0; i < limit; ++i) {
1443                 ioData->mBuffers[i].mNumberChannels = 1;
1444                 ioData->mBuffers[i].mDataByteSize = sizeof (Sample) * inNumberFrames;
1445
1446                 bool valid = false;
1447                 uint32_t idx = input_map->get (DataType::AUDIO, i, &valid);
1448                 if (valid) {
1449                         ioData->mBuffers[i].mData = input_buffers->get_audio (idx).data (cb_offset + input_offset);
1450                 } else {
1451                         ioData->mBuffers[i].mData = silent_bufs.get_audio(0).data (cb_offset + input_offset);
1452                 }
1453         }
1454
1455         cb_offset += inNumberFrames;
1456
1457         return noErr;
1458 }
1459
1460 int
1461 AUPlugin::connect_and_run (BufferSet& bufs, ChanMapping in_map, ChanMapping out_map, pframes_t nframes, framecnt_t offset)
1462 {
1463         Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
1464
1465         AudioUnitRenderActionFlags flags = 0;
1466         AudioTimeStamp ts;
1467         OSErr err;
1468
1469         if (requires_fixed_size_buffers() && (nframes != _last_nframes)) {
1470                 unit->GlobalReset();
1471                 _last_nframes = nframes;
1472         }
1473
1474         /* test if we can run in-place; only compare audio buffers */
1475         bool inplace = true;
1476         ChanMapping::Mappings inmap (in_map.mappings ());
1477         ChanMapping::Mappings outmap (out_map.mappings ());
1478         assert (outmap[DataType::AUDIO].size () > 0);
1479         if (inmap[DataType::AUDIO].size() > 0 && inmap != outmap) {
1480                 inplace = false;
1481         }
1482
1483         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1 in %2 out %3 MIDI %4 bufs %5 (available %6) Inplace: %7\n",
1484                                 name(), input_channels, output_channels, _has_midi_input,
1485                                 bufs.count(), bufs.available(), inplace));
1486
1487         /* the apparent number of buffers matches our input configuration, but we know that the bufferset
1488          * has the capacity to handle our outputs.
1489          */
1490
1491         assert (bufs.available() >= ChanCount (DataType::AUDIO, output_channels));
1492
1493         input_buffers = &bufs;
1494         input_map = &in_map;
1495         input_maxbuf = bufs.count().n_audio(); // number of input audio buffers
1496         input_offset = offset;
1497         cb_offset = 0;
1498
1499         buffers->mNumberBuffers = output_channels;
1500
1501         ChanCount bufs_count (DataType::AUDIO, 1);
1502         BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
1503
1504         for (int32_t i = 0; i < output_channels; ++i) {
1505                 buffers->mBuffers[i].mNumberChannels = 1;
1506                 buffers->mBuffers[i].mDataByteSize = nframes * sizeof (Sample);
1507                 /* setting this to 0 indicates to the AU that it can provide buffers here
1508                  * if necessary. if it can process in-place, it will use the buffers provided
1509                  * as input by ::render_callback() above.
1510                  *
1511                  * a non-null values tells the plugin to render into the buffer pointed
1512                  * at by the value.
1513                  */
1514                 if (inplace) {
1515                         buffers->mBuffers[i].mData = 0;
1516                 } else {
1517                         bool valid = false;
1518                         uint32_t idx = out_map.get (DataType::AUDIO, i, &valid);
1519                         if (valid) {
1520                                 buffers->mBuffers[i].mData = bufs.get_audio (idx).data (offset);
1521                         } else {
1522                                 buffers->mBuffers[i].mData = scratch_bufs.get_audio(0).data(offset);
1523                         }
1524                 }
1525         }
1526
1527         if (_has_midi_input) {
1528
1529                 uint32_t nmidi = bufs.count().n_midi();
1530
1531                 for (uint32_t i = 0; i < nmidi; ++i) {
1532
1533                         /* one MIDI port/buffer only */
1534
1535                         MidiBuffer& m = bufs.get_midi (i);
1536
1537                         for (MidiBuffer::iterator i = m.begin(); i != m.end(); ++i) {
1538                                 Evoral::MIDIEvent<framepos_t> ev (*i);
1539
1540                                 if (ev.is_channel_event()) {
1541                                         const uint8_t* b = ev.buffer();
1542                                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1: MIDI event %2\n", name(), ev));
1543                                         unit->MIDIEvent (b[0], b[1], b[2], ev.time());
1544                                 }
1545
1546                                 /* XXX need to handle sysex and other message types */
1547                         }
1548                 }
1549         }
1550
1551         /* does this really mean anything ?  */
1552
1553         ts.mSampleTime = frames_processed;
1554         ts.mFlags = kAudioTimeStampSampleTimeValid;
1555
1556         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1 render flags=%2 time=%3 nframes=%4 buffers=%5\n",
1557                                 name(), flags, frames_processed, nframes, buffers->mNumberBuffers));
1558
1559         if ((err = unit->Render (&flags, &ts, 0, nframes, buffers)) == noErr) {
1560
1561                 input_maxbuf = 0;
1562                 frames_processed += nframes;
1563
1564                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1 rendered %2 buffers of %3\n",
1565                                         name(), buffers->mNumberBuffers, output_channels));
1566
1567                 int32_t limit = min ((int32_t) buffers->mNumberBuffers, output_channels);
1568                 int32_t i;
1569
1570                 for (i = 0; i < limit; ++i) {
1571                         bool valid = false;
1572                         uint32_t idx = out_map.get (DataType::AUDIO, i, &valid);
1573                         if (!valid) continue;
1574                         Sample* expected_buffer_address = bufs.get_audio (idx).data (offset);
1575                         if (expected_buffer_address != buffers->mBuffers[i].mData) {
1576                                 /* plugin provided its own buffer for output so copy it back to where we want it
1577                                 */
1578                                 memcpy (expected_buffer_address, buffers->mBuffers[i].mData, nframes * sizeof (Sample));
1579                         }
1580                 }
1581
1582                 /* now silence any buffers that were passed in but the that the plugin
1583                  * did not fill/touch/use.
1584                  */
1585
1586                 for (;i < output_channels; ++i) {
1587                         bool valid = false;
1588                         uint32_t idx = out_map.get (DataType::AUDIO, i, &valid);
1589                         if (!valid) continue;
1590                         memset (bufs.get_audio (idx).data (offset), 0, nframes * sizeof (Sample));
1591                 }
1592
1593                 return 0;
1594         }
1595
1596         error << string_compose (_("AU: render error for %1, status = %2"), name(), err) << endmsg;
1597         return -1;
1598 }
1599
1600 OSStatus
1601 AUPlugin::get_beat_and_tempo_callback (Float64* outCurrentBeat,
1602                                        Float64* outCurrentTempo)
1603 {
1604         TempoMap& tmap (_session.tempo_map());
1605
1606         DEBUG_TRACE (DEBUG::AudioUnits, "AU calls ardour beat&tempo callback\n");
1607
1608         /* more than 1 meter or more than 1 tempo means that a simplistic computation
1609            (and interpretation) of a beat position will be incorrect. So refuse to
1610            offer the value.
1611         */
1612
1613         if (tmap.n_tempos() > 1 || tmap.n_meters() > 1) {
1614                 return kAudioUnitErr_CannotDoInCurrentContext;
1615         }
1616
1617         Timecode::BBT_Time bbt;
1618         TempoMetric metric = tmap.metric_at (_session.transport_frame() + input_offset);
1619         tmap.bbt_time (_session.transport_frame() + input_offset, bbt);
1620
1621         if (outCurrentBeat) {
1622                 float beat;
1623                 beat = metric.meter().divisions_per_bar() * bbt.bars;
1624                 beat += bbt.beats;
1625                 beat += bbt.ticks / Timecode::BBT_Time::ticks_per_beat;
1626                 *outCurrentBeat = beat;
1627         }
1628
1629         if (outCurrentTempo) {
1630                 *outCurrentTempo = floor (metric.tempo().beats_per_minute());
1631         }
1632
1633         return noErr;
1634
1635 }
1636
1637 OSStatus
1638 AUPlugin::get_musical_time_location_callback (UInt32*   outDeltaSampleOffsetToNextBeat,
1639                                               Float32*  outTimeSig_Numerator,
1640                                               UInt32*   outTimeSig_Denominator,
1641                                               Float64*  outCurrentMeasureDownBeat)
1642 {
1643         TempoMap& tmap (_session.tempo_map());
1644
1645         DEBUG_TRACE (DEBUG::AudioUnits, "AU calls ardour music time location callback\n");
1646
1647         /* more than 1 meter or more than 1 tempo means that a simplistic computation
1648            (and interpretation) of a beat position will be incorrect. So refuse to
1649            offer the value.
1650         */
1651
1652         if (tmap.n_tempos() > 1 || tmap.n_meters() > 1) {
1653                 return kAudioUnitErr_CannotDoInCurrentContext;
1654         }
1655
1656         Timecode::BBT_Time bbt;
1657         TempoMetric metric = tmap.metric_at (_session.transport_frame() + input_offset);
1658         tmap.bbt_time (_session.transport_frame() + input_offset, bbt);
1659
1660         if (outDeltaSampleOffsetToNextBeat) {
1661                 if (bbt.ticks == 0) {
1662                         /* on the beat */
1663                         *outDeltaSampleOffsetToNextBeat = 0;
1664                 } else {
1665                         *outDeltaSampleOffsetToNextBeat = (UInt32)
1666                                 floor (((Timecode::BBT_Time::ticks_per_beat - bbt.ticks)/Timecode::BBT_Time::ticks_per_beat) * // fraction of a beat to next beat
1667                                        metric.tempo().frames_per_beat (_session.frame_rate())); // frames per beat
1668                 }
1669         }
1670
1671         if (outTimeSig_Numerator) {
1672                 *outTimeSig_Numerator = (UInt32) lrintf (metric.meter().divisions_per_bar());
1673         }
1674         if (outTimeSig_Denominator) {
1675                 *outTimeSig_Denominator = (UInt32) lrintf (metric.meter().note_divisor());
1676         }
1677
1678         if (outCurrentMeasureDownBeat) {
1679
1680                 /* beat for the start of the bar.
1681                    1|1|0 -> 1
1682                    2|1|0 -> 1 + divisions_per_bar
1683                    3|1|0 -> 1 + (2 * divisions_per_bar)
1684                    etc.
1685                 */
1686
1687                 *outCurrentMeasureDownBeat = 1 + metric.meter().divisions_per_bar() * (bbt.bars - 1);
1688         }
1689
1690         return noErr;
1691 }
1692
1693 OSStatus
1694 AUPlugin::get_transport_state_callback (Boolean*  outIsPlaying,
1695                                         Boolean*  outTransportStateChanged,
1696                                         Float64*  outCurrentSampleInTimeLine,
1697                                         Boolean*  outIsCycling,
1698                                         Float64*  outCycleStartBeat,
1699                                         Float64*  outCycleEndBeat)
1700 {
1701         bool rolling;
1702         float speed;
1703
1704         DEBUG_TRACE (DEBUG::AudioUnits, "AU calls ardour transport state callback\n");
1705
1706         rolling = _session.transport_rolling();
1707         speed = _session.transport_speed ();
1708
1709         if (outIsPlaying) {
1710                 *outIsPlaying = _session.transport_rolling();
1711         }
1712
1713         if (outTransportStateChanged) {
1714                 if (rolling != last_transport_rolling) {
1715                         *outTransportStateChanged = true;
1716                 } else if (speed != last_transport_speed) {
1717                         *outTransportStateChanged = true;
1718                 } else {
1719                         *outTransportStateChanged = false;
1720                 }
1721         }
1722
1723         if (outCurrentSampleInTimeLine) {
1724                 /* this assumes that the AU can only call this host callback from render context,
1725                    where input_offset is valid.
1726                 */
1727                 *outCurrentSampleInTimeLine = _session.transport_frame() + input_offset;
1728         }
1729
1730         if (outIsCycling) {
1731                 Location* loc = _session.locations()->auto_loop_location();
1732
1733                 *outIsCycling = (loc && _session.transport_rolling() && _session.get_play_loop());
1734
1735                 if (*outIsCycling) {
1736
1737                         if (outCycleStartBeat || outCycleEndBeat) {
1738
1739                                 TempoMap& tmap (_session.tempo_map());
1740
1741                                 /* more than 1 meter means that a simplistic computation (and interpretation) of
1742                                    a beat position will be incorrect. so refuse to offer the value.
1743                                 */
1744
1745                                 if (tmap.n_meters() > 1) {
1746                                         return kAudioUnitErr_CannotDoInCurrentContext;
1747                                 }
1748
1749                                 Timecode::BBT_Time bbt;
1750
1751                                 if (outCycleStartBeat) {
1752                                         TempoMetric metric = tmap.metric_at (loc->start() + input_offset);
1753                                         _session.tempo_map().bbt_time (loc->start(), bbt);
1754
1755                                         float beat;
1756                                         beat = metric.meter().divisions_per_bar() * bbt.bars;
1757                                         beat += bbt.beats;
1758                                         beat += bbt.ticks / Timecode::BBT_Time::ticks_per_beat;
1759
1760                                         *outCycleStartBeat = beat;
1761                                 }
1762
1763                                 if (outCycleEndBeat) {
1764                                         TempoMetric metric = tmap.metric_at (loc->end() + input_offset);
1765                                         _session.tempo_map().bbt_time (loc->end(), bbt);
1766
1767                                         float beat;
1768                                         beat = metric.meter().divisions_per_bar() * bbt.bars;
1769                                         beat += bbt.beats;
1770                                         beat += bbt.ticks / Timecode::BBT_Time::ticks_per_beat;
1771
1772                                         *outCycleEndBeat = beat;
1773                                 }
1774                         }
1775                 }
1776         }
1777
1778         last_transport_rolling = rolling;
1779         last_transport_speed = speed;
1780
1781         return noErr;
1782 }
1783
1784 set<Evoral::Parameter>
1785 AUPlugin::automatable() const
1786 {
1787         set<Evoral::Parameter> automates;
1788
1789         for (uint32_t i = 0; i < descriptors.size(); ++i) {
1790                 if (descriptors[i].automatable) {
1791                         automates.insert (automates.end(), Evoral::Parameter (PluginAutomation, 0, i));
1792                 }
1793         }
1794
1795         return automates;
1796 }
1797
1798 string
1799 AUPlugin::describe_parameter (Evoral::Parameter param)
1800 {
1801         if (param.type() == PluginAutomation && param.id() < parameter_count()) {
1802                 return descriptors[param.id()].label;
1803         } else {
1804                 return "??";
1805         }
1806 }
1807
1808 void
1809 AUPlugin::print_parameter (uint32_t /*param*/, char* /*buf*/, uint32_t /*len*/) const
1810 {
1811         // NameValue stuff here
1812 }
1813
1814 bool
1815 AUPlugin::parameter_is_audio (uint32_t) const
1816 {
1817         return false;
1818 }
1819
1820 bool
1821 AUPlugin::parameter_is_control (uint32_t param) const
1822 {
1823         assert(param < descriptors.size());
1824         if (descriptors[param].automatable) {
1825                 /* corrently ardour expects all controls to be automatable
1826                  * IOW ardour GUI elements mandate an Evoral::Parameter
1827                  * for all input+control ports.
1828                  */
1829                 return true;
1830         }
1831         return false;
1832 }
1833
1834 bool
1835 AUPlugin::parameter_is_input (uint32_t param) const
1836 {
1837         /* AU params that are both readable and writeable,
1838          * are listed in kAudioUnitScope_Global
1839          */
1840         return (descriptors[param].scope == kAudioUnitScope_Input || descriptors[param].scope == kAudioUnitScope_Global);
1841 }
1842
1843 bool
1844 AUPlugin::parameter_is_output (uint32_t param) const
1845 {
1846         assert(param < descriptors.size());
1847         // TODO check if ardour properly handles ports
1848         // that report is_input + is_output == true
1849         // -> add || descriptors[param].scope == kAudioUnitScope_Global
1850         return (descriptors[param].scope == kAudioUnitScope_Output);
1851 }
1852
1853 void
1854 AUPlugin::add_state (XMLNode* root) const
1855 {
1856         LocaleGuard lg (X_("C"));
1857         CFDataRef xmlData;
1858         CFPropertyListRef propertyList;
1859
1860         DEBUG_TRACE (DEBUG::AudioUnits, "get preset state\n");
1861         if (unit->GetAUPreset (propertyList) != noErr) {
1862                 return;
1863         }
1864
1865         // Convert the property list into XML data.
1866
1867         xmlData = CFPropertyListCreateXMLData( kCFAllocatorDefault, propertyList);
1868
1869         if (!xmlData) {
1870                 error << _("Could not create XML version of property list") << endmsg;
1871                 return;
1872         }
1873
1874         /* re-parse XML bytes to create a libxml++ XMLTree that we can merge into
1875            our state node. GACK!
1876         */
1877
1878         XMLTree t;
1879
1880         if (t.read_buffer (string ((const char*) CFDataGetBytePtr (xmlData), CFDataGetLength (xmlData)))) {
1881                 if (t.root()) {
1882                         root->add_child_copy (*t.root());
1883                 }
1884         }
1885
1886         CFRelease (xmlData);
1887         CFRelease (propertyList);
1888 }
1889
1890 int
1891 AUPlugin::set_state(const XMLNode& node, int version)
1892 {
1893         int ret = -1;
1894         CFPropertyListRef propertyList;
1895         LocaleGuard lg (X_("C"));
1896
1897         if (node.name() != state_node_name()) {
1898                 error << _("Bad node sent to AUPlugin::set_state") << endmsg;
1899                 return -1;
1900         }
1901
1902 #ifndef NO_PLUGIN_STATE
1903         if (node.children().empty()) {
1904                 return -1;
1905         }
1906
1907         XMLNode* top = node.children().front();
1908         XMLNode* copy = new XMLNode (*top);
1909
1910         XMLTree t;
1911         t.set_root (copy);
1912
1913         const string& xml = t.write_buffer ();
1914         CFDataRef xmlData = CFDataCreateWithBytesNoCopy (kCFAllocatorDefault, (UInt8*) xml.data(), xml.length(), kCFAllocatorNull);
1915         CFStringRef errorString;
1916
1917         propertyList = CFPropertyListCreateFromXMLData( kCFAllocatorDefault,
1918                                                         xmlData,
1919                                                         kCFPropertyListImmutable,
1920                                                         &errorString);
1921
1922         CFRelease (xmlData);
1923
1924         if (propertyList) {
1925                 DEBUG_TRACE (DEBUG::AudioUnits, "set preset\n");
1926                 if (unit->SetAUPreset (propertyList) == noErr) {
1927                         ret = 0;
1928
1929                         /* tell the world */
1930
1931                         AudioUnitParameter changedUnit;
1932                         changedUnit.mAudioUnit = unit->AU();
1933                         changedUnit.mParameterID = kAUParameterListener_AnyParameter;
1934                         AUParameterListenerNotify (NULL, NULL, &changedUnit);
1935                 }
1936                 CFRelease (propertyList);
1937         }
1938 #endif
1939
1940         Plugin::set_state (node, version);
1941         return ret;
1942 }
1943
1944 bool
1945 AUPlugin::load_preset (PresetRecord r)
1946 {
1947         Plugin::load_preset (r);
1948
1949         bool ret = false;
1950         CFPropertyListRef propertyList;
1951         Glib::ustring path;
1952         UserPresetMap::iterator ux;
1953         FactoryPresetMap::iterator fx;
1954
1955         /* look first in "user" presets */
1956
1957         if ((ux = user_preset_map.find (r.label)) != user_preset_map.end()) {
1958
1959                 if ((propertyList = load_property_list (ux->second)) != 0) {
1960                         DEBUG_TRACE (DEBUG::AudioUnits, "set preset from user presets\n");
1961                         if (unit->SetAUPreset (propertyList) == noErr) {
1962                                 ret = true;
1963
1964                                 /* tell the world */
1965
1966                                 AudioUnitParameter changedUnit;
1967                                 changedUnit.mAudioUnit = unit->AU();
1968                                 changedUnit.mParameterID = kAUParameterListener_AnyParameter;
1969                                 AUParameterListenerNotify (NULL, NULL, &changedUnit);
1970                         }
1971                         CFRelease(propertyList);
1972                 }
1973
1974         } else if ((fx = factory_preset_map.find (r.label)) != factory_preset_map.end()) {
1975
1976                 AUPreset preset;
1977
1978                 preset.presetNumber = fx->second;
1979                 preset.presetName = CFStringCreateWithCString (kCFAllocatorDefault, fx->first.c_str(), kCFStringEncodingUTF8);
1980
1981                 DEBUG_TRACE (DEBUG::AudioUnits, "set preset from factory presets\n");
1982
1983                 if (unit->SetPresentPreset (preset) == 0) {
1984                         ret = true;
1985
1986                         /* tell the world */
1987
1988                         AudioUnitParameter changedUnit;
1989                         changedUnit.mAudioUnit = unit->AU();
1990                         changedUnit.mParameterID = kAUParameterListener_AnyParameter;
1991                         AUParameterListenerNotify (NULL, NULL, &changedUnit);
1992                 }
1993         }
1994
1995         return ret;
1996 }
1997
1998 void
1999 AUPlugin::do_remove_preset (std::string)
2000 {
2001 }
2002
2003 string
2004 AUPlugin::do_save_preset (string preset_name)
2005 {
2006         CFPropertyListRef propertyList;
2007         vector<Glib::ustring> v;
2008         Glib::ustring user_preset_path;
2009
2010         std::string m = maker();
2011         std::string n = name();
2012
2013         strip_whitespace_edges (m);
2014         strip_whitespace_edges (n);
2015
2016         v.push_back (Glib::get_home_dir());
2017         v.push_back ("Library");
2018         v.push_back ("Audio");
2019         v.push_back ("Presets");
2020         v.push_back (m);
2021         v.push_back (n);
2022
2023         user_preset_path = Glib::build_filename (v);
2024
2025         if (g_mkdir_with_parents (user_preset_path.c_str(), 0775) < 0) {
2026                 error << string_compose (_("Cannot create user plugin presets folder (%1)"), user_preset_path) << endmsg;
2027                 return string();
2028         }
2029
2030         DEBUG_TRACE (DEBUG::AudioUnits, "get current preset\n");
2031         if (unit->GetAUPreset (propertyList) != noErr) {
2032                 return string();
2033         }
2034
2035         // add the actual preset name */
2036
2037         v.push_back (preset_name + preset_suffix);
2038
2039         // rebuild
2040
2041         user_preset_path = Glib::build_filename (v);
2042
2043         set_preset_name_in_plist (propertyList, preset_name);
2044
2045         if (save_property_list (propertyList, user_preset_path)) {
2046                 error << string_compose (_("Saving plugin state to %1 failed"), user_preset_path) << endmsg;
2047                 return string();
2048         }
2049
2050         CFRelease(propertyList);
2051
2052         user_preset_map[preset_name] = user_preset_path;;
2053
2054         DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Saving Preset to %1\n", user_preset_path));
2055
2056         return string ("file:///") + user_preset_path;
2057 }
2058
2059 //-----------------------------------------------------------------------------
2060 // this is just a little helper function used by GetAUComponentDescriptionFromPresetFile()
2061 static SInt32
2062 GetDictionarySInt32Value(CFDictionaryRef inAUStateDictionary, CFStringRef inDictionaryKey, Boolean * outSuccess)
2063 {
2064         CFNumberRef cfNumber;
2065         SInt32 numberValue = 0;
2066         Boolean dummySuccess;
2067
2068         if (outSuccess == NULL)
2069                 outSuccess = &dummySuccess;
2070         if ( (inAUStateDictionary == NULL) || (inDictionaryKey == NULL) )
2071         {
2072                 *outSuccess = FALSE;
2073                 return 0;
2074         }
2075
2076         cfNumber = (CFNumberRef) CFDictionaryGetValue(inAUStateDictionary, inDictionaryKey);
2077         if (cfNumber == NULL)
2078         {
2079                 *outSuccess = FALSE;
2080                 return 0;
2081         }
2082         *outSuccess = CFNumberGetValue(cfNumber, kCFNumberSInt32Type, &numberValue);
2083         if (*outSuccess)
2084                 return numberValue;
2085         else
2086                 return 0;
2087 }
2088
2089 static OSStatus
2090 GetAUComponentDescriptionFromStateData(CFPropertyListRef inAUStateData, ArdourDescription * outComponentDescription)
2091 {
2092         CFDictionaryRef auStateDictionary;
2093         ArdourDescription tempDesc = {0,0,0,0,0};
2094         SInt32 versionValue;
2095         Boolean gotValue;
2096
2097         if ( (inAUStateData == NULL) || (outComponentDescription == NULL) )
2098                 return paramErr;
2099
2100         // the property list for AU state data must be of the dictionary type
2101         if (CFGetTypeID(inAUStateData) != CFDictionaryGetTypeID()) {
2102                 return kAudioUnitErr_InvalidPropertyValue;
2103         }
2104
2105         auStateDictionary = (CFDictionaryRef)inAUStateData;
2106
2107         // first check to make sure that the version of the AU state data is one that we know understand
2108         // XXX should I really do this?  later versions would probably still hold these ID keys, right?
2109         versionValue = GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetVersionKey), &gotValue);
2110
2111         if (!gotValue) {
2112                 return kAudioUnitErr_InvalidPropertyValue;
2113         }
2114 #define kCurrentSavedStateVersion 0
2115         if (versionValue != kCurrentSavedStateVersion) {
2116                 return kAudioUnitErr_InvalidPropertyValue;
2117         }
2118
2119         // grab the ComponentDescription values from the AU state data
2120         tempDesc.componentType = (OSType) GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetTypeKey), NULL);
2121         tempDesc.componentSubType = (OSType) GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetSubtypeKey), NULL);
2122         tempDesc.componentManufacturer = (OSType) GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetManufacturerKey), NULL);
2123         // zero values are illegit for specific ComponentDescriptions, so zero for any value means that there was an error
2124         if ( (tempDesc.componentType == 0) || (tempDesc.componentSubType == 0) || (tempDesc.componentManufacturer == 0) )
2125                 return kAudioUnitErr_InvalidPropertyValue;
2126
2127         *outComponentDescription = tempDesc;
2128         return noErr;
2129 }
2130
2131
2132 static bool au_preset_filter (const string& str, void* arg)
2133 {
2134         /* Not a dotfile, has a prefix before a period, suffix is aupreset */
2135
2136         bool ret;
2137
2138         ret = (str[0] != '.' && str.length() > 9 && str.find (preset_suffix) == (str.length() - preset_suffix.length()));
2139
2140         if (ret && arg) {
2141
2142                 /* check the preset file path name against this plugin
2143                    ID. The idea is that all preset files for this plugin
2144                    include "<manufacturer>/<plugin-name>" in their path.
2145                 */
2146
2147                 AUPluginInfo* p = (AUPluginInfo *) arg;
2148                 string match = p->creator;
2149                 match += '/';
2150                 match += p->name;
2151
2152                 ret = str.find (match) != string::npos;
2153
2154                 if (ret == false) {
2155                         string m = p->creator;
2156                         string n = p->name;
2157                         strip_whitespace_edges (m);
2158                         strip_whitespace_edges (n);
2159                         match = m;
2160                         match += '/';
2161                         match += n;
2162
2163                         ret = str.find (match) != string::npos;
2164                 }
2165         }
2166
2167         return ret;
2168 }
2169
2170 static bool
2171 check_and_get_preset_name (ArdourComponent component, const string& pathstr, string& preset_name)
2172 {
2173         OSStatus status;
2174         CFPropertyListRef plist;
2175         ArdourDescription presetDesc;
2176         bool ret = false;
2177
2178         plist = load_property_list (pathstr);
2179
2180         if (!plist) {
2181                 return ret;
2182         }
2183
2184         // get the ComponentDescription from the AU preset file
2185
2186         status = GetAUComponentDescriptionFromStateData(plist, &presetDesc);
2187
2188         if (status == noErr) {
2189                 if (ComponentAndDescriptionMatch_Loosely(component, &presetDesc)) {
2190
2191                         /* try to get the preset name from the property list */
2192
2193                         if (CFGetTypeID(plist) == CFDictionaryGetTypeID()) {
2194
2195                                 const void* psk = CFDictionaryGetValue ((CFMutableDictionaryRef)plist, CFSTR(kAUPresetNameKey));
2196
2197                                 if (psk) {
2198
2199                                         const char* p = CFStringGetCStringPtr ((CFStringRef) psk, kCFStringEncodingUTF8);
2200
2201                                         if (!p) {
2202                                                 char buf[PATH_MAX+1];
2203
2204                                                 if (CFStringGetCString ((CFStringRef)psk, buf, sizeof (buf), kCFStringEncodingUTF8)) {
2205                                                         preset_name = buf;
2206                                                 }
2207                                         }
2208                                 }
2209                         }
2210                 }
2211         }
2212
2213         CFRelease (plist);
2214
2215         return true;
2216 }
2217
2218
2219 static void
2220 #ifdef COREAUDIO105
2221 get_names (CAComponentDescription& comp_desc, std::string& name, std::string& maker)
2222 #else
2223 get_names (ArdourComponent& comp, std::string& name, std::string& maker)
2224 #endif
2225 {
2226         CFStringRef itemName = NULL;
2227         // Marc Poirier-style item name
2228 #ifdef COREAUDIO105
2229         CAComponent auComponent (comp_desc);
2230         if (auComponent.IsValid()) {
2231                 CAComponentDescription dummydesc;
2232                 Handle nameHandle = NewHandle(sizeof(void*));
2233                 if (nameHandle != NULL) {
2234                         OSErr err = GetComponentInfo(auComponent.Comp(), &dummydesc, nameHandle, NULL, NULL);
2235                         if (err == noErr) {
2236                                 ConstStr255Param nameString = (ConstStr255Param) (*nameHandle);
2237                                 if (nameString != NULL) {
2238                                         itemName = CFStringCreateWithPascalString(kCFAllocatorDefault, nameString, CFStringGetSystemEncoding());
2239                                 }
2240                         }
2241                         DisposeHandle(nameHandle);
2242                 }
2243         }
2244 #else
2245         assert (comp);
2246         AudioComponentCopyName (comp, &itemName);
2247 #endif
2248
2249         // if Marc-style fails, do the original way
2250         if (itemName == NULL) {
2251 #ifndef COREAUDIO105
2252                 CAComponentDescription comp_desc;
2253                 AudioComponentGetDescription (comp, &comp_desc);
2254 #endif
2255                 CFStringRef compTypeString = UTCreateStringForOSType(comp_desc.componentType);
2256                 CFStringRef compSubTypeString = UTCreateStringForOSType(comp_desc.componentSubType);
2257                 CFStringRef compManufacturerString = UTCreateStringForOSType(comp_desc.componentManufacturer);
2258
2259                 itemName = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR("%@ - %@ - %@"),
2260                                 compTypeString, compManufacturerString, compSubTypeString);
2261
2262                 if (compTypeString != NULL)
2263                         CFRelease(compTypeString);
2264                 if (compSubTypeString != NULL)
2265                         CFRelease(compSubTypeString);
2266                 if (compManufacturerString != NULL)
2267                         CFRelease(compManufacturerString);
2268         }
2269
2270         string str = CFStringRefToStdString(itemName);
2271         string::size_type colon = str.find (':');
2272
2273         if (colon) {
2274                 name = str.substr (colon+1);
2275                 maker = str.substr (0, colon);
2276                 strip_whitespace_edges (maker);
2277                 strip_whitespace_edges (name);
2278         } else {
2279                 name = str;
2280                 maker = "unknown";
2281                 strip_whitespace_edges (name);
2282         }
2283 }
2284
2285 std::string
2286 AUPlugin::current_preset() const
2287 {
2288         string preset_name;
2289
2290         CFPropertyListRef propertyList;
2291
2292         DEBUG_TRACE (DEBUG::AudioUnits, "get current preset for current_preset()\n");
2293         if (unit->GetAUPreset (propertyList) == noErr) {
2294                 preset_name = get_preset_name_in_plist (propertyList);
2295                 CFRelease(propertyList);
2296         }
2297
2298         return preset_name;
2299 }
2300
2301 void
2302 AUPlugin::find_presets ()
2303 {
2304         vector<string> preset_files;
2305
2306         user_preset_map.clear ();
2307
2308         PluginInfoPtr nfo = get_info();
2309         find_files_matching_filter (preset_files, preset_search_path, au_preset_filter,
2310                         boost::dynamic_pointer_cast<AUPluginInfo> (nfo).get(),
2311                         true, true, true);
2312
2313         if (preset_files.empty()) {
2314                 DEBUG_TRACE (DEBUG::AudioUnits, "AU No Preset Files found for given plugin.\n");
2315         }
2316
2317         for (vector<string>::iterator x = preset_files.begin(); x != preset_files.end(); ++x) {
2318
2319                 string path = *x;
2320                 string preset_name;
2321
2322                 /* make an initial guess at the preset name using the path */
2323
2324                 preset_name = Glib::path_get_basename (path);
2325                 preset_name = preset_name.substr (0, preset_name.find_last_of ('.'));
2326
2327                 /* check that this preset file really matches this plugin
2328                    and potentially get the "real" preset name from
2329                    within the file.
2330                 */
2331
2332                 if (check_and_get_preset_name (get_comp()->Comp(), path, preset_name)) {
2333                         user_preset_map[preset_name] = path;
2334                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Preset File: %1 > %2\n", preset_name, path));
2335                 } else {
2336                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU INVALID Preset: %1 > %2\n", preset_name, path));
2337                 }
2338
2339         }
2340
2341         /* now fill the vector<string> with the names we have */
2342
2343         for (UserPresetMap::iterator i = user_preset_map.begin(); i != user_preset_map.end(); ++i) {
2344                 _presets.insert (make_pair (i->second, Plugin::PresetRecord (i->second, i->first)));
2345                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Adding User Preset: %1 > %2\n", i->first, i->second));
2346         }
2347
2348         /* add factory presets */
2349
2350         for (FactoryPresetMap::iterator i = factory_preset_map.begin(); i != factory_preset_map.end(); ++i) {
2351                 /* XXX: dubious */
2352                 string const uri = string_compose ("%1", _presets.size ());
2353                 _presets.insert (make_pair (uri, Plugin::PresetRecord (uri, i->first, false)));
2354                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Adding Factory Preset: %1 > %2\n", i->first, i->second));
2355         }
2356 }
2357
2358 bool
2359 AUPlugin::has_editor () const
2360 {
2361         // even if the plugin doesn't have its own editor, the AU API can be used
2362         // to create one that looks native.
2363         return true;
2364 }
2365
2366 AUPluginInfo::AUPluginInfo (boost::shared_ptr<CAComponentDescription> d)
2367         : descriptor (d)
2368         , version (0)
2369 {
2370         type = ARDOUR::AudioUnit;
2371 }
2372
2373 AUPluginInfo::~AUPluginInfo ()
2374 {
2375         type = ARDOUR::AudioUnit;
2376 }
2377
2378 PluginPtr
2379 AUPluginInfo::load (Session& session)
2380 {
2381         try {
2382                 PluginPtr plugin;
2383
2384                 DEBUG_TRACE (DEBUG::AudioUnits, "load AU as a component\n");
2385                 boost::shared_ptr<CAComponent> comp (new CAComponent(*descriptor));
2386
2387                 if (!comp->IsValid()) {
2388                         error << ("AudioUnit: not a valid Component") << endmsg;
2389                 } else {
2390                         plugin.reset (new AUPlugin (session.engine(), session, comp));
2391                 }
2392
2393                 AUPluginInfo *aup = new AUPluginInfo (*this);
2394                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("plugin info for %1 = %2\n", this, aup));
2395                 plugin->set_info (PluginInfoPtr (aup));
2396                 boost::dynamic_pointer_cast<AUPlugin> (plugin)->set_fixed_size_buffers (aup->creator == "Universal Audio");
2397                 return plugin;
2398         }
2399
2400         catch (failed_constructor &err) {
2401                 DEBUG_TRACE (DEBUG::AudioUnits, "failed to load component/plugin\n");
2402                 return PluginPtr ();
2403         }
2404 }
2405
2406 std::vector<Plugin::PresetRecord>
2407 AUPluginInfo::get_presets (bool user_only) const
2408 {
2409         std::vector<Plugin::PresetRecord> p;
2410         boost::shared_ptr<CAComponent> comp;
2411 #ifndef NO_PLUGIN_STATE
2412         try {
2413                 comp = boost::shared_ptr<CAComponent>(new CAComponent(*descriptor));
2414                 if (!comp->IsValid()) {
2415                         throw failed_constructor();
2416                 }
2417         } catch (failed_constructor& err) {
2418                 return p;
2419         }
2420
2421         // user presets
2422
2423         if (!preset_search_path_initialized) {
2424                 Glib::ustring p = Glib::get_home_dir();
2425                 p += "/Library/Audio/Presets:";
2426                 p += preset_search_path;
2427                 preset_search_path = p;
2428                 preset_search_path_initialized = true;
2429                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Preset Path: %1\n", preset_search_path));
2430         }
2431
2432         vector<string> preset_files;
2433         find_files_matching_filter (preset_files, preset_search_path, au_preset_filter, const_cast<AUPluginInfo*>(this), true, true, true);
2434
2435         for (vector<string>::iterator x = preset_files.begin(); x != preset_files.end(); ++x) {
2436                 string path = *x;
2437                 string preset_name;
2438                 preset_name = Glib::path_get_basename (path);
2439                 preset_name = preset_name.substr (0, preset_name.find_last_of ('.'));
2440                 if (check_and_get_preset_name (comp.get()->Comp(), path, preset_name)) {
2441                         p.push_back (Plugin::PresetRecord (path, preset_name));
2442                 }
2443         }
2444
2445         if (user_only) {
2446                 return p;
2447         }
2448
2449         // factory presets
2450
2451         CFArrayRef presets;
2452         UInt32 dataSize;
2453         Boolean isWritable;
2454
2455         boost::shared_ptr<CAAudioUnit> unit (new CAAudioUnit);
2456         if (noErr != CAAudioUnit::Open (*(comp.get()), *unit)) {
2457                 return p;
2458         }
2459         if (noErr != unit->GetPropertyInfo (kAudioUnitProperty_FactoryPresets, kAudioUnitScope_Global, 0, &dataSize, &isWritable)) {
2460                 unit->Uninitialize ();
2461                 return p;
2462         }
2463         if (noErr != unit->GetProperty (kAudioUnitProperty_FactoryPresets, kAudioUnitScope_Global, 0, (void*) &presets, &dataSize)) {
2464                 unit->Uninitialize ();
2465                 return p;
2466         }
2467         if (!presets) {
2468                 unit->Uninitialize ();
2469                 return p;
2470         }
2471
2472         CFIndex cnt = CFArrayGetCount (presets);
2473         for (CFIndex i = 0; i < cnt; ++i) {
2474                 AUPreset* preset = (AUPreset*) CFArrayGetValueAtIndex (presets, i);
2475                 string const uri = string_compose ("%1", i);
2476                 string name = CFStringRefToStdString (preset->presetName);
2477                 p.push_back (Plugin::PresetRecord (uri, name, false));
2478         }
2479         CFRelease (presets);
2480         unit->Uninitialize ();
2481
2482 #endif // NO_PLUGIN_STATE
2483         return p;
2484 }
2485
2486 Glib::ustring
2487 AUPluginInfo::au_cache_path ()
2488 {
2489         return Glib::build_filename (ARDOUR::user_cache_directory(), "au_cache");
2490 }
2491
2492 PluginInfoList*
2493 AUPluginInfo::discover (bool scan_only)
2494 {
2495         XMLTree tree;
2496
2497         /* AU require a CAComponentDescription pointer provided by the OS.
2498          * Ardour only caches port and i/o config. It can't just 'scan' without
2499          * 'discovering' (like we do for VST).
2500          *
2501          * "Scan Only" means
2502          * "Iterate over all plugins. skip the ones where there's no io-cache".
2503          */
2504         _scan_only = scan_only;
2505
2506         if (!Glib::file_test (au_cache_path(), Glib::FILE_TEST_EXISTS)) {
2507                 ARDOUR::BootMessage (_("Discovering AudioUnit plugins (could take some time ...)"));
2508         }
2509         // create crash log file
2510         au_start_crashlog ();
2511
2512         PluginInfoList* plugs = new PluginInfoList;
2513
2514         discover_fx (*plugs);
2515         discover_music (*plugs);
2516         discover_generators (*plugs);
2517         discover_instruments (*plugs);
2518
2519         // all fine if we get here
2520         au_remove_crashlog ();
2521
2522         DEBUG_TRACE (DEBUG::PluginManager, string_compose ("AU: discovered %1 plugins\n", plugs->size()));
2523
2524         return plugs;
2525 }
2526
2527 void
2528 AUPluginInfo::discover_music (PluginInfoList& plugs)
2529 {
2530         CAComponentDescription desc;
2531         desc.componentFlags = 0;
2532         desc.componentFlagsMask = 0;
2533         desc.componentSubType = 0;
2534         desc.componentManufacturer = 0;
2535         desc.componentType = kAudioUnitType_MusicEffect;
2536
2537         discover_by_description (plugs, desc);
2538 }
2539
2540 void
2541 AUPluginInfo::discover_fx (PluginInfoList& plugs)
2542 {
2543         CAComponentDescription desc;
2544         desc.componentFlags = 0;
2545         desc.componentFlagsMask = 0;
2546         desc.componentSubType = 0;
2547         desc.componentManufacturer = 0;
2548         desc.componentType = kAudioUnitType_Effect;
2549
2550         discover_by_description (plugs, desc);
2551 }
2552
2553 void
2554 AUPluginInfo::discover_generators (PluginInfoList& plugs)
2555 {
2556         CAComponentDescription desc;
2557         desc.componentFlags = 0;
2558         desc.componentFlagsMask = 0;
2559         desc.componentSubType = 0;
2560         desc.componentManufacturer = 0;
2561         desc.componentType = kAudioUnitType_Generator;
2562
2563         discover_by_description (plugs, desc);
2564 }
2565
2566 void
2567 AUPluginInfo::discover_instruments (PluginInfoList& plugs)
2568 {
2569         CAComponentDescription desc;
2570         desc.componentFlags = 0;
2571         desc.componentFlagsMask = 0;
2572         desc.componentSubType = 0;
2573         desc.componentManufacturer = 0;
2574         desc.componentType = kAudioUnitType_MusicDevice;
2575
2576         discover_by_description (plugs, desc);
2577 }
2578
2579
2580 bool
2581 AUPluginInfo::au_get_crashlog (std::string &msg)
2582 {
2583         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_crashlog.txt");
2584         if (!Glib::file_test (fn, Glib::FILE_TEST_EXISTS)) {
2585                 return false;
2586         }
2587         std::ifstream ifs(fn.c_str());
2588         msg.assign ((std::istreambuf_iterator<char>(ifs)), (std::istreambuf_iterator<char>()));
2589         au_remove_crashlog ();
2590         return true;
2591 }
2592
2593 void
2594 AUPluginInfo::au_start_crashlog ()
2595 {
2596         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_crashlog.txt");
2597         assert(!_crashlog_fd);
2598         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("Creating AU Log: %1\n", fn));
2599         if (!(_crashlog_fd = fopen(fn.c_str(), "w"))) {
2600                 PBD::error << "Cannot create AU error-log" << fn << "\n";
2601                 cerr << "Cannot create AU error-log" << fn << "\n";
2602         }
2603 }
2604
2605 void
2606 AUPluginInfo::au_remove_crashlog ()
2607 {
2608         if (_crashlog_fd) {
2609                 ::fclose(_crashlog_fd);
2610                 _crashlog_fd = NULL;
2611         }
2612         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_crashlog.txt");
2613         ::g_unlink(fn.c_str());
2614         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("Remove AU Log: %1\n", fn));
2615 }
2616
2617
2618 void
2619 AUPluginInfo::au_crashlog (std::string msg)
2620 {
2621         if (!_crashlog_fd) {
2622                 fprintf(stderr, "AU: %s\n", msg.c_str());
2623         } else {
2624                 fprintf(_crashlog_fd, "AU: %s\n", msg.c_str());
2625                 ::fflush(_crashlog_fd);
2626         }
2627 }
2628
2629 void
2630 AUPluginInfo::discover_by_description (PluginInfoList& plugs, CAComponentDescription& desc)
2631 {
2632         ArdourComponent comp = 0;
2633         au_crashlog(string_compose("Start AU discovery for Type: %1", (int)desc.componentType));
2634
2635         comp = ArdourFindNext (NULL, &desc);
2636
2637         while (comp != NULL) {
2638                 CAComponentDescription temp;
2639 #ifdef COREAUDIO105
2640                 GetComponentInfo (comp, &temp, NULL, NULL, NULL);
2641 #else
2642                 AudioComponentGetDescription (comp, &temp);
2643 #endif
2644                 CFStringRef itemName = NULL;
2645
2646                 {
2647                         if (itemName != NULL) CFRelease(itemName);
2648                         CFStringRef compTypeString = UTCreateStringForOSType(temp.componentType);
2649                         CFStringRef compSubTypeString = UTCreateStringForOSType(temp.componentSubType);
2650                         CFStringRef compManufacturerString = UTCreateStringForOSType(temp.componentManufacturer);
2651                         itemName = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR("%@ - %@ - %@"),
2652                                         compTypeString, compManufacturerString, compSubTypeString);
2653                         au_crashlog(string_compose("Scanning ID: %1", CFStringRefToStdString(itemName)));
2654                         if (compTypeString != NULL)
2655                                 CFRelease(compTypeString);
2656                         if (compSubTypeString != NULL)
2657                                 CFRelease(compSubTypeString);
2658                         if (compManufacturerString != NULL)
2659                                 CFRelease(compManufacturerString);
2660                 }
2661
2662                 if (is_blacklisted(CFStringRefToStdString(itemName))) {
2663                         info << string_compose (_("Skipped blacklisted AU plugin %1 "), CFStringRefToStdString(itemName)) << endmsg;
2664                         comp = ArdourFindNext (comp, &desc);
2665                         continue;
2666                 }
2667
2668                 bool has_midi_in = false;
2669
2670                 AUPluginInfoPtr info (new AUPluginInfo
2671                                       (boost::shared_ptr<CAComponentDescription> (new CAComponentDescription(temp))));
2672
2673                 /* although apple designed the subtype field to be a "category" indicator,
2674                    its really turned into a plugin ID field for a given manufacturer. Hence
2675                    there are no categories for AudioUnits. However, to keep the plugins
2676                    showing up under "categories", we'll use the "type" as a high level
2677                    selector.
2678
2679                    NOTE: no panners, format converters or i/o AU's for our purposes
2680                  */
2681
2682                 switch (info->descriptor->Type()) {
2683                 case kAudioUnitType_Panner:
2684                 case kAudioUnitType_OfflineEffect:
2685                 case kAudioUnitType_FormatConverter:
2686                         comp = ArdourFindNext (comp, &desc);
2687                         continue;
2688
2689                 case kAudioUnitType_Output:
2690                         info->category = _("AudioUnit Outputs");
2691                         break;
2692                 case kAudioUnitType_MusicDevice:
2693                         info->category = _("AudioUnit Instruments");
2694                         has_midi_in = true;
2695                         break;
2696                 case kAudioUnitType_MusicEffect:
2697                         info->category = _("AudioUnit MusicEffects");
2698                         has_midi_in = true;
2699                         break;
2700                 case kAudioUnitType_Effect:
2701                         info->category = _("AudioUnit Effects");
2702                         break;
2703                 case kAudioUnitType_Mixer:
2704                         info->category = _("AudioUnit Mixers");
2705                         break;
2706                 case kAudioUnitType_Generator:
2707                         info->category = _("AudioUnit Generators");
2708                         break;
2709                 default:
2710                         info->category = _("AudioUnit (Unknown)");
2711                         break;
2712                 }
2713
2714                 au_blacklist(CFStringRefToStdString(itemName));
2715 #ifdef COREAUDIO105
2716                 get_names (temp, info->name, info->creator);
2717 #else
2718                 get_names (comp, info->name, info->creator);
2719 #endif
2720                 ARDOUR::PluginScanMessage(_("AU"), info->name, false);
2721                 au_crashlog(string_compose("Plugin: %1", info->name));
2722
2723                 info->type = ARDOUR::AudioUnit;
2724                 info->unique_id = stringify_descriptor (*info->descriptor);
2725
2726                 /* XXX not sure of the best way to handle plugin versioning yet
2727                  */
2728
2729                 CAComponent cacomp (*info->descriptor);
2730
2731 #ifdef COREAUDIO105
2732                 if (cacomp.GetResourceVersion (info->version) != noErr)
2733 #else
2734                 if (cacomp.GetVersion (info->version) != noErr)
2735 #endif
2736                 {
2737                         info->version = 0;
2738                 }
2739
2740                 const int rv = cached_io_configuration (info->unique_id, info->version, cacomp, info->cache, info->name);
2741
2742                 if (rv == 0) {
2743                         /* here we have to map apple's wildcard system to a simple pair
2744                            of values. in ::can_do() we use the whole system, but here
2745                            we need a single pair of values. XXX probably means we should
2746                            remove any use of these values.
2747
2748                            for now, if the plugin provides a wildcard, treat it as 1. we really
2749                            don't care much, because whether we can handle an i/o configuration
2750                            depends upon ::can_support_io_configuration(), not these counts.
2751
2752                            they exist because other parts of ardour try to present i/o configuration
2753                            info to the user, which should perhaps be revisited.
2754                         */
2755
2756                         int32_t possible_in = info->cache.io_configs.front().first;
2757                         int32_t possible_out = info->cache.io_configs.front().second;
2758
2759                         if (possible_in > 0) {
2760                                 info->n_inputs.set (DataType::AUDIO, possible_in);
2761                         } else {
2762                                 info->n_inputs.set (DataType::AUDIO, 1);
2763                         }
2764
2765                         info->n_inputs.set (DataType::MIDI, has_midi_in ? 1 : 0);
2766
2767                         if (possible_out > 0) {
2768                                 info->n_outputs.set (DataType::AUDIO, possible_out);
2769                         } else {
2770                                 info->n_outputs.set (DataType::AUDIO, 1);
2771                         }
2772
2773                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("detected AU %1 with %2 i/o configurations - %3\n",
2774                                                                         info->name.c_str(), info->cache.io_configs.size(), info->unique_id));
2775
2776                         plugs.push_back (info);
2777
2778                 }
2779                 else if (rv == -1) {
2780                         error << string_compose (_("Cannot get I/O configuration info for AU %1"), info->name) << endmsg;
2781                 }
2782
2783                 au_unblacklist(CFStringRefToStdString(itemName));
2784                 au_crashlog("Success.");
2785                 comp = ArdourFindNext (comp, &desc);
2786                 if (itemName != NULL) CFRelease(itemName); itemName = NULL;
2787         }
2788         au_crashlog(string_compose("End AU discovery for Type: %1", (int)desc.componentType));
2789 }
2790
2791 int
2792 AUPluginInfo::cached_io_configuration (const std::string& unique_id,
2793                                        UInt32 version,
2794                                        CAComponent& comp,
2795                                        AUPluginCachedInfo& cinfo,
2796                                        const std::string& name)
2797 {
2798         std::string id;
2799         char buf[32];
2800
2801         /* concatenate unique ID with version to provide a key for cached info lookup.
2802            this ensures we don't get stale information, or should if plugin developers
2803            follow Apple "guidelines".
2804          */
2805
2806         snprintf (buf, sizeof (buf), "%u", (uint32_t) version);
2807         id = unique_id;
2808         id += '/';
2809         id += buf;
2810
2811         CachedInfoMap::iterator cim = cached_info.find (id);
2812
2813         if (cim != cached_info.end()) {
2814                 cinfo = cim->second;
2815                 return 0;
2816         }
2817
2818         if (_scan_only) {
2819                 PBD::info << string_compose (_("Skipping AU %1 (not indexed. Discover new plugins to add)"), name) << endmsg;
2820                 return 1;
2821         }
2822
2823         CAAudioUnit unit;
2824         AUChannelInfo* channel_info;
2825         UInt32 cnt;
2826         int ret;
2827
2828         ARDOUR::BootMessage (string_compose (_("Checking AudioUnit: %1"), name));
2829
2830         try {
2831
2832                 if (CAAudioUnit::Open (comp, unit) != noErr) {
2833                         return -1;
2834                 }
2835
2836         } catch (...) {
2837
2838                 warning << string_compose (_("Could not load AU plugin %1 - ignored"), name) << endmsg;
2839                 return -1;
2840
2841         }
2842
2843         DEBUG_TRACE (DEBUG::AudioUnits, "get AU channel info\n");
2844         if ((ret = unit.GetChannelInfo (&channel_info, cnt)) < 0) {
2845                 return -1;
2846         }
2847
2848         if (ret > 0) {
2849
2850                 /* no explicit info available, so default to 1in/1out */
2851
2852                 /* XXX this is wrong. we should be indicating wildcard values */
2853
2854                 cinfo.io_configs.push_back (pair<int,int> (-1, -1));
2855
2856         } else {
2857
2858                 /* store each configuration */
2859
2860                 for (uint32_t n = 0; n < cnt; ++n) {
2861                         cinfo.io_configs.push_back (pair<int,int> (channel_info[n].inChannels,
2862                                                                    channel_info[n].outChannels));
2863                 }
2864
2865                 free (channel_info);
2866         }
2867
2868         add_cached_info (id, cinfo);
2869         save_cached_info ();
2870
2871         return 0;
2872 }
2873
2874 void
2875 AUPluginInfo::add_cached_info (const std::string& id, AUPluginCachedInfo& cinfo)
2876 {
2877         cached_info[id] = cinfo;
2878 }
2879
2880 #define AU_CACHE_VERSION "2.0"
2881
2882 void
2883 AUPluginInfo::save_cached_info ()
2884 {
2885         XMLNode* node;
2886
2887         node = new XMLNode (X_("AudioUnitPluginCache"));
2888         node->add_property( "version", AU_CACHE_VERSION );
2889
2890         for (map<string,AUPluginCachedInfo>::iterator i = cached_info.begin(); i != cached_info.end(); ++i) {
2891                 XMLNode* parent = new XMLNode (X_("plugin"));
2892                 parent->add_property ("id", i->first);
2893                 node->add_child_nocopy (*parent);
2894
2895                 for (vector<pair<int, int> >::iterator j = i->second.io_configs.begin(); j != i->second.io_configs.end(); ++j) {
2896
2897                         XMLNode* child = new XMLNode (X_("io"));
2898                         char buf[32];
2899
2900                         snprintf (buf, sizeof (buf), "%d", j->first);
2901                         child->add_property (X_("in"), buf);
2902                         snprintf (buf, sizeof (buf), "%d", j->second);
2903                         child->add_property (X_("out"), buf);
2904                         parent->add_child_nocopy (*child);
2905                 }
2906
2907         }
2908
2909         Glib::ustring path = au_cache_path ();
2910         XMLTree tree;
2911
2912         tree.set_root (node);
2913
2914         if (!tree.write (path)) {
2915                 error << string_compose (_("could not save AU cache to %1"), path) << endmsg;
2916                 g_unlink (path.c_str());
2917         }
2918 }
2919
2920 int
2921 AUPluginInfo::load_cached_info ()
2922 {
2923         Glib::ustring path = au_cache_path ();
2924         XMLTree tree;
2925
2926         if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
2927                 return 0;
2928         }
2929
2930         if ( !tree.read (path) ) {
2931                 error << "au_cache is not a valid XML file.  AU plugins will be re-scanned" << endmsg;
2932                 return -1;
2933         }
2934
2935         const XMLNode* root (tree.root());
2936
2937         if (root->name() != X_("AudioUnitPluginCache")) {
2938                 return -1;
2939         }
2940
2941         //initial version has incorrectly stored i/o info, and/or garbage chars.
2942         const XMLProperty* version = root->property(X_("version"));
2943         if (! ((version != NULL) && (version->value() == X_(AU_CACHE_VERSION)))) {
2944                 error << "au_cache is not correct version.  AU plugins will be re-scanned" << endmsg;
2945                 return -1;
2946         }
2947
2948         cached_info.clear ();
2949
2950         const XMLNodeList children = root->children();
2951
2952         for (XMLNodeConstIterator iter = children.begin(); iter != children.end(); ++iter) {
2953
2954                 const XMLNode* child = *iter;
2955
2956                 if (child->name() == X_("plugin")) {
2957
2958                         const XMLNode* gchild;
2959                         const XMLNodeList gchildren = child->children();
2960                         const XMLProperty* prop = child->property (X_("id"));
2961
2962                         if (!prop) {
2963                                 continue;
2964                         }
2965
2966                         string id = prop->value();
2967                         string fixed;
2968                         string version;
2969
2970                         string::size_type slash = id.find_last_of ('/');
2971
2972                         if (slash == string::npos) {
2973                                 continue;
2974                         }
2975
2976                         version = id.substr (slash);
2977                         id = id.substr (0, slash);
2978                         fixed = AUPlugin::maybe_fix_broken_au_id (id);
2979
2980                         if (fixed.empty()) {
2981                                 error << string_compose (_("Your AudioUnit configuration cache contains an AU plugin whose ID cannot be understood - ignored (%1)"), id) << endmsg;
2982                                 continue;
2983                         }
2984
2985                         id = fixed;
2986                         id += version;
2987
2988                         AUPluginCachedInfo cinfo;
2989
2990                         for (XMLNodeConstIterator giter = gchildren.begin(); giter != gchildren.end(); giter++) {
2991
2992                                 gchild = *giter;
2993
2994                                 if (gchild->name() == X_("io")) {
2995
2996                                         int in;
2997                                         int out;
2998                                         const XMLProperty* iprop;
2999                                         const XMLProperty* oprop;
3000
3001                                         if (((iprop = gchild->property (X_("in"))) != 0) &&
3002                                             ((oprop = gchild->property (X_("out"))) != 0)) {
3003                                                 in = atoi (iprop->value());
3004                                                 out = atoi (oprop->value());
3005
3006                                                 cinfo.io_configs.push_back (pair<int,int> (in, out));
3007                                         }
3008                                 }
3009                         }
3010
3011                         if (cinfo.io_configs.size()) {
3012                                 add_cached_info (id, cinfo);
3013                         }
3014                 }
3015         }
3016
3017         return 0;
3018 }
3019
3020
3021 std::string
3022 AUPluginInfo::stringify_descriptor (const CAComponentDescription& desc)
3023 {
3024         stringstream s;
3025
3026         /* note: OSType is a compiler-implemenation-defined value,
3027            historically a 32 bit integer created with a multi-character
3028            constant such as 'abcd'. It is, fundamentally, an abomination.
3029         */
3030
3031         s << desc.Type();
3032         s << '-';
3033         s << desc.SubType();
3034         s << '-';
3035         s << desc.Manu();
3036
3037         return s.str();
3038 }
3039
3040 bool
3041 AUPluginInfo::needs_midi_input () const
3042 {
3043         return is_effect_with_midi_input () || is_instrument ();
3044 }
3045
3046 bool
3047 AUPluginInfo::is_effect () const
3048 {
3049         return is_effect_without_midi_input() || is_effect_with_midi_input();
3050 }
3051
3052 bool
3053 AUPluginInfo::is_effect_without_midi_input () const
3054 {
3055         return descriptor->IsAUFX();
3056 }
3057
3058 bool
3059 AUPluginInfo::is_effect_with_midi_input () const
3060 {
3061         return descriptor->IsAUFM();
3062 }
3063
3064 bool
3065 AUPluginInfo::is_instrument () const
3066 {
3067         return descriptor->IsMusicDevice();
3068 }
3069
3070 void
3071 AUPlugin::set_info (PluginInfoPtr info)
3072 {
3073         Plugin::set_info (info);
3074
3075         AUPluginInfoPtr pinfo = boost::dynamic_pointer_cast<AUPluginInfo>(get_info());
3076         _has_midi_input = pinfo->needs_midi_input ();
3077         _has_midi_output = false;
3078 }
3079
3080 int
3081 AUPlugin::create_parameter_listener (AUEventListenerProc cb, void* arg, float interval_secs)
3082 {
3083 #ifdef WITH_CARBON
3084         CFRunLoopRef run_loop = (CFRunLoopRef) GetCFRunLoopFromEventLoop(GetCurrentEventLoop());
3085 #else
3086         CFRunLoopRef run_loop = CFRunLoopGetCurrent();
3087 #endif
3088         CFStringRef  loop_mode = kCFRunLoopDefaultMode;
3089
3090         if (AUEventListenerCreate (cb, arg, run_loop, loop_mode, interval_secs, interval_secs, &_parameter_listener) != noErr) {
3091                 return -1;
3092         }
3093
3094         _parameter_listener_arg = arg;
3095
3096         return 0;
3097 }
3098
3099 int
3100 AUPlugin::listen_to_parameter (uint32_t param_id)
3101 {
3102         AudioUnitEvent      event;
3103
3104         if (!_parameter_listener || param_id >= descriptors.size()) {
3105                 return -2;
3106         }
3107
3108         event.mEventType = kAudioUnitEvent_ParameterValueChange;
3109         event.mArgument.mParameter.mAudioUnit = unit->AU();
3110         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3111         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3112         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3113
3114         if (AUEventListenerAddEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3115                 return -1;
3116         }
3117
3118         event.mEventType = kAudioUnitEvent_BeginParameterChangeGesture;
3119         event.mArgument.mParameter.mAudioUnit = unit->AU();
3120         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3121         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3122         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3123
3124         if (AUEventListenerAddEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3125                 return -1;
3126         }
3127
3128         event.mEventType = kAudioUnitEvent_EndParameterChangeGesture;
3129         event.mArgument.mParameter.mAudioUnit = unit->AU();
3130         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3131         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3132         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3133
3134         if (AUEventListenerAddEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3135                 return -1;
3136         }
3137
3138         return 0;
3139 }
3140
3141 int
3142 AUPlugin::end_listen_to_parameter (uint32_t param_id)
3143 {
3144         AudioUnitEvent      event;
3145
3146         if (!_parameter_listener || param_id >= descriptors.size()) {
3147                 return -2;
3148         }
3149
3150         event.mEventType = kAudioUnitEvent_ParameterValueChange;
3151         event.mArgument.mParameter.mAudioUnit = unit->AU();
3152         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3153         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3154         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3155
3156         if (AUEventListenerRemoveEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3157                 return -1;
3158         }
3159
3160         event.mEventType = kAudioUnitEvent_BeginParameterChangeGesture;
3161         event.mArgument.mParameter.mAudioUnit = unit->AU();
3162         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3163         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3164         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3165
3166         if (AUEventListenerRemoveEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3167                 return -1;
3168         }
3169
3170         event.mEventType = kAudioUnitEvent_EndParameterChangeGesture;
3171         event.mArgument.mParameter.mAudioUnit = unit->AU();
3172         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3173         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3174         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3175
3176         if (AUEventListenerRemoveEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3177                 return -1;
3178         }
3179
3180         return 0;
3181 }
3182
3183 void
3184 AUPlugin::_parameter_change_listener (void* arg, void* src, const AudioUnitEvent* event, UInt64 host_time, Float32 new_value)
3185 {
3186         ((AUPlugin*) arg)->parameter_change_listener (arg, src, event, host_time, new_value);
3187 }
3188
3189 void
3190 AUPlugin::parameter_change_listener (void* /*arg*/, void* src, const AudioUnitEvent* event, UInt64 /*host_time*/, Float32 new_value)
3191 {
3192         ParameterMap::iterator i;
3193
3194         if ((i = parameter_map.find (event->mArgument.mParameter.mParameterID)) == parameter_map.end()) {
3195                 return;
3196         }
3197
3198         switch (event->mEventType) {
3199         case kAudioUnitEvent_BeginParameterChangeGesture:
3200                 StartTouch (i->second);
3201                 break;
3202         case kAudioUnitEvent_EndParameterChangeGesture:
3203                 EndTouch (i->second);
3204                 break;
3205         case kAudioUnitEvent_ParameterValueChange:
3206                 /* whenever we change a parameter, we request that we are NOT notified of the change, so anytime we arrive here, it
3207                    means that something else (i.e. the plugin GUI) made the change.
3208                 */
3209                 ParameterChangedExternally (i->second, new_value);
3210                 break;
3211         default:
3212                 break;
3213         }
3214 }