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         //Ardour expects the plugin to tell it the output
1154         //configuration but AU plugins can have multiple I/O
1155         //configurations in most cases. so first lets see
1156         //if there's a configuration that keeps out==in
1157
1158         if (in.n_midi() > 0 && audio_in == 0) {
1159                 audio_out = 2; // prefer stereo version if available.
1160         } else {
1161                 audio_out = audio_in;
1162         }
1163
1164         /* kAudioUnitProperty_SupportedNumChannels
1165          * https://developer.apple.com/library/mac/documentation/MusicAudio/Conceptual/AudioUnitProgrammingGuide/TheAudioUnit/TheAudioUnit.html#//apple_ref/doc/uid/TP40003278-CH12-SW20
1166          *
1167          * - both fields are -1
1168          *   e.g. inChannels = -1 outChannels = -1
1169          *    This is the default case. Any number of input and output channels, as long as the numbers match
1170          *
1171          * - one field is -1, the other field is positive
1172          *   e.g. inChannels = -1 outChannels = 2
1173          *    Any number of input channels, exactly two output channels
1174          *
1175          * - one field is -1, the other field is -2
1176          *   e.g. inChannels = -1 outChannels = -2
1177          *    Any number of input channels, any number of output channels
1178          *
1179          * - both fields have non-negative values
1180          *   e.g. inChannels = 2 outChannels = 6
1181          *    Exactly two input channels, exactly six output channels
1182          *   e.g. inChannels = 0 outChannels = 2
1183          *    No input channels, exactly two output channels (such as for an instrument unit with stereo output)
1184          *
1185          * - both fields have negative values, neither of which is –1 or –2
1186          *   e.g. inChannels = -4 outChannels = -8
1187          *    Up to four input channels and up to eight output channels
1188          */
1189
1190         for (vector<pair<int,int> >::iterator i = io_configs.begin(); i != io_configs.end(); ++i) {
1191
1192                 int32_t possible_in = i->first;
1193                 int32_t possible_out = i->second;
1194
1195                 if ((possible_in == audio_in) && (possible_out == audio_out)) {
1196                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tCHOSEN: %1 in %2 out to match in %3 out %4\n",
1197                                                                         possible_in, possible_out,
1198                                                                         in, out));
1199
1200                         out.set (DataType::MIDI, 0);
1201                         out.set (DataType::AUDIO, audio_out);
1202
1203                         return true;
1204                 }
1205         }
1206
1207         /* now allow potentially "imprecise" matches */
1208         audio_out = -1;
1209         bool found = false;
1210
1211         for (vector<pair<int,int> >::iterator i = io_configs.begin(); i != io_configs.end(); ++i) {
1212
1213                 int32_t possible_in = i->first;
1214                 int32_t possible_out = i->second;
1215
1216                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tpossible in %1 possible out %2\n", possible_in, possible_out));
1217
1218                 if (possible_out == 0) {
1219                         warning << string_compose (_("AU %1 has zero outputs - configuration ignored"), name()) << endmsg;
1220                         /* XXX surely this is just a send? (e.g. AUNetSend) */
1221                         continue;
1222                 }
1223
1224                 if (possible_in == 0) {
1225                         /* no inputs, generators & instruments */
1226                         if (possible_out == -1) {
1227                                 /* any configuration possible, provide stereo output */
1228                                 audio_out = 2;
1229                                 found = true;
1230                         } else if (possible_out == -2) {
1231                                 /* invalid, should be (0, -1) */
1232                                 audio_out = 2;
1233                                 found = true;
1234                         } else if (possible_out < -2) {
1235                                 /* explicitly variable number of outputs. */
1236                                 audio_out = 2;
1237                                 found = true;
1238                         } else {
1239                                 /* exact number of outputs */
1240                                 audio_out = possible_out;
1241                                 found = true;
1242                         }
1243                 }
1244
1245                 if (possible_in == -1) {
1246                         /* wildcard for input */
1247                         if (possible_out == -1) {
1248                                 /* out must match in */
1249                                 audio_out = audio_in;
1250                                 found = true;
1251                         } else if (possible_out == -2) {
1252                                 /* any configuration possible, pick matching */
1253                                 audio_out = audio_in;
1254                                 found = true;
1255                         } else if (possible_out < -2) {
1256                                 /* explicitly variable number of outputs, pick maximum */
1257                                 audio_out = -possible_out;
1258                                 found = true;
1259                         } else {
1260                                 /* exact number of outputs */
1261                                 audio_out = possible_out;
1262                                 found = true;
1263                         }
1264                 }
1265
1266                 if (possible_in == -2) {
1267                         if (possible_out == -1) {
1268                                 /* any configuration possible, pick matching */
1269                                 audio_out = audio_in;
1270                                 found = true;
1271                         } else if (possible_out == -2) {
1272                                 /* invalid. interpret as (-1, -1) */
1273                                 audio_out = audio_in;
1274                                 found = true;
1275                         } else if (possible_out < -2) {
1276                                 /* explicitly variable number of outputs, pick maximum */
1277                                 audio_out = -possible_out;
1278                                 found = true;
1279                         } else {
1280                                 /* exact number of outputs */
1281                                 audio_out = possible_out;
1282                                 found = true;
1283                         }
1284                 }
1285
1286                 if (possible_in < -2) {
1287                         /* explicit variable number of inputs */
1288                         if (audio_in > -possible_in && imprecise != NULL) {
1289                                 // hide inputs ports
1290                                 imprecise->set (DataType::AUDIO, -possible_in);
1291                         }
1292
1293                         if (audio_in > -possible_in && imprecise == NULL) {
1294                                 /* request is too large */
1295                         } else if (possible_out == -1) {
1296                                 /* any output configuration possible, provide stereo out */
1297                                 audio_out = 2;
1298                                 found = true;
1299                         } else if (possible_out == -2) {
1300                                 /* invalid. interpret as (<-2, -1) */
1301                                 audio_out = 2;
1302                                 found = true;
1303                         } else if (possible_out < -2) {
1304                                 /* explicitly variable number of outputs, pick stereo */
1305                                 audio_out = 2;
1306                                 found = true;
1307                         } else {
1308                                 /* exact number of outputs */
1309                                 audio_out = possible_out;
1310                                 found = true;
1311                         }
1312                 }
1313
1314                 if (possible_in && (possible_in == audio_in)) {
1315                         /* exact number of inputs ... must match obviously */
1316                         if (possible_out == -1) {
1317                                 /* any output configuration possible, provide stereo output */
1318                                 audio_out = 2;
1319                                 found = true;
1320                         } else if (possible_out == -2) {
1321                                 /* plugins shouldn't really use (>0,-2) but might.
1322                                    interpret as (>0,-1):
1323                                    any output configuration possible, provide stereo output
1324                                 */
1325                                 audio_out = 2;
1326                                 found = true;
1327                         } else if (possible_out < -2) {
1328                                 /* explicitly variable number of outputs, pick maximum */
1329                                 audio_out = -possible_out;
1330                                 found = true;
1331                         } else {
1332                                 /* exact number of outputs */
1333                                 audio_out = possible_out;
1334                                 found = true;
1335                         }
1336                 }
1337
1338                 if (found) {
1339                         if (possible_in < -2 && audio_in == 0) {
1340                                 // input-port count cannot be zero, use as many ports
1341                                 // as outputs, but at most abs(possible_in)
1342                                 audio_input_cnt = max (1, min (audio_out, -possible_in));
1343                         }
1344                         break;
1345                 }
1346
1347         }
1348         if (!found && imprecise) {
1349                 /* try harder */
1350                 for (vector<pair<int,int> >::iterator i = io_configs.begin(); i != io_configs.end(); ++i) {
1351                         int32_t possible_in = i->first;
1352                         int32_t possible_out = i->second;
1353
1354                         assert (possible_in > 0); // all other cases will have been matched above
1355                         assert (possible_out !=0 || possible_in !=0); // already handled above
1356
1357                         imprecise->set (DataType::AUDIO, possible_in);
1358                         if (possible_out == -1 || possible_out == -2) {
1359                                 audio_out = 2;
1360                                 found = true;
1361                         } else if (possible_out < -2) {
1362                                 /* explicitly variable number of outputs, pick maximum */
1363                                 audio_out = -possible_out;
1364                                 found = true;
1365                         } else {
1366                                 /* exact number of outputs */
1367                                 audio_out = possible_out;
1368                                 found = true;
1369                         }
1370
1371                         if (found) {
1372                                 // ideally we'll keep iterating and take the "best match"
1373                                 // whatever "best" means:
1374                                 // least unconnected inputs, least silenced inputs,
1375                                 // closest match of inputs == outputs
1376                                 break;
1377                         }
1378                 }
1379         }
1380
1381         if (found) {
1382                 out.set (DataType::MIDI, 0); /// XXX
1383                 out.set (DataType::AUDIO, audio_out);
1384                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tCHOSEN: in %1 out %2\n", in, out));
1385         } else {
1386                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("\tFAIL: no io configs match %1\n", in));
1387                 return false;
1388         }
1389
1390         return true;
1391 }
1392
1393 int
1394 AUPlugin::set_input_format (AudioStreamBasicDescription& fmt)
1395 {
1396         return set_stream_format (kAudioUnitScope_Input, input_elements, fmt);
1397 }
1398
1399 int
1400 AUPlugin::set_output_format (AudioStreamBasicDescription& fmt)
1401 {
1402         if (set_stream_format (kAudioUnitScope_Output, output_elements, fmt) != 0) {
1403                 return -1;
1404         }
1405
1406         if (buffers) {
1407                 free (buffers);
1408                 buffers = 0;
1409         }
1410
1411         buffers = (AudioBufferList *) malloc (offsetof(AudioBufferList, mBuffers) +
1412                                               fmt.mChannelsPerFrame * sizeof(::AudioBuffer));
1413
1414         return 0;
1415 }
1416
1417 int
1418 AUPlugin::set_stream_format (int scope, uint32_t cnt, AudioStreamBasicDescription& fmt)
1419 {
1420         OSErr result;
1421
1422         for (uint32_t i = 0; i < cnt; ++i) {
1423                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("set stream format for %1, scope = %2 element %3\n",
1424                                                                 (scope == kAudioUnitScope_Input ? "input" : "output"),
1425                                                                 scope, cnt));
1426                 if ((result = unit->SetFormat (scope, i, fmt)) != 0) {
1427                         error << string_compose (_("AUPlugin: could not set stream format for %1/%2 (err = %3)"),
1428                                                  (scope == kAudioUnitScope_Input ? "input" : "output"), i, result) << endmsg;
1429                         return -1;
1430                 }
1431         }
1432
1433         if (scope == kAudioUnitScope_Input) {
1434                 input_channels = fmt.mChannelsPerFrame;
1435         } else {
1436                 output_channels = fmt.mChannelsPerFrame;
1437         }
1438
1439         return 0;
1440 }
1441
1442 OSStatus
1443 AUPlugin::render_callback(AudioUnitRenderActionFlags*,
1444                           const AudioTimeStamp*,
1445                           UInt32,
1446                           UInt32       inNumberFrames,
1447                           AudioBufferList*       ioData)
1448 {
1449         /* not much to do with audio - the data is already in the buffers given to us in connect_and_run() */
1450
1451         // DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1: render callback, frames %2 bufs %3\n",
1452         // name(), inNumberFrames, ioData->mNumberBuffers));
1453
1454         if (input_maxbuf == 0) {
1455                 error << _("AUPlugin: render callback called illegally!") << endmsg;
1456                 return kAudioUnitErr_CannotDoInCurrentContext;
1457         }
1458         uint32_t limit = min ((uint32_t) ioData->mNumberBuffers, input_maxbuf);
1459
1460         ChanCount bufs_count (DataType::AUDIO, 1);
1461         BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
1462
1463         for (uint32_t i = 0; i < limit; ++i) {
1464                 ioData->mBuffers[i].mNumberChannels = 1;
1465                 ioData->mBuffers[i].mDataByteSize = sizeof (Sample) * inNumberFrames;
1466
1467                 bool valid = false;
1468                 uint32_t idx = input_map->get (DataType::AUDIO, i, &valid);
1469                 if (valid) {
1470                         ioData->mBuffers[i].mData = input_buffers->get_audio (idx).data (cb_offset + input_offset);
1471                 } else {
1472                         ioData->mBuffers[i].mData = silent_bufs.get_audio(0).data (cb_offset + input_offset);
1473                 }
1474         }
1475
1476         cb_offset += inNumberFrames;
1477
1478         return noErr;
1479 }
1480
1481 int
1482 AUPlugin::connect_and_run (BufferSet& bufs, ChanMapping in_map, ChanMapping out_map, pframes_t nframes, framecnt_t offset)
1483 {
1484         Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
1485
1486         AudioUnitRenderActionFlags flags = 0;
1487         AudioTimeStamp ts;
1488         OSErr err;
1489
1490         if (requires_fixed_size_buffers() && (nframes != _last_nframes)) {
1491                 unit->GlobalReset();
1492                 _last_nframes = nframes;
1493         }
1494
1495         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1 in %2 out %3 MIDI %4 bufs %5 (available %6)\n",
1496                                 name(), input_channels, output_channels, _has_midi_input,
1497                                 bufs.count(), bufs.available()));
1498
1499         /* the apparent number of buffers matches our input configuration, but we know that the bufferset
1500            has the capacity to handle our outputs.
1501            */
1502
1503         assert (bufs.available() >= ChanCount (DataType::AUDIO, output_channels));
1504
1505         input_buffers = &bufs;
1506         input_map = &in_map;
1507         input_maxbuf = bufs.count().n_audio(); // number of input audio buffers
1508         input_offset = offset;
1509         cb_offset = 0;
1510
1511         buffers->mNumberBuffers = output_channels;
1512         bool inplace = in_map == out_map;
1513
1514         ChanCount bufs_count (DataType::AUDIO, 1);
1515         BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
1516
1517         for (int32_t i = 0; i < output_channels; ++i) {
1518                 buffers->mBuffers[i].mNumberChannels = 1;
1519                 buffers->mBuffers[i].mDataByteSize = nframes * sizeof (Sample);
1520                 /* setting this to 0 indicates to the AU that it can provide buffers here
1521                  * if necessary. if it can process in-place, it will use the buffers provided
1522                  * as input by ::render_callback() above.
1523                  *
1524                  * a non-null values tells the plugin to render into the buffer pointed
1525                  * at by the value.
1526                  */
1527                 if (inplace) {
1528                         buffers->mBuffers[i].mData = 0;
1529                 } else {
1530                         bool valid = false;
1531                         uint32_t idx = out_map.get (DataType::AUDIO, i, &valid);
1532                         if (valid) {
1533                                 buffers->mBuffers[i].mData = bufs.get_audio (idx).data (offset);
1534                         } else {
1535                                 buffers->mBuffers[i].mData = scratch_bufs.get_audio(0).data(offset);
1536                         }
1537                 }
1538         }
1539
1540         if (_has_midi_input) {
1541
1542                 uint32_t nmidi = bufs.count().n_midi();
1543
1544                 for (uint32_t i = 0; i < nmidi; ++i) {
1545
1546                         /* one MIDI port/buffer only */
1547
1548                                 MidiBuffer& m = bufs.get_midi (i);
1549
1550                                 for (MidiBuffer::iterator i = m.begin(); i != m.end(); ++i) {
1551                                         Evoral::MIDIEvent<framepos_t> ev (*i);
1552
1553                                         if (ev.is_channel_event()) {
1554                                                 const uint8_t* b = ev.buffer();
1555                                                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1: MIDI event %2\n", name(), ev));
1556                                                 unit->MIDIEvent (b[0], b[1], b[2], ev.time());
1557                                         }
1558
1559                                         /* XXX need to handle sysex and other message types */
1560                                 }
1561                         }
1562                 }
1563
1564                 /* does this really mean anything ?
1565                 */
1566
1567                 ts.mSampleTime = frames_processed;
1568                 ts.mFlags = kAudioTimeStampSampleTimeValid;
1569
1570                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1 render flags=%2 time=%3 nframes=%4 buffers=%5\n",
1571                                         name(), flags, frames_processed, nframes, buffers->mNumberBuffers));
1572
1573                 if ((err = unit->Render (&flags, &ts, 0, nframes, buffers)) == noErr) {
1574
1575                         input_maxbuf = 0;
1576                         frames_processed += nframes;
1577
1578                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("%1 rendered %2 buffers of %3\n",
1579                                                 name(), buffers->mNumberBuffers, output_channels));
1580
1581                         int32_t limit = min ((int32_t) buffers->mNumberBuffers, output_channels);
1582                         int32_t i;
1583
1584                         for (i = 0; i < limit; ++i) {
1585                                 // we know in_map == out_map
1586                                 bool valid = false;
1587                                 uint32_t idx = out_map.get (DataType::AUDIO, i, &valid);
1588                                 if (!valid) continue;
1589                                 Sample* expected_buffer_address = bufs.get_audio (idx).data (offset);
1590                                 if (expected_buffer_address != buffers->mBuffers[i].mData) {
1591                                         /* plugin provided its own buffer for output so copy it back to where we want it
1592                                         */
1593                                         memcpy (expected_buffer_address, buffers->mBuffers[i].mData, nframes * sizeof (Sample));
1594                                 }
1595                         }
1596
1597                 /* now silence any buffers that were passed in but the that the plugin
1598                  * did not fill/touch/use.
1599                  */
1600
1601                 for (;i < output_channels; ++i) {
1602                         bool valid = false;
1603                         uint32_t idx = out_map.get (DataType::AUDIO, i, &valid);
1604                         if (!valid) continue;
1605                         memset (bufs.get_audio (idx).data (offset), 0, nframes * sizeof (Sample));
1606                 }
1607
1608                 return 0;
1609         }
1610
1611         error << string_compose (_("AU: render error for %1, status = %2"), name(), err) << endmsg;
1612         return -1;
1613 }
1614
1615 OSStatus
1616 AUPlugin::get_beat_and_tempo_callback (Float64* outCurrentBeat,
1617                                        Float64* outCurrentTempo)
1618 {
1619         TempoMap& tmap (_session.tempo_map());
1620
1621         DEBUG_TRACE (DEBUG::AudioUnits, "AU calls ardour beat&tempo callback\n");
1622
1623         /* more than 1 meter or more than 1 tempo means that a simplistic computation
1624            (and interpretation) of a beat position will be incorrect. So refuse to
1625            offer the value.
1626         */
1627
1628         if (tmap.n_tempos() > 1 || tmap.n_meters() > 1) {
1629                 return kAudioUnitErr_CannotDoInCurrentContext;
1630         }
1631
1632         Timecode::BBT_Time bbt;
1633         TempoMetric metric = tmap.metric_at (_session.transport_frame() + input_offset);
1634         tmap.bbt_time (_session.transport_frame() + input_offset, bbt);
1635
1636         if (outCurrentBeat) {
1637                 float beat;
1638                 beat = metric.meter().divisions_per_bar() * bbt.bars;
1639                 beat += bbt.beats;
1640                 beat += bbt.ticks / Timecode::BBT_Time::ticks_per_beat;
1641                 *outCurrentBeat = beat;
1642         }
1643
1644         if (outCurrentTempo) {
1645                 *outCurrentTempo = floor (metric.tempo().beats_per_minute());
1646         }
1647
1648         return noErr;
1649
1650 }
1651
1652 OSStatus
1653 AUPlugin::get_musical_time_location_callback (UInt32*   outDeltaSampleOffsetToNextBeat,
1654                                               Float32*  outTimeSig_Numerator,
1655                                               UInt32*   outTimeSig_Denominator,
1656                                               Float64*  outCurrentMeasureDownBeat)
1657 {
1658         TempoMap& tmap (_session.tempo_map());
1659
1660         DEBUG_TRACE (DEBUG::AudioUnits, "AU calls ardour music time location callback\n");
1661
1662         /* more than 1 meter or more than 1 tempo means that a simplistic computation
1663            (and interpretation) of a beat position will be incorrect. So refuse to
1664            offer the value.
1665         */
1666
1667         if (tmap.n_tempos() > 1 || tmap.n_meters() > 1) {
1668                 return kAudioUnitErr_CannotDoInCurrentContext;
1669         }
1670
1671         Timecode::BBT_Time bbt;
1672         TempoMetric metric = tmap.metric_at (_session.transport_frame() + input_offset);
1673         tmap.bbt_time (_session.transport_frame() + input_offset, bbt);
1674
1675         if (outDeltaSampleOffsetToNextBeat) {
1676                 if (bbt.ticks == 0) {
1677                         /* on the beat */
1678                         *outDeltaSampleOffsetToNextBeat = 0;
1679                 } else {
1680                         *outDeltaSampleOffsetToNextBeat = (UInt32)
1681                                 floor (((Timecode::BBT_Time::ticks_per_beat - bbt.ticks)/Timecode::BBT_Time::ticks_per_beat) * // fraction of a beat to next beat
1682                                        metric.tempo().frames_per_beat (_session.frame_rate())); // frames per beat
1683                 }
1684         }
1685
1686         if (outTimeSig_Numerator) {
1687                 *outTimeSig_Numerator = (UInt32) lrintf (metric.meter().divisions_per_bar());
1688         }
1689         if (outTimeSig_Denominator) {
1690                 *outTimeSig_Denominator = (UInt32) lrintf (metric.meter().note_divisor());
1691         }
1692
1693         if (outCurrentMeasureDownBeat) {
1694
1695                 /* beat for the start of the bar.
1696                    1|1|0 -> 1
1697                    2|1|0 -> 1 + divisions_per_bar
1698                    3|1|0 -> 1 + (2 * divisions_per_bar)
1699                    etc.
1700                 */
1701
1702                 *outCurrentMeasureDownBeat = 1 + metric.meter().divisions_per_bar() * (bbt.bars - 1);
1703         }
1704
1705         return noErr;
1706 }
1707
1708 OSStatus
1709 AUPlugin::get_transport_state_callback (Boolean*  outIsPlaying,
1710                                         Boolean*  outTransportStateChanged,
1711                                         Float64*  outCurrentSampleInTimeLine,
1712                                         Boolean*  outIsCycling,
1713                                         Float64*  outCycleStartBeat,
1714                                         Float64*  outCycleEndBeat)
1715 {
1716         bool rolling;
1717         float speed;
1718
1719         DEBUG_TRACE (DEBUG::AudioUnits, "AU calls ardour transport state callback\n");
1720
1721         rolling = _session.transport_rolling();
1722         speed = _session.transport_speed ();
1723
1724         if (outIsPlaying) {
1725                 *outIsPlaying = _session.transport_rolling();
1726         }
1727
1728         if (outTransportStateChanged) {
1729                 if (rolling != last_transport_rolling) {
1730                         *outTransportStateChanged = true;
1731                 } else if (speed != last_transport_speed) {
1732                         *outTransportStateChanged = true;
1733                 } else {
1734                         *outTransportStateChanged = false;
1735                 }
1736         }
1737
1738         if (outCurrentSampleInTimeLine) {
1739                 /* this assumes that the AU can only call this host callback from render context,
1740                    where input_offset is valid.
1741                 */
1742                 *outCurrentSampleInTimeLine = _session.transport_frame() + input_offset;
1743         }
1744
1745         if (outIsCycling) {
1746                 Location* loc = _session.locations()->auto_loop_location();
1747
1748                 *outIsCycling = (loc && _session.transport_rolling() && _session.get_play_loop());
1749
1750                 if (*outIsCycling) {
1751
1752                         if (outCycleStartBeat || outCycleEndBeat) {
1753
1754                                 TempoMap& tmap (_session.tempo_map());
1755
1756                                 /* more than 1 meter means that a simplistic computation (and interpretation) of
1757                                    a beat position will be incorrect. so refuse to offer the value.
1758                                 */
1759
1760                                 if (tmap.n_meters() > 1) {
1761                                         return kAudioUnitErr_CannotDoInCurrentContext;
1762                                 }
1763
1764                                 Timecode::BBT_Time bbt;
1765
1766                                 if (outCycleStartBeat) {
1767                                         TempoMetric metric = tmap.metric_at (loc->start() + input_offset);
1768                                         _session.tempo_map().bbt_time (loc->start(), bbt);
1769
1770                                         float beat;
1771                                         beat = metric.meter().divisions_per_bar() * bbt.bars;
1772                                         beat += bbt.beats;
1773                                         beat += bbt.ticks / Timecode::BBT_Time::ticks_per_beat;
1774
1775                                         *outCycleStartBeat = beat;
1776                                 }
1777
1778                                 if (outCycleEndBeat) {
1779                                         TempoMetric metric = tmap.metric_at (loc->end() + input_offset);
1780                                         _session.tempo_map().bbt_time (loc->end(), bbt);
1781
1782                                         float beat;
1783                                         beat = metric.meter().divisions_per_bar() * bbt.bars;
1784                                         beat += bbt.beats;
1785                                         beat += bbt.ticks / Timecode::BBT_Time::ticks_per_beat;
1786
1787                                         *outCycleEndBeat = beat;
1788                                 }
1789                         }
1790                 }
1791         }
1792
1793         last_transport_rolling = rolling;
1794         last_transport_speed = speed;
1795
1796         return noErr;
1797 }
1798
1799 set<Evoral::Parameter>
1800 AUPlugin::automatable() const
1801 {
1802         set<Evoral::Parameter> automates;
1803
1804         for (uint32_t i = 0; i < descriptors.size(); ++i) {
1805                 if (descriptors[i].automatable) {
1806                         automates.insert (automates.end(), Evoral::Parameter (PluginAutomation, 0, i));
1807                 }
1808         }
1809
1810         return automates;
1811 }
1812
1813 string
1814 AUPlugin::describe_parameter (Evoral::Parameter param)
1815 {
1816         if (param.type() == PluginAutomation && param.id() < parameter_count()) {
1817                 return descriptors[param.id()].label;
1818         } else {
1819                 return "??";
1820         }
1821 }
1822
1823 void
1824 AUPlugin::print_parameter (uint32_t /*param*/, char* /*buf*/, uint32_t /*len*/) const
1825 {
1826         // NameValue stuff here
1827 }
1828
1829 bool
1830 AUPlugin::parameter_is_audio (uint32_t) const
1831 {
1832         return false;
1833 }
1834
1835 bool
1836 AUPlugin::parameter_is_control (uint32_t param) const
1837 {
1838         assert(param < descriptors.size());
1839         if (descriptors[param].automatable) {
1840                 /* corrently ardour expects all controls to be automatable
1841                  * IOW ardour GUI elements mandate an Evoral::Parameter
1842                  * for all input+control ports.
1843                  */
1844                 return true;
1845         }
1846         return false;
1847 }
1848
1849 bool
1850 AUPlugin::parameter_is_input (uint32_t param) const
1851 {
1852         /* AU params that are both readable and writeable,
1853          * are listed in kAudioUnitScope_Global
1854          */
1855         return (descriptors[param].scope == kAudioUnitScope_Input || descriptors[param].scope == kAudioUnitScope_Global);
1856 }
1857
1858 bool
1859 AUPlugin::parameter_is_output (uint32_t param) const
1860 {
1861         assert(param < descriptors.size());
1862         // TODO check if ardour properly handles ports
1863         // that report is_input + is_output == true
1864         // -> add || descriptors[param].scope == kAudioUnitScope_Global
1865         return (descriptors[param].scope == kAudioUnitScope_Output);
1866 }
1867
1868 void
1869 AUPlugin::add_state (XMLNode* root) const
1870 {
1871         LocaleGuard lg (X_("C"));
1872         CFDataRef xmlData;
1873         CFPropertyListRef propertyList;
1874
1875         DEBUG_TRACE (DEBUG::AudioUnits, "get preset state\n");
1876         if (unit->GetAUPreset (propertyList) != noErr) {
1877                 return;
1878         }
1879
1880         // Convert the property list into XML data.
1881
1882         xmlData = CFPropertyListCreateXMLData( kCFAllocatorDefault, propertyList);
1883
1884         if (!xmlData) {
1885                 error << _("Could not create XML version of property list") << endmsg;
1886                 return;
1887         }
1888
1889         /* re-parse XML bytes to create a libxml++ XMLTree that we can merge into
1890            our state node. GACK!
1891         */
1892
1893         XMLTree t;
1894
1895         if (t.read_buffer (string ((const char*) CFDataGetBytePtr (xmlData), CFDataGetLength (xmlData)))) {
1896                 if (t.root()) {
1897                         root->add_child_copy (*t.root());
1898                 }
1899         }
1900
1901         CFRelease (xmlData);
1902         CFRelease (propertyList);
1903 }
1904
1905 int
1906 AUPlugin::set_state(const XMLNode& node, int version)
1907 {
1908         int ret = -1;
1909         CFPropertyListRef propertyList;
1910         LocaleGuard lg (X_("C"));
1911
1912         if (node.name() != state_node_name()) {
1913                 error << _("Bad node sent to AUPlugin::set_state") << endmsg;
1914                 return -1;
1915         }
1916
1917 #ifndef NO_PLUGIN_STATE
1918         if (node.children().empty()) {
1919                 return -1;
1920         }
1921
1922         XMLNode* top = node.children().front();
1923         XMLNode* copy = new XMLNode (*top);
1924
1925         XMLTree t;
1926         t.set_root (copy);
1927
1928         const string& xml = t.write_buffer ();
1929         CFDataRef xmlData = CFDataCreateWithBytesNoCopy (kCFAllocatorDefault, (UInt8*) xml.data(), xml.length(), kCFAllocatorNull);
1930         CFStringRef errorString;
1931
1932         propertyList = CFPropertyListCreateFromXMLData( kCFAllocatorDefault,
1933                                                         xmlData,
1934                                                         kCFPropertyListImmutable,
1935                                                         &errorString);
1936
1937         CFRelease (xmlData);
1938
1939         if (propertyList) {
1940                 DEBUG_TRACE (DEBUG::AudioUnits, "set preset\n");
1941                 if (unit->SetAUPreset (propertyList) == noErr) {
1942                         ret = 0;
1943
1944                         /* tell the world */
1945
1946                         AudioUnitParameter changedUnit;
1947                         changedUnit.mAudioUnit = unit->AU();
1948                         changedUnit.mParameterID = kAUParameterListener_AnyParameter;
1949                         AUParameterListenerNotify (NULL, NULL, &changedUnit);
1950                 }
1951                 CFRelease (propertyList);
1952         }
1953 #endif
1954
1955         Plugin::set_state (node, version);
1956         return ret;
1957 }
1958
1959 bool
1960 AUPlugin::load_preset (PresetRecord r)
1961 {
1962         Plugin::load_preset (r);
1963
1964         bool ret = false;
1965         CFPropertyListRef propertyList;
1966         Glib::ustring path;
1967         UserPresetMap::iterator ux;
1968         FactoryPresetMap::iterator fx;
1969
1970         /* look first in "user" presets */
1971
1972         if ((ux = user_preset_map.find (r.label)) != user_preset_map.end()) {
1973
1974                 if ((propertyList = load_property_list (ux->second)) != 0) {
1975                         DEBUG_TRACE (DEBUG::AudioUnits, "set preset from user presets\n");
1976                         if (unit->SetAUPreset (propertyList) == noErr) {
1977                                 ret = true;
1978
1979                                 /* tell the world */
1980
1981                                 AudioUnitParameter changedUnit;
1982                                 changedUnit.mAudioUnit = unit->AU();
1983                                 changedUnit.mParameterID = kAUParameterListener_AnyParameter;
1984                                 AUParameterListenerNotify (NULL, NULL, &changedUnit);
1985                         }
1986                         CFRelease(propertyList);
1987                 }
1988
1989         } else if ((fx = factory_preset_map.find (r.label)) != factory_preset_map.end()) {
1990
1991                 AUPreset preset;
1992
1993                 preset.presetNumber = fx->second;
1994                 preset.presetName = CFStringCreateWithCString (kCFAllocatorDefault, fx->first.c_str(), kCFStringEncodingUTF8);
1995
1996                 DEBUG_TRACE (DEBUG::AudioUnits, "set preset from factory presets\n");
1997
1998                 if (unit->SetPresentPreset (preset) == 0) {
1999                         ret = true;
2000
2001                         /* tell the world */
2002
2003                         AudioUnitParameter changedUnit;
2004                         changedUnit.mAudioUnit = unit->AU();
2005                         changedUnit.mParameterID = kAUParameterListener_AnyParameter;
2006                         AUParameterListenerNotify (NULL, NULL, &changedUnit);
2007                 }
2008         }
2009
2010         return ret;
2011 }
2012
2013 void
2014 AUPlugin::do_remove_preset (std::string)
2015 {
2016 }
2017
2018 string
2019 AUPlugin::do_save_preset (string preset_name)
2020 {
2021         CFPropertyListRef propertyList;
2022         vector<Glib::ustring> v;
2023         Glib::ustring user_preset_path;
2024
2025         std::string m = maker();
2026         std::string n = name();
2027
2028         strip_whitespace_edges (m);
2029         strip_whitespace_edges (n);
2030
2031         v.push_back (Glib::get_home_dir());
2032         v.push_back ("Library");
2033         v.push_back ("Audio");
2034         v.push_back ("Presets");
2035         v.push_back (m);
2036         v.push_back (n);
2037
2038         user_preset_path = Glib::build_filename (v);
2039
2040         if (g_mkdir_with_parents (user_preset_path.c_str(), 0775) < 0) {
2041                 error << string_compose (_("Cannot create user plugin presets folder (%1)"), user_preset_path) << endmsg;
2042                 return string();
2043         }
2044
2045         DEBUG_TRACE (DEBUG::AudioUnits, "get current preset\n");
2046         if (unit->GetAUPreset (propertyList) != noErr) {
2047                 return string();
2048         }
2049
2050         // add the actual preset name */
2051
2052         v.push_back (preset_name + preset_suffix);
2053
2054         // rebuild
2055
2056         user_preset_path = Glib::build_filename (v);
2057
2058         set_preset_name_in_plist (propertyList, preset_name);
2059
2060         if (save_property_list (propertyList, user_preset_path)) {
2061                 error << string_compose (_("Saving plugin state to %1 failed"), user_preset_path) << endmsg;
2062                 return string();
2063         }
2064
2065         CFRelease(propertyList);
2066
2067         user_preset_map[preset_name] = user_preset_path;;
2068
2069         DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Saving Preset to %1\n", user_preset_path));
2070
2071         return string ("file:///") + user_preset_path;
2072 }
2073
2074 //-----------------------------------------------------------------------------
2075 // this is just a little helper function used by GetAUComponentDescriptionFromPresetFile()
2076 static SInt32
2077 GetDictionarySInt32Value(CFDictionaryRef inAUStateDictionary, CFStringRef inDictionaryKey, Boolean * outSuccess)
2078 {
2079         CFNumberRef cfNumber;
2080         SInt32 numberValue = 0;
2081         Boolean dummySuccess;
2082
2083         if (outSuccess == NULL)
2084                 outSuccess = &dummySuccess;
2085         if ( (inAUStateDictionary == NULL) || (inDictionaryKey == NULL) )
2086         {
2087                 *outSuccess = FALSE;
2088                 return 0;
2089         }
2090
2091         cfNumber = (CFNumberRef) CFDictionaryGetValue(inAUStateDictionary, inDictionaryKey);
2092         if (cfNumber == NULL)
2093         {
2094                 *outSuccess = FALSE;
2095                 return 0;
2096         }
2097         *outSuccess = CFNumberGetValue(cfNumber, kCFNumberSInt32Type, &numberValue);
2098         if (*outSuccess)
2099                 return numberValue;
2100         else
2101                 return 0;
2102 }
2103
2104 static OSStatus
2105 GetAUComponentDescriptionFromStateData(CFPropertyListRef inAUStateData, ArdourDescription * outComponentDescription)
2106 {
2107         CFDictionaryRef auStateDictionary;
2108         ArdourDescription tempDesc = {0,0,0,0,0};
2109         SInt32 versionValue;
2110         Boolean gotValue;
2111
2112         if ( (inAUStateData == NULL) || (outComponentDescription == NULL) )
2113                 return paramErr;
2114
2115         // the property list for AU state data must be of the dictionary type
2116         if (CFGetTypeID(inAUStateData) != CFDictionaryGetTypeID()) {
2117                 return kAudioUnitErr_InvalidPropertyValue;
2118         }
2119
2120         auStateDictionary = (CFDictionaryRef)inAUStateData;
2121
2122         // first check to make sure that the version of the AU state data is one that we know understand
2123         // XXX should I really do this?  later versions would probably still hold these ID keys, right?
2124         versionValue = GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetVersionKey), &gotValue);
2125
2126         if (!gotValue) {
2127                 return kAudioUnitErr_InvalidPropertyValue;
2128         }
2129 #define kCurrentSavedStateVersion 0
2130         if (versionValue != kCurrentSavedStateVersion) {
2131                 return kAudioUnitErr_InvalidPropertyValue;
2132         }
2133
2134         // grab the ComponentDescription values from the AU state data
2135         tempDesc.componentType = (OSType) GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetTypeKey), NULL);
2136         tempDesc.componentSubType = (OSType) GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetSubtypeKey), NULL);
2137         tempDesc.componentManufacturer = (OSType) GetDictionarySInt32Value(auStateDictionary, CFSTR(kAUPresetManufacturerKey), NULL);
2138         // zero values are illegit for specific ComponentDescriptions, so zero for any value means that there was an error
2139         if ( (tempDesc.componentType == 0) || (tempDesc.componentSubType == 0) || (tempDesc.componentManufacturer == 0) )
2140                 return kAudioUnitErr_InvalidPropertyValue;
2141
2142         *outComponentDescription = tempDesc;
2143         return noErr;
2144 }
2145
2146
2147 static bool au_preset_filter (const string& str, void* arg)
2148 {
2149         /* Not a dotfile, has a prefix before a period, suffix is aupreset */
2150
2151         bool ret;
2152
2153         ret = (str[0] != '.' && str.length() > 9 && str.find (preset_suffix) == (str.length() - preset_suffix.length()));
2154
2155         if (ret && arg) {
2156
2157                 /* check the preset file path name against this plugin
2158                    ID. The idea is that all preset files for this plugin
2159                    include "<manufacturer>/<plugin-name>" in their path.
2160                 */
2161
2162                 AUPluginInfo* p = (AUPluginInfo *) arg;
2163                 string match = p->creator;
2164                 match += '/';
2165                 match += p->name;
2166
2167                 ret = str.find (match) != string::npos;
2168
2169                 if (ret == false) {
2170                         string m = p->creator;
2171                         string n = p->name;
2172                         strip_whitespace_edges (m);
2173                         strip_whitespace_edges (n);
2174                         match = m;
2175                         match += '/';
2176                         match += n;
2177
2178                         ret = str.find (match) != string::npos;
2179                 }
2180         }
2181
2182         return ret;
2183 }
2184
2185 static bool
2186 check_and_get_preset_name (ArdourComponent component, const string& pathstr, string& preset_name)
2187 {
2188         OSStatus status;
2189         CFPropertyListRef plist;
2190         ArdourDescription presetDesc;
2191         bool ret = false;
2192
2193         plist = load_property_list (pathstr);
2194
2195         if (!plist) {
2196                 return ret;
2197         }
2198
2199         // get the ComponentDescription from the AU preset file
2200
2201         status = GetAUComponentDescriptionFromStateData(plist, &presetDesc);
2202
2203         if (status == noErr) {
2204                 if (ComponentAndDescriptionMatch_Loosely(component, &presetDesc)) {
2205
2206                         /* try to get the preset name from the property list */
2207
2208                         if (CFGetTypeID(plist) == CFDictionaryGetTypeID()) {
2209
2210                                 const void* psk = CFDictionaryGetValue ((CFMutableDictionaryRef)plist, CFSTR(kAUPresetNameKey));
2211
2212                                 if (psk) {
2213
2214                                         const char* p = CFStringGetCStringPtr ((CFStringRef) psk, kCFStringEncodingUTF8);
2215
2216                                         if (!p) {
2217                                                 char buf[PATH_MAX+1];
2218
2219                                                 if (CFStringGetCString ((CFStringRef)psk, buf, sizeof (buf), kCFStringEncodingUTF8)) {
2220                                                         preset_name = buf;
2221                                                 }
2222                                         }
2223                                 }
2224                         }
2225                 }
2226         }
2227
2228         CFRelease (plist);
2229
2230         return true;
2231 }
2232
2233
2234 static void
2235 #ifdef COREAUDIO105
2236 get_names (CAComponentDescription& comp_desc, std::string& name, std::string& maker)
2237 #else
2238 get_names (ArdourComponent& comp, std::string& name, std::string& maker)
2239 #endif
2240 {
2241         CFStringRef itemName = NULL;
2242         // Marc Poirier-style item name
2243 #ifdef COREAUDIO105
2244         CAComponent auComponent (comp_desc);
2245         if (auComponent.IsValid()) {
2246                 CAComponentDescription dummydesc;
2247                 Handle nameHandle = NewHandle(sizeof(void*));
2248                 if (nameHandle != NULL) {
2249                         OSErr err = GetComponentInfo(auComponent.Comp(), &dummydesc, nameHandle, NULL, NULL);
2250                         if (err == noErr) {
2251                                 ConstStr255Param nameString = (ConstStr255Param) (*nameHandle);
2252                                 if (nameString != NULL) {
2253                                         itemName = CFStringCreateWithPascalString(kCFAllocatorDefault, nameString, CFStringGetSystemEncoding());
2254                                 }
2255                         }
2256                         DisposeHandle(nameHandle);
2257                 }
2258         }
2259 #else
2260         assert (comp);
2261         AudioComponentCopyName (comp, &itemName);
2262 #endif
2263
2264         // if Marc-style fails, do the original way
2265         if (itemName == NULL) {
2266 #ifndef COREAUDIO105
2267                 CAComponentDescription comp_desc;
2268                 AudioComponentGetDescription (comp, &comp_desc);
2269 #endif
2270                 CFStringRef compTypeString = UTCreateStringForOSType(comp_desc.componentType);
2271                 CFStringRef compSubTypeString = UTCreateStringForOSType(comp_desc.componentSubType);
2272                 CFStringRef compManufacturerString = UTCreateStringForOSType(comp_desc.componentManufacturer);
2273
2274                 itemName = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR("%@ - %@ - %@"),
2275                                 compTypeString, compManufacturerString, compSubTypeString);
2276
2277                 if (compTypeString != NULL)
2278                         CFRelease(compTypeString);
2279                 if (compSubTypeString != NULL)
2280                         CFRelease(compSubTypeString);
2281                 if (compManufacturerString != NULL)
2282                         CFRelease(compManufacturerString);
2283         }
2284
2285         string str = CFStringRefToStdString(itemName);
2286         string::size_type colon = str.find (':');
2287
2288         if (colon) {
2289                 name = str.substr (colon+1);
2290                 maker = str.substr (0, colon);
2291                 strip_whitespace_edges (maker);
2292                 strip_whitespace_edges (name);
2293         } else {
2294                 name = str;
2295                 maker = "unknown";
2296                 strip_whitespace_edges (name);
2297         }
2298 }
2299
2300 std::string
2301 AUPlugin::current_preset() const
2302 {
2303         string preset_name;
2304
2305         CFPropertyListRef propertyList;
2306
2307         DEBUG_TRACE (DEBUG::AudioUnits, "get current preset for current_preset()\n");
2308         if (unit->GetAUPreset (propertyList) == noErr) {
2309                 preset_name = get_preset_name_in_plist (propertyList);
2310                 CFRelease(propertyList);
2311         }
2312
2313         return preset_name;
2314 }
2315
2316 void
2317 AUPlugin::find_presets ()
2318 {
2319         vector<string> preset_files;
2320
2321         user_preset_map.clear ();
2322
2323         PluginInfoPtr nfo = get_info();
2324         find_files_matching_filter (preset_files, preset_search_path, au_preset_filter,
2325                         boost::dynamic_pointer_cast<AUPluginInfo> (nfo).get(),
2326                         true, true, true);
2327
2328         if (preset_files.empty()) {
2329                 DEBUG_TRACE (DEBUG::AudioUnits, "AU No Preset Files found for given plugin.\n");
2330         }
2331
2332         for (vector<string>::iterator x = preset_files.begin(); x != preset_files.end(); ++x) {
2333
2334                 string path = *x;
2335                 string preset_name;
2336
2337                 /* make an initial guess at the preset name using the path */
2338
2339                 preset_name = Glib::path_get_basename (path);
2340                 preset_name = preset_name.substr (0, preset_name.find_last_of ('.'));
2341
2342                 /* check that this preset file really matches this plugin
2343                    and potentially get the "real" preset name from
2344                    within the file.
2345                 */
2346
2347                 if (check_and_get_preset_name (get_comp()->Comp(), path, preset_name)) {
2348                         user_preset_map[preset_name] = path;
2349                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Preset File: %1 > %2\n", preset_name, path));
2350                 } else {
2351                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU INVALID Preset: %1 > %2\n", preset_name, path));
2352                 }
2353
2354         }
2355
2356         /* now fill the vector<string> with the names we have */
2357
2358         for (UserPresetMap::iterator i = user_preset_map.begin(); i != user_preset_map.end(); ++i) {
2359                 _presets.insert (make_pair (i->second, Plugin::PresetRecord (i->second, i->first)));
2360                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Adding User Preset: %1 > %2\n", i->first, i->second));
2361         }
2362
2363         /* add factory presets */
2364
2365         for (FactoryPresetMap::iterator i = factory_preset_map.begin(); i != factory_preset_map.end(); ++i) {
2366                 /* XXX: dubious */
2367                 string const uri = string_compose ("%1", _presets.size ());
2368                 _presets.insert (make_pair (uri, Plugin::PresetRecord (uri, i->first, false)));
2369                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Adding Factory Preset: %1 > %2\n", i->first, i->second));
2370         }
2371 }
2372
2373 bool
2374 AUPlugin::has_editor () const
2375 {
2376         // even if the plugin doesn't have its own editor, the AU API can be used
2377         // to create one that looks native.
2378         return true;
2379 }
2380
2381 AUPluginInfo::AUPluginInfo (boost::shared_ptr<CAComponentDescription> d)
2382         : descriptor (d)
2383         , version (0)
2384 {
2385         type = ARDOUR::AudioUnit;
2386 }
2387
2388 AUPluginInfo::~AUPluginInfo ()
2389 {
2390         type = ARDOUR::AudioUnit;
2391 }
2392
2393 PluginPtr
2394 AUPluginInfo::load (Session& session)
2395 {
2396         try {
2397                 PluginPtr plugin;
2398
2399                 DEBUG_TRACE (DEBUG::AudioUnits, "load AU as a component\n");
2400                 boost::shared_ptr<CAComponent> comp (new CAComponent(*descriptor));
2401
2402                 if (!comp->IsValid()) {
2403                         error << ("AudioUnit: not a valid Component") << endmsg;
2404                 } else {
2405                         plugin.reset (new AUPlugin (session.engine(), session, comp));
2406                 }
2407
2408                 AUPluginInfo *aup = new AUPluginInfo (*this);
2409                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("plugin info for %1 = %2\n", this, aup));
2410                 plugin->set_info (PluginInfoPtr (aup));
2411                 boost::dynamic_pointer_cast<AUPlugin> (plugin)->set_fixed_size_buffers (aup->creator == "Universal Audio");
2412                 return plugin;
2413         }
2414
2415         catch (failed_constructor &err) {
2416                 DEBUG_TRACE (DEBUG::AudioUnits, "failed to load component/plugin\n");
2417                 return PluginPtr ();
2418         }
2419 }
2420
2421 std::vector<Plugin::PresetRecord>
2422 AUPluginInfo::get_presets (bool user_only) const
2423 {
2424         std::vector<Plugin::PresetRecord> p;
2425         boost::shared_ptr<CAComponent> comp;
2426 #ifndef NO_PLUGIN_STATE
2427         try {
2428                 comp = boost::shared_ptr<CAComponent>(new CAComponent(*descriptor));
2429                 if (!comp->IsValid()) {
2430                         throw failed_constructor();
2431                 }
2432         } catch (failed_constructor& err) {
2433                 return p;
2434         }
2435
2436         // user presets
2437
2438         if (!preset_search_path_initialized) {
2439                 Glib::ustring p = Glib::get_home_dir();
2440                 p += "/Library/Audio/Presets:";
2441                 p += preset_search_path;
2442                 preset_search_path = p;
2443                 preset_search_path_initialized = true;
2444                 DEBUG_TRACE (DEBUG::AudioUnits, string_compose("AU Preset Path: %1\n", preset_search_path));
2445         }
2446
2447         vector<string> preset_files;
2448         find_files_matching_filter (preset_files, preset_search_path, au_preset_filter, const_cast<AUPluginInfo*>(this), true, true, true);
2449
2450         for (vector<string>::iterator x = preset_files.begin(); x != preset_files.end(); ++x) {
2451                 string path = *x;
2452                 string preset_name;
2453                 preset_name = Glib::path_get_basename (path);
2454                 preset_name = preset_name.substr (0, preset_name.find_last_of ('.'));
2455                 if (check_and_get_preset_name (comp.get()->Comp(), path, preset_name)) {
2456                         p.push_back (Plugin::PresetRecord (path, preset_name));
2457                 }
2458         }
2459
2460         if (user_only) {
2461                 return p;
2462         }
2463
2464         // factory presets
2465
2466         CFArrayRef presets;
2467         UInt32 dataSize;
2468         Boolean isWritable;
2469
2470         boost::shared_ptr<CAAudioUnit> unit (new CAAudioUnit);
2471         if (noErr != CAAudioUnit::Open (*(comp.get()), *unit)) {
2472                 return p;
2473         }
2474         if (noErr != unit->GetPropertyInfo (kAudioUnitProperty_FactoryPresets, kAudioUnitScope_Global, 0, &dataSize, &isWritable)) {
2475                 unit->Uninitialize ();
2476                 return p;
2477         }
2478         if (noErr != unit->GetProperty (kAudioUnitProperty_FactoryPresets, kAudioUnitScope_Global, 0, (void*) &presets, &dataSize)) {
2479                 unit->Uninitialize ();
2480                 return p;
2481         }
2482         if (!presets) {
2483                 unit->Uninitialize ();
2484                 return p;
2485         }
2486
2487         CFIndex cnt = CFArrayGetCount (presets);
2488         for (CFIndex i = 0; i < cnt; ++i) {
2489                 AUPreset* preset = (AUPreset*) CFArrayGetValueAtIndex (presets, i);
2490                 string const uri = string_compose ("%1", i);
2491                 string name = CFStringRefToStdString (preset->presetName);
2492                 p.push_back (Plugin::PresetRecord (uri, name, false));
2493         }
2494         CFRelease (presets);
2495         unit->Uninitialize ();
2496
2497 #endif // NO_PLUGIN_STATE
2498         return p;
2499 }
2500
2501 Glib::ustring
2502 AUPluginInfo::au_cache_path ()
2503 {
2504         return Glib::build_filename (ARDOUR::user_cache_directory(), "au_cache");
2505 }
2506
2507 PluginInfoList*
2508 AUPluginInfo::discover (bool scan_only)
2509 {
2510         XMLTree tree;
2511
2512         /* AU require a CAComponentDescription pointer provided by the OS.
2513          * Ardour only caches port and i/o config. It can't just 'scan' without
2514          * 'discovering' (like we do for VST).
2515          *
2516          * "Scan Only" means
2517          * "Iterate over all plugins. skip the ones where there's no io-cache".
2518          */
2519         _scan_only = scan_only;
2520
2521         if (!Glib::file_test (au_cache_path(), Glib::FILE_TEST_EXISTS)) {
2522                 ARDOUR::BootMessage (_("Discovering AudioUnit plugins (could take some time ...)"));
2523         }
2524         // create crash log file
2525         au_start_crashlog ();
2526
2527         PluginInfoList* plugs = new PluginInfoList;
2528
2529         discover_fx (*plugs);
2530         discover_music (*plugs);
2531         discover_generators (*plugs);
2532         discover_instruments (*plugs);
2533
2534         // all fine if we get here
2535         au_remove_crashlog ();
2536
2537         DEBUG_TRACE (DEBUG::PluginManager, string_compose ("AU: discovered %1 plugins\n", plugs->size()));
2538
2539         return plugs;
2540 }
2541
2542 void
2543 AUPluginInfo::discover_music (PluginInfoList& plugs)
2544 {
2545         CAComponentDescription desc;
2546         desc.componentFlags = 0;
2547         desc.componentFlagsMask = 0;
2548         desc.componentSubType = 0;
2549         desc.componentManufacturer = 0;
2550         desc.componentType = kAudioUnitType_MusicEffect;
2551
2552         discover_by_description (plugs, desc);
2553 }
2554
2555 void
2556 AUPluginInfo::discover_fx (PluginInfoList& plugs)
2557 {
2558         CAComponentDescription desc;
2559         desc.componentFlags = 0;
2560         desc.componentFlagsMask = 0;
2561         desc.componentSubType = 0;
2562         desc.componentManufacturer = 0;
2563         desc.componentType = kAudioUnitType_Effect;
2564
2565         discover_by_description (plugs, desc);
2566 }
2567
2568 void
2569 AUPluginInfo::discover_generators (PluginInfoList& plugs)
2570 {
2571         CAComponentDescription desc;
2572         desc.componentFlags = 0;
2573         desc.componentFlagsMask = 0;
2574         desc.componentSubType = 0;
2575         desc.componentManufacturer = 0;
2576         desc.componentType = kAudioUnitType_Generator;
2577
2578         discover_by_description (plugs, desc);
2579 }
2580
2581 void
2582 AUPluginInfo::discover_instruments (PluginInfoList& plugs)
2583 {
2584         CAComponentDescription desc;
2585         desc.componentFlags = 0;
2586         desc.componentFlagsMask = 0;
2587         desc.componentSubType = 0;
2588         desc.componentManufacturer = 0;
2589         desc.componentType = kAudioUnitType_MusicDevice;
2590
2591         discover_by_description (plugs, desc);
2592 }
2593
2594
2595 bool
2596 AUPluginInfo::au_get_crashlog (std::string &msg)
2597 {
2598         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_crashlog.txt");
2599         if (!Glib::file_test (fn, Glib::FILE_TEST_EXISTS)) {
2600                 return false;
2601         }
2602         std::ifstream ifs(fn.c_str());
2603         msg.assign ((std::istreambuf_iterator<char>(ifs)), (std::istreambuf_iterator<char>()));
2604         au_remove_crashlog ();
2605         return true;
2606 }
2607
2608 void
2609 AUPluginInfo::au_start_crashlog ()
2610 {
2611         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_crashlog.txt");
2612         assert(!_crashlog_fd);
2613         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("Creating AU Log: %1\n", fn));
2614         if (!(_crashlog_fd = fopen(fn.c_str(), "w"))) {
2615                 PBD::error << "Cannot create AU error-log" << fn << "\n";
2616                 cerr << "Cannot create AU error-log" << fn << "\n";
2617         }
2618 }
2619
2620 void
2621 AUPluginInfo::au_remove_crashlog ()
2622 {
2623         if (_crashlog_fd) {
2624                 ::fclose(_crashlog_fd);
2625                 _crashlog_fd = NULL;
2626         }
2627         string fn = Glib::build_filename (ARDOUR::user_cache_directory(), "au_crashlog.txt");
2628         ::g_unlink(fn.c_str());
2629         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("Remove AU Log: %1\n", fn));
2630 }
2631
2632
2633 void
2634 AUPluginInfo::au_crashlog (std::string msg)
2635 {
2636         if (!_crashlog_fd) {
2637                 fprintf(stderr, "AU: %s\n", msg.c_str());
2638         } else {
2639                 fprintf(_crashlog_fd, "AU: %s\n", msg.c_str());
2640                 ::fflush(_crashlog_fd);
2641         }
2642 }
2643
2644 void
2645 AUPluginInfo::discover_by_description (PluginInfoList& plugs, CAComponentDescription& desc)
2646 {
2647         ArdourComponent comp = 0;
2648         au_crashlog(string_compose("Start AU discovery for Type: %1", (int)desc.componentType));
2649
2650         comp = ArdourFindNext (NULL, &desc);
2651
2652         while (comp != NULL) {
2653                 CAComponentDescription temp;
2654 #ifdef COREAUDIO105
2655                 GetComponentInfo (comp, &temp, NULL, NULL, NULL);
2656 #else
2657                 AudioComponentGetDescription (comp, &temp);
2658 #endif
2659                 CFStringRef itemName = NULL;
2660
2661                 {
2662                         if (itemName != NULL) CFRelease(itemName);
2663                         CFStringRef compTypeString = UTCreateStringForOSType(temp.componentType);
2664                         CFStringRef compSubTypeString = UTCreateStringForOSType(temp.componentSubType);
2665                         CFStringRef compManufacturerString = UTCreateStringForOSType(temp.componentManufacturer);
2666                         itemName = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR("%@ - %@ - %@"),
2667                                         compTypeString, compManufacturerString, compSubTypeString);
2668                         au_crashlog(string_compose("Scanning ID: %1", CFStringRefToStdString(itemName)));
2669                         if (compTypeString != NULL)
2670                                 CFRelease(compTypeString);
2671                         if (compSubTypeString != NULL)
2672                                 CFRelease(compSubTypeString);
2673                         if (compManufacturerString != NULL)
2674                                 CFRelease(compManufacturerString);
2675                 }
2676
2677                 if (is_blacklisted(CFStringRefToStdString(itemName))) {
2678                         info << string_compose (_("Skipped blacklisted AU plugin %1 "), CFStringRefToStdString(itemName)) << endmsg;
2679                         comp = ArdourFindNext (comp, &desc);
2680                         continue;
2681                 }
2682
2683                 AUPluginInfoPtr info (new AUPluginInfo
2684                                       (boost::shared_ptr<CAComponentDescription> (new CAComponentDescription(temp))));
2685
2686                 /* although apple designed the subtype field to be a "category" indicator,
2687                    its really turned into a plugin ID field for a given manufacturer. Hence
2688                    there are no categories for AudioUnits. However, to keep the plugins
2689                    showing up under "categories", we'll use the "type" as a high level
2690                    selector.
2691
2692                    NOTE: no panners, format converters or i/o AU's for our purposes
2693                  */
2694
2695                 switch (info->descriptor->Type()) {
2696                 case kAudioUnitType_Panner:
2697                 case kAudioUnitType_OfflineEffect:
2698                 case kAudioUnitType_FormatConverter:
2699                         comp = ArdourFindNext (comp, &desc);
2700                         continue;
2701
2702                 case kAudioUnitType_Output:
2703                         info->category = _("AudioUnit Outputs");
2704                         break;
2705                 case kAudioUnitType_MusicDevice:
2706                         info->category = _("AudioUnit Instruments");
2707                         break;
2708                 case kAudioUnitType_MusicEffect:
2709                         info->category = _("AudioUnit MusicEffects");
2710                         break;
2711                 case kAudioUnitType_Effect:
2712                         info->category = _("AudioUnit Effects");
2713                         break;
2714                 case kAudioUnitType_Mixer:
2715                         info->category = _("AudioUnit Mixers");
2716                         break;
2717                 case kAudioUnitType_Generator:
2718                         info->category = _("AudioUnit Generators");
2719                         break;
2720                 default:
2721                         info->category = _("AudioUnit (Unknown)");
2722                         break;
2723                 }
2724
2725                 au_blacklist(CFStringRefToStdString(itemName));
2726 #ifdef COREAUDIO105
2727                 get_names (temp, info->name, info->creator);
2728 #else
2729                 get_names (comp, info->name, info->creator);
2730 #endif
2731                 ARDOUR::PluginScanMessage(_("AU"), info->name, false);
2732                 au_crashlog(string_compose("Plugin: %1", info->name));
2733
2734                 info->type = ARDOUR::AudioUnit;
2735                 info->unique_id = stringify_descriptor (*info->descriptor);
2736
2737                 /* XXX not sure of the best way to handle plugin versioning yet
2738                  */
2739
2740                 CAComponent cacomp (*info->descriptor);
2741
2742 #ifdef COREAUDIO105
2743                 if (cacomp.GetResourceVersion (info->version) != noErr)
2744 #else
2745                 if (cacomp.GetVersion (info->version) != noErr)
2746 #endif
2747                 {
2748                         info->version = 0;
2749                 }
2750
2751                 const int rv = cached_io_configuration (info->unique_id, info->version, cacomp, info->cache, info->name);
2752
2753                 if (rv == 0) {
2754                         /* here we have to map apple's wildcard system to a simple pair
2755                            of values. in ::can_do() we use the whole system, but here
2756                            we need a single pair of values. XXX probably means we should
2757                            remove any use of these values.
2758
2759                            for now, if the plugin provides a wildcard, treat it as 1. we really
2760                            don't care much, because whether we can handle an i/o configuration
2761                            depends upon ::can_support_io_configuration(), not these counts.
2762
2763                            they exist because other parts of ardour try to present i/o configuration
2764                            info to the user, which should perhaps be revisited.
2765                         */
2766
2767                         int32_t possible_in = info->cache.io_configs.front().first;
2768                         int32_t possible_out = info->cache.io_configs.front().second;
2769
2770                         if (possible_in > 0) {
2771                                 info->n_inputs.set (DataType::AUDIO, possible_in);
2772                         } else {
2773                                 info->n_inputs.set (DataType::AUDIO, 1);
2774                         }
2775
2776                         if (possible_out > 0) {
2777                                 info->n_outputs.set (DataType::AUDIO, possible_out);
2778                         } else {
2779                                 info->n_outputs.set (DataType::AUDIO, 1);
2780                         }
2781
2782                         DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("detected AU %1 with %2 i/o configurations - %3\n",
2783                                                                         info->name.c_str(), info->cache.io_configs.size(), info->unique_id));
2784
2785                         plugs.push_back (info);
2786
2787                 }
2788                 else if (rv == -1) {
2789                         error << string_compose (_("Cannot get I/O configuration info for AU %1"), info->name) << endmsg;
2790                 }
2791
2792                 au_unblacklist(CFStringRefToStdString(itemName));
2793                 au_crashlog("Success.");
2794                 comp = ArdourFindNext (comp, &desc);
2795                 if (itemName != NULL) CFRelease(itemName); itemName = NULL;
2796         }
2797         au_crashlog(string_compose("End AU discovery for Type: %1", (int)desc.componentType));
2798 }
2799
2800 int
2801 AUPluginInfo::cached_io_configuration (const std::string& unique_id,
2802                                        UInt32 version,
2803                                        CAComponent& comp,
2804                                        AUPluginCachedInfo& cinfo,
2805                                        const std::string& name)
2806 {
2807         std::string id;
2808         char buf[32];
2809
2810         /* concatenate unique ID with version to provide a key for cached info lookup.
2811            this ensures we don't get stale information, or should if plugin developers
2812            follow Apple "guidelines".
2813          */
2814
2815         snprintf (buf, sizeof (buf), "%u", (uint32_t) version);
2816         id = unique_id;
2817         id += '/';
2818         id += buf;
2819
2820         CachedInfoMap::iterator cim = cached_info.find (id);
2821
2822         if (cim != cached_info.end()) {
2823                 cinfo = cim->second;
2824                 return 0;
2825         }
2826
2827         if (_scan_only) {
2828                 PBD::info << string_compose (_("Skipping AU %1 (not indexed. Discover new plugins to add)"), name) << endmsg;
2829                 return 1;
2830         }
2831
2832         CAAudioUnit unit;
2833         AUChannelInfo* channel_info;
2834         UInt32 cnt;
2835         int ret;
2836
2837         ARDOUR::BootMessage (string_compose (_("Checking AudioUnit: %1"), name));
2838
2839         try {
2840
2841                 if (CAAudioUnit::Open (comp, unit) != noErr) {
2842                         return -1;
2843                 }
2844
2845         } catch (...) {
2846
2847                 warning << string_compose (_("Could not load AU plugin %1 - ignored"), name) << endmsg;
2848                 return -1;
2849
2850         }
2851
2852         DEBUG_TRACE (DEBUG::AudioUnits, "get AU channel info\n");
2853         if ((ret = unit.GetChannelInfo (&channel_info, cnt)) < 0) {
2854                 return -1;
2855         }
2856
2857         if (ret > 0) {
2858
2859                 /* no explicit info available, so default to 1in/1out */
2860
2861                 /* XXX this is wrong. we should be indicating wildcard values */
2862
2863                 cinfo.io_configs.push_back (pair<int,int> (-1, -1));
2864
2865         } else {
2866
2867                 /* store each configuration */
2868
2869                 for (uint32_t n = 0; n < cnt; ++n) {
2870                         cinfo.io_configs.push_back (pair<int,int> (channel_info[n].inChannels,
2871                                                                    channel_info[n].outChannels));
2872                 }
2873
2874                 free (channel_info);
2875         }
2876
2877         add_cached_info (id, cinfo);
2878         save_cached_info ();
2879
2880         return 0;
2881 }
2882
2883 void
2884 AUPluginInfo::add_cached_info (const std::string& id, AUPluginCachedInfo& cinfo)
2885 {
2886         cached_info[id] = cinfo;
2887 }
2888
2889 #define AU_CACHE_VERSION "2.0"
2890
2891 void
2892 AUPluginInfo::save_cached_info ()
2893 {
2894         XMLNode* node;
2895
2896         node = new XMLNode (X_("AudioUnitPluginCache"));
2897         node->add_property( "version", AU_CACHE_VERSION );
2898
2899         for (map<string,AUPluginCachedInfo>::iterator i = cached_info.begin(); i != cached_info.end(); ++i) {
2900                 XMLNode* parent = new XMLNode (X_("plugin"));
2901                 parent->add_property ("id", i->first);
2902                 node->add_child_nocopy (*parent);
2903
2904                 for (vector<pair<int, int> >::iterator j = i->second.io_configs.begin(); j != i->second.io_configs.end(); ++j) {
2905
2906                         XMLNode* child = new XMLNode (X_("io"));
2907                         char buf[32];
2908
2909                         snprintf (buf, sizeof (buf), "%d", j->first);
2910                         child->add_property (X_("in"), buf);
2911                         snprintf (buf, sizeof (buf), "%d", j->second);
2912                         child->add_property (X_("out"), buf);
2913                         parent->add_child_nocopy (*child);
2914                 }
2915
2916         }
2917
2918         Glib::ustring path = au_cache_path ();
2919         XMLTree tree;
2920
2921         tree.set_root (node);
2922
2923         if (!tree.write (path)) {
2924                 error << string_compose (_("could not save AU cache to %1"), path) << endmsg;
2925                 g_unlink (path.c_str());
2926         }
2927 }
2928
2929 int
2930 AUPluginInfo::load_cached_info ()
2931 {
2932         Glib::ustring path = au_cache_path ();
2933         XMLTree tree;
2934
2935         if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
2936                 return 0;
2937         }
2938
2939         if ( !tree.read (path) ) {
2940                 error << "au_cache is not a valid XML file.  AU plugins will be re-scanned" << endmsg;
2941                 return -1;
2942         }
2943
2944         const XMLNode* root (tree.root());
2945
2946         if (root->name() != X_("AudioUnitPluginCache")) {
2947                 return -1;
2948         }
2949
2950         //initial version has incorrectly stored i/o info, and/or garbage chars.
2951         const XMLProperty* version = root->property(X_("version"));
2952         if (! ((version != NULL) && (version->value() == X_(AU_CACHE_VERSION)))) {
2953                 error << "au_cache is not correct version.  AU plugins will be re-scanned" << endmsg;
2954                 return -1;
2955         }
2956
2957         cached_info.clear ();
2958
2959         const XMLNodeList children = root->children();
2960
2961         for (XMLNodeConstIterator iter = children.begin(); iter != children.end(); ++iter) {
2962
2963                 const XMLNode* child = *iter;
2964
2965                 if (child->name() == X_("plugin")) {
2966
2967                         const XMLNode* gchild;
2968                         const XMLNodeList gchildren = child->children();
2969                         const XMLProperty* prop = child->property (X_("id"));
2970
2971                         if (!prop) {
2972                                 continue;
2973                         }
2974
2975                         string id = prop->value();
2976                         string fixed;
2977                         string version;
2978
2979                         string::size_type slash = id.find_last_of ('/');
2980
2981                         if (slash == string::npos) {
2982                                 continue;
2983                         }
2984
2985                         version = id.substr (slash);
2986                         id = id.substr (0, slash);
2987                         fixed = AUPlugin::maybe_fix_broken_au_id (id);
2988
2989                         if (fixed.empty()) {
2990                                 error << string_compose (_("Your AudioUnit configuration cache contains an AU plugin whose ID cannot be understood - ignored (%1)"), id) << endmsg;
2991                                 continue;
2992                         }
2993
2994                         id = fixed;
2995                         id += version;
2996
2997                         AUPluginCachedInfo cinfo;
2998
2999                         for (XMLNodeConstIterator giter = gchildren.begin(); giter != gchildren.end(); giter++) {
3000
3001                                 gchild = *giter;
3002
3003                                 if (gchild->name() == X_("io")) {
3004
3005                                         int in;
3006                                         int out;
3007                                         const XMLProperty* iprop;
3008                                         const XMLProperty* oprop;
3009
3010                                         if (((iprop = gchild->property (X_("in"))) != 0) &&
3011                                             ((oprop = gchild->property (X_("out"))) != 0)) {
3012                                                 in = atoi (iprop->value());
3013                                                 out = atoi (oprop->value());
3014
3015                                                 cinfo.io_configs.push_back (pair<int,int> (in, out));
3016                                         }
3017                                 }
3018                         }
3019
3020                         if (cinfo.io_configs.size()) {
3021                                 add_cached_info (id, cinfo);
3022                         }
3023                 }
3024         }
3025
3026         return 0;
3027 }
3028
3029
3030 std::string
3031 AUPluginInfo::stringify_descriptor (const CAComponentDescription& desc)
3032 {
3033         stringstream s;
3034
3035         /* note: OSType is a compiler-implemenation-defined value,
3036            historically a 32 bit integer created with a multi-character
3037            constant such as 'abcd'. It is, fundamentally, an abomination.
3038         */
3039
3040         s << desc.Type();
3041         s << '-';
3042         s << desc.SubType();
3043         s << '-';
3044         s << desc.Manu();
3045
3046         return s.str();
3047 }
3048
3049 bool
3050 AUPluginInfo::needs_midi_input ()
3051 {
3052         return is_effect_with_midi_input () || is_instrument ();
3053 }
3054
3055 bool
3056 AUPluginInfo::is_effect () const
3057 {
3058         return is_effect_without_midi_input() || is_effect_with_midi_input();
3059 }
3060
3061 bool
3062 AUPluginInfo::is_effect_without_midi_input () const
3063 {
3064         return descriptor->IsAUFX();
3065 }
3066
3067 bool
3068 AUPluginInfo::is_effect_with_midi_input () const
3069 {
3070         return descriptor->IsAUFM();
3071 }
3072
3073 bool
3074 AUPluginInfo::is_instrument () const
3075 {
3076         return descriptor->IsMusicDevice();
3077 }
3078
3079 void
3080 AUPlugin::set_info (PluginInfoPtr info)
3081 {
3082         Plugin::set_info (info);
3083
3084         AUPluginInfoPtr pinfo = boost::dynamic_pointer_cast<AUPluginInfo>(get_info());
3085         _has_midi_input = pinfo->needs_midi_input ();
3086         _has_midi_output = false;
3087 }
3088
3089 int
3090 AUPlugin::create_parameter_listener (AUEventListenerProc cb, void* arg, float interval_secs)
3091 {
3092 #ifdef WITH_CARBON
3093         CFRunLoopRef run_loop = (CFRunLoopRef) GetCFRunLoopFromEventLoop(GetCurrentEventLoop());
3094 #else
3095         CFRunLoopRef run_loop = CFRunLoopGetCurrent();
3096 #endif
3097         CFStringRef  loop_mode = kCFRunLoopDefaultMode;
3098
3099         if (AUEventListenerCreate (cb, arg, run_loop, loop_mode, interval_secs, interval_secs, &_parameter_listener) != noErr) {
3100                 return -1;
3101         }
3102
3103         _parameter_listener_arg = arg;
3104
3105         return 0;
3106 }
3107
3108 int
3109 AUPlugin::listen_to_parameter (uint32_t param_id)
3110 {
3111         AudioUnitEvent      event;
3112
3113         if (!_parameter_listener || param_id >= descriptors.size()) {
3114                 return -2;
3115         }
3116
3117         event.mEventType = kAudioUnitEvent_ParameterValueChange;
3118         event.mArgument.mParameter.mAudioUnit = unit->AU();
3119         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3120         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3121         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3122
3123         if (AUEventListenerAddEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3124                 return -1;
3125         }
3126
3127         event.mEventType = kAudioUnitEvent_BeginParameterChangeGesture;
3128         event.mArgument.mParameter.mAudioUnit = unit->AU();
3129         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3130         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3131         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3132
3133         if (AUEventListenerAddEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3134                 return -1;
3135         }
3136
3137         event.mEventType = kAudioUnitEvent_EndParameterChangeGesture;
3138         event.mArgument.mParameter.mAudioUnit = unit->AU();
3139         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3140         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3141         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3142
3143         if (AUEventListenerAddEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3144                 return -1;
3145         }
3146
3147         return 0;
3148 }
3149
3150 int
3151 AUPlugin::end_listen_to_parameter (uint32_t param_id)
3152 {
3153         AudioUnitEvent      event;
3154
3155         if (!_parameter_listener || param_id >= descriptors.size()) {
3156                 return -2;
3157         }
3158
3159         event.mEventType = kAudioUnitEvent_ParameterValueChange;
3160         event.mArgument.mParameter.mAudioUnit = unit->AU();
3161         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3162         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3163         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3164
3165         if (AUEventListenerRemoveEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3166                 return -1;
3167         }
3168
3169         event.mEventType = kAudioUnitEvent_BeginParameterChangeGesture;
3170         event.mArgument.mParameter.mAudioUnit = unit->AU();
3171         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3172         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3173         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3174
3175         if (AUEventListenerRemoveEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3176                 return -1;
3177         }
3178
3179         event.mEventType = kAudioUnitEvent_EndParameterChangeGesture;
3180         event.mArgument.mParameter.mAudioUnit = unit->AU();
3181         event.mArgument.mParameter.mParameterID = descriptors[param_id].id;
3182         event.mArgument.mParameter.mScope = descriptors[param_id].scope;
3183         event.mArgument.mParameter.mElement = descriptors[param_id].element;
3184
3185         if (AUEventListenerRemoveEventType (_parameter_listener, _parameter_listener_arg, &event) != noErr) {
3186                 return -1;
3187         }
3188
3189         return 0;
3190 }
3191
3192 void
3193 AUPlugin::_parameter_change_listener (void* arg, void* src, const AudioUnitEvent* event, UInt64 host_time, Float32 new_value)
3194 {
3195         ((AUPlugin*) arg)->parameter_change_listener (arg, src, event, host_time, new_value);
3196 }
3197
3198 void
3199 AUPlugin::parameter_change_listener (void* /*arg*/, void* src, const AudioUnitEvent* event, UInt64 /*host_time*/, Float32 new_value)
3200 {
3201         ParameterMap::iterator i;
3202
3203         if ((i = parameter_map.find (event->mArgument.mParameter.mParameterID)) == parameter_map.end()) {
3204                 return;
3205         }
3206
3207         switch (event->mEventType) {
3208         case kAudioUnitEvent_BeginParameterChangeGesture:
3209                 StartTouch (i->second);
3210                 break;
3211         case kAudioUnitEvent_EndParameterChangeGesture:
3212                 EndTouch (i->second);
3213                 break;
3214         case kAudioUnitEvent_ParameterValueChange:
3215                 /* whenever we change a parameter, we request that we are NOT notified of the change, so anytime we arrive here, it
3216                    means that something else (i.e. the plugin GUI) made the change.
3217                 */
3218                 ParameterChangedExternally (i->second, new_value);
3219                 break;
3220         default:
3221                 break;
3222         }
3223 }