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