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

   1 /*****************************************************************************
   2  * snapshot.c : snapshot plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2002 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Olivier Aubert <oaubert@lisi.univ-lyon1.fr>
   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  * This module is a pseudo video output that offers the possibility to
  26  * keep a cache of low-res snapshots.
  27  * The snapshot structure is defined in include/snapshot.h
  28  * In order to access the current snapshot cache, object variables are used:
  29  *   snapshot-list-pointer : the pointer on the first element in the list
  30  *   snapshot-datasize     : size of a snapshot
  31  *                           (also available in snapshot_t->i_datasize)
  32  *   snapshot-cache-size   : size of the cache list
  33  *
  34  * It is used for the moment by the CORBA module and a specialized
  35  * python-vlc binding.
  36  *****************************************************************************/
  37
  38 /*****************************************************************************
  39  * Preamble
  40  *****************************************************************************/
  41
  42 #ifdef HAVE_CONFIG_H
  43 # include "config.h"
  44 #endif
  45
  46 #include <vlc_common.h>
  47 #include <vlc_plugin.h>
  48 #include <vlc_vout.h>
  49 #include <vlc_interface.h>
  50 #include <vlc_input.h>
  51
  52 /*****************************************************************************
  53  * Local prototypes
  54  *****************************************************************************/
  55 static int  Create    ( vlc_object_t * );
  56 static void Destroy   ( vlc_object_t * );
  57
  58 static int  Init      ( vout_thread_t * );
  59 static void End       ( vout_thread_t * );
  60 static void Display   ( vout_thread_t *, picture_t * );
  61
  62 /*****************************************************************************
  63  * Module descriptor
  64  *****************************************************************************/
  65 #define WIDTH_TEXT N_( "Snapshot width" )
  66 #define WIDTH_LONGTEXT N_( "Width of the snapshot image." )
  67
  68 #define HEIGHT_TEXT N_( "Snapshot height" )
  69 #define HEIGHT_LONGTEXT N_( "Height of the snapshot image." )
  70
  71 #define CHROMA_TEXT N_( "Chroma" )
  72 #define CHROMA_LONGTEXT N_( "Output chroma for the snapshot image " \
  73                             "(a 4 character string, like \"RV32\")." )
  74
  75 #define CACHE_TEXT N_( "Cache size (number of images)" )
  76 #define CACHE_LONGTEXT N_( "Snapshot cache size (number of images to keep)." )
  77
  78
  79 vlc_module_begin ()
  80     set_description( N_( "Snapshot output" ) )
  81     set_shortname( N_("Snapshot") )
  82
  83     set_category( CAT_VIDEO )
  84     set_subcategory( SUBCAT_VIDEO_VOUT )
  85     set_capability( "video output", 1 )
  86
  87     add_integer( "snapshot-width", 320, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, false )
  88     add_integer( "snapshot-height", 200, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, false )
  89     add_string( "snapshot-chroma", "RV32", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true )
  90     add_integer( "snapshot-cache-size", 50, NULL, CACHE_TEXT, CACHE_LONGTEXT, true )
  91
  92     set_callbacks( Create, Destroy )
  93 vlc_module_end ()
  94
  95 /*****************************************************************************
  96  * vout_sys_t: video output descriptor
  97  *****************************************************************************/
  98 typedef struct snapshot_t
  99 {
 100   uint8_t *p_data;   /* Data area */
 101
 102   int i_width;       /* In pixels */
 103   int i_height;      /* In pixels */
 104   int i_datasize;    /* In bytes */
 105   mtime_t date;      /* Presentation time */
 106 } snapshot_t;
 107
 108 struct vout_sys_t
 109 {
 110     snapshot_t **p_list;    /* List of available snapshots */
 111     int i_index;            /* Index of the next available list member */
 112     int i_size;             /* Size of the cache */
 113     int i_datasize;         /* Size of an image */
 114     input_thread_t *p_input;             /* The input thread */
 115 };
 116
 117 /*****************************************************************************
 118  * Create: allocates video thread
 119  *****************************************************************************
 120  * This function allocates and initializes a vout method.
 121  *****************************************************************************/
 122 static int Create( vlc_object_t *p_this )
 123 {
 124     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 125
 126     /* Allocate instance and initialize some members */
 127     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 128     if( ! p_vout->p_sys )
 129         return VLC_ENOMEM;
 130
 131     var_Create( p_vout, "snapshot-width", VLC_VAR_INTEGER );
 132     var_Create( p_vout, "snapshot-height", VLC_VAR_INTEGER );
 133     var_Create( p_vout, "snapshot-datasize", VLC_VAR_INTEGER );
 134     var_Create( p_vout, "snapshot-cache-size", VLC_VAR_INTEGER );
 135     var_Create( p_vout, "snapshot-list-pointer", VLC_VAR_ADDRESS );
 136
 137     p_vout->pf_init = Init;
 138     p_vout->pf_end = End;
 139     p_vout->pf_manage = NULL;
 140     p_vout->pf_render = NULL;
 141     p_vout->pf_display = Display;
 142
 143     return VLC_SUCCESS;
 144 }
 145
 146 /*****************************************************************************
 147  * Init: initialize video thread
 148  *****************************************************************************/
 149 static int Init( vout_thread_t *p_vout )
 150 {
 151     int i_index;
 152     picture_t *p_pic;
 153     vlc_value_t val;
 154     char* psz_chroma;
 155     vlc_fourcc_t i_chroma;
 156     int i_width;
 157     int i_height;
 158     int i_datasize;
 159
 160     i_width  = config_GetInt( p_vout, "snapshot-width" );
 161     i_height = config_GetInt( p_vout, "snapshot-height" );
 162
 163     psz_chroma = config_GetPsz( p_vout, "snapshot-chroma" );
 164     if( !psz_chroma )
 165     {
 166         msg_Err( p_vout, "Cannot find chroma information." );
 167         return VLC_EGENERIC;
 168     }
 169
 170     i_chroma = vlc_fourcc_GetCodecFromString( VIDEO_ES, psz_chroma );
 171     free( psz_chroma );
 172
 173     if( !i_chroma )
 174     {
 175         msg_Err( p_vout, "snapshot-chroma should be 4 characters long" );
 176         return VLC_EGENERIC;
 177     }
 178
 179     I_OUTPUTPICTURES = 0;
 180
 181     /* Initialize the output structure */
 182     p_vout->output.i_chroma = i_chroma;
 183     p_vout->output.pf_setpalette = NULL;
 184     p_vout->output.i_width = i_width;
 185     p_vout->output.i_height = i_height;
 186     p_vout->output.i_aspect = p_vout->output.i_width
 187                                * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
 188
 189
 190     /* Define the bitmasks */
 191     switch( i_chroma )
 192     {
 193       case VLC_CODEC_RGB15:
 194         p_vout->output.i_rmask = 0x001f;
 195         p_vout->output.i_gmask = 0x03e0;
 196         p_vout->output.i_bmask = 0x7c00;
 197         break;
 198
 199       case VLC_CODEC_RGB16:
 200         p_vout->output.i_rmask = 0x001f;
 201         p_vout->output.i_gmask = 0x07e0;
 202         p_vout->output.i_bmask = 0xf800;
 203         break;
 204
 205       case VLC_CODEC_RGB24:
 206         p_vout->output.i_rmask = 0xff0000;
 207         p_vout->output.i_gmask = 0x00ff00;
 208         p_vout->output.i_bmask = 0x0000ff;
 209         break;
 210
 211       case VLC_CODEC_RGB32:
 212         p_vout->output.i_rmask = 0xff0000;
 213         p_vout->output.i_gmask = 0x00ff00;
 214         p_vout->output.i_bmask = 0x0000ff;
 215         break;
 216     }
 217
 218     /* Try to initialize 1 direct buffer */
 219     p_pic = NULL;
 220
 221     /* Find an empty picture slot */
 222     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 223     {
 224         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 225         {
 226             p_pic = p_vout->p_picture + i_index;
 227             break;
 228         }
 229     }
 230
 231     /* Allocate the picture */
 232     if( p_pic == NULL )
 233     {
 234         return VLC_SUCCESS;
 235     }
 236
 237     vout_AllocatePicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
 238                           p_vout->output.i_width, p_vout->output.i_height,
 239                           p_vout->output.i_aspect );
 240
 241     if( p_pic->i_planes == 0 )
 242     {
 243         return VLC_EGENERIC;
 244     }
 245
 246     p_pic->i_status = DESTROYED_PICTURE;
 247     p_pic->i_type   = DIRECT_PICTURE;
 248
 249     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 250
 251     I_OUTPUTPICTURES++;
 252
 253
 254     /* Get datasize and set variables */
 255     i_datasize = i_width * i_height * p_pic->p->i_pixel_pitch;
 256
 257     p_vout->p_sys->i_datasize = i_datasize;
 258     p_vout->p_sys->i_index = 0;
 259     p_vout->p_sys->i_size = config_GetInt( p_vout, "snapshot-cache-size" );
 260
 261     if( p_vout->p_sys->i_size < 2 )
 262     {
 263         msg_Err( p_vout, "snapshot-cache-size must be at least 1." );
 264         return VLC_EGENERIC;
 265     }
 266
 267     p_vout->p_sys->p_list = malloc( p_vout->p_sys->i_size * sizeof( snapshot_t * ) );
 268
 269     if( p_vout->p_sys->p_list == NULL )
 270         return VLC_ENOMEM;
 271
 272     /* Initialize the structures for the circular buffer */
 273     for( i_index = 0; i_index < p_vout->p_sys->i_size; i_index++ )
 274     {
 275         snapshot_t *p_snapshot = malloc( sizeof( snapshot_t ) );
 276
 277         if( p_snapshot == NULL )
 278             return VLC_ENOMEM;
 279
 280         p_snapshot->i_width = i_width;
 281         p_snapshot->i_height = i_height;
 282         p_snapshot->i_datasize = i_datasize;
 283         p_snapshot->date = 0;
 284         p_snapshot->p_data = malloc( i_datasize );
 285         if( p_snapshot->p_data == NULL )
 286         {
 287             free( p_snapshot );
 288             return VLC_ENOMEM;
 289         }
 290         p_vout->p_sys->p_list[i_index] = p_snapshot;
 291     }
 292
 293     val.i_int = i_width;
 294     var_Set( p_vout, "snapshot-width", val );
 295     val.i_int = i_height;
 296     var_Set( p_vout, "snapshot-height", val );
 297     val.i_int = i_datasize;
 298     var_Set( p_vout, "snapshot-datasize", val );
 299
 300     val.i_int = p_vout->p_sys->i_size;
 301     var_Set( p_vout, "snapshot-cache-size", val );
 302
 303     val.p_address = p_vout->p_sys->p_list;
 304     var_Set( p_vout, "snapshot-list-pointer", val );
 305
 306     /* Get the p_input pointer (to access video times) */
 307     p_vout->p_sys->p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
 308                                               FIND_PARENT );
 309
 310     if( !p_vout->p_sys->p_input )
 311         return VLC_ENOOBJ;
 312
 313     if( var_Create( p_vout->p_sys->p_input, "snapshot-id", VLC_VAR_INTEGER ) )
 314     {
 315         msg_Err( p_vout, "Cannot create snapshot-id variable in p_input(%p).",
 316                  p_vout->p_sys->p_input );
 317         return VLC_EGENERIC;
 318     }
 319
 320     /* Register the snapshot vout module at the input level */
 321     val.p_address = p_vout;
 322
 323     if( var_Set( p_vout->p_sys->p_input, "snapshot-id", val ) )
 324     {
 325         msg_Err( p_vout, "Cannot register snapshot-id in p_input(%p).",
 326                  p_vout->p_sys->p_input );
 327         return VLC_EGENERIC;
 328     }
 329
 330     return VLC_SUCCESS;
 331 }
 332
 333 /*****************************************************************************
 334  * End: terminate video thread output method
 335  *****************************************************************************/
 336 static void End( vout_thread_t *p_vout )
 337 {
 338     (void)p_vout;
 339 }
 340
 341 /*****************************************************************************
 342  * Destroy: destroy video thread
 343  *****************************************************************************
 344  * Terminate an output method created by Create
 345  *****************************************************************************/
 346 static void Destroy( vlc_object_t *p_this )
 347 {
 348     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 349     int i_index;
 350
 351     var_Destroy( p_vout->p_sys->p_input, "snapshot-id" );
 352
 353     vlc_object_release( p_vout->p_sys->p_input );
 354     var_Destroy( p_this, "snapshot-width" );
 355     var_Destroy( p_this, "snapshot-height" );
 356     var_Destroy( p_this, "snapshot-datasize" );
 357
 358     for( i_index = 0 ; i_index < p_vout->p_sys->i_size ; i_index++ )
 359     {
 360         free( p_vout->p_sys->p_list[ i_index ]->p_data );
 361     }
 362     free( p_vout->p_sys->p_list );
 363     /* Destroy structure */
 364     free( p_vout->p_sys );
 365 }
 366
 367 /* Return the position in ms from the start of the movie */
 368 static mtime_t snapshot_GetMovietime( vout_thread_t *p_vout )
 369 {
 370     input_thread_t *p_input = p_vout->p_sys->p_input;
 371     if( !p_input )
 372         return 0;
 373
 374     return var_GetTime( p_input, "time" ) / 1000;
 375 }
 376
 377 /*****************************************************************************
 378  * Display: displays previously rendered output
 379  *****************************************************************************
 380  * This function copies the rendered picture into our circular buffer.
 381  *****************************************************************************/
 382 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 383 {
 384     int i_index;
 385     mtime_t i_date;
 386
 387     i_index = p_vout->p_sys->i_index;
 388
 389     vlc_memcpy( p_vout->p_sys->p_list[i_index]->p_data, p_pic->p->p_pixels,
 390                 p_vout->p_sys->i_datasize );
 391
 392     i_date = snapshot_GetMovietime( p_vout );
 393
 394     p_vout->p_sys->p_list[i_index]->date = i_date;
 395
 396     i_index++;
 397
 398     if( i_index >= p_vout->p_sys->i_size )
 399     {
 400         i_index = 0;
 401     }
 402
 403     p_vout->p_sys->i_index = i_index;
 404 }
 405