1 /*****************************************************************************
2 * embeddedwindow.m: MacOS X interface module
3 *****************************************************************************
4 * Copyright (C) 2005-2009 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 *****************************************************************************/
32 #import "embeddedwindow.h"
35 /* SetSystemUIMode, ... */
36 #import <Carbon/Carbon.h>
38 /*****************************************************************************
39 * VLCEmbeddedWindow Implementation
40 *****************************************************************************/
42 @implementation VLCEmbeddedWindow
44 - (id)initWithContentRect:(NSRect)contentRect styleMask: (NSUInteger)windowStyle backing:(NSBackingStoreType)bufferingType defer:(BOOL)deferCreation
46 BOOL b_useTextured = YES;
47 if( [[NSWindow class] instancesRespondToSelector:@selector(setContentBorderThickness:forEdge:)] )
50 windowStyle ^= NSTexturedBackgroundWindowMask;
52 self = [super initWithContentRect:contentRect styleMask:windowStyle backing:bufferingType defer:deferCreation];
55 [self setContentBorderThickness:28.0 forEdge:NSMinYEdge];
62 [self setDelegate: self];
64 [o_btn_backward setToolTip: _NS("Rewind")];
65 [o_btn_forward setToolTip: _NS("Fast Forward")];
66 [o_btn_fullscreen setToolTip: _NS("Fullscreen")];
67 [o_btn_play setToolTip: _NS("Play")];
68 [o_slider setToolTip: _NS("Position")];
70 o_img_play = [NSImage imageNamed: @"play_embedded"];
71 o_img_pause = [NSImage imageNamed: @"pause_embedded"];
72 [self controlTintChanged];
73 [[NSNotificationCenter defaultCenter] addObserver: self
74 selector: @selector( controlTintChanged )
75 name: NSControlTintDidChangeNotification
78 /* Useful to save o_view frame in fullscreen mode */
79 o_temp_view = [[NSView alloc] init];
80 [o_temp_view setAutoresizingMask:NSViewHeightSizable | NSViewWidthSizable];
82 o_fullscreen_window = nil;
83 o_fullscreen_anim1 = o_fullscreen_anim2 = nil;
85 /* Not fullscreen when we wake up */
86 [o_btn_fullscreen setState: NO];
89 [self setMovableByWindowBackground:YES];
91 [self setDelegate:self];
93 /* Make sure setVisible: returns NO */
95 b_window_is_invisible = YES;
96 videoRatio = NSMakeSize( 0., 0. );
99 - (void)controlTintChanged
102 if( [o_btn_play alternateImage] == o_img_play_pressed )
105 if( [NSColor currentControlTint] == NSGraphiteControlTint )
107 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_graphite"];
108 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_graphite"];
109 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_graphite"]];
110 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_graphite"]];
111 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_graphite"]];
115 o_img_play_pressed = [NSImage imageNamed: @"play_embedded_blue"];
116 o_img_pause_pressed = [NSImage imageNamed: @"pause_embedded_blue"];
117 [o_btn_backward setAlternateImage: [NSImage imageNamed: @"skip_previous_embedded_blue"]];
118 [o_btn_forward setAlternateImage: [NSImage imageNamed: @"skip_forward_embedded_blue"]];
119 [o_btn_fullscreen setAlternateImage: [NSImage imageNamed: @"fullscreen_blue"]];
123 [o_btn_play setAlternateImage: o_img_play_pressed];
125 [o_btn_play setAlternateImage: o_img_pause_pressed];
130 [[NSNotificationCenter defaultCenter] removeObserver: self];
131 [o_img_play release];
132 [o_img_play_pressed release];
133 [o_img_pause release];
134 [o_img_pause_pressed release];
139 - (void)setTime:(NSString *)o_arg_time position:(float)f_position
141 [o_time setStringValue: o_arg_time];
142 [o_slider setFloatValue: f_position];
145 - (void)playStatusUpdated:(int)i_status
147 if( i_status == PLAYING_S )
149 [o_btn_play setImage: o_img_pause];
150 [o_btn_play setAlternateImage: o_img_pause_pressed];
151 [o_btn_play setToolTip: _NS("Pause")];
155 [o_btn_play setImage: o_img_play];
156 [o_btn_play setAlternateImage: o_img_play_pressed];
157 [o_btn_play setToolTip: _NS("Play")];
161 - (void)setSeekable:(BOOL)b_seekable
163 [o_btn_forward setEnabled: b_seekable];
164 [o_btn_backward setEnabled: b_seekable];
165 [o_slider setEnabled: b_seekable];
168 - (BOOL)windowShouldZoom:(NSWindow *)sender toFrame:(NSRect)newFrame
170 [self setFrame: newFrame display: YES animate: YES];
174 - (BOOL)windowShouldClose:(id)sender
176 playlist_t * p_playlist = pl_Hold( VLCIntf );
178 playlist_Stop( p_playlist );
179 pl_Release( VLCIntf );
185 if (o_fullscreen_window)
191 - (void)setVideoRatio:(NSSize)ratio
196 - (NSSize)windowWillResize:(NSWindow *)window toSize:(NSSize)proposedFrameSize
198 if( videoRatio.height == 0. || videoRatio.width == 0. )
199 return proposedFrameSize;
201 if( [[[VLCMain sharedInstance] controls] aspectRatioIsLocked] )
203 NSRect viewRect = [o_view convertRect:[o_view bounds] toView: nil];
204 NSRect contentRect = [self contentRectForFrameRect:[self frame]];
205 float marginy = viewRect.origin.y + [self frame].size.height - contentRect.size.height;
206 float marginx = contentRect.size.width - viewRect.size.width;
207 proposedFrameSize.height = (proposedFrameSize.width - marginx) * videoRatio.height / videoRatio.width + marginy;
210 return proposedFrameSize;
213 /*****************************************************************************
222 - (void)lockFullscreenAnimation
224 [o_animation_lock lock];
227 - (void)unlockFullscreenAnimation
229 [o_animation_lock unlock];
232 - (void)enterFullscreen
234 NSMutableDictionary *dict1, *dict2;
238 vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
239 BOOL blackout_other_displays = config_GetInt( VLCIntf, "macosx-black" );
241 screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )];
243 [self lockFullscreenAnimation];
247 msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
248 screen = [self screen];
252 msg_Dbg( p_vout, "Using deepest screen" );
253 screen = [NSScreen deepestScreen];
256 vlc_object_release( p_vout );
258 screen_rect = [screen frame];
260 [o_btn_fullscreen setState: YES];
262 [NSCursor setHiddenUntilMouseMoves: YES];
264 if( blackout_other_displays )
265 [screen blackoutOtherScreens];
267 /* Make sure we don't see the window flashes in float-on-top mode */
268 originalLevel = [self level];
269 [self setLevel:NSNormalWindowLevel];
271 /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
272 if (!o_fullscreen_window)
274 /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
276 rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
277 rect.origin.x += [self frame].origin.x;
278 rect.origin.y += [self frame].origin.y;
279 o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
280 [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
281 [o_fullscreen_window setCanBecomeKeyWindow: YES];
283 if (![self isVisible] || [self alphaValue] == 0.0)
285 /* We don't animate if we are not visible, instead we
286 * simply fade the display */
287 CGDisplayFadeReservationToken token;
289 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
290 CGDisplayFade( token, 0.5, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
292 if ([screen isMainScreen])
293 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
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];
299 [o_fullscreen_window makeKeyAndOrderFront:self];
300 [o_fullscreen_window orderFront:self animate:YES];
302 [o_fullscreen_window setFrame:screen_rect display:YES];
304 CGDisplayFade( token, 0.3, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
305 CGReleaseDisplayFadeReservation( token);
307 /* Will release the lock */
308 [self hasBecomeFullscreen];
313 /* Make sure we don't see the o_view disappearing of the screen during this operation */
314 NSDisableScreenUpdates();
315 [[self contentView] replaceSubview:o_view with:o_temp_view];
316 [o_temp_view setFrame:[o_view frame]];
317 [o_fullscreen_window setContentView:o_view];
318 [o_fullscreen_window makeKeyAndOrderFront:self];
319 NSEnableScreenUpdates();
322 /* We are in fullscreen (and no animation is running) */
325 /* Make sure we are hidden */
326 [super orderOut: self];
327 [self unlockFullscreenAnimation];
331 if (o_fullscreen_anim1)
333 [o_fullscreen_anim1 stopAnimation];
334 [o_fullscreen_anim1 release];
336 if (o_fullscreen_anim2)
338 [o_fullscreen_anim2 stopAnimation];
339 [o_fullscreen_anim2 release];
342 if ([screen isMainScreen])
343 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
345 dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
346 dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
348 [dict1 setObject:self forKey:NSViewAnimationTargetKey];
349 [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
351 [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
352 [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
353 [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
355 /* Strategy with NSAnimation allocation:
356 - Keep at most 2 animation at a time
357 - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
359 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
360 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
365 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
366 [o_fullscreen_anim1 setDuration: 0.3];
367 [o_fullscreen_anim1 setFrameRate: 30];
368 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
369 [o_fullscreen_anim2 setDuration: 0.2];
370 [o_fullscreen_anim2 setFrameRate: 30];
372 [o_fullscreen_anim2 setDelegate: self];
373 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
375 [o_fullscreen_anim1 startAnimation];
376 /* fullscreenAnimation will be unlocked when animation ends */
379 - (void)hasBecomeFullscreen
381 [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] controls] voutView]];
383 [o_fullscreen_window makeKeyWindow];
384 [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
386 /* tell the fspanel to move itself to front next time it's triggered */
387 [[[[VLCMain sharedInstance] controls] fspanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
390 [super orderOut: self];
392 [[[[VLCMain sharedInstance] controls] fspanel] setActive: nil];
395 [self unlockFullscreenAnimation];
398 - (void)leaveFullscreen
400 [self leaveFullscreenAndFadeOut: NO];
403 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
405 NSMutableDictionary *dict1, *dict2;
408 [self lockFullscreenAnimation];
411 [o_btn_fullscreen setState: NO];
413 /* We always try to do so */
414 [NSScreen unblackoutScreens];
416 /* Don't do anything if o_fullscreen_window is already closed */
417 if (!o_fullscreen_window)
419 [self unlockFullscreenAnimation];
425 /* We don't animate if we are not visible, instead we
426 * simply fade the display */
427 CGDisplayFadeReservationToken token;
429 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
430 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
432 [[[[VLCMain sharedInstance] controls] fspanel] setNonActive: nil];
433 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
435 /* Will release the lock */
436 [self hasEndedFullscreen];
438 /* Our window is hidden, and might be faded. We need to workaround that, so note it
440 b_window_is_invisible = YES;
442 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
443 CGReleaseDisplayFadeReservation( token);
447 [self setAlphaValue: 0.0];
448 [self orderFront: self];
450 [[[[VLCMain sharedInstance] controls] fspanel] setNonActive: nil];
451 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
453 if (o_fullscreen_anim1)
455 [o_fullscreen_anim1 stopAnimation];
456 [o_fullscreen_anim1 release];
458 if (o_fullscreen_anim2)
460 [o_fullscreen_anim2 stopAnimation];
461 [o_fullscreen_anim2 release];
464 frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
465 frame.origin.x += [self frame].origin.x;
466 frame.origin.y += [self frame].origin.y;
468 dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
469 [dict2 setObject:self forKey:NSViewAnimationTargetKey];
470 [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
472 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
475 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
476 [o_fullscreen_anim2 setDuration: 0.3];
477 [o_fullscreen_anim2 setFrameRate: 30];
479 [o_fullscreen_anim2 setDelegate: self];
481 dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
483 [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
484 [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
485 [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
487 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
490 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
491 [o_fullscreen_anim1 setDuration: 0.2];
492 [o_fullscreen_anim1 setFrameRate: 30];
493 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
495 /* Make sure o_fullscreen_window is the frontmost window */
496 [o_fullscreen_window orderFront: self];
498 [o_fullscreen_anim1 startAnimation];
499 /* fullscreenAnimation will be unlocked when animation ends */
502 - (void)hasEndedFullscreen
504 /* This function is private and should be only triggered at the end of the fullscreen change animation */
505 /* Make sure we don't see the o_view disappearing of the screen during this operation */
506 NSDisableScreenUpdates();
508 [o_view removeFromSuperviewWithoutNeedingDisplay];
509 [[self contentView] replaceSubview:o_temp_view with:o_view];
511 [o_view setFrame:[o_temp_view frame]];
512 [self makeFirstResponder: o_view];
513 if ([self isVisible])
514 [super makeKeyAndOrderFront:self]; /* our version contains a workaround */
515 [o_fullscreen_window orderOut: self];
516 NSEnableScreenUpdates();
518 [o_fullscreen_window release];
519 o_fullscreen_window = nil;
520 [self setLevel:originalLevel];
522 [self unlockFullscreenAnimation];
525 - (void)animationDidEnd:(NSAnimation*)animation
527 NSArray *viewAnimations;
529 if ([animation currentValue] < 1.0)
532 /* Fullscreen ended or started (we are a delegate only for leaveFullscreen's/enterFullscren's anim2) */
533 viewAnimations = [o_fullscreen_anim2 viewAnimations];
534 if ([viewAnimations count] >=1 &&
535 [[[viewAnimations objectAtIndex: 0] objectForKey: NSViewAnimationEffectKey] isEqualToString:NSViewAnimationFadeInEffect])
537 /* Fullscreen ended */
538 [self hasEndedFullscreen];
542 /* Fullscreen started */
543 [self hasBecomeFullscreen];
547 - (void)orderOut: (id)sender
549 [super orderOut: sender];
551 /* Make sure we leave fullscreen */
552 [self leaveFullscreenAndFadeOut: YES];
555 - (void)makeKeyAndOrderFront: (id)sender
558 * when we exit fullscreen and fade out, we may endup in
559 * having a window that is faded. We can't have it fade in unless we
562 if(!b_window_is_invisible)
564 /* Make sure we don't do it too much */
565 [super makeKeyAndOrderFront: sender];
569 [super setAlphaValue:0.0f];
570 [super makeKeyAndOrderFront: sender];
572 NSMutableDictionary * dict = [[[NSMutableDictionary alloc] initWithCapacity:2] autorelease];
573 [dict setObject:self forKey:NSViewAnimationTargetKey];
574 [dict setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
576 NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObject:dict]];
578 [anim setAnimationBlockingMode: NSAnimationNonblocking];
579 [anim setDuration: 0.1];
580 [anim setFrameRate: 30];
582 [anim startAnimation];
583 b_window_is_invisible = NO;
585 /* fullscreenAnimation will be unlocked when animation ends */
590 /* Make sure setFrame gets executed on main thread especially if we are animating.
591 * (Thus we won't block the video output thread) */
592 - (void)setFrame:(NSRect)frame display:(BOOL)display animate:(BOOL)animate
594 struct { NSRect frame; BOOL display; BOOL animate;} args;
598 args.display = display;
599 args.animate = animate;
601 packedargs = [NSData dataWithBytes:&args length:sizeof(args)];
603 [self performSelectorOnMainThread:@selector(setFrameOnMainThread:)
604 withObject: packedargs waitUntilDone: YES];
607 - (void)setFrameOnMainThread:(NSData*)packedargs
609 struct args { NSRect frame; BOOL display; BOOL animate; } * args = (struct args*)[packedargs bytes];
613 /* Make sure we don't block too long and set up a non blocking animation */
614 NSDictionary * dict = [NSDictionary dictionaryWithObjectsAndKeys:
615 self, NSViewAnimationTargetKey,
616 [NSValue valueWithRect:[self frame]], NSViewAnimationStartFrameKey,
617 [NSValue valueWithRect:args->frame], NSViewAnimationEndFrameKey, nil];
619 NSViewAnimation * anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict, nil]];
621 [anim setAnimationBlockingMode: NSAnimationNonblocking];
622 [anim setDuration: 0.4];
623 [anim setFrameRate: 30];
624 [anim startAnimation];
627 [super setFrame:args->frame display:args->display animate:args->animate];