fix #4663, partly by more efficiently generating the relevant string, and secondly...
[ardour.git] / gtk2_ardour / au_pluginui.mm
index cb58f67f6fb616bb2dc379f0324c43440deeda45..d1ba3d4d7f53b369f514dce392856025c8aff219 100644 (file)
@@ -1,9 +1,14 @@
+#include <gtkmm/stock.h>
+
 #undef  Marker
 #define Marker FuckYouAppleAndYourLackOfNameSpaces
 
+#include "pbd/convert.h"
 #include "pbd/error.h"
+
 #include "ardour/audio_unit.h"
-#include "ardour/insert.h"
+#include "ardour/debug.h"
+#include "ardour/plugin_insert.h"
 
 #undef check // stupid gtk, stupid apple
 
@@ -15,8 +20,8 @@
 #include "au_pluginui.h"
 #include "gui_thread.h"
 
-#include <appleutility/CAAudioUnit.h>
-#include <appleutility/CAComponent.h>
+#include "appleutility/CAAudioUnit.h"
+#include "appleutility/CAComponent.h"
 
 #import <AudioUnit/AUCocoaUIView.h>
 #import <CoreAudioKit/AUGenericView.h>
@@ -45,6 +50,65 @@ static const gchar* _automation_mode_strings[] = {
        0
 };
 
+@implementation NotificationObject
+
+- (NotificationObject*) initWithPluginUI: (AUPluginUI*) apluginui andCocoaParent: (NSWindow*) cp andTopLevelParent: (NSWindow*) tlp
+{
+       self = [ super init ];
+
+       if (self) {
+               plugin_ui = apluginui;
+               cocoa_parent = cp;
+               top_level_parent = tlp;
+
+               [[NSNotificationCenter defaultCenter] addObserver:self
+                selector:@selector(cocoaParentActivationHandler:)
+                name:NSWindowDidBecomeMainNotification
+                object:nil];
+
+               [[NSNotificationCenter defaultCenter] addObserver:self
+                selector:@selector(cocoaParentBecameKeyHandler:)
+                name:NSWindowDidBecomeKeyNotification
+                object:nil];
+       }
+
+       return self;
+}
+               
+- (void)cocoaParentActivationHandler:(NSNotification *)notification
+{
+       NSWindow* notification_window = (NSWindow *)[notification object];
+
+       if (top_level_parent == notification_window || cocoa_parent == notification_window) {
+               if ([notification_window isMainWindow]) {
+                       plugin_ui->activate();
+               } else {
+                       plugin_ui->deactivate();
+               }
+       } 
+}
+
+- (void)cocoaParentBecameKeyHandler:(NSNotification *)notification
+{
+       NSWindow* notification_window = (NSWindow *)[notification object];
+
+       if (top_level_parent == notification_window || cocoa_parent == notification_window) {
+               if ([notification_window isKeyWindow]) {
+                       plugin_ui->activate();
+               } else {
+                       plugin_ui->deactivate();
+               }
+       } 
+}
+
+- (void)auViewResized:(NSNotification *)notification;
+{
+       (void) notification;
+       plugin_ui->cocoa_view_resized();
+}
+
+@end
+
 AUPluginUI::AUPluginUI (boost::shared_ptr<PluginInsert> insert)
        : PlugUIBase (insert)
        , automation_mode_label (_("Automation"))
@@ -67,11 +131,15 @@ AUPluginUI::AUPluginUI (boost::shared_ptr<PluginInsert> insert)
 
        HBox* smaller_hbox = manage (new HBox);
 
-       smaller_hbox->pack_start (preset_label, false, false, 10);
-       smaller_hbox->pack_start (preset_combo, false, false);
+       smaller_hbox->set_spacing (6);
+       smaller_hbox->pack_start (preset_label, false, false, 4);
+       smaller_hbox->pack_start (_preset_combo, false, false);
        smaller_hbox->pack_start (save_button, false, false);
+#if 0
+       /* one day these might be useful with an AU plugin, but not yet */
        smaller_hbox->pack_start (automation_mode_label, false, false);
        smaller_hbox->pack_start (automation_mode_selector, false, false);
+#endif
        smaller_hbox->pack_start (bypass_button, false, true);
 
        VBox* v1_box = manage (new VBox);
@@ -92,7 +160,7 @@ AUPluginUI::AUPluginUI (boost::shared_ptr<PluginInsert> insert)
        pack_start (low_box, false, false);
 
        preset_label.show ();
-       preset_combo.show ();
+       _preset_combo.show ();
        automation_mode_label.show ();
        automation_mode_selector.show ();
        bypass_button.show ();
@@ -101,16 +169,20 @@ AUPluginUI::AUPluginUI (boost::shared_ptr<PluginInsert> insert)
 
        _activating_from_app = false;
        cocoa_parent = 0;
+       _notify = 0;
        cocoa_window = 0;
+       carbon_window = 0;
        au_view = 0;
-       packView = 0;
+       editView = 0;
 
        /* prefer cocoa, fall back to cocoa, but use carbon if its there */
 
        if (test_cocoa_view_support()) {
                create_cocoa_view ();
+#ifdef WITH_CARBON
        } else if (test_carbon_view_support()) {
                create_carbon_view ();
+#endif
        } else {
                create_cocoa_view ();
        }
@@ -122,19 +194,28 @@ AUPluginUI::~AUPluginUI ()
 {
        if (cocoa_parent) {
                NSWindow* win = get_nswindow();
-               RemoveEventHandler(carbon_event_handler);
+               [[NSNotificationCenter defaultCenter] removeObserver:_notify];
                [win removeChildWindow:cocoa_parent];
-       } else if (carbon_window) {
-               /* never parented */
+
+       } 
+
+#ifdef WITH_CARBON
+       if (carbon_window) {
+               /* not parented, just overlaid on top of our window */
                DisposeWindow (carbon_window);
        }
+#endif
 
-       if (packView) {
+       if (editView) {
+               CloseComponent (editView);
+       }
+
+       if (au_view) {
                /* remove whatever we packed into low_box so that GTK doesn't
                   mess with it.
                */
 
-               [packView removeFromSuperview];
+               [au_view removeFromSuperview];
        }
 }
 
@@ -202,7 +283,7 @@ AUPluginUI::create_cocoa_view ()
        UInt32     dataSize;
        Boolean    isWritable;
        NSString*           factoryClassName = 0;
-       NSURL*              CocoaViewBundlePath;
+       NSURL*              CocoaViewBundlePath = NULL;
 
        OSStatus result = AudioUnitGetPropertyInfo (*au->get_au(),
                                                    kAudioUnitProperty_CocoaUI,
@@ -212,10 +293,14 @@ AUPluginUI::create_cocoa_view ()
                                                    &isWritable );
 
        numberOfClasses = (dataSize - sizeof(CFURLRef)) / sizeof(CFStringRef);
-       
+
        // Does view have custom Cocoa UI?
        
        if ((result == noErr) && (numberOfClasses > 0) ) {
+
+               DEBUG_TRACE(DEBUG::AudioUnits,
+                           string_compose ( "based on %1, there are %2 cocoa UI classes\n", dataSize, numberOfClasses));
+
                cocoaViewInfo = (AudioUnitCocoaViewInfo *)malloc(dataSize);
                if(AudioUnitGetProperty(*au->get_au(),
                                        kAudioUnitProperty_CocoaUI,
@@ -225,12 +310,17 @@ AUPluginUI::create_cocoa_view ()
                                        &dataSize) == noErr) {
 
                        CocoaViewBundlePath     = (NSURL *)cocoaViewInfo->mCocoaAUViewBundleLocation;
-                       
+                               
                        // we only take the first view in this example.
                        factoryClassName        = (NSString *)cocoaViewInfo->mCocoaAUViewClass[0];
+                       
+                       DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("the factory name is %1 bundle is %2\n",
+                                                                       factoryClassName, CocoaViewBundlePath));
 
                } else {
 
+                       DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("No cocoaUI property cocoaViewInfo = %1\n", cocoaViewInfo));
+
                        if (cocoaViewInfo != NULL) {
                                free (cocoaViewInfo);
                                cocoaViewInfo = NULL;
@@ -244,11 +334,15 @@ AUPluginUI::create_cocoa_view ()
 
        if (CocoaViewBundlePath && factoryClassName) {
                NSBundle *viewBundle    = [NSBundle bundleWithPath:[CocoaViewBundlePath path]];
+
+               DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("tried to create bundle, result = %1\n", viewBundle));
+
                if (viewBundle == nil) {
                        error << _("AUPluginUI: error loading AU view's bundle") << endmsg;
                        return -1;
                } else {
                        Class factoryClass = [viewBundle classNamed:factoryClassName];
+                       DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("tried to create factory class, result = %1\n", factoryClass));
                        if (!factoryClass) {
                                error << _("AUPluginUI: error getting AU view's factory class from bundle") << endmsg;
                                return -1;
@@ -266,8 +360,12 @@ AUPluginUI::create_cocoa_view ()
                                return -1;
                        }
 
+                       DEBUG_TRACE (DEBUG::AudioUnits, "got a factory instance\n");
+
                        // make a view
                        au_view = [factoryInstance uiViewForAudioUnit:*au->get_au() withSize:crect.size];
+
+                       DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("view created @ %1\n", au_view));
                        
                        // cleanup
                        [CocoaViewBundlePath release];
@@ -284,24 +382,40 @@ AUPluginUI::create_cocoa_view ()
 
        if (!wasAbleToLoadCustomView) {
                // load generic Cocoa view
+               DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("Loading generic view using %1 -> %2\n", au,
+                                                               au->get_au()));
                au_view = [[AUGenericView alloc] initWithAudioUnit:*au->get_au()];
+               DEBUG_TRACE (DEBUG::AudioUnits, string_compose ("view created @ %1\n", au_view));
                [(AUGenericView *)au_view setShowsExpertParameters:YES];
        }
 
-       packView = au_view;
-       
+       // watch for size changes of the view
+
+        [[NSNotificationCenter defaultCenter] addObserver:_notify
+              selector:@selector(auViewResized:) name:NSWindowDidResizeNotification
+              object:au_view];
+
        // Get the size of the new AU View's frame 
+       
        NSRect packFrame;
        packFrame = [au_view frame];
        prefwidth = packFrame.size.width;
        prefheight = packFrame.size.height;
-
+       low_box.set_size_request (prefwidth, prefheight);
+       
        return 0;
 }
 
+void
+AUPluginUI::cocoa_view_resized ()
+{
+       NSRect packFrame = [au_view frame];
+}
+
 int
 AUPluginUI::create_carbon_view ()
 {
+#ifdef WITH_CARBON
        OSStatus err;
        ControlRef root_control;
 
@@ -321,11 +435,14 @@ AUPluginUI::create_carbon_view ()
 
        if ((err = CreateNewWindow(kDocumentWindowClass, attr, &r, &carbon_window)) != noErr) {
                error << string_compose (_("AUPluginUI: cannot create carbon window (err: %1)"), err) << endmsg;
+               CloseComponent (editView);
                return -1;
        }
        
        if ((err = GetRootControl(carbon_window, &root_control)) != noErr) {
                error << string_compose (_("AUPlugin: cannot get root control of carbon window (err: %1)"), err) << endmsg;
+               DisposeWindow (carbon_window);
+               CloseComponent (editView);
                return -1;
        }
 
@@ -335,6 +452,8 @@ AUPluginUI::create_carbon_view ()
 
        if ((err = AudioUnitCarbonViewCreate (editView, *au->get_au(), carbon_window, root_control, &location, &size, &viewPane)) != noErr) {
                error << string_compose (_("AUPluginUI: cannot create carbon plugin view (err: %1)"), err) << endmsg;
+               DisposeWindow (carbon_window);
+               CloseComponent (editView);
                return -1;
        }
 
@@ -352,6 +471,10 @@ AUPluginUI::create_carbon_view ()
        low_box.set_size_request (prefwidth, prefheight);
 
        return 0;
+#else
+       error << _("AU Carbon GUI is not supported.") << endmsg;
+       return -1;
+#endif
 }
 
 NSWindow*
@@ -377,75 +500,24 @@ AUPluginUI::get_nswindow ()
 void
 AUPluginUI::activate ()
 {
-       if (carbon_window && cocoa_parent) {
-               cerr << "APP activated, activate carbon window " << insert->name() << endl;
-               _activating_from_app = true;
-               ActivateWindow (carbon_window, TRUE);
-               _activating_from_app = false;
-               [cocoa_parent makeKeyAndOrderFront:nil];
-       } 
+#ifdef WITH_CARBON
+       ActivateWindow (carbon_window, TRUE);
+#endif
+       // [cocoa_parent makeKeyAndOrderFront:nil];
 }
 
 void
 AUPluginUI::deactivate ()
 {
-       return;
-       cerr << "APP DEactivated, for " << insert->name() << endl;
-       _activating_from_app = true;
+#ifdef WITH_CARBON
        ActivateWindow (carbon_window, FALSE);
-       _activating_from_app = false;
-}
-
-
-OSStatus 
-_carbon_event (EventHandlerCallRef nextHandlerRef, EventRef event, void *userData) 
-{
-       return ((AUPluginUI*)userData)->carbon_event (nextHandlerRef, event);
-}
-
-OSStatus 
-AUPluginUI::carbon_event (EventHandlerCallRef nextHandlerRef, EventRef event)
-{
-       cerr << "CARBON EVENT\n";
-
-       UInt32 eventKind = GetEventKind(event);
-       ClickActivationResult howToHandleClick;
-       NSWindow* win = get_nswindow ();
-
-       cerr << "window " << win << " carbon event type " << eventKind << endl;
-
-       switch (eventKind) {
-       case kEventWindowHandleActivate:
-               cerr << "carbon window for " << insert->name() << " activated\n";
-               if (_activating_from_app) {
-                       cerr << "app activation, ignore window activation\n";
-                       return noErr;
-               }
-               [win makeMainWindow];
-               return eventNotHandledErr;
-               break;
-
-       case kEventWindowHandleDeactivate:
-               cerr << "carbon window for " << insert->name() << " would have been deactivated\n";
-               // never deactivate the carbon window
-               return noErr;
-               break;
-               
-       case kEventWindowGetClickActivation:
-               cerr << "carbon window CLICK activated\n";
-               [win makeKeyAndOrderFront:nil];
-               howToHandleClick = kActivateAndHandleClick;
-               SetEventParameter(event, kEventParamClickActivation, typeClickActivationResult, 
-                                 sizeof(ClickActivationResult), &howToHandleClick);
-               break;
-       }
-
-       return noErr;
+#endif
 }
 
 int
 AUPluginUI::parent_carbon_window ()
 {
+#ifdef WITH_CARBON
        NSWindow* win = get_nswindow ();
        int x, y;
 
@@ -479,29 +551,22 @@ AUPluginUI::parent_carbon_window ()
        // create the cocoa window for the carbon one and make it visible
        cocoa_parent = [[NSWindow alloc] initWithWindowRef: carbon_window];
 
-       EventTypeSpec   windowEventTypes[] = {
-               {kEventClassWindow, kEventWindowGetClickActivation },
-               {kEventClassWindow, kEventWindowHandleDeactivate }
-       };
-       
-       EventHandlerUPP   ehUPP = NewEventHandlerUPP(_carbon_event);
-       OSStatus result = InstallWindowEventHandler (carbon_window, ehUPP, 
-                                                    sizeof(windowEventTypes) / sizeof(EventTypeSpec), 
-                                                    windowEventTypes, this, &carbon_event_handler);
-       if (result != noErr) {
-               return -1;
-       }
+       SetWindowActivationScope (carbon_window, kWindowActivationScopeNone);
+
+       _notify = [ [NotificationObject alloc] initWithPluginUI:this andCocoaParent:cocoa_parent andTopLevelParent:win ]; 
 
        [win addChildWindow:cocoa_parent ordered:NSWindowAbove];
 
        return 0;
+#else
+       return -1;
+#endif
 }      
 
 int
 AUPluginUI::parent_cocoa_window ()
 {
        NSWindow* win = get_nswindow ();
-       NSRect packFrame;
 
        if (!win) {
                return -1;
@@ -515,21 +580,59 @@ AUPluginUI::parent_cocoa_window ()
                error << _("AUPluginUI: no top level window!") << endmsg;
                return -1;
        }
-       
-       // Get the size of the new AU View's frame 
-       packFrame = [au_view frame];
 
-       NSView* view = gdk_quartz_window_get_nsview (low_box.get_window()->gobj());
-       
+       NSView* view = gdk_quartz_window_get_nsview (get_toplevel()->get_window()->gobj());
+       GtkRequisition a = top_box.size_request ();
 
-       [view setFrame:packFrame];
-       [view addSubview:packView]; 
+       /* move the au_view down so that it doesn't overlap the top_box contents */
 
-       low_box.set_size_request (packFrame.size.width, packFrame.size.height);
+       NSPoint origin = { 0, a.height };
+
+       [au_view setFrameOrigin:origin];
+       [view addSubview:au_view]; 
 
        return 0;
 }
 
+static void
+dump_view_tree (NSView* view, int depth)
+{
+       NSArray* subviews = [view subviews];
+       unsigned long cnt = [subviews count];
+
+       for (int d = 0; d < depth; d++) {
+               cerr << '\t';
+       }
+       cerr << " view @ " << view << endl;
+       
+       for (unsigned long i = 0; i < cnt; ++i) {
+               NSView* subview = [subviews objectAtIndex:i];
+               dump_view_tree (subview, depth+1);
+       }
+}
+
+void
+AUPluginUI::forward_key_event (GdkEventKey* ev)
+{
+       NSEvent* nsevent = gdk_quartz_event_get_nsevent ((GdkEvent*)ev);
+
+       if (au_view && nsevent) {
+
+               /* filter on nsevent type here because GDK massages FlagsChanged
+                  messages into GDK_KEY_{PRESS,RELEASE} but Cocoa won't
+                  handle a FlagsChanged message as a keyDown or keyUp
+               */
+
+               if ([nsevent type] == NSKeyDown) {
+                       [[[au_view window] firstResponder] keyDown:nsevent];
+               } else if ([nsevent type] == NSKeyUp) {
+                       [[[au_view window] firstResponder] keyUp:nsevent];
+               } else if ([nsevent type] == NSFlagsChanged) {
+                       [[[au_view window] firstResponder] flagsChanged:nsevent];
+               }
+       }
+}
+
 void
 AUPluginUI::on_realize ()
 {
@@ -553,44 +656,52 @@ AUPluginUI::lower_box_realized ()
        }
 }
 
-void
-AUPluginUI::on_hide ()
-{
-       // VBox::on_hide ();
-       cerr << "AU plugin window hidden\n";
-}
-
 bool
-AUPluginUI::on_map_event (GdkEventAny* ev)
+AUPluginUI::on_map_event (GdkEventAny*)
 {
        return false;
 }
 
 void
-AUPluginUI::on_show ()
+AUPluginUI::on_window_hide ()
 {
-       cerr << "AU plugin window shown\n";
+#ifdef WITH_CARBON
+       if (carbon_window) {
+               HideWindow (carbon_window);
+               ActivateWindow (carbon_window, FALSE);
+       }
+#endif
+
+       hide_all ();
+}
 
-       VBox::on_show ();
+bool
+AUPluginUI::on_window_show (const string& /*title*/)
+{
+       /* this is idempotent so just call it every time we show the window */
 
        gtk_widget_realize (GTK_WIDGET(low_box.gobj()));
 
-       if (au_view) {
-               show_all ();
-       } else if (carbon_window) {
-               [cocoa_parent setIsVisible:YES];
+       show_all ();
+
+#ifdef WITH_CARBON
+       if (carbon_window) {
                ShowWindow (carbon_window);
+               ActivateWindow (carbon_window, TRUE);
        }
+#endif
+
+       return true;
 }
 
 bool
-AUPluginUI::start_updating (GdkEventAny* any)
+AUPluginUI::start_updating (GdkEventAny*)
 {
        return false;
 }
 
 bool
-AUPluginUI::stop_updating (GdkEventAny* any)
+AUPluginUI::stop_updating (GdkEventAny*)
 {
        return false;
 }
@@ -604,7 +715,7 @@ create_au_gui (boost::shared_ptr<PluginInsert> plugin_insert, VBox** box)
 }
 
 bool
-AUPluginUI::on_focus_in_event (GdkEventFocus* ev)
+AUPluginUI::on_focus_in_event (GdkEventFocus*)
 {
        //cerr << "au plugin focus in\n";
        //Keyboard::magic_widget_grab_focus ();
@@ -612,7 +723,7 @@ AUPluginUI::on_focus_in_event (GdkEventFocus* ev)
 }
 
 bool
-AUPluginUI::on_focus_out_event (GdkEventFocus* ev)
+AUPluginUI::on_focus_out_event (GdkEventFocus*)
 {
        //cerr << "au plugin focus out\n";
        //Keyboard::magic_widget_drop_focus ();