video_output/opengllayer.m: Don't rely on CAOpenGLLayer when frames should be display...
[vlc.git] / modules / video_output / opengllayer.m
1 /*****************************************************************************
2  * opengl.c: CAOpenGLLayer (Mac OS X) video output. Display a video output in
3  * a layer. The layer will register itself to the drawable object stored in 
4  * the "drawable" variable. 
5  *****************************************************************************
6  * Copyright (C) 2004 the VideoLAN team
7  * $Id$
8  *
9  * Authors: Cyril Deguet <asmax@videolan.org>
10  *          Gildas Bazin <gbazin@videolan.org>
11  *          Eric Petit <titer@m0k.org>
12  *          Cedric Cocquebert <cedric.cocquebert@supelec.fr>
13  *          Pierre d'Herbemont <pdherbemont # videolan.org>
14  *
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
28  *****************************************************************************/
29
30 /*****************************************************************************
31  * Preamble
32  *****************************************************************************/
33 #include <errno.h>                                                 /* ENOMEM */
34
35 #include <vlc/vlc.h>
36 #include <vlc_vout.h>
37
38 #import <QuartzCore/QuartzCore.h>
39 #import <Cocoa/Cocoa.h>
40 #import <OpenGL/OpenGL.h>
41
42 /* On OS X, use GL_TEXTURE_RECTANGLE_EXT instead of GL_TEXTURE_2D.
43    This allows sizes which are not powers of 2 */
44 #define VLCGL_TARGET GL_TEXTURE_RECTANGLE_EXT
45
46 /* OS X OpenGL supports YUV. Hehe. */
47 #define VLCGL_FORMAT GL_YCBCR_422_APPLE
48 #define VLCGL_TYPE   GL_UNSIGNED_SHORT_8_8_APPLE
49
50 /* RV32 */
51 #define VLCGL_RGB_FORMAT GL_RGBA
52 #define VLCGL_RGB_TYPE GL_UNSIGNED_BYTE
53
54 /* YUY2 */
55 #ifndef YCBCR_MESA
56 #define YCBCR_MESA 0x8757
57 #endif
58 #ifndef UNSIGNED_SHORT_8_8_MESA
59 #define UNSIGNED_SHORT_8_8_MESA 0x85BA
60 #endif
61 #define VLCGL_YUV_FORMAT YCBCR_MESA
62 #define VLCGL_YUV_TYPE UNSIGNED_SHORT_8_8_MESA
63
64
65 #ifndef GL_CLAMP_TO_EDGE
66 #   define GL_CLAMP_TO_EDGE 0x812F
67 #endif
68
69 @interface VLCVideoView : NSObject
70 - (void)addVoutLayer:(CALayer *)layer;
71 @end
72
73 /*****************************************************************************
74  * Vout interface
75  *****************************************************************************/
76 static int  CreateVout   ( vlc_object_t * );
77 static void DestroyVout  ( vlc_object_t * );
78 static int  Init         ( vout_thread_t * );
79 static void End          ( vout_thread_t * );
80 static int  Manage       ( vout_thread_t * );
81 static void Render       ( vout_thread_t *, picture_t * );
82 static void DisplayVideo ( vout_thread_t *, picture_t * );
83 static int  Control      ( vout_thread_t *, int, va_list );
84
85 static int InitTextures  ( vout_thread_t * );
86
87 vlc_module_begin();
88     set_shortname( "OpenGLLayer" );
89     set_category( CAT_VIDEO );
90     set_subcategory( SUBCAT_VIDEO_VOUT );
91     set_description( _("Core Animation OpenGL Layer (Mac OS X)") );
92     set_capability( "video output", 20 );
93     add_shortcut( "opengllayer" );
94     set_callbacks( CreateVout, DestroyVout );
95 vlc_module_end();
96
97 @interface VLCVoutLayer : CAOpenGLLayer {
98     vout_thread_t * p_vout;
99 }
100 + (id)layerWithVout:(vout_thread_t*)_p_vout; 
101 @end
102
103 /*****************************************************************************
104  * vout_sys_t: video output method descriptor
105  *****************************************************************************
106  * This structure is part of the video output thread descriptor.
107  * It describes the OpenGL specific properties of the output thread.
108  *****************************************************************************/
109 struct vout_sys_t
110 {
111     vout_thread_t * p_vout;
112
113     uint8_t    *pp_buffer[2]; /* one last rendered, one to be rendered */
114     int         i_index;
115     vlc_bool_t  b_frame_available;
116     
117     CGLContextObj glContext;
118
119     int         i_tex_width;
120     int         i_tex_height;
121     GLuint      p_textures[2];
122
123     NSAutoreleasePool *autorealease_pool;
124     VLCVoutLayer * o_layer;
125     id          o_cocoa_container;
126 };
127
128 /*****************************************************************************
129  * CreateVout: This function allocates and initializes the OpenGL vout method.
130  *****************************************************************************/
131 static int CreateVout( vlc_object_t *p_this )
132 {
133     vout_thread_t *p_vout = (vout_thread_t *)p_this;
134     vout_sys_t *p_sys;
135     char * psz;
136
137     /* Allocate structure */
138     p_vout->p_sys = p_sys = calloc( sizeof( vout_sys_t ), 1 );
139     if( p_sys == NULL )
140     {
141         msg_Err( p_vout, "out of memory" );
142         return VLC_EGENERIC;
143     }
144
145     p_sys->i_tex_width  = p_vout->fmt_in.i_width;
146     p_sys->i_tex_height = p_vout->fmt_in.i_height;
147
148     msg_Dbg( p_vout, "Texture size: %dx%d", p_sys->i_tex_width,
149              p_sys->i_tex_height );
150
151     p_vout->pf_init = Init;
152     p_vout->pf_end = End;
153     p_vout->pf_manage = Manage;
154     p_vout->pf_render = Render;
155     p_vout->pf_display = DisplayVideo;
156     p_vout->pf_control = Control;
157
158     return VLC_SUCCESS;
159 }
160
161 /*****************************************************************************
162  * Init: initialize the OpenGL video thread output method
163  *****************************************************************************/
164 static int Init( vout_thread_t *p_vout )
165 {
166     vout_sys_t *p_sys = p_vout->p_sys;
167     int i_pixel_pitch;
168     vlc_value_t val;
169
170 #if ( defined( WORDS_BIGENDIAN ) && VLCGL_FORMAT == GL_YCBCR_422_APPLE ) || (VLCGL_FORMAT == YCBCR_MESA)
171     p_vout->output.i_chroma = VLC_FOURCC('Y','U','Y','2');
172     i_pixel_pitch = 2;
173 #elif (VLCGL_FORMAT == GL_YCBCR_422_APPLE)
174     p_vout->output.i_chroma = VLC_FOURCC('U','Y','V','Y');
175     i_pixel_pitch = 2;
176 #endif
177
178     /* Since OpenGL can do rescaling for us, stick to the default
179      * coordinates and aspect. */
180     p_vout->output.i_width  = p_vout->render.i_width;
181     p_vout->output.i_height = p_vout->render.i_height;
182     p_vout->output.i_aspect = p_vout->render.i_aspect;
183
184     /* We do need a drawable to work properly */
185     vlc_value_t value_drawable;
186     var_Create( p_vout, "drawable", VLC_VAR_DOINHERIT );
187     var_Get( p_vout, "drawable", &value_drawable );
188
189     p_vout->p_sys->o_cocoa_container = (id) value_drawable.i_int;
190     
191     p_vout->fmt_out = p_vout->fmt_in;
192     p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
193
194     /* We know the chroma, allocate two buffer which will be used
195      * directly by the decoder */
196     int i;
197     for( i = 0; i < 2; i++ )
198     {
199         p_sys->pp_buffer[i] =
200             malloc( p_sys->i_tex_width * p_sys->i_tex_height * i_pixel_pitch );
201         if( !p_sys->pp_buffer[i] )
202         {
203             msg_Err( p_vout, "out of memory" );
204             return VLC_EGENERIC;
205         }
206     }
207     p_sys->b_frame_available = VLC_FALSE;
208     p_sys->i_index = 0;
209
210     p_vout->p_picture[0].i_planes = 1;
211     p_vout->p_picture[0].p->p_pixels = p_sys->pp_buffer[p_sys->i_index];
212     p_vout->p_picture[0].p->i_lines = p_vout->output.i_height;
213     p_vout->p_picture[0].p->i_visible_lines = p_vout->output.i_height;
214     p_vout->p_picture[0].p->i_pixel_pitch = i_pixel_pitch;
215     p_vout->p_picture[0].p->i_pitch = p_vout->output.i_width *
216         p_vout->p_picture[0].p->i_pixel_pitch;
217     p_vout->p_picture[0].p->i_visible_pitch = p_vout->output.i_width *
218         p_vout->p_picture[0].p->i_pixel_pitch;
219
220     p_vout->p_picture[0].i_status = DESTROYED_PICTURE;
221     p_vout->p_picture[0].i_type   = DIRECT_PICTURE;
222
223     PP_OUTPUTPICTURE[ 0 ] = &p_vout->p_picture[0];
224
225     I_OUTPUTPICTURES = 1;
226     p_sys->autorealease_pool = [[NSAutoreleasePool alloc] init];
227
228     [VLCVoutLayer performSelectorOnMainThread:@selector(autoinitInVout:)
229                              withObject:[NSValue valueWithPointer:p_vout]
230                              waitUntilDone:YES];
231
232     return 0;
233 }
234
235 /*****************************************************************************
236  * End: terminate GLX video thread output method
237  *****************************************************************************/
238 static void End( vout_thread_t *p_vout )
239 {
240     vout_sys_t *p_sys = p_vout->p_sys;
241
242     p_vout->p_sys->b_frame_available = VLC_FALSE;
243
244     [CATransaction performSelectorOnMainThread:@selector(begin)
245                     withObject:nil waitUntilDone:YES];
246
247     [p_sys->o_layer performSelectorOnMainThread:@selector(removeFromSuperlayer)
248                     withObject:nil waitUntilDone:YES];
249     [CATransaction performSelectorOnMainThread:@selector(commit)
250                     withObject:nil waitUntilDone:YES];
251
252     // Should be done automatically
253     [p_sys->o_layer release];
254     [p_sys->autorealease_pool release];
255
256     /* Free the texture buffer*/
257     free( p_sys->pp_buffer[0] );
258     free( p_sys->pp_buffer[1] );
259 }
260
261 /*****************************************************************************
262  * Destroy: destroy GLX video thread output method
263  *****************************************************************************
264  * Terminate an output method created by CreateVout
265  *****************************************************************************/
266 static void DestroyVout( vlc_object_t *p_this )
267 {
268     vout_thread_t *p_vout = (vout_thread_t *)p_this;
269     vout_sys_t *p_sys = p_vout->p_sys;
270     free( p_sys );
271 }
272
273 /*****************************************************************************
274  * Manage: handle Sys events
275  *****************************************************************************
276  * This function should be called regularly by video output thread. It returns
277  * a non null value if an error occurred.
278  *****************************************************************************/
279 static int Manage( vout_thread_t *p_vout )
280 {
281     vout_sys_t *p_sys = p_vout->p_sys;
282
283     return VLC_SUCCESS;
284 }
285
286 /*****************************************************************************
287  * Render: render previously calculated output
288  *****************************************************************************/
289 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
290 {
291     vout_sys_t *p_sys = p_vout->p_sys;
292
293     @synchronized( p_sys->o_layer ) /* Make sure the p_sys->glContext isn't edited */
294     {
295         if( p_sys->glContext )
296         {
297             CGLLockContext(p_sys->glContext);
298             CGLSetCurrentContext(p_sys->glContext);
299             int i_new_index;
300             i_new_index = ( p_sys->i_index + 1 ) & 1;
301
302
303             /* Update the texture */
304             glBindTexture( VLCGL_TARGET, p_sys->p_textures[i_new_index] );
305             glTexSubImage2D( VLCGL_TARGET, 0, 0, 0,
306                          p_vout->fmt_out.i_width,
307                          p_vout->fmt_out.i_height,
308                          VLCGL_FORMAT, VLCGL_TYPE, p_sys->pp_buffer[i_new_index] );
309
310             /* Bind to the previous texture for drawing */
311             glBindTexture( VLCGL_TARGET, p_sys->p_textures[p_sys->i_index] );
312
313             /* Switch buffers */
314             p_sys->i_index = i_new_index;
315             p_pic->p->p_pixels = p_sys->pp_buffer[p_sys->i_index];
316             CGLUnlockContext(p_sys->glContext);
317         }
318     }
319
320     /* Give a buffer where the image will be rendered */
321     p_pic->p->p_pixels = p_sys->pp_buffer[p_sys->i_index];
322 }
323
324 /*****************************************************************************
325  * DisplayVideo: displays previously rendered output
326  *****************************************************************************/
327 static void DisplayVideo( vout_thread_t *p_vout, picture_t *p_pic )
328 {
329     vout_sys_t *p_sys = p_vout->p_sys;
330
331     [p_sys->o_layer performSelectorOnMainThread:@selector(setNeedsDisplay)
332                     withObject:nil waitUntilDone:NO];
333
334     p_sys->b_frame_available = VLC_TRUE;
335 }
336
337 /*****************************************************************************
338  * Control: control facility for the vout
339  *****************************************************************************/
340 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
341 {
342     vout_sys_t *p_sys = p_vout->p_sys;
343
344     switch( i_query )
345     {
346     case VOUT_SNAPSHOT:
347         return vout_vaControlDefault( p_vout, i_query, args );
348
349     default:
350         if( p_sys->p_vout->pf_control )
351             return p_sys->p_vout->pf_control( p_sys->p_vout, i_query, args );
352         else
353             return vout_vaControlDefault( p_vout, i_query, args );
354     }
355 }
356
357 /*****************************************************************************
358  * InitTextures
359  *****************************************************************************/
360 static int InitTextures( vout_thread_t *p_vout )
361 {
362     vout_sys_t *p_sys = p_vout->p_sys;
363     int i_index;
364
365     glDeleteTextures( 2, p_sys->p_textures );
366     glGenTextures( 2, p_sys->p_textures );
367
368     for( i_index = 0; i_index < 2; i_index++ )
369     {
370         glBindTexture( VLCGL_TARGET, p_sys->p_textures[i_index] );
371
372         /* Set the texture parameters */
373         glTexParameterf( VLCGL_TARGET, GL_TEXTURE_PRIORITY, 1.0 );
374
375         glTexParameteri( VLCGL_TARGET, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE );
376         glTexParameteri( VLCGL_TARGET, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE );
377
378         glTexParameteri( VLCGL_TARGET, GL_TEXTURE_MAG_FILTER, GL_LINEAR );
379         glTexParameteri( VLCGL_TARGET, GL_TEXTURE_MIN_FILTER, GL_LINEAR );
380
381         glTexEnvf( GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE );
382
383         /* Note: It seems that we can't bypass those, and even
384          * disabled they are used. They are the cause of the flickering */
385
386         /* Tell the driver not to make a copy of the texture but to use
387            our buffer */
388         glEnable( GL_UNPACK_CLIENT_STORAGE_APPLE );
389         glPixelStorei( GL_UNPACK_CLIENT_STORAGE_APPLE, GL_TRUE );
390
391         /* Use AGP texturing */
392         glTexParameteri( VLCGL_TARGET, GL_TEXTURE_STORAGE_HINT_APPLE, GL_STORAGE_SHARED_APPLE );
393
394         /* Call glTexImage2D only once, and use glTexSubImage2D later */
395         glTexImage2D( VLCGL_TARGET, 0, 4, p_sys->i_tex_width,
396                       p_sys->i_tex_height, 0, VLCGL_FORMAT, VLCGL_TYPE,
397                       p_sys->pp_buffer[i_index] );
398     }
399
400     return 0;
401 }
402
403 /*****************************************************************************
404  * @implementation VLCVoutLayer
405  */
406 @implementation VLCVoutLayer
407
408 /*****************************************************************************
409  * autoinitInVout: Called from the video thread to create a layer.
410  * The created layer is stored in the p_vout. We do that way because, cocoa
411  * doesn't support layer creation on non-main thread.
412  *****************************************************************************/
413 + (void)autoinitInVout:(NSValue*)arg
414 {
415     vout_thread_t * p_vout = [arg pointerValue];
416     p_vout->p_sys->o_layer = [[VLCVoutLayer layerWithVout:p_vout] retain];
417     [p_vout->p_sys->o_cocoa_container addVoutLayer:p_vout->p_sys->o_layer];
418 }
419
420 + (id)layerWithVout:(vout_thread_t*)_p_vout 
421 {
422     VLCVoutLayer* me = [[[self alloc] init] autorelease];
423     if( me )
424     {
425         me->p_vout = _p_vout;
426         me.asynchronous = NO;
427         me.bounds = CGRectMake( 0.0, 0.0, 
428                                 (float)_p_vout->fmt_in.i_visible_width * _p_vout->fmt_in.i_sar_num,
429                                 (float)_p_vout->fmt_in.i_visible_height * _p_vout->fmt_in.i_sar_den );
430     }
431     return me;
432 }
433
434 - (BOOL)canDrawInCGLContext:(CGLContextObj)glContext pixelFormat:(CGLPixelFormatObj)pixelFormat forLayerTime:(CFTimeInterval)timeInterval displayTime:(const CVTimeStamp *)timeStamp
435 {
436     /* Only draw the frame if we have a frame that was previously rendered */
437         return p_vout->p_sys->b_frame_available; // Flag is cleared by drawInCGLContext:pixelFormat:forLayerTime:displayTime:
438 }
439
440 - (void)drawInCGLContext:(CGLContextObj)glContext pixelFormat:(CGLPixelFormatObj)pixelFormat forLayerTime:(CFTimeInterval)timeInterval displayTime:(const CVTimeStamp *)timeStamp
441 {
442     CGLLockContext( glContext );
443     CGLSetCurrentContext( glContext );
444
445     float f_width, f_height, f_x, f_y;
446
447     f_x = (float)p_vout->fmt_out.i_x_offset;
448     f_y = (float)p_vout->fmt_out.i_y_offset;
449     f_width = (float)p_vout->fmt_out.i_x_offset +
450               (float)p_vout->fmt_out.i_visible_width;
451     f_height = (float)p_vout->fmt_out.i_y_offset +
452                (float)p_vout->fmt_out.i_visible_height;
453
454     glClear( GL_COLOR_BUFFER_BIT );
455
456     glEnable( VLCGL_TARGET );
457     glBegin( GL_POLYGON );
458     glTexCoord2f( f_x, f_y ); glVertex2f( -1.0, 1.0 );
459     glTexCoord2f( f_width, f_y ); glVertex2f( 1.0, 1.0 );
460     glTexCoord2f( f_width, f_height ); glVertex2f( 1.0, -1.0 );
461     glTexCoord2f( f_x, f_height ); glVertex2f( -1.0, -1.0 );
462     glEnd();
463
464     glDisable( VLCGL_TARGET );
465
466     glFlush();
467
468     CGLUnlockContext( glContext );
469
470     p_vout->p_sys->b_frame_available = VLC_FALSE;
471 }
472
473 - (CGLContextObj)copyCGLContextForPixelFormat:(CGLPixelFormatObj)pixelFormat
474 {
475     CGLContextObj context = [super copyCGLContextForPixelFormat:pixelFormat];
476
477     CGLLockContext( context );
478
479     CGLSetCurrentContext( context );
480
481     /* Swap buffers only during the vertical retrace of the monitor.
482     http://developer.apple.com/documentation/GraphicsImaging/
483     Conceptual/OpenGL/chap5/chapter_5_section_44.html */
484
485     GLint params = 1;
486     CGLSetParameter( CGLGetCurrentContext(), kCGLCPSwapInterval,
487                      &params );
488
489     InitTextures( p_vout );
490
491     glDisable( GL_BLEND );
492     glDisable( GL_DEPTH_TEST );
493     glDepthMask( GL_FALSE );
494     glDisable( GL_CULL_FACE) ;
495     glClearColor( 0.0f, 0.0f, 0.0f, 1.0f );
496     glClear( GL_COLOR_BUFFER_BIT );
497
498     CGLUnlockContext( context );
499     @synchronized( self )
500     {
501         p_vout->p_sys->glContext = context;
502     }
503
504     return context;
505 }
506
507 - (void)releaseCGLContext:(CGLContextObj)glContext
508 {
509     @synchronized( self )
510     {
511         p_vout->p_sys->glContext = nil;
512     }
513
514     CGLLockContext( glContext );
515     CGLSetCurrentContext( glContext );
516
517     glDeleteTextures( 2, p_vout->p_sys->p_textures );
518
519     CGLUnlockContext( glContext );
520 }
521 @end