]> git.sesse.net Git - vlc/blobdiff - modules/codec/dvbsub.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / modules / codec / dvbsub.c
index ee15d26a5ede75816830743fc9302de7bfe54e4c..fb7619cfa4a22e54605cce34572b852095c48024 100644 (file)
@@ -3,7 +3,7 @@
  *            DVB subtitles encoder (developed for Anevia, www.anevia.com)
  *****************************************************************************
  * Copyright (C) 2003 ANEVIA
- * Copyright (C) 2003-2005 the VideoLAN team
+ * Copyright (C) 2003-2009 the VideoLAN team
  * $Id$
  *
  * Authors: Gildas Bazin <gbazin@videolan.org>
@@ -11,6 +11,7 @@
  *          Laurent Aimar <fenrir@via.ecp.fr>
  *          Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
  *          Derk-Jan Hartman <hartman #at# videolan dot org>
+ *          Simon Hailes <simon _a_ screen.subtitling.com>
  *
  * 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
  * GNU General Public License for more details.
  *
  * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
+
 /*****************************************************************************
  * Preamble
  *
  * 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
+ * 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.
  *****************************************************************************
+ *
+ *****************************************************************************
  * Notes on DDS (Display Definition Segment)
- * DDS (Display Definition Segment) tells the decoder how the subtitle image relates to
- * the video image.
- * For SD, the subtitle image is always considered to be for display at 720x576
- * (although it's assumed that for NTSC, this is 720x480, this is not documented well)
- * Also, for SD, the subtitle image is drawn 'on the glass' (i.e. after video scaling,
-       + * letterbox, etc.)
- * For 'HD' (subs marked type 0x14/0x24 in PSI), a DDS must be present, and the subs area
- * is drawn onto the video area (scales if necessary).  The DDS tells the decoder what 
- * resolution the subtitle images were intended for, and hence how to scale the subtitle 
- * images for a particular video size  
- * i.e. if HD video is presented as letterbox, the subs will
- * be in the same place on the video as if the video was presented on an HD set
- * indeed, if the HD video was pillarboxed by the decoder, the subs may be cut off as
- * well as the video.  The intent here is that the subs can be placed accurately on the video
- * - somthing which was missed in the original spec.
- * 
+ * -----------------------------------------
+ * DDS (Display Definition Segment) tells the decoder how the subtitle image
+ * relates to the video image.
+ * For SD, the subtitle image is always considered to be for display at
+ * 720x576 (although it's assumed that for NTSC, this is 720x480, this
+ * is not documented well) Also, for SD, the subtitle image is drawn 'on
+ * the glass' (i.e. after video scaling, letterbox, etc.)
+ * For 'HD' (subs marked type 0x14/0x24 in PSI), a DDS must be present,
+ * and the subs area is drawn onto the video area (scales if necessary).
+ * The DDS tells the decoder what resolution the subtitle images were
+ * intended for, and hence how to scale the subtitle images for a
+ * particular video size
+ * i.e. if HD video is presented as letterbox, the subs will be in the
+ * same place on the video as if the video was presented on an HD set
+ * indeed, if the HD video was pillarboxed by the decoder, the subs may
+ * be cut off as well as the video. The intent here is that the subs can
+ * be placed accurately on the video - something which was missed in the
+ * original spec.
+ *
  * A DDS may also specify a window - this is where the subs images are moved so that the (0,0)
  * origin of decode is offset.
  ********************************************************************************************/
@@ -171,7 +178,7 @@ typedef struct dvbsub_display_s
     int                     i_width;
     int                     i_height;
 
-    bool              b_windowed;
+    bool                    b_windowed;
     /* these values are only relevant if windowed */
     int                     i_x;
     int                     i_y;
@@ -240,25 +247,25 @@ typedef struct
 
 struct decoder_sys_t
 {
-    bs_t            bs;
+    bs_t               bs;
 
     /* Decoder internal data */
-    int             i_id;
-    int             i_ancillary_id;
-    mtime_t         i_pts;
-
-    bool      b_absolute;
-    int             i_spu_position;
-    int             i_spu_x;
-    int             i_spu_y;
-
-    bool      b_page;
-    dvbsub_page_t   *p_page;
-    dvbsub_region_t *p_regions;
-    dvbsub_clut_t   *p_cluts;
+    int                i_id;
+    int                i_ancillary_id;
+    mtime_t            i_pts;
+
+    bool               b_absolute;
+    int                i_spu_position;
+    int                i_spu_x;
+    int                i_spu_y;
+
+    bool               b_page;
+    dvbsub_page_t      *p_page;
+    dvbsub_region_t    *p_regions;
+    dvbsub_clut_t      *p_cluts;
     /* this is very small, so keep forever */
-    dvbsub_display_t display;
-    dvbsub_clut_t    default_clut;
+    dvbsub_display_t   display;
+    dvbsub_clut_t      default_clut;
 };
 
 
@@ -316,7 +323,6 @@ static int Open( vlc_object_t *p_this )
 {
     decoder_t     *p_dec = (decoder_t *) p_this;
     decoder_sys_t *p_sys;
-    vlc_value_t    val;
     int i_posx, i_posy;
 
     if( p_dec->fmt_in.i_codec != VLC_CODEC_DVBS )
@@ -325,12 +331,11 @@ 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) );
+    p_sys = p_dec->p_sys = calloc( 1, sizeof(decoder_sys_t) );
     if( !p_sys )
         return VLC_ENOMEM;
-    memset( p_sys, 0, sizeof(decoder_sys_t) );
 
-    p_sys->i_pts          = (mtime_t) 0;
+    p_sys->i_pts          = VLC_TS_INVALID;
     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;
 
@@ -341,18 +346,10 @@ static int Open( vlc_object_t *p_this )
     /* configure for SD res in case DDS is not present */
     default_dds_init( p_dec );
 
-    var_Create( p_this, DVBSUB_CFG_PREFIX "position",
-                VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, DVBSUB_CFG_PREFIX "position", &val );
-    p_sys->i_spu_position = val.i_int;
-    var_Create( p_this, DVBSUB_CFG_PREFIX "x",
-                VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, DVBSUB_CFG_PREFIX "x", &val );
-    i_posx = val.i_int;
-    var_Create( p_this, DVBSUB_CFG_PREFIX "y",
-                VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, DVBSUB_CFG_PREFIX "y", &val );
-    i_posy = val.i_int;
+    p_sys->i_spu_position = var_CreateGetInteger( p_this,
+                                    DVBSUB_CFG_PREFIX "position" );
+    i_posx = var_CreateGetInteger( p_this, DVBSUB_CFG_PREFIX "x" );
+    i_posy = var_CreateGetInteger( p_this, DVBSUB_CFG_PREFIX "y" );
 
     /* Check if subpicture position was overridden */
     p_sys->b_absolute = true;
@@ -408,7 +405,7 @@ static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
         default_dds_init( p_dec );
 
     p_sys->i_pts = p_block->i_pts;
-    if( p_sys->i_pts <= 0 )
+    if( p_sys->i_pts <= VLC_TS_INVALID )
     {
 #ifdef DEBUG_DVBSUB
         /* Some DVB channels send stuffing segments in non-dated packets so
@@ -869,10 +866,9 @@ static void decode_region_composition( decoder_t *p_dec, bs_t *s )
 #ifdef DEBUG_DVBSUB
         msg_Dbg( p_dec, "new region: %i", i_id );
 #endif
-        p_region = *pp_region = malloc( sizeof(dvbsub_region_t) );
+        p_region = *pp_region = calloc( 1, sizeof(dvbsub_region_t) );
         if( !p_region )
             return;
-        memset( p_region, 0, sizeof(dvbsub_region_t) );
         p_region->p_object_defs = NULL;
         p_region->p_pixbuf = NULL;
         p_region->p_next = NULL;
@@ -917,7 +913,7 @@ static void decode_region_composition( decoder_t *p_dec, bs_t *s )
             free( p_region->p_pixbuf );
         }
 
-        p_region->p_pixbuf = malloc( i_height * i_width );
+        p_region->p_pixbuf = xmalloc( i_height * i_width );
         p_region->i_depth = 0;
         b_fill = true;
     }
@@ -951,8 +947,7 @@ static void decode_region_composition( decoder_t *p_dec, bs_t *s )
 
         /* We create a new object */
         p_region->i_object_defs++;
-        p_region->p_object_defs =
-            realloc( p_region->p_object_defs,
+        p_region->p_object_defs = xrealloc( p_region->p_object_defs,
                      sizeof(dvbsub_objectdef_t) * p_region->i_object_defs );
 
         /* We parse object properties */
@@ -1169,7 +1164,7 @@ static void decode_object( decoder_t *p_dec, bs_t *s )
                 if( p_region->p_object_defs[i].i_id != i_id ) continue;
 
                 p_region->p_object_defs[i].psz_text =
-                    realloc( p_region->p_object_defs[i].psz_text,
+                    xrealloc( p_region->p_object_defs[i].psz_text,
                              i_number_of_codes + 1 );
 
                 /* FIXME 16bits -> char ??? See Preamble */
@@ -1482,17 +1477,18 @@ static subpicture_t *render( decoder_t *p_dec )
     int i_base_y;
 
     /* Allocate the subpicture internal data. */
-    p_spu = decoder_NewSubpicture( p_dec );
+    p_spu = decoder_NewSubpicture( p_dec, NULL );
     if( !p_spu )
         return NULL;
 
     p_spu->b_absolute = p_sys->b_absolute;
     /* Set the pf_render callback */
-    p_spu->i_start = (mtime_t) p_sys->i_pts;
+    p_spu->i_start = p_sys->i_pts;
     //p_spu->i_stop = (mtime_t) 0;
     p_spu->b_ephemer = true;
     //p_spu->b_fade = true;
     //p_spu->i_stop = p_spu->i_start + (mtime_t) (i_timeout * 1000000);
+    p_spu->b_subtitle = true;
 
     /* Correct positioning of SPU */
     i_base_x = p_sys->i_spu_x;
@@ -1553,8 +1549,8 @@ static subpicture_t *render( decoder_t *p_dec )
         if (p_region)
         {
                 msg_Dbg( p_dec, "rendering region %i (%i,%i) to (%i,%i)", i,
-                        p_regiondef->i_x, p_regiondef->i_y, 
-                p_regiondef->i_x + p_region->i_width, 
+                        p_regiondef->i_x, p_regiondef->i_y,
+                p_regiondef->i_x + p_region->i_width,
                 p_regiondef->i_y + p_region->i_height );
         }
         else
@@ -1581,13 +1577,14 @@ static subpicture_t *render( decoder_t *p_dec )
             continue;
         }
 
-        /* FIXME: don't create a subpicture region with VLC CODEC YUVP 
+        /* FIXME: don't create a subpicture region with VLC CODEC YUVP
          * when it actually is a TEXT region */
 
         /* Create new SPU region */
         memset( &fmt, 0, sizeof(video_format_t) );
         fmt.i_chroma = VLC_CODEC_YUVP;
-        fmt.i_aspect = 0; /* 0 means use aspect ratio of background video */
+        fmt.i_sar_num = 0; /* 0 means use aspect ratio of background video */
+        fmt.i_sar_den = 1;
         fmt.i_width = fmt.i_visible_width = p_region->i_width;
         fmt.i_height = fmt.i_visible_height = p_region->i_height;
         fmt.i_x_offset = fmt.i_y_offset = 0;
@@ -1640,16 +1637,12 @@ static subpicture_t *render( decoder_t *p_dec )
             /* Create new SPU region */
             memset( &fmt, 0, sizeof(video_format_t) );
             fmt.i_chroma = VLC_CODEC_TEXT;
-            fmt.i_aspect = VOUT_ASPECT_FACTOR;
+            fmt.i_sar_num = 1;
+            fmt.i_sar_den = 1;
             fmt.i_width = fmt.i_visible_width = p_region->i_width;
             fmt.i_height = fmt.i_visible_height = p_region->i_height;
             fmt.i_x_offset = fmt.i_y_offset = 0;
             p_spu_region = subpicture_region_New( &fmt );
-            if( !p_region )
-            {
-                msg_Err( p_dec, "cannot allocate SPU region" );
-                continue;
-            }
 
             p_spu_region->psz_text = strdup( p_object_def->psz_text );
             p_spu_region->i_x = i_base_x + p_regiondef->i_x + p_object_def->i_x;
@@ -1701,7 +1694,6 @@ static int OpenEncoder( vlc_object_t *p_this )
 {
     encoder_t *p_enc = (encoder_t *)p_this;
     encoder_sys_t *p_sys;
-    vlc_value_t val;
 
     if( ( p_enc->fmt_out.i_codec != VLC_CODEC_DVBS ) &&
         !p_enc->b_force )
@@ -1726,12 +1718,8 @@ static int OpenEncoder( vlc_object_t *p_this )
     p_sys->i_regions = 0;
     p_sys->p_regions = 0;
 
-    var_Create( p_this, ENC_CFG_PREFIX "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, ENC_CFG_PREFIX "x", &val );
-    p_sys->i_offset_x = val.i_int;
-    var_Create( p_this, ENC_CFG_PREFIX "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, ENC_CFG_PREFIX "y", &val );
-    p_sys->i_offset_y = val.i_int;
+    p_sys->i_offset_x = var_CreateGetInteger( p_this, ENC_CFG_PREFIX "x" );
+    p_sys->i_offset_y = var_CreateGetInteger( p_this, ENC_CFG_PREFIX "y" );
 
     return VLC_SUCCESS;
 }
@@ -1847,7 +1835,7 @@ static subpicture_t *YuvaYuvp( subpicture_t *p_subpic )
 #endif
 
 #ifndef RANDOM_DITHERING
-        pi_delta = malloc( ( p_region->p_picture->p[0].i_pitch + 1 )
+        pi_delta = xmalloc( ( p_region->p_picture->p[0].i_pitch + 1 )
                             * sizeof(int) * 4  );
         for( i = 0; i < (p_region->p_picture->p[0].i_pitch + 1) * 4 ; i++ )
         {
@@ -1980,7 +1968,7 @@ static block_t *Encode( encoder_t *p_enc, subpicture_t *p_subpic )
         char psz_fourcc[5];
         memset( &psz_fourcc, 0, sizeof( psz_fourcc ) );
         vlc_fourcc_to_char( p_region->fmt.i_chroma, &psz_fourcc );
-        msg_Err( p_enc, "chroma %4s not supported", psz_fourcc );
+        msg_Err( p_enc, "chroma %4.4s not supported", psz_fourcc );
         return NULL;
     }
 
@@ -2087,9 +2075,8 @@ static void encode_page_composition( encoder_t *p_enc, bs_t *s,
         {
             encoder_region_t region;
             region.i_width = region.i_height = 0;
-            p_sys->p_regions =
-                realloc( p_sys->p_regions, sizeof(encoder_region_t) *
-                         (p_sys->i_regions + 1) );
+            p_sys->p_regions = xrealloc( p_sys->p_regions,
+                          sizeof(encoder_region_t) * (p_sys->i_regions + 1) );
             p_sys->p_regions[p_sys->i_regions++] = region;
         }