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