f98bafcecce45befcfba54d670fe232e623fcc8e
[vlc.git] / modules / demux / rawvid.c
1 /*****************************************************************************
2  * rawvid.c : raw video input module for vlc
3  *****************************************************************************
4  * Copyright (C) 2007 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *          Antoine Cellerier <dionoea at videolan d.t org>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * 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_demux.h>
36 #include <assert.h>
37
38 /*****************************************************************************
39  * Module descriptor
40  *****************************************************************************/
41 static int  Open ( vlc_object_t * );
42 static void Close( vlc_object_t * );
43
44 #define FPS_TEXT N_("Frames per Second")
45 #define FPS_LONGTEXT N_("This is the desired frame rate when " \
46     "playing raw video streams. In the form 30000/1001 or 29.97")
47
48 #define WIDTH_TEXT N_("Width")
49 #define WIDTH_LONGTEXT N_("This specifies the width in pixels of the raw " \
50     "video stream.")
51
52 #define HEIGHT_TEXT N_("Height")
53 #define HEIGHT_LONGTEXT N_("This specifies the height in pixels of the raw " \
54     "video stream.")
55
56 #define CHROMA_TEXT N_("Force chroma (Use carefully)")
57 #define CHROMA_LONGTEXT N_("Force chroma. This is a four character string.")
58
59 #define ASPECT_RATIO_TEXT N_("Aspect ratio")
60 #define ASPECT_RATIO_LONGTEXT N_( \
61     "Aspect ratio (4:3, 16:9). Default assumes square pixels." )
62
63 vlc_module_begin ()
64     set_shortname( "Raw Video" )
65     set_description( N_("Raw video demuxer") )
66     set_capability( "demux", 10 )
67     set_category( CAT_INPUT )
68     set_subcategory( SUBCAT_INPUT_DEMUX )
69     set_callbacks( Open, Close )
70     add_shortcut( "rawvideo" )
71     add_string( "rawvid-fps", NULL, FPS_TEXT, FPS_LONGTEXT, false )
72     add_integer( "rawvid-width", 0, WIDTH_TEXT, WIDTH_LONGTEXT, 0 )
73     add_integer( "rawvid-height", 0, HEIGHT_TEXT, HEIGHT_LONGTEXT, 0 )
74     add_string( "rawvid-chroma", NULL, CHROMA_TEXT, CHROMA_LONGTEXT,
75                 true )
76     add_string( "rawvid-aspect-ratio", NULL,
77                 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, true )
78 vlc_module_end ()
79
80 /*****************************************************************************
81  * Definitions of structures used by this plugin
82  *****************************************************************************/
83 struct demux_sys_t
84 {
85     int    frame_size;
86
87     es_out_id_t *p_es_video;
88     es_format_t  fmt_video;
89
90     date_t pcr;
91
92     bool b_y4m;
93 };
94
95 /*****************************************************************************
96  * Local prototypes
97  *****************************************************************************/
98 static int Demux( demux_t * );
99 static int Control( demux_t *, int i_query, va_list args );
100
101 struct preset_t
102 {
103     const char *psz_ext;
104     int i_width;
105     int i_height;
106     unsigned u_fps_num;
107     unsigned u_fps_den;
108     unsigned u_ar_num;
109     unsigned u_ar_den;
110     vlc_fourcc_t i_chroma;
111 };
112
113 static const struct preset_t p_presets[] =
114 {
115     { "sqcif", 128, 96, 30000, 1001, 4,3, VLC_CODEC_YV12 },
116     { "qcif", 176, 144, 30000, 1001, 4,3, VLC_CODEC_YV12 },
117     { "cif", 352, 288, 30000, 1001, 4,3, VLC_CODEC_YV12 },
118     { "4cif", 704, 576, 30000, 1001, 4,3, VLC_CODEC_YV12 },
119     { "16cif", 1408, 1152, 30000, 1001, 4,3, VLC_CODEC_YV12 },
120     { "yuv", 176, 144, 25, 1, 4,3, VLC_CODEC_YV12 },
121     { NULL, 0, 0, 0, 0, 0,0, 0 }
122 };
123
124 /*****************************************************************************
125  * Open: initializes raw DV demux structures
126  *****************************************************************************/
127 static int Open( vlc_object_t * p_this )
128 {
129     demux_t     *p_demux = (demux_t*)p_this;
130     demux_sys_t *p_sys;
131     int i_width=-1, i_height=-1;
132     unsigned u_fps_num=0, u_fps_den=1;
133     vlc_fourcc_t i_chroma = 0;
134     unsigned int i_sar_num = 0;
135     unsigned int i_sar_den = 0;
136     const struct preset_t *p_preset = NULL;
137     const uint8_t *p_peek;
138     bool b_y4m = false;
139
140     if( stream_Peek( p_demux->s, &p_peek, 9 ) == 9 )
141     {
142         /* http://wiki.multimedia.cx/index.php?title=YUV4MPEG2 */
143         if( !strncmp( (char *)p_peek, "YUV4MPEG2", 9 ) )
144         {
145             b_y4m = true;
146             goto valid;
147         }
148     }
149
150     if( !p_demux->b_force )
151     {
152         /* guess preset based on file extension */
153         if( !p_demux->psz_file )
154             return VLC_EGENERIC;
155
156         const char *psz_ext = strrchr( p_demux->psz_file, '.' );
157         if( !psz_ext )
158             return VLC_EGENERIC;
159         psz_ext++;
160
161         for( unsigned i = 0; p_presets[i].psz_ext ; i++ )
162         {
163             if( !strcasecmp( psz_ext, p_presets[i].psz_ext ) )
164             {
165                 p_preset = &p_presets[i];
166                 goto valid;
167             }
168         }
169         return VLC_EGENERIC;
170     }
171 valid:
172     p_demux->p_sys      = p_sys = malloc( sizeof( demux_sys_t ) );
173     if( !p_sys )
174         return VLC_ENOMEM;
175
176     p_sys->b_y4m = b_y4m;
177
178     /* guess the parameters based on the preset */
179     if( p_preset )
180     {
181         i_width = p_preset->i_width;
182         i_height = p_preset->i_height;
183         u_fps_num = p_preset->u_fps_num;
184         u_fps_den = p_preset->u_fps_den;
185         i_sar_num = p_preset->u_ar_num * p_preset->i_height;
186         i_sar_den = p_preset->u_ar_den * p_preset->i_width;
187         i_chroma = p_preset->i_chroma;
188     }
189
190     /* override presets if yuv4mpeg2 */
191     if( b_y4m )
192     {
193         char *psz = stream_ReadLine( p_demux->s );
194         char *psz_buf;
195         int a = 1;
196         int b = 1;
197
198         /* The string will start with "YUV4MPEG2" */
199         assert( strlen(psz) >= 9 );
200
201         /* NB, it is not possible to handle interlaced here, since the
202          * interlaced picture flags are in picture_t not block_t */
203
204 #define READ_FRAC( key, num, den ) do { \
205         psz_buf = strstr( psz+9, key );\
206         if( psz_buf )\
207         {\
208             char *end = strchr( psz_buf+1, ' ' );\
209             char *sep;\
210             if( end ) *end = '\0';\
211             sep = strchr( psz_buf+1, ':' );\
212             if( sep )\
213             {\
214                 *sep = '\0';\
215                 den = atoi( sep+1 );\
216             }\
217             else\
218             {\
219                 den = 1;\
220             }\
221             num = atoi( psz_buf+2 );\
222             if( sep ) *sep = ':';\
223             if( end ) *end = ' ';\
224         } } while(0)
225         READ_FRAC( " W", i_width, a );
226         READ_FRAC( " H", i_height, a );
227         READ_FRAC( " F", u_fps_num, u_fps_den );
228         READ_FRAC( " A", a, b );
229 #undef READ_FRAC
230         if( b != 0 )
231         {
232             i_sar_num = a;
233             i_sar_den = b;
234         }
235
236         psz_buf = strstr( psz+9, " C" );
237         if( psz_buf )
238         {
239             static const struct { const char *psz_name; vlc_fourcc_t i_fcc; } formats[] =
240             {
241                 { "420jpeg",    VLC_CODEC_I420 },
242                 { "420paldv",   VLC_CODEC_I420 },
243                 { "420",        VLC_CODEC_I420 },
244                 { "422",        VLC_CODEC_I422 },
245                 { "444",        VLC_CODEC_I444 },
246                 { "mono",       VLC_CODEC_GREY },
247                 { NULL, 0 }
248             };
249             bool b_found = false;
250             char *psz_end = strchr( psz_buf+1, ' ' );
251             if( psz_end )
252                 *psz_end = '\0';
253             psz_buf += 2;
254
255             for( int i = 0; formats[i].psz_name != NULL; i++ )
256             {
257                 if( !strncmp( psz_buf, formats[i].psz_name, strlen(formats[i].psz_name) ) )
258                 {
259                     i_chroma = formats[i].i_fcc;
260                     b_found = true;
261                     break;
262                 }
263             }
264             if( !b_found )
265                 msg_Warn( p_demux, "Unknown YUV4MPEG2 chroma type \"%s\"", psz_buf );
266             if( psz_end )
267                 *psz_end = ' ';
268         }
269
270         free( psz );
271     }
272
273     /* allow the user to override anything guessed from the input */
274     int i_tmp;
275     i_tmp = var_CreateGetInteger( p_demux, "rawvid-width" );
276     if( i_tmp ) i_width = i_tmp;
277
278     i_tmp = var_CreateGetInteger( p_demux, "rawvid-height" );
279     if( i_tmp ) i_height = i_tmp;
280
281     char *psz_tmp;
282     psz_tmp = var_CreateGetNonEmptyString( p_demux, "rawvid-chroma" );
283     if( psz_tmp )
284     {
285         if( strlen( psz_tmp ) != 4 )
286         {
287             msg_Err( p_demux, "Invalid fourcc format/chroma specification %s"
288                      " expecting four characters eg, UYVY", psz_tmp );
289             free( psz_tmp );
290             goto error;
291         }
292         memcpy( &i_chroma, psz_tmp, 4 );
293         msg_Dbg( p_demux, "Forcing chroma to 0x%.8x (%4.4s)", i_chroma, (char*)&i_chroma );
294         free( psz_tmp );
295     }
296
297     psz_tmp = var_CreateGetNonEmptyString( p_demux, "rawvid-fps" );
298     if( psz_tmp )
299     {
300         char *p_ptr;
301         /* fps can either be n/d or q.f
302          * for accuracy, avoid representation in float */
303         u_fps_num = strtol( psz_tmp, &p_ptr, 10 );
304         if( *p_ptr == '/' )
305         {
306             p_ptr++;
307             u_fps_den = strtol( p_ptr, NULL, 10 );
308         }
309         else if( *p_ptr == '.' )
310         {
311             char *p_end;
312             p_ptr++;
313             int i_frac =  strtol( p_ptr, &p_end, 10 );
314             u_fps_den = (p_end - p_ptr) * 10;
315             if( !u_fps_den )
316                 u_fps_den = 1;
317             u_fps_num = u_fps_num * u_fps_den + i_frac;
318         }
319         else if( *p_ptr == '\0')
320         {
321             u_fps_den = 1;
322         }
323         free( psz_tmp );
324     }
325
326     psz_tmp = var_CreateGetNonEmptyString( p_demux, "rawvid-aspect-ratio" );
327     if( psz_tmp )
328     {
329         char *psz_denominator = strchr( psz_tmp, ':' );
330         if( psz_denominator )
331         {
332             *psz_denominator++ = '\0';
333             i_sar_num = atoi( psz_tmp )         * i_height;
334             i_sar_den = atoi( psz_denominator ) * i_width;
335         }
336         free( psz_tmp );
337     }
338
339     /* moan about anything wrong */
340     if( i_width <= 0 || i_height <= 0 )
341     {
342         msg_Err( p_demux, "width and height must be strictly positive." );
343         goto error;
344     }
345
346     if( !u_fps_num || !u_fps_den )
347     {
348         msg_Err( p_demux, "invalid or no framerate specified." );
349         goto error;
350     }
351
352     if( i_chroma == 0 )
353     {
354         msg_Err( p_demux, "invalid or no chroma specified." );
355         goto error;
356     }
357
358     /* fixup anything missing with sensible assumptions */
359     if( i_sar_num <= 0 || i_sar_den <= 0 )
360     {
361         /* assume 1:1 sar */
362         i_sar_num = 1;
363         i_sar_den = 1;
364     }
365
366     es_format_Init( &p_sys->fmt_video, VIDEO_ES, i_chroma );
367     video_format_Setup( &p_sys->fmt_video.video, i_chroma,
368                         i_width, i_height, i_width, i_height,
369                         i_sar_num, i_sar_den );
370
371     vlc_ureduce( &p_sys->fmt_video.video.i_frame_rate,
372                  &p_sys->fmt_video.video.i_frame_rate_base,
373                  u_fps_num, u_fps_den, 0);
374     date_Init( &p_sys->pcr, p_sys->fmt_video.video.i_frame_rate,
375                p_sys->fmt_video.video.i_frame_rate_base );
376     date_Set( &p_sys->pcr, 0 );
377
378     if( !p_sys->fmt_video.video.i_bits_per_pixel )
379     {
380         msg_Err( p_demux, "Unsupported chroma 0x%.8x (%4.4s)", i_chroma,
381                  (char*)&i_chroma );
382         goto error;
383     }
384     p_sys->frame_size = i_width * i_height
385                         * p_sys->fmt_video.video.i_bits_per_pixel / 8;
386     p_sys->p_es_video = es_out_Add( p_demux->out, &p_sys->fmt_video );
387
388     p_demux->pf_demux   = Demux;
389     p_demux->pf_control = Control;
390     return VLC_SUCCESS;
391
392 error:
393     stream_Seek( p_demux->s, 0 ); // Workaround, but y4m uses stream_ReadLines
394     free( p_sys );
395     return VLC_EGENERIC;
396 }
397
398 /*****************************************************************************
399  * Close: frees unused data
400  *****************************************************************************/
401 static void Close( vlc_object_t *p_this )
402 {
403     demux_t     *p_demux = (demux_t*)p_this;
404     demux_sys_t *p_sys  = p_demux->p_sys;
405     free( p_sys );
406 }
407
408 /*****************************************************************************
409  * Demux: reads and demuxes data packets
410  *****************************************************************************
411  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
412  *****************************************************************************/
413 static int Demux( demux_t *p_demux )
414 {
415     demux_sys_t *p_sys  = p_demux->p_sys;
416     block_t     *p_block;
417     mtime_t i_pcr = date_Get( &p_sys->pcr );
418
419     /* Call the pace control */
420     es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + i_pcr );
421
422     if( p_sys->b_y4m )
423     {
424         /* Skip the frame header */
425         /* Skip "FRAME" */
426         if( stream_Read( p_demux->s, NULL, 5 ) < 5 )
427             return 0;
428         /* Find \n */
429         for( ;; )
430         {
431             uint8_t b;
432             if( stream_Read( p_demux->s, &b, 1 ) < 1 )
433                 return 0;
434             if( b == 0x0a )
435                 break;
436         }
437     }
438
439     if( ( p_block = stream_Block( p_demux->s, p_sys->frame_size ) ) == NULL )
440     {
441         /* EOF */
442         return 0;
443     }
444
445     p_block->i_dts = p_block->i_pts = VLC_TS_0 + i_pcr;
446     es_out_Send( p_demux->out, p_sys->p_es_video, p_block );
447
448     date_Increment( &p_sys->pcr, 1 );
449
450     return 1;
451 }
452
453 /*****************************************************************************
454  * Control:
455  *****************************************************************************/
456 static int Control( demux_t *p_demux, int i_query, va_list args )
457 {
458     demux_sys_t *p_sys  = p_demux->p_sys;
459
460      /* (2**31)-1 is insufficient to store 1080p50 4:4:4. */
461     const int64_t i_bps = 8LL * p_sys->frame_size * p_sys->pcr.i_divider_num /
462                                                     p_sys->pcr.i_divider_den;
463
464     /* XXX: DEMUX_SET_TIME is precise here */
465     return demux_vaControlHelper( p_demux->s, 0, -1, i_bps,
466                                    p_sys->frame_size, i_query, args );
467 }
468