]> git.sesse.net Git - vlc/blobdiff - src/video_output/vout_subpictures.c
No functionnal changes.
[vlc] / src / video_output / vout_subpictures.c
index 9920b34a757f1444a292be8ceab6be34b5582510..8b8a44825950b6758da8ea5d4858b9dd5bf1e910 100644 (file)
@@ -30,6 +30,9 @@
 # include "config.h"
 #endif
 
+#include <assert.h>
+#include <limits.h>
+
 #include <vlc_common.h>
 #include <vlc_vout.h>
 #include <vlc_block.h>
@@ -39,9 +42,6 @@
 #include "vout_internal.h"
 #include <vlc_image.h>
 
-#include <assert.h>
-#include <limits.h>
-
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
@@ -156,6 +156,8 @@ static void SpuRenderRegion( spu_t *,
 static void UpdateSPU   ( spu_t *, vlc_object_t * );
 static int  CropCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
+static int MarginCallback( vlc_object_t *, char const *,
+                           vlc_value_t, vlc_value_t, void * );
 
 static int SpuControl( spu_t *, int, va_list );
 
@@ -182,21 +184,23 @@ static void FilterRelease( filter_t *p_filter );
 /*****************************************************************************
  * Public API
  *****************************************************************************/
+
+#undef spu_Create
 /**
  * Creates the subpicture unit
  *
  * \param p_this the parent object which creates the subpicture unit
  */
-spu_t *__spu_Create( vlc_object_t *p_this )
+spu_t *spu_Create( vlc_object_t *p_this )
 {
     spu_t *p_spu;
     spu_private_t *p_sys;
+
     p_spu = vlc_custom_create( p_this, sizeof(spu_t) + sizeof(spu_private_t),
                                VLC_OBJECT_GENERIC, "subpicture" );
-
     if( !p_spu )
         return NULL;
+    vlc_object_attach( p_spu, p_this );
 
     /* Initialize spu fields */
     p_spu->pf_control = SpuControl;
@@ -212,11 +216,11 @@ spu_t *__spu_Create( vlc_object_t *p_this )
     p_sys->p_scale = NULL;
     p_sys->p_scale_yuvp = NULL;
 
+    p_sys->i_margin = var_InheritInteger( p_spu, "sub-margin" );
+
     /* Register the default subpicture channel */
     p_sys->i_channel = 2;
 
-    vlc_object_attach( p_spu, p_this );
-
     p_sys->psz_chain_update = NULL;
     p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
                                        SubFilterAllocationInit,
@@ -240,11 +244,6 @@ spu_t *__spu_Create( vlc_object_t *p_this )
  */
 int spu_Init( spu_t *p_spu )
 {
-    spu_private_t *p_sys = p_spu->p;
-
-    /* If the user requested a sub margin, we force the position. */
-    p_sys->i_margin = var_CreateGetInteger( p_spu, "sub-margin" );
-
     var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
     var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
     var_TriggerCallback( p_spu, "sub-filter" );
@@ -303,13 +302,22 @@ void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
     if( b_attach )
     {
         UpdateSPU( p_spu, VLC_OBJECT(p_input) );
+        var_Create( p_input, "highlight", VLC_VAR_BOOL );
         var_AddCallback( p_input, "highlight", CropCallback, p_spu );
+        var_AddCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
+
+        vlc_mutex_lock( &p_spu->p->lock );
+        p_spu->p->i_margin = var_GetInteger( p_input, "sub-margin" );
+        vlc_mutex_unlock( &p_spu->p->lock );
+
         vlc_object_release( p_input );
     }
     else
     {
-        /* Delete callback */
+        /* Delete callbacks */
+        var_DelCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
         var_DelCallback( p_input, "highlight", CropCallback, p_spu );
+        var_Destroy( p_input, "highlight" );
         vlc_object_release( p_input );
     }
 }
@@ -353,11 +361,11 @@ void spu_RenderSubpictures( spu_t *p_spu,
                             picture_t *p_pic_dst, const video_format_t *p_fmt_dst,
                             subpicture_t *p_subpic_list,
                             const video_format_t *p_fmt_src,
-                            mtime_t render_date )
+                            mtime_t render_subtitle_date )
 {
     spu_private_t *p_sys = p_spu->p;
 
-    const mtime_t system_date = mdate();
+    const mtime_t render_osd_date = mdate();
 
     const int i_source_video_width  = p_fmt_src->i_width;
     const int i_source_video_height = p_fmt_src->i_height;
@@ -388,7 +396,7 @@ void spu_RenderSubpictures( spu_t *p_spu,
             fmt_org.i_visible_height = i_source_video_height;
 
             p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org,
-                                         p_subpic->b_subtitle ? render_date : system_date );
+                                         p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
         }
 
         /* */
@@ -469,16 +477,8 @@ void spu_RenderSubpictures( spu_t *p_spu,
         p_region = p_subpic->p_region;
         if( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den )
         {
-            if( p_region->fmt.i_aspect != 0 )
-            {
-                p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
-                p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
-            }
-            else
-            {
-                p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
-                p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
-            }
+            p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
+            p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
         }
 
         /* Take care of the aspect ratio */
@@ -507,7 +507,7 @@ void spu_RenderSubpictures( spu_t *p_spu,
             SpuRenderRegion( p_spu, p_pic_dst, &area,
                              p_subpic, p_region, scale, p_fmt_dst,
                              p_subtitle_area, i_subtitle_area,
-                             p_subpic->b_subtitle ? render_date : system_date );
+                             p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
 
             if( p_subpic->b_subtitle )
             {
@@ -542,13 +542,13 @@ void spu_RenderSubpictures( spu_t *p_spu,
  * 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 render_date,
+subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_subtitle_date,
                                    bool b_subtitle_only )
 {
     spu_private_t *p_sys = p_spu->p;
     int i_channel;
     subpicture_t *p_subpic = NULL;
-    const mtime_t system_date = mdate();
+    const mtime_t render_osd_date = mdate();
 
     /* Update sub-filter chain */
     vlc_mutex_lock( &p_sys->lock );
@@ -566,7 +566,7 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
     }
 
     /* Run subpicture filters */
-    filter_chain_SubFilter( p_sys->p_chain, render_date );
+    filter_chain_SubFilter( p_sys->p_chain, render_osd_date );
 
     vlc_mutex_lock( &p_sys->lock );
 
@@ -578,9 +578,9 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
         bool         pb_available_late[VOUT_MAX_SUBPICTURES];
         int          i_available = 0;
 
-        mtime_t      start_date = render_date;
+        mtime_t      start_date = render_subtitle_date;
         mtime_t      ephemer_subtitle_date = 0;
-        mtime_t      ephemer_system_date = 0;
+        mtime_t      ephemer_osd_date = 0;
         int64_t      i_ephemer_subtitle_order = INT64_MIN;
         int64_t      i_ephemer_system_order = INT64_MIN;
         int i_index;
@@ -605,6 +605,7 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
             {
                 continue;
             }
+            const mtime_t render_date = p_current->b_subtitle ? render_subtitle_date : render_osd_date;
             if( render_date &&
                 render_date < p_current->i_start )
             {
@@ -612,7 +613,7 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
                 continue;
             }
 
-            mtime_t *pi_ephemer_date  = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_system_date;
+            mtime_t *pi_ephemer_date  = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
             int64_t *pi_ephemer_order = p_current->b_subtitle ? &i_ephemer_subtitle_order : &i_ephemer_system_order;
             if( p_current->i_start >= *pi_ephemer_date )
             {
@@ -623,7 +624,7 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
 
             b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
 
-            b_late = b_stop_valid && p_current->i_stop <= p_current->b_subtitle ? render_date : system_date;
+            b_late = b_stop_valid && p_current->i_stop <= render_date;
 
             /* start_date will be used for correct automatic overlap support
              * in case picture that should not be displayed anymore (display_time)
@@ -649,8 +650,8 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
             subpicture_t *p_current = p_available_subpic[i_index];
             bool b_late = pb_available_late[i_index];
 
-            const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : system_date;
-            const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_system_date;
+            const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : render_osd_date;
+            const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_osd_date;
             const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
 
             /* Destroy late and obsolete ephemer subpictures */
@@ -671,7 +672,7 @@ subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
         }
     }
 
-    p_sys->i_last_sort_date = render_date;
+    p_sys->i_last_sort_date = render_subtitle_date;
     vlc_mutex_unlock( &p_sys->lock );
 
     return p_subpic;
@@ -771,7 +772,6 @@ subpicture_t *subpicture_NewFromPicture( vlc_object_t *p_obj,
     p_subpic->i_original_picture_width  = fmt_out.i_width;
     p_subpic->i_original_picture_height = fmt_out.i_height;
 
-    fmt_out.i_aspect = 0;
     fmt_out.i_sar_num =
     fmt_out.i_sar_den = 0;
 
@@ -815,11 +815,10 @@ subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
     if( p_fmt->i_chroma == VLC_CODEC_TEXT )
         return p_region;
 
-    p_region->p_picture = picture_New( p_fmt->i_chroma, p_fmt->i_width, p_fmt->i_height,
-                                       p_fmt->i_aspect );
+    p_region->p_picture = picture_NewFromFormat( p_fmt );
     if( !p_region->p_picture )
     {
-        free( p_fmt->p_palette );
+        free( p_region->fmt.p_palette );
         free( p_region );
         return NULL;
     }
@@ -959,7 +958,6 @@ static void FilterRelease( filter_t *p_filter )
     if( p_filter->p_module )
         module_unneed( p_filter, p_filter->p_module );
 
-    vlc_object_detach( p_filter );
     vlc_object_release( p_filter );
 }
 
@@ -1029,8 +1027,8 @@ static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
     p_scale->fmt_out.video.i_width =
     p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
 
-    p_scale->pf_vout_buffer_new = spu_new_video_buffer;
-    p_scale->pf_vout_buffer_del = spu_del_video_buffer;
+    p_scale->pf_video_buffer_new = spu_new_video_buffer;
+    p_scale->pf_video_buffer_del = spu_del_video_buffer;
 
     vlc_object_attach( p_scale, p_obj );
     p_scale->p_module = module_need( p_scale, "video filter2", NULL, false );
@@ -1192,15 +1190,12 @@ static bool spu_area_overlap( spu_area_t a, spu_area_t b )
  * Avoid area overlapping
  */
 static void SpuAreaFixOverlap( spu_area_t *p_dst,
-                               const spu_area_t *p_master,
                                const spu_area_t *p_sub, int i_sub, int i_align )
 {
     spu_area_t a = spu_area_scaled( *p_dst );
     bool b_moved = false;
     bool b_ok;
 
-    assert( p_master->i_x == 0 && p_master->i_y == 0 );
-
     /* Check for overlap
      * XXX It is not fast O(n^2) but we should not have a lot of region */
     do
@@ -1217,8 +1212,6 @@ static void SpuAreaFixOverlap( spu_area_t *p_dst,
             {
                 /* We go down */
                 int i_y = sub.i_y + sub.i_height;
-                if( i_y + a.i_height > p_master->i_height )
-                    break;
                 a.i_y = i_y;
                 b_moved = true;
             }
@@ -1226,8 +1219,6 @@ static void SpuAreaFixOverlap( spu_area_t *p_dst,
             {
                 /* We go up */
                 int i_y = sub.i_y - a.i_height;
-                if( i_y < 0 )
-                    break;
                 a.i_y = i_y;
                 b_moved = true;
             }
@@ -1248,13 +1239,31 @@ static void SpuAreaFixOverlap( spu_area_t *p_dst,
 }
 
 
+static void SpuAreaFitInside( spu_area_t *p_area, const spu_area_t *p_boundary )
+{
+  spu_area_t a = spu_area_scaled( *p_area );
+
+  const int i_error_x = (a.i_x + a.i_width) - p_boundary->i_width;
+  if( i_error_x > 0 )
+      a.i_x -= i_error_x;
+  if( a.i_x < 0 )
+      a.i_x = 0;
+
+  const int i_error_y = (a.i_y + a.i_height) - p_boundary->i_height;
+  if( i_error_y > 0 )
+      a.i_y -= i_error_y;
+  if( a.i_y < 0 )
+      a.i_y = 0;
+
+  *p_area = spu_area_unscaled( a, p_area->scale );
+}
+
 /**
  * Place a region
  */
 static void SpuRegionPlace( int *pi_x, int *pi_y,
                             const subpicture_t *p_subpic,
-                            const subpicture_region_t *p_region,
-                            int i_margin_y )
+                            const subpicture_region_t *p_region )
 {
     const int i_delta_x = p_region->i_x;
     const int i_delta_y = p_region->i_y;
@@ -1294,10 +1303,12 @@ static void SpuRegionPlace( int *pi_x, int *pi_y,
     }
 
     /* Margin shifts all subpictures */
+    /* NOTE We have margin only for subtitles, so we don't really need this here
     if( i_margin_y != 0 )
-        i_y -= i_margin_y;
+        i_y -= i_margin_y;*/
 
     /* Clamp offset to not go out of the screen (when possible) */
+    /* NOTE Again, useful only for subtitles, otherwise goes against the alignment logic above
     const int i_error_x = (i_x + p_region->fmt.i_width) - p_subpic->i_original_picture_width;
     if( i_error_x > 0 )
         i_x -= i_error_x;
@@ -1308,7 +1319,7 @@ static void SpuRegionPlace( int *pi_x, int *pi_y,
     if( i_error_y > 0 )
         i_y -= i_error_y;
     if( i_y < 0 )
-        i_y = 0;
+        i_y = 0;*/
 
     *pi_x = i_x;
     *pi_y = i_y;
@@ -1395,7 +1406,7 @@ static void SpuRenderRegion( spu_t *p_spu,
     /* Place the picture
      * We compute the position in the rendered size */
     SpuRegionPlace( &i_x_offset, &i_y_offset,
-                    p_subpic, p_region, i_margin_y );
+                    p_subpic, p_region );
 
     /* Save this position for subtitle overlap support
      * it is really important that there are given without scale_size applied */
@@ -1406,16 +1417,26 @@ static void SpuRenderRegion( spu_t *p_spu,
     /* Handle overlapping subtitles when possible */
     if( p_subpic->b_subtitle && !p_subpic->b_absolute )
     {
+        SpuAreaFixOverlap( p_area, p_subtitle_area, i_subtitle_area,
+                           p_region->i_align );
+    }
+
+    /* we copy the area: for the subtitle overlap support we want
+     * to only save the area without margin applied */
+    spu_area_t restrained = *p_area;
+
+    /* apply margin to subtitles and correct if they go over the picture edge */
+    if( p_subpic->b_subtitle )
+    {
+        restrained.i_y -= i_margin_y;
         spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height,
                                               spu_scale_unit() );
-
-        SpuAreaFixOverlap( p_area, &display, p_subtitle_area, i_subtitle_area,
-                           p_region->i_align );
+        SpuAreaFitInside( &restrained, &display );
     }
 
     /* Fix the position for the current scale_size */
-    i_x_offset = spu_scale_w( p_area->i_x, p_area->scale );
-    i_y_offset = spu_scale_h( p_area->i_y, p_area->scale );
+    i_x_offset = spu_scale_w( restrained.i_x, restrained.scale );
+    i_y_offset = spu_scale_h( restrained.i_y, restrained.scale );
 
     /* */
     if( b_force_palette )
@@ -1785,6 +1806,22 @@ static int CropCallback( vlc_object_t *p_object, char const *psz_var,
     return VLC_SUCCESS;
 }
 
+/*****************************************************************************
+ * MarginCallback: called when requested subtitle position has changed         *
+ *****************************************************************************/
+
+static int MarginCallback( vlc_object_t *p_object, char const *psz_var,
+                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
+{
+    VLC_UNUSED( psz_var ); VLC_UNUSED( oldval ); VLC_UNUSED( p_object );
+    spu_private_t *p_sys = ( spu_private_t* ) p_data;
+
+    vlc_mutex_lock( &p_sys->lock );
+    p_sys->i_margin = newval.i_int;
+    vlc_mutex_unlock( &p_sys->lock );
+    return VLC_SUCCESS;
+}
+
 /*****************************************************************************
  * Buffers allocation callbacks for the filters
  *****************************************************************************/
@@ -1825,8 +1862,7 @@ static picture_t *spu_new_video_buffer( filter_t *p_filter )
     const video_format_t *p_fmt = &p_filter->fmt_out.video;
 
     VLC_UNUSED(p_filter);
-    return picture_New( p_fmt->i_chroma,
-                        p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
+    return picture_NewFromFormat( p_fmt );
 }
 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_picture )
 {