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, u_fps_den;
 133     vlc_fourcc_t i_chroma = 0;
 134     unsigned int i_sar_num;
 135     unsigned int i_sar_den;
 136     const struct preset_t *p_preset = NULL;
 137     const uint8_t *p_peek;
 138     bool b_y4m = false;
 139
 140     if( vlc_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->obj.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         /* The string should start with "YUV4MPEG2" */
 194         char *psz = vlc_stream_ReadLine( p_demux->s );
 195         char *psz_buf;
 196         int a = 1;
 197         int b = 1;
 198
 199         if( unlikely(psz == NULL) )
 200             goto error;
 201
 202         /* NB, it is not possible to handle interlaced here, since the
 203          * interlaced picture flags are in picture_t not block_t */
 204
 205 #define READ_FRAC( key, num, den ) do { \
 206         psz_buf = strstr( psz+9, key );\
 207         if( psz_buf )\
 208         {\
 209             char *end = strchr( psz_buf+1, ' ' );\
 210             char *sep;\
 211             if( end ) *end = '\0';\
 212             sep = strchr( psz_buf+1, ':' );\
 213             if( sep )\
 214             {\
 215                 *sep = '\0';\
 216                 den = atoi( sep+1 );\
 217             }\
 218             else\
 219             {\
 220                 den = 1;\
 221             }\
 222             num = atoi( psz_buf+2 );\
 223             if( sep ) *sep = ':';\
 224             if( end ) *end = ' ';\
 225         } } while(0)
 226         READ_FRAC( " W", i_width, a );
 227         READ_FRAC( " H", i_height, a );
 228         READ_FRAC( " F", u_fps_num, u_fps_den );
 229         READ_FRAC( " A", a, b );
 230 #undef READ_FRAC
 231         if( b != 0 )
 232         {
 233             i_sar_num = a;
 234             i_sar_den = b;
 235         }
 236
 237         psz_buf = strstr( psz+9, " C" );
 238         if( psz_buf )
 239         {
 240             static const struct { const char *psz_name; vlc_fourcc_t i_fcc; } formats[] =
 241             {
 242                 { "420jpeg",    VLC_CODEC_I420 },
 243                 { "420paldv",   VLC_CODEC_I420 },
 244                 { "420",        VLC_CODEC_I420 },
 245                 { "422",        VLC_CODEC_I422 },
 246                 { "444",        VLC_CODEC_I444 },
 247                 { "mono",       VLC_CODEC_GREY },
 248                 { NULL, 0 }
 249             };
 250             bool b_found = false;
 251             char *psz_end = strchr( psz_buf+1, ' ' );
 252             if( psz_end )
 253                 *psz_end = '\0';
 254             psz_buf += 2;
 255
 256             for( int i = 0; formats[i].psz_name != NULL; i++ )
 257             {
 258                 if( !strncmp( psz_buf, formats[i].psz_name, strlen(formats[i].psz_name) ) )
 259                 {
 260                     i_chroma = formats[i].i_fcc;
 261                     b_found = true;
 262                     break;
 263                 }
 264             }
 265             if( !b_found )
 266                 msg_Warn( p_demux, "Unknown YUV4MPEG2 chroma type \"%s\"", psz_buf );
 267             if( psz_end )
 268                 *psz_end = ' ';
 269         }
 270
 271         free( psz );
 272     }
 273
 274     /* allow the user to override anything guessed from the input */
 275     int i_tmp;
 276     i_tmp = var_CreateGetInteger( p_demux, "rawvid-width" );
 277     if( i_tmp ) i_width = i_tmp;
 278
 279     i_tmp = var_CreateGetInteger( p_demux, "rawvid-height" );
 280     if( i_tmp ) i_height = i_tmp;
 281
 282     char *psz_tmp;
 283     psz_tmp = var_CreateGetNonEmptyString( p_demux, "rawvid-chroma" );
 284     if( psz_tmp )
 285     {
 286         if( strlen( psz_tmp ) != 4 )
 287         {
 288             msg_Err( p_demux, "Invalid fourcc format/chroma specification %s"
 289                      " expecting four characters eg, UYVY", psz_tmp );
 290             free( psz_tmp );
 291             goto error;
 292         }
 293         memcpy( &i_chroma, psz_tmp, 4 );
 294         msg_Dbg( p_demux, "Forcing chroma to 0x%.8x (%4.4s)", i_chroma, (char*)&i_chroma );
 295         free( psz_tmp );
 296     }
 297
 298     if( var_InheritURational( p_demux, &u_fps_num, &u_fps_den, "rawvid-fps" ) )
 299     {
 300         u_fps_num = 0;
 301         u_fps_den = 1;
 302     }
 303
 304     if( var_InheritURational( p_demux, &i_sar_num, &i_sar_den,
 305                               "rawvid-aspect-ratio" ) )
 306         i_sar_num = i_sar_den = 1;
 307
 308     /* moan about anything wrong */
 309     if( i_width <= 0 || i_height <= 0 )
 310     {
 311         msg_Err( p_demux, "width and height must be strictly positive." );
 312         goto error;
 313     }
 314
 315     if( !u_fps_num || !u_fps_den )
 316     {
 317         msg_Err( p_demux, "invalid or no framerate specified." );
 318         goto error;
 319     }
 320
 321     if( i_chroma == 0 )
 322     {
 323         msg_Err( p_demux, "invalid or no chroma specified." );
 324         goto error;
 325     }
 326
 327     /* fixup anything missing with sensible assumptions */
 328     if( i_sar_num <= 0 || i_sar_den <= 0 )
 329     {
 330         /* assume 1:1 sar */
 331         i_sar_num = 1;
 332         i_sar_den = 1;
 333     }
 334
 335     es_format_Init( &p_sys->fmt_video, VIDEO_ES, i_chroma );
 336     video_format_Setup( &p_sys->fmt_video.video, i_chroma,
 337                         i_width, i_height, i_width, i_height,
 338                         i_sar_num, i_sar_den );
 339
 340     vlc_ureduce( &p_sys->fmt_video.video.i_frame_rate,
 341                  &p_sys->fmt_video.video.i_frame_rate_base,
 342                  u_fps_num, u_fps_den, 0);
 343     date_Init( &p_sys->pcr, p_sys->fmt_video.video.i_frame_rate,
 344                p_sys->fmt_video.video.i_frame_rate_base );
 345     date_Set( &p_sys->pcr, 0 );
 346
 347     if( !p_sys->fmt_video.video.i_bits_per_pixel )
 348     {
 349         msg_Err( p_demux, "Unsupported chroma 0x%.8x (%4.4s)", i_chroma,
 350                  (char*)&i_chroma );
 351         goto error;
 352     }
 353     p_sys->frame_size = i_width * i_height
 354                         * p_sys->fmt_video.video.i_bits_per_pixel / 8;
 355     p_sys->p_es_video = es_out_Add( p_demux->out, &p_sys->fmt_video );
 356
 357     p_demux->pf_demux   = Demux;
 358     p_demux->pf_control = Control;
 359     return VLC_SUCCESS;
 360
 361 error:
 362     /* workaround, but y4m uses vlc_stream_ReadLine */
 363     vlc_stream_Seek( p_demux->s, 0 );
 364     free( p_sys );
 365     return VLC_EGENERIC;
 366 }
 367
 368 /*****************************************************************************
 369  * Close: frees unused data
 370  *****************************************************************************/
 371 static void Close( vlc_object_t *p_this )
 372 {
 373     demux_t     *p_demux = (demux_t*)p_this;
 374     demux_sys_t *p_sys  = p_demux->p_sys;
 375     free( p_sys );
 376 }
 377
 378 /*****************************************************************************
 379  * Demux: reads and demuxes data packets
 380  *****************************************************************************
 381  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 382  *****************************************************************************/
 383 static int Demux( demux_t *p_demux )
 384 {
 385     demux_sys_t *p_sys  = p_demux->p_sys;
 386     block_t     *p_block;
 387     mtime_t i_pcr = date_Get( &p_sys->pcr );
 388
 389     /* Call the pace control */
 390     es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + i_pcr );
 391
 392     if( p_sys->b_y4m )
 393     {
 394         /* Skip the frame header */
 395         /* Skip "FRAME" */
 396         if( vlc_stream_Read( p_demux->s, NULL, 5 ) < 5 )
 397             return 0;
 398         /* Find \n */
 399         for( ;; )
 400         {
 401             uint8_t b;
 402             if( vlc_stream_Read( p_demux->s, &b, 1 ) < 1 )
 403                 return 0;
 404             if( b == 0x0a )
 405                 break;
 406         }
 407     }
 408
 409     p_block = vlc_stream_Block( p_demux->s, p_sys->frame_size );
 410     if( p_block == NULL )
 411     {
 412         /* EOF */
 413         return 0;
 414     }
 415
 416     p_block->i_dts = p_block->i_pts = VLC_TS_0 + i_pcr;
 417     es_out_Send( p_demux->out, p_sys->p_es_video, p_block );
 418
 419     date_Increment( &p_sys->pcr, 1 );
 420
 421     return 1;
 422 }
 423
 424 /*****************************************************************************
 425  * Control:
 426  *****************************************************************************/
 427 static int Control( demux_t *p_demux, int i_query, va_list args )
 428 {
 429     demux_sys_t *p_sys  = p_demux->p_sys;
 430
 431      /* (2**31)-1 is insufficient to store 1080p50 4:4:4. */
 432     const int64_t i_bps = 8LL * p_sys->frame_size * p_sys->pcr.i_divider_num /
 433                                                     p_sys->pcr.i_divider_den;
 434
 435     /* XXX: DEMUX_SET_TIME is precise here */
 436     return demux_vaControlHelper( p_demux->s, 0, -1, i_bps,
 437                                    p_sys->frame_size, i_query, args );
 438 }
 439