]> git.sesse.net Git - vlc/blobdiff - src/video_output/vout_subpictures.c
MKV USF subtitles support and other Subtitles improvements.
[vlc] / src / video_output / vout_subpictures.c
index 137f9e9df0e242fd20bed134b326137298d47f60..d16716859575539d79a6fd0cdc4ca7b8a4ba1c70 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * vout_subpictures.c : subpicture management functions
  *****************************************************************************
- * Copyright (C) 2000-2005 VideoLAN
+ * Copyright (C) 2000-2005 the VideoLAN team
  * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
@@ -20,7 +20,7 @@
  *
  * 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.
  *****************************************************************************/
 
 /*****************************************************************************
 #include <string.h>                                            /* strerror() */
 
 #include <vlc/vlc.h>
-
-#include "vlc_block.h"
-#include "vlc_video.h"
-#include "video_output.h"
-#include "vlc_spu.h"
-#include "vlc_filter.h"
+#include <vlc_vout.h>
+#include <vlc_block.h>
+#include <vlc_filter.h>
+#include <vlc_osd.h>
 
 /*****************************************************************************
  * Local prototypes
@@ -98,7 +96,7 @@ spu_t *__spu_Create( vlc_object_t *p_this )
  */
 int spu_Init( spu_t *p_spu )
 {
-    char *psz_filter, *psz_filter_orig;
+    char *psz_parser;
     vlc_value_t val;
 
     /* If the user requested a sub margin, we force the position. */
@@ -108,22 +106,27 @@ int spu_Init( spu_t *p_spu )
 
     var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
     var_Get( p_spu, "sub-filter", &val );
-    psz_filter = psz_filter_orig = val.psz_string;
-    while( psz_filter && *psz_filter )
+
+    psz_parser = val.psz_string;
+
+    while( psz_parser && *psz_parser )
     {
-        char *psz_parser = strchr( psz_filter, ',' );
-        if( !psz_parser ) psz_parser = strchr( psz_filter, ':' );
+        config_chain_t *p_cfg; /* Do we ever need to free this ? */
+        char *psz_name;
+
+        psz_parser = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
 
-        if( psz_parser ) *psz_parser++ = 0;
+        msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
 
         p_spu->pp_filter[p_spu->i_filter] =
             vlc_object_create( p_spu, VLC_OBJECT_FILTER );
         vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
+        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;;
         p_spu->pp_filter[p_spu->i_filter]->p_module =
             module_Need( p_spu->pp_filter[p_spu->i_filter],
-                         "sub filter", psz_filter, 0 );
+                         "sub filter", psz_name, 0 );
         if( p_spu->pp_filter[p_spu->i_filter]->p_module )
         {
             filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
@@ -144,9 +147,9 @@ int spu_Init( spu_t *p_spu )
             msg_Dbg( p_spu, "can't add anymore filters" );
         }
 
-        psz_filter = psz_parser;
+        free( psz_name );
     }
-    if( psz_filter_orig ) free( psz_filter_orig );
+    if( val.psz_string ) free( val.psz_string );
 
     return VLC_EGENERIC;
 }
@@ -257,14 +260,14 @@ subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
     p_region->p_cache = 0;
     p_region->fmt = *p_fmt;
     p_region->psz_text = 0;
-    p_region->i_text_color = 0xFFFFFF;
+    p_region->p_style = NULL;
 
     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
         p_fmt->p_palette = p_region->fmt.p_palette =
             malloc( sizeof(video_palette_t) );
     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
 
-    p_region->picture.p_data_orig = 0;
+    p_region->picture.p_data_orig = NULL;
 
     if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
 
@@ -300,7 +303,7 @@ subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
     p_region->p_cache = 0;
     p_region->fmt = *p_fmt;
     p_region->psz_text = 0;
-    p_region->i_text_color = 0xFFFFFF;
+    p_region->p_style = NULL;
 
     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
         p_fmt->p_palette = p_region->fmt.p_palette =
@@ -325,8 +328,11 @@ void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
     if( p_region->picture.pf_release )
         p_region->picture.pf_release( &p_region->picture );
     if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
-    if( p_region->psz_text ) free( p_region->psz_text );
     if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
+
+    if( p_region->psz_text )
+        free( p_region->psz_text );
+    //free( p_region->p_style ); FIXME --fenrir plugin does not allocate the memory for it. I think it might lead to segfault, video renderer can live longer than the decoder
     free( p_region );
 }
 
@@ -403,6 +409,7 @@ subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
     memset( p_subpic, 0, sizeof(subpicture_t) );
     p_subpic->i_status   = RESERVED_SUBPICTURE;
     p_subpic->b_absolute = VLC_TRUE;
+    p_subpic->b_pausable = VLC_FALSE;
     p_subpic->b_fade     = VLC_FALSE;
     p_subpic->i_alpha    = 0xFF;
     p_subpic->p_region   = 0;
@@ -414,7 +421,7 @@ subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
     p_subpic->pf_create_region = __spu_CreateRegion;
     p_subpic->pf_make_region = __spu_MakeRegion;
     p_subpic->pf_destroy_region = __spu_DestroyRegion;
-    
+
     return p_subpic;
 }
 
@@ -473,9 +480,6 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
                             subpicture_t *p_subpic,
                             int i_scale_width_orig, int i_scale_height_orig )
 {
-
-    int i_subpic_x;
-  
     /* Get lock */
     vlc_mutex_lock( &p_spu->subpicture_lock );
 
@@ -484,6 +488,7 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
     {
         subpicture_region_t *p_region = p_subpic->p_region;
         int i_scale_width, i_scale_height;
+        int i_subpic_x = p_subpic->i_x;
 
         /* Load the blending module */
         if( !p_spu->p_blend && p_region )
@@ -501,70 +506,102 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
         }
 
         /* Load the text rendering module */
-        if( !p_spu->p_text && p_region )
+        if( !p_spu->p_text && p_region && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
         {
+            char *psz_modulename = NULL;
+
             p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
             vlc_object_attach( p_spu->p_text, p_spu );
 
             p_spu->p_text->fmt_out.video.i_width =
                 p_spu->p_text->fmt_out.video.i_visible_width =
-                    p_fmt->i_width;
+                p_fmt->i_width;
             p_spu->p_text->fmt_out.video.i_height =
                 p_spu->p_text->fmt_out.video.i_visible_height =
-                    p_fmt->i_height;
-                
+                p_fmt->i_height;
+
             p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
             p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
-            p_spu->p_text->p_module =
-                module_Need( p_spu->p_text, "text renderer", 0, 0 );
+
+            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
+            if( psz_modulename && *psz_modulename )
+            {
+                p_spu->p_text->p_module =
+                    module_Need( p_spu->p_text, "text renderer", psz_modulename, VLC_TRUE );
+            }
+            if( !p_spu->p_text->p_module )
+            {
+                p_spu->p_text->p_module =
+                    module_Need( p_spu->p_text, "text renderer", 0, 0 );
+            }
+            if( psz_modulename ) free( psz_modulename );
         }
-        else if( p_region )
+        if( p_spu->p_text )
         {
-            p_spu->p_text->fmt_out.video.i_width =
-                p_spu->p_text->fmt_out.video.i_visible_width =
+            if( p_subpic->i_original_picture_height > 0 &&
+                p_subpic->i_original_picture_width  > 0 )
+            {
+                p_spu->p_text->fmt_out.video.i_width =
+                    p_spu->p_text->fmt_out.video.i_visible_width =
+                    p_subpic->i_original_picture_width;
+                p_spu->p_text->fmt_out.video.i_height =
+                    p_spu->p_text->fmt_out.video.i_visible_height =
+                    p_subpic->i_original_picture_height;
+            }
+            else
+            {
+                p_spu->p_text->fmt_out.video.i_width =
+                    p_spu->p_text->fmt_out.video.i_visible_width =
                     p_fmt->i_width;
-            p_spu->p_text->fmt_out.video.i_height =
-                p_spu->p_text->fmt_out.video.i_visible_height =
+                p_spu->p_text->fmt_out.video.i_height =
+                    p_spu->p_text->fmt_out.video.i_visible_height =
                     p_fmt->i_height;
+            }
         }
 
-       if (p_subpic->p_region->fmt.i_aspect == 0)
-         /* Set subtitle to be the same aspect ratio as the background
-            source video.
-          */
-         p_subpic->p_region->fmt.i_aspect = p_pic_src->format.i_aspect;
-
         i_scale_width = i_scale_width_orig;
         i_scale_height = i_scale_height_orig;
 
-        if( p_subpic->i_original_picture_width &&
-            p_subpic->i_original_picture_height )
+        if( p_subpic->i_original_picture_height > 0 &&
+            p_subpic->i_original_picture_width  > 0 )
         {
             i_scale_width = i_scale_width * p_fmt->i_width /
-                p_subpic->i_original_picture_width;
+                             p_subpic->i_original_picture_width;
             i_scale_height = i_scale_height * p_fmt->i_height /
-                p_subpic->i_original_picture_height;
+                             p_subpic->i_original_picture_height;
+        }
+        else if( p_subpic->i_original_picture_height > 0 )
+        {
+            i_scale_height = i_scale_height * p_fmt->i_height /
+                             p_subpic->i_original_picture_height;
+            i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height; 
         }
 
-        /* Take care of the aspect ratio */
-
-       if( p_subpic->p_region->fmt.i_aspect != p_pic_src->format.i_aspect)
-       {
-         i_scale_width = (p_subpic->p_region->fmt.i_aspect*1000) / 
-           p_pic_src->format.i_aspect;
-         i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
-       } else 
-         i_subpic_x = p_subpic->i_x;
-
+        /* Set default subpicture aspect ratio */
+        if( p_region && p_region->fmt.i_aspect &&
+            (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
+        {
+            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
+            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
+        }
+        if( p_region &&
+            (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
+        {
+            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
+            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
+        }
 
+        /* Take care of the aspect ratio */
         if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
             p_region->fmt.i_sar_den * p_fmt->i_sar_num )
         {
             i_scale_width = i_scale_width *
                 (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
                 p_region->fmt.i_sar_den / p_fmt->i_sar_num;
+            i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
         }
 
+        /* Load the scaling module */
         if( !p_spu->p_scale && (i_scale_width != 1000 ||
             i_scale_height != 1000) )
         {
@@ -584,18 +621,7 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
                 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
         }
 
-        if( p_subpic->pf_render )
-        {
-            /* HACK to remove when the ogt subpic decoder is gone */
-            if( p_spu->p_parent &&
-                p_spu->p_parent->i_object_type == VLC_OBJECT_VOUT )
-            {
-                vout_thread_t *p_vout = (vout_thread_t *)p_spu->p_parent;
-                p_subpic->pf_render( p_vout, p_pic_dst, p_subpic );
-            }
-        }
-        else while( p_region && p_spu->p_blend &&
-                    p_spu->p_blend->pf_video_blend )
+        while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
         {
             int i_fade_alpha = 255;
             int i_x_offset = p_region->i_x + i_subpic_x;
@@ -603,23 +629,29 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
 
             if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
             {
-                if( p_spu->p_text && p_spu->p_text->p_module &&
-                    p_spu->p_text->pf_render_text )
+                if( p_spu->p_text && p_spu->p_text->p_module )
                 {
-                    p_region->i_text_align = p_subpic->i_flags & 0x3;
-                    p_spu->p_text->pf_render_text( p_spu->p_text,
-                                                   p_region, p_region ); 
+                    p_region->i_align = p_subpic->i_flags;
+
+                    if( p_spu->p_text->pf_render_html && p_region->psz_html )
+                    {
+                        p_spu->p_text->pf_render_html( p_spu->p_text,
+                                                       p_region, p_region );
+                    }
+                    else if( p_spu->p_text->pf_render_text )
+                    {
+                        p_spu->p_text->pf_render_text( p_spu->p_text,
+                                                       p_region, p_region ); 
+                    }
                 }
             }
 
             /* Force palette if requested */
-            if( p_spu->b_force_alpha && VLC_FOURCC('Y','U','V','P') ==
+            if( p_spu->b_force_palette && VLC_FOURCC('Y','U','V','P') ==
                 p_region->fmt.i_chroma )
             {
-                p_region->fmt.p_palette->palette[0][3] = p_spu->pi_alpha[0];
-                p_region->fmt.p_palette->palette[1][3] = p_spu->pi_alpha[1];
-                p_region->fmt.p_palette->palette[2][3] = p_spu->pi_alpha[2];
-                p_region->fmt.p_palette->palette[3][3] = p_spu->pi_alpha[3];
+                memcpy( p_region->fmt.p_palette->palette,
+                        p_spu->palette, 16 );
             }
 
             /* Scale SPU if necessary */
@@ -710,15 +742,21 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
                 i_y_offset = p_region->i_y +
                     p_subpic->i_y * i_scale_height / 1000;
 
-                if( p_spu->i_margin >= 0 )
-                {
-                    if( p_subpic->i_height + (unsigned int)p_spu->i_margin <=
-                        p_fmt->i_height )
-                    {
-                        i_y_offset = p_fmt->i_height -
-                            p_spu->i_margin - p_subpic->i_height;
-                    }
-                }
+            }
+            
+            i_x_offset = __MAX( i_x_offset, 0 );
+            i_y_offset = __MAX( i_y_offset, 0 );
+
+            if( p_spu->i_margin != 0 && p_spu->b_force_crop == VLC_FALSE )
+            {
+                int i_diff = 0;
+                int i_low = i_y_offset - p_spu->i_margin;
+                int i_high = i_y_offset + p_region->fmt.i_height - p_spu->i_margin;
+
+                /* crop extra margin to keep within bounds */
+                if( i_low < 0 ) i_diff = i_low;
+                if( i_high > (int)p_fmt->i_height ) i_diff = i_high - p_fmt->i_height;
+                i_y_offset -= ( p_spu->i_margin + i_diff );
             }
 
             p_spu->p_blend->fmt_in.video = p_region->fmt;
@@ -781,6 +819,9 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
                 }
             }
 
+            i_x_offset = __MAX( i_x_offset, 0 );
+            i_y_offset = __MAX( i_y_offset, 0 );
+
             p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
                 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
                 i_fade_alpha * p_subpic->i_alpha / 255 );
@@ -805,7 +846,8 @@ void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
  * to be removed if a newer one is available), which makes it a lot
  * more difficult to guess if a subpicture has to be rendered or not.
  *****************************************************************************/
-subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
+subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
+                                   vlc_bool_t b_paused )
 {
     int i_index, i_channel;
     subpicture_t *p_subpic = NULL;
@@ -851,7 +893,9 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
             if( display_date > p_spu->p_subpicture[i_index].i_stop &&
                 ( !p_spu->p_subpicture[i_index].b_ephemer ||
                   p_spu->p_subpicture[i_index].i_stop >
-                  p_spu->p_subpicture[i_index].i_start ) )
+                  p_spu->p_subpicture[i_index].i_start ) &&
+                !( p_spu->p_subpicture[i_index].b_pausable &&
+                   b_paused ) )
             {
                 /* Too late, destroy the subpic */
                 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
@@ -947,8 +991,6 @@ static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
     case SPU_CHANNEL_REGISTER:
         pi = (int *)va_arg( args, int * );
         if( pi ) *pi = p_spu->i_channel++;
-        msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
-                 p_spu->i_channel - 1 );
         break;
 
     case SPU_CHANNEL_CLEAR:
@@ -978,7 +1020,7 @@ static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
 {
     vlc_value_t val;
 
-    p_spu->b_force_alpha = VLC_FALSE;
+    p_spu->b_force_palette = VLC_FALSE;
     p_spu->b_force_crop = VLC_FALSE;
 
     if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
@@ -993,32 +1035,16 @@ static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
     var_Get( p_object, "y-end", &val );
     p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
 
-#if 0
-    if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
+    if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
     {
-        int i;
-        for( i = 0; i < 4; i++ )
-        {
-            p_spu->pi_color[i] = ((uint8_t *)val.p_address)[i];
-        }
-    }
-#endif
-
-    if( var_Get( p_object, "menu-contrast", &val ) == VLC_SUCCESS )
-    {
-        int i;
-        for( i = 0; i < 4; i++ )
-        {
-            p_spu->pi_alpha[i] = ((uint8_t *)val.p_address)[i];
-            p_spu->pi_alpha[i] = p_spu->pi_alpha[i] == 0xf ?
-                0xff : p_spu->pi_alpha[i] << 4;
-        }
-        p_spu->b_force_alpha = VLC_TRUE;
+        memcpy( p_spu->palette, val.p_address, 16 );
+        p_spu->b_force_palette = VLC_TRUE;
     }
 
-    msg_Dbg( p_object, "crop: %i,%i,%i,%i, alpha: %i",
+    msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
              p_spu->i_crop_x, p_spu->i_crop_y,
-             p_spu->i_crop_width, p_spu->i_crop_height, p_spu->b_force_alpha );
+             p_spu->i_crop_width, p_spu->i_crop_height,
+             p_spu->b_force_palette );
 }
 
 /*****************************************************************************