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

   1 /*****************************************************************************
   2  * image.c : image video output
   3  *****************************************************************************
   4  * Copyright (C) 2004-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.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 #include <stdlib.h>
  28
  29 #include <vlc/vlc.h>
  30 #include <vlc/vout.h>
  31 #include <vlc/intf.h>
  32
  33 #include "vlc_image.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 *p_vout );
  43 static void Display   ( vout_thread_t *, picture_t * );
  44
  45 /*****************************************************************************
  46  * Module descriptor
  47  *****************************************************************************/
  48 #define FORMAT_TEXT N_( "Image format" )
  49 #define FORMAT_LONGTEXT N_( "Format of the output images (png or jpg)." )
  50
  51 #define WIDTH_TEXT N_( "Image width" )
  52 #define WIDTH_LONGTEXT N_( "You can enforce the image width. By default " \
  53                             "(-1) VLC will adapt to the video " \
  54                             "characteristics.")
  55
  56 #define HEIGHT_TEXT N_( "Image height" )
  57 #define HEIGHT_LONGTEXT N_( "You can enforce the image height. By default " \
  58                             "(-1) VLC will adapt to the video " \
  59                             "characteristics.")
  60
  61 #define RATIO_TEXT N_( "Recording ratio" )
  62 #define RATIO_LONGTEXT N_( "Ratio of images to record. "\
  63                            "3 means that one image out of three is recorded." )
  64
  65 #define PREFIX_TEXT N_( "Filename prefix" )
  66 #define PREFIX_LONGTEXT N_( "Prefix of the output images filenames. Output " \
  67                             "filenames will have the \"prefixNUMBER.format\" "\
  68                             "form." )
  69
  70 #define REPLACE_TEXT N_( "Always write to the same file" )
  71 #define REPLACE_LONGTEXT N_( "Always write to the same file instead of " \
  72                             "creating one file per image. In this case, " \
  73                              "the number is not appended to the filename." )
  74
  75 static char *psz_format_list[] = { "png", "jpeg" };
  76 static char *psz_format_list_text[] = { "PNG", "JPEG" };
  77
  78 vlc_module_begin( );
  79     set_shortname( _( "Image file" ) );
  80     set_description( _( "Image video output" ) );
  81     set_category( CAT_VIDEO );
  82     set_subcategory( SUBCAT_VIDEO_VOUT );
  83     set_capability( "video output", 0 );
  84
  85     add_string( "image-out-format", "png", NULL,  FORMAT_TEXT, FORMAT_LONGTEXT,
  86                                                   VLC_FALSE );
  87     change_string_list( psz_format_list, psz_format_list_text, 0 );
  88     add_integer( "image-width", -1, NULL,  WIDTH_TEXT, WIDTH_LONGTEXT,
  89                                                   VLC_TRUE );
  90     add_integer( "image-height", -1, NULL,  HEIGHT_TEXT, HEIGHT_LONGTEXT,
  91                                                   VLC_TRUE );
  92     add_integer( "image-out-ratio", 3, NULL, RATIO_TEXT, RATIO_LONGTEXT,
  93                                                   VLC_FALSE );
  94     add_string( "image-out-prefix", "img", NULL, PREFIX_TEXT, PREFIX_LONGTEXT,
  95                                                   VLC_FALSE );
  96     add_bool( "image-out-replace", 0, NULL, REPLACE_TEXT, REPLACE_LONGTEXT,
  97                                                   VLC_FALSE );
  98     set_callbacks( Create, Destroy );
  99 vlc_module_end();
 100
 101 /*****************************************************************************
 102  * vout_sys_t: video output descriptor
 103  *****************************************************************************/
 104 struct vout_sys_t
 105 {
 106     char        *psz_prefix;          /* Prefix */
 107     char        *psz_format;          /* Format */
 108     int         i_ratio;         /* Image ratio */
 109
 110     int         i_width;         /* Image width */
 111     int         i_height;       /* Image height */
 112
 113     int         i_current;     /* Current image */
 114     int         i_frames;   /* Number of frames */
 115
 116     vlc_bool_t  b_replace;
 117
 118     image_handler_t *p_image;
 119 };
 120
 121 /*****************************************************************************
 122  * Create: allocates video thread
 123  *****************************************************************************
 124  * This function allocates and initializes a vout method.
 125  *****************************************************************************/
 126 static int Create( vlc_object_t *p_this )
 127 {
 128     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 129
 130     /* Allocate instance and initialize some members */
 131     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 132     if( ! p_vout->p_sys )
 133         return VLC_ENOMEM;
 134
 135     p_vout->p_sys->psz_prefix =
 136             var_CreateGetString( p_this, "image-out-prefix" );
 137     p_vout->p_sys->psz_format =
 138             var_CreateGetString( p_this, "image-out-format" );
 139     p_vout->p_sys->i_width =
 140             var_CreateGetInteger( p_this, "image-width" );
 141     p_vout->p_sys->i_height =
 142             var_CreateGetInteger( p_this, "image-height" );
 143     p_vout->p_sys->i_ratio =
 144             var_CreateGetInteger( p_this, "image-out-ratio" );
 145     p_vout->p_sys->b_replace =
 146             var_CreateGetBool( p_this, "image-out-replace" );
 147     p_vout->p_sys->i_current = 0;
 148     p_vout->p_sys->p_image = image_HandlerCreate( p_vout );
 149
 150     if( !p_vout->p_sys->p_image )
 151     {
 152         msg_Err( p_this, "unable to create image handler") ;
 153         FREENULL( p_vout->p_sys->psz_prefix );
 154         FREENULL( p_vout->p_sys );
 155         return VLC_EGENERIC;
 156     }
 157
 158     p_vout->pf_init = Init;
 159     p_vout->pf_end = End;
 160     p_vout->pf_manage = NULL;
 161     p_vout->pf_render = Display;
 162     p_vout->pf_display = NULL;
 163
 164     return VLC_SUCCESS;
 165 }
 166
 167 /*****************************************************************************
 168  * Init: initialize video thread
 169  *****************************************************************************/
 170 static int Init( vout_thread_t *p_vout )
 171 {
 172     int i_index;
 173     picture_t *p_pic;
 174
 175     /* Initialize the output structure */
 176     p_vout->output.i_chroma = p_vout->render.i_chroma;
 177     p_vout->output.pf_setpalette = NULL;
 178     p_vout->output.i_width = p_vout->render.i_width;
 179     p_vout->output.i_height = p_vout->render.i_height;
 180     p_vout->output.i_aspect = p_vout->output.i_width
 181                                * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
 182
 183     p_vout->output.i_rmask = 0xff0000;
 184     p_vout->output.i_gmask = 0x00ff00;
 185     p_vout->output.i_bmask = 0x0000ff;
 186
 187     /* Try to initialize 1 direct buffer */
 188     p_pic = NULL;
 189
 190     /* Find an empty picture slot */
 191     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 192     {
 193         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 194         {
 195             p_pic = p_vout->p_picture + i_index;
 196             break;
 197         }
 198     }
 199
 200     /* Allocate the picture */
 201     if( p_pic == NULL )
 202     {
 203         return VLC_EGENERIC;
 204     }
 205
 206     vout_AllocatePicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
 207                           p_vout->output.i_width, p_vout->output.i_height,
 208                           p_vout->output.i_aspect );
 209
 210     if( p_pic->i_planes == 0 )
 211     {
 212         return VLC_EGENERIC;
 213     }
 214
 215     p_pic->i_status = DESTROYED_PICTURE;
 216     p_pic->i_type   = DIRECT_PICTURE;
 217
 218     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 219     I_OUTPUTPICTURES++;
 220     return VLC_SUCCESS;
 221 }
 222
 223 /*****************************************************************************
 224  * Destroy: destroy video thread
 225  *****************************************************************************
 226  * Terminate an output method created by Create
 227  *****************************************************************************/
 228 static void Destroy( vlc_object_t *p_this )
 229 {
 230     int i_index;
 231     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 232
 233     for( i_index = I_OUTPUTPICTURES-1; i_index >= 0; i_index-- )
 234     {
 235         free( PP_OUTPUTPICTURE[ i_index ]->p_data );
 236     }
 237
 238     /* Destroy structure */
 239     image_HandlerDelete( p_vout->p_sys->p_image );
 240     FREENULL( p_vout->p_sys->psz_prefix );
 241     FREENULL( p_vout->p_sys->psz_format );
 242     FREENULL( p_vout->p_sys );
 243 }
 244
 245 /*****************************************************************************
 246  * Display: displays previously rendered output
 247  *****************************************************************************
 248  * This function copies the rendered picture into our circular buffer.
 249  *****************************************************************************/
 250 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 251 {
 252     video_format_t fmt_in = {0}, fmt_out = {0};
 253
 254     char *psz_filename;
 255
 256     if( p_vout->p_sys->i_frames % p_vout->p_sys->i_ratio != 0 )
 257     {
 258         p_vout->p_sys->i_frames++;
 259         return;
 260     }
 261     p_vout->p_sys->i_frames++;
 262     psz_filename = (char *)malloc( 10 + strlen( p_vout->p_sys->psz_prefix )
 263                                       + strlen( p_vout->p_sys->psz_format ) );
 264
 265     fmt_in.i_chroma = p_vout->render.i_chroma;
 266     fmt_in.i_width = p_vout->render.i_width;
 267     fmt_in.i_height = p_vout->render.i_height;
 268
 269     fmt_out.i_width = p_vout->p_sys->i_width > 0 ? p_vout->p_sys->i_width :
 270                                                    p_vout->render.i_width;
 271     fmt_out.i_height = p_vout->p_sys->i_height > 0 ? p_vout->p_sys->i_height :
 272                                                      p_vout->render.i_height;
 273
 274     if( p_vout->p_sys->b_replace )
 275     {
 276         sprintf( psz_filename, "%s.%s", p_vout->p_sys->psz_prefix,
 277                                             p_vout->p_sys->psz_format );
 278     }
 279     else
 280     {
 281         sprintf( psz_filename, "%s%.6i.%s", p_vout->p_sys->psz_prefix,
 282                                             p_vout->p_sys->i_current,
 283                                             p_vout->p_sys->psz_format );
 284     }
 285     image_WriteUrl( p_vout->p_sys->p_image, p_pic,
 286                     &fmt_in, &fmt_out, psz_filename ) ;
 287     free( psz_filename );
 288
 289     p_vout->p_sys->i_current++;
 290
 291     return;
 292 }
 293
 294
 295 static void End( vout_thread_t *p_vout )
 296 {
 297 }