1 /*****************************************************************************
2 * macosx.m: MacOS X OpenGL provider
3 *****************************************************************************
4 * Copyright (C) 2001-2012 the VideoLAN team
7 * Authors: Colin Delacroix <colin@zoy.org>
8 * Florian G. Pflug <fgp@phlo.org>
9 * Jon Lech Johansen <jon-vl@nanocrew.net>
10 * Derk-Jan Hartman <hartman at videolan dot org>
11 * Eric Petit <titer@m0k.org>
12 * Benjamin Pracht <bigben at videolan dot org>
13 * Damien Fouilleul <damienf at videolan dot org>
14 * Pierre d'Herbemont <pdherbemont at videolan dot org>
15 * Felix Paul Kühne <fkuehne at videolan dot org>
16 * David Fuhrmann <david dot fuhrmann at googlemail dot com>
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
31 *****************************************************************************/
33 /*****************************************************************************
35 *****************************************************************************/
37 #import <Cocoa/Cocoa.h>
38 #import <OpenGL/OpenGL.h>
45 #include <vlc_common.h>
46 #include <vlc_plugin.h>
47 #include <vlc_vout_display.h>
48 #include <vlc_opengl.h>
49 #include <vlc_dialog.h>
52 @interface NSWindow (VLCCustomCode)
56 /* compilation support for 10.5 and 10.6 */
57 #define OSX_LION NSAppKitVersionNumber >= 1115.2
58 #ifndef MAC_OS_X_VERSION_10_7
60 @interface NSView (IntroducedInLion)
61 - (NSRect)convertRectToBacking:(NSRect)aRect;
62 - (void)setWantsBestResolutionOpenGLSurface:(BOOL)aBool;
68 * Forward declarations
70 static int Open (vlc_object_t *);
71 static void Close (vlc_object_t *);
73 static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count);
74 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture);
75 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture);
76 static int Control (vout_display_t *vd, int query, va_list ap);
78 static void *OurGetProcAddress(vlc_gl_t *, const char *);
80 static int OpenglLock (vlc_gl_t *gl);
81 static void OpenglUnlock (vlc_gl_t *gl);
82 static void OpenglSwap (vlc_gl_t *gl);
88 /* Will be loaded even without interface module. see voutgl.m */
89 set_shortname ("Mac OS X")
90 set_description (N_("Mac OS X OpenGL video output (requires drawable-nsobject)"))
91 set_category (CAT_VIDEO)
92 set_subcategory (SUBCAT_VIDEO_VOUT )
93 set_capability ("vout display", 300)
94 set_callbacks (Open, Close)
96 add_shortcut ("macosx", "vout_macosx")
100 * Obj-C protocol declaration that drawable-nsobject should follow
102 @protocol VLCOpenGLVideoViewEmbedding <NSObject>
103 - (void)addVoutSubview:(NSView *)view;
104 - (void)removeVoutSubview:(NSView *)view;
107 @interface VLCOpenGLVideoView : NSOpenGLView
110 BOOL _hasPendingReshape;
112 - (void)setVoutDisplay:(vout_display_t *)vd;
113 - (void)setVoutFlushing:(BOOL)flushing;
117 struct vout_display_sys_t
119 VLCOpenGLVideoView *glView;
120 id<VLCOpenGLVideoViewEmbedding> container;
122 vout_window_t *embed;
124 vout_display_opengl_t *vgl;
126 picture_pool_t *pool;
128 bool has_first_frame;
130 vout_display_place_t place;
134 static void *OurGetProcAddress(vlc_gl_t *gl, const char *name)
138 return dlsym(RTLD_DEFAULT, name);
141 static int Open (vlc_object_t *this)
143 vout_display_t *vd = (vout_display_t *)this;
144 vout_display_sys_t *sys = calloc (1, sizeof(*sys));
145 NSAutoreleasePool *nsPool = nil;
150 if (!CGDisplayUsesOpenGLAcceleration (kCGDirectMainDisplay))
152 msg_Err (this, "no OpenGL hardware acceleration found. this can lead to slow output and unexpected results");
153 dialog_Fatal (this, _("OpenGL acceleration is not supported on your Mac"), _("Your Mac lacks Quartz Extreme acceleration, which is required for video output. It will still work, but much slower and with possibly unexpected results."));
156 msg_Dbg (this, "Quartz Extreme acceleration is active");
163 /* Get the drawable object */
164 id container = var_CreateGetAddress (vd, "drawable-nsobject");
167 vout_display_DeleteWindow (vd, NULL);
171 vout_window_cfg_t wnd_cfg;
173 memset (&wnd_cfg, 0, sizeof (wnd_cfg));
174 wnd_cfg.type = VOUT_WINDOW_TYPE_NSOBJECT;
175 wnd_cfg.x = var_InheritInteger (vd, "video-x");
176 wnd_cfg.y = var_InheritInteger (vd, "video-y");
177 wnd_cfg.width = vd->cfg->display.width;
178 wnd_cfg.height = vd->cfg->display.height;
180 sys->embed = vout_display_NewWindow (vd, &wnd_cfg);
182 container = sys->embed->handle.nsobject;
186 msg_Dbg(vd, "No drawable-nsobject nor vout_window_t found, passing over.");
191 /* This will be released in Close(), on
192 * main thread, after we are done using it. */
193 sys->container = [container retain];
195 /* Get our main view*/
196 nsPool = [[NSAutoreleasePool alloc] init];
198 [VLCOpenGLVideoView performSelectorOnMainThread:@selector(getNewView:) withObject:[NSValue valueWithPointer:&sys->glView] waitUntilDone:YES];
202 [sys->glView setVoutDisplay:vd];
204 /* We don't wait, that means that we'll have to be careful about releasing
206 * That's why we'll release on main thread in Close(). */
207 if ([(id)container respondsToSelector:@selector(addVoutSubview:)])
208 [(id)container performSelectorOnMainThread:@selector(addVoutSubview:) withObject:sys->glView waitUntilDone:NO];
209 else if ([container isKindOfClass:[NSView class]])
211 NSView *parentView = container;
212 [parentView performSelectorOnMainThread:@selector(addSubview:) withObject:sys->glView waitUntilDone:NO];
213 [sys->glView performSelectorOnMainThread:@selector(setFrameToBoundsOfView:) withObject:[NSValue valueWithPointer:parentView] waitUntilDone:NO];
217 msg_Err(vd, "Invalid drawable-nsobject object. drawable-nsobject must either be an NSView or comply to the @protocol VLCOpenGLVideoViewEmbedding.");
225 /* Initialize common OpenGL video display */
226 sys->gl.lock = OpenglLock;
227 sys->gl.unlock = OpenglUnlock;
228 sys->gl.swap = OpenglSwap;
229 sys->gl.getProcAddress = OurGetProcAddress;
231 const vlc_fourcc_t *subpicture_chromas;
232 video_format_t fmt = vd->fmt;
234 sys->vgl = vout_display_opengl_New (&vd->fmt, &subpicture_chromas, &sys->gl);
242 vout_display_info_t info = vd->info;
243 info.has_pictures_invalid = false;
244 info.has_event_thread = true;
245 info.subpicture_chromas = subpicture_chromas;
247 /* Setup vout_display_t once everything is fine */
251 vd->prepare = PictureRender;
252 vd->display = PictureDisplay;
253 vd->control = Control;
256 vout_display_SendEventDisplaySize (vd, vd->source.i_visible_width, vd->source.i_visible_height, false);
266 void Close (vlc_object_t *this)
268 vout_display_t *vd = (vout_display_t *)this;
269 vout_display_sys_t *sys = vd->sys;
271 if ([[sys->glView window] level] != NSNormalWindowLevel)
272 [[sys->glView window] setLevel: NSNormalWindowLevel];
274 [sys->glView setVoutDisplay:nil];
276 var_Destroy (vd, "drawable-nsobject");
277 if ([(id)sys->container respondsToSelector:@selector(removeVoutSubview:)])
279 /* This will retain sys->glView */
280 [(id)sys->container performSelectorOnMainThread:@selector(removeVoutSubview:) withObject:sys->glView waitUntilDone:NO];
282 /* release on main thread as explained in Open() */
283 [(id)sys->container performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
284 [sys->glView performSelectorOnMainThread:@selector(removeFromSuperview) withObject:nil waitUntilDone:NO];
286 [sys->glView release];
288 if (sys->gl.sys != NULL)
289 vout_display_opengl_Delete (sys->vgl);
292 vout_display_DeleteWindow (vd, sys->embed);
296 /*****************************************************************************
297 * vout display callbacks
298 *****************************************************************************/
300 static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count)
302 vout_display_sys_t *sys = vd->sys;
305 sys->pool = vout_display_opengl_GetPool (sys->vgl, requested_count);
310 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
313 vout_display_sys_t *sys = vd->sys;
315 vout_display_opengl_Prepare (sys->vgl, pic, subpicture);
318 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
320 vout_display_sys_t *sys = vd->sys;
321 [sys->glView setVoutFlushing:YES];
322 vout_display_opengl_Display (sys->vgl, &vd->source);
323 [sys->glView setVoutFlushing:NO];
324 picture_Release (pic);
325 sys->has_first_frame = true;
328 subpicture_Delete(subpicture);
331 static int Control (vout_display_t *vd, int query, va_list ap)
333 vout_display_sys_t *sys = vd->sys;
337 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
339 const vout_display_cfg_t *cfg = va_arg (ap, const vout_display_cfg_t *);
340 if (vout_window_SetFullScreen (sys->embed, cfg->is_fullscreen))
345 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
347 NSAutoreleasePool * o_pool = [[NSAutoreleasePool alloc] init];
348 unsigned state = va_arg (ap, unsigned);
349 [sys->glView performSelectorOnMainThread:@selector(setWindowLevel:) withObject:[NSNumber numberWithUnsignedInt:state] waitUntilDone:NO];
353 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
354 case VOUT_DISPLAY_CHANGE_ZOOM:
355 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
356 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
357 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
362 NSAutoreleasePool * o_pool = [[NSAutoreleasePool alloc] init];
364 id o_window = [sys->glView window];
366 return VLC_SUCCESS; // this is okay, since the event will occur again when we have a window
368 NSSize windowMinSize = [o_window minSize];
370 const vout_display_cfg_t *cfg;
371 const video_format_t *source;
372 bool is_forced = false;
374 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP)
376 source = (const video_format_t *)va_arg (ap, const video_format_t *);
381 source = &vd->source;
382 cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
383 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
384 is_forced = (bool)va_arg (ap, int);
387 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE && is_forced
388 && (cfg->display.width != vd->cfg->display.width
389 || cfg->display.height != vd->cfg->display.height)
390 && vout_window_SetSize (sys->embed, cfg->display.width, cfg->display.height))
393 /* for the case that the core wants to resize below minimum window size we correct the size here
394 to ensure a centered picture */
395 vout_display_cfg_t cfg_tmp = *cfg;
396 if (cfg_tmp.display.width < windowMinSize.width)
397 cfg_tmp.display.width = windowMinSize.width;
398 if (cfg_tmp.display.height < 70)
399 cfg_tmp.display.height = 70;
401 if (!config_GetInt(vd, "macosx-video-autoresize"))
404 /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
406 bounds = [sys->glView convertRectToBacking:[sys->glView bounds]];
408 bounds = [sys->glView bounds];
409 cfg_tmp.display.width = bounds.size.width;
410 cfg_tmp.display.height = bounds.size.height;
412 vout_display_place_t place;
413 vout_display_PlacePicture (&place, source, &cfg_tmp, false);
414 @synchronized (sys->glView) {
418 /* For resize, we call glViewport in reshape and not here.
419 This has the positive side effect that we avoid erratic sizing as we animate every resize. */
420 if (query != VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
422 // x / y are top left corner, but we need the lower left one
423 glViewport (place.x, cfg_tmp.display.height - (place.y + place.height), place.width, place.height);
430 case VOUT_DISPLAY_HIDE_MOUSE:
432 [NSCursor setHiddenUntilMouseMoves: YES];
436 case VOUT_DISPLAY_GET_OPENGL:
438 vlc_gl_t **gl = va_arg (ap, vlc_gl_t **);
443 case VOUT_DISPLAY_RESET_PICTURES:
446 msg_Err (vd, "Unknown request in Mac OS X vout display");
451 /*****************************************************************************
452 * vout opengl callbacks
453 *****************************************************************************/
454 static int OpenglLock (vlc_gl_t *gl)
456 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
457 NSOpenGLContext *context = [sys->glView openGLContext];
458 CGLError err = CGLLockContext ([context CGLContextObj]);
459 if (kCGLNoError == err)
461 [context makeCurrentContext];
467 static void OpenglUnlock (vlc_gl_t *gl)
469 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
470 CGLUnlockContext ([[sys->glView openGLContext] CGLContextObj]);
473 static void OpenglSwap (vlc_gl_t *gl)
475 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
476 [[sys->glView openGLContext] flushBuffer];
479 /*****************************************************************************
481 *****************************************************************************/
482 @implementation VLCOpenGLVideoView
484 #define VLCAssertMainThread() assert([[NSThread currentThread] isMainThread])
487 + (void)getNewView:(NSValue *)value
489 id *ret = [value pointerValue];
490 *ret = [[self alloc] init];
494 * Gets called by the Open() method.
498 VLCAssertMainThread();
500 /* Warning - this may be called on non main thread */
502 NSOpenGLPixelFormatAttribute attribs[] =
504 NSOpenGLPFADoubleBuffer,
505 NSOpenGLPFAAccelerated,
506 NSOpenGLPFANoRecovery,
507 NSOpenGLPFAColorSize, 24,
508 NSOpenGLPFAAlphaSize, 8,
509 NSOpenGLPFADepthSize, 24,
514 NSOpenGLPixelFormat *fmt = [[NSOpenGLPixelFormat alloc] initWithAttributes:attribs];
519 self = [super initWithFrame:NSMakeRect(0,0,10,10) pixelFormat:fmt];
525 /* enable HiDPI support on OS X 10.7 and later */
527 [self setWantsBestResolutionOpenGLSurface:YES];
529 /* Swap buffers only during the vertical retrace of the monitor.
530 http://developer.apple.com/documentation/GraphicsImaging/
531 Conceptual/OpenGL/chap5/chapter_5_section_44.html */
532 GLint params[] = { 1 };
533 CGLSetParameter ([[self openGLContext] CGLContextObj], kCGLCPSwapInterval, params);
535 [self setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable];
540 * Gets called by the Open() method.
542 - (void)setFrameToBoundsOfView:(NSValue *)value
544 NSView *parentView = [value pointerValue];
546 /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
548 frame = [parentView convertRectToBacking:[parentView bounds]];
550 frame = [parentView bounds];
551 [self setFrame:frame];
555 * Gets called by the Close and Open methods.
558 - (void)setVoutDisplay:(vout_display_t *)aVd
560 @synchronized(self) {
566 * Gets called when the vout will aquire the lock and flush.
569 - (void)setVoutFlushing:(BOOL)flushing
573 @synchronized(self) {
574 _hasPendingReshape = NO;
579 * Can -drawRect skip rendering?.
581 - (BOOL)canSkipRendering
583 VLCAssertMainThread();
585 @synchronized(self) {
586 BOOL hasFirstFrame = vd && vd->sys->has_first_frame;
587 return !_hasPendingReshape && hasFirstFrame;
593 * Local method that locks the gl context.
597 VLCAssertMainThread();
598 NSOpenGLContext *context = [self openGLContext];
599 CGLError err = CGLLockContext ([context CGLContextObj]);
600 if (err == kCGLNoError)
601 [context makeCurrentContext];
602 return err == kCGLNoError;
606 * Local method that unlocks the gl context.
610 VLCAssertMainThread();
611 CGLUnlockContext ([[self openGLContext] CGLContextObj]);
615 * Local method that force a rendering of a frame.
616 * This will get called if Cocoa forces us to redraw (via -drawRect).
620 VLCAssertMainThread();
622 // We may have taken some times to take the opengl Lock.
623 // Check here to see if we can just skip the frame as well.
624 if ([self canSkipRendering])
628 @synchronized(self) { // vd can be accessed from multiple threads
629 hasFirstFrame = vd && vd->sys->has_first_frame;
633 // This will lock gl.
634 vout_display_opengl_Display (vd->sys->vgl, &vd->source);
637 glClear (GL_COLOR_BUFFER_BIT);
641 * Method called by Cocoa when the view is resized.
645 VLCAssertMainThread();
648 /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
650 bounds = [self convertRectToBacking:[self bounds]];
652 bounds = [self bounds];
653 vout_display_place_t place;
655 @synchronized(self) {
657 vout_display_cfg_t cfg_tmp = *(vd->cfg);
658 cfg_tmp.display.width = bounds.size.width;
659 cfg_tmp.display.height = bounds.size.height;
661 vout_display_PlacePicture (&place, &vd->source, &cfg_tmp, false);
662 vd->sys->place = place;
663 vout_display_SendEventDisplaySize (vd, bounds.size.width, bounds.size.height, vd->cfg->is_fullscreen);
668 // x / y are top left corner, but we need the lower left one
669 glViewport (place.x, bounds.size.height - (place.y + place.height), place.width, place.height);
671 @synchronized(self) {
672 // This may be cleared before -drawRect is being called,
673 // in this case we'll skip the rendering.
674 // This will save us for rendering two frames (or more) for nothing
675 // (one by the vout, one (or more) by drawRect)
676 _hasPendingReshape = YES;
686 * Method called by Cocoa when the view is resized or the location has changed.
687 * We just need to make sure we are locking here.
691 VLCAssertMainThread();
692 BOOL success = [self lockgl];
702 * Method called by Cocoa to force redraw.
704 - (void)drawRect:(NSRect) rect
706 VLCAssertMainThread();
708 if ([self canSkipRendering])
711 BOOL success = [self lockgl];
722 NSWindow *window = [self window];
724 // Remove flashes with splitter view.
725 if ([window respondsToSelector:@selector(disableScreenUpdatesUntilFlush)])
726 [window disableScreenUpdatesUntilFlush];
736 - (void)setWindowLevel:(NSNumber*)state
738 if ([state unsignedIntValue] & VOUT_WINDOW_STATE_ABOVE)
739 [[self window] setLevel: NSStatusWindowLevel];
741 [[self window] setLevel: NSNormalWindowLevel];
745 #pragma mark Mouse handling
747 - (void)mouseDown:(NSEvent *)o_event
749 if ([o_event type] == NSLeftMouseDown && !([o_event modifierFlags] & NSControlKeyMask))
751 if ([o_event clickCount] <= 1)
752 vout_display_SendEventMousePressed (vd, MOUSE_BUTTON_LEFT);
755 [super mouseDown:o_event];
758 - (void)otherMouseDown:(NSEvent *)o_event
760 vout_display_SendEventMousePressed (vd, MOUSE_BUTTON_CENTER);
762 [super otherMouseDown: o_event];
765 - (void)mouseUp:(NSEvent *)o_event
767 if ([o_event type] == NSLeftMouseUp)
768 vout_display_SendEventMouseReleased (vd, MOUSE_BUTTON_LEFT);
770 [super mouseUp: o_event];
773 - (void)otherMouseUp:(NSEvent *)o_event
775 vout_display_SendEventMouseReleased (vd, MOUSE_BUTTON_CENTER);
777 [super otherMouseUp: o_event];
780 - (void)mouseMoved:(NSEvent *)o_event
786 /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
788 s_rect = [self convertRectToBacking:[self bounds]];
790 s_rect = [self bounds];
791 ml = [self convertPoint: [o_event locationInWindow] fromView: nil];
792 b_inside = [self mouse: ml inRect: s_rect];
800 vout_display_place_t place = vd->sys->place;
802 if (place.width > 0 && place.height > 0)
804 const int x = vd->source.i_x_offset +
805 (int64_t)(ml.x - place.x) * vd->source.i_visible_width / place.width;
806 const int y = vd->source.i_y_offset +
807 (int64_t)((int)s_rect.size.height - (int)ml.y - place.y) * vd->source.i_visible_height / place.height;
809 vout_display_SendEventMouseMoved (vd, x, y);
815 [super mouseMoved: o_event];
818 - (void)mouseDragged:(NSEvent *)o_event
820 [self mouseMoved: o_event];
821 [super mouseDragged: o_event];
824 - (void)otherMouseDragged:(NSEvent *)o_event
826 [self mouseMoved: o_event];
827 [super otherMouseDragged: o_event];
830 - (void)rightMouseDragged:(NSEvent *)o_event
832 [self mouseMoved: o_event];
833 [super rightMouseDragged: o_event];
836 - (BOOL)acceptsFirstResponder
841 - (BOOL)mouseDownCanMoveWindow