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

   1 /*****************************************************************************
   2  * image.c : image video output
   3  *****************************************************************************
   4  * Copyright (C) 2004 VideoLAN
   5  * $Id: snapshot.c 8644 2004-09-05 16:53:04Z fkuehne $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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" };
  60 static char *psz_format_list_text[] = { N_("PNG") };
  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     int         i_ratio;    /* Image ratio */
  86
  87     int         i_current;  /* Current image */
  88     int         i_frames;  /* Number of frames */
  89
  90     image_handler_t *p_image;
  91 };
  92
  93 #define FREE( p ) if( p ) { free( p ); p = NULL; }
  94
  95 /*****************************************************************************
  96  * Create: allocates video thread
  97  *****************************************************************************
  98  * This function allocates and initializes a vout method.
  99  *****************************************************************************/
 100 static int Create( vlc_object_t *p_this )
 101 {
 102     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 103
 104     /* Allocate instance and initialize some members */
 105     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 106     if( ! p_vout->p_sys )
 107         return VLC_ENOMEM;
 108
 109     p_vout->p_sys->psz_prefix =
 110             var_CreateGetString( p_this, "image-out-prefix" );
 111     p_vout->p_sys->i_ratio =
 112             var_CreateGetInteger( p_this, "image-out-ratio" );
 113     p_vout->p_sys->i_current = 0;
 114     p_vout->p_sys->p_image = image_HandlerCreate( p_vout );
 115
 116     if( !p_vout->p_sys->p_image )
 117     {
 118         msg_Err( p_this, "unable to create image handler") ;
 119         FREE( p_vout->p_sys->psz_prefix );
 120         FREE( p_vout->p_sys );
 121         return VLC_EGENERIC;
 122     }
 123
 124     p_vout->pf_init = Init;
 125     p_vout->pf_end = End;
 126     p_vout->pf_manage = NULL;
 127     p_vout->pf_render = Display;
 128     p_vout->pf_display = NULL;
 129
 130     return VLC_SUCCESS;
 131 }
 132
 133 /*****************************************************************************
 134  * Init: initialize video thread
 135  *****************************************************************************/
 136 static int Init( vout_thread_t *p_vout )
 137 {
 138     int i_index;
 139     picture_t *p_pic;
 140
 141     /* Initialize the output structure */
 142     p_vout->output.i_chroma = p_vout->render.i_chroma;
 143     p_vout->output.pf_setpalette = NULL;
 144     p_vout->output.i_width = p_vout->render.i_width;
 145     p_vout->output.i_height = p_vout->render.i_height;
 146     p_vout->output.i_aspect = p_vout->output.i_width
 147                                * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
 148
 149     p_vout->output.i_rmask = 0xff0000;
 150     p_vout->output.i_gmask = 0x00ff00;
 151     p_vout->output.i_bmask = 0x0000ff;
 152
 153     /* Try to initialize 1 direct buffer */
 154     p_pic = NULL;
 155
 156     /* Find an empty picture slot */
 157     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 158     {
 159         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 160         {
 161             p_pic = p_vout->p_picture + i_index;
 162             break;
 163         }
 164     }
 165
 166     /* Allocate the picture */
 167     if( p_pic == NULL )
 168     {
 169         return VLC_EGENERIC;
 170     }
 171
 172     vout_AllocatePicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
 173                           p_vout->output.i_width, p_vout->output.i_height,
 174                           p_vout->output.i_aspect );
 175
 176     if( p_pic->i_planes == 0 )
 177     {
 178         return VLC_EGENERIC;
 179     }
 180
 181     p_pic->i_status = DESTROYED_PICTURE;
 182     p_pic->i_type   = DIRECT_PICTURE;
 183
 184     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 185     I_OUTPUTPICTURES++;
 186     return VLC_SUCCESS;
 187 }
 188
 189 /*****************************************************************************
 190  * Destroy: destroy video thread
 191  *****************************************************************************
 192  * Terminate an output method created by Create
 193  *****************************************************************************/
 194 static void Destroy( vlc_object_t *p_this )
 195 {
 196     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
 197
 198     /* Destroy structure */
 199     image_HandlerDelete( p_vout->p_sys->p_image );
 200     FREE( p_vout->p_sys->psz_prefix );
 201     FREE( p_vout->p_sys );
 202 }
 203
 204 /*****************************************************************************
 205  * Display: displays previously rendered output
 206  *****************************************************************************
 207  * This function copies the rendered picture into our circular buffer.
 208  *****************************************************************************/
 209 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 210 {
 211     video_format_t fmt_in = {0}, fmt_out = {0};
 212
 213     char *psz_filename;
 214
 215     if( p_vout->p_sys->i_frames % p_vout->p_sys->i_ratio != 0 )
 216     {
 217         p_vout->p_sys->i_frames++;
 218         return;
 219     }
 220     p_vout->p_sys->i_frames++;
 221     psz_filename = (char *)malloc( strlen( p_vout->p_sys->psz_prefix ) +
 222                                          10 );
 223
 224     fmt_in.i_chroma = p_vout->render.i_chroma;
 225     fmt_out.i_width = fmt_in.i_width = p_vout->render.i_width;
 226     fmt_out.i_height = fmt_in.i_height = p_vout->render.i_height;
 227
 228     p_vout->p_sys->i_current++;
 229
 230     sprintf( psz_filename, "%s%.6i.%s", p_vout->p_sys->psz_prefix,
 231                                       p_vout->p_sys->i_current,
 232                                       "png" );
 233
 234     image_WriteUrl( p_vout->p_sys->p_image, p_pic,
 235                     &fmt_in, &fmt_out, psz_filename ) ;
 236     free( psz_filename );
 237     return;
 238 }
 239
 240
 241 static void End( vout_thread_t *p_vout )
 242 {
 243 }