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
44 - (id)initWithContentRect:(NSRect)contentRect styleMask:(unsigned int)windowStyle backing:(NSBackingStoreType)bufferingType defer:(BOOL)deferCreation
46 if(MACOS_VERSION < 10.5f)
47 return [super initWithContentRect:contentRect styleMask:windowStyle backing:bufferingType defer:deferCreation];
49 windowStyle ^= NSTexturedBackgroundWindowMask;
50 self = [super initWithContentRect:contentRect styleMask:windowStyle backing:bufferingType defer:deferCreation];
51 [self setContentBorderThickness:32.0 forEdge:NSMinYEdge];
58 [self setDelegate: self];
60 [o_btn_backward setToolTip: _NS("Rewind")];
61 [o_btn_forward setToolTip: _NS("Fast Forward")];
62 [o_btn_fullscreen setToolTip: _NS("Fullscreen")];
63 [o_btn_play setToolTip: _NS("Play")];
64 [o_slider setToolTip: _NS("Position")];
66 o_img_play = [NSImage imageNamed: @"play_embedded"];
67 o_img_pause = [NSImage imageNamed: @"pause_embedded"];
68 [self controlTintChanged];
69 [[NSNotificationCenter defaultCenter] addObserver: self
70 selector: @selector( controlTintChanged )
71 name: NSControlTintDidChangeNotification
74 /* Useful to save o_view frame in fullscreen mode */
75 o_temp_view = [[NSView alloc] init];
76 [o_temp_view setAutoresizingMask:NSViewHeightSizable | NSViewWidthSizable];
78 o_fullscreen_window = nil;
79 o_fullscreen_anim1 = o_fullscreen_anim2 = nil;
81 /* Not fullscreen when we wake up */
82 [o_btn_fullscreen setState: NO];
85 [self setMovableByWindowBackground:YES];
87 [self setDelegate:self];
89 /* Make sure setVisible: returns NO */
91 b_window_is_invisible = YES;
92 videoRatio = NSMakeSize( 0., 0. );
95 - (void)controlTintChanged
98 if( [o_btn_play alternateImage] == o_img_play_pressed )
101 if( [NSColor currentControlTint] == NSGraphiteControlTint )
103 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_graphite"];
104 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_graphite"];
105 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_graphite"]];
106 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_graphite"]];
107 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_graphite"]];
111 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_blue"];
112 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_blue"];
113 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_blue"]];
114 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_blue"]];
115 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_blue"]];
119 [o_btn_play setAlternateImage: o_img_play_pressed];
121 [o_btn_play setAlternateImage: o_img_pause_pressed];
126 [[NSNotificationCenter defaultCenter] removeObserver: self];
127 [o_img_play release];
128 [o_img_play_pressed release];
129 [o_img_pause release];
130 [o_img_pause_pressed release];
135 - (void)setTime:(NSString *)o_arg_time position:(float)f_position
137 [o_time setStringValue: o_arg_time];
138 [o_slider setFloatValue: f_position];
141 - (void)playStatusUpdated:(int)i_status
143 if( i_status == PLAYING_S )
145 [o_btn_play setImage: o_img_pause];
146 [o_btn_play setAlternateImage: o_img_pause_pressed];
147 [o_btn_play setToolTip: _NS("Pause")];
151 [o_btn_play setImage: o_img_play];
152 [o_btn_play setAlternateImage: o_img_play_pressed];
153 [o_btn_play setToolTip: _NS("Play")];
157 - (void)setSeekable:(BOOL)b_seekable
159 [o_btn_forward setEnabled: b_seekable];
160 [o_btn_backward setEnabled: b_seekable];
161 [o_slider setEnabled: b_seekable];
164 - (BOOL)windowShouldZoom:(NSWindow *)sender toFrame:(NSRect)newFrame
166 [self setFrame: newFrame display: YES animate: YES];
170 - (BOOL)windowShouldClose:(id)sender
172 playlist_t * p_playlist = pl_Yield( VLCIntf );
174 playlist_Stop( p_playlist );
175 vlc_object_release( p_playlist );
181 if (o_fullscreen_window)
187 - (void)setVideoRatio:(NSSize)ratio
192 - (NSSize)windowWillResize:(NSWindow *)window toSize:(NSSize)proposedFrameSize
194 if( videoRatio.height == 0. || videoRatio.width == 0. )
195 return proposedFrameSize;
197 NSRect viewRect = [o_view convertRect:[o_view bounds] toView: nil];
198 NSRect contentRect = [self contentRectForFrameRect:[self frame]];
199 float marginy = viewRect.origin.y + [self frame].size.height - contentRect.size.height;
200 float marginx = contentRect.size.width - viewRect.size.width;
201 proposedFrameSize.height = (proposedFrameSize.width - marginx) * videoRatio.height / videoRatio.width + marginy;
203 return proposedFrameSize;
206 /*****************************************************************************
215 - (void)lockFullscreenAnimation
217 [o_animation_lock lock];
220 - (void)unlockFullscreenAnimation
222 [o_animation_lock unlock];
225 - (void)enterFullscreen
227 NSMutableDictionary *dict1, *dict2;
231 vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
232 BOOL blackout_other_displays = config_GetInt( VLCIntf, "macosx-black" );
234 screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )];
236 [self lockFullscreenAnimation];
240 msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
241 screen = [self screen];
245 msg_Dbg( p_vout, "Using deepest screen" );
246 screen = [NSScreen deepestScreen];
249 vlc_object_release( p_vout );
251 screen_rect = [screen frame];
253 [o_btn_fullscreen setState: YES];
255 [NSCursor setHiddenUntilMouseMoves: YES];
257 if( blackout_other_displays )
258 [screen blackoutOtherScreens];
260 /* Make sure we don't see the window flashes in float-on-top mode */
261 originalLevel = [self level];
262 [self setLevel:NSNormalWindowLevel];
264 /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
265 if (!o_fullscreen_window)
267 /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
269 rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
270 rect.origin.x += [self frame].origin.x;
271 rect.origin.y += [self frame].origin.y;
272 o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
273 [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
274 [o_fullscreen_window setCanBecomeKeyWindow: YES];
276 if (![self isVisible] || [self alphaValue] == 0.0 || MACOS_VERSION < 10.4f)
278 /* We don't animate if we are not visible or if we are running on
279 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
280 * simply fade the display */
281 CGDisplayFadeReservationToken token;
283 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
284 CGDisplayFade( token, 0.5, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
286 if ([screen isMainScreen])
287 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
289 [[self contentView] replaceSubview:o_view with:o_temp_view];
290 [o_temp_view setFrame:[o_view frame]];
291 [o_fullscreen_window setContentView:o_view];
293 [o_fullscreen_window makeKeyAndOrderFront:self];
295 [o_fullscreen_window makeKeyAndOrderFront:self];
296 [o_fullscreen_window orderFront:self animate:YES];
298 [o_fullscreen_window setFrame:screen_rect display:YES];
300 CGDisplayFade( token, 0.3, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
301 CGReleaseDisplayFadeReservation( token);
303 /* Will release the lock */
304 [self hasBecomeFullscreen];
309 /* Make sure we don't see the o_view disappearing of the screen during this operation */
310 DisableScreenUpdates();
311 [[self contentView] replaceSubview:o_view with:o_temp_view];
312 [o_temp_view setFrame:[o_view frame]];
313 [o_fullscreen_window setContentView:o_view];
314 [o_fullscreen_window makeKeyAndOrderFront:self];
315 EnableScreenUpdates();
318 if (MACOS_VERSION < 10.4f)
320 /* We were already fullscreen nothing to do when NSAnimation
321 * is not supported */
322 [self unlockFullscreenAnimation];
326 /* We are in fullscreen (and no animation is running) */
329 /* Make sure we are hidden */
330 [super orderOut: self];
331 [self unlockFullscreenAnimation];
335 if (o_fullscreen_anim1)
337 [o_fullscreen_anim1 stopAnimation];
338 [o_fullscreen_anim1 release];
340 if (o_fullscreen_anim2)
342 [o_fullscreen_anim2 stopAnimation];
343 [o_fullscreen_anim2 release];
346 if ([screen isMainScreen])
347 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
349 dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
350 dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
352 [dict1 setObject:self forKey:NSViewAnimationTargetKey];
353 [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
355 [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
356 [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
357 [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
359 /* Strategy with NSAnimation allocation:
360 - Keep at most 2 animation at a time
361 - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
363 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
364 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
369 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
370 [o_fullscreen_anim1 setDuration: 0.3];
371 [o_fullscreen_anim1 setFrameRate: 30];
372 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
373 [o_fullscreen_anim2 setDuration: 0.2];
374 [o_fullscreen_anim2 setFrameRate: 30];
376 [o_fullscreen_anim2 setDelegate: self];
377 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
379 [o_fullscreen_anim1 startAnimation];
380 /* fullscreenAnimation will be unlocked when animation ends */
383 - (void)hasBecomeFullscreen
385 [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] getControls] getVoutView]];
387 [o_fullscreen_window makeKeyWindow];
388 [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
390 /* tell the fspanel to move itself to front next time it's triggered */
391 [[[[VLCMain sharedInstance] getControls] getFSPanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
394 [super orderOut: self];
396 [[[[VLCMain sharedInstance] getControls] getFSPanel] setActive: nil];
399 [self unlockFullscreenAnimation];
402 - (void)leaveFullscreen
404 [self leaveFullscreenAndFadeOut: NO];
407 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
409 NSMutableDictionary *dict1, *dict2;
412 [self lockFullscreenAnimation];
415 [o_btn_fullscreen setState: NO];
417 /* We always try to do so */
418 [NSScreen unblackoutScreens];
420 /* Don't do anything if o_fullscreen_window is already closed */
421 if (!o_fullscreen_window)
423 [self unlockFullscreenAnimation];
427 if (fadeout || MACOS_VERSION < 10.4f)
429 /* We don't animate if we are not visible or if we are running on
430 * Mac OS X <10.4 which doesn't support NSAnimation, instead we
431 * simply fade the display */
432 CGDisplayFadeReservationToken token;
434 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
435 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
437 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
438 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
440 /* Will release the lock */
441 [self hasEndedFullscreen];
443 /* Our window is hidden, and might be faded. We need to workaround that, so note it
445 b_window_is_invisible = YES;
447 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
448 CGReleaseDisplayFadeReservation( token);
452 [self setAlphaValue: 0.0];
453 [self orderFront: self];
455 [[[[VLCMain sharedInstance] getControls] getFSPanel] setNonActive: nil];
456 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
458 if (o_fullscreen_anim1)
460 [o_fullscreen_anim1 stopAnimation];
461 [o_fullscreen_anim1 release];
463 if (o_fullscreen_anim2)
465 [o_fullscreen_anim2 stopAnimation];
466 [o_fullscreen_anim2 release];
469 frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
470 frame.origin.x += [self frame].origin.x;
471 frame.origin.y += [self frame].origin.y;
473 dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
474 [dict2 setObject:self forKey:NSViewAnimationTargetKey];
475 [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
477 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
480 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
481 [o_fullscreen_anim2 setDuration: 0.3];
482 [o_fullscreen_anim2 setFrameRate: 30];
484 [o_fullscreen_anim2 setDelegate: self];
486 dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
488 [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
489 [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
490 [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
492 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
495 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
496 [o_fullscreen_anim1 setDuration: 0.2];
497 [o_fullscreen_anim1 setFrameRate: 30];
498 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
500 /* Make sure o_fullscreen_window is the frontmost window */
501 [o_fullscreen_window orderFront: self];
503 [o_fullscreen_anim1 startAnimation];
504 /* fullscreenAnimation will be unlocked when animation ends */
507 - (void)hasEndedFullscreen
509 /* This function is private and should be only triggered at the end of the fullscreen change animation */
510 /* Make sure we don't see the o_view disappearing of the screen during this operation */
511 DisableScreenUpdates();
513 [o_view removeFromSuperviewWithoutNeedingDisplay];
514 [[self contentView] replaceSubview:o_temp_view with:o_view];
516 [o_view setFrame:[o_temp_view frame]];
517 [self makeFirstResponder: o_view];
518 if ([self isVisible])
519 [super makeKeyAndOrderFront:self]; /* our version contains a workaround */
520 [o_fullscreen_window orderOut: self];
521 EnableScreenUpdates();
523 [o_fullscreen_window release];
524 o_fullscreen_window = nil;
525 [self setLevel:originalLevel];
527 [self unlockFullscreenAnimation];
530 - (void)animationDidEnd:(NSAnimation*)animation
532 NSArray *viewAnimations;
534 if ([animation currentValue] < 1.0)
537 /* Fullscreen ended or started (we are a delegate only for leaveFullscreen's/enterFullscren's anim2) */
538 viewAnimations = [o_fullscreen_anim2 viewAnimations];
539 if ([viewAnimations count] >=1 &&
540 [[[viewAnimations objectAtIndex: 0] objectForKey: NSViewAnimationEffectKey] isEqualToString:NSViewAnimationFadeInEffect])
542 /* Fullscreen ended */
543 [self hasEndedFullscreen];
547 /* Fullscreen started */
548 [self hasBecomeFullscreen];
552 - (void)orderOut: (id)sender
554 [super orderOut: sender];
556 /* Make sure we leave fullscreen */
557 [self leaveFullscreenAndFadeOut: YES];
560 - (void)makeKeyAndOrderFront: (id)sender
563 * when we exit fullscreen and fade out, we may endup in
564 * having a window that is faded. We can't have it fade in unless we
567 if(!b_window_is_invisible)
569 /* Make sure we don't do it too much */
570 [super makeKeyAndOrderFront: sender];
574 [super setAlphaValue:0.0f];
575 [super makeKeyAndOrderFront: sender];
577 NSMutableDictionary * dict = [[[NSMutableDictionary alloc] initWithCapacity:2] autorelease];
578 [dict setObject:self forKey:NSViewAnimationTargetKey];
579 [dict setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
581 NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObject:dict]];
583 [anim setAnimationBlockingMode: NSAnimationNonblocking];
584 [anim setDuration: 0.1];
585 [anim setFrameRate: 30];
587 [anim startAnimation];
588 b_window_is_invisible = NO;
590 /* fullscreenAnimation will be unlocked when animation ends */
595 /* Make sure setFrame gets executed on main thread especially if we are animating.
596 * (Thus we won't block the video output thread) */
597 - (void)setFrame:(NSRect)frame display:(BOOL)display animate:(BOOL)animate
599 struct { NSRect frame; BOOL display; BOOL animate;} args;
603 args.display = display;
604 args.animate = animate;
606 packedargs = [NSData dataWithBytes:&args length:sizeof(args)];
608 [self performSelectorOnMainThread:@selector(setFrameOnMainThread:)
609 withObject: packedargs waitUntilDone: YES];
612 - (void)setFrameOnMainThread:(NSData*)packedargs
614 struct args { NSRect frame; BOOL display; BOOL animate; } * args = (struct args*)[packedargs bytes];
618 /* Make sure we don't block too long and set up a non blocking animation */
619 NSDictionary * dict = [NSDictionary dictionaryWithObjectsAndKeys:
620 self, NSViewAnimationTargetKey,
621 [NSValue valueWithRect:[self frame]], NSViewAnimationStartFrameKey,
622 [NSValue valueWithRect:args->frame], NSViewAnimationEndFrameKey, nil];
624 NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict, nil]];
626 [anim setAnimationBlockingMode: NSAnimationNonblocking];
627 [anim setDuration: 0.4];
628 [anim setFrameRate: 30];
629 [anim startAnimation];
632 [super setFrame:args->frame display:args->display animate:args->animate];