1 /*****************************************************************************
2 * macosx.m: MacOS X OpenGL provider
3 *****************************************************************************
4 * Copyright (C) 2001-2013 VLC authors and VideoLAN
7 * Authors: Derk-Jan Hartman <hartman at videolan dot org>
8 * Eric Petit <titer@m0k.org>
9 * Benjamin Pracht <bigben at videolan dot org>
10 * Damien Fouilleul <damienf at videolan dot org>
11 * Pierre d'Herbemont <pdherbemont at videolan dot org>
12 * Felix Paul Kühne <fkuehne at videolan dot org>
13 * David Fuhrmann <david dot fuhrmann at googlemail dot com>
15 * Juho Vähä-Herttua <juhovh at iki dot fi>
16 * Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
18 * This program is free software; you can redistribute it and/or modify it
19 * under the terms of the GNU Lesser General Public License as published by
20 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
28 * You should have received a copy of the GNU Lesser General Public License
29 * along with this program; if not, write to the Free Software Foundation,
30 * 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 /* compilation support for 10.5 and 10.6 */
53 #define OSX_LION NSAppKitVersionNumber >= 1115.2
54 #ifndef MAC_OS_X_VERSION_10_7
56 @interface NSView (IntroducedInLion)
57 - (NSRect)convertRectToBacking:(NSRect)aRect;
58 - (void)setWantsBestResolutionOpenGLSurface:(BOOL)aBool;
64 * Forward declarations
66 static int Open (vlc_object_t *);
67 static void Close (vlc_object_t *);
69 static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count);
70 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture);
71 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture);
72 static int Control (vout_display_t *vd, int query, va_list ap);
74 static void *OurGetProcAddress(vlc_gl_t *, const char *);
76 static int OpenglLock (vlc_gl_t *gl);
77 static void OpenglUnlock (vlc_gl_t *gl);
78 static void OpenglSwap (vlc_gl_t *gl);
84 /* Will be loaded even without interface module. see voutgl.m */
85 set_shortname ("Mac OS X")
86 set_description (N_("Mac OS X OpenGL video output (requires drawable-nsobject)"))
87 set_category (CAT_VIDEO)
88 set_subcategory (SUBCAT_VIDEO_VOUT)
89 set_capability ("vout display", 300)
90 set_callbacks (Open, Close)
92 add_shortcut ("macosx", "vout_macosx")
96 * Obj-C protocol declaration that drawable-nsobject should follow
98 @protocol VLCOpenGLVideoViewEmbedding <NSObject>
99 - (void)addVoutSubview:(NSView *)view;
100 - (void)removeVoutSubview:(NSView *)view;
103 @interface VLCOpenGLVideoView : NSOpenGLView
106 BOOL _hasPendingReshape;
108 - (void)setVoutDisplay:(vout_display_t *)vd;
109 - (void)setVoutFlushing:(BOOL)flushing;
113 struct vout_display_sys_t
115 VLCOpenGLVideoView *glView;
116 id<VLCOpenGLVideoViewEmbedding> container;
118 vout_window_t *embed;
120 vout_display_opengl_t *vgl;
122 picture_pool_t *pool;
124 bool has_first_frame;
126 vout_display_place_t place;
130 static void *OurGetProcAddress(vlc_gl_t *gl, const char *name)
134 return dlsym(RTLD_DEFAULT, name);
137 static int Open (vlc_object_t *this)
139 vout_display_t *vd = (vout_display_t *)this;
140 vout_display_sys_t *sys = calloc (1, sizeof(*sys));
141 NSAutoreleasePool *nsPool = nil;
146 if (!CGDisplayUsesOpenGLAcceleration (kCGDirectMainDisplay)) {
147 msg_Err (this, "no OpenGL hardware acceleration found. this can lead to slow output and unexpected results");
148 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."));
150 msg_Dbg (this, "Quartz Extreme acceleration is active");
157 /* Get the drawable object */
158 id container = var_CreateGetAddress (vd, "drawable-nsobject");
160 vout_display_DeleteWindow (vd, NULL);
162 vout_window_cfg_t wnd_cfg;
164 memset (&wnd_cfg, 0, sizeof (wnd_cfg));
165 wnd_cfg.type = VOUT_WINDOW_TYPE_NSOBJECT;
166 wnd_cfg.x = var_InheritInteger (vd, "video-x");
167 wnd_cfg.y = var_InheritInteger (vd, "video-y");
168 wnd_cfg.width = vd->cfg->display.width;
169 wnd_cfg.height = vd->cfg->display.height;
171 sys->embed = vout_display_NewWindow (vd, &wnd_cfg);
173 container = sys->embed->handle.nsobject;
176 msg_Err(vd, "No drawable-nsobject nor vout_window_t found, passing over.");
181 /* This will be released in Close(), on
182 * main thread, after we are done using it. */
183 sys->container = [container retain];
185 /* Get our main view*/
186 nsPool = [[NSAutoreleasePool alloc] init];
188 [VLCOpenGLVideoView performSelectorOnMainThread:@selector(getNewView:) withObject:[NSValue valueWithPointer:&sys->glView] waitUntilDone:YES];
192 [sys->glView setVoutDisplay:vd];
194 /* We don't wait, that means that we'll have to be careful about releasing
196 * That's why we'll release on main thread in Close(). */
197 if ([(id)container respondsToSelector:@selector(addVoutSubview:)])
198 [(id)container performSelectorOnMainThread:@selector(addVoutSubview:) withObject:sys->glView waitUntilDone:NO];
199 else if ([container isKindOfClass:[NSView class]]) {
200 NSView *parentView = container;
201 [parentView performSelectorOnMainThread:@selector(addSubview:) withObject:sys->glView waitUntilDone:NO];
202 [sys->glView performSelectorOnMainThread:@selector(setFrameToBoundsOfView:) withObject:[NSValue valueWithPointer:parentView] waitUntilDone:NO];
204 msg_Err(vd, "Invalid drawable-nsobject object. drawable-nsobject must either be an NSView or comply to the @protocol VLCOpenGLVideoViewEmbedding.");
212 /* Initialize common OpenGL video display */
213 sys->gl.lock = OpenglLock;
214 sys->gl.unlock = OpenglUnlock;
215 sys->gl.swap = OpenglSwap;
216 sys->gl.getProcAddress = OurGetProcAddress;
218 const vlc_fourcc_t *subpicture_chromas;
219 video_format_t fmt = vd->fmt;
221 sys->vgl = vout_display_opengl_New (&vd->fmt, &subpicture_chromas, &sys->gl);
223 msg_Err(vd, "Error while initializing opengl display.");
229 vout_display_info_t info = vd->info;
230 info.has_pictures_invalid = false;
231 info.has_event_thread = true;
232 info.subpicture_chromas = subpicture_chromas;
233 info.has_hide_mouse = true;
235 /* Setup vout_display_t once everything is fine */
239 vd->prepare = PictureRender;
240 vd->display = PictureDisplay;
241 vd->control = Control;
244 vout_display_SendEventDisplaySize (vd, vd->source.i_visible_width, vd->source.i_visible_height, false);
254 void Close (vlc_object_t *this)
256 vout_display_t *vd = (vout_display_t *)this;
257 vout_display_sys_t *sys = vd->sys;
259 [sys->glView setVoutDisplay:nil];
261 var_Destroy (vd, "drawable-nsobject");
262 if ([(id)sys->container respondsToSelector:@selector(removeVoutSubview:)])
263 /* This will retain sys->glView */
264 [(id)sys->container performSelectorOnMainThread:@selector(removeVoutSubview:) withObject:sys->glView waitUntilDone:NO];
266 /* release on main thread as explained in Open() */
267 [(id)sys->container performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
268 [sys->glView performSelectorOnMainThread:@selector(removeFromSuperview) withObject:nil waitUntilDone:NO];
270 if (sys->gl.sys != NULL)
271 vout_display_opengl_Delete (sys->vgl);
273 [sys->glView release];
276 vout_display_DeleteWindow (vd, sys->embed);
280 /*****************************************************************************
281 * vout display callbacks
282 *****************************************************************************/
284 static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count)
286 vout_display_sys_t *sys = vd->sys;
289 sys->pool = vout_display_opengl_GetPool (sys->vgl, requested_count);
294 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
297 vout_display_sys_t *sys = vd->sys;
299 vout_display_opengl_Prepare (sys->vgl, pic, subpicture);
302 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
304 vout_display_sys_t *sys = vd->sys;
305 [sys->glView setVoutFlushing:YES];
306 vout_display_opengl_Display (sys->vgl, &vd->source);
307 [sys->glView setVoutFlushing:NO];
308 picture_Release (pic);
309 sys->has_first_frame = true;
312 subpicture_Delete(subpicture);
315 static int Control (vout_display_t *vd, int query, va_list ap)
317 vout_display_sys_t *sys = vd->sys;
327 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
329 const vout_display_cfg_t *cfg = va_arg (ap, const vout_display_cfg_t *);
330 if (vout_window_SetFullScreen (sys->embed, cfg->is_fullscreen))
335 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
337 unsigned state = va_arg (ap, unsigned);
338 return vout_window_SetState (sys->embed, state);
340 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
341 case VOUT_DISPLAY_CHANGE_ZOOM:
342 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
343 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
344 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
346 NSAutoreleasePool * o_pool = [[NSAutoreleasePool alloc] init];
348 id o_window = [sys->glView window];
351 return VLC_SUCCESS; // this is okay, since the event will occur again when we have a window
354 NSSize windowMinSize = [o_window minSize];
356 const vout_display_cfg_t *cfg;
357 const video_format_t *source;
358 bool is_forced = false;
360 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP) {
361 source = (const video_format_t *)va_arg (ap, const video_format_t *);
364 source = &vd->source;
365 cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
366 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
367 is_forced = (bool)va_arg (ap, int);
370 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE && is_forced
371 && (cfg->display.width != vd->cfg->display.width
372 || cfg->display.height != vd->cfg->display.height)
373 && vout_window_SetSize (sys->embed, cfg->display.width, cfg->display.height)) {
378 /* we always use our current frame here, because we have some size constraints
379 in the ui vout provider */
380 vout_display_cfg_t cfg_tmp = *cfg;
382 /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
384 bounds = [sys->glView convertRectToBacking:[sys->glView bounds]];
386 bounds = [sys->glView bounds];
387 cfg_tmp.display.width = bounds.size.width;
388 cfg_tmp.display.height = bounds.size.height;
390 vout_display_place_t place;
391 vout_display_PlacePicture (&place, source, &cfg_tmp, false);
392 @synchronized (sys->glView) {
396 /* For resize, we call glViewport in reshape and not here.
397 This has the positive side effect that we avoid erratic sizing as we animate every resize. */
398 if (query != VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
399 // x / y are top left corner, but we need the lower left one
400 glViewport (place.x, cfg_tmp.display.height - (place.y + place.height), place.width, place.height);
407 case VOUT_DISPLAY_HIDE_MOUSE:
409 [NSCursor setHiddenUntilMouseMoves: YES];
413 case VOUT_DISPLAY_GET_OPENGL:
415 vlc_gl_t **gl = va_arg (ap, vlc_gl_t **);
420 case VOUT_DISPLAY_RESET_PICTURES:
423 msg_Err (vd, "Unknown request in Mac OS X vout display");
428 /*****************************************************************************
429 * vout opengl callbacks
430 *****************************************************************************/
431 static int OpenglLock (vlc_gl_t *gl)
433 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
434 if (!sys->glView || ![sys->glView respondsToSelector:@selector(openGLContext)])
437 NSOpenGLContext *context = [sys->glView openGLContext];
438 CGLError err = CGLLockContext ([context CGLContextObj]);
439 if (kCGLNoError == err) {
440 [context makeCurrentContext];
446 static void OpenglUnlock (vlc_gl_t *gl)
448 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
449 CGLUnlockContext ([[sys->glView openGLContext] CGLContextObj]);
452 static void OpenglSwap (vlc_gl_t *gl)
454 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
455 [[sys->glView openGLContext] flushBuffer];
458 /*****************************************************************************
460 *****************************************************************************/
461 @implementation VLCOpenGLVideoView
463 #define VLCAssertMainThread() assert([[NSThread currentThread] isMainThread])
466 + (void)getNewView:(NSValue *)value
468 id *ret = [value pointerValue];
469 *ret = [[self alloc] init];
473 * Gets called by the Open() method.
477 VLCAssertMainThread();
479 /* Warning - this may be called on non main thread */
481 NSOpenGLPixelFormatAttribute attribs[] =
483 NSOpenGLPFADoubleBuffer,
484 NSOpenGLPFAAccelerated,
485 NSOpenGLPFANoRecovery,
486 NSOpenGLPFAColorSize, 24,
487 NSOpenGLPFAAlphaSize, 8,
488 NSOpenGLPFADepthSize, 24,
490 NSOpenGLPFAAllowOfflineRenderers,
494 NSOpenGLPixelFormat *fmt = [[NSOpenGLPixelFormat alloc] initWithAttributes:attribs];
499 self = [super initWithFrame:NSMakeRect(0,0,10,10) pixelFormat:fmt];
505 /* enable HiDPI support on OS X 10.7 and later */
507 [self setWantsBestResolutionOpenGLSurface:YES];
509 /* Swap buffers only during the vertical retrace of the monitor.
510 http://developer.apple.com/documentation/GraphicsImaging/
511 Conceptual/OpenGL/chap5/chapter_5_section_44.html */
512 GLint params[] = { 1 };
513 CGLSetParameter ([[self openGLContext] CGLContextObj], kCGLCPSwapInterval, params);
515 [[NSNotificationCenter defaultCenter] addObserverForName:NSApplicationDidChangeScreenParametersNotification
516 object:[NSApplication sharedApplication]
518 usingBlock:^(NSNotification *notification) {
519 [self performSelectorOnMainThread:@selector(reshape)
524 [self setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable];
530 [[NSNotificationCenter defaultCenter] removeObserver:self];
535 * Gets called by the Open() method.
537 - (void)setFrameToBoundsOfView:(NSValue *)value
539 NSView *parentView = [value pointerValue];
540 [self setFrame:[parentView bounds]];
544 * Gets called by the Close and Open methods.
547 - (void)setVoutDisplay:(vout_display_t *)aVd
549 @synchronized(self) {
555 * Gets called when the vout will aquire the lock and flush.
558 - (void)setVoutFlushing:(BOOL)flushing
562 @synchronized(self) {
563 _hasPendingReshape = NO;
568 * Can -drawRect skip rendering?.
570 - (BOOL)canSkipRendering
572 VLCAssertMainThread();
574 @synchronized(self) {
575 BOOL hasFirstFrame = vd && vd->sys->has_first_frame;
576 return !_hasPendingReshape && hasFirstFrame;
582 * Local method that locks the gl context.
586 VLCAssertMainThread();
587 NSOpenGLContext *context = [self openGLContext];
588 CGLError err = CGLLockContext ([context CGLContextObj]);
589 if (err == kCGLNoError)
590 [context makeCurrentContext];
591 return err == kCGLNoError;
595 * Local method that unlocks the gl context.
599 VLCAssertMainThread();
600 CGLUnlockContext ([[self openGLContext] CGLContextObj]);
604 * Local method that force a rendering of a frame.
605 * This will get called if Cocoa forces us to redraw (via -drawRect).
609 VLCAssertMainThread();
611 // We may have taken some times to take the opengl Lock.
612 // Check here to see if we can just skip the frame as well.
613 if ([self canSkipRendering])
617 @synchronized(self) { // vd can be accessed from multiple threads
618 hasFirstFrame = vd && vd->sys->has_first_frame;
622 // This will lock gl.
623 vout_display_opengl_Display (vd->sys->vgl, &vd->source);
625 glClear (GL_COLOR_BUFFER_BIT);
629 * Method called by Cocoa when the view is resized.
633 VLCAssertMainThread();
636 /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
638 bounds = [self convertRectToBacking:[self bounds]];
640 bounds = [self bounds];
641 vout_display_place_t place;
643 @synchronized(self) {
645 vout_display_cfg_t cfg_tmp = *(vd->cfg);
646 cfg_tmp.display.width = bounds.size.width;
647 cfg_tmp.display.height = bounds.size.height;
649 vout_display_PlacePicture (&place, &vd->source, &cfg_tmp, false);
650 vd->sys->place = place;
651 vout_display_SendEventDisplaySize (vd, bounds.size.width, bounds.size.height, vd->cfg->is_fullscreen);
656 // x / y are top left corner, but we need the lower left one
657 glViewport (place.x, bounds.size.height - (place.y + place.height), place.width, place.height);
659 @synchronized(self) {
660 // This may be cleared before -drawRect is being called,
661 // in this case we'll skip the rendering.
662 // This will save us for rendering two frames (or more) for nothing
663 // (one by the vout, one (or more) by drawRect)
664 _hasPendingReshape = YES;
674 * Method called by Cocoa when the view is resized or the location has changed.
675 * We just need to make sure we are locking here.
679 VLCAssertMainThread();
680 BOOL success = [self lockgl];
690 * Method called by Cocoa to force redraw.
692 - (void)drawRect:(NSRect) rect
694 VLCAssertMainThread();
696 if ([self canSkipRendering])
699 BOOL success = [self lockgl];
710 NSWindow *window = [self window];
712 // Remove flashes with splitter view.
713 if ([window respondsToSelector:@selector(disableScreenUpdatesUntilFlush)])
714 [window disableScreenUpdatesUntilFlush];
725 #pragma mark Mouse handling
727 - (void)mouseDown:(NSEvent *)o_event
729 @synchronized (self) {
731 if ([o_event type] == NSLeftMouseDown && !([o_event modifierFlags] & NSControlKeyMask)) {
732 if ([o_event clickCount] <= 1)
733 vout_display_SendEventMousePressed (vd, MOUSE_BUTTON_LEFT);
738 [super mouseDown:o_event];
741 - (void)otherMouseDown:(NSEvent *)o_event
743 @synchronized (self) {
745 vout_display_SendEventMousePressed (vd, MOUSE_BUTTON_CENTER);
748 [super otherMouseDown: o_event];
751 - (void)mouseUp:(NSEvent *)o_event
753 @synchronized (self) {
755 if ([o_event type] == NSLeftMouseUp)
756 vout_display_SendEventMouseReleased (vd, MOUSE_BUTTON_LEFT);
760 [super mouseUp: o_event];
763 - (void)otherMouseUp:(NSEvent *)o_event
765 @synchronized (self) {
767 vout_display_SendEventMouseReleased (vd, MOUSE_BUTTON_CENTER);
770 [super otherMouseUp: o_event];
773 - (void)mouseMoved:(NSEvent *)o_event
779 /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
781 s_rect = [self convertRectToBacking:[self bounds]];
783 s_rect = [self bounds];
784 ml = [self convertPoint: [o_event locationInWindow] fromView: nil];
785 b_inside = [self mouse: ml inRect: s_rect];
788 @synchronized (self) {
790 vout_display_place_t place = vd->sys->place;
792 if (place.width > 0 && place.height > 0) {
793 const int x = vd->source.i_x_offset +
794 (int64_t)(ml.x - place.x) * vd->source.i_visible_width / place.width;
795 const int y = vd->source.i_y_offset +
796 (int64_t)((int)s_rect.size.height - (int)ml.y - place.y) * vd->source.i_visible_height / place.height;
798 vout_display_SendEventMouseMoved (vd, x, y);
804 [super mouseMoved: o_event];
807 - (void)mouseDragged:(NSEvent *)o_event
809 [self mouseMoved: o_event];
810 [super mouseDragged: o_event];
813 - (void)otherMouseDragged:(NSEvent *)o_event
815 [self mouseMoved: o_event];
816 [super otherMouseDragged: o_event];
819 - (void)rightMouseDragged:(NSEvent *)o_event
821 [self mouseMoved: o_event];
822 [super rightMouseDragged: o_event];
825 - (BOOL)acceptsFirstResponder
830 - (BOOL)mouseDownCanMoveWindow