libs/ardour/audio_unit.cc

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