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_( "Set the format of the output image." )
  50
  51 #define RATIO_TEXT N_( "Recording ratio" )
  52 #define RATIO_LONGTEXT N_( "Set the ratio of images that are recorded. "\
  53                            "3 means that one image out of three is recorded." )
  54
  55 #define PREFIX_TEXT N_( "Filename prefix" )
  56 #define PREFIX_LONGTEXT N_( "Set the prefix of the filename. Output filename "\
  57                             "will have the form prefixNUMBER.format" )
  58
  59 static char *psz_format_list[] = { "png", "jpeg" };
  60 static char *psz_format_list_text[] = { "PNG", "JPEG" };
  61
  62 vlc_module_begin( );
  63     set_shortname( _( "Image file" ) );
  64     set_description( _( "Image video output" ) );
  65     set_category( CAT_VIDEO );
  66     set_subcategory( SUBCAT_VIDEO_VOUT );
  67     set_capability( "video output", 0 );
  68
  69     add_string( "image-out-format", "png", NULL,  FORMAT_TEXT, FORMAT_LONGTEXT,
  70                                                   VLC_FALSE );
  71         change_string_list( psz_format_list, psz_format_list_text, 0 );
  72     add_integer( "image-out-ratio", 3 , NULL,  RATIO_TEXT, RATIO_LONGTEXT,
  73                                                   VLC_FALSE );
  74     add_string( "image-out-prefix", "img", NULL, PREFIX_TEXT, PREFIX_LONGTEXT,
  75                                                  VLC_FALSE );
  76     set_callbacks( Create, Destroy );
  77 vlc_module_end();
  78
  79 /*****************************************************************************
  80  * vout_sys_t: video output descriptor
  81  *****************************************************************************/
  82 struct vout_sys_t
  83 {
  84     char        *psz_prefix;          /* Prefix */
  85     char        *psz_format;          /* Format */
  86     int         i_ratio;         /* Image ratio */
  87
  88     int         i_current;     /* Current image */
  89     int         i_frames;   /* Number of frames */
  90
  91     image_handler_t *p_image;
  92 };
  93
  94 #define FREE( p ) if( p ) { free( p ); p = NULL; }
  95
  96 /*****************************************************************************
  97  * Create: allocates video thread
  98  *****************************************************************************
  99  * This function allocates and initializes a vout method.
 100  *****************************************************************************/
 101 static int Create( vlc_object_t *p_this )
 102 {
 103     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 104
 105     /* Allocate instance and initialize some members */
 106     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 107     if( ! p_vout->p_sys )
 108         return VLC_ENOMEM;
 109
 110     p_vout->p_sys->psz_prefix =
 111             var_CreateGetString( p_this, "image-out-prefix" );
 112     p_vout->p_sys->psz_format =
 113             var_CreateGetString( p_this, "image-out-format" );
 114     p_vout->p_sys->i_ratio =
 115             var_CreateGetInteger( p_this, "image-out-ratio" );
 116     p_vout->p_sys->i_current = 0;
 117     p_vout->p_sys->p_image = image_HandlerCreate( p_vout );
 118
 119     if( !p_vout->p_sys->p_image )
 120     {
 121         msg_Err( p_this, "unable to create image handler") ;
 122         FREE( p_vout->p_sys->psz_prefix );
 123         FREE( p_vout->p_sys );
 124         return VLC_EGENERIC;
 125     }
 126
 127     p_vout->pf_init = Init;
 128     p_vout->pf_end = End;
 129     p_vout->pf_manage = NULL;
 130     p_vout->pf_render = Display;
 131     p_vout->pf_display = NULL;
 132
 133     return VLC_SUCCESS;
 134 }
 135
 136 /*****************************************************************************
 137  * Init: initialize video thread
 138  *****************************************************************************/
 139 static int Init( vout_thread_t *p_vout )
 140 {
 141     int i_index;
 142     picture_t *p_pic;
 143
 144     /* Initialize the output structure */
 145     p_vout->output.i_chroma = p_vout->render.i_chroma;
 146     p_vout->output.pf_setpalette = NULL;
 147     p_vout->output.i_width = p_vout->render.i_width;
 148     p_vout->output.i_height = p_vout->render.i_height;
 149     p_vout->output.i_aspect = p_vout->output.i_width
 150                                * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
 151
 152     p_vout->output.i_rmask = 0xff0000;
 153     p_vout->output.i_gmask = 0x00ff00;
 154     p_vout->output.i_bmask = 0x0000ff;
 155
 156     /* Try to initialize 1 direct buffer */
 157     p_pic = NULL;
 158
 159     /* Find an empty picture slot */
 160     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 161     {
 162         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 163         {
 164             p_pic = p_vout->p_picture + i_index;
 165             break;
 166         }
 167     }
 168
 169     /* Allocate the picture */
 170     if( p_pic == NULL )
 171     {
 172         return VLC_EGENERIC;
 173     }
 174
 175     vout_AllocatePicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
 176                           p_vout->output.i_width, p_vout->output.i_height,
 177                           p_vout->output.i_aspect );
 178
 179     if( p_pic->i_planes == 0 )
 180     {
 181         return VLC_EGENERIC;
 182     }
 183
 184     p_pic->i_status = DESTROYED_PICTURE;
 185     p_pic->i_type   = DIRECT_PICTURE;
 186
 187     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 188     I_OUTPUTPICTURES++;
 189     return VLC_SUCCESS;
 190 }
 191
 192 /*****************************************************************************
 193  * Destroy: destroy video thread
 194  *****************************************************************************
 195  * Terminate an output method created by Create
 196  *****************************************************************************/
 197 static void Destroy( vlc_object_t *p_this )
 198 {
 199     int i_index;
 200     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 201
 202     for( i_index = I_OUTPUTPICTURES-1; i_index >= 0; i_index-- )
 203     {
 204         free( PP_OUTPUTPICTURE[ i_index ]->p_data );
 205     }
 206
 207     /* Destroy structure */
 208     image_HandlerDelete( p_vout->p_sys->p_image );
 209     FREE( p_vout->p_sys->psz_prefix );
 210     FREE( p_vout->p_sys->psz_format );
 211     FREE( p_vout->p_sys );
 212 }
 213
 214 /*****************************************************************************
 215  * Display: displays previously rendered output
 216  *****************************************************************************
 217  * This function copies the rendered picture into our circular buffer.
 218  *****************************************************************************/
 219 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 220 {
 221     video_format_t fmt_in = {0}, fmt_out = {0};
 222
 223     char *psz_filename;
 224
 225     if( p_vout->p_sys->i_frames % p_vout->p_sys->i_ratio != 0 )
 226     {
 227         p_vout->p_sys->i_frames++;
 228         return;
 229     }
 230     p_vout->p_sys->i_frames++;
 231     psz_filename = (char *)malloc( 10 + strlen( p_vout->p_sys->psz_prefix )
 232                                       + strlen( p_vout->p_sys->psz_format ) );
 233
 234     fmt_in.i_chroma = p_vout->render.i_chroma;
 235     fmt_out.i_width = fmt_in.i_width = p_vout->render.i_width;
 236     fmt_out.i_height = fmt_in.i_height = p_vout->render.i_height;
 237
 238     sprintf( psz_filename, "%s%.6i.%s", p_vout->p_sys->psz_prefix,
 239                                         p_vout->p_sys->i_current,
 240                                         p_vout->p_sys->psz_format );
 241     image_WriteUrl( p_vout->p_sys->p_image, p_pic,
 242                     &fmt_in, &fmt_out, psz_filename ) ;
 243     free( psz_filename );
 244
 245     p_vout->p_sys->i_current++;
 246
 247     return;
 248 }
 249
 250
 251 static void End( vout_thread_t *p_vout )
 252 {
 253 }