1 /*****************************************************************************
2 * snapshot.c : snapshot plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2002 the VideoLAN team
7 * Authors: Olivier Aubert <oaubert@lisi.univ-lyon1.fr>
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.
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.
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 *****************************************************************************/
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
34 * It is used for the moment by the CORBA module and a specialized
36 *****************************************************************************/
38 /*****************************************************************************
40 *****************************************************************************/
48 #include <vlc_interface.h>
49 #include <vlc_input.h>
51 /*****************************************************************************
53 *****************************************************************************/
54 static int Create ( vlc_object_t * );
55 static void Destroy ( vlc_object_t * );
57 static int Init ( vout_thread_t * );
58 static void Display ( vout_thread_t *, picture_t * );
60 /*****************************************************************************
62 *****************************************************************************/
63 #define WIDTH_TEXT N_( "Snapshot width" )
64 #define WIDTH_LONGTEXT N_( "Width of the snapshot image." )
66 #define HEIGHT_TEXT N_( "Snapshot height" )
67 #define HEIGHT_LONGTEXT N_( "Height of the snapshot image." )
69 #define CHROMA_TEXT N_( "Chroma" )
70 #define CHROMA_LONGTEXT N_( "Output chroma for the snapshot image " \
71 "(a 4 character string, like \"RV32\")." )
73 #define CACHE_TEXT N_( "Cache size (number of images)" )
74 #define CACHE_LONGTEXT N_( "Snapshot cache size (number of images to keep)." )
78 set_description( _( "Snapshot module" ) );
79 set_shortname( _("Snapshot") );
81 set_category( CAT_VIDEO );
82 set_subcategory( SUBCAT_VIDEO_VOUT );
83 set_capability( "video output", 1 );
85 add_integer( "snapshot-width", 320, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_FALSE );
86 add_integer( "snapshot-height", 200, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_FALSE );
87 add_string( "snapshot-chroma", "RV32", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, VLC_TRUE );
88 add_integer( "snapshot-cache-size", 50, NULL, CACHE_TEXT, CACHE_LONGTEXT, VLC_TRUE );
90 set_callbacks( Create, Destroy );
93 /*****************************************************************************
94 * vout_sys_t: video output descriptor
95 *****************************************************************************/
98 snapshot_t **p_list; /* List of available snapshots */
99 int i_index; /* Index of the next available list member */
100 int i_size; /* Size of the cache */
101 int i_datasize; /* Size of an image */
102 input_thread_t *p_input; /* The input thread */
105 /*****************************************************************************
106 * Create: allocates video thread
107 *****************************************************************************
108 * This function allocates and initializes a vout method.
109 *****************************************************************************/
110 static int Create( vlc_object_t *p_this )
112 vout_thread_t *p_vout = ( vout_thread_t * )p_this;
114 /* Allocate instance and initialize some members */
115 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
116 if( ! p_vout->p_sys )
119 var_Create( p_vout, "snapshot-width", VLC_VAR_INTEGER );
120 var_Create( p_vout, "snapshot-height", VLC_VAR_INTEGER );
121 var_Create( p_vout, "snapshot-datasize", VLC_VAR_INTEGER );
122 var_Create( p_vout, "snapshot-cache-size", VLC_VAR_INTEGER );
123 var_Create( p_vout, "snapshot-list-pointer", VLC_VAR_ADDRESS );
125 p_vout->pf_init = Init;
126 p_vout->pf_end = NULL;
127 p_vout->pf_manage = NULL;
128 p_vout->pf_render = NULL;
129 p_vout->pf_display = Display;
134 /*****************************************************************************
135 * Init: initialize video thread
136 *****************************************************************************/
137 static int Init( vout_thread_t *p_vout )
148 i_width = config_GetInt( p_vout, "snapshot-width" );
149 i_height = config_GetInt( p_vout, "snapshot-height" );
151 psz_chroma = config_GetPsz( p_vout, "snapshot-chroma" );
154 if( strlen( psz_chroma ) < 4 )
156 msg_Err( p_vout, "snapshot-chroma should be 4 characters long" );
159 i_chroma = VLC_FOURCC( psz_chroma[0], psz_chroma[1],
160 psz_chroma[2], psz_chroma[3] );
165 msg_Err( p_vout, "Cannot find chroma information." );
169 I_OUTPUTPICTURES = 0;
171 /* Initialize the output structure */
172 p_vout->output.i_chroma = i_chroma;
173 p_vout->output.pf_setpalette = NULL;
174 p_vout->output.i_width = i_width;
175 p_vout->output.i_height = i_height;
176 p_vout->output.i_aspect = p_vout->output.i_width
177 * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
180 /* Define the bitmasks */
183 case VLC_FOURCC( 'R','V','1','5' ):
184 p_vout->output.i_rmask = 0x001f;
185 p_vout->output.i_gmask = 0x03e0;
186 p_vout->output.i_bmask = 0x7c00;
189 case VLC_FOURCC( 'R','V','1','6' ):
190 p_vout->output.i_rmask = 0x001f;
191 p_vout->output.i_gmask = 0x07e0;
192 p_vout->output.i_bmask = 0xf800;
195 case VLC_FOURCC( 'R','V','2','4' ):
196 p_vout->output.i_rmask = 0xff0000;
197 p_vout->output.i_gmask = 0x00ff00;
198 p_vout->output.i_bmask = 0x0000ff;
201 case VLC_FOURCC( 'R','V','3','2' ):
202 p_vout->output.i_rmask = 0xff0000;
203 p_vout->output.i_gmask = 0x00ff00;
204 p_vout->output.i_bmask = 0x0000ff;
208 /* Try to initialize 1 direct buffer */
211 /* Find an empty picture slot */
212 for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
214 if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
216 p_pic = p_vout->p_picture + i_index;
221 /* Allocate the picture */
227 vout_AllocatePicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
228 p_vout->output.i_width, p_vout->output.i_height,
229 p_vout->output.i_aspect );
231 if( p_pic->i_planes == 0 )
236 p_pic->i_status = DESTROYED_PICTURE;
237 p_pic->i_type = DIRECT_PICTURE;
239 PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
244 /* Get datasize and set variables */
245 i_datasize = i_width * i_height * p_pic->p->i_pixel_pitch;
247 p_vout->p_sys->i_datasize = i_datasize;
248 p_vout->p_sys->i_index = 0;
249 p_vout->p_sys->i_size = config_GetInt( p_vout, "snapshot-cache-size" );
251 if( p_vout->p_sys->i_size < 2 )
253 msg_Err( p_vout, "snapshot-cache-size must be at least 1." );
257 p_vout->p_sys->p_list = malloc( p_vout->p_sys->i_size * sizeof( snapshot_t * ) );
259 if( p_vout->p_sys->p_list == NULL )
262 /* Initialize the structures for the circular buffer */
263 for( i_index = 0; i_index < p_vout->p_sys->i_size; i_index++ )
265 snapshot_t *p_snapshot = malloc( sizeof( snapshot_t ) );
267 if( p_snapshot == NULL )
270 p_snapshot->i_width = i_width;
271 p_snapshot->i_height = i_height;
272 p_snapshot->i_datasize = i_datasize;
273 p_snapshot->date = 0;
274 p_snapshot->p_data = ( char* ) malloc( i_datasize );
275 if( p_snapshot->p_data == NULL )
277 p_vout->p_sys->p_list[i_index] = p_snapshot;
281 var_Set( p_vout, "snapshot-width", val );
282 val.i_int = i_height;
283 var_Set( p_vout, "snapshot-height", val );
284 val.i_int = i_datasize;
285 var_Set( p_vout, "snapshot-datasize", val );
287 val.i_int = p_vout->p_sys->i_size;
288 var_Set( p_vout, "snapshot-cache-size", val );
290 val.p_address = p_vout->p_sys->p_list;
291 var_Set( p_vout, "snapshot-list-pointer", val );
293 /* Get the p_input pointer (to access video times) */
294 p_vout->p_sys->p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
297 if( !p_vout->p_sys->p_input )
300 if( var_Create( p_vout->p_sys->p_input, "snapshot-id", VLC_VAR_INTEGER ) )
302 msg_Err( p_vout, "Cannot create snapshot-id variable in p_input (%d).",
303 p_vout->p_sys->p_input->i_object_id );
307 /* Register the snapshot vout module at the input level */
308 val.i_int = p_vout->i_object_id;
310 if( var_Set( p_vout->p_sys->p_input, "snapshot-id", val ) )
312 msg_Err( p_vout, "Cannot register snapshot-id in p_input (%d).",
313 p_vout->p_sys->p_input->i_object_id );
320 /*****************************************************************************
321 * Destroy: destroy video thread
322 *****************************************************************************
323 * Terminate an output method created by Create
324 *****************************************************************************/
325 static void Destroy( vlc_object_t *p_this )
327 vout_thread_t *p_vout = ( vout_thread_t * )p_this;
330 var_Destroy( p_vout->p_sys->p_input, "snapshot-id" );
332 vlc_object_release( p_vout->p_sys->p_input );
333 var_Destroy( p_this, "snapshot-width" );
334 var_Destroy( p_this, "snapshot-height" );
335 var_Destroy( p_this, "snapshot-datasize" );
337 for( i_index = 0 ; i_index < p_vout->p_sys->i_size ; i_index++ )
339 free( p_vout->p_sys->p_list[ i_index ]->p_data );
341 free( p_vout->p_sys->p_list );
342 /* Destroy structure */
343 free( p_vout->p_sys );
346 /* Return the position in ms from the start of the movie */
347 static mtime_t snapshot_GetMovietime( vout_thread_t *p_vout )
349 input_thread_t* p_input;
353 p_input = p_vout->p_sys->p_input;
357 var_Get( p_input, "time", &val );
359 i_result = val.i_time - p_input->i_pts_delay;
361 return( i_result / 1000 );
364 /*****************************************************************************
365 * Display: displays previously rendered output
366 *****************************************************************************
367 * This function copies the rendered picture into our circular buffer.
368 *****************************************************************************/
369 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
374 i_index = p_vout->p_sys->i_index;
376 p_vout->p_libvlc->pf_memcpy( p_vout->p_sys->p_list[i_index]->p_data,
378 p_vout->p_sys->i_datasize );
380 i_date = snapshot_GetMovietime( p_vout );
382 p_vout->p_sys->p_list[i_index]->date = i_date;
386 if( i_index >= p_vout->p_sys->i_size )
391 p_vout->p_sys->i_index = i_index;