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 setDelegate:self];
75 /* Make sure setVisible: returns NO */
77 b_window_is_invisible = YES;
78 videoRatio = NSMakeSize( 0., 0. );
81 - (void)controlTintChanged
84 if( [o_btn_play alternateImage] == o_img_play_pressed )
87 if( [NSColor currentControlTint] == NSGraphiteControlTint )
89 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_graphite"];
90 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_graphite"];
91 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_graphite"]];
92 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_graphite"]];
93 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_graphite"]];
97 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_blue"];
98 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_blue"];
99 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_blue"]];
100 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_blue"]];
101 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_blue"]];
105 [o_btn_play setAlternateImage: o_img_play_pressed];
107 [o_btn_play setAlternateImage: o_img_pause_pressed];
112 [[NSNotificationCenter defaultCenter] removeObserver: self];
113 [o_img_play release];
114 [o_img_play_pressed release];
115 [o_img_pause release];
116 [o_img_pause_pressed release];
121 - (void)setTime:(NSString *)o_arg_time position:(float)f_position
123 [o_time setStringValue: o_arg_time];
124 [o_slider setFloatValue: f_position];
127 - (void)playStatusUpdated:(int)i_status
129 if( i_status == PLAYING_S )
131 [o_btn_play setImage: o_img_pause];
132 [o_btn_play setAlternateImage: o_img_pause_pressed];
133 [o_btn_play setToolTip: _NS("Pause")];
137 [o_btn_play setImage: o_img_play];
138 [o_btn_play setAlternateImage: o_img_play_pressed];
139 [o_btn_play setToolTip: _NS("Play")];
143 - (void)setSeekable:(BOOL)b_seekable
145 [o_btn_forward setEnabled: b_seekable];
146 [o_btn_backward setEnabled: b_seekable];
147 [o_slider setEnabled: b_seekable];
150 - (BOOL)windowShouldZoom:(NSWindow *)sender toFrame:(NSRect)newFrame
152 [self setFrame: newFrame display: YES animate: YES];
156 - (BOOL)windowShouldClose:(id)sender
158 playlist_t * p_playlist = pl_Yield( VLCIntf );
160 playlist_Stop( p_playlist );
161 vlc_object_release( p_playlist );
167 if (o_fullscreen_window)
173 - (void)setVideoRatio:(NSSize)ratio
178 - (NSSize)windowWillResize:(NSWindow *)window toSize:(NSSize)proposedFrameSize
180 if( videoRatio.height == 0. || videoRatio.width == 0. )
181 return proposedFrameSize;
183 NSRect viewRect = [o_view convertRect:[o_view bounds] toView: nil];
184 NSRect contentRect = [self contentRectForFrameRect:[self frame]];
185 float marginy = viewRect.origin.y + [self frame].size.height - contentRect.size.height;
186 float marginx = contentRect.size.width - viewRect.size.width;
187 proposedFrameSize.height = (proposedFrameSize.width - marginx) * videoRatio.height / videoRatio.width + marginy;
189 return proposedFrameSize;
192 /*****************************************************************************
201 - (void)lockFullscreenAnimation
203 [o_animation_lock lock];
206 - (void)unlockFullscreenAnimation
208 [o_animation_lock unlock];
211 - (void)enterFullscreen
213 NSMutableDictionary *dict1, *dict2;
217 vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
218 BOOL blackout_other_displays = config_GetInt( VLCIntf, "macosx-black" );
220 screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )];
222 [self lockFullscreenAnimation];
226 msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
227 screen = [self screen];
231 msg_Dbg( p_vout, "Using deepest screen" );
232 screen = [NSScreen deepestScreen];
235 vlc_object_release( p_vout );
237 screen_rect = [screen frame];
239 [o_btn_fullscreen setState: YES];
241 [NSCursor setHiddenUntilMouseMoves: YES];
243 if( blackout_other_displays )
244 [screen blackoutOtherScreens];
246 /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
247 if (!o_fullscreen_window)
249 /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
251 rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
252 rect.origin.x += [self frame].origin.x;
253 rect.origin.y += [self frame].origin.y;
254 o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
255 [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
256 [o_fullscreen_window setCanBecomeKeyWindow: YES];
258 if (![self isVisible] || [self alphaValue] == 0.0 || MACOS_VERSION < 10.4f)
260 /* We don't animate if we are not visible or if we are running on
261 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
262 * simply fade the display */
263 CGDisplayFadeReservationToken token;
265 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
266 CGDisplayFade( token, 0.5, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
268 if ([screen isMainScreen])
269 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
271 [[self contentView] replaceSubview:o_view with:o_temp_view];
272 [o_temp_view setFrame:[o_view frame]];
273 [o_fullscreen_window setContentView:o_view];
275 [o_fullscreen_window makeKeyAndOrderFront:self];
277 [o_fullscreen_window makeKeyAndOrderFront:self];
278 [o_fullscreen_window orderFront:self animate:YES];
280 [o_fullscreen_window setFrame:screen_rect display:YES];
282 CGDisplayFade( token, 0.3, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
283 CGReleaseDisplayFadeReservation( token);
285 /* Will release the lock */
286 [self hasBecomeFullscreen];
291 /* Make sure we don't see the o_view disappearing of the screen during this operation */
292 DisableScreenUpdates();
293 [[self contentView] replaceSubview:o_view with:o_temp_view];
294 [o_temp_view setFrame:[o_view frame]];
295 [o_fullscreen_window setContentView:o_view];
296 [o_fullscreen_window makeKeyAndOrderFront:self];
297 EnableScreenUpdates();
300 if (MACOS_VERSION < 10.4f)
302 /* We were already fullscreen nothing to do when NSAnimation
303 * is not supported */
304 [self unlockFullscreenAnimation];
308 /* We are in fullscreen (and no animation is running) */
311 /* Make sure we are hidden */
312 [super orderOut: self];
313 [self unlockFullscreenAnimation];
317 if (o_fullscreen_anim1)
319 [o_fullscreen_anim1 stopAnimation];
320 [o_fullscreen_anim1 release];
322 if (o_fullscreen_anim2)
324 [o_fullscreen_anim2 stopAnimation];
325 [o_fullscreen_anim2 release];
328 if ([screen isMainScreen])
329 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
331 dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
332 dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
334 [dict1 setObject:self forKey:NSViewAnimationTargetKey];
335 [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
337 [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
338 [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
339 [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
341 /* Strategy with NSAnimation allocation:
342 - Keep at most 2 animation at a time
343 - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
345 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
346 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
351 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
352 [o_fullscreen_anim1 setDuration: 0.3];
353 [o_fullscreen_anim1 setFrameRate: 30];
354 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
355 [o_fullscreen_anim2 setDuration: 0.2];
356 [o_fullscreen_anim2 setFrameRate: 30];
358 [o_fullscreen_anim2 setDelegate: self];
359 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
361 [o_fullscreen_anim1 startAnimation];
362 /* fullscreenAnimation will be unlocked when animation ends */
365 - (void)hasBecomeFullscreen
367 [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] getControls] getVoutView]];
369 [o_fullscreen_window makeKeyWindow];
370 [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
372 /* tell the fspanel to move itself to front next time it's triggered */
373 [[[[VLCMain sharedInstance] getControls] getFSPanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
376 [super orderOut: self];
378 [[[[VLCMain sharedInstance] getControls] getFSPanel] setActive: nil];
381 [self unlockFullscreenAnimation];
384 - (void)leaveFullscreen
386 [self leaveFullscreenAndFadeOut: NO];
389 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
391 NSMutableDictionary *dict1, *dict2;
394 [self lockFullscreenAnimation];
397 [o_btn_fullscreen setState: NO];
399 /* We always try to do so */
400 [NSScreen unblackoutScreens];
402 /* Don't do anything if o_fullscreen_window is already closed */
403 if (!o_fullscreen_window)
405 [self unlockFullscreenAnimation];
409 if (fadeout || MACOS_VERSION < 10.4f)
411 /* We don't animate if we are not visible or if we are running on
412 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
413 * simply fade the display */
414 CGDisplayFadeReservationToken token;
416 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
417 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
419 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
420 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
422 /* Will release the lock */
423 [self hasEndedFullscreen];
425 /* Our window is hidden, and might be faded. We need to workaround that, so note it
427 b_window_is_invisible = YES;
429 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
430 CGReleaseDisplayFadeReservation( token);
434 [self setAlphaValue: 0.0];
435 [self orderFront: self];
437 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
438 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
440 if (o_fullscreen_anim1)
442 [o_fullscreen_anim1 stopAnimation];
443 [o_fullscreen_anim1 release];
445 if (o_fullscreen_anim2)
447 [o_fullscreen_anim2 stopAnimation];
448 [o_fullscreen_anim2 release];
451 frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
452 frame.origin.x += [self frame].origin.x;
453 frame.origin.y += [self frame].origin.y;
455 dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
456 [dict2 setObject:self forKey:NSViewAnimationTargetKey];
457 [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
459 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
462 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
463 [o_fullscreen_anim2 setDuration: 0.3];
464 [o_fullscreen_anim2 setFrameRate: 30];
466 [o_fullscreen_anim2 setDelegate: self];
468 dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
470 [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
471 [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
472 [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
474 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
477 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
478 [o_fullscreen_anim1 setDuration: 0.2];
479 [o_fullscreen_anim1 setFrameRate: 30];
480 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
482 /* Make sure o_fullscreen_window is the frontmost window */
483 [o_fullscreen_window orderFront: self];
485 [o_fullscreen_anim1 startAnimation];
486 /* fullscreenAnimation will be unlocked when animation ends */
489 - (void)hasEndedFullscreen
491 /* This function is private and should be only triggered at the end of the fullscreen change animation */
492 /* Make sure we don't see the o_view disappearing of the screen during this operation */
493 DisableScreenUpdates();
495 [o_view removeFromSuperviewWithoutNeedingDisplay];
496 [[self contentView] replaceSubview:o_temp_view with:o_view];
498 [o_view setFrame:[o_temp_view frame]];
499 [self makeFirstResponder: o_view];
500 if ([self isVisible])
501 [super makeKeyAndOrderFront:self]; /* our version contains a workaround */
502 [o_fullscreen_window orderOut: self];
503 EnableScreenUpdates();
505 [o_fullscreen_window release];
506 o_fullscreen_window = nil;
507 [self unlockFullscreenAnimation];
510 - (void)animationDidEnd:(NSAnimation*)animation
512 NSArray *viewAnimations;
514 if ([animation currentValue] < 1.0)
517 /* Fullscreen ended or started (we are a delegate only for leaveFullscreen's/enterFullscren's anim2) */
518 viewAnimations = [o_fullscreen_anim2 viewAnimations];
519 if ([viewAnimations count] >=1 &&
520 [[[viewAnimations objectAtIndex: 0] objectForKey: NSViewAnimationEffectKey] isEqualToString:NSViewAnimationFadeInEffect])
522 /* Fullscreen ended */
523 [self hasEndedFullscreen];
527 /* Fullscreen started */
528 [self hasBecomeFullscreen];
532 - (void)orderOut: (id)sender
534 [super orderOut: sender];
536 /* Make sure we leave fullscreen */
537 [self leaveFullscreenAndFadeOut: YES];
540 - (void)makeKeyAndOrderFront: (id)sender
543 * when we exit fullscreen and fade out, we may endup in
544 * having a window that is faded. We can't have it fade in unless we
547 if(!b_window_is_invisible)
549 /* Make sure we don't do it too much */
550 [super makeKeyAndOrderFront: sender];
554 [super setAlphaValue:0.0f];
555 [super makeKeyAndOrderFront: sender];
557 NSMutableDictionary * dict = [[[NSMutableDictionary alloc] initWithCapacity:2] autorelease];
558 [dict setObject:self forKey:NSViewAnimationTargetKey];
559 [dict setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
561 NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObject:dict]];
563 [anim setAnimationBlockingMode: NSAnimationNonblocking];
564 [anim setDuration: 0.1];
565 [anim setFrameRate: 30];
567 [anim startAnimation];
568 b_window_is_invisible = NO;
570 /* fullscreenAnimation will be unlocked when animation ends */
575 /* Make sure setFrame gets executed on main thread especially if we are animating.
576 * (Thus we won't block the video output thread) */
577 - (void)setFrame:(NSRect)frame display:(BOOL)display animate:(BOOL)animate
579 struct { NSRect frame; BOOL display; BOOL animate;} args;
583 args.display = display;
584 args.animate = animate;
586 packedargs = [NSData dataWithBytes:&args length:sizeof(args)];
588 [self performSelectorOnMainThread:@selector(setFrameOnMainThread:)
589 withObject: packedargs waitUntilDone: YES];
592 - (void)setFrameOnMainThread:(NSData*)packedargs
594 struct args { NSRect frame; BOOL display; BOOL animate; } * args = (struct args*)[packedargs bytes];
596 [super setFrame: args->frame display: args->display animate:args->animate];