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