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