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