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