git.sesse.net Git - vlc/blob - modules/codec/fake.c

   1 /*****************************************************************************
   2  * fake.c: decoder reading from a fake stream, outputting a fixed image
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Jean-Paul Saman <jpsaman at m2x dot nl>
   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 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_codec.h>
  35
  36 #include <vlc_image.h>
  37 #include <vlc_filter.h>
  38 #include <vlc_charset.h>
  39
  40 /*****************************************************************************
  41  * Local prototypes
  42  *****************************************************************************/
  43 static int  OpenDecoder   ( vlc_object_t * );
  44 static void CloseDecoder  ( vlc_object_t * );
  45
  46 static picture_t *DecodeBlock  ( decoder_t *, block_t ** );
  47 static int FakeCallback( vlc_object_t *, char const *,
  48                          vlc_value_t, vlc_value_t, void * );
  49
  50 /*****************************************************************************
  51  * Module descriptor
  52  *****************************************************************************/
  53 #define FILE_TEXT N_("Image file")
  54 #define FILE_LONGTEXT N_( \
  55     "Path of the image file for fake input." )
  56 #define RELOAD_TEXT N_("Reload image file")
  57 #define RELOAD_LONGTEXT N_( \
  58     "Reload image file every n seconds." )
  59 #define WIDTH_TEXT N_("Video width")
  60 #define WIDTH_LONGTEXT N_( \
  61     "Output video width." )
  62 #define HEIGHT_TEXT N_("Video height")
  63 #define HEIGHT_LONGTEXT N_( \
  64     "Output video height." )
  65 #define KEEP_AR_TEXT N_("Keep aspect ratio")
  66 #define KEEP_AR_LONGTEXT N_( \
  67     "Consider width and height as maximum values." )
  68 #define ASPECT_RATIO_TEXT N_("Background aspect ratio")
  69 #define ASPECT_RATIO_LONGTEXT N_( \
  70     "Aspect ratio of the image file (4:3, 16:9). Default is square pixels." )
  71 #define DEINTERLACE_TEXT N_("Deinterlace video")
  72 #define DEINTERLACE_LONGTEXT N_( \
  73     "Deinterlace the image after loading it." )
  74 #define DEINTERLACE_MODULE_TEXT N_("Deinterlace module")
  75 #define DEINTERLACE_MODULE_LONGTEXT N_( \
  76     "Deinterlace module to use." )
  77 #define CHROMA_TEXT N_("Chroma used.")
  78 #define CHROMA_LONGTEXT N_( \
  79     "Force use of a specific chroma for output. Default is I420." )
  80
  81 static const char *const ppsz_deinterlace_type[] =
  82 {
  83     "deinterlace", "ffmpeg-deinterlace"
  84 };
  85
  86 vlc_module_begin ()
  87     set_category( CAT_INPUT )
  88     set_subcategory( SUBCAT_INPUT_VCODEC )
  89     set_shortname( N_("Fake") )
  90     set_description( N_("Fake video decoder") )
  91     set_capability( "decoder", 1000 )
  92     set_callbacks( OpenDecoder, CloseDecoder )
  93     add_shortcut( "fake" )
  94
  95     add_file( "fake-file", "", NULL, FILE_TEXT,
  96                 FILE_LONGTEXT, false )
  97     add_integer( "fake-file-reload", 0, NULL, RELOAD_TEXT,
  98                 RELOAD_LONGTEXT, false )
  99     add_integer( "fake-width", 0, NULL, WIDTH_TEXT,
 100                  WIDTH_LONGTEXT, true )
 101     add_integer( "fake-height", 0, NULL, HEIGHT_TEXT,
 102                  HEIGHT_LONGTEXT, true )
 103     add_bool( "fake-keep-ar", 0, NULL, KEEP_AR_TEXT, KEEP_AR_LONGTEXT,
 104               true )
 105     add_string( "fake-aspect-ratio", "", NULL,
 106                 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, true )
 107     add_bool( "fake-deinterlace", 0, NULL, DEINTERLACE_TEXT,
 108               DEINTERLACE_LONGTEXT, false )
 109     add_string( "fake-deinterlace-module", "deinterlace", NULL,
 110                 DEINTERLACE_MODULE_TEXT, DEINTERLACE_MODULE_LONGTEXT,
 111                 false )
 112         change_string_list( ppsz_deinterlace_type, 0, 0 )
 113     add_string( "fake-chroma", "I420", NULL, CHROMA_TEXT, CHROMA_LONGTEXT,
 114                 true )
 115 vlc_module_end ()
 116
 117 struct decoder_sys_t
 118 {
 119     picture_t *p_image;
 120     vlc_mutex_t lock;
 121
 122     bool  b_reload;
 123     mtime_t     i_reload;
 124     mtime_t     i_next;
 125 };
 126
 127 /*****************************************************************************
 128  * OpenDecoder: probe the decoder and return score
 129  *****************************************************************************/
 130 static int OpenDecoder( vlc_object_t *p_this )
 131 {
 132     decoder_t *p_dec = (decoder_t*)p_this;
 133     vlc_value_t val;
 134     image_handler_t *p_handler;
 135     video_format_t fmt_in, fmt_out;
 136     picture_t *p_image;
 137     char *psz_file, *psz_chroma;
 138     bool b_keep_ar;
 139     int i_aspect = 0;
 140
 141     if( p_dec->fmt_in.i_codec != VLC_FOURCC('f','a','k','e') )
 142     {
 143         return VLC_EGENERIC;
 144     }
 145
 146     p_dec->p_sys = calloc( 1, sizeof( *p_dec->p_sys ) );
 147     if( !p_dec->p_sys )
 148         return VLC_ENOMEM;
 149
 150     psz_file = var_CreateGetNonEmptyStringCommand( p_dec, "fake-file" );
 151     if( !psz_file )
 152     {
 153         msg_Err( p_dec, "specify a file with --fake-file=..." );
 154         free( p_dec->p_sys );
 155         return VLC_EGENERIC;
 156     }
 157
 158     memset( &fmt_in, 0, sizeof(fmt_in) );
 159     memset( &fmt_out, 0, sizeof(fmt_out) );
 160
 161     val.i_int = var_CreateGetIntegerCommand( p_dec, "fake-file-reload" );
 162     if( val.i_int > 0)
 163     {
 164         p_dec->p_sys->b_reload = true;
 165         p_dec->p_sys->i_reload = (mtime_t)(val.i_int * 1000000);
 166         p_dec->p_sys->i_next   = (mtime_t)(p_dec->p_sys->i_reload + mdate());
 167     }
 168
 169     psz_chroma = var_CreateGetString( p_dec, "fake-chroma" );
 170     fmt_out.i_chroma = vlc_fourcc_GetCodecFromString( VIDEO_ES, psz_chroma );
 171     if( !fmt_out.i_chroma )
 172     {
 173         msg_Warn( p_dec, "Invalid chroma (%s). Using I420.", psz_chroma );
 174         fmt_out.i_chroma = VLC_CODEC_I420;
 175     }
 176     free( psz_chroma );
 177
 178     var_Create( p_dec, "fake-keep-ar", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 179     var_Get( p_dec, "fake-keep-ar", &val );
 180     b_keep_ar = val.b_bool;
 181
 182     var_Create( p_dec, "fake-width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 183     var_Create( p_dec, "fake-height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 184     var_Create( p_dec, "fake-aspect-ratio",
 185                 VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 186
 187     var_Get( p_dec, "fake-aspect-ratio", &val );
 188     if ( val.psz_string )
 189     {
 190         char *psz_parser = strchr( val.psz_string, ':' );
 191
 192         if( psz_parser )
 193         {
 194             *psz_parser++ = '\0';
 195             i_aspect = atoi( val.psz_string )
 196                                    * VOUT_ASPECT_FACTOR / atoi( psz_parser );
 197         }
 198         free( val.psz_string );
 199     }
 200
 201     if ( !b_keep_ar )
 202     {
 203         var_Get( p_dec, "fake-width", &val );
 204         fmt_out.i_width = val.i_int;
 205         var_Get( p_dec, "fake-height", &val );
 206         fmt_out.i_height = val.i_int;
 207     }
 208
 209     p_handler = image_HandlerCreate( p_dec );
 210     p_image = image_ReadUrl( p_handler, psz_file, &fmt_in, &fmt_out );
 211     image_HandlerDelete( p_handler );
 212
 213     if ( p_image == NULL )
 214     {
 215         msg_Err( p_dec, "unable to read image file %s", psz_file );
 216         free( psz_file );
 217         free( p_dec->p_sys );
 218         return VLC_EGENERIC;
 219     }
 220     msg_Dbg( p_dec, "file %s loaded successfully", psz_file );
 221
 222     free( psz_file );
 223
 224     if ( b_keep_ar )
 225     {
 226         picture_t *p_old = p_image;
 227         int i_width, i_height;
 228
 229         var_Get( p_dec, "fake-width", &val );
 230         i_width = val.i_int;
 231         var_Get( p_dec, "fake-height", &val );
 232         i_height = val.i_int;
 233
 234         if ( i_width && i_height )
 235         {
 236             int i_image_ar = fmt_out.i_width * VOUT_ASPECT_FACTOR
 237                               / fmt_out.i_height;
 238             int i_region_ar = i_width * VOUT_ASPECT_FACTOR / i_height;
 239             fmt_in = fmt_out;
 240
 241             if ( i_aspect == i_image_ar )
 242             {
 243                 fmt_out.i_width = i_width;
 244                 fmt_out.i_height = i_height;
 245             }
 246             else if ( i_image_ar > i_region_ar )
 247             {
 248                 fmt_out.i_width = i_width;
 249                 fmt_out.i_height = i_width * VOUT_ASPECT_FACTOR
 250                                     / i_image_ar;
 251                 i_aspect = i_image_ar;
 252             }
 253             else
 254             {
 255                 fmt_out.i_height = i_height;
 256                 fmt_out.i_width = i_height * i_image_ar
 257                                     / VOUT_ASPECT_FACTOR;
 258                 i_aspect = i_image_ar;
 259             }
 260
 261             p_handler = image_HandlerCreate( p_dec );
 262             p_image = image_Convert( p_handler, p_old, &fmt_in, &fmt_out );
 263             image_HandlerDelete( p_handler );
 264
 265             if ( p_image == NULL )
 266             {
 267                 msg_Warn( p_dec, "couldn't load resizing module" );
 268                 p_image = p_old;
 269                 fmt_out = fmt_in;
 270             }
 271             else
 272             {
 273                 picture_Release( p_old );
 274             }
 275         }
 276     }
 277
 278     if ( i_aspect )
 279     {
 280         fmt_out.i_aspect = i_aspect;
 281     }
 282     else
 283     {
 284         fmt_out.i_aspect = fmt_out.i_width
 285                             * VOUT_ASPECT_FACTOR / fmt_out.i_height;
 286     }
 287
 288     var_Create( p_dec, "fake-deinterlace", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 289     var_Get( p_dec, "fake-deinterlace", &val );
 290     if ( val.b_bool )
 291     {
 292         picture_t *p_old = p_image;
 293
 294         var_Create( p_dec, "fake-deinterlace-module",
 295                     VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 296         var_Get( p_dec, "fake-deinterlace-module", &val );
 297
 298         p_handler = image_HandlerCreate( p_dec );
 299         p_image = image_Filter( p_handler, p_old, &fmt_out, val.psz_string );
 300         image_HandlerDelete( p_handler );
 301         free( val.psz_string );
 302
 303         if ( p_image == NULL )
 304         {
 305             msg_Warn( p_dec, "couldn't load deinterlace module" );
 306             p_image = p_old;
 307         }
 308         else
 309         {
 310             picture_Release( p_old );
 311         }
 312     }
 313
 314     /* Set output properties */
 315     p_dec->fmt_out.i_cat = VIDEO_ES;
 316     p_dec->fmt_out.i_codec = fmt_out.i_chroma;
 317     p_dec->fmt_out.video = fmt_out;
 318
 319     /* Set callbacks */
 320     p_dec->pf_decode_video = DecodeBlock;
 321
 322     p_dec->p_sys->p_image = p_image;
 323     vlc_mutex_init( &p_dec->p_sys->lock );
 324
 325     /* Add the callback when every variables are available */
 326     var_AddCallback( p_dec, "fake-file", FakeCallback, p_dec );
 327     var_AddCallback( p_dec, "fake-file-reload", FakeCallback , p_dec );
 328
 329     return VLC_SUCCESS;
 330 }
 331
 332 /****************************************************************************
 333  * DecodeBlock: the whole thing
 334  ****************************************************************************/
 335 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 336 {
 337     decoder_sys_t *p_sys = (decoder_sys_t*) p_dec->p_sys;
 338     picture_t *p_pic;
 339
 340     if( pp_block == NULL || !*pp_block ) return NULL;
 341     p_pic = decoder_NewPicture( p_dec );
 342     if( p_pic == NULL )
 343     {
 344         msg_Err( p_dec, "cannot get picture" );
 345         goto error;
 346     }
 347
 348     if( p_sys->b_reload && (mdate() >= p_sys->i_next) )
 349     {
 350         var_TriggerCallback( p_dec, "fake-file" );
 351         /* next period */
 352         p_sys->i_next = (mtime_t)(p_sys->i_reload + mdate());
 353     }
 354     vlc_mutex_lock( &p_dec->p_sys->lock );
 355     picture_Copy( p_pic, p_dec->p_sys->p_image );
 356     vlc_mutex_unlock( &p_dec->p_sys->lock );
 357
 358     p_pic->date = (*pp_block)->i_pts;
 359
 360 error:
 361     block_Release( *pp_block );
 362     *pp_block = NULL;
 363
 364     return p_pic;
 365 }
 366
 367 /*****************************************************************************
 368  * CloseDecoder: fake decoder destruction
 369  *****************************************************************************/
 370 static void CloseDecoder( vlc_object_t *p_this )
 371 {
 372     decoder_t *p_dec = (decoder_t *)p_this;
 373     picture_t *p_image = p_dec->p_sys->p_image;
 374
 375     var_DelCallback( p_dec, "fake-file", FakeCallback, p_dec );
 376     var_DelCallback( p_dec, "fake-file-reload", FakeCallback , p_dec );
 377
 378     if( p_image != NULL )
 379         picture_Release( p_image );
 380
 381     vlc_mutex_destroy( &p_dec->p_sys->lock );
 382     free( p_dec->p_sys );
 383 }
 384
 385 /*****************************************************************************
 386  * FakeCallback: Image source change callback.
 387  *****************************************************************************/
 388 static int FakeCallback( vlc_object_t *p_this, char const *psz_var,
 389                          vlc_value_t oldval, vlc_value_t newval,
 390                          void *p_data )
 391 {
 392     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 393     decoder_t *p_dec = (decoder_t *)p_data;
 394
 395     if( !strcmp( psz_var, "fake-file" ) )
 396     {
 397         image_handler_t *p_handler;
 398         picture_t *p_new_image;
 399         video_format_t fmt_in, fmt_out;
 400         char *psz_file = newval.psz_string;
 401         picture_t *p_image;
 402
 403         vlc_mutex_lock( &p_dec->p_sys->lock );
 404         p_image = p_dec->p_sys->p_image;
 405
 406         if( !psz_file || !*psz_file )
 407         {
 408             msg_Err( p_dec, "fake-file value must be non empty." );
 409             vlc_mutex_unlock( &p_dec->p_sys->lock );
 410             return VLC_EGENERIC;
 411         }
 412         msg_Dbg( p_dec, "Changing fake-file to %s.", psz_file );
 413
 414         memset( &fmt_in, 0, sizeof(fmt_in) );
 415         fmt_out = p_dec->fmt_out.video;
 416         p_handler = image_HandlerCreate( p_dec );
 417         p_new_image = image_ReadUrl( p_handler, psz_file, &fmt_in, &fmt_out );
 418         image_HandlerDelete( p_handler );
 419
 420         if( !p_new_image )
 421         {
 422             msg_Err( p_dec, "error while reading image (%s)", psz_file );
 423             vlc_mutex_unlock( &p_dec->p_sys->lock );
 424             return VLC_EGENERIC;
 425         }
 426
 427         p_dec->p_sys->p_image = p_new_image;
 428         picture_Release( p_image );
 429         vlc_mutex_unlock( &p_dec->p_sys->lock );
 430     }
 431     else if( !strcmp( psz_var, "fake-file-reload" ) )
 432     {
 433         if( newval.i_int > 0)
 434         {
 435             p_dec->p_sys->b_reload = true;
 436             p_dec->p_sys->i_reload = (mtime_t)(newval.i_int * 1000000);
 437             p_dec->p_sys->i_next   = (mtime_t)(p_dec->p_sys->i_reload + mdate());
 438         }
 439         else
 440         {
 441             p_dec->p_sys->b_reload = false;
 442         }
 443     }
 444
 445     return VLC_SUCCESS;
 446 }