1 /*****************************************************************************
2 * voutgl.m: MacOS X OpenGL provider
3 *****************************************************************************
4 * Copyright (C) 2001-2009 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>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
29 *****************************************************************************/
31 /*****************************************************************************
33 *****************************************************************************/
35 #import <Cocoa/Cocoa.h>
36 #import <OpenGL/OpenGL.h>
42 #include <vlc_common.h>
43 #include <vlc_plugin.h>
44 #include <vlc_vout_display.h>
45 #include <vlc_vout_opengl.h>
49 * Forward declarations
51 static int Open(vlc_object_t *);
52 static void Close(vlc_object_t *);
54 static picture_pool_t *Pool(vout_display_t *vd, unsigned requested_count);
55 static void PictureRender(vout_display_t *vd, picture_t *pic);
56 static void PictureDisplay(vout_display_t *vd, picture_t *pic);
57 static int Control (vout_display_t *vd, int query, va_list ap);
59 static int OpenglLock(vout_opengl_t *gl);
60 static void OpenglUnlock(vout_opengl_t *gl);
61 static void OpenglSwap(vout_opengl_t *gl);
67 /* Will be loaded even without interface module. see voutgl.m */
68 set_shortname("Mac OS X")
69 set_description( N_("Mac OS X OpenGL video output (requires drawable-nsobject)"))
70 set_category(CAT_VIDEO)
71 set_subcategory(SUBCAT_VIDEO_VOUT )
72 set_capability("vout display", 300)
73 set_callbacks(Open, Close)
75 add_shortcut("macosx")
76 add_shortcut("vout_macosx")
80 * Obj-C protocol declaration that drawable-nsobject should follow
82 @protocol VLCOpenGLVideoViewEmbedding <NSObject>
83 - (void)addVoutSubview:(NSView *)view;
84 - (void)removeVoutSubview:(NSView *)view;
87 @interface VLCOpenGLVideoView : NSOpenGLView
90 BOOL _hasPendingReshape;
92 - (void)setVoutDisplay:(vout_display_t *)vd;
93 - (void)setVoutFlushing:(BOOL)flushing;
97 struct vout_display_sys_t
99 VLCOpenGLVideoView *glView;
100 id<VLCOpenGLVideoViewEmbedding> container;
103 vout_display_opengl_t vgl;
105 picture_pool_t *pool;
107 bool has_first_frame;
110 static int Open(vlc_object_t *this)
112 vout_display_t *vd = (vout_display_t *)this;
113 vout_display_sys_t *sys = calloc(1, sizeof(*sys));
114 NSAutoreleasePool *nsPool = nil;
123 /* Get the drawable object */
124 id container = var_CreateGetAddress(vd, "drawable-nsobject");
127 msg_Dbg(vd, "No drawable-nsobject, passing over.");
130 vout_display_DeleteWindow(vd, NULL);
132 /* This will be released in Close(), on
133 * main thread, after we are done using it. */
134 sys->container = [container retain];
136 /* Get our main view*/
137 nsPool = [[NSAutoreleasePool alloc] init];
139 [VLCOpenGLVideoView performSelectorOnMainThread:@selector(getNewView:) withObject:[NSValue valueWithPointer:&sys->glView] waitUntilDone:YES];
143 [sys->glView setVoutDisplay:vd];
145 /* We don't wait, that means that we'll have to be careful about releasing
147 * That's why we'll release on main thread in Close(). */
148 if ([(id)container respondsToSelector:@selector(addVoutSubview:)])
149 [(id)container performSelectorOnMainThread:@selector(addVoutSubview:) withObject:sys->glView waitUntilDone:NO];
150 else if ([container isKindOfClass:[NSView class]])
152 NSView *parentView = container;
153 [parentView performSelectorOnMainThread:@selector(addSubview:) withObject:sys->glView waitUntilDone:NO];
154 [sys->glView performSelectorOnMainThread:@selector(setFrame:) withObject:[NSValue valueWithRect:[parentView bounds]] waitUntilDone:NO];
158 msg_Err(vd, "Invalid drawable-nsobject object. drawable-nsobject must either be an NSView or comply to the @protocol VLCOpenGLVideoViewEmbedding.");
166 /* Initialize common OpenGL video display */
167 sys->gl.lock = OpenglLock;
168 sys->gl.unlock = OpenglUnlock;
169 sys->gl.swap = OpenglSwap;
172 if (vout_display_opengl_Init(&sys->vgl, &vd->fmt, &sys->gl))
179 vout_display_info_t info = vd->info;
180 info.has_pictures_invalid = false;
182 /* Setup vout_display_t once everything is fine */
186 vd->prepare = PictureRender;
187 vd->display = PictureDisplay;
188 vd->control = Control;
191 vout_display_SendEventFullscreen (vd, false);
192 vout_display_SendEventDisplaySize (vd, vd->source.i_visible_width, vd->source.i_visible_height, false);
202 void Close(vlc_object_t *this)
204 vout_display_t *vd = (vout_display_t *)this;
205 vout_display_sys_t *sys = vd->sys;
207 [sys->glView setVoutDisplay:nil];
209 var_Destroy(vd, "drawable-nsobject");
210 if ([(id)sys->container respondsToSelector:@selector(removeVoutSubview:)])
212 /* This will retain sys->glView */
213 [(id)sys->container performSelectorOnMainThread:@selector(removeVoutSubview:) withObject:sys->glView waitUntilDone:NO];
215 /* release on main thread as explained in Open() */
216 [(id)sys->container performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
217 [sys->glView performSelectorOnMainThread:@selector(removeFromSuperview) withObject:nil waitUntilDone:NO];
219 [sys->glView release];
221 if (sys->gl.sys != NULL)
222 vout_display_opengl_Clean(&sys->vgl);
227 /*****************************************************************************
228 * vout display callbacks
229 *****************************************************************************/
231 static picture_pool_t *Pool(vout_display_t *vd, unsigned requested_count)
233 vout_display_sys_t *sys = vd->sys;
234 VLC_UNUSED(requested_count);
237 sys->pool = vout_display_opengl_GetPool (&sys->vgl);
242 static void PictureRender(vout_display_t *vd, picture_t *pic)
245 vout_display_sys_t *sys = vd->sys;
247 vout_display_opengl_Prepare( &sys->vgl, pic );
250 static void PictureDisplay(vout_display_t *vd, picture_t *pic)
252 vout_display_sys_t *sys = vd->sys;
253 [sys->glView setVoutFlushing:YES];
254 vout_display_opengl_Display(&sys->vgl, &vd->fmt );
255 [sys->glView setVoutFlushing:NO];
256 picture_Release (pic);
257 sys->has_first_frame = true;
260 static int Control (vout_display_t *vd, int query, va_list ap)
262 vout_display_sys_t *sys = vd->sys;
266 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
267 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
268 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
269 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
270 case VOUT_DISPLAY_CHANGE_ZOOM:
271 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
272 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
277 case VOUT_DISPLAY_HIDE_MOUSE:
280 case VOUT_DISPLAY_GET_OPENGL:
282 vout_opengl_t **gl = va_arg (ap, vout_opengl_t **);
287 case VOUT_DISPLAY_RESET_PICTURES:
290 msg_Err (vd, "Unknown request in Mac OS X vout display");
295 /*****************************************************************************
296 * vout opengl callbacks
297 *****************************************************************************/
298 static int OpenglLock(vout_opengl_t *gl)
300 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
301 NSOpenGLContext *context = [sys->glView openGLContext];
302 CGLError err = CGLLockContext([context CGLContextObj]);
303 if (kCGLNoError == err)
305 [context makeCurrentContext];
311 static void OpenglUnlock(vout_opengl_t *gl)
313 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
314 CGLUnlockContext([[sys->glView openGLContext] CGLContextObj]);
317 static void OpenglSwap(vout_opengl_t *gl)
319 vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
320 [[sys->glView openGLContext] flushBuffer];
323 /*****************************************************************************
325 *****************************************************************************/
326 @implementation VLCOpenGLVideoView
328 #define VLCAssertMainThread() assert([[NSThread currentThread] isMainThread])
330 + (void)getNewView:(NSValue *)value
332 id *ret = [value pointerValue];
333 *ret = [[self alloc] init];
337 * Gets called by the Open() method.
341 VLCAssertMainThread();
343 /* Warning - this may be called on non main thread */
345 NSOpenGLPixelFormatAttribute attribs[] =
347 NSOpenGLPFADoubleBuffer,
348 NSOpenGLPFAAccelerated,
349 NSOpenGLPFANoRecovery,
350 NSOpenGLPFAColorSize, 24,
351 NSOpenGLPFAAlphaSize, 8,
352 NSOpenGLPFADepthSize, 24,
357 NSOpenGLPixelFormat *fmt = [[NSOpenGLPixelFormat alloc] initWithAttributes:attribs];
362 self = [super initWithFrame:NSMakeRect(0,0,10,10) pixelFormat:fmt];
368 /* Swap buffers only during the vertical retrace of the monitor.
369 http://developer.apple.com/documentation/GraphicsImaging/
370 Conceptual/OpenGL/chap5/chapter_5_section_44.html */
371 GLint params[] = { 1 };
372 CGLSetParameter([[self openGLContext] CGLContextObj], kCGLCPSwapInterval, params);
374 [self setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable];
379 * Gets called by the Close and Open methods.
382 - (void)setVoutDisplay:(vout_display_t *)aVd
384 @synchronized(self) {
391 * Gets called when the vout will aquire the lock and flush.
394 - (void)setVoutFlushing:(BOOL)flushing
398 @synchronized(self) {
399 _hasPendingReshape = NO;
404 * Can -drawRect skip rendering?.
406 - (BOOL)canSkipRendering
408 VLCAssertMainThread();
410 @synchronized(self) {
411 BOOL hasFirstFrame = vd && vd->sys->has_first_frame;
412 return !_hasPendingReshape && hasFirstFrame;
418 * Local method that locks the gl context.
422 VLCAssertMainThread();
423 NSOpenGLContext *context = [self openGLContext];
424 CGLError err = CGLLockContext([context CGLContextObj]);
425 if (err == kCGLNoError)
426 [context makeCurrentContext];
427 return err == kCGLNoError;
431 * Local method that unlocks the gl context.
435 VLCAssertMainThread();
436 CGLUnlockContext([[self openGLContext] CGLContextObj]);
440 * Local method that force a rendering of a frame.
441 * This will get called if Cocoa forces us to redraw (via -drawRect).
445 VLCAssertMainThread();
447 // We may have taken some times to take the opengl Lock.
448 // Check here to see if we can just skip the frame as well.
449 if ([self canSkipRendering])
453 @synchronized(self) { // vd can be accessed from multiple threads
454 hasFirstFrame = vd && vd->sys->has_first_frame;
458 // This will lock gl.
459 vout_display_opengl_Display( &vd->sys->vgl, &vd->source );
462 glClear(GL_COLOR_BUFFER_BIT);
466 * Method called by Cocoa when the view is resized.
470 VLCAssertMainThread();
472 NSRect bounds = [self bounds];
474 CGFloat height = bounds.size.height;
475 CGFloat width = bounds.size.width;
477 GLint x = width, y = height;
479 @synchronized(self) {
481 CGFloat videoHeight = vd->source.i_visible_height;
482 CGFloat videoWidth = vd->source.i_visible_width;
484 GLint sarNum = vd->source.i_sar_num;
485 GLint sarDen = vd->source.i_sar_den;
487 if (height * videoWidth * sarNum < width * videoHeight * sarDen)
489 x = (height * videoWidth * sarNum) / (videoHeight * sarDen);
495 y = (width * videoHeight * sarDen) / (videoWidth * sarNum);
501 glViewport((width - x) / 2, (height - y) / 2, x, y);
503 @synchronized(self) {
504 // This may be cleared before -drawRect is being called,
505 // in this case we'll skip the rendering.
506 // This will save us for rendering two frames (or more) for nothing
507 // (one by the vout, one (or more) by drawRect)
508 _hasPendingReshape = YES;
518 * Method called by Cocoa when the view is resized or the location has changed.
519 * We just need to make sure we are locking here.
523 VLCAssertMainThread();
524 BOOL success = [self lockgl];
534 * Method called by Cocoa to force redraw.
536 - (void)drawRect:(NSRect) rect
538 VLCAssertMainThread();
540 if ([self canSkipRendering])
543 BOOL success = [self lockgl];
554 NSWindow *window = [self window];
556 // Remove flashes with splitter view.
557 if ([window respondsToSelector:@selector(disableScreenUpdatesUntilFlush)])
558 [window disableScreenUpdatesUntilFlush];
563 - (BOOL)mouseDownCanMoveWindow