git.sesse.net Git - vlc/blob - modules/demux/mjpeg.c

   1 /*****************************************************************************
   2  * mjpeg.c : demuxes mjpeg webcam http streams
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Henry Jen (slowhog) <henryjen@ztune.net>
   8  *          Derk-Jan Hartman (thedj)
   9  *          Sigmund Augdal (Dnumgis)
  10  *          Laurent Aimar <fenrir@via.ecp.fr>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30
  31 #include <vlc/vlc.h>
  32 #include <vlc_demux.h>
  33
  34 #include <vlc_codecs.h>
  35
  36 /*****************************************************************************
  37  * Module descriptor
  38  *****************************************************************************/
  39 static int  Open ( vlc_object_t * );
  40 static void Close( vlc_object_t * );
  41
  42 #define FPS_TEXT N_("Frames per Second")
  43 #define FPS_LONGTEXT N_("This is the desired frame rate when " \
  44     "playing MJPEG from a file. Use 0 (this is the default value) for a " \
  45     "live stream (from a camera).")
  46
  47 vlc_module_begin();
  48     set_shortname( "MJPEG");
  49     set_description( _("M-JPEG camera demuxer") );
  50     set_capability( "demux2", 5 );
  51     set_callbacks( Open, Close );
  52     set_category( CAT_INPUT );
  53     set_subcategory( SUBCAT_INPUT_DEMUX );
  54     add_float( "mjpeg-fps", 0.0, NULL, FPS_TEXT, FPS_LONGTEXT, VLC_FALSE );
  55 vlc_module_end();
  56
  57 /*****************************************************************************
  58  * Local prototypes
  59  *****************************************************************************/
  60 static int MimeDemux( demux_t * );
  61 static int MjpgDemux( demux_t * );
  62 static int Control( demux_t *, int i_query, va_list args );
  63
  64 struct demux_sys_t
  65 {
  66     es_format_t     fmt;
  67     es_out_id_t     *p_es;
  68
  69     vlc_bool_t      b_still;
  70     mtime_t         i_still_end;
  71     mtime_t         i_still_length;
  72
  73     mtime_t         i_time;
  74     mtime_t         i_frame_length;
  75     char            *psz_separator;
  76     int             i_frame_size_estimate;
  77     const uint8_t   *p_peek;
  78     int             i_data_peeked;
  79 };
  80
  81 /*****************************************************************************
  82  * Peek: Helper function to peek data with incremental size.
  83  * \return VLC_FALSE if peek no more data, VLC_TRUE otherwise.
  84  *****************************************************************************/
  85 static vlc_bool_t Peek( demux_t *p_demux, vlc_bool_t b_first )
  86 {
  87     int i_data;
  88     demux_sys_t *p_sys = p_demux->p_sys;
  89
  90     if( b_first )
  91     {
  92         p_sys->i_data_peeked = 0;
  93     }
  94     else if( p_sys->i_data_peeked == p_sys->i_frame_size_estimate )
  95     {
  96         p_sys->i_frame_size_estimate += 5120;
  97     }
  98     i_data = stream_Peek( p_demux->s, &p_sys->p_peek,
  99                           p_sys->i_frame_size_estimate );
 100     if( i_data == p_sys->i_data_peeked )
 101     {
 102         msg_Warn( p_demux, "no more data" );
 103         return VLC_FALSE;
 104     }
 105     p_sys->i_data_peeked = i_data;
 106     if( i_data <= 0 )
 107     {
 108         msg_Warn( p_demux, "cannot peek data" );
 109         return VLC_FALSE;
 110     }
 111     return VLC_TRUE;
 112 }
 113
 114 /*****************************************************************************
 115  * GetLine: Internal function used to dup a line of string from the buffer
 116  *****************************************************************************/
 117 static char* GetLine( demux_t *p_demux, int *p_pos )
 118 {
 119     demux_sys_t *p_sys = p_demux->p_sys;
 120     const uint8_t *p_buf;
 121     int         i_size;
 122     int         i;
 123     char        *p_line;
 124
 125     while( *p_pos > p_sys->i_data_peeked )
 126     {
 127         if( ! Peek( p_demux, VLC_FALSE ) )
 128         {
 129             return NULL;
 130         }
 131     }
 132     p_buf = p_sys->p_peek + *p_pos;
 133     i_size = p_sys->i_data_peeked - *p_pos;
 134     i = 0;
 135     while( p_buf[i] != '\n' )
 136     {
 137         i++;
 138         if( i == i_size )
 139         {
 140             if( ! Peek( p_demux, VLC_FALSE ) )
 141             {
 142                 return NULL;
 143             }
 144         }
 145         p_buf = p_sys->p_peek + *p_pos;
 146         i_size = p_sys->i_data_peeked - *p_pos;
 147     }
 148     *p_pos += ( i + 1 );
 149     if( i > 0 && '\r' == p_buf[i - 1] )
 150     {
 151         i--;
 152     }
 153     p_line = malloc( i + 1 );
 154     if( NULL == p_line )
 155     {
 156         msg_Err( p_demux, "out of memory" );
 157         return NULL;
 158     }
 159     strncpy ( p_line, (char*)p_buf, i );
 160     p_line[i] = '\0';
 161 //    msg_Dbg( p_demux, "i = %d, pos = %d, %s", i, *p_pos, p_line );
 162     return p_line;
 163 }
 164
 165 /*****************************************************************************
 166  * CheckMimeHeader: Internal function used to verify and skip mime header
 167  * \param p_header_size Return size of MIME header, 0 if no MIME header
 168  * detected, minus value if error
 169  * \return VLC_TRUE if content type is image/jpeg, VLC_FALSE otherwise
 170  *****************************************************************************/
 171 static vlc_bool_t CheckMimeHeader( demux_t *p_demux, int *p_header_size )
 172 {
 173     vlc_bool_t  b_jpeg = VLC_FALSE;
 174     int         i_pos;
 175     char        *psz_line;
 176     char        *p_ch;
 177     demux_sys_t *p_sys = p_demux->p_sys;
 178
 179     if( !Peek( p_demux, VLC_TRUE ) )
 180     {
 181         msg_Err( p_demux, "cannot peek" );
 182         *p_header_size = -1;
 183         return VLC_FALSE;
 184     }
 185     if( p_sys->i_data_peeked < 3)
 186     {
 187         msg_Err( p_demux, "data shortage" );
 188         *p_header_size = -2;
 189         return VLC_FALSE;
 190     }
 191     if( strncmp( (char *)p_sys->p_peek, "--", 2 ) )
 192     {
 193         *p_header_size = 0;
 194         return VLC_FALSE;
 195     }
 196     i_pos = 2;
 197     psz_line = GetLine( p_demux, &i_pos );
 198     if( NULL == psz_line )
 199     {
 200         msg_Err( p_demux, "no EOL" );
 201         *p_header_size = -3;
 202         return VLC_FALSE;
 203     }
 204
 205     /* Read the separator and remember it if not yet stored */
 206     if( p_sys->psz_separator == NULL )
 207     {
 208         p_sys->psz_separator = psz_line;
 209         msg_Dbg( p_demux, "Multipart MIME detected, using separator: %s",
 210                  p_sys->psz_separator );
 211     }
 212     else
 213     {
 214         if( strcmp( psz_line, p_sys->psz_separator ) )
 215         {
 216             msg_Warn( p_demux, "separator %s does not match %s", psz_line,
 217                       p_sys->psz_separator );
 218         }
 219         free( psz_line );
 220     }
 221
 222     psz_line = GetLine( p_demux, &i_pos );
 223     while( psz_line && *psz_line )
 224     {
 225         if( !strncasecmp( psz_line, "Content-Type:", 13 ) )
 226         {
 227             p_ch = psz_line + 13;
 228             while( *p_ch != '\0' && ( *p_ch == ' ' || *p_ch == '\t' ) ) p_ch++;
 229             if( strncasecmp( p_ch, "image/jpeg", 10 ) )
 230             {
 231                 msg_Warn( p_demux, "%s, image/jpeg is expected", psz_line );
 232                 b_jpeg = VLC_FALSE;
 233             }
 234             else
 235             {
 236                 b_jpeg = VLC_TRUE;
 237             }
 238         }
 239         else
 240         {
 241             msg_Dbg( p_demux, "discard MIME header: %s", psz_line );
 242         }
 243         free( psz_line );
 244         psz_line = GetLine( p_demux, &i_pos );
 245     }
 246
 247     if( NULL == psz_line )
 248     {
 249         msg_Err( p_demux, "no EOL" );
 250         *p_header_size = -3;
 251         return VLC_FALSE;
 252     }
 253
 254     free( psz_line );
 255
 256     *p_header_size = i_pos;
 257     return b_jpeg;
 258 }
 259
 260 static int SendBlock( demux_t *p_demux, int i )
 261 {
 262     demux_sys_t *p_sys = p_demux->p_sys;
 263     block_t     *p_block;
 264
 265     if( ( p_block = stream_Block( p_demux->s, i ) ) == NULL )
 266     {
 267         msg_Warn( p_demux, "cannot read data" );
 268         return 0;
 269     }
 270
 271     if( !p_sys->i_frame_length || !p_sys->i_time )
 272     {
 273         p_sys->i_time = p_block->i_dts = p_block->i_pts = mdate();
 274     }
 275     else
 276     {
 277         p_block->i_dts = p_block->i_pts = p_sys->i_time;
 278         p_sys->i_time += p_sys->i_frame_length;
 279     }
 280
 281     /* set PCR */
 282     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
 283     es_out_Send( p_demux->out, p_sys->p_es, p_block );
 284
 285     if( p_sys->b_still )
 286     {
 287         p_sys->i_still_end = mdate() + p_sys->i_still_length;
 288     }
 289
 290     return 1;
 291 }
 292
 293 /*****************************************************************************
 294  * Open: check file and initializes structures
 295  *****************************************************************************/
 296 static int Open( vlc_object_t * p_this )
 297 {
 298     demux_t     *p_demux = (demux_t*)p_this;
 299     demux_sys_t *p_sys;
 300     int         i_size;
 301     int         b_matched = VLC_FALSE;
 302     vlc_value_t val;
 303
 304     p_demux->pf_control = Control;
 305     p_demux->p_sys      = p_sys = malloc( sizeof( demux_sys_t ) );
 306     p_sys->p_es         = NULL;
 307     p_sys->i_time       = 0;
 308
 309     p_sys->psz_separator = NULL;
 310     p_sys->i_frame_size_estimate = 15 * 1024;
 311
 312     b_matched = CheckMimeHeader( p_demux, &i_size);
 313     if( b_matched )
 314     {
 315         p_demux->pf_demux = MimeDemux;
 316         stream_Read( p_demux->s, NULL, i_size );
 317     }
 318     else if( 0 == i_size )
 319     {
 320         /* 0xffd8 identify a JPEG SOI */
 321         if( p_sys->p_peek[0] == 0xFF && p_sys->p_peek[1] == 0xD8 )
 322         {
 323             msg_Dbg( p_demux, "JPEG SOI marker detected" );
 324             p_demux->pf_demux = MjpgDemux;
 325         }
 326         else
 327         {
 328             goto error;
 329         }
 330     }
 331     else
 332     {
 333         goto error;
 334     }
 335
 336
 337     var_Create( p_demux, "mjpeg-fps", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 338     var_Get( p_demux, "mjpeg-fps", &val );
 339     p_sys->i_frame_length = 0;
 340
 341     /* Check for jpeg file extension */
 342     p_sys->b_still = VLC_FALSE;
 343     p_sys->i_still_end = 0;
 344     if( demux2_IsPathExtension( p_demux, ".jpeg" ) ||
 345         demux2_IsPathExtension( p_demux, ".jpg" ) )
 346     {
 347         p_sys->b_still = VLC_TRUE;
 348         if( val.f_float)
 349         {
 350             p_sys->i_still_length =1000000.0 / val.f_float;
 351         }
 352         else
 353         {
 354             /* Defaults to 1fps */
 355             p_sys->i_still_length = 1000000;
 356         }
 357     }
 358     else if ( val.f_float )
 359     {
 360         p_sys->i_frame_length = 1000000.0 / val.f_float;
 361     }
 362
 363     es_format_Init( &p_sys->fmt, VIDEO_ES, 0 );
 364     p_sys->fmt.i_codec = VLC_FOURCC('m','j','p','g');
 365
 366     p_sys->p_es = es_out_Add( p_demux->out, &p_sys->fmt );
 367     return VLC_SUCCESS;
 368
 369 error:
 370     free( p_sys );
 371     return VLC_EGENERIC;
 372 }
 373
 374 /*****************************************************************************
 375  * Demux: read packet and send them to decoders
 376  *****************************************************************************
 377  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 378  *****************************************************************************/
 379 static int MjpgDemux( demux_t *p_demux )
 380 {
 381     demux_sys_t *p_sys = p_demux->p_sys;
 382     int i;
 383
 384     if( p_sys->b_still && p_sys->i_still_end && p_sys->i_still_end < mdate() )
 385     {
 386         /* Still frame, wait until the pause delay is gone */
 387         p_sys->i_still_end = 0;
 388     }
 389     else if( p_sys->b_still && p_sys->i_still_end )
 390     {
 391         msleep( 400 );
 392         return 1;
 393     }
 394
 395     if( !Peek( p_demux, VLC_TRUE ) )
 396     {
 397         msg_Warn( p_demux, "cannot peek data" );
 398         return 0;
 399     }
 400     if( p_sys->i_data_peeked < 4 )
 401     {
 402         msg_Warn( p_demux, "data shortage" );
 403         return 0;
 404     }
 405     i = 3;
 406     while( !( 0xFF == p_sys->p_peek[i-1] && 0xD9 == p_sys->p_peek[i] ) )
 407     {
 408         i++;
 409         if( i >= p_sys->i_data_peeked )
 410         {
 411             msg_Dbg( p_demux, "did not find JPEG EOI in %d bytes",
 412                      p_sys->i_data_peeked );
 413             if( !Peek( p_demux, VLC_FALSE ) )
 414             {
 415                 msg_Warn( p_demux, "no more data is available at the moment" );
 416                 return 0;
 417             }
 418         }
 419     }
 420     i++;
 421
 422     msg_Dbg( p_demux, "JPEG EOI detected at %d", i );
 423     return SendBlock( p_demux, i );
 424 }
 425
 426 static int MimeDemux( demux_t *p_demux )
 427 {
 428     demux_sys_t *p_sys = p_demux->p_sys;
 429     int         i_size, i;
 430     vlc_bool_t  b_match;
 431     vlc_bool_t  b_done;
 432
 433     b_match = CheckMimeHeader( p_demux, &i_size );
 434     if( i_size > 0 )
 435     {
 436         stream_Read( p_demux->s, NULL, i_size );
 437     }
 438     else if( i_size < 0 )
 439     {
 440         return 0;
 441     }
 442     else
 443     {
 444         // No MIME header, assume OK
 445         b_match = VLC_TRUE;
 446     }
 447
 448     if( !Peek( p_demux, VLC_TRUE ) )
 449     {
 450         msg_Warn( p_demux, "cannot peek data" );
 451         return 0;
 452     }
 453     i = 0;
 454     i_size = strlen( p_sys->psz_separator ) + 2;
 455     if( p_sys->i_data_peeked < i_size )
 456     {
 457         msg_Warn( p_demux, "data shortage" );
 458         return 0;
 459     }
 460     b_done = VLC_FALSE;
 461     while( !b_done )
 462     {
 463         while( !( p_sys->p_peek[i] == '-' && p_sys->p_peek[i+1] == '-' ) )
 464         {
 465             i++;
 466             i_size++;
 467             if( i_size >= p_sys->i_data_peeked )
 468             {
 469                 msg_Dbg( p_demux, "MIME boundary not found in %d bytes of "
 470                          "data", p_sys->i_data_peeked );
 471
 472                 if( !Peek( p_demux, VLC_FALSE ) )
 473                 {
 474                     msg_Warn( p_demux, "no more data is available at the "
 475                               "moment" );
 476                     return 0;
 477                 }
 478             }
 479         }
 480         if( !strncmp( p_sys->psz_separator, (char *)(p_sys->p_peek + i + 2),
 481                       strlen( p_sys->psz_separator ) ) )
 482         {
 483             b_done = VLC_TRUE;
 484         }
 485         else
 486         {
 487             i++;
 488             i_size++;
 489         }
 490     }
 491
 492     if( !b_match )
 493     {
 494         msg_Err( p_demux, "discard non-JPEG part" );
 495         stream_Read( p_demux->s, NULL, i );
 496         return 0;
 497     }
 498
 499     return SendBlock( p_demux, i );
 500 }
 501
 502 /*****************************************************************************
 503  * Close: frees unused data
 504  *****************************************************************************/
 505 static void Close ( vlc_object_t * p_this )
 506 {
 507     demux_t     *p_demux = (demux_t*)p_this;
 508     demux_sys_t *p_sys  = p_demux->p_sys;
 509
 510     if( p_sys->psz_separator )
 511     {
 512         free( p_sys->psz_separator );
 513     }
 514     free( p_sys );
 515 }
 516
 517 /*****************************************************************************
 518  * Control:
 519  *****************************************************************************/
 520 static int Control( demux_t *p_demux, int i_query, va_list args )
 521 {
 522     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 0, i_query, args );
 523 }