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     var_AddCallback( p_dec, "fake-file", FakeCallback, p_dec );
 158
 159     memset( &fmt_in, 0, sizeof(fmt_in) );
 160     memset( &fmt_out, 0, sizeof(fmt_out) );
 161
 162     val.i_int = var_CreateGetIntegerCommand( p_dec, "fake-file-reload" );
 163     if( val.i_int > 0)
 164     {
 165         p_dec->p_sys->b_reload = true;
 166         p_dec->p_sys->i_reload = (mtime_t)(val.i_int * 1000000);
 167         p_dec->p_sys->i_next   = (mtime_t)(p_dec->p_sys->i_reload + mdate());
 168     }
 169     var_AddCallback( p_dec, "fake-file-reload", FakeCallback , p_dec );
 170
 171     psz_chroma = var_CreateGetString( p_dec, "fake-chroma" );
 172     fmt_out.i_chroma = vlc_fourcc_GetCodecFromString( VIDEO_ES, psz_chroma );
 173     if( !fmt_out.i_chroma )
 174     {
 175         msg_Warn( p_dec, "Invalid chroma (%s). Using I420.", psz_chroma );
 176         fmt_out.i_chroma = VLC_CODEC_I420;
 177     }
 178     free( psz_chroma );
 179
 180     var_Create( p_dec, "fake-keep-ar", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 181     var_Get( p_dec, "fake-keep-ar", &val );
 182     b_keep_ar = val.b_bool;
 183
 184     var_Create( p_dec, "fake-width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 185     var_Create( p_dec, "fake-height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 186     var_Create( p_dec, "fake-aspect-ratio",
 187                 VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 188
 189     var_Get( p_dec, "fake-aspect-ratio", &val );
 190     if ( val.psz_string )
 191     {
 192         char *psz_parser = strchr( val.psz_string, ':' );
 193
 194         if( psz_parser )
 195         {
 196             *psz_parser++ = '\0';
 197             i_aspect = atoi( val.psz_string )
 198                                    * VOUT_ASPECT_FACTOR / atoi( psz_parser );
 199         }
 200         free( val.psz_string );
 201     }
 202
 203     if ( !b_keep_ar )
 204     {
 205         var_Get( p_dec, "fake-width", &val );
 206         fmt_out.i_width = val.i_int;
 207         var_Get( p_dec, "fake-height", &val );
 208         fmt_out.i_height = val.i_int;
 209     }
 210
 211     p_handler = image_HandlerCreate( p_dec );
 212     p_image = image_ReadUrl( p_handler, psz_file, &fmt_in, &fmt_out );
 213     image_HandlerDelete( p_handler );
 214
 215     if ( p_image == NULL )
 216     {
 217         msg_Err( p_dec, "unable to read image file %s", psz_file );
 218         free( psz_file );
 219         free( p_dec->p_sys );
 220         return VLC_EGENERIC;
 221     }
 222     msg_Dbg( p_dec, "file %s loaded successfully", psz_file );
 223
 224     free( psz_file );
 225
 226     if ( b_keep_ar )
 227     {
 228         picture_t *p_old = p_image;
 229         int i_width, i_height;
 230
 231         var_Get( p_dec, "fake-width", &val );
 232         i_width = val.i_int;
 233         var_Get( p_dec, "fake-height", &val );
 234         i_height = val.i_int;
 235
 236         if ( i_width && i_height )
 237         {
 238             int i_image_ar = fmt_out.i_width * VOUT_ASPECT_FACTOR
 239                               / fmt_out.i_height;
 240             int i_region_ar = i_width * VOUT_ASPECT_FACTOR / i_height;
 241             fmt_in = fmt_out;
 242
 243             if ( i_aspect == i_image_ar )
 244             {
 245                 fmt_out.i_width = i_width;
 246                 fmt_out.i_height = i_height;
 247             }
 248             else if ( i_image_ar > i_region_ar )
 249             {
 250                 fmt_out.i_width = i_width;
 251                 fmt_out.i_height = i_width * VOUT_ASPECT_FACTOR
 252                                     / i_image_ar;
 253                 i_aspect = i_image_ar;
 254             }
 255             else
 256             {
 257                 fmt_out.i_height = i_height;
 258                 fmt_out.i_width = i_height * i_image_ar
 259                                     / VOUT_ASPECT_FACTOR;
 260                 i_aspect = i_image_ar;
 261             }
 262
 263             p_handler = image_HandlerCreate( p_dec );
 264             p_image = image_Convert( p_handler, p_old, &fmt_in, &fmt_out );
 265             image_HandlerDelete( p_handler );
 266
 267             if ( p_image == NULL )
 268             {
 269                 msg_Warn( p_dec, "couldn't load resizing module" );
 270                 p_image = p_old;
 271                 fmt_out = fmt_in;
 272             }
 273             else
 274             {
 275                 picture_Release( p_old );
 276             }
 277         }
 278     }
 279
 280     if ( i_aspect )
 281     {
 282         fmt_out.i_aspect = i_aspect;
 283     }
 284     else
 285     {
 286         fmt_out.i_aspect = fmt_out.i_width
 287                             * VOUT_ASPECT_FACTOR / fmt_out.i_height;
 288     }
 289
 290     var_Create( p_dec, "fake-deinterlace", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 291     var_Get( p_dec, "fake-deinterlace", &val );
 292     if ( val.b_bool )
 293     {
 294         picture_t *p_old = p_image;
 295
 296         var_Create( p_dec, "fake-deinterlace-module",
 297                     VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 298         var_Get( p_dec, "fake-deinterlace-module", &val );
 299
 300         p_handler = image_HandlerCreate( p_dec );
 301         p_image = image_Filter( p_handler, p_old, &fmt_out, val.psz_string );
 302         image_HandlerDelete( p_handler );
 303         free( val.psz_string );
 304
 305         if ( p_image == NULL )
 306         {
 307             msg_Warn( p_dec, "couldn't load deinterlace module" );
 308             p_image = p_old;
 309         }
 310         else
 311         {
 312             picture_Release( p_old );
 313         }
 314     }
 315
 316     /* Set output properties */
 317     p_dec->fmt_out.i_cat = VIDEO_ES;
 318     p_dec->fmt_out.i_codec = fmt_out.i_chroma;
 319     p_dec->fmt_out.video = fmt_out;
 320
 321     /* Set callbacks */
 322     p_dec->pf_decode_video = DecodeBlock;
 323
 324     p_dec->p_sys->p_image = p_image;
 325     vlc_mutex_init( &p_dec->p_sys->lock );
 326
 327     return VLC_SUCCESS;
 328 }
 329
 330 /****************************************************************************
 331  * DecodeBlock: the whole thing
 332  ****************************************************************************/
 333 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 334 {
 335     decoder_sys_t *p_sys = (decoder_sys_t*) p_dec->p_sys;
 336     picture_t *p_pic;
 337
 338     if( pp_block == NULL || !*pp_block ) return NULL;
 339     p_pic = decoder_NewPicture( p_dec );
 340     if( p_pic == NULL )
 341     {
 342         msg_Err( p_dec, "cannot get picture" );
 343         goto error;
 344     }
 345
 346     if( p_sys->b_reload && (mdate() >= p_sys->i_next) )
 347     {
 348         var_TriggerCallback( p_dec, "fake-file" );
 349         /* next period */
 350         p_sys->i_next = (mtime_t)(p_sys->i_reload + mdate());
 351     }
 352     vlc_mutex_lock( &p_dec->p_sys->lock );
 353     picture_Copy( p_pic, p_dec->p_sys->p_image );
 354     vlc_mutex_unlock( &p_dec->p_sys->lock );
 355
 356     p_pic->date = (*pp_block)->i_pts;
 357
 358 error:
 359     block_Release( *pp_block );
 360     *pp_block = NULL;
 361
 362     return p_pic;
 363 }
 364
 365 /*****************************************************************************
 366  * CloseDecoder: fake decoder destruction
 367  *****************************************************************************/
 368 static void CloseDecoder( vlc_object_t *p_this )
 369 {
 370     decoder_t *p_dec = (decoder_t *)p_this;
 371     picture_t *p_image = p_dec->p_sys->p_image;
 372
 373     if( p_image != NULL )
 374         picture_Release( p_image );
 375
 376     vlc_mutex_destroy( &p_dec->p_sys->lock );
 377     free( p_dec->p_sys );
 378 }
 379
 380 /*****************************************************************************
 381  * FakeCallback: Image source change callback.
 382  *****************************************************************************/
 383 static int FakeCallback( vlc_object_t *p_this, char const *psz_var,
 384                          vlc_value_t oldval, vlc_value_t newval,
 385                          void *p_data )
 386 {
 387     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 388     decoder_t *p_dec = (decoder_t *)p_data;
 389
 390     if( !strcmp( psz_var, "fake-file" ) )
 391     {
 392         image_handler_t *p_handler;
 393         picture_t *p_new_image;
 394         video_format_t fmt_in, fmt_out;
 395         char *psz_file = newval.psz_string;
 396         picture_t *p_image;
 397
 398         vlc_mutex_lock( &p_dec->p_sys->lock );
 399         p_image = p_dec->p_sys->p_image;
 400
 401         if( !psz_file || !*psz_file )
 402         {
 403             msg_Err( p_dec, "fake-file value must be non empty." );
 404             vlc_mutex_unlock( &p_dec->p_sys->lock );
 405             return VLC_EGENERIC;
 406         }
 407         msg_Dbg( p_dec, "Changing fake-file to %s.", psz_file );
 408
 409         memset( &fmt_in, 0, sizeof(fmt_in) );
 410         fmt_out = p_dec->fmt_out.video;
 411         p_handler = image_HandlerCreate( p_dec );
 412         p_new_image = image_ReadUrl( p_handler, psz_file, &fmt_in, &fmt_out );
 413         image_HandlerDelete( p_handler );
 414
 415         if( !p_new_image )
 416         {
 417             msg_Err( p_dec, "error while reading image (%s)", psz_file );
 418             vlc_mutex_unlock( &p_dec->p_sys->lock );
 419             return VLC_EGENERIC;
 420         }
 421
 422         p_dec->p_sys->p_image = p_new_image;
 423         picture_Release( p_image );
 424         vlc_mutex_unlock( &p_dec->p_sys->lock );
 425     }
 426     else if( !strcmp( psz_var, "fake-file-reload" ) )
 427     {
 428         if( newval.i_int > 0)
 429         {
 430             p_dec->p_sys->b_reload = true;
 431             p_dec->p_sys->i_reload = (mtime_t)(newval.i_int * 1000000);
 432             p_dec->p_sys->i_next   = (mtime_t)(p_dec->p_sys->i_reload + mdate());
 433         }
 434         else
 435         {
 436             p_dec->p_sys->b_reload = false;
 437         }
 438     }
 439
 440     return VLC_SUCCESS;
 441 }