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