git.sesse.net Git - vlc/blob - modules/video_filter/scene.c

   1 /*****************************************************************************
   2  * scene.c : scene video filter (based on modules/video_output/image.c)
   3  *****************************************************************************
   4  * Copyright (C) 2004-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Jean-Paul Saman <jpsaman@videolan.org>
   8  *          Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_block.h>
  36
  37 #include <vlc_filter.h>
  38 #include "filter_picture.h"
  39 #include <vlc_image.h>
  40 #include <vlc_strings.h>
  41
  42 /*****************************************************************************
  43  * Local prototypes
  44  *****************************************************************************/
  45 static int  Create      ( vlc_object_t * );
  46 static void Destroy     ( vlc_object_t * );
  47
  48 static picture_t *Filter( filter_t *, picture_t * );
  49
  50 static void SnapshotRatio( filter_t *p_filter, picture_t *p_pic );
  51 static void SavePicture( filter_t *, picture_t * );
  52
  53 /*****************************************************************************
  54  * Module descriptor
  55  *****************************************************************************/
  56 #define FORMAT_TEXT N_( "Image format" )
  57 #define FORMAT_LONGTEXT N_( "Format of the output images (png, jpeg, ...)." )
  58
  59 #define WIDTH_TEXT N_( "Image width" )
  60 #define WIDTH_LONGTEXT N_( "You can enforce the image width. By default " \
  61                             "(-1) VLC will adapt to the video " \
  62                             "characteristics.")
  63
  64 #define HEIGHT_TEXT N_( "Image height" )
  65 #define HEIGHT_LONGTEXT N_( "You can enforce the image height. By default " \
  66                             "(-1) VLC will adapt to the video " \
  67                             "characteristics.")
  68
  69 #define RATIO_TEXT N_( "Recording ratio" )
  70 #define RATIO_LONGTEXT N_( "Ratio of images to record. "\
  71                            "3 means that one image out of three is recorded." )
  72
  73 #define PREFIX_TEXT N_( "Filename prefix" )
  74 #define PREFIX_LONGTEXT N_( "Prefix of the output images filenames. Output " \
  75                             "filenames will have the \"prefixNUMBER.format\" "\
  76                             "form if replace is not true." )
  77
  78 #define PATH_TEXT N_( "Directory path prefix" )
  79 #define PATH_LONGTEXT N_( "Directory path where images files should be saved." \
  80                           "If not set, then images will be automatically saved in " \
  81                           "users homedir." )
  82
  83 #define REPLACE_TEXT N_( "Always write to the same file" )
  84 #define REPLACE_LONGTEXT N_( "Always write to the same file instead of " \
  85                             "creating one file per image. In this case, " \
  86                              "the number is not appended to the filename." )
  87
  88 #define CFG_PREFIX "scene-"
  89
  90 vlc_module_begin ()
  91     set_shortname( N_( "Scene filter" ) )
  92     set_description( N_( "Scene video filter" ) )
  93     set_category( CAT_VIDEO )
  94     set_subcategory( SUBCAT_VIDEO_VOUT )
  95     set_capability( "video filter2", 0 )
  96
  97     /* General options */
  98     add_string(  CFG_PREFIX "format", "png", NULL,
  99                  FORMAT_TEXT, FORMAT_LONGTEXT, false )
 100     add_integer( CFG_PREFIX "width", -1, NULL,
 101                  WIDTH_TEXT, WIDTH_LONGTEXT, true )
 102     add_integer( CFG_PREFIX "height", -1, NULL,
 103                  HEIGHT_TEXT, HEIGHT_LONGTEXT, true )
 104     add_string(  CFG_PREFIX "prefix", "scene", NULL,
 105                  PREFIX_TEXT, PREFIX_LONGTEXT, false )
 106     add_string(  CFG_PREFIX "path", NULL, NULL,
 107                  PATH_TEXT, PATH_LONGTEXT, false )
 108     add_bool(    CFG_PREFIX "replace", false, NULL,
 109                  REPLACE_TEXT, REPLACE_LONGTEXT, false )
 110
 111     /* Snapshot method */
 112     add_integer( CFG_PREFIX "ratio", 50, NULL,
 113                  RATIO_TEXT, RATIO_LONGTEXT, false )
 114
 115     set_callbacks( Create, Destroy )
 116 vlc_module_end ()
 117
 118 static const char *const ppsz_vfilter_options[] = {
 119     "format", "width", "height", "ratio", "prefix", "path", "replace", NULL
 120 };
 121
 122 typedef struct scene_t {
 123     picture_t       *p_pic;
 124     video_format_t  format;
 125 } scene_t;
 126
 127 /*****************************************************************************
 128  * filter_sys_t: private data
 129  *****************************************************************************/
 130 struct filter_sys_t
 131 {
 132     image_handler_t *p_image;
 133     scene_t *p_scene;
 134
 135     char *psz_path;
 136     char *psz_prefix;
 137     char *psz_format;
 138     vlc_fourcc_t i_format;
 139     int32_t i_width;
 140     int32_t i_height;
 141     int32_t i_ratio;  /* save every n-th frame */
 142     int32_t i_frames; /* frames count */
 143     bool  b_replace;
 144 };
 145
 146 /*****************************************************************************
 147  * Create: initialize and set pf_video_filter()
 148  *****************************************************************************/
 149 static int Create( vlc_object_t *p_this )
 150 {
 151     filter_t *p_filter = (filter_t *)p_this;
 152     filter_sys_t *p_sys;
 153
 154     config_ChainParse( p_filter, CFG_PREFIX, ppsz_vfilter_options,
 155                        p_filter->p_cfg );
 156
 157     p_filter->p_sys = p_sys = calloc( 1, sizeof( filter_sys_t ) );
 158     if( p_filter->p_sys == NULL )
 159         return VLC_ENOMEM;
 160
 161     p_sys->p_scene = calloc( 1, sizeof( scene_t ) );
 162     if( !p_sys->p_scene )
 163     {
 164         free( p_sys );
 165         return VLC_ENOMEM;
 166     }
 167
 168     p_sys->p_image = image_HandlerCreate( p_this );
 169     if( !p_sys->p_image )
 170     {
 171         msg_Err( p_this, "Couldn't get handle to image conversion routines." );
 172         free( p_sys->p_scene );
 173         free( p_sys );
 174         return VLC_EGENERIC;
 175     }
 176
 177     p_sys->psz_format = var_CreateGetString( p_this, CFG_PREFIX "format" );
 178     p_sys->i_format = image_Type2Fourcc( p_sys->psz_format );
 179     if( !p_sys->i_format )
 180     {
 181         msg_Err( p_filter, "Could not find FOURCC for image type '%s'",
 182                  p_sys->psz_format );
 183         image_HandlerDelete( p_sys->p_image );
 184         free( p_sys->p_scene );
 185         free( p_sys->psz_format );
 186         free( p_sys );
 187         return VLC_EGENERIC;
 188     }
 189     p_sys->i_width = var_CreateGetInteger( p_this, CFG_PREFIX "width" );
 190     p_sys->i_height = var_CreateGetInteger( p_this, CFG_PREFIX "height" );
 191     p_sys->i_ratio = var_CreateGetInteger( p_this, CFG_PREFIX "ratio" );
 192     p_sys->b_replace = var_CreateGetBool( p_this, CFG_PREFIX "replace" );
 193     p_sys->psz_prefix = var_CreateGetString( p_this, CFG_PREFIX "prefix" );
 194     p_sys->psz_path = var_GetNonEmptyString( p_this, CFG_PREFIX "path" );
 195     if( p_sys->psz_path == NULL )
 196         p_sys->psz_path = config_GetUserDir( VLC_HOME_DIR );
 197
 198     p_filter->pf_video_filter = Filter;
 199
 200     return VLC_SUCCESS;
 201 }
 202
 203 /*****************************************************************************
 204  * Destroy: destroy video filter method
 205  *****************************************************************************/
 206 static void Destroy( vlc_object_t *p_this )
 207 {
 208     filter_t *p_filter = (filter_t *)p_this;
 209     filter_sys_t *p_sys = (filter_sys_t *) p_filter->p_sys;
 210
 211     image_HandlerDelete( p_sys->p_image );
 212
 213     if( p_sys->p_scene && p_sys->p_scene->p_pic )
 214     picture_Release( p_sys->p_scene->p_pic );
 215     free( p_sys->p_scene );
 216     free( p_sys->psz_format );
 217     free( p_sys->psz_prefix );
 218     free( p_sys->psz_path );
 219     free( p_sys );
 220 }
 221
 222 /*****************************************************************************
 223  * Filter: Apply filtering logic to picture.
 224  *****************************************************************************/
 225 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
 226 {
 227     /* TODO: think of some funky algorithm to detect scene changes. */
 228     SnapshotRatio( p_filter, p_pic );
 229     return p_pic;
 230 }
 231
 232 static void SnapshotRatio( filter_t *p_filter, picture_t *p_pic )
 233 {
 234     filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
 235
 236     if( !p_pic ) return;
 237
 238     if( p_sys->i_frames % p_sys->i_ratio != 0 )
 239     {
 240         p_sys->i_frames++;
 241         return;
 242     }
 243     p_sys->i_frames++;
 244
 245     if( p_sys->p_scene->p_pic )
 246         picture_Release( p_sys->p_scene->p_pic );
 247
 248     if( (p_sys->i_width <= 0) && (p_sys->i_height > 0) )
 249     {
 250         p_sys->i_width = (p_pic->format.i_width * p_sys->i_height) / p_pic->format.i_height;
 251     }
 252     else if( (p_sys->i_height <= 0) && (p_sys->i_width > 0) )
 253     {
 254         p_sys->i_height = (p_pic->format.i_height * p_sys->i_width) / p_pic->format.i_width;
 255     }
 256     else if( (p_sys->i_width <= 0) && (p_sys->i_height <= 0) )
 257     {
 258         p_sys->i_width = p_pic->format.i_width;
 259         p_sys->i_height = p_pic->format.i_height;
 260     }
 261
 262     p_sys->p_scene->p_pic = picture_New( p_pic->format.i_chroma,
 263                 p_pic->format.i_width, p_pic->format.i_height,
 264                 p_pic->format.i_sar_num );
 265     if( p_sys->p_scene->p_pic )
 266     {
 267         picture_Copy( p_sys->p_scene->p_pic, p_pic );
 268         SavePicture( p_filter, p_sys->p_scene->p_pic );
 269     }
 270 }
 271
 272 /*****************************************************************************
 273  * Save Picture to disk
 274  *****************************************************************************/
 275 static void SavePicture( filter_t *p_filter, picture_t *p_pic )
 276 {
 277     filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
 278     video_format_t fmt_in, fmt_out;
 279     char *psz_filename = NULL;
 280     char *psz_temp = NULL;
 281     int i_ret;
 282
 283     memset( &fmt_in, 0, sizeof(video_format_t) );
 284     memset( &fmt_out, 0, sizeof(video_format_t) );
 285
 286     /* Save snapshot psz_format to a memory zone */
 287     fmt_in = p_pic->format;
 288     fmt_out.i_sar_num = fmt_out.i_sar_den = 1;
 289     fmt_out.i_width = p_sys->i_width;
 290     fmt_out.i_height = p_sys->i_height;
 291     fmt_out.i_chroma = p_sys->i_format;
 292
 293     /*
 294      * Save the snapshot to a temporary file and
 295      * switch it to the real name afterwards.
 296      */
 297     if( p_sys->b_replace )
 298         i_ret = asprintf( &psz_filename, "%s" DIR_SEP "%s.%s",
 299                           p_sys->psz_path, p_sys->psz_prefix,
 300                           p_sys->psz_format );
 301     else
 302         i_ret = asprintf( &psz_filename, "%s" DIR_SEP "%s%05d.%s",
 303                           p_sys->psz_path, p_sys->psz_prefix,
 304                           p_sys->i_frames, p_sys->psz_format );
 305
 306     if( i_ret == -1 )
 307     {
 308         msg_Err( p_filter, "could not create snapshot %s", psz_filename );
 309         goto error;
 310     }
 311     path_sanitize( psz_filename );
 312
 313     i_ret = asprintf( &psz_temp, "%s.swp", psz_filename );
 314     if( i_ret == -1 )
 315     {
 316         msg_Err( p_filter, "could not create snapshot temporarily file %s", psz_temp );
 317         goto error;
 318     }
 319     path_sanitize( psz_temp );
 320
 321     /* Save the image */
 322     i_ret = image_WriteUrl( p_sys->p_image, p_pic, &fmt_in, &fmt_out,
 323                             psz_temp );
 324     if( i_ret != VLC_SUCCESS )
 325     {
 326         msg_Err( p_filter, "could not create snapshot %s", psz_temp );
 327     }
 328     else
 329     {
 330         /* switch to the final destination */
 331         i_ret = rename( psz_temp, psz_filename );
 332         if( i_ret == -1 )
 333         {
 334             msg_Err( p_filter, "could not rename snapshot %s %m", psz_filename );
 335             goto error;
 336         }
 337     }
 338
 339 error:
 340     free( psz_temp );
 341     free( psz_filename );
 342 }