1 /*****************************************************************************
2 * embeddedwindow.m: MacOS X interface module
3 *****************************************************************************
4 * Copyright (C) 2005-2008 the VideoLAN team
7 * Authors: Benjamin Pracht <bigben at videolan dot org>
8 * Felix Paul Kühne <fkuehne at videolan dot org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
29 /* DisableScreenUpdates, SetSystemUIMode, ... */
30 #import <QuickTime/QuickTime.h>
35 #import "embeddedwindow.h"
38 /*****************************************************************************
39 * VLCEmbeddedWindow Implementation
40 *****************************************************************************/
42 @implementation VLCEmbeddedWindow
46 [self setDelegate: self];
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")];
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
62 /* Useful to save o_view frame in fullscreen mode */
63 o_temp_view = [[NSView alloc] init];
64 [o_temp_view setAutoresizingMask:NSViewHeightSizable | NSViewWidthSizable];
66 o_fullscreen_window = nil;
67 o_fullscreen_anim1 = o_fullscreen_anim2 = nil;
69 /* Not fullscreen when we wake up */
70 [o_btn_fullscreen setState: NO];
72 /* Use a recursive lock to be able to trigger enter/leavefullscreen
73 * in middle of an animation, providing that the enter/leave functions
74 * are called from the same thread */
75 o_animation_lock = [[NSRecursiveLock alloc] init];
76 b_animation_lock_alreadylocked = NO;
79 - (void)controlTintChanged
82 if( [o_btn_play alternateImage] == o_img_play_pressed )
85 if( [NSColor currentControlTint] == NSGraphiteControlTint )
87 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_graphite"];
88 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_graphite"];
89 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_graphite"]];
90 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_graphite"]];
91 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_graphite"]];
95 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_blue"];
96 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_blue"];
97 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_blue"]];
98 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_blue"]];
99 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_blue"]];
103 [o_btn_play setAlternateImage: o_img_play_pressed];
105 [o_btn_play setAlternateImage: o_img_pause_pressed];
110 [[NSNotificationCenter defaultCenter] removeObserver: self];
111 [o_img_play release];
112 [o_img_play_pressed release];
113 [o_img_pause release];
114 [o_img_pause_pressed release];
119 - (void)setTime:(NSString *)o_arg_time position:(float)f_position
121 [o_time setStringValue: o_arg_time];
122 [o_slider setFloatValue: f_position];
125 - (void)playStatusUpdated:(int)i_status
127 if( i_status == PLAYING_S )
129 [o_btn_play setImage: o_img_pause];
130 [o_btn_play setAlternateImage: o_img_pause_pressed];
131 [o_btn_play setToolTip: _NS("Pause")];
135 [o_btn_play setImage: o_img_play];
136 [o_btn_play setAlternateImage: o_img_play_pressed];
137 [o_btn_play setToolTip: _NS("Play")];
141 - (void)setSeekable:(BOOL)b_seekable
143 [o_btn_forward setEnabled: b_seekable];
144 [o_btn_backward setEnabled: b_seekable];
145 [o_slider setEnabled: b_seekable];
148 - (BOOL)windowShouldZoom:(NSWindow *)sender toFrame:(NSRect)newFrame
150 [self setFrame: newFrame display: YES animate: YES];
154 - (BOOL)windowShouldClose:(id)sender
156 playlist_t * p_playlist = pl_Yield( VLCIntf );
158 playlist_Stop( p_playlist );
159 vlc_object_release( p_playlist );
165 if (o_fullscreen_window)
171 /*****************************************************************************
180 - (void)lockFullscreenAnimation
182 [o_animation_lock lock];
185 - (void)unlockFullscreenAnimation
187 [o_animation_lock unlock];
190 - (void)enterFullscreen
192 NSMutableDictionary *dict1, *dict2;
196 vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
197 BOOL blackout_other_displays = config_GetInt( VLCIntf, "macosx-black" );
199 screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )];
201 [self lockFullscreenAnimation];
205 msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
206 screen = [self screen];
209 vlc_object_release( p_vout );
211 screen_rect = [screen frame];
213 [o_btn_fullscreen setState: YES];
215 [NSCursor setHiddenUntilMouseMoves: YES];
217 if( blackout_other_displays )
218 [screen blackoutOtherScreens];
220 /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
221 if (!o_fullscreen_window)
223 /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
225 rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
226 rect.origin.x += [self frame].origin.x;
227 rect.origin.y += [self frame].origin.y;
228 o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
229 [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
230 [o_fullscreen_window setCanBecomeKeyWindow: YES];
232 if (![self isVisible] || [self alphaValue] == 0.0 || MACOS_VERSION < 10.4f)
234 /* We don't animate if we are not visible or if we are running on
235 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
236 * simply fade the display */
237 CGDisplayFadeReservationToken token;
239 [o_fullscreen_window setFrame:screen_rect display:NO];
241 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
242 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
244 if ([screen isMainScreen])
245 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
247 [[self contentView] replaceSubview:o_view with:o_temp_view];
248 [o_temp_view setFrame:[o_view frame]];
249 [o_fullscreen_window setContentView:o_view];
250 [o_fullscreen_window makeKeyAndOrderFront:self];
251 [self orderOut: self];
253 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
254 CGReleaseDisplayFadeReservation( token);
256 /* Will release the lock */
257 [self hasBecomeFullscreen];
262 /* Make sure we don't see the o_view disappearing of the screen during this operation */
263 DisableScreenUpdates();
264 [[self contentView] replaceSubview:o_view with:o_temp_view];
265 [o_temp_view setFrame:[o_view frame]];
266 [o_fullscreen_window setContentView:o_view];
267 [o_fullscreen_window makeKeyAndOrderFront:self];
268 EnableScreenUpdates();
271 if (MACOS_VERSION < 10.4f)
273 /* We were already fullscreen nothing to do when NSAnimation
274 * is not supported */
275 b_animation_lock_alreadylocked = NO;
276 [self unlockFullscreenAnimation];
280 /* We are in fullscreen (and no animation is running) */
283 /* Make sure we are hidden */
284 [super orderOut: self];
285 b_animation_lock_alreadylocked = NO;
286 [self unlockFullscreenAnimation];
290 if (o_fullscreen_anim1)
292 [o_fullscreen_anim1 stopAnimation];
293 [o_fullscreen_anim1 release];
295 if (o_fullscreen_anim2)
297 [o_fullscreen_anim2 stopAnimation];
298 [o_fullscreen_anim2 release];
301 /* This is a recursive lock. If we are already in the middle of an animation we
302 * unlock it. We don't add an extra locking here, because enter/leavefullscreen
303 * are executed always in the same thread */
304 if (b_animation_lock_alreadylocked)
305 [self unlockFullscreenAnimation];
306 b_animation_lock_alreadylocked = YES;
308 if ([screen isMainScreen])
309 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
311 dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
312 dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
314 [dict1 setObject:self forKey:NSViewAnimationTargetKey];
315 [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
317 [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
318 [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
319 [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
321 /* Strategy with NSAnimation allocation:
322 - Keep at most 2 animation at a time
323 - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
325 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
326 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
331 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
332 [o_fullscreen_anim1 setDuration: 0.3];
333 [o_fullscreen_anim1 setFrameRate: 30];
334 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
335 [o_fullscreen_anim2 setDuration: 0.2];
336 [o_fullscreen_anim2 setFrameRate: 30];
338 [o_fullscreen_anim2 setDelegate: self];
339 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
341 [o_fullscreen_anim1 startAnimation];
342 /* fullscreenAnimation will be unlocked when animation ends */
345 - (void)hasBecomeFullscreen
347 [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] getControls] getVoutView]];
349 [o_fullscreen_window makeKeyWindow];
350 [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
352 /* tell the fspanel to move itself to front next time it's triggered */
353 [[[[VLCMain sharedInstance] getControls] getFSPanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
355 [super orderOut: self];
357 [[[[VLCMain sharedInstance] getControls] getFSPanel] setActive: nil];
359 [self unlockFullscreenAnimation];
362 - (void)leaveFullscreen
364 [self leaveFullscreenAndFadeOut: NO];
367 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
369 NSMutableDictionary *dict1, *dict2;
372 [self lockFullscreenAnimation];
375 [o_btn_fullscreen setState: NO];
377 /* We always try to do so */
378 [NSScreen unblackoutScreens];
380 /* Don't do anything if o_fullscreen_window is already closed */
381 if (!o_fullscreen_window)
383 b_animation_lock_alreadylocked = NO;
384 [self unlockFullscreenAnimation];
388 if (fadeout || MACOS_VERSION < 10.4f)
390 /* We don't animate if we are not visible or if we are running on
391 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
392 * simply fade the display */
393 CGDisplayFadeReservationToken token;
395 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
396 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
398 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
399 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
401 /* Will release the lock */
402 [self hasEndedFullscreen];
404 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
405 CGReleaseDisplayFadeReservation( token);
409 [self setAlphaValue: 0.0];
410 [self orderFront: self];
412 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
413 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
415 if (o_fullscreen_anim1)
417 [o_fullscreen_anim1 stopAnimation];
418 [o_fullscreen_anim1 release];
420 if (o_fullscreen_anim2)
422 [o_fullscreen_anim2 stopAnimation];
423 [o_fullscreen_anim2 release];
426 /* This is a recursive lock. If we are already in the middle of an animation we
427 * unlock it. We don't add an extra locking here, because enter/leavefullscreen
428 * are executed always in the same thread */
429 if (b_animation_lock_alreadylocked)
430 [self unlockFullscreenAnimation];
431 b_animation_lock_alreadylocked = YES;
433 frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
434 frame.origin.x += [self frame].origin.x;
435 frame.origin.y += [self frame].origin.y;
437 dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
438 [dict2 setObject:self forKey:NSViewAnimationTargetKey];
439 [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
441 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
444 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
445 [o_fullscreen_anim2 setDuration: 0.3];
446 [o_fullscreen_anim2 setFrameRate: 30];
448 [o_fullscreen_anim2 setDelegate: self];
450 dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
452 [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
453 [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
454 [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
456 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
459 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
460 [o_fullscreen_anim1 setDuration: 0.2];
461 [o_fullscreen_anim1 setFrameRate: 30];
462 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
464 /* Make sure o_fullscreen_window is the frontmost window */
465 [o_fullscreen_window orderFront: self];
467 [o_fullscreen_anim1 startAnimation];
468 /* fullscreenAnimation will be unlocked when animation ends */
471 - (void)hasEndedFullscreen
473 /* This function is private and should be only triggered at the end of the fullscreen change animation */
474 /* Make sure we don't see the o_view disappearing of the screen during this operation */
475 DisableScreenUpdates();
477 [o_view removeFromSuperviewWithoutNeedingDisplay];
478 [[self contentView] replaceSubview:o_temp_view with:o_view];
480 [o_view setFrame:[o_temp_view frame]];
481 [self makeFirstResponder: o_view];
482 if ([self isVisible])
483 [self makeKeyAndOrderFront:self];
484 [o_fullscreen_window orderOut: self];
485 EnableScreenUpdates();
487 [o_fullscreen_window release];
488 o_fullscreen_window = nil;
489 b_animation_lock_alreadylocked = NO;
490 [self unlockFullscreenAnimation];
493 - (void)animationDidEnd:(NSAnimation*)animation
495 NSArray *viewAnimations;
497 if ([animation currentValue] < 1.0)
500 /* Fullscreen ended or started (we are a delegate only for leaveFullscreen's/enterFullscren's anim2) */
501 viewAnimations = [o_fullscreen_anim2 viewAnimations];
502 if ([viewAnimations count] >=1 &&
503 [[[viewAnimations objectAtIndex: 0] objectForKey: NSViewAnimationEffectKey] isEqualToString:NSViewAnimationFadeInEffect])
505 /* Fullscreen ended */
506 [self hasEndedFullscreen];
510 /* Fullscreen started */
511 [self hasBecomeFullscreen];
515 - (void)orderOut: (id)sender
517 [super orderOut: sender];
518 /* Make sure we leave fullscreen */
519 [self leaveFullscreenAndFadeOut: YES];
522 /* Make sure setFrame gets executed on main thread especially if we are animating.
523 * (Thus we won't block the video output thread) */
524 - (void)setFrame:(NSRect)frame display:(BOOL)display animate:(BOOL)animate
526 struct { NSRect frame; BOOL display; BOOL animate;} args;
530 args.display = display;
531 args.animate = animate;
533 packedargs = [NSData dataWithBytes:&args length:sizeof(args)];
535 [self performSelectorOnMainThread:@selector(setFrameOnMainThread:)
536 withObject: packedargs waitUntilDone: YES];
539 - (void)setFrameOnMainThread:(NSData*)packedargs
541 struct args { NSRect frame; BOOL display; BOOL animate; } * args = (struct args*)[packedargs bytes];
543 [super setFrame: args->frame display: args->display animate:args->animate];