]> git.sesse.net Git - vlc/blob - modules/codec/libmpeg2.c
* include/video.h include/video_output.h src/video_output/vout_pictures.c:
[vlc] / modules / codec / libmpeg2.c
1 /*****************************************************************************
2  * libmpeg2.c: mpeg2 video decoder module making use of libmpeg2.
3  *****************************************************************************
4  * Copyright (C) 1999-2001 VideoLAN
5  * $Id: libmpeg2.c,v 1.20 2003/06/09 00:33:34 massiot Exp $
6  *
7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  * 
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <vlc/vlc.h>
28 #include <vlc/vout.h>
29 #include <vlc/input.h>
30 #include <vlc/decoder.h>
31
32 #include <stdlib.h>                                      /* malloc(), free() */
33 #include <string.h>                                    /* memcpy(), memset() */
34
35 #include <mpeg2dec/mpeg2.h>
36
37 #include "vout_synchro.h"
38
39 /* Aspect ratio (ISO/IEC 13818-2 section 6.3.3, table 6-3) */
40 #define AR_SQUARE_PICTURE       1                           /* square pixels */
41 #define AR_3_4_PICTURE          2                        /* 3:4 picture (TV) */
42 #define AR_16_9_PICTURE         3              /* 16:9 picture (wide screen) */
43 #define AR_221_1_PICTURE        4                  /* 2.21:1 picture (movie) */
44
45 /*****************************************************************************
46  * dec_thread_t : libmpeg2 decoder thread descriptor
47  *****************************************************************************/
48 typedef struct dec_thread_t
49 {
50     /*
51      * libmpeg2 properties
52      */
53     mpeg2dec_t          *p_mpeg2dec;
54     const mpeg2_info_t  *p_info;
55     vlc_bool_t          b_skip;
56
57     /*
58      * Input properties
59      */
60     decoder_fifo_t   *p_fifo;                  /* stores the PES stream data */
61     pes_packet_t     *p_pes;                  /* current PES we are decoding */
62     mtime_t          i_pts;
63     mtime_t          i_previous_pts;
64     mtime_t          i_current_pts;
65     mtime_t          i_period_remainder;
66     int              i_current_rate;
67     picture_t *      p_picture_to_destroy;
68     vlc_bool_t       b_garbage_pic;
69     vlc_bool_t       b_after_sequence_header; /* is it the next frame after
70                                                * the sequence header ?    */
71     vlc_bool_t       b_slice_i;             /* intra-slice refresh stream */
72
73     /*
74      * Output properties
75      */
76     vout_thread_t *p_vout;
77     vout_synchro_t *p_synchro;
78
79 } dec_thread_t;
80
81 /*****************************************************************************
82  * Local prototypes
83  *****************************************************************************/
84 static int  OpenDecoder  ( vlc_object_t * );
85 static int  RunDecoder   ( decoder_fifo_t * );
86 static void CloseDecoder ( dec_thread_t * );
87
88 static picture_t *GetNewPicture( dec_thread_t *, uint8_t ** );
89
90 /*****************************************************************************
91  * Module descriptor
92  *****************************************************************************/
93 vlc_module_begin();
94     set_description( _("MPEG I/II video decoder (using libmpeg2)") );
95     set_capability( "decoder", 40 );
96     set_callbacks( OpenDecoder, NULL );
97     add_shortcut( "libmpeg2" );
98 vlc_module_end();
99
100 /*****************************************************************************
101  * OpenDecoder: probe the decoder and return score
102  *****************************************************************************/
103 static int OpenDecoder( vlc_object_t *p_this )
104 {
105     decoder_fifo_t *p_fifo = (decoder_fifo_t*) p_this;
106
107     if( p_fifo->i_fourcc != VLC_FOURCC('m','p','g','v') )
108     {
109         return VLC_EGENERIC;
110     }
111
112     p_fifo->pf_run = RunDecoder;
113     return VLC_SUCCESS;
114 }
115
116 /*****************************************************************************
117  * RunDecoder: the libmpeg2 decoder
118  *****************************************************************************/
119 static int RunDecoder( decoder_fifo_t *p_fifo )
120 {
121     dec_thread_t    *p_dec;
122     data_packet_t   *p_data = NULL;
123     mpeg2_state_t   state;
124     picture_t       *p_pic;
125     int             i_aspect, i_chroma;
126
127     /* Allocate the memory needed to store the thread's structure */
128     if( (p_dec = (dec_thread_t *)malloc (sizeof(dec_thread_t)) )
129         == NULL)
130     {
131         msg_Err( p_fifo, "out of memory" );
132         goto error;
133     }
134
135     /* Initialize the thread properties */
136     memset( p_dec, 0, sizeof(dec_thread_t) );
137     p_dec->p_fifo     = p_fifo;
138     p_dec->p_pes      = NULL;
139     p_dec->p_vout     = NULL;
140     p_dec->p_mpeg2dec = NULL;
141     p_dec->p_synchro  = NULL;
142     p_dec->p_info     = NULL;
143     p_dec->i_pts      = mdate() + DEFAULT_PTS_DELAY;
144     p_dec->i_current_pts  = 0;
145     p_dec->i_previous_pts = 0;
146     p_dec->i_period_remainder = 0;
147     p_dec->p_picture_to_destroy = NULL;
148     p_dec->b_garbage_pic = 0;
149     p_dec->b_slice_i  = 0;
150     p_dec->b_skip     = 0;
151
152     /* Initialize decoder */
153     p_dec->p_mpeg2dec = mpeg2_init();
154     if( p_dec->p_mpeg2dec == NULL)
155         goto error;
156
157     p_dec->p_info = mpeg2_info( p_dec->p_mpeg2dec );
158
159     /* libmpeg2 decoder thread's main loop */
160     while( (!p_dec->p_fifo->b_die) && (!p_dec->p_fifo->b_error) )
161     {
162         state = mpeg2_parse( p_dec->p_mpeg2dec );
163
164         switch( state )
165         {
166         case STATE_BUFFER:
167             /* Feed libmpeg2 a data packet at a time */
168             if( p_data == NULL )
169             {
170                 /* Get the next PES */
171                 if( p_dec->p_pes )
172                     input_DeletePES( p_dec->p_fifo->p_packets_mgt,
173                                      p_dec->p_pes );
174
175                 input_ExtractPES( p_dec->p_fifo, &p_dec->p_pes );
176                 if( !p_dec->p_pes )
177                 {
178                     p_dec->p_fifo->b_error = 1;
179                     break;
180                 }
181
182                 if( p_dec->p_pes->b_discontinuity && p_dec->p_synchro )
183                 {
184                     vout_SynchroReset( p_dec->p_synchro );
185                     if ( p_dec->p_info->current_fbuf != NULL )
186                     {
187                         p_dec->b_garbage_pic = 1;
188                         p_pic = p_dec->p_info->current_fbuf->id;
189                     }
190                     else
191                     {
192                         uint8_t *buf[3];
193                         buf[0] = buf[1] = buf[2] = NULL;
194                         if( (p_pic = GetNewPicture( p_dec, buf )) == NULL )
195                             break;
196                         mpeg2_set_buf( p_dec->p_mpeg2dec, buf, p_pic );
197                     }
198                     p_dec->p_picture_to_destroy = p_pic;
199
200                     memset( p_pic->p[0].p_pixels, 0,
201                             p_dec->p_info->sequence->width
202                              * p_dec->p_info->sequence->height );
203                     memset( p_pic->p[1].p_pixels, 0x80,
204                             p_dec->p_info->sequence->width
205                              * p_dec->p_info->sequence->height / 4 );
206                     memset( p_pic->p[2].p_pixels, 0x80,
207                             p_dec->p_info->sequence->width
208                              * p_dec->p_info->sequence->height / 4 );
209
210                     if ( p_dec->b_slice_i )
211                     {
212                         vout_SynchroNewPicture( p_dec->p_synchro,
213                             I_CODING_TYPE, 2, 0, 0, p_dec->i_current_rate );
214                         vout_SynchroDecode( p_dec->p_synchro );
215                         vout_SynchroEnd( p_dec->p_synchro, I_CODING_TYPE, 0 );
216                     }
217                 }
218
219                 if( p_dec->p_pes->i_pts )
220                 {
221                     mpeg2_pts( p_dec->p_mpeg2dec,
222                                (uint32_t)p_dec->p_pes->i_pts );
223                     p_dec->i_previous_pts = p_dec->i_current_pts;
224                     p_dec->i_current_pts = p_dec->p_pes->i_pts;
225                 }
226
227                 p_dec->i_current_rate = p_dec->p_pes->i_rate;
228                 p_data = p_dec->p_pes->p_first;
229             }
230
231             if( p_data != NULL )
232             {
233                 mpeg2_buffer( p_dec->p_mpeg2dec,
234                               p_data->p_payload_start,
235                               p_data->p_payload_end );
236
237                 p_data = p_data->p_next;
238             }
239             break;
240
241         case STATE_SEQUENCE:
242         {
243             /* Initialize video output */
244             uint8_t *buf[3];
245             buf[0] = buf[1] = buf[2] = NULL;
246
247             /* Check whether the input gives a particular aspect ratio */
248             if( p_dec->p_fifo->p_demux_data
249                 && ( *(int*)(p_dec->p_fifo->p_demux_data) & 0x7 ) )
250             {
251                 i_aspect = *(int*)(p_dec->p_fifo->p_demux_data);
252                 switch( i_aspect )
253                 {
254                 case AR_3_4_PICTURE:
255                     i_aspect = VOUT_ASPECT_FACTOR * 4 / 3;
256                     break;
257                 case AR_16_9_PICTURE:
258                     i_aspect = VOUT_ASPECT_FACTOR * 16 / 9;
259                     break;
260                 case AR_221_1_PICTURE:
261                     i_aspect = VOUT_ASPECT_FACTOR * 221 / 100;
262                     break;
263                 case AR_SQUARE_PICTURE:
264                 default:
265                     i_aspect = VOUT_ASPECT_FACTOR *
266                                    p_dec->p_info->sequence->width /
267                                    p_dec->p_info->sequence->height;
268                     break;
269                 }
270             }
271             else
272             {
273                 /* Use the value provided in the MPEG sequence header */
274                 i_aspect = ((uint64_t)p_dec->p_info->sequence->display_width) *
275                     p_dec->p_info->sequence->pixel_width * VOUT_ASPECT_FACTOR /
276                     p_dec->p_info->sequence->display_height /
277                     p_dec->p_info->sequence->pixel_height;
278             }
279
280             i_chroma = VLC_FOURCC('Y','V','1','2');
281
282             p_dec->p_vout = vout_Request( p_dec->p_fifo, p_dec->p_vout,
283                                           p_dec->p_info->sequence->width,
284                                           p_dec->p_info->sequence->height,
285                                           i_chroma, i_aspect );
286
287             msg_Dbg( p_dec->p_fifo, "%dx%d, aspect %d, %u.%03u fps",
288                      p_dec->p_info->sequence->width,
289                      p_dec->p_info->sequence->height, i_aspect,
290                      (u32)((u64)1001000000 * 27 / p_dec->p_info->sequence->frame_period / 1001),
291                      (u32)((u64)1001000000 * 27 / p_dec->p_info->sequence->frame_period % 1001) );
292
293             mpeg2_custom_fbuf( p_dec->p_mpeg2dec, 1 );
294
295             /* Set the first 2 reference frames */
296             mpeg2_set_buf( p_dec->p_mpeg2dec, buf, NULL );
297
298             if( (p_pic = GetNewPicture( p_dec, buf )) == NULL ) break;
299             memset( p_pic->p[0].p_pixels, 0,
300                     p_dec->p_info->sequence->width
301                      * p_dec->p_info->sequence->height );
302             memset( p_pic->p[1].p_pixels, 0x80,
303                     p_dec->p_info->sequence->width
304                      * p_dec->p_info->sequence->height / 4 );
305             memset( p_pic->p[2].p_pixels, 0x80,
306                     p_dec->p_info->sequence->width
307                      * p_dec->p_info->sequence->height / 4 );
308             mpeg2_set_buf( p_dec->p_mpeg2dec, buf, p_pic );
309             /* This picture will never go through display_picture. */
310             vout_DatePicture( p_dec->p_vout, p_pic, 0 );
311             vout_DisplayPicture( p_dec->p_vout, p_pic );
312             /* For some reason, libmpeg2 will put this pic twice in
313              * discard_picture. This can be considered a bug in libmpeg2. */
314             vout_LinkPicture( p_dec->p_vout, p_pic );
315
316             if ( p_dec->p_synchro )
317             {
318                 vout_SynchroRelease( p_dec->p_synchro );
319             }
320             p_dec->p_synchro = vout_SynchroInit( p_dec->p_fifo, p_dec->p_vout,
321                 (u32)((u64)1001000000 * 27 / p_dec->p_info->sequence->frame_period) );
322             p_dec->b_after_sequence_header = 1;
323         }
324         break;
325
326         case STATE_PICTURE_2ND:
327             vout_SynchroNewPicture( p_dec->p_synchro,
328                 p_dec->p_info->current_picture->flags & PIC_MASK_CODING_TYPE,
329                 p_dec->p_info->current_picture->nb_fields,
330                 0, 0,
331                 p_dec->i_current_rate );
332
333             if ( p_dec->b_skip )
334             {
335                 vout_SynchroTrash( p_dec->p_synchro );
336             }
337             else
338             {
339                 vout_SynchroDecode( p_dec->p_synchro );
340             }
341             break;
342
343         case STATE_PICTURE:
344         {
345             uint8_t *buf[3];
346             buf[0] = buf[1] = buf[2] = NULL;
347
348             if ( p_dec->b_after_sequence_header
349                   && ((p_dec->p_info->current_picture->flags
350                         & PIC_MASK_CODING_TYPE)
351                        == PIC_FLAG_CODING_TYPE_P) )
352             {
353                 /* Intra-slice refresh. Simulate a blank I picture. */
354                 msg_Dbg( p_dec->p_fifo, "intra-slice refresh stream" );
355                 vout_SynchroNewPicture( p_dec->p_synchro,
356                     I_CODING_TYPE, 2, 0, 0, p_dec->i_current_rate );
357                 vout_SynchroDecode( p_dec->p_synchro );
358                 vout_SynchroEnd( p_dec->p_synchro, I_CODING_TYPE, 0 );
359                 p_dec->b_slice_i = 1;
360             }
361             p_dec->b_after_sequence_header = 0;
362
363             vout_SynchroNewPicture( p_dec->p_synchro,
364                 p_dec->p_info->current_picture->flags & PIC_MASK_CODING_TYPE,
365                 p_dec->p_info->current_picture->nb_fields,
366                 (p_dec->p_info->current_picture->flags & PIC_FLAG_PTS) ?
367                     ( (p_dec->p_info->current_picture->pts ==
368                                 (uint32_t)p_dec->i_current_pts) ?
369                               p_dec->i_current_pts : p_dec->i_previous_pts ) : 0,
370                 0,
371                 p_dec->i_current_rate );
372
373             if ( !(p_dec->b_slice_i
374                    && ((p_dec->p_info->current_picture->flags
375                          & PIC_MASK_CODING_TYPE) == P_CODING_TYPE))
376                    && !vout_SynchroChoose( p_dec->p_synchro,
377                               p_dec->p_info->current_picture->flags
378                                 & PIC_MASK_CODING_TYPE ) )
379             {
380                 mpeg2_skip( p_dec->p_mpeg2dec, 1 );
381                 p_dec->b_skip = 1;
382                 vout_SynchroTrash( p_dec->p_synchro );
383                 mpeg2_set_buf( p_dec->p_mpeg2dec, buf, NULL );
384             }
385             else
386             {
387                 mpeg2_skip( p_dec->p_mpeg2dec, 0 );
388                 p_dec->b_skip = 0;
389                 vout_SynchroDecode( p_dec->p_synchro );
390                 if( (p_pic = GetNewPicture( p_dec, buf )) == NULL ) break;
391                 mpeg2_set_buf( p_dec->p_mpeg2dec, buf, p_pic );
392             }
393         }
394         break;
395
396         case STATE_END:
397         case STATE_SLICE:
398             if( p_dec->p_info->display_fbuf
399                 && p_dec->p_info->display_fbuf->id )
400             {
401                 p_pic = (picture_t *)p_dec->p_info->display_fbuf->id;
402
403                 vout_SynchroEnd( p_dec->p_synchro,
404                             p_dec->p_info->display_picture->flags
405                              & PIC_MASK_CODING_TYPE,
406                             p_dec->b_garbage_pic );
407                 p_dec->b_garbage_pic = 0;
408                 vout_DisplayPicture( p_dec->p_vout, p_pic );
409
410                 if ( p_dec->p_picture_to_destroy != p_pic )
411                 {
412                     vout_DatePicture( p_dec->p_vout, p_pic,
413                         vout_SynchroDate( p_dec->p_synchro ) );
414                 }
415                 else
416                 {
417                     p_dec->p_picture_to_destroy = NULL;
418                     vout_DatePicture( p_dec->p_vout, p_pic, 0 );
419                 }
420             }
421
422             if( p_dec->p_info->discard_fbuf &&
423                 p_dec->p_info->discard_fbuf->id )
424             {
425                 p_pic = (picture_t *)p_dec->p_info->discard_fbuf->id;
426                 vout_UnlinkPicture( p_dec->p_vout, p_pic );
427             }
428             break;
429
430         case STATE_INVALID:
431         {
432             uint8_t *buf[3];
433             buf[0] = buf[1] = buf[2] = NULL;
434
435             msg_Warn( p_dec->p_fifo, "invalid picture encountered" );
436             if ( ( p_dec->p_info->current_picture == NULL ) || 
437                ( ( p_dec->p_info->current_picture->flags & PIC_MASK_CODING_TYPE)
438                   != B_CODING_TYPE ) )
439             {
440                 vout_SynchroReset( p_dec->p_synchro );
441             }
442             mpeg2_skip( p_dec->p_mpeg2dec, 1 );
443             p_dec->b_skip = 1;
444
445             if( p_dec->p_info->current_fbuf &&
446                 p_dec->p_info->current_fbuf->id )
447             {
448                 p_dec->b_garbage_pic = 1;
449                 p_pic = p_dec->p_info->current_fbuf->id;
450             }
451             else
452             {
453                 if( (p_pic = GetNewPicture( p_dec, buf )) == NULL )
454                     break;
455                 mpeg2_set_buf( p_dec->p_mpeg2dec, buf, p_pic );
456             }
457             p_dec->p_picture_to_destroy = p_pic;
458
459             memset( p_pic->p[0].p_pixels, 0,
460                     p_dec->p_info->sequence->width
461                      * p_dec->p_info->sequence->height );
462             memset( p_pic->p[1].p_pixels, 0x80,
463                     p_dec->p_info->sequence->width
464                      * p_dec->p_info->sequence->height / 4 );
465             memset( p_pic->p[2].p_pixels, 0x80,
466                     p_dec->p_info->sequence->width
467                      * p_dec->p_info->sequence->height / 4 );
468
469             if ( p_dec->b_slice_i )
470             {
471                 vout_SynchroNewPicture( p_dec->p_synchro,
472                             I_CODING_TYPE, 2, 0, 0, p_dec->i_current_rate );
473                 vout_SynchroDecode( p_dec->p_synchro );
474                 vout_SynchroEnd( p_dec->p_synchro, I_CODING_TYPE, 0 );
475             }
476             break;
477         }
478
479         default:
480             break;
481         }
482     }
483
484     /* If b_error is set, the libmpeg2 decoder thread enters the error loop */
485     if( p_dec->p_fifo->b_error )
486     {
487         DecoderError( p_dec->p_fifo );
488     }
489
490     /* End of the libmpeg2 decoder thread */
491     CloseDecoder( p_dec );
492
493     return 0;
494
495  error:
496     DecoderError( p_fifo );
497     if( p_dec )
498     {
499         if( p_dec->p_fifo )
500             p_dec->p_fifo->b_error = 1;
501
502         /* End of the libmpeg2 decoder thread */
503         CloseDecoder( p_dec );
504     }
505
506     return -1;
507 }
508
509 /*****************************************************************************
510  * CloseDecoder: libmpeg2 decoder destruction
511  *****************************************************************************/
512 static void CloseDecoder( dec_thread_t * p_dec )
513 {
514     if( p_dec )
515     {
516         int i_pic;
517
518         if( p_dec->p_pes )
519             input_DeletePES( p_dec->p_fifo->p_packets_mgt, p_dec->p_pes );
520
521         if( p_dec->p_synchro )
522             vout_SynchroRelease( p_dec->p_synchro );
523
524         if( p_dec->p_vout )
525         {
526             /* Temporary hack to free the pictures in use by libmpeg2 */
527             for( i_pic = 0; i_pic < p_dec->p_vout->render.i_pictures; i_pic++ )
528             {
529                 if( p_dec->p_vout->render.pp_picture[i_pic]->i_status ==
530                       RESERVED_PICTURE )
531                     vout_DestroyPicture( p_dec->p_vout,
532                                      p_dec->p_vout->render.pp_picture[i_pic] );
533                 if( p_dec->p_vout->render.pp_picture[i_pic]->i_refcount > 0 )
534                     vout_UnlinkPicture( p_dec->p_vout,
535                                      p_dec->p_vout->render.pp_picture[i_pic] );
536             }
537
538             vout_Request( p_dec->p_fifo, p_dec->p_vout, 0, 0, 0, 0 );
539         }
540
541         if( p_dec->p_mpeg2dec ) mpeg2_close( p_dec->p_mpeg2dec );
542
543         free( p_dec );
544     }
545 }
546
547 /*****************************************************************************
548  * GetNewPicture: Get a new picture from the vout and set the buf struct
549  *****************************************************************************/
550 static picture_t *GetNewPicture( dec_thread_t *p_dec, uint8_t **pp_buf )
551 {
552     picture_t *p_pic;
553     vlc_bool_t b_progressive = p_dec->p_info->current_picture != NULL ?
554         p_dec->p_info->current_picture->flags & PIC_FLAG_PROGRESSIVE_FRAME :
555         1;
556     vlc_bool_t b_top_field_first = p_dec->p_info->current_picture != NULL ?
557         p_dec->p_info->current_picture->flags & PIC_FLAG_TOP_FIELD_FIRST :
558         1;
559     unsigned int i_nb_fields = p_dec->p_info->current_picture != NULL ?
560         p_dec->p_info->current_picture->nb_fields : 2;
561
562     /* Get a new picture */
563     while( !(p_pic = vout_CreatePicture( p_dec->p_vout,
564         b_progressive, b_top_field_first, i_nb_fields )) )
565     {
566         if( p_dec->p_fifo->b_die || p_dec->p_fifo->b_error )
567             break;
568
569         msleep( VOUT_OUTMEM_SLEEP );
570     }
571     if( p_pic == NULL )
572         return NULL;
573     vout_LinkPicture( p_dec->p_vout, p_pic );
574
575     pp_buf[0] = p_pic->p[0].p_pixels;
576     pp_buf[1] = p_pic->p[1].p_pixels;
577     pp_buf[2] = p_pic->p[2].p_pixels;
578
579     return p_pic;
580 }