]> git.sesse.net Git - vlc/blobdiff - modules/codec/spudec/parse.c
A bit of headers cleanup
[vlc] / modules / codec / spudec / parse.c
index f626f008838020d7f0b04f6020b6be8951f15e3a..f747c43818bebb3f0e2d59fc2e9b008184776a52 100644 (file)
@@ -1,10 +1,10 @@
 /*****************************************************************************
  * parse.c: SPU parser
  *****************************************************************************
- * Copyright (C) 2000-2001 VideoLAN
+ * Copyright (C) 2000-2001, 2005, 2006 the VideoLAN team
  * $Id$
  *
- * Authors: Samuel Hocevar <sam@zoy.org>
+ * Authors: Sam Hocevar <sam@zoy.org>
  *          Laurent Aimar <fenrir@via.ecp.fr>
  *          Gildas Bazin <gbazin@videolan.org>
  *
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
 #include <vlc/vlc.h>
-#include <vlc/vout.h>
-#include <vlc/decoder.h>
+#include <vlc_vout.h>
+#include <vlc_codec.h>
 
 #include "spudec.h"
 
@@ -43,7 +43,7 @@ static void Render         ( decoder_t *, subpicture_t *, subpicture_data_t *);
  * AddNibble: read a nibble from a source packet and add it to our integer.
  *****************************************************************************/
 static inline unsigned int AddNibble( unsigned int i_code,
-                                      uint8_t *p_src, int *pi_index )
+                                      uint8_t *p_src, unsigned int *pi_index )
 {
     if( *pi_index & 0x1 )
     {
@@ -71,6 +71,8 @@ subpicture_t * E_(ParsePacket)( decoder_t *p_dec )
     p_spu = p_dec->pf_spu_buffer_new( p_dec );
     if( !p_spu ) return NULL;
 
+    p_spu->b_pausable = VLC_TRUE;
+
     /* Rationale for the "p_spudec->i_rle_size * 4": we are going to
      * expand the RLE stuff so that we won't need to read nibbles later
      * on. This will speed things up a lot. Plus, we'll only need to do
@@ -90,8 +92,10 @@ subpicture_t * E_(ParsePacket)( decoder_t *p_dec )
     /* Get display time now. If we do it later, we may miss the PTS. */
     p_spu_data->i_pts = p_sys->i_pts;
 
-    p_spu->i_original_picture_width = p_dec->fmt_in.subs.spu.i_original_frame_width;
-    p_spu->i_original_picture_height = p_dec->fmt_in.subs.spu.i_original_frame_height;
+    p_spu->i_original_picture_width =
+        p_dec->fmt_in.subs.spu.i_original_frame_width;
+    p_spu->i_original_picture_height =
+        p_dec->fmt_in.subs.spu.i_original_frame_height;
 
     /* Getting the control part */
     if( ParseControlSeq( p_dec, p_spu, p_spu_data ) )
@@ -109,9 +113,11 @@ subpicture_t * E_(ParsePacket)( decoder_t *p_dec )
         return NULL;
     }
 
+#ifdef DEBUG_SPUDEC
     msg_Dbg( p_dec, "total size: 0x%x, RLE offsets: 0x%x 0x%x",
              p_sys->i_spu_size,
              p_spu_data->pi_offset[0], p_spu_data->pi_offset[1] );
+#endif
 
     Render( p_dec, p_spu, p_spu_data );
     free( p_spu_data );
@@ -141,27 +147,22 @@ static int ParseControlSeq( decoder_t *p_dec, subpicture_t *p_spu,
     uint8_t i_command = SPU_CMD_END;
     mtime_t date = 0;
 
-    unsigned int i, pi_alpha[4];
-
     /* Initialize the structure */
     p_spu->i_start = p_spu->i_stop = 0;
     p_spu->b_ephemer = VLC_FALSE;
 
-    do
+    for( i_index = 4 + p_sys->i_rle_size; i_index < p_sys->i_spu_size ; )
     {
-        if( (int)i_index >= p_sys->i_spu_size + 1 )
-        {
-            /* sanity
-             * XXX only on test by loop as p_sys->buffer is bigger than needed
-             * to avoid checking at each access
-             */
-            break;
-        }
-
         /* If we just read a command sequence, read the next one;
          * otherwise, go on with the commands of the current sequence. */
         if( i_command == SPU_CMD_END )
         {
+            if( i_index + 4 > p_sys->i_spu_size )
+            {
+                msg_Err( p_dec, "overflow in SPU command sequence" );
+                return VLC_EGENERIC;
+            }
+
             /* Get the control sequence date */
             date = (mtime_t)GetWBE( &p_sys->buffer[i_index] ) * 11000;
             /* FIXME How to access i_rate
@@ -172,41 +173,57 @@ static int ParseControlSeq( decoder_t *p_dec, subpicture_t *p_spu,
             i_cur_seq = i_index;
             i_next_seq = GetWBE( &p_sys->buffer[i_index+2] );
 
+            if( i_next_seq > p_sys->i_spu_size )
+            {
+                msg_Err( p_dec, "overflow in SPU next command sequence" );
+                return VLC_EGENERIC;
+            }
+
             /* Skip what we just read */
             i_index += 4;
         }
 
-        i_command = p_sys->buffer[i_index++];
+        i_command = p_sys->buffer[i_index];
 
         switch( i_command )
         {
         case SPU_CMD_FORCE_DISPLAY: /* 00 (force displaying) */
             p_spu->i_start = p_spu_data->i_pts + date;
             p_spu->b_ephemer = VLC_TRUE;
+            i_index += 1;
             break;
 
         /* Convert the dates in seconds to PTS values */
         case SPU_CMD_START_DISPLAY: /* 01 (start displaying) */
             p_spu->i_start = p_spu_data->i_pts + date;
+            i_index += 1;
             break;
 
         case SPU_CMD_STOP_DISPLAY: /* 02 (stop displaying) */
             p_spu->i_stop = p_spu_data->i_pts + date;
+            i_index += 1;
             break;
 
         case SPU_CMD_SET_PALETTE:
 
             /* 03xxxx (palette) */
+            if( i_index + 3 > p_sys->i_spu_size )
+            {
+                msg_Err( p_dec, "overflow in SPU command" );
+                return VLC_EGENERIC;
+            }
+
             if( p_dec->fmt_in.subs.spu.palette[0] == 0xBeeF )
             {
                 unsigned int idx[4];
+                int i;
 
                 p_spu_data->b_palette = VLC_TRUE;
 
-                idx[0] = (p_sys->buffer[i_index+0]>>4)&0x0f;
-                idx[1] = (p_sys->buffer[i_index+0])&0x0f;
-                idx[2] = (p_sys->buffer[i_index+1]>>4)&0x0f;
-                idx[3] = (p_sys->buffer[i_index+1])&0x0f;
+                idx[0] = (p_sys->buffer[i_index+1]>>4)&0x0f;
+                idx[1] = (p_sys->buffer[i_index+1])&0x0f;
+                idx[2] = (p_sys->buffer[i_index+2]>>4)&0x0f;
+                idx[3] = (p_sys->buffer[i_index+2])&0x0f;
 
                 for( i = 0; i < 4 ; i++ )
                 {
@@ -218,63 +235,89 @@ static int ParseControlSeq( decoder_t *p_dec, subpicture_t *p_spu,
                     p_spu_data->pi_yuv[3-i][2] = (i_color>>8) & 0xff;
                 }
             }
-            i_index += 2;
 
+            i_index += 3;
             break;
 
         case SPU_CMD_SET_ALPHACHANNEL: /* 04xxxx (alpha channel) */
-            pi_alpha[3] = (p_sys->buffer[i_index+0]>>4)&0x0f;
-            pi_alpha[2] = (p_sys->buffer[i_index+0])&0x0f;
-            pi_alpha[1] = (p_sys->buffer[i_index+1]>>4)&0x0f;
-            pi_alpha[0] = (p_sys->buffer[i_index+1])&0x0f;
-
-            /* Ignore blank alpha palette. Sometimes spurious blank
-             * alpha palettes are present - dunno why. */
-            if( pi_alpha[0] | pi_alpha[1] | pi_alpha[2] | pi_alpha[3] )
+            if( i_index + 3 > p_sys->i_spu_size )
             {
-                p_spu_data->pi_alpha[0] = pi_alpha[0];
-                p_spu_data->pi_alpha[1] = pi_alpha[1];
-                p_spu_data->pi_alpha[2] = pi_alpha[2];
-                p_spu_data->pi_alpha[3] = pi_alpha[3];
-            }
-            else
-            {
-                msg_Warn( p_dec, "ignoring blank alpha palette" );
+                msg_Err( p_dec, "overflow in SPU command" );
+                return VLC_EGENERIC;
             }
 
-            i_index += 2;
+            p_spu_data->pi_alpha[3] = (p_sys->buffer[i_index+1]>>4)&0x0f;
+            p_spu_data->pi_alpha[2] = (p_sys->buffer[i_index+1])&0x0f;
+            p_spu_data->pi_alpha[1] = (p_sys->buffer[i_index+2]>>4)&0x0f;
+            p_spu_data->pi_alpha[0] = (p_sys->buffer[i_index+2])&0x0f;
+
+            i_index += 3;
             break;
 
         case SPU_CMD_SET_COORDINATES: /* 05xxxyyyxxxyyy (coordinates) */
-            p_spu->i_x = (p_sys->buffer[i_index+0]<<4)|
-                         ((p_sys->buffer[i_index+1]>>4)&0x0f);
-            p_spu->i_width = (((p_sys->buffer[i_index+1]&0x0f)<<8)|
-                              p_sys->buffer[i_index+2]) - p_spu->i_x + 1;
+            if( i_index + 7 > p_sys->i_spu_size )
+            {
+                msg_Err( p_dec, "overflow in SPU command" );
+                return VLC_EGENERIC;
+            }
+
+            p_spu->i_x = (p_sys->buffer[i_index+1]<<4)|
+                         ((p_sys->buffer[i_index+2]>>4)&0x0f);
+            p_spu->i_width = (((p_sys->buffer[i_index+2]&0x0f)<<8)|
+                              p_sys->buffer[i_index+3]) - p_spu->i_x + 1;
 
-            p_spu->i_y = (p_sys->buffer[i_index+3]<<4)|
-                         ((p_sys->buffer[i_index+4]>>4)&0x0f);
-            p_spu->i_height = (((p_sys->buffer[i_index+4]&0x0f)<<8)|
-                              p_sys->buffer[i_index+5]) - p_spu->i_y + 1;
+            p_spu->i_y = (p_sys->buffer[i_index+4]<<4)|
+                         ((p_sys->buffer[i_index+5]>>4)&0x0f);
+            p_spu->i_height = (((p_sys->buffer[i_index+5]&0x0f)<<8)|
+                              p_sys->buffer[i_index+6]) - p_spu->i_y + 1;
 
             /* Auto crop fullscreen subtitles */
             if( p_spu->i_height > 250 )
                 p_spu_data->b_auto_crop = VLC_TRUE;
 
-            i_index += 6;
+            i_index += 7;
             break;
 
         case SPU_CMD_SET_OFFSETS: /* 06xxxxyyyy (byte offsets) */
-            p_spu_data->pi_offset[0] = GetWBE(&p_sys->buffer[i_index+0]) - 4;
-            p_spu_data->pi_offset[1] = GetWBE(&p_sys->buffer[i_index+2]) - 4;
-            i_index += 4;
+            if( i_index + 5 > p_sys->i_spu_size )
+            {
+                msg_Err( p_dec, "overflow in SPU command" );
+                return VLC_EGENERIC;
+            }
+
+            p_spu_data->pi_offset[0] = GetWBE(&p_sys->buffer[i_index+1]) - 4;
+            p_spu_data->pi_offset[1] = GetWBE(&p_sys->buffer[i_index+3]) - 4;
+            i_index += 5;
             break;
 
         case SPU_CMD_END: /* ff (end) */
+            i_index += 1;
             break;
 
         default: /* xx (unknown command) */
-            msg_Warn( p_dec, "unknown command 0x%.2x", i_command );
-            return VLC_EGENERIC;
+            msg_Warn( p_dec, "unknown SPU command 0x%.2x", i_command );
+            if( i_index + 1 < i_next_seq )
+            {
+                 /* There is at least one other command sequence */
+                 if( p_sys->buffer[i_next_seq - 1] == SPU_CMD_END )
+                 {
+                     /* This is consistent. Skip to that command sequence. */
+                     i_index = i_next_seq;
+                 }
+                 else
+                 {
+                     /* There were other commands. */
+                     msg_Warn( p_dec, "cannot recover, dropping subtitle" );
+                     return VLC_EGENERIC;
+                 }
+            }
+            else
+            {
+                /* We were in the last command sequence. Stop parsing by
+                 * pretending we met an SPU_CMD_END command. */
+                i_command = SPU_CMD_END;
+                i_index++;
+            }
         }
 
         /* We need to check for quit commands here */
@@ -283,7 +326,11 @@ static int ParseControlSeq( decoder_t *p_dec, subpicture_t *p_spu,
             return VLC_EGENERIC;
         }
 
-    } while( i_command != SPU_CMD_END || i_index == i_next_seq );
+        if( i_command == SPU_CMD_END && i_index != i_next_seq )
+        {
+            break;
+        }
+    }
 
     /* Check that the next sequence index matches the current one */
     if( i_next_seq != i_cur_seq )
@@ -293,7 +340,7 @@ static int ParseControlSeq( decoder_t *p_dec, subpicture_t *p_spu,
         return VLC_EGENERIC;
     }
 
-    if( (int)i_index > p_sys->i_spu_size )
+    if( i_index > p_sys->i_spu_size )
     {
         msg_Err( p_dec, "uh-oh, we went too far (0x%.4x > 0x%.4x)",
                  i_index, p_sys->i_spu_size );
@@ -313,11 +360,11 @@ static int ParseControlSeq( decoder_t *p_dec, subpicture_t *p_spu,
     }
 
     /* Get rid of padding bytes */
-    if( p_sys->i_spu_size > (int)i_index + 1 )
+    if( p_sys->i_spu_size > i_index + 1 )
     {
-        /* Zero or one padding byte, are quite usual
+        /* Zero or one padding byte are quite usual
          * More than one padding byte - this is very strange, but
-         * we can deal with it */
+         * we can ignore them. */
         msg_Warn( p_dec, "%i padding bytes, we usually get 0 or 1 of them",
                   p_sys->i_spu_size - i_index );
     }
@@ -502,19 +549,24 @@ static int ParseRLE( decoder_t *p_dec, subpicture_t * p_spu,
         return VLC_EGENERIC;
     }
 
+#ifdef DEBUG_SPUDEC
     msg_Dbg( p_dec, "valid subtitle, size: %ix%i, position: %i,%i",
              p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
+#endif
 
     /* Crop if necessary */
     if( i_skipped_top || i_skipped_bottom )
     {
+#ifdef DEBUG_SPUDEC
         int i_y = p_spu->i_y + i_skipped_top;
         int i_height = p_spu->i_height - (i_skipped_top + i_skipped_bottom);
-
+#endif
         p_spu_data->i_y_top_offset = i_skipped_top;
         p_spu_data->i_y_bottom_offset = i_skipped_bottom;
+#ifdef DEBUG_SPUDEC
         msg_Dbg( p_dec, "cropped to: %ix%i, position: %i,%i",
                  p_spu->i_width, i_height, p_spu->i_x, i_y );
+#endif
     }
  
     /* Handle color if no palette was found */
@@ -569,8 +621,10 @@ static int ParseRLE( decoder_t *p_dec, subpicture_t * p_spu,
             p_spu_data->pi_yuv[i_shade][2] = 0x80;
         }
 
+#ifdef DEBUG_SPUDEC
         msg_Dbg( p_dec, "using custom palette (border %i, inner %i, shade %i)",
                  i_border, i_inner, i_shade );
+#endif
     }
 
     return VLC_SUCCESS;
@@ -587,7 +641,7 @@ static void Render( decoder_t *p_dec, subpicture_t *p_spu,
     /* Create a new subpicture region */
     memset( &fmt, 0, sizeof(video_format_t) );
     fmt.i_chroma = VLC_FOURCC('Y','U','V','P');
-    fmt.i_aspect = VOUT_ASPECT_FACTOR;
+    fmt.i_aspect = 0; /* 0 means use aspect ratio of background video */
     fmt.i_width = fmt.i_visible_width = p_spu->i_width;
     fmt.i_height = fmt.i_visible_height = p_spu->i_height -
         p_spu_data->i_y_top_offset - p_spu_data->i_y_bottom_offset;