]> git.sesse.net Git - vlc/blobdiff - modules/codec/dvbsub.c
Removes trailing spaces. Removes tabs.
[vlc] / modules / codec / dvbsub.c
index ffc240f7530f424aa56a26128220f7bb974c69f2..8fc151ae8b882833616f17329d8f6cc72cb2bd48 100644 (file)
@@ -10,6 +10,7 @@
  *          Damien LUCAS <damien.lucas@anevia.com>
  *          Laurent Aimar <fenrir@via.ecp.fr>
  *          Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
+ *          Derk-Jan Hartman <hartman #at# videolan dot org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * FIXME:
  * DVB subtitles coded as strings of characters are not handled correctly.
- * The character codes in the string should actually be indexes refering to a
+ * The character codes in the string should actually be indexes referring to a
  * character table identified in the subtitle descriptor.
+ *
+ * The spec is quite vague in this area, but what is meant is perhaps that it
+ * refers to the character index in the codepage belonging to the language specified
+ * in the subtitle descriptor. Potentially it's designed for widechar
+ * (but not for UTF-*) codepages.
  *****************************************************************************/
 #include <vlc/vlc.h>
-#include <vlc/vout.h>
-#include <vlc/decoder.h>
-#include <vlc/sout.h>
+#include <vlc_vout.h>
+#include <vlc_codec.h>
+#include <vlc_sout.h>
 
 #include "vlc_bits.h"
 
@@ -46,7 +52,7 @@
 #define POSX_LONGTEXT N_("X coordinate of the rendered subtitle")
 
 #define POSY_TEXT N_("Decoding Y coordinate")
-#define POSY_LONGTEXT N_("Y coordinate of the rendered subtitle") 
+#define POSY_LONGTEXT N_("Y coordinate of the rendered subtitle")
 
 #define POS_TEXT N_("Subpicture position")
 #define POS_LONGTEXT N_( \
@@ -60,7 +66,7 @@
 #define ENC_POSY_LONGTEXT N_("Y coordinate of the encoded subtitle" )
 
 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
-static char *ppsz_pos_descriptions[] =
+static const char *ppsz_pos_descriptions[] =
 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
 
@@ -96,7 +102,7 @@ vlc_module_begin();
 
     add_integer( ENC_CFG_PREFIX "x", -1, NULL, ENC_POSX_TEXT, ENC_POSX_LONGTEXT, VLC_FALSE );
     add_integer( ENC_CFG_PREFIX "y", -1, NULL, ENC_POSY_TEXT, ENC_POSY_LONGTEXT, VLC_FALSE );
-    add_suppressed_integer( ENC_CFG_PREFIX "timeout" ); /* Suppressed since 0.8.5 */
+    add_obsolete_integer( ENC_CFG_PREFIX "timeout" ); /* Suppressed since 0.8.5 */
 vlc_module_end();
 
 static const char *ppsz_enc_options[] = { "x", "y", NULL };
@@ -107,7 +113,7 @@ static const char *ppsz_enc_options[] = { "x", "y", NULL };
  * Those structures refer closely to the ETSI 300 743 Object model
  ****************************************************************************/
 
-/* The object definition gives the position of the object in a region */
+/* The object definition gives the position of the object in a region [7.2.5] */
 typedef struct dvbsub_objectdef_s
 {
     int i_id;
@@ -130,7 +136,24 @@ typedef struct
 
 } dvbsub_color_t;
 
-/* */
+/* The displays dimensions [7.2.1] */
+typedef struct dvbsub_display_s
+{
+    uint8_t                 i_id;
+    uint8_t                 i_version;
+
+    int                     i_width;
+    int                     i_height;
+
+    vlc_bool_t              b_windowed;
+    int                     i_x;
+    int                     i_y;
+    int                     i_max_x;
+    int                     i_max_y;
+
+} dvbsub_display_t;
+
+/* [7.2.4] */
 typedef struct dvbsub_clut_s
 {
     uint8_t                 i_id;
@@ -143,7 +166,7 @@ typedef struct dvbsub_clut_s
 
 } dvbsub_clut_t;
 
-/* The Region is an aera on the image
+/* The Region is an aera on the image [7.2.3]
  * with a list of the object definitions associated and a CLUT */
 typedef struct dvbsub_region_s
 {
@@ -175,7 +198,7 @@ typedef struct dvbsub_regiondef_s
 
 } dvbsub_regiondef_t;
 
-/* The page defines the list of regions */
+/* The page defines the list of regions [7.2.2] */
 typedef struct
 {
     int i_id;
@@ -206,7 +229,8 @@ struct decoder_sys_t
     dvbsub_page_t   *p_page;
     dvbsub_region_t *p_regions;
     dvbsub_clut_t   *p_cluts;
-    dvbsub_clut_t   default_clut;
+    dvbsub_display_t *p_display;
+    dvbsub_clut_t    default_clut;
 };
 
 
@@ -216,6 +240,7 @@ struct decoder_sys_t
 #define DVBSUB_ST_REGION_COMPOSITION    0x11
 #define DVBSUB_ST_CLUT_DEFINITION       0x12
 #define DVBSUB_ST_OBJECT_DATA           0x13
+#define DVBSUB_ST_DISPLAY_DEFINITION    0x14
 #define DVBSUB_ST_ENDOFDISPLAY          0x80
 #define DVBSUB_ST_STUFFING              0xff
 /* List of different OBJECT TYPES */
@@ -224,7 +249,7 @@ struct decoder_sys_t
 #define DVBSUB_OT_BASIC_CHAR            0x01
 #define DVBSUB_OT_COMPOSITE_STRING      0x02
 /* Pixel DATA TYPES */
-/* According to EN 300-743, table 9 */ 
+/* According to EN 300-743, table 9 */
 #define DVBSUB_DT_2BP_CODE_STRING       0x10
 #define DVBSUB_DT_4BP_CODE_STRING       0x11
 #define DVBSUB_DT_8BP_CODE_STRING       0x12
@@ -244,6 +269,7 @@ static void decode_segment( decoder_t *, bs_t * );
 static void decode_page_composition( decoder_t *, bs_t * );
 static void decode_region_composition( decoder_t *, bs_t * );
 static void decode_object( decoder_t *, bs_t * );
+static void decode_display_definition( decoder_t *, bs_t * );
 static void decode_clut( decoder_t *, bs_t * );
 static void free_all( decoder_t * );
 
@@ -271,15 +297,21 @@ static int Open( vlc_object_t *p_this )
 
     p_dec->pf_decode_sub = Decode;
     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
+    if( !p_sys )
+    {
+        msg_Err( p_dec, "out of memory" );
+        return VLC_ENOMEM;
+    }
     memset( p_sys, 0, sizeof(decoder_sys_t) );
 
-    p_sys->i_pts          = (mtime_t) 0;    
+    p_sys->i_pts          = (mtime_t) 0;
     p_sys->i_id           = p_dec->fmt_in.subs.dvb.i_id & 0xFFFF;
     p_sys->i_ancillary_id = p_dec->fmt_in.subs.dvb.i_id >> 16;
 
     p_sys->p_regions      = NULL;
     p_sys->p_cluts        = NULL;
     p_sys->p_page         = NULL;
+    p_sys->p_display      = NULL;
 
     var_Create( p_this, DVBSUB_CFG_PREFIX "position",
                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
@@ -419,8 +451,8 @@ static void default_clut_init( decoder_t *p_dec )
         else R = G = B = 0x7F;
 
         p_sys->default_clut.c_2b[i].Y = RGB_TO_Y(R,G,B);
-        p_sys->default_clut.c_2b[i].Cr = RGB_TO_U(R,G,B);
         p_sys->default_clut.c_2b[i].Cb = RGB_TO_V(R,G,B);
+        p_sys->default_clut.c_2b[i].Cr = RGB_TO_U(R,G,B);
         p_sys->default_clut.c_2b[i].T = T;
     }
 
@@ -450,8 +482,8 @@ static void default_clut_init( decoder_t *p_dec )
         }
 
         p_sys->default_clut.c_4b[i].Y = RGB_TO_Y(R,G,B);
-        p_sys->default_clut.c_4b[i].Cr = RGB_TO_U(R,G,B);
-        p_sys->default_clut.c_4b[i].Cb = RGB_TO_V(R,G,B);
+        p_sys->default_clut.c_4b[i].Cr = RGB_TO_V(R,G,B);
+        p_sys->default_clut.c_4b[i].Cb = RGB_TO_U(R,G,B);
         p_sys->default_clut.c_4b[i].T = T;
     }
 
@@ -536,6 +568,13 @@ static void decode_segment( decoder_t *p_dec, bs_t *s )
         decode_object( p_dec, s );
         break;
 
+    case DVBSUB_ST_DISPLAY_DEFINITION:
+#ifdef DEBUG_DVBSUB
+        msg_Dbg( p_dec, "decode_display_definition" );
+#endif
+        decode_display_definition( p_dec, s );
+        break;
+
     case DVBSUB_ST_ENDOFDISPLAY:
 #ifdef DEBUG_DVBSUB
         msg_Dbg( p_dec, "end of display" );
@@ -894,6 +933,67 @@ static void decode_region_composition( decoder_t *p_dec, bs_t *s )
     }
 }
 
+/* ETSI 300 743 [7.2.1] */
+static void decode_display_definition( decoder_t *p_dec, bs_t *s )
+{
+    decoder_sys_t *p_sys = p_dec->p_sys;
+    uint16_t      i_segment_length;
+    uint16_t      i_processed_length = 40;
+    dvbsub_display_t *p_display;
+    dvbsub_display_t *p_old = p_sys->p_display;
+    int           i_version;
+
+    i_segment_length = bs_read( s, 16 );
+    i_version        = bs_read( s, 4 );
+
+    /* Check version number */
+    if( p_old && p_old->i_version == i_version )
+    {
+        /* The definition did not change */
+        bs_skip( s, 8*i_segment_length - 4 );
+        return;
+    }
+
+#ifdef DEBUG_DVBSUB
+    msg_Dbg( p_dec, "new display definition: %i", i_version );
+#endif
+    p_display = malloc( sizeof(dvbsub_display_t) );
+
+    /* We don't have this version of the display definition: Parse it */
+    p_display->i_version = i_version;
+    p_display->b_windowed = bs_read( s, 1 );
+    bs_skip( s, 3 ); /* Reserved bits */
+    p_display->i_width = bs_read( s, 16 )+1;
+    p_display->i_height = bs_read( s, 16 )+1;
+
+    if( p_display->b_windowed )
+    {
+#ifdef DEBUG_DVBSUB
+        msg_Dbg( p_dec, "display definition with offsets (windowed)" );
+#endif
+        /* Coordinates are measured from the top left corner */
+        p_display->i_x     = bs_read( s, 16 );
+        p_display->i_max_x = bs_read( s, 16 );
+        p_display->i_y     = bs_read( s, 16 );
+        p_display->i_max_y = bs_read( s, 16 );
+        i_processed_length += 64;
+    }
+
+    p_sys->p_display = p_display;
+    if( p_old ) free( p_old );
+
+    if( i_processed_length != i_segment_length*8 )
+    {
+        msg_Err( p_dec, "processed length %d != segment length %d", i_processed_length, i_segment_length );
+    }
+
+#ifdef DEBUG_DVBSUB
+    msg_Dbg( p_dec, "version: %d, width: %d, height: %d", p_display->i_version, p_display->i_width, p_display->i_height );
+    if( p_display->b_windowed )
+        msg_Dbg( p_dec, "xmin: %d, xmax: %d, ymin: %d, ymax: %d", p_display->i_x, p_display->i_max_x, p_display->i_y, p_display->i_max_y );
+#endif
+}
+
 static void dvbsub_render_pdata( decoder_t *, dvbsub_region_t *, int, int,
                                  uint8_t *, int );
 static void dvbsub_pdata2bpp( bs_t *, uint8_t *, int, int * );
@@ -1022,9 +1122,10 @@ static void decode_object( decoder_t *p_dec, bs_t *s )
                     realloc( p_region->p_object_defs[i].psz_text,
                              i_number_of_codes + 1 );
 
+                /* FIXME 16bits -> char ??? See Preamble */
                 for( j = 0; j < i_number_of_codes; j++ )
                 {
-                    p_region->p_object_defs[i].psz_text[j] = bs_read( s, 16 );
+                    p_region->p_object_defs[i].psz_text[j] = (char)(bs_read( s, 16 ) & 0xFF);
                 }
                 p_region->p_object_defs[i].psz_text[j] = 0;
             }
@@ -1286,6 +1387,8 @@ static void free_all( decoder_t *p_dec )
     dvbsub_region_t *p_reg, *p_reg_next;
     dvbsub_clut_t *p_clut, *p_clut_next;
 
+    if( p_sys->p_display ) free( p_sys->p_display );
+
     for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut_next )
     {
         p_clut_next = p_clut->p_next;
@@ -1394,6 +1497,7 @@ static subpicture_t *render( decoder_t *p_dec )
         }
         p_spu_region->i_x = p_regiondef->i_x;
         p_spu_region->i_y = p_regiondef->i_y;
+        p_spu_region->i_align = p_sys->i_spu_position;
         *pp_spu_region = p_spu_region;
         pp_spu_region = &p_spu_region->p_next;
 
@@ -1405,8 +1509,8 @@ static subpicture_t *render( decoder_t *p_dec )
         for( j = 0; j < fmt.p_palette->i_entries; j++ )
         {
             fmt.p_palette->palette[j][0] = p_color[j].Y;
-            fmt.p_palette->palette[j][1] = p_color[j].Cr;
-            fmt.p_palette->palette[j][2] = p_color[j].Cb;
+            fmt.p_palette->palette[j][1] = p_color[j].Cb; /* U == Cb */
+            fmt.p_palette->palette[j][2] = p_color[j].Cr; /* V == Cr */
             fmt.p_palette->palette[j][3] = 0xff - p_color[j].T;
         }
 
@@ -1448,6 +1552,7 @@ static subpicture_t *render( decoder_t *p_dec )
             p_spu_region->psz_text = strdup( p_object_def->psz_text );
             p_spu_region->i_x = p_regiondef->i_x + p_object_def->i_x;
             p_spu_region->i_y = p_regiondef->i_y + p_object_def->i_y;
+            p_spu_region->i_align = p_sys->i_spu_position;
             *pp_spu_region = p_spu_region;
             pp_spu_region = &p_spu_region->p_next;
         }
@@ -1455,15 +1560,33 @@ static subpicture_t *render( decoder_t *p_dec )
 
     /* Set the pf_render callback */
     p_spu->i_start = p_sys->i_pts;
-    p_spu->i_stop = p_spu->i_start + (mtime_t) (i_timeout * 1000000);
     p_spu->b_ephemer = VLC_TRUE;
-    p_spu->b_fade = VLC_TRUE;
+    p_spu->b_pausable = VLC_TRUE;
+    //p_spu->b_fade = VLC_TRUE;
+    //p_spu->i_stop = p_spu->i_start + (mtime_t) (i_timeout * 1000000);
 
     /* Correct positioning of SPU */
     p_spu->b_absolute = p_sys->b_absolute;
     p_spu->i_flags = p_sys->i_spu_position;
     p_spu->i_x = p_sys->i_spu_x;
     p_spu->i_y = p_sys->i_spu_y;
+    p_spu->i_original_picture_width = 720;
+    p_spu->i_original_picture_height = 576;
+
+    if( p_sys->p_display )
+    {
+        p_spu->i_original_picture_width = p_sys->p_display->i_width;
+        p_spu->i_original_picture_height = p_sys->p_display->i_height;
+
+        if( p_sys->p_display->b_windowed )
+        {
+            /* TODO: check that this actually works */
+            p_spu->i_original_picture_width = p_sys->p_display->i_max_x - p_sys->p_display->i_x;
+            p_spu->i_original_picture_height = p_sys->p_display->i_max_y - p_sys->p_display->i_y;
+            p_spu->i_x += p_sys->p_display->i_x;
+            p_spu->i_y += p_sys->p_display->i_y;
+        }
+    }
 
     return p_spu;
 }
@@ -1544,7 +1667,7 @@ static int OpenEncoder( vlc_object_t *p_this )
     return VLC_SUCCESS;
 }
 
-/* FIXME: this routine is a hack to convert VLC_FOURCC('Y','U','V','A') 
+/* FIXME: this routine is a hack to convert VLC_FOURCC('Y','U','V','A')
  *        into VLC_FOURCC('Y','U','V','P')
  */
 static subpicture_t *YuvaYuvp( encoder_t *p_enc, subpicture_t *p_subpic )
@@ -1571,7 +1694,7 @@ static subpicture_t *YuvaYuvp( encoder_t *p_enc, subpicture_t *p_subpic )
                         + p_region->picture.p[0].i_pitch * 1 / 3;
         int i_tolerance = 0;
 
-#if DEBUG_DVBSUB
+#ifdef DEBUG_DVBSUB
         msg_Dbg( p_enc, "YuvaYuvp: i_pixels=%d, i_iterator=%d", i_pixels, i_iterator );
 #endif
         p_fmt->i_chroma = VLC_FOURCC('Y','U','V','P');
@@ -1648,7 +1771,7 @@ static subpicture_t *YuvaYuvp( encoder_t *p_enc, subpicture_t *p_subpic )
             }
         }
 
-#if DEBUG_DVBSUB
+#ifdef DEBUG_DVBSUB
         msg_Dbg( p_enc, "best palette has %d colors", p_fmt->p_palette->i_entries );
 #endif
 
@@ -1742,7 +1865,7 @@ static subpicture_t *YuvaYuvp( encoder_t *p_enc, subpicture_t *p_subpic )
             p_fmt->p_palette->palette[i][3] = 0;
         }
         p_fmt->p_palette->i_entries = i_max_entries;
-#if DEBUG_DVBSUB
+#ifdef DEBUG_DVBSUB
         msg_Dbg( p_enc, "best palette has %d colors", p_fmt->p_palette->i_entries );
 #endif
     }
@@ -1780,7 +1903,14 @@ static block_t *Encode( encoder_t *p_enc, subpicture_t *p_subpic )
     if( !p_region ) return NULL;
 
     if( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') &&
-        p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') ) return NULL;
+        p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') )
+    {
+        char psz_fourcc[5];
+        memset( &psz_fourcc, 0, sizeof(char)*5 );
+        vlc_fourcc_to_char( p_region->fmt.i_chroma, &psz_fourcc );
+        msg_Err( p_enc, "chroma %4s not supported", &psz_fourcc );
+        return NULL;
+    }
 
     if( p_region->fmt.p_palette )
     {
@@ -1799,7 +1929,7 @@ static block_t *Encode( encoder_t *p_enc, subpicture_t *p_subpic )
     }
     /* End of hack */
 
-#if DEBUG_DVBSUB
+#ifdef DEBUG_DVBSUB
     msg_Dbg( p_enc, "encoding subpicture" );
 #endif
     p_block = block_New( p_enc, 64000 );
@@ -1892,7 +2022,7 @@ static void encode_page_composition( encoder_t *p_enc, bs_t *s,
         }
 
         if( ( p_sys->p_regions[i_regions].i_width <
-              (int)p_region->fmt.i_visible_width ) || 
+              (int)p_region->fmt.i_visible_width ) ||
             ( p_sys->p_regions[i_regions].i_width >
               (int)p_region->fmt.i_visible_width ) )
         {
@@ -1942,8 +2072,8 @@ static void encode_page_composition( encoder_t *p_enc, bs_t *s,
         }
         else
         {
-            bs_write( s, 16, p_region->i_x );
-            bs_write( s, 16, p_region->i_y );
+            bs_write( s, 16, p_subpic->i_x + p_region->i_x );
+            bs_write( s, 16, p_subpic->i_y + p_region->i_y );
         }
     }
 }