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];
73 /* Make sure setVisible: returns NO */
77 - (void)controlTintChanged
80 if( [o_btn_play alternateImage] == o_img_play_pressed )
83 if( [NSColor currentControlTint] == NSGraphiteControlTint )
85 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_graphite"];
86 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_graphite"];
87 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_graphite"]];
88 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_graphite"]];
89 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_graphite"]];
93 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_blue"];
94 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_blue"];
95 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_blue"]];
96 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_blue"]];
97 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_blue"]];
101 [o_btn_play setAlternateImage: o_img_play_pressed];
103 [o_btn_play setAlternateImage: o_img_pause_pressed];
108 [[NSNotificationCenter defaultCenter] removeObserver: self];
109 [o_img_play release];
110 [o_img_play_pressed release];
111 [o_img_pause release];
112 [o_img_pause_pressed release];
117 - (void)setTime:(NSString *)o_arg_time position:(float)f_position
119 [o_time setStringValue: o_arg_time];
120 [o_slider setFloatValue: f_position];
123 - (void)playStatusUpdated:(int)i_status
125 if( i_status == PLAYING_S )
127 [o_btn_play setImage: o_img_pause];
128 [o_btn_play setAlternateImage: o_img_pause_pressed];
129 [o_btn_play setToolTip: _NS("Pause")];
133 [o_btn_play setImage: o_img_play];
134 [o_btn_play setAlternateImage: o_img_play_pressed];
135 [o_btn_play setToolTip: _NS("Play")];
139 - (void)setSeekable:(BOOL)b_seekable
141 [o_btn_forward setEnabled: b_seekable];
142 [o_btn_backward setEnabled: b_seekable];
143 [o_slider setEnabled: b_seekable];
146 - (BOOL)windowShouldZoom:(NSWindow *)sender toFrame:(NSRect)newFrame
148 [self setFrame: newFrame display: YES animate: YES];
152 - (BOOL)windowShouldClose:(id)sender
154 playlist_t * p_playlist = pl_Yield( VLCIntf );
156 playlist_Stop( p_playlist );
157 vlc_object_release( p_playlist );
163 if (o_fullscreen_window)
169 /*****************************************************************************
178 - (void)lockFullscreenAnimation
180 [o_animation_lock lock];
183 - (void)unlockFullscreenAnimation
185 [o_animation_lock unlock];
188 - (void)enterFullscreen
190 NSMutableDictionary *dict1, *dict2;
194 vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
195 BOOL blackout_other_displays = config_GetInt( VLCIntf, "macosx-black" );
197 screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )];
199 [self lockFullscreenAnimation];
203 msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
204 screen = [self screen];
208 msg_Dbg( p_vout, "Using deepest screen" );
209 screen = [NSScreen deepestScreen];
212 vlc_object_release( p_vout );
214 screen_rect = [screen frame];
216 [o_btn_fullscreen setState: YES];
218 [NSCursor setHiddenUntilMouseMoves: YES];
220 if( blackout_other_displays )
221 [screen blackoutOtherScreens];
223 /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
224 if (!o_fullscreen_window)
226 /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
228 rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
229 rect.origin.x += [self frame].origin.x;
230 rect.origin.y += [self frame].origin.y;
231 o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
232 [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
233 [o_fullscreen_window setCanBecomeKeyWindow: YES];
235 if (![self isVisible] || [self alphaValue] == 0.0 || MACOS_VERSION < 10.4f)
237 /* We don't animate if we are not visible or if we are running on
238 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
239 * simply fade the display */
240 CGDisplayFadeReservationToken token;
242 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
243 CGDisplayFade( token, 0.5, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
245 if ([screen isMainScreen])
246 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
248 [[self contentView] replaceSubview:o_view with:o_temp_view];
249 [o_temp_view setFrame:[o_view frame]];
250 [o_fullscreen_window setContentView:o_view];
252 [o_fullscreen_window makeKeyAndOrderFront:self];
254 [o_fullscreen_window makeKeyAndOrderFront:self];
255 [o_fullscreen_window orderFront:self animate:YES];
257 [o_fullscreen_window setFrame:screen_rect display:YES];
259 CGDisplayFade( token, 0.3, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
260 CGReleaseDisplayFadeReservation( token);
262 /* Will release the lock */
263 [self hasBecomeFullscreen];
268 /* Make sure we don't see the o_view disappearing of the screen during this operation */
269 DisableScreenUpdates();
270 [[self contentView] replaceSubview:o_view with:o_temp_view];
271 [o_temp_view setFrame:[o_view frame]];
272 [o_fullscreen_window setContentView:o_view];
273 [o_fullscreen_window makeKeyAndOrderFront:self];
274 EnableScreenUpdates();
277 if (MACOS_VERSION < 10.4f)
279 /* We were already fullscreen nothing to do when NSAnimation
280 * is not supported */
281 [self unlockFullscreenAnimation];
285 /* We are in fullscreen (and no animation is running) */
288 /* Make sure we are hidden */
289 [super orderOut: self];
290 [self unlockFullscreenAnimation];
294 if (o_fullscreen_anim1)
296 [o_fullscreen_anim1 stopAnimation];
297 [o_fullscreen_anim1 release];
299 if (o_fullscreen_anim2)
301 [o_fullscreen_anim2 stopAnimation];
302 [o_fullscreen_anim2 release];
305 if ([screen isMainScreen])
306 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
308 dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
309 dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
311 [dict1 setObject:self forKey:NSViewAnimationTargetKey];
312 [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
314 [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
315 [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
316 [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
318 /* Strategy with NSAnimation allocation:
319 - Keep at most 2 animation at a time
320 - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
322 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
323 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
328 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
329 [o_fullscreen_anim1 setDuration: 0.3];
330 [o_fullscreen_anim1 setFrameRate: 30];
331 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
332 [o_fullscreen_anim2 setDuration: 0.2];
333 [o_fullscreen_anim2 setFrameRate: 30];
335 [o_fullscreen_anim2 setDelegate: self];
336 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
338 [o_fullscreen_anim1 startAnimation];
339 /* fullscreenAnimation will be unlocked when animation ends */
342 - (void)hasBecomeFullscreen
344 [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] getControls] getVoutView]];
346 [o_fullscreen_window makeKeyWindow];
347 [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
349 /* tell the fspanel to move itself to front next time it's triggered */
350 [[[[VLCMain sharedInstance] getControls] getFSPanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
353 [super orderOut: self];
355 [[[[VLCMain sharedInstance] getControls] getFSPanel] setActive: nil];
358 [self unlockFullscreenAnimation];
361 - (void)leaveFullscreen
363 [self leaveFullscreenAndFadeOut: NO];
366 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
368 NSMutableDictionary *dict1, *dict2;
371 [self lockFullscreenAnimation];
374 [o_btn_fullscreen setState: NO];
376 /* We always try to do so */
377 [NSScreen unblackoutScreens];
379 /* Don't do anything if o_fullscreen_window is already closed */
380 if (!o_fullscreen_window)
382 [self unlockFullscreenAnimation];
386 if (fadeout || MACOS_VERSION < 10.4f)
388 /* We don't animate if we are not visible or if we are running on
389 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
390 * simply fade the display */
391 CGDisplayFadeReservationToken token;
393 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
394 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
396 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
397 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
399 /* Will release the lock */
400 [self hasEndedFullscreen];
402 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
403 CGReleaseDisplayFadeReservation( token);
407 [self setAlphaValue: 0.0];
408 [self orderFront: self];
410 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
411 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
413 if (o_fullscreen_anim1)
415 [o_fullscreen_anim1 stopAnimation];
416 [o_fullscreen_anim1 release];
418 if (o_fullscreen_anim2)
420 [o_fullscreen_anim2 stopAnimation];
421 [o_fullscreen_anim2 release];
424 frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
425 frame.origin.x += [self frame].origin.x;
426 frame.origin.y += [self frame].origin.y;
428 dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
429 [dict2 setObject:self forKey:NSViewAnimationTargetKey];
430 [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
432 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
435 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
436 [o_fullscreen_anim2 setDuration: 0.3];
437 [o_fullscreen_anim2 setFrameRate: 30];
439 [o_fullscreen_anim2 setDelegate: self];
441 dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
443 [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
444 [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
445 [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
447 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
450 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
451 [o_fullscreen_anim1 setDuration: 0.2];
452 [o_fullscreen_anim1 setFrameRate: 30];
453 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
455 /* Make sure o_fullscreen_window is the frontmost window */
456 [o_fullscreen_window orderFront: self];
458 [o_fullscreen_anim1 startAnimation];
459 /* fullscreenAnimation will be unlocked when animation ends */
462 - (void)hasEndedFullscreen
464 /* This function is private and should be only triggered at the end of the fullscreen change animation */
465 /* Make sure we don't see the o_view disappearing of the screen during this operation */
466 DisableScreenUpdates();
468 [o_view removeFromSuperviewWithoutNeedingDisplay];
469 [[self contentView] replaceSubview:o_temp_view with:o_view];
471 [o_view setFrame:[o_temp_view frame]];
472 [self makeFirstResponder: o_view];
473 if ([self isVisible])
474 [super makeKeyAndOrderFront:self]; /* our version contains a workaround */
475 [o_fullscreen_window orderOut: self];
476 EnableScreenUpdates();
478 [o_fullscreen_window release];
479 o_fullscreen_window = nil;
480 [self unlockFullscreenAnimation];
483 - (void)animationDidEnd:(NSAnimation*)animation
485 NSArray *viewAnimations;
487 if ([animation currentValue] < 1.0)
490 /* Fullscreen ended or started (we are a delegate only for leaveFullscreen's/enterFullscren's anim2) */
491 viewAnimations = [o_fullscreen_anim2 viewAnimations];
492 if ([viewAnimations count] >=1 &&
493 [[[viewAnimations objectAtIndex: 0] objectForKey: NSViewAnimationEffectKey] isEqualToString:NSViewAnimationFadeInEffect])
495 /* Fullscreen ended */
496 [self hasEndedFullscreen];
500 /* Fullscreen started */
501 [self hasBecomeFullscreen];
505 - (void)orderOut: (id)sender
507 [super orderOut: sender];
509 /* Make sure we leave fullscreen */
510 [self leaveFullscreenAndFadeOut: YES];
513 - (void)makeKeyAndOrderFront: (id)sender
516 * when we exit fullscreen and fade out, we may endup in
517 * having a window that is faded. We can't have it fade in unless we
520 [super setAlphaValue:0.0f];
521 [super makeKeyAndOrderFront: sender];
523 NSMutableDictionary * dict = [[[NSMutableDictionary alloc] initWithCapacity:2] autorelease];
524 [dict setObject:self forKey:NSViewAnimationTargetKey];
525 [dict setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
527 NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObject:dict]];
529 [anim setAnimationBlockingMode: NSAnimationNonblocking];
530 [anim setDuration: 0.1];
531 [anim setFrameRate: 30];
533 [anim startAnimation];
534 /* fullscreenAnimation will be unlocked when animation ends */
539 /* Make sure setFrame gets executed on main thread especially if we are animating.
540 * (Thus we won't block the video output thread) */
541 - (void)setFrame:(NSRect)frame display:(BOOL)display animate:(BOOL)animate
543 struct { NSRect frame; BOOL display; BOOL animate;} args;
547 args.display = display;
548 args.animate = animate;
550 packedargs = [NSData dataWithBytes:&args length:sizeof(args)];
552 [self performSelectorOnMainThread:@selector(setFrameOnMainThread:)
553 withObject: packedargs waitUntilDone: YES];
556 - (void)setFrameOnMainThread:(NSData*)packedargs
558 struct args { NSRect frame; BOOL display; BOOL animate; } * args = (struct args*)[packedargs bytes];
560 [super setFrame: args->frame display: args->display animate:args->animate];