git.sesse.net Git - vlc/blob - modules/video_output/opengl.c

   1 /*****************************************************************************
   2  * opengl.c: OpenGL video output
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet <asmax@videolan.org>
   8  *          Gildas Bazin <gbazin@videolan.org>
   9  *          Eric Petit <titer@m0k.org>
  10  *          Cedric Cocquebert <cedric.cocquebert@supelec.fr>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30
  31 #ifdef HAVE_CONFIG_H
  32 # include "config.h"
  33 #endif
  34
  35 #include <assert.h>
  36
  37 #include <vlc_common.h>
  38 #include <vlc_plugin.h>
  39 #include <vlc_vout.h>
  40 #include "opengl.h"
  41
  42 /*****************************************************************************
  43  * Vout interface
  44  *****************************************************************************/
  45 static int  CreateVout   ( vlc_object_t * );
  46 static void DestroyVout  ( vlc_object_t * );
  47 static int  Init         ( vout_thread_t * );
  48 static void End          ( vout_thread_t * );
  49 static int  Manage       ( vout_thread_t * );
  50 static void Render       ( vout_thread_t *, picture_t * );
  51 static void DisplayVideo ( vout_thread_t *, picture_t * );
  52 static int  Control      ( vout_thread_t *, int, va_list );
  53
  54 static int SendEvents    ( vlc_object_t *, char const *,
  55                            vlc_value_t, vlc_value_t, void * );
  56
  57 #define PROVIDER_TEXT N_("OpenGL Provider")
  58 #define PROVIDER_LONGTEXT N_("Allows you to modify what OpenGL provider should be used")
  59
  60 vlc_module_begin ()
  61     set_shortname( "OpenGL" )
  62     set_category( CAT_VIDEO )
  63     set_subcategory( SUBCAT_VIDEO_VOUT )
  64     set_description( N_("OpenGL video output") )
  65 #ifdef __APPLE__
  66     set_capability( "video output", 200 )
  67 #else
  68     set_capability( "video output", 20 )
  69 #endif
  70     add_shortcut( "opengl" )
  71     /* Allow opengl provider plugin selection */
  72     add_module( "opengl-provider", "opengl provider", NULL, NULL,
  73                 PROVIDER_TEXT, PROVIDER_LONGTEXT, true )
  74     set_callbacks( CreateVout, DestroyVout )
  75 vlc_module_end ()
  76
  77 /*****************************************************************************
  78  * vout_sys_t: video output method descriptor
  79  *****************************************************************************
  80  * This structure is part of the video output thread descriptor.
  81  * It describes the OpenGL specific properties of the output thread.
  82  *****************************************************************************/
  83 struct vout_sys_t
  84 {
  85     vout_thread_t *p_vout;
  86     vout_opengl_t gl;
  87     vout_display_opengl_t vgl;
  88
  89     picture_pool_t *p_pool;
  90     picture_t *p_current;
  91 };
  92
  93 /*****************************************************************************
  94  * CreateVout: This function allocates and initializes the OpenGL vout method.
  95  *****************************************************************************/
  96 static int CreateVout( vlc_object_t *p_this )
  97 {
  98     vout_thread_t *p_vout = (vout_thread_t *)p_this;
  99     vout_sys_t *p_sys;
 100     char * psz;
 101
 102     /* Allocate structure */
 103     p_vout->p_sys = p_sys = malloc( sizeof( vout_sys_t ) );
 104     if( p_sys == NULL )
 105         return VLC_ENOMEM;
 106
 107     /* Get window */
 108     p_sys->p_vout =
 109         (vout_thread_t *)vlc_object_create( p_this, sizeof( vout_thread_t ) );
 110     if( p_sys->p_vout == NULL )
 111     {
 112         free( p_sys );
 113         return VLC_ENOMEM;
 114     }
 115     vlc_object_attach( p_sys->p_vout, p_this );
 116
 117     p_sys->p_vout->i_window_width = p_vout->i_window_width;
 118     p_sys->p_vout->i_window_height = p_vout->i_window_height;
 119     p_sys->p_vout->b_fullscreen = p_vout->b_fullscreen;
 120     p_sys->p_vout->render.i_width = p_vout->render.i_width;
 121     p_sys->p_vout->render.i_height = p_vout->render.i_height;
 122     p_sys->p_vout->render.i_aspect = p_vout->render.i_aspect;
 123     p_sys->p_vout->fmt_render = p_vout->fmt_render;
 124     p_sys->p_vout->fmt_in = p_vout->fmt_in;
 125     p_sys->p_vout->b_autoscale = p_vout->b_autoscale;
 126     p_sys->p_vout->i_zoom = p_vout->i_zoom;
 127     p_sys->p_vout->i_alignment = p_vout->i_alignment;
 128     var_Create( p_sys->p_vout, "video-deco",
 129                 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 130
 131     /* Forward events from the opengl provider */
 132     var_Create( p_sys->p_vout, "mouse-x", VLC_VAR_INTEGER );
 133     var_Create( p_sys->p_vout, "mouse-y", VLC_VAR_INTEGER );
 134     var_Create( p_sys->p_vout, "mouse-moved", VLC_VAR_VOID );
 135     var_Create( p_sys->p_vout, "mouse-clicked", VLC_VAR_BOOL );
 136     var_Create( p_sys->p_vout, "mouse-button-down", VLC_VAR_INTEGER );
 137     var_Create( p_sys->p_vout, "video-on-top",
 138                 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 139     var_Create( p_sys->p_vout, "autoscale",
 140                 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 141     var_Create( p_sys->p_vout, "scale",
 142                 VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 143
 144     var_AddCallback( p_sys->p_vout, "mouse-x", SendEvents, p_vout );
 145     var_AddCallback( p_sys->p_vout, "mouse-y", SendEvents, p_vout );
 146     var_AddCallback( p_sys->p_vout, "mouse-moved", SendEvents, p_vout );
 147     var_AddCallback( p_sys->p_vout, "mouse-clicked", SendEvents, p_vout );
 148     var_AddCallback( p_sys->p_vout, "mouse-button-down", SendEvents, p_vout );
 149     var_AddCallback( p_sys->p_vout, "video-on-top", SendEvents, p_vout );
 150     var_AddCallback( p_vout, "autoscale", SendEvents, p_sys->p_vout );
 151     var_AddCallback( p_vout, "scale", SendEvents, p_sys->p_vout );
 152
 153     psz = var_CreateGetString( p_vout, "opengl-provider" );
 154     p_sys->p_vout->p_module =
 155         module_need( p_sys->p_vout, "opengl provider", psz, false );
 156     free( psz );
 157     if( p_sys->p_vout->p_module == NULL )
 158     {
 159         msg_Warn( p_vout, "No OpenGL provider found" );
 160         /* no need for var_DelCallback here :-) */
 161         vlc_object_release( p_sys->p_vout );
 162         free( p_sys );
 163         return VLC_ENOOBJ;
 164     }
 165
 166     p_vout->pf_init = Init;
 167     p_vout->pf_end = End;
 168     p_vout->pf_manage = Manage;
 169     p_vout->pf_render = Render;
 170     p_vout->pf_display = DisplayVideo;
 171     p_vout->pf_control = Control;
 172
 173     return VLC_SUCCESS;
 174 }
 175
 176 static int OpenglLock(vout_opengl_t *gl)
 177 {
 178     vout_thread_t *p_vout = gl->sys;
 179
 180     if( !p_vout->pf_lock )
 181         return VLC_SUCCESS;
 182     return p_vout->pf_lock( p_vout );
 183 }
 184 static void OpenglUnlock(vout_opengl_t *gl)
 185 {
 186     vout_thread_t *p_vout = gl->sys;
 187
 188     if( p_vout->pf_unlock )
 189         p_vout->pf_unlock( p_vout );
 190 }
 191 static void OpenglSwap(vout_opengl_t *gl)
 192 {
 193     vout_thread_t *p_vout = gl->sys;
 194     p_vout->pf_swap( p_vout );
 195 }
 196
 197 /*****************************************************************************
 198  * Init: initialize the OpenGL video thread output method
 199  *****************************************************************************/
 200 static int Init( vout_thread_t *p_vout )
 201 {
 202     vout_sys_t *p_sys = p_vout->p_sys;
 203
 204     p_sys->p_vout->pf_init( p_sys->p_vout );
 205
 206     p_sys->gl.lock = OpenglLock;
 207     p_sys->gl.unlock = OpenglUnlock;
 208     p_sys->gl.swap = OpenglSwap;
 209     p_sys->gl.sys = p_sys->p_vout;
 210
 211     video_format_t fmt;
 212     video_format_Init( &fmt, 0 );
 213     video_format_Setup( &fmt,
 214                         p_vout->render.i_chroma,
 215                         p_vout->render.i_width,
 216                         p_vout->render.i_height,
 217                         p_vout->render.i_aspect * p_vout->render.i_height,
 218                         VOUT_ASPECT_FACTOR      * p_vout->render.i_width );
 219
 220
 221     if( vout_display_opengl_Init( &p_sys->vgl, &fmt, &p_sys->gl ) )
 222     {
 223         I_OUTPUTPICTURES = 0;
 224         return VLC_EGENERIC;
 225     }
 226     p_sys->p_pool = vout_display_opengl_GetPool( &p_sys->vgl );
 227     if( !p_sys->p_pool )
 228     {
 229         vout_display_opengl_Clean( &p_sys->vgl );
 230         I_OUTPUTPICTURES = 0;
 231         return VLC_EGENERIC;
 232     }
 233
 234     /* */
 235     p_vout->output.i_chroma = fmt.i_chroma;
 236     p_vout->output.i_rmask  = fmt.i_rmask;
 237     p_vout->output.i_gmask  = fmt.i_gmask;
 238     p_vout->output.i_bmask  = fmt.i_bmask;
 239
 240     /* Since OpenGL can do rescaling for us, stick to the default
 241      * coordinates and aspect. */
 242     p_vout->output.i_width  = p_vout->render.i_width;
 243     p_vout->output.i_height = p_vout->render.i_height;
 244     p_vout->output.i_aspect = p_vout->render.i_aspect;
 245
 246     p_vout->fmt_out = p_vout->fmt_in;
 247     p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
 248
 249     /* */
 250     p_sys->p_current = picture_pool_Get( p_sys->p_pool );
 251     p_vout->p_picture[0] = *p_sys->p_current;
 252     p_vout->p_picture[0].i_status = DESTROYED_PICTURE;
 253     p_vout->p_picture[0].i_type   = DIRECT_PICTURE;
 254     p_vout->p_picture[0].i_refcount = 0;
 255     p_vout->p_picture[0].p_sys = NULL;
 256     PP_OUTPUTPICTURE[0] = &p_vout->p_picture[0];
 257
 258     I_OUTPUTPICTURES = 1;
 259
 260     return VLC_SUCCESS;
 261 }
 262
 263 /*****************************************************************************
 264  * End: terminate GLX video thread output method
 265  *****************************************************************************/
 266 static void End( vout_thread_t *p_vout )
 267 {
 268     vout_sys_t *p_sys = p_vout->p_sys;
 269
 270     if( I_OUTPUTPICTURES > 0 )
 271     {
 272
 273         if( p_sys->p_current )
 274             picture_Release( p_sys->p_current );
 275         vout_display_opengl_Clean( &p_sys->vgl );
 276
 277         p_vout->p_picture[0].i_status = FREE_PICTURE;
 278         I_OUTPUTPICTURES = 0;
 279     }
 280
 281     /* We must release the opengl provider here: opengl requiere init and end
 282        to be done in the same thread */
 283     module_unneed( p_sys->p_vout, p_sys->p_vout->p_module );
 284     vlc_object_release( p_sys->p_vout );
 285 }
 286
 287 /*****************************************************************************
 288  * Destroy: destroy GLX video thread output method
 289  *****************************************************************************
 290  * Terminate an output method created by CreateVout
 291  *****************************************************************************/
 292 static void DestroyVout( vlc_object_t *p_this )
 293 {
 294     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 295     vout_sys_t *p_sys = p_vout->p_sys;
 296
 297     free( p_sys );
 298 }
 299
 300 /*****************************************************************************
 301  * Manage: handle Sys events
 302  *****************************************************************************
 303  * This function should be called regularly by video output thread. It returns
 304  * a non null value if an error occurred.
 305  *****************************************************************************/
 306 static int Manage( vout_thread_t *p_vout )
 307 {
 308     vout_sys_t *p_sys = p_vout->p_sys;
 309     int i_ret, i_fullscreen_change;
 310
 311     i_fullscreen_change = ( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE );
 312
 313     p_vout->fmt_out.i_x_offset = p_sys->p_vout->fmt_in.i_x_offset =
 314         p_vout->fmt_in.i_x_offset;
 315     p_vout->fmt_out.i_y_offset = p_sys->p_vout->fmt_in.i_y_offset =
 316         p_vout->fmt_in.i_y_offset;
 317     p_vout->fmt_out.i_visible_width = p_sys->p_vout->fmt_in.i_visible_width =
 318         p_vout->fmt_in.i_visible_width;
 319     p_vout->fmt_out.i_visible_height = p_sys->p_vout->fmt_in.i_visible_height =
 320         p_vout->fmt_in.i_visible_height;
 321     p_vout->fmt_out.i_sar_num = p_sys->p_vout->fmt_in.i_sar_num =
 322         p_vout->fmt_in.i_sar_num;
 323     p_vout->fmt_out.i_sar_den = p_sys->p_vout->fmt_in.i_sar_den =
 324         p_vout->fmt_in.i_sar_den;
 325     p_vout->output.i_aspect = (int64_t)p_vout->fmt_in.i_sar_num * p_vout->fmt_in.i_width * VOUT_ASPECT_FACTOR /
 326                               p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_height;
 327
 328     p_sys->p_vout->i_changes = p_vout->i_changes;
 329     i_ret = p_sys->p_vout->pf_manage( p_sys->p_vout );
 330     p_vout->i_changes = p_sys->p_vout->i_changes;
 331
 332 #ifdef __APPLE__
 333     /* On OS X, we create the window and the GL view when entering
 334        fullscreen - the textures have to be inited again */
 335     if( i_fullscreen_change )
 336     {
 337         /* FIXME should we release p_current ? */
 338         vout_display_opengl_ResetTextures( &p_sys->vgl );
 339     }
 340 #endif
 341
 342 // to align in real time in OPENGL
 343     if (p_sys->p_vout->i_alignment != p_vout->i_alignment)
 344     {
 345         p_vout->i_changes |= VOUT_CROP_CHANGE;        //to force change
 346         p_sys->p_vout->i_alignment = p_vout->i_alignment;
 347     }
 348
 349     /* forward signal that autoscale toggle has changed */
 350     if (p_vout->i_changes & VOUT_SCALE_CHANGE )
 351     {
 352         p_vout->i_changes &= ~VOUT_SCALE_CHANGE;
 353
 354         p_sys->p_vout->i_changes |= VOUT_SCALE_CHANGE;
 355     }
 356
 357     /* forward signal that scale has changed */
 358     if (p_vout->i_changes & VOUT_ZOOM_CHANGE )
 359     {
 360         p_vout->i_changes &= ~VOUT_ZOOM_CHANGE;
 361
 362         p_sys->p_vout->i_changes |= VOUT_ZOOM_CHANGE;
 363     }
 364
 365
 366     return i_ret;
 367 }
 368
 369 /*****************************************************************************
 370  * Render: render previously calculated output
 371  *****************************************************************************/
 372 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 373 {
 374     vout_sys_t *p_sys = p_vout->p_sys;
 375
 376     picture_t *p_next = p_sys->p_current;
 377
 378     if( VLCGL_TEXTURE_COUNT > 1 )
 379     {
 380         /* Get the next picture to display */
 381         p_next = picture_pool_Get( p_sys->p_pool );
 382         assert( p_next );
 383     }
 384
 385     if( p_sys->p_current )
 386     {
 387         assert( p_sys->p_current->p[0].p_pixels == p_pic->p[0].p_pixels );
 388
 389         /* Make sure we have the prepare after the picture_pool_Get,
 390          * because picture_pool_Get() will bind the new picture texture,
 391          * and vout_display_opengl_Prepare() bind the current rendered picture
 392          * texture.
 393          * DisplayVideo() will effectively use the last binded texture. */
 394
 395         vout_display_opengl_Prepare( &p_sys->vgl, p_sys->p_current );
 396     }
 397
 398     if( p_sys->p_current != p_next ) {
 399         if( p_sys->p_current )
 400             picture_Release( p_sys->p_current );
 401
 402         /* Swap the picture texture on opengl vout side. */
 403         p_sys->p_current = p_next;
 404
 405         /* Now, switch the only picture that is being used
 406          * to render in the backend to point to our "next"
 407          * picture texture */
 408         p_pic->p[0].p_pixels = p_sys->p_current->p[0].p_pixels;
 409     }
 410
 411     VLC_UNUSED( p_pic );
 412 }
 413
 414 /*****************************************************************************
 415  * DisplayVideo: displays previously rendered output
 416  *****************************************************************************/
 417 static void DisplayVideo( vout_thread_t *p_vout, picture_t *p_pic )
 418 {
 419     vout_sys_t *p_sys = p_vout->p_sys;
 420
 421     vout_display_opengl_Display( &p_sys->vgl, &p_vout->fmt_out );
 422     VLC_UNUSED( p_pic );
 423 }
 424
 425 /*****************************************************************************
 426  * Control: control facility for the vout
 427  *****************************************************************************/
 428 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
 429 {
 430     vout_sys_t *p_sys = p_vout->p_sys;
 431
 432     if( p_sys->p_vout->pf_control )
 433         return p_sys->p_vout->pf_control( p_sys->p_vout, i_query, args );
 434     return VLC_EGENERIC;
 435 }
 436
 437 /*****************************************************************************
 438  * SendEvents: forward mouse and keyboard events to the parent p_vout
 439  *****************************************************************************/
 440 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 441                        vlc_value_t oldval, vlc_value_t newval, void *_p_vout )
 442 {
 443     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 444     return var_Set( (vlc_object_t *)_p_vout, psz_var, newval );
 445 }
 446