]> git.sesse.net Git - vlc/blob - modules/gui/macosx/embeddedwindow.m
macosx: Make sure we don't see a grey flash in float-on-top mode in embedded window.
[vlc] / modules / gui / macosx / embeddedwindow.m
1 /*****************************************************************************
2  * embeddedwindow.m: MacOS X interface module
3  *****************************************************************************
4  * Copyright (C) 2005-2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Benjamin Pracht <bigben at videolan dot org>
8  *          Felix Paul Kühne <fkuehne at videolan dot org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 /* DisableScreenUpdates, SetSystemUIMode, ... */
30 #import <QuickTime/QuickTime.h>
31
32 #import "intf.h"
33 #import "controls.h"
34 #import "vout.h"
35 #import "embeddedwindow.h"
36 #import "fspanel.h"
37
38 /*****************************************************************************
39  * VLCEmbeddedWindow Implementation
40  *****************************************************************************/
41
42 @implementation VLCEmbeddedWindow
43
44 - (void)awakeFromNib
45 {
46     [self setDelegate: self];
47
48     [o_btn_backward setToolTip: _NS("Rewind")];
49     [o_btn_forward setToolTip: _NS("Fast Forward")];
50     [o_btn_fullscreen setToolTip: _NS("Fullscreen")];
51     [o_btn_play setToolTip: _NS("Play")];
52     [o_slider setToolTip: _NS("Position")];
53
54     o_img_play = [NSImage imageNamed: @"play_embedded"];
55     o_img_pause = [NSImage imageNamed: @"pause_embedded"];
56     [self controlTintChanged];
57     [[NSNotificationCenter defaultCenter] addObserver: self
58                                              selector: @selector( controlTintChanged )
59                                                  name: NSControlTintDidChangeNotification
60                                                object: nil];
61
62     /* Useful to save o_view frame in fullscreen mode */
63     o_temp_view = [[NSView alloc] init];
64     [o_temp_view setAutoresizingMask:NSViewHeightSizable | NSViewWidthSizable];
65
66     o_fullscreen_window = nil;
67     o_fullscreen_anim1 = o_fullscreen_anim2 = nil;
68
69     /* Not fullscreen when we wake up */
70     [o_btn_fullscreen setState: NO];
71     b_fullscreen = NO;
72
73     [self setMovableByWindowBackground:YES];
74
75     [self setDelegate:self];
76
77     /* Make sure setVisible: returns NO */
78     [self orderOut:self];
79     b_window_is_invisible = YES;
80     videoRatio = NSMakeSize( 0., 0. );
81 }
82
83 - (void)controlTintChanged
84 {
85     BOOL b_playing = NO;
86     if( [o_btn_play alternateImage] == o_img_play_pressed )
87         b_playing = YES;
88     
89     if( [NSColor currentControlTint] == NSGraphiteControlTint )
90     {
91         o_img_play_pressed = [NSImage imageNamed: @"play_embedded_graphite"];
92         o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_graphite"];
93         [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_graphite"]];
94         [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_graphite"]];
95         [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_graphite"]];
96     }
97     else
98     {
99         o_img_play_pressed = [NSImage imageNamed: @"play_embedded_blue"];
100         o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_blue"];
101         [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_blue"]];
102         [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_blue"]];
103         [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_blue"]];
104     }
105     
106     if( b_playing )
107         [o_btn_play setAlternateImage: o_img_play_pressed];
108     else
109         [o_btn_play setAlternateImage: o_img_pause_pressed];
110 }
111
112 - (void)dealloc
113 {
114     [[NSNotificationCenter defaultCenter] removeObserver: self];
115     [o_img_play release];
116     [o_img_play_pressed release];
117     [o_img_pause release];
118     [o_img_pause_pressed release];
119     
120     [super dealloc];
121 }
122
123 - (void)setTime:(NSString *)o_arg_time position:(float)f_position
124 {
125     [o_time setStringValue: o_arg_time];
126     [o_slider setFloatValue: f_position];
127 }
128
129 - (void)playStatusUpdated:(int)i_status
130 {
131     if( i_status == PLAYING_S )
132     {
133         [o_btn_play setImage: o_img_pause];
134         [o_btn_play setAlternateImage: o_img_pause_pressed];
135         [o_btn_play setToolTip: _NS("Pause")];
136     }
137     else
138     {
139         [o_btn_play setImage: o_img_play];
140         [o_btn_play setAlternateImage: o_img_play_pressed];
141         [o_btn_play setToolTip: _NS("Play")];
142     }
143 }
144
145 - (void)setSeekable:(BOOL)b_seekable
146 {
147     [o_btn_forward setEnabled: b_seekable];
148     [o_btn_backward setEnabled: b_seekable];
149     [o_slider setEnabled: b_seekable];
150 }
151
152 - (BOOL)windowShouldZoom:(NSWindow *)sender toFrame:(NSRect)newFrame
153 {
154     [self setFrame: newFrame display: YES animate: YES];
155     return YES;
156 }
157
158 - (BOOL)windowShouldClose:(id)sender
159 {
160     playlist_t * p_playlist = pl_Yield( VLCIntf );
161
162     playlist_Stop( p_playlist );
163     vlc_object_release( p_playlist );
164     return YES;
165 }
166
167 - (NSView *)mainView
168 {
169     if (o_fullscreen_window)
170         return o_temp_view;
171     else
172         return o_view;
173 }
174
175 - (void)setVideoRatio:(NSSize)ratio
176 {
177     videoRatio = ratio;
178 }
179
180 - (NSSize)windowWillResize:(NSWindow *)window toSize:(NSSize)proposedFrameSize
181 {
182     if( videoRatio.height == 0. || videoRatio.width == 0. )
183         return proposedFrameSize;
184
185     NSRect viewRect = [o_view convertRect:[o_view bounds] toView: nil];
186     NSRect contentRect = [self contentRectForFrameRect:[self frame]];
187     float marginy = viewRect.origin.y + [self frame].size.height - contentRect.size.height;
188     float marginx = contentRect.size.width - viewRect.size.width;
189     proposedFrameSize.height = (proposedFrameSize.width - marginx) * videoRatio.height / videoRatio.width + marginy;
190
191     return proposedFrameSize;
192 }
193
194 /*****************************************************************************
195  * Fullscreen support
196  */
197
198 - (BOOL)isFullscreen
199 {
200     return b_fullscreen;
201 }
202
203 - (void)lockFullscreenAnimation
204 {
205     [o_animation_lock lock];
206 }
207
208 - (void)unlockFullscreenAnimation
209 {
210     [o_animation_lock unlock];
211 }
212
213 - (void)enterFullscreen
214 {
215     NSMutableDictionary *dict1, *dict2;
216     NSScreen *screen;
217     NSRect screen_rect;
218     NSRect rect;
219     vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
220     BOOL blackout_other_displays = config_GetInt( VLCIntf, "macosx-black" );
221
222     screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )]; 
223  
224     [self lockFullscreenAnimation];
225
226     if (!screen)
227     {
228         msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
229         screen = [self screen];
230     }
231     if (!screen)
232     {
233         msg_Dbg( p_vout, "Using deepest screen" );
234         screen = [NSScreen deepestScreen];
235     }
236
237     vlc_object_release( p_vout );
238
239     screen_rect = [screen frame];
240
241     [o_btn_fullscreen setState: YES];
242
243     [NSCursor setHiddenUntilMouseMoves: YES];
244  
245     if( blackout_other_displays )        
246         [screen blackoutOtherScreens];
247
248     /* Make sure we don't see the window flashes in float-on-top mode */
249     originalLevel = [self level];
250     [self setLevel:NSNormalWindowLevel];
251
252     /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
253     if (!o_fullscreen_window)
254     {
255         /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
256
257         rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
258         rect.origin.x += [self frame].origin.x;
259         rect.origin.y += [self frame].origin.y;
260         o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
261         [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
262         [o_fullscreen_window setCanBecomeKeyWindow: YES];
263
264         if (![self isVisible] || [self alphaValue] == 0.0 || MACOS_VERSION < 10.4f)
265         {
266             /* We don't animate if we are not visible or if we are running on
267              * Mac OS X <10.4 which doesn't support NSAnimation, instead we
268              * simply fade the display */
269             CGDisplayFadeReservationToken token;
270  
271             CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
272             CGDisplayFade( token, 0.5, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
273  
274             if ([screen isMainScreen])
275                 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
276  
277             [[self contentView] replaceSubview:o_view with:o_temp_view];
278             [o_temp_view setFrame:[o_view frame]];
279             [o_fullscreen_window setContentView:o_view];
280
281             [o_fullscreen_window makeKeyAndOrderFront:self];
282
283             [o_fullscreen_window makeKeyAndOrderFront:self];
284             [o_fullscreen_window orderFront:self animate:YES];
285
286             [o_fullscreen_window setFrame:screen_rect display:YES];
287
288             CGDisplayFade( token, 0.3, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
289             CGReleaseDisplayFadeReservation( token);
290
291             /* Will release the lock */
292             [self hasBecomeFullscreen];
293
294             return;
295         }
296  
297         /* Make sure we don't see the o_view disappearing of the screen during this operation */
298         DisableScreenUpdates();
299         [[self contentView] replaceSubview:o_view with:o_temp_view];
300         [o_temp_view setFrame:[o_view frame]];
301         [o_fullscreen_window setContentView:o_view];
302         [o_fullscreen_window makeKeyAndOrderFront:self];
303         EnableScreenUpdates();
304     }
305
306     if (MACOS_VERSION < 10.4f)
307     {
308         /* We were already fullscreen nothing to do when NSAnimation
309          * is not supported */
310         [self unlockFullscreenAnimation];
311         return;
312     }
313
314     /* We are in fullscreen (and no animation is running) */
315     if (b_fullscreen)
316     {
317         /* Make sure we are hidden */
318         [super orderOut: self];
319         [self unlockFullscreenAnimation];
320         return;
321     }
322
323     if (o_fullscreen_anim1)
324     {
325         [o_fullscreen_anim1 stopAnimation];
326         [o_fullscreen_anim1 release];
327     }
328     if (o_fullscreen_anim2)
329     {
330         [o_fullscreen_anim2 stopAnimation];
331         [o_fullscreen_anim2 release];
332     }
333  
334     if ([screen isMainScreen])
335         SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
336
337     dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
338     dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
339
340     [dict1 setObject:self forKey:NSViewAnimationTargetKey];
341     [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
342
343     [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
344     [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
345     [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
346
347     /* Strategy with NSAnimation allocation:
348         - Keep at most 2 animation at a time
349         - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
350     */
351     o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
352     o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
353
354     [dict1 release];
355     [dict2 release];
356
357     [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
358     [o_fullscreen_anim1 setDuration: 0.3];
359     [o_fullscreen_anim1 setFrameRate: 30];
360     [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
361     [o_fullscreen_anim2 setDuration: 0.2];
362     [o_fullscreen_anim2 setFrameRate: 30];
363
364     [o_fullscreen_anim2 setDelegate: self];
365     [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
366
367     [o_fullscreen_anim1 startAnimation];
368     /* fullscreenAnimation will be unlocked when animation ends */
369 }
370
371 - (void)hasBecomeFullscreen
372 {
373     [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] getControls] getVoutView]];
374
375     [o_fullscreen_window makeKeyWindow];
376     [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
377
378     /* tell the fspanel to move itself to front next time it's triggered */
379     [[[[VLCMain sharedInstance] getControls] getFSPanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
380
381     if([self isVisible])
382         [super orderOut: self];
383
384     [[[[VLCMain sharedInstance] getControls] getFSPanel] setActive: nil];
385
386     b_fullscreen = YES;
387     [self unlockFullscreenAnimation];
388 }
389
390 - (void)leaveFullscreen
391 {
392     [self leaveFullscreenAndFadeOut: NO];
393 }
394
395 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
396 {
397     NSMutableDictionary *dict1, *dict2;
398     NSRect frame;
399
400     [self lockFullscreenAnimation];
401
402     b_fullscreen = NO;
403     [o_btn_fullscreen setState: NO];
404
405     /* We always try to do so */
406     [NSScreen unblackoutScreens];
407
408     /* Don't do anything if o_fullscreen_window is already closed */
409     if (!o_fullscreen_window)
410     {
411         [self unlockFullscreenAnimation];
412         return;
413     }
414
415     if (fadeout || MACOS_VERSION < 10.4f)
416     {
417         /* We don't animate if we are not visible or if we are running on
418         * Mac OS X <10.4 which doesn't support NSAnimation, instead we
419         * simply fade the display */
420         CGDisplayFadeReservationToken token;
421
422         CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
423         CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
424
425         [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
426         SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
427
428         /* Will release the lock */
429         [self hasEndedFullscreen];
430
431         /* Our window is hidden, and might be faded. We need to workaround that, so note it
432          * here */
433         b_window_is_invisible = YES;
434
435         CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
436         CGReleaseDisplayFadeReservation( token);
437         return;
438     }
439
440     [self setAlphaValue: 0.0];
441     [self orderFront: self];
442
443     [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
444     SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
445
446     if (o_fullscreen_anim1)
447     {
448         [o_fullscreen_anim1 stopAnimation];
449         [o_fullscreen_anim1 release];
450     }
451     if (o_fullscreen_anim2)
452     {
453         [o_fullscreen_anim2 stopAnimation];
454         [o_fullscreen_anim2 release];
455     }
456
457     frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
458     frame.origin.x += [self frame].origin.x;
459     frame.origin.y += [self frame].origin.y;
460
461     dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
462     [dict2 setObject:self forKey:NSViewAnimationTargetKey];
463     [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
464
465     o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
466     [dict2 release];
467
468     [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
469     [o_fullscreen_anim2 setDuration: 0.3];
470     [o_fullscreen_anim2 setFrameRate: 30];
471
472     [o_fullscreen_anim2 setDelegate: self];
473
474     dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
475
476     [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
477     [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
478     [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
479
480     o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
481     [dict1 release];
482
483     [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
484     [o_fullscreen_anim1 setDuration: 0.2];
485     [o_fullscreen_anim1 setFrameRate: 30];
486     [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
487
488     /* Make sure o_fullscreen_window is the frontmost window */
489     [o_fullscreen_window orderFront: self];
490
491     [o_fullscreen_anim1 startAnimation];
492     /* fullscreenAnimation will be unlocked when animation ends */
493 }
494
495 - (void)hasEndedFullscreen
496 {
497     /* This function is private and should be only triggered at the end of the fullscreen change animation */
498     /* Make sure we don't see the o_view disappearing of the screen during this operation */
499     DisableScreenUpdates();
500     [o_view retain];
501     [o_view removeFromSuperviewWithoutNeedingDisplay];
502     [[self contentView] replaceSubview:o_temp_view with:o_view];
503     [o_view release];
504     [o_view setFrame:[o_temp_view frame]];
505     [self makeFirstResponder: o_view];
506     if ([self isVisible])
507         [super makeKeyAndOrderFront:self]; /* our version contains a workaround */
508     [o_fullscreen_window orderOut: self];
509     EnableScreenUpdates();
510
511     [o_fullscreen_window release];
512     o_fullscreen_window = nil;
513     [self setLevel:originalLevel];
514
515     [self unlockFullscreenAnimation];
516 }
517
518 - (void)animationDidEnd:(NSAnimation*)animation
519 {
520     NSArray *viewAnimations;
521
522     if ([animation currentValue] < 1.0)
523         return;
524
525     /* Fullscreen ended or started (we are a delegate only for leaveFullscreen's/enterFullscren's anim2) */
526     viewAnimations = [o_fullscreen_anim2 viewAnimations];
527     if ([viewAnimations count] >=1 &&
528         [[[viewAnimations objectAtIndex: 0] objectForKey: NSViewAnimationEffectKey] isEqualToString:NSViewAnimationFadeInEffect])
529     {
530         /* Fullscreen ended */
531         [self hasEndedFullscreen];
532     }
533     else
534     {
535         /* Fullscreen started */
536         [self hasBecomeFullscreen];
537     }
538 }
539
540 - (void)orderOut: (id)sender
541 {
542     [super orderOut: sender];
543
544     /* Make sure we leave fullscreen */
545     [self leaveFullscreenAndFadeOut: YES];
546 }
547
548 - (void)makeKeyAndOrderFront: (id)sender
549 {
550     /* Hack
551      * when we exit fullscreen and fade out, we may endup in
552      * having a window that is faded. We can't have it fade in unless we
553      * animate again. */
554
555     if(!b_window_is_invisible)
556     {
557         /* Make sure we don't do it too much */
558         [super makeKeyAndOrderFront: sender];
559         return;
560     }
561
562     [super setAlphaValue:0.0f];
563     [super makeKeyAndOrderFront: sender];
564
565     NSMutableDictionary * dict = [[[NSMutableDictionary alloc] initWithCapacity:2] autorelease];
566     [dict setObject:self forKey:NSViewAnimationTargetKey];
567     [dict setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
568
569     NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObject:dict]];
570
571     [anim setAnimationBlockingMode: NSAnimationNonblocking];
572     [anim setDuration: 0.1];
573     [anim setFrameRate: 30];
574
575     [anim startAnimation];
576     b_window_is_invisible = NO;
577
578     /* fullscreenAnimation will be unlocked when animation ends */
579 }
580
581
582
583 /* Make sure setFrame gets executed on main thread especially if we are animating.
584  * (Thus we won't block the video output thread) */
585 - (void)setFrame:(NSRect)frame display:(BOOL)display animate:(BOOL)animate
586 {
587     struct { NSRect frame; BOOL display; BOOL animate;} args;
588     NSData *packedargs;
589
590     args.frame = frame;
591     args.display = display;
592     args.animate = animate;
593
594     packedargs = [NSData dataWithBytes:&args length:sizeof(args)];
595
596     [self performSelectorOnMainThread:@selector(setFrameOnMainThread:)
597                     withObject: packedargs waitUntilDone: YES];
598 }
599
600 - (void)setFrameOnMainThread:(NSData*)packedargs
601 {
602     struct args { NSRect frame; BOOL display; BOOL animate; } * args = (struct args*)[packedargs bytes];
603
604     [super setFrame: args->frame display: args->display animate:args->animate];
605 }
606 @end