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 *****************************************************************************/
29 /* DisableScreenUpdates, SetSystemUIMode, ... */
30 #import <Carbon/Carbon.h>
35 #import "embeddedwindow.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 NSRect viewRect = [o_view convertRect:[o_view bounds] toView: nil];
202 NSRect contentRect = [self contentRectForFrameRect:[self frame]];
203 float marginy = viewRect.origin.y + [self frame].size.height - contentRect.size.height;
204 float marginx = contentRect.size.width - viewRect.size.width;
205 proposedFrameSize.height = (proposedFrameSize.width - marginx) * videoRatio.height / videoRatio.width + marginy;
207 return proposedFrameSize;
210 /*****************************************************************************
219 - (void)lockFullscreenAnimation
221 [o_animation_lock lock];
224 - (void)unlockFullscreenAnimation
226 [o_animation_lock unlock];
229 - (void)enterFullscreen
231 NSMutableDictionary *dict1, *dict2;
235 vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
236 BOOL blackout_other_displays = config_GetInt( VLCIntf, "macosx-black" );
238 screen = [NSScreen screenWithDisplayID:(CGDirectDisplayID)var_GetInteger( p_vout, "video-device" )];
240 [self lockFullscreenAnimation];
244 msg_Dbg( p_vout, "chosen screen isn't present, using current screen for fullscreen mode" );
245 screen = [self screen];
249 msg_Dbg( p_vout, "Using deepest screen" );
250 screen = [NSScreen deepestScreen];
253 vlc_object_release( p_vout );
255 screen_rect = [screen frame];
257 [o_btn_fullscreen setState: YES];
259 [NSCursor setHiddenUntilMouseMoves: YES];
261 if( blackout_other_displays )
262 [screen blackoutOtherScreens];
264 /* Make sure we don't see the window flashes in float-on-top mode */
265 originalLevel = [self level];
266 [self setLevel:NSNormalWindowLevel];
268 /* Only create the o_fullscreen_window if we are not in the middle of the zooming animation */
269 if (!o_fullscreen_window)
271 /* We can't change the styleMask of an already created NSWindow, so we create an other window, and do eye catching stuff */
273 rect = [[o_view superview] convertRect: [o_view frame] toView: nil]; /* Convert to Window base coord */
274 rect.origin.x += [self frame].origin.x;
275 rect.origin.y += [self frame].origin.y;
276 o_fullscreen_window = [[VLCWindow alloc] initWithContentRect:rect styleMask: NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
277 [o_fullscreen_window setBackgroundColor: [NSColor blackColor]];
278 [o_fullscreen_window setCanBecomeKeyWindow: YES];
280 if (![self isVisible] || [self alphaValue] == 0.0)
282 /* We don't animate if we are not visible, instead we
283 * simply fade the display */
284 CGDisplayFadeReservationToken token;
286 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
287 CGDisplayFade( token, 0.5, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
289 if ([screen isMainScreen])
290 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
292 [[self contentView] replaceSubview:o_view with:o_temp_view];
293 [o_temp_view setFrame:[o_view frame]];
294 [o_fullscreen_window setContentView:o_view];
296 [o_fullscreen_window makeKeyAndOrderFront:self];
297 [o_fullscreen_window orderFront:self animate:YES];
299 [o_fullscreen_window setFrame:screen_rect display:YES];
301 CGDisplayFade( token, 0.3, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
302 CGReleaseDisplayFadeReservation( token);
304 /* Will release the lock */
305 [self hasBecomeFullscreen];
310 /* Make sure we don't see the o_view disappearing of the screen during this operation */
312 DisableScreenUpdates();
314 [[self contentView] replaceSubview:o_view with:o_temp_view];
315 [o_temp_view setFrame:[o_view frame]];
316 [o_fullscreen_window setContentView:o_view];
317 [o_fullscreen_window makeKeyAndOrderFront:self];
319 EnableScreenUpdates();
323 /* We are in fullscreen (and no animation is running) */
326 /* Make sure we are hidden */
327 [super orderOut: self];
328 [self unlockFullscreenAnimation];
332 if (o_fullscreen_anim1)
334 [o_fullscreen_anim1 stopAnimation];
335 [o_fullscreen_anim1 release];
337 if (o_fullscreen_anim2)
339 [o_fullscreen_anim2 stopAnimation];
340 [o_fullscreen_anim2 release];
343 if ([screen isMainScreen])
344 SetSystemUIMode( kUIModeAllHidden, kUIOptionAutoShowMenuBar);
346 dict1 = [[NSMutableDictionary alloc] initWithCapacity:2];
347 dict2 = [[NSMutableDictionary alloc] initWithCapacity:3];
349 [dict1 setObject:self forKey:NSViewAnimationTargetKey];
350 [dict1 setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
352 [dict2 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
353 [dict2 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
354 [dict2 setObject:[NSValue valueWithRect:screen_rect] forKey:NSViewAnimationEndFrameKey];
356 /* Strategy with NSAnimation allocation:
357 - Keep at most 2 animation at a time
358 - leaveFullscreen/enterFullscreen are the only responsible for releasing and alloc-ing
360 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
361 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
366 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
367 [o_fullscreen_anim1 setDuration: 0.3];
368 [o_fullscreen_anim1 setFrameRate: 30];
369 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
370 [o_fullscreen_anim2 setDuration: 0.2];
371 [o_fullscreen_anim2 setFrameRate: 30];
373 [o_fullscreen_anim2 setDelegate: self];
374 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
376 [o_fullscreen_anim1 startAnimation];
377 /* fullscreenAnimation will be unlocked when animation ends */
380 - (void)hasBecomeFullscreen
382 [o_fullscreen_window makeFirstResponder: [[[VLCMain sharedInstance] controls] voutView]];
384 [o_fullscreen_window makeKeyWindow];
385 [o_fullscreen_window setAcceptsMouseMovedEvents: TRUE];
387 /* tell the fspanel to move itself to front next time it's triggered */
388 [[[[VLCMain sharedInstance] controls] fspanel] setVoutWasUpdated: (int)[[o_fullscreen_window screen] displayID]];
391 [super orderOut: self];
393 [[[[VLCMain sharedInstance] controls] fspanel] setActive: nil];
396 [self unlockFullscreenAnimation];
399 - (void)leaveFullscreen
401 [self leaveFullscreenAndFadeOut: NO];
404 - (void)leaveFullscreenAndFadeOut: (BOOL)fadeout
406 NSMutableDictionary *dict1, *dict2;
409 [self lockFullscreenAnimation];
412 [o_btn_fullscreen setState: NO];
414 /* We always try to do so */
415 [NSScreen unblackoutScreens];
417 /* Don't do anything if o_fullscreen_window is already closed */
418 if (!o_fullscreen_window)
420 [self unlockFullscreenAnimation];
426 /* We don't animate if we are not visible, instead we
427 * simply fade the display */
428 CGDisplayFadeReservationToken token;
430 CGAcquireDisplayFadeReservation(kCGMaxDisplayReservationInterval, &token);
431 CGDisplayFade( token, 0.3, kCGDisplayBlendNormal, kCGDisplayBlendSolidColor, 0, 0, 0, YES );
433 [[[[VLCMain sharedInstance] controls] fspanel] setNonActive: nil];
434 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
436 /* Will release the lock */
437 [self hasEndedFullscreen];
439 /* Our window is hidden, and might be faded. We need to workaround that, so note it
441 b_window_is_invisible = YES;
443 CGDisplayFade( token, 0.5, kCGDisplayBlendSolidColor, kCGDisplayBlendNormal, 0, 0, 0, NO );
444 CGReleaseDisplayFadeReservation( token);
448 [self setAlphaValue: 0.0];
449 [self orderFront: self];
451 [[[[VLCMain sharedInstance] controls] fspanel] setNonActive: nil];
452 SetSystemUIMode( kUIModeNormal, kUIOptionAutoShowMenuBar);
454 if (o_fullscreen_anim1)
456 [o_fullscreen_anim1 stopAnimation];
457 [o_fullscreen_anim1 release];
459 if (o_fullscreen_anim2)
461 [o_fullscreen_anim2 stopAnimation];
462 [o_fullscreen_anim2 release];
465 frame = [[o_temp_view superview] convertRect: [o_temp_view frame] toView: nil]; /* Convert to Window base coord */
466 frame.origin.x += [self frame].origin.x;
467 frame.origin.y += [self frame].origin.y;
469 dict2 = [[NSMutableDictionary alloc] initWithCapacity:2];
470 [dict2 setObject:self forKey:NSViewAnimationTargetKey];
471 [dict2 setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
473 o_fullscreen_anim2 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict2, nil]];
476 [o_fullscreen_anim2 setAnimationBlockingMode: NSAnimationNonblocking];
477 [o_fullscreen_anim2 setDuration: 0.3];
478 [o_fullscreen_anim2 setFrameRate: 30];
480 [o_fullscreen_anim2 setDelegate: self];
482 dict1 = [[NSMutableDictionary alloc] initWithCapacity:3];
484 [dict1 setObject:o_fullscreen_window forKey:NSViewAnimationTargetKey];
485 [dict1 setObject:[NSValue valueWithRect:[o_fullscreen_window frame]] forKey:NSViewAnimationStartFrameKey];
486 [dict1 setObject:[NSValue valueWithRect:frame] forKey:NSViewAnimationEndFrameKey];
488 o_fullscreen_anim1 = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict1, nil]];
491 [o_fullscreen_anim1 setAnimationBlockingMode: NSAnimationNonblocking];
492 [o_fullscreen_anim1 setDuration: 0.2];
493 [o_fullscreen_anim1 setFrameRate: 30];
494 [o_fullscreen_anim2 startWhenAnimation: o_fullscreen_anim1 reachesProgress: 1.0];
496 /* Make sure o_fullscreen_window is the frontmost window */
497 [o_fullscreen_window orderFront: self];
499 [o_fullscreen_anim1 startAnimation];
500 /* fullscreenAnimation will be unlocked when animation ends */
503 - (void)hasEndedFullscreen
505 /* This function is private and should be only triggered at the end of the fullscreen change animation */
506 /* Make sure we don't see the o_view disappearing of the screen during this operation */
508 DisableScreenUpdates();
511 [o_view removeFromSuperviewWithoutNeedingDisplay];
512 [[self contentView] replaceSubview:o_temp_view with:o_view];
514 [o_view setFrame:[o_temp_view frame]];
515 [self makeFirstResponder: o_view];
516 if ([self isVisible])
517 [super makeKeyAndOrderFront:self]; /* our version contains a workaround */
518 [o_fullscreen_window orderOut: self];
520 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];