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