2 #define Marker FuckYouAppleAndYourLackOfNameSpaces
4 #include <gtkmm/button.h>
5 #include <gdk/gdkquartz.h>
7 #include "pbd/convert.h"
10 #include "ardour/audio_unit.h"
11 #include "ardour/debug.h"
12 #include "ardour/plugin_insert.h"
14 #undef check // stupid gtk, stupid apple
16 #include <gtkmm2ext/utils.h>
18 #include "au_pluginui.h"
19 #include "gui_thread.h"
21 #include "appleutility/CAAudioUnit.h"
22 #include "appleutility/CAComponent.h"
24 #import <AudioUnit/AUCocoaUIView.h>
25 #import <CoreAudioKit/AUGenericView.h>
31 #include "public_editor.h"
34 using namespace ARDOUR;
36 using namespace Gtkmm2ext;
40 vector<string> AUPluginUI::automation_mode_strings;
42 static const gchar* _automation_mode_strings[] = {
51 dump_view_tree (NSView* view, int depth, int maxdepth)
53 NSArray* subviews = [view subviews];
54 unsigned long cnt = [subviews count];
56 for (int d = 0; d < depth; d++) {
59 NSRect frame = [view frame];
60 cerr << " view @ " << frame.origin.x << ", " << frame.origin.y
61 << ' ' << frame.size.width << " x " << frame.size.height
64 if (depth >= maxdepth) {
67 for (unsigned long i = 0; i < cnt; ++i) {
68 NSView* subview = [subviews objectAtIndex:i];
69 dump_view_tree (subview, depth+1, maxdepth);
73 @implementation NotificationObject
75 - (NotificationObject*) initWithPluginUI: (AUPluginUI*) apluginui andCocoaParent: (NSWindow*) cp andTopLevelParent: (NSWindow*) tlp
77 self = [ super init ];
80 plugin_ui = apluginui;
81 top_level_parent = tlp;
86 [[NSNotificationCenter defaultCenter]
88 selector:@selector(cocoaParentActivationHandler:)
89 name:NSWindowDidBecomeMainNotification
92 [[NSNotificationCenter defaultCenter]
94 selector:@selector(cocoaParentBecameKeyHandler:)
95 name:NSWindowDidBecomeKeyNotification
103 - (void)cocoaParentActivationHandler:(NSNotification *)notification
105 NSWindow* notification_window = (NSWindow *)[notification object];
107 if (top_level_parent == notification_window || cocoa_parent == notification_window) {
108 if ([notification_window isMainWindow]) {
109 plugin_ui->activate();
111 plugin_ui->deactivate();
116 - (void)cocoaParentBecameKeyHandler:(NSNotification *)notification
118 NSWindow* notification_window = (NSWindow *)[notification object];
120 if (top_level_parent == notification_window || cocoa_parent == notification_window) {
121 if ([notification_window isKeyWindow]) {
122 plugin_ui->activate();
124 plugin_ui->deactivate();
129 - (void)auViewResized:(NSNotification *)notification
131 (void) notification; // stop complaints about unusued argument
132 plugin_ui->cocoa_view_resized();
137 AUPluginUI::AUPluginUI (boost::shared_ptr<PluginInsert> insert)
138 : PlugUIBase (insert)
139 , automation_mode_label (_("Automation"))
140 , preset_label (_("Presets"))
151 if (automation_mode_strings.empty()) {
152 automation_mode_strings = I18N (_automation_mode_strings);
155 set_popdown_strings (automation_mode_selector, automation_mode_strings);
156 automation_mode_selector.set_active_text (automation_mode_strings.front());
158 if ((au = boost::dynamic_pointer_cast<AUPlugin> (insert->plugin())) == 0) {
159 error << _("unknown type of editor-supplying plugin (note: no AudioUnit support in this version of ardour)") << endmsg;
160 throw failed_constructor ();
163 /* stuff some stuff into the top of the window */
165 HBox* smaller_hbox = manage (new HBox);
167 smaller_hbox->set_spacing (6);
168 smaller_hbox->pack_start (preset_label, false, false, 4);
169 smaller_hbox->pack_start (_preset_modified, false, false);
170 smaller_hbox->pack_start (_preset_combo, false, false);
171 smaller_hbox->pack_start (add_button, false, false);
173 /* Ardour does not currently allow to overwrite existing presets
174 * see save_property_list() in audio_unit.cc
176 smaller_hbox->pack_start (save_button, false, false);
179 /* one day these might be useful with an AU plugin, but not yet */
180 smaller_hbox->pack_start (automation_mode_label, false, false);
181 smaller_hbox->pack_start (automation_mode_selector, false, false);
183 smaller_hbox->pack_start (reset_button, false, false);
184 smaller_hbox->pack_start (bypass_button, false, true);
186 VBox* v1_box = manage (new VBox);
187 VBox* v2_box = manage (new VBox);
189 v1_box->pack_start (*smaller_hbox, false, true);
190 v2_box->pack_start (focus_button, false, true);
192 top_box.set_homogeneous (false);
193 top_box.set_spacing (6);
194 top_box.set_border_width (6);
196 top_box.pack_end (*v2_box, false, false);
197 top_box.pack_end (*v1_box, false, false);
200 pack_start (top_box, false, false);
201 pack_start (low_box, true, true);
203 preset_label.show ();
204 _preset_combo.show ();
205 automation_mode_label.show ();
206 automation_mode_selector.show ();
207 bypass_button.show ();
215 _activating_from_app = false;
222 /* prefer cocoa, fall back to cocoa, but use carbon if its there */
224 if (test_cocoa_view_support()) {
225 create_cocoa_view ();
227 } else if (test_carbon_view_support()) {
228 create_carbon_view ();
231 create_cocoa_view ();
234 low_box.add_events (Gdk::VISIBILITY_NOTIFY_MASK | Gdk::EXPOSURE_MASK);
236 low_box.signal_realize().connect (mem_fun (this, &AUPluginUI::lower_box_realized));
237 low_box.signal_visibility_notify_event ().connect (mem_fun (this, &AUPluginUI::lower_box_visibility_notify));
238 low_box.signal_size_request ().connect (mem_fun (this, &AUPluginUI::lower_box_size_request));
239 low_box.signal_size_allocate ().connect (mem_fun (this, &AUPluginUI::lower_box_size_allocate));
240 low_box.signal_map ().connect (mem_fun (this, &AUPluginUI::lower_box_map));
241 low_box.signal_unmap ().connect (mem_fun (this, &AUPluginUI::lower_box_unmap));
242 //low_box.signal_expose_event ().connect (mem_fun (this, &AUPluginUI::lower_box_expose));
245 AUPluginUI::~AUPluginUI ()
248 [[NSNotificationCenter defaultCenter] removeObserver:_notify];
252 NSWindow* win = get_nswindow();
253 [win removeChildWindow:cocoa_parent];
258 /* not parented, just overlaid on top of our window */
259 DisposeWindow (carbon_window);
264 CloseComponent (editView);
268 /* remove whatever we packed into low_box so that GTK doesn't
272 [au_view removeFromSuperview];
277 AUPluginUI::test_carbon_view_support ()
282 carbon_descriptor.componentType = kAudioUnitCarbonViewComponentType;
283 carbon_descriptor.componentSubType = 'gnrc';
284 carbon_descriptor.componentManufacturer = 'appl';
285 carbon_descriptor.componentFlags = 0;
286 carbon_descriptor.componentFlagsMask = 0;
290 // ask the AU for its first editor component
292 err = AudioUnitGetPropertyInfo(*au->get_au(), kAudioUnitProperty_GetUIComponentList, kAudioUnitScope_Global, 0, &propertySize, NULL);
294 int nEditors = propertySize / sizeof(ComponentDescription);
295 ComponentDescription *editors = new ComponentDescription[nEditors];
296 err = AudioUnitGetProperty(*au->get_au(), kAudioUnitProperty_GetUIComponentList, kAudioUnitScope_Global, 0, editors, &propertySize);
298 // just pick the first one for now
299 carbon_descriptor = editors[0];
312 AUPluginUI::test_cocoa_view_support ()
315 Boolean isWritable = 0;
316 OSStatus err = AudioUnitGetPropertyInfo(*au->get_au(),
317 kAudioUnitProperty_CocoaUI, kAudioUnitScope_Global,
318 0, &dataSize, &isWritable);
320 return dataSize > 0 && err == noErr;
324 AUPluginUI::plugin_class_valid (Class pluginClass)
326 if([pluginClass conformsToProtocol: @protocol(AUCocoaUIBase)]) {
327 if([pluginClass instancesRespondToSelector: @selector(interfaceVersion)] &&
328 [pluginClass instancesRespondToSelector: @selector(uiViewForAudioUnit:withSize:)]) {
336 AUPluginUI::create_cocoa_view ()
338 bool wasAbleToLoadCustomView = false;
339 AudioUnitCocoaViewInfo* cocoaViewInfo = NULL;
340 UInt32 numberOfClasses = 0;
343 NSString* factoryClassName = 0;
344 NSURL* CocoaViewBundlePath = NULL;
346 OSStatus result = AudioUnitGetPropertyInfo (*au->get_au(),
347 kAudioUnitProperty_CocoaUI,
348 kAudioUnitScope_Global,
353 numberOfClasses = (dataSize - sizeof(CFURLRef)) / sizeof(CFStringRef);
355 // Does view have custom Cocoa UI?
357 if ((result == noErr) && (numberOfClasses > 0) ) {
359 DEBUG_TRACE(DEBUG::AudioUnits,
360 string_compose ( "based on %1, there are %2 cocoa UI classes\n", dataSize, numberOfClasses));
362 cocoaViewInfo = (AudioUnitCocoaViewInfo *)malloc(dataSize);
364 if(AudioUnitGetProperty(*au->get_au(),
365 kAudioUnitProperty_CocoaUI,
366 kAudioUnitScope_Global,
369 &dataSize) == noErr) {
371 CocoaViewBundlePath = (NSURL *)cocoaViewInfo->mCocoaAUViewBundleLocation;
373 // we only take the first view in this example.
374 factoryClassName = (NSString *)cocoaViewInfo->mCocoaAUViewClass[0];
376 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("the factory name is %1 bundle is %2\n",
377 [factoryClassName UTF8String], CocoaViewBundlePath));
381 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("No cocoaUI property cocoaViewInfo = %1\n", cocoaViewInfo));
383 if (cocoaViewInfo != NULL) {
384 free (cocoaViewInfo);
385 cocoaViewInfo = NULL;
390 // [A] Show custom UI if view has it
392 if (CocoaViewBundlePath && factoryClassName) {
393 NSBundle *viewBundle = [NSBundle bundleWithPath:[CocoaViewBundlePath path]];
395 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("tried to create bundle, result = %1\n", viewBundle));
397 if (viewBundle == NULL) {
398 error << _("AUPluginUI: error loading AU view's bundle") << endmsg;
401 Class factoryClass = [viewBundle classNamed:factoryClassName];
402 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("tried to create factory class, result = %1\n", factoryClass));
404 error << _("AUPluginUI: error getting AU view's factory class from bundle") << endmsg;
408 // make sure 'factoryClass' implements the AUCocoaUIBase protocol
409 if (!plugin_class_valid (factoryClass)) {
410 error << _("AUPluginUI: U view's factory class does not properly implement the AUCocoaUIBase protocol") << endmsg;
414 id factory = [[[factoryClass alloc] init] autorelease];
415 if (factory == NULL) {
416 error << _("AUPluginUI: Could not create an instance of the AU view factory") << endmsg;
420 DEBUG_TRACE (DEBUG::AudioUnits, "got a factory instance\n");
423 au_view = [factory uiViewForAudioUnit:*au->get_au() withSize:NSZeroSize];
425 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("view created @ %1\n", au_view));
428 [CocoaViewBundlePath release];
431 for (i = 0; i < numberOfClasses; i++)
432 CFRelease(cocoaViewInfo->mCocoaAUViewClass[i]);
434 free (cocoaViewInfo);
436 wasAbleToLoadCustomView = true;
440 if (!wasAbleToLoadCustomView) {
441 // load generic Cocoa view
442 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("Loading generic view using %1 -> %2\n", au,
444 au_view = [[AUGenericView alloc] initWithAudioUnit:*au->get_au()];
445 DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("view created @ %1\n", au_view));
446 [(AUGenericView *)au_view setShowsExpertParameters:1];
449 // Get the initial size of the new AU View's frame
450 NSRect frame = [au_view frame];
451 min_width = req_width = CGRectGetWidth(NSRectToCGRect(frame));
452 min_height = req_height = CGRectGetHeight(NSRectToCGRect(frame));
453 resizable = [au_view autoresizingMask];
455 low_box.queue_resize ();
461 AUPluginUI::cocoa_view_resized ()
463 if (!mapped || alo_width == 0 || alo_height == 0 || !resizable) {
466 /* check for self-resizing plugins (e.g expand settings in AUSampler)
467 * if the widget expands it moves its y-offset (cocoa y-axis points towards the top)
469 NSRect new_au_frame = [au_view frame];
471 //float dx = last_au_frame.origin.x - new_au_frame.origin.x;
472 float dy = last_au_frame.origin.y - new_au_frame.origin.y;
475 if (req_width < min_width) req_width = min_width;
476 if (req_height < min_height) req_height = min_height;
478 last_au_frame = new_au_frame;
479 low_box.queue_resize ();
483 AUPluginUI::create_carbon_view ()
487 ControlRef root_control;
489 Component editComponent = FindNextComponent(NULL, &carbon_descriptor);
491 OpenAComponent(editComponent, &editView);
493 error << _("AU Carbon view: cannot open AU Component") << endmsg;
497 Rect r = { 100, 100, 100, 100 };
498 WindowAttributes attr = WindowAttributes (kWindowStandardHandlerAttribute |
499 kWindowCompositingAttribute|
500 kWindowNoShadowAttribute|
501 kWindowNoTitleBarAttribute);
503 if ((err = CreateNewWindow(kUtilityWindowClass, attr, &r, &carbon_window)) != noErr) {
504 error << string_compose (_("AUPluginUI: cannot create carbon window (err: %1)"), err) << endmsg;
505 CloseComponent (editView);
509 if ((err = GetRootControl(carbon_window, &root_control)) != noErr) {
510 error << string_compose (_("AUPlugin: cannot get root control of carbon window (err: %1)"), err) << endmsg;
511 DisposeWindow (carbon_window);
512 CloseComponent (editView);
517 Float32Point location = { 0.0, 0.0 };
518 Float32Point size = { 0.0, 0.0 } ;
520 if ((err = AudioUnitCarbonViewCreate (editView, *au->get_au(), carbon_window, root_control, &location, &size, &viewPane)) != noErr) {
521 error << string_compose (_("AUPluginUI: cannot create carbon plugin view (err: %1)"), err) << endmsg;
522 DisposeWindow (carbon_window);
523 CloseComponent (editView);
530 GetControlBounds(viewPane, &bounds);
531 size.x = bounds.right-bounds.left;
532 size.y = bounds.bottom-bounds.top;
534 req_width = (int) (size.x + 0.5);
535 req_height = (int) (size.y + 0.5);
537 SizeWindow (carbon_window, prefwidth, req_height, true);
538 low_box.set_size_request (prefwidth, req_height); // ??
542 error << _("AU Carbon GUI is not supported.") << endmsg;
548 AUPluginUI::get_nswindow ()
550 Gtk::Container* toplevel = get_toplevel();
552 if (!toplevel || !toplevel->is_toplevel()) {
553 error << _("AUPluginUI: no top level window!") << endmsg;
557 NSWindow* true_parent = gdk_quartz_window_get_nswindow (toplevel->get_window()->gobj());
560 error << _("AUPluginUI: no top level window!") << endmsg;
568 AUPluginUI::activate ()
571 ActivateWindow (carbon_window, TRUE);
576 AUPluginUI::deactivate ()
579 ActivateWindow (carbon_window, FALSE);
584 AUPluginUI::parent_carbon_window ()
587 NSWindow* win = get_nswindow ();
588 Rect windowStructureBoundsRect;
594 Gtk::Container* toplevel = get_toplevel();
596 if (!toplevel || !toplevel->is_toplevel()) {
597 error << _("AUPluginUI: no top level window!") << endmsg;
601 /* figure out where the cocoa parent window is in carbon-coordinate space, which
602 differs from both cocoa-coordinate space and GTK-coordinate space
605 GetWindowBounds((WindowRef) [win windowRef], kWindowStructureRgn, &windowStructureBoundsRect);
607 /* compute how tall the title bar is, because we have to offset the position of the carbon window
611 NSRect content_frame = [NSWindow contentRectForFrameRect:[win frame] styleMask:[win styleMask]];
612 NSRect wm_frame = [NSWindow frameRectForContentRect:content_frame styleMask:[win styleMask]];
614 int titlebar_height = wm_frame.size.height - content_frame.size.height;
616 int packing_extra = 6; // this is the total vertical packing in our top level window
618 /* move into position, based on parent window position */
619 MoveWindow (carbon_window,
620 windowStructureBoundsRect.left,
621 windowStructureBoundsRect.top + titlebar_height + top_box.get_height() + packing_extra,
623 ShowWindow (carbon_window);
625 // create the cocoa window for the carbon one and make it visible
626 cocoa_parent = [[NSWindow alloc] initWithWindowRef: carbon_window];
628 SetWindowActivationScope (carbon_window, kWindowActivationScopeNone);
630 _notify = [ [NotificationObject alloc] initWithPluginUI:this andCocoaParent:cocoa_parent andTopLevelParent:win ];
632 [win addChildWindow:cocoa_parent ordered:NSWindowAbove];
633 [win setAutodisplay:1]; // turn of GTK stuff for this window
642 AUPluginUI::parent_cocoa_window ()
644 NSWindow* win = get_nswindow ();
650 //[win setAutodisplay:1]; // turn off GTK stuff for this window
652 NSView* view = gdk_quartz_window_get_nsview (low_box.get_window()->gobj());
653 [view addSubview:au_view];
656 gtk_widget_translate_coordinates(
657 GTK_WIDGET(low_box.gobj()),
658 GTK_WIDGET(low_box.get_parent()->gobj()),
660 [au_view setFrame:NSMakeRect(xx, yy, req_width, req_height)];
662 last_au_frame = [au_view frame];
663 // watch for size changes of the view
664 _notify = [ [NotificationObject alloc] initWithPluginUI:this andCocoaParent:NULL andTopLevelParent:win ];
666 [[NSNotificationCenter defaultCenter] addObserver:_notify
667 selector:@selector(auViewResized:) name:NSViewFrameDidChangeNotification
674 AUPluginUI::grab_focus()
677 [au_view becomeFirstResponder];
681 AUPluginUI::forward_key_event (GdkEventKey* ev)
683 NSEvent* nsevent = gdk_quartz_event_get_nsevent ((GdkEvent*)ev);
685 if (au_view && nsevent) {
687 /* filter on nsevent type here because GDK massages FlagsChanged
688 messages into GDK_KEY_{PRESS,RELEASE} but Cocoa won't
689 handle a FlagsChanged message as a keyDown or keyUp
692 if ([nsevent type] == NSKeyDown) {
693 [[[au_view window] firstResponder] keyDown:nsevent];
694 } else if ([nsevent type] == NSKeyUp) {
695 [[[au_view window] firstResponder] keyUp:nsevent];
696 } else if ([nsevent type] == NSFlagsChanged) {
697 [[[au_view window] firstResponder] flagsChanged:nsevent];
703 AUPluginUI::on_realize ()
707 /* our windows should not have that resize indicator */
709 NSWindow* win = get_nswindow ();
711 [win setShowsResizeIndicator:0];
716 AUPluginUI::lower_box_realized ()
719 parent_cocoa_window ();
720 } else if (carbon_window) {
721 parent_carbon_window ();
726 AUPluginUI::lower_box_visibility_notify (GdkEventVisibility* ev)
729 if (carbon_window && ev->state != GDK_VISIBILITY_UNOBSCURED) {
730 ShowWindow (carbon_window);
731 ActivateWindow (carbon_window, TRUE);
739 AUPluginUI::update_view_size ()
741 if (!mapped || alo_width == 0 || alo_height == 0) {
745 gtk_widget_translate_coordinates(
746 GTK_WIDGET(low_box.gobj()),
747 GTK_WIDGET(low_box.get_parent()->gobj()),
750 [[NSNotificationCenter defaultCenter] removeObserver:_notify
751 name:NSViewFrameDidChangeNotification
755 xx += (alo_width - req_width) * .5;
756 [au_view setFrame:NSMakeRect(xx, yy, req_width, req_height)];
758 /* this mitigates issues with plugins that resize themselves
759 * depending on visible options (e.g AUSampler)
760 * since the OSX y-axis points upwards, the plugin adjusts its
761 * own y-offset if the view expands to the bottom to accomodate
762 * subviews inside the main view.
764 [au_view setAutoresizesSubviews:0];
765 [au_view setFrame:NSMakeRect(xx, yy, alo_width, alo_height)];
766 [au_view setAutoresizesSubviews:1];
767 [au_view setNeedsDisplay:1];
770 last_au_frame = [au_view frame];
772 [[NSNotificationCenter defaultCenter]
774 selector:@selector(auViewResized:) name:NSViewFrameDidChangeNotification
779 AUPluginUI::lower_box_map ()
782 [au_view setHidden:0];
787 AUPluginUI::lower_box_unmap ()
790 [au_view setHidden:1];
794 AUPluginUI::lower_box_size_request (GtkRequisition* requisition)
796 requisition->width = req_width;
797 requisition->height = req_height;
801 AUPluginUI::lower_box_size_allocate (Gtk::Allocation& allocation)
803 alo_width = allocation.get_width ();
804 alo_height = allocation.get_height ();
809 AUPluginUI::lower_box_expose (GdkEventExpose* event)
811 [au_view drawRect:NSMakeRect(event->area.x,
814 event->area.height)];
819 AUPluginUI::on_window_hide ()
823 HideWindow (carbon_window);
824 ActivateWindow (carbon_window, FALSE);
830 NSArray* wins = [NSApp windows];
831 for (uint32_t i = 0; i < [wins count]; i++) {
832 id win = [wins objectAtIndex:i];
838 AUPluginUI::on_window_show (const string& /*title*/)
840 /* this is idempotent so just call it every time we show the window */
842 gtk_widget_realize (GTK_WIDGET(low_box.gobj()));
848 ShowWindow (carbon_window);
849 ActivateWindow (carbon_window, TRUE);
857 AUPluginUI::start_updating (GdkEventAny*)
863 AUPluginUI::stop_updating (GdkEventAny*)
869 create_au_gui (boost::shared_ptr<PluginInsert> plugin_insert, VBox** box)
871 AUPluginUI* aup = new AUPluginUI (plugin_insert);