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 [self setMovableByWindowBackground:YES];
75 [self setDelegate:self];
77 /* Make sure setVisible: returns NO */
79 b_window_is_invisible = YES;
80 videoRatio = NSMakeSize( 0., 0. );
83 - (void)controlTintChanged
86 if( [o_btn_play alternateImage] == o_img_play_pressed )
89 if( [NSColor currentControlTint] == NSGraphiteControlTint )
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"]];
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"]];
107 [o_btn_play setAlternateImage: o_img_play_pressed];
109 [o_btn_play setAlternateImage: o_img_pause_pressed];
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];
123 - (void)setTime:(NSString *)o_arg_time position:(float)f_position
125 [o_time setStringValue: o_arg_time];
126 [o_slider setFloatValue: f_position];
129 - (void)playStatusUpdated:(int)i_status
131 if( i_status == PLAYING_S )
133 [o_btn_play setImage: o_img_pause];
134 [o_btn_play setAlternateImage: o_img_pause_pressed];
135 [o_btn_play setToolTip: _NS("Pause")];
139 [o_btn_play setImage: o_img_play];
140 [o_btn_play setAlternateImage: o_img_play_pressed];
141 [o_btn_play setToolTip: _NS("Play")];
145 - (void)setSeekable:(BOOL)b_seekable
147 [o_btn_forward setEnabled: b_seekable];
148 [o_btn_backward setEnabled: b_seekable];
149 [o_slider setEnabled: b_seekable];
152 - (BOOL)windowShouldZoom:(NSWindow *)sender toFrame:(NSRect)newFrame
154 [self setFrame: newFrame display: YES animate: YES];
158 - (BOOL)windowShouldClose:(id)sender
160 playlist_t * p_playlist = pl_Yield( VLCIntf );
162 playlist_Stop( p_playlist );
163 vlc_object_release( p_playlist );
169 if (o_fullscreen_window)
175 - (void)setVideoRatio:(NSSize)ratio
180 - (NSSize)windowWillResize:(NSWindow *)window toSize:(NSSize)proposedFrameSize
182 if( videoRatio.height == 0. || videoRatio.width == 0. )
183 return proposedFrameSize;
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;
191 return proposedFrameSize;
194 /*****************************************************************************
203 - (void)lockFullscreenAnimation
205 [o_animation_lock lock];
208 - (void)unlockFullscreenAnimation
210 [o_animation_lock unlock];
213 - (void)enterFullscreen
215 NSMutableDictionary *dict1, *dict2;
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" );
222 screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )];
224 [self lockFullscreenAnimation];
228 msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
229 screen = [self screen];
233 msg_Dbg( p_vout, "Using deepest screen" );
234 screen = [NSScreen deepestScreen];
237 vlc_object_release( p_vout );
239 screen_rect = [screen frame];
241 [o_btn_fullscreen setState: YES];
243 [NSCursor setHiddenUntilMouseMoves: YES];
245 if( blackout_other_displays )
246 [screen blackoutOtherScreens];
248 /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
249 if (!o_fullscreen_window)
251 /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
253 rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
254 rect.origin.x += [self frame].origin.x;
255 rect.origin.y += [self frame].origin.y;
256 o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
257 [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
258 [o_fullscreen_window setCanBecomeKeyWindow: YES];
260 if (![self isVisible] || [self alphaValue] == 0.0 || MACOS_VERSION < 10.4f)
262 /* We don't animate if we are not visible or if we are running on
263 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
264 * simply fade the display */
265 CGDisplayFadeReservationToken token;
267 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
268 CGDisplayFade( token, 0.5, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
270 if ([screen isMainScreen])
271 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
273 [[self contentView] replaceSubview:o_view with:o_temp_view];
274 [o_temp_view setFrame:[o_view frame]];
275 [o_fullscreen_window setContentView:o_view];
277 [o_fullscreen_window makeKeyAndOrderFront:self];
279 [o_fullscreen_window makeKeyAndOrderFront:self];
280 [o_fullscreen_window orderFront:self animate:YES];
282 [o_fullscreen_window setFrame:screen_rect display:YES];
284 CGDisplayFade( token, 0.3, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
285 CGReleaseDisplayFadeReservation( token);
287 /* Will release the lock */
288 [self hasBecomeFullscreen];
293 /* Make sure we don't see the o_view disappearing of the screen during this operation */
294 DisableScreenUpdates();
295 [[self contentView] replaceSubview:o_view with:o_temp_view];
296 [o_temp_view setFrame:[o_view frame]];
297 [o_fullscreen_window setContentView:o_view];
298 [o_fullscreen_window makeKeyAndOrderFront:self];
299 EnableScreenUpdates();
302 if (MACOS_VERSION < 10.4f)
304 /* We were already fullscreen nothing to do when NSAnimation
305 * is not supported */
306 [self unlockFullscreenAnimation];
310 /* We are in fullscreen (and no animation is running) */
313 /* Make sure we are hidden */
314 [super orderOut: self];
315 [self unlockFullscreenAnimation];
319 if (o_fullscreen_anim1)
321 [o_fullscreen_anim1 stopAnimation];
322 [o_fullscreen_anim1 release];
324 if (o_fullscreen_anim2)
326 [o_fullscreen_anim2 stopAnimation];
327 [o_fullscreen_anim2 release];
330 if ([screen isMainScreen])
331 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
333 dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
334 dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
336 [dict1 setObject:self forKey:NSViewAnimationTargetKey];
337 [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
339 [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
340 [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
341 [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
343 /* Strategy with NSAnimation allocation:
344 - Keep at most 2 animation at a time
345 - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
347 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
348 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
353 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
354 [o_fullscreen_anim1 setDuration: 0.3];
355 [o_fullscreen_anim1 setFrameRate: 30];
356 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
357 [o_fullscreen_anim2 setDuration: 0.2];
358 [o_fullscreen_anim2 setFrameRate: 30];
360 [o_fullscreen_anim2 setDelegate: self];
361 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
363 [o_fullscreen_anim1 startAnimation];
364 /* fullscreenAnimation will be unlocked when animation ends */
367 - (void)hasBecomeFullscreen
369 [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] getControls] getVoutView]];
371 [o_fullscreen_window makeKeyWindow];
372 [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
374 /* tell the fspanel to move itself to front next time it's triggered */
375 [[[[VLCMain sharedInstance] getControls] getFSPanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
378 [super orderOut: self];
380 [[[[VLCMain sharedInstance] getControls] getFSPanel] setActive: nil];
383 [self unlockFullscreenAnimation];
386 - (void)leaveFullscreen
388 [self leaveFullscreenAndFadeOut: NO];
391 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
393 NSMutableDictionary *dict1, *dict2;
396 [self lockFullscreenAnimation];
399 [o_btn_fullscreen setState: NO];
401 /* We always try to do so */
402 [NSScreen unblackoutScreens];
404 /* Don't do anything if o_fullscreen_window is already closed */
405 if (!o_fullscreen_window)
407 [self unlockFullscreenAnimation];
411 if (fadeout || MACOS_VERSION < 10.4f)
413 /* We don't animate if we are not visible or if we are running on
414 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
415 * simply fade the display */
416 CGDisplayFadeReservationToken token;
418 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
419 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
421 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
422 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
424 /* Will release the lock */
425 [self hasEndedFullscreen];
427 /* Our window is hidden, and might be faded. We need to workaround that, so note it
429 b_window_is_invisible = YES;
431 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
432 CGReleaseDisplayFadeReservation( token);
436 [self setAlphaValue: 0.0];
437 [self orderFront: self];
439 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
440 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
442 if (o_fullscreen_anim1)
444 [o_fullscreen_anim1 stopAnimation];
445 [o_fullscreen_anim1 release];
447 if (o_fullscreen_anim2)
449 [o_fullscreen_anim2 stopAnimation];
450 [o_fullscreen_anim2 release];
453 frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
454 frame.origin.x += [self frame].origin.x;
455 frame.origin.y += [self frame].origin.y;
457 dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
458 [dict2 setObject:self forKey:NSViewAnimationTargetKey];
459 [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
461 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
464 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
465 [o_fullscreen_anim2 setDuration: 0.3];
466 [o_fullscreen_anim2 setFrameRate: 30];
468 [o_fullscreen_anim2 setDelegate: self];
470 dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
472 [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
473 [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
474 [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
476 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
479 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
480 [o_fullscreen_anim1 setDuration: 0.2];
481 [o_fullscreen_anim1 setFrameRate: 30];
482 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
484 /* Make sure o_fullscreen_window is the frontmost window */
485 [o_fullscreen_window orderFront: self];
487 [o_fullscreen_anim1 startAnimation];
488 /* fullscreenAnimation will be unlocked when animation ends */
491 - (void)hasEndedFullscreen
493 /* This function is private and should be only triggered at the end of the fullscreen change animation */
494 /* Make sure we don't see the o_view disappearing of the screen during this operation */
495 DisableScreenUpdates();
497 [o_view removeFromSuperviewWithoutNeedingDisplay];
498 [[self contentView] replaceSubview:o_temp_view with:o_view];
500 [o_view setFrame:[o_temp_view frame]];
501 [self makeFirstResponder: o_view];
502 if ([self isVisible])
503 [super makeKeyAndOrderFront:self]; /* our version contains a workaround */
504 [o_fullscreen_window orderOut: self];
505 EnableScreenUpdates();
507 [o_fullscreen_window release];
508 o_fullscreen_window = nil;
509 [self unlockFullscreenAnimation];
512 - (void)animationDidEnd:(NSAnimation*)animation
514 NSArray *viewAnimations;
516 if ([animation currentValue] < 1.0)
519 /* Fullscreen ended or started (we are a delegate only for leaveFullscreen's/enterFullscren's anim2) */
520 viewAnimations = [o_fullscreen_anim2 viewAnimations];
521 if ([viewAnimations count] >=1 &&
522 [[[viewAnimations objectAtIndex: 0] objectForKey: NSViewAnimationEffectKey] isEqualToString:NSViewAnimationFadeInEffect])
524 /* Fullscreen ended */
525 [self hasEndedFullscreen];
529 /* Fullscreen started */
530 [self hasBecomeFullscreen];
534 - (void)orderOut: (id)sender
536 [super orderOut: sender];
538 /* Make sure we leave fullscreen */
539 [self leaveFullscreenAndFadeOut: YES];
542 - (void)makeKeyAndOrderFront: (id)sender
545 * when we exit fullscreen and fade out, we may endup in
546 * having a window that is faded. We can't have it fade in unless we
549 if(!b_window_is_invisible)
551 /* Make sure we don't do it too much */
552 [super makeKeyAndOrderFront: sender];
556 [super setAlphaValue:0.0f];
557 [super makeKeyAndOrderFront: sender];
559 NSMutableDictionary * dict = [[[NSMutableDictionary alloc] initWithCapacity:2] autorelease];
560 [dict setObject:self forKey:NSViewAnimationTargetKey];
561 [dict setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
563 NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObject:dict]];
565 [anim setAnimationBlockingMode: NSAnimationNonblocking];
566 [anim setDuration: 0.1];
567 [anim setFrameRate: 30];
569 [anim startAnimation];
570 b_window_is_invisible = NO;
572 /* fullscreenAnimation will be unlocked when animation ends */
577 /* Make sure setFrame gets executed on main thread especially if we are animating.
578 * (Thus we won't block the video output thread) */
579 - (void)setFrame:(NSRect)frame display:(BOOL)display animate:(BOOL)animate
581 struct { NSRect frame; BOOL display; BOOL animate;} args;
585 args.display = display;
586 args.animate = animate;
588 packedargs = [NSData dataWithBytes:&args length:sizeof(args)];
590 [self performSelectorOnMainThread:@selector(setFrameOnMainThread:)
591 withObject: packedargs waitUntilDone: YES];
594 - (void)setFrameOnMainThread:(NSData*)packedargs
596 struct args { NSRect frame; BOOL display; BOOL animate; } * args = (struct args*)[packedargs bytes];
598 [super setFrame: args->frame display: args->display animate:args->animate];