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

   1 /*****************************************************************************
   2  * vmem.c: memory video driver for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Sam Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc_vout.h>
  34
  35 /*****************************************************************************
  36  * Local prototypes
  37  *****************************************************************************/
  38 static int  Create    ( vlc_object_t * );
  39 static void Destroy   ( vlc_object_t * );
  40
  41 static int  Init          ( vout_thread_t * );
  42 static void End           ( vout_thread_t * );
  43 static int  LockPicture   ( vout_thread_t *, picture_t * );
  44 static int  UnlockPicture ( vout_thread_t *, picture_t * );
  45
  46 /*****************************************************************************
  47  * Module descriptor
  48  *****************************************************************************/
  49 #define T_WIDTH N_( "Width" )
  50 #define LT_WIDTH N_( "Video memory buffer width." )
  51
  52 #define T_HEIGHT N_( "Height" )
  53 #define LT_HEIGHT N_( "Video memory buffer height." )
  54
  55 #define T_PITCH N_( "Pitch" )
  56 #define LT_PITCH N_( "Video memory buffer pitch in bytes." )
  57
  58 #define T_CHROMA N_( "Chroma" )
  59 #define LT_CHROMA N_( "Output chroma for the memory image as a 4-character " \
  60                       "string, eg. \"RV32\"." )
  61
  62 #define T_LOCK N_( "Lock function" )
  63 #define LT_LOCK N_( "Address of the locking callback function. This " \
  64                     "function must return a valid memory address for use " \
  65                     "by the video renderer." )
  66
  67 #define T_UNLOCK N_( "Unlock function" )
  68 #define LT_UNLOCK N_( "Address of the unlocking callback function" )
  69
  70 #define T_DATA N_( "Callback data" )
  71 #define LT_DATA N_( "Data for the locking and unlocking functions" )
  72
  73 vlc_module_begin( );
  74     set_description( _( "Video memory module" ) );
  75     set_shortname( _("Video memory") );
  76
  77     set_category( CAT_VIDEO );
  78     set_subcategory( SUBCAT_VIDEO_VOUT );
  79     set_capability( "video output", 0 );
  80
  81     add_integer( "vmem-width", 320, NULL, T_WIDTH, LT_WIDTH, VLC_FALSE );
  82     add_integer( "vmem-height", 200, NULL, T_HEIGHT, LT_HEIGHT, VLC_FALSE );
  83     add_integer( "vmem-pitch", 640, NULL, T_PITCH, LT_PITCH, VLC_FALSE );
  84     add_string( "vmem-chroma", "RV16", NULL, T_CHROMA, LT_CHROMA, VLC_TRUE );
  85     add_string( "vmem-lock", "0", NULL, T_LOCK, LT_LOCK, VLC_TRUE );
  86     add_string( "vmem-unlock", "0", NULL, T_UNLOCK, LT_UNLOCK, VLC_TRUE );
  87     add_string( "vmem-data", "0", NULL, T_DATA, LT_DATA, VLC_TRUE );
  88
  89     set_callbacks( Create, Destroy );
  90 vlc_module_end();
  91
  92 /*****************************************************************************
  93  * vout_sys_t: video output descriptor
  94  *****************************************************************************/
  95 struct vout_sys_t
  96 {
  97     int i_width, i_height, i_pitch;
  98
  99     void * (*pf_lock) (void *);
 100     void (*pf_unlock) (void *);
 101     void *p_data;
 102 };
 103
 104 /*****************************************************************************
 105  * Create: allocates video thread
 106  *****************************************************************************
 107  * This function allocates and initializes a vout method.
 108  *****************************************************************************/
 109 static int Create( vlc_object_t *p_this )
 110 {
 111     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 112
 113     /* Allocate instance and initialize some members */
 114     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 115     if( ! p_vout->p_sys )
 116         return VLC_ENOMEM;
 117
 118     p_vout->pf_init = Init;
 119     p_vout->pf_end = End;
 120     p_vout->pf_manage = NULL;
 121     p_vout->pf_render = NULL;
 122     p_vout->pf_display = NULL;
 123
 124     return VLC_SUCCESS;
 125 }
 126
 127 /*****************************************************************************
 128  * Init: initialize video thread
 129  *****************************************************************************/
 130 static int Init( vout_thread_t *p_vout )
 131 {
 132     int i_index;
 133     picture_t *p_pic;
 134     char *psz_chroma, *psz_tmp;
 135     int i_width, i_height, i_pitch, i_chroma;
 136
 137     i_width = config_GetInt( p_vout, "vmem-width" );
 138     i_height = config_GetInt( p_vout, "vmem-height" );
 139     i_pitch = config_GetInt( p_vout, "vmem-pitch" );
 140
 141     psz_chroma = config_GetPsz( p_vout, "vmem-chroma" );
 142     if( psz_chroma )
 143     {
 144         if( strlen( psz_chroma ) < 4 )
 145         {
 146             msg_Err( p_vout, "vmem-chroma should be 4 characters long" );
 147             return VLC_EGENERIC;
 148         }
 149         i_chroma = VLC_FOURCC( psz_chroma[0], psz_chroma[1],
 150                                psz_chroma[2], psz_chroma[3] );
 151         free( psz_chroma );
 152     }
 153     else
 154     {
 155         msg_Err( p_vout, "Cannot find chroma information." );
 156         return VLC_EGENERIC;
 157     }
 158
 159     psz_tmp = config_GetPsz( p_vout, "vmem-lock" );
 160     p_vout->p_sys->pf_lock = (void * (*) (void *))(intptr_t)atoll( psz_tmp );
 161     free( psz_tmp );
 162
 163     psz_tmp = config_GetPsz( p_vout, "vmem-unlock" );
 164     p_vout->p_sys->pf_unlock = (void (*) (void *))(intptr_t)atoll( psz_tmp );
 165     free( psz_tmp );
 166
 167     psz_tmp = config_GetPsz( p_vout, "vmem-data" );
 168     p_vout->p_sys->p_data = (void *)(intptr_t)atoll( psz_tmp );
 169     free( psz_tmp );
 170
 171     if( !p_vout->p_sys->pf_lock || !p_vout->p_sys->pf_unlock )
 172     {
 173         msg_Err( p_vout, "Invalid lock or unlock callbacks" );
 174         return VLC_EGENERIC;
 175     }
 176
 177     I_OUTPUTPICTURES = 0;
 178
 179     /* Initialize the output structure */
 180     p_vout->output.i_chroma = i_chroma;
 181     p_vout->output.pf_setpalette = NULL;
 182     p_vout->output.i_width = i_width;
 183     p_vout->output.i_height = i_height;
 184     p_vout->output.i_aspect = p_vout->output.i_width
 185                                * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
 186
 187     /* Define the bitmasks */
 188     switch( i_chroma )
 189     {
 190       case VLC_FOURCC( 'R','V','1','5' ):
 191         p_vout->output.i_rmask = 0x001f;
 192         p_vout->output.i_gmask = 0x03e0;
 193         p_vout->output.i_bmask = 0x7c00;
 194         break;
 195
 196       case VLC_FOURCC( 'R','V','1','6' ):
 197         p_vout->output.i_rmask = 0x001f;
 198         p_vout->output.i_gmask = 0x07e0;
 199         p_vout->output.i_bmask = 0xf800;
 200         break;
 201
 202       case VLC_FOURCC( 'R','V','2','4' ):
 203         p_vout->output.i_rmask = 0xff0000;
 204         p_vout->output.i_gmask = 0x00ff00;
 205         p_vout->output.i_bmask = 0x0000ff;
 206         break;
 207
 208       case VLC_FOURCC( 'R','V','3','2' ):
 209         p_vout->output.i_rmask = 0xff0000;
 210         p_vout->output.i_gmask = 0x00ff00;
 211         p_vout->output.i_bmask = 0x0000ff;
 212         break;
 213     }
 214
 215     /* Try to initialize 1 direct buffer */
 216     p_pic = NULL;
 217
 218     /* Find an empty picture slot */
 219     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 220     {
 221         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 222         {
 223             p_pic = p_vout->p_picture + i_index;
 224             break;
 225         }
 226     }
 227
 228     /* Allocate the picture */
 229     if( p_pic == NULL )
 230     {
 231         return VLC_SUCCESS;
 232     }
 233
 234     vout_InitPicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
 235                       p_vout->output.i_width, p_vout->output.i_height,
 236                       p_vout->output.i_aspect );
 237
 238     p_pic->p->i_pitch = i_pitch;
 239
 240     p_pic->pf_lock = LockPicture;
 241     p_pic->pf_unlock = UnlockPicture;
 242
 243     p_pic->i_status = DESTROYED_PICTURE;
 244     p_pic->i_type   = DIRECT_PICTURE;
 245
 246     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 247
 248     I_OUTPUTPICTURES++;
 249
 250     return VLC_SUCCESS;
 251 }
 252
 253 /*****************************************************************************
 254  * End: terminate video thread output method
 255  *****************************************************************************/
 256 static void End( vout_thread_t *p_vout )
 257 {
 258     (void)p_vout;
 259 }
 260
 261 /*****************************************************************************
 262  * Destroy: destroy video thread
 263  *****************************************************************************
 264  * Terminate an output method created by Create
 265  *****************************************************************************/
 266 static void Destroy( vlc_object_t *p_this )
 267 {
 268     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 269
 270     /* Destroy structure */
 271     free( p_vout->p_sys );
 272 }
 273
 274 /*****************************************************************************
 275  * LockPicture: lock a picture
 276  *****************************************************************************
 277  * This function locks the picture and prepares it for direct pixel access.
 278  *****************************************************************************/
 279 static int LockPicture( vout_thread_t *p_vout, picture_t *p_pic )
 280 {
 281     p_pic->p->p_pixels = p_vout->p_sys->pf_lock( p_vout->p_sys->p_data );
 282
 283     return VLC_SUCCESS;
 284 }
 285
 286 /*****************************************************************************
 287  * UnlockPicture: unlock a picture
 288  *****************************************************************************
 289  * This function unlocks a previously locked picture.
 290  *****************************************************************************/
 291 static int UnlockPicture( vout_thread_t *p_vout, picture_t *p_pic )
 292 {
 293     p_vout->p_sys->pf_unlock( p_vout->p_sys->p_data );
 294
 295     (void)p_pic;
 296
 297     return VLC_SUCCESS;
 298 }
 299