[subtitles] Align to screen image based subtitles with cropped source

xbmc · Mar 23, 2022 · 28d4b35 · 28d4b35
1 parent fca7647
commit 28d4b35
Show file tree

Hide file tree

Showing 6 changed files with 95 additions and 28 deletions.
diff --git a/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRenderer.cpp b/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRenderer.cpp
@@ -34,6 +34,8 @@
 #include "OverlayRendererDX.h"
 #endif
 
+#include <algorithm>
+
 using namespace OVERLAY;
 
 COverlay::COverlay()
@@ -172,29 +174,47 @@ void CRenderer::Render(COverlay* o)
   {
     float scale_x = 1.0;
     float scale_y = 1.0;
+    float scale_w = 1.0;
+    float scale_h = 1.0;
 
     if (align == COverlay::ALIGN_SCREEN || align == COverlay::ALIGN_SUBTITLE)
     {
       scale_x = m_rv.Width();
       scale_y = m_rv.Height();
+      scale_w = scale_x;
+      scale_h = scale_y;
+    }
+    else if (align == COverlay::ALIGN_SCREEN_AR)
+    {
+      // Align to screen by keeping aspect ratio to fit into the screen area
+      float source_width = o->m_source_width > 0 ? o->m_source_width : m_rs.Width();
+      float source_height = o->m_source_height > 0 ? o->m_source_height : m_rs.Height();
+      float ratio = std::min<float>(m_rv.Width() / source_width, m_rv.Height() / source_height);
+      scale_x = m_rv.Width();
+      scale_y = m_rv.Height();
+      scale_w = ratio;
+      scale_h = ratio;
     }
     else if (align == COverlay::ALIGN_VIDEO)
     {
       scale_x = m_rs.Width();
       scale_y = m_rs.Height();
+      scale_w = scale_x;
+      scale_h = scale_y;
     }
 
     state.x *= scale_x;
     state.y *= scale_y;
-    state.width *= scale_x;
-    state.height *= scale_y;
+    state.width *= scale_w;
+    state.height *= scale_h;
 
     pos = COverlay::POSITION_ABSOLUTE;
   }
 
   if (pos == COverlay::POSITION_ABSOLUTE)
   {
-    if (align == COverlay::ALIGN_SCREEN || align == COverlay::ALIGN_SUBTITLE)
+    if (align == COverlay::ALIGN_SCREEN || align == COverlay::ALIGN_SCREEN_AR ||
+        align == COverlay::ALIGN_SUBTITLE)
     {
       if (align == COverlay::ALIGN_SUBTITLE)
       {
@@ -483,12 +503,12 @@ COverlay* CRenderer::Convert(CDVDOverlay* o, double pts)
 
 #if defined(HAS_GL) || defined(HAS_GLES)
   if (o->IsOverlayType(DVDOVERLAY_TYPE_IMAGE))
-    r = new COverlayTextureGL(static_cast<CDVDOverlayImage*>(o));
+    r = new COverlayTextureGL(static_cast<CDVDOverlayImage*>(o), m_rs);
   else if (o->IsOverlayType(DVDOVERLAY_TYPE_SPU))
     r = new COverlayTextureGL(static_cast<CDVDOverlaySpu*>(o));
 #elif defined(HAS_DX)
   if (o->IsOverlayType(DVDOVERLAY_TYPE_IMAGE))
-    r = new COverlayImageDX(static_cast<CDVDOverlayImage*>(o));
+    r = new COverlayImageDX(static_cast<CDVDOverlayImage*>(o), m_rs);
   else if (o->IsOverlayType(DVDOVERLAY_TYPE_SPU))
     r = new COverlayImageDX(static_cast<CDVDOverlaySpu*>(o));
 #endif

diff --git a/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRenderer.h b/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRenderer.h
@@ -76,6 +76,7 @@ namespace OVERLAY {
     enum EAlign
     {
       ALIGN_SCREEN,
+      ALIGN_SCREEN_AR,
       ALIGN_VIDEO,
       ALIGN_SUBTITLE
     } m_align;
@@ -91,6 +92,8 @@ namespace OVERLAY {
     float m_y;
     float m_width;
     float m_height;
+    float m_source_width{0}; // Video source width resolution used to calculate aspect ratio
+    float m_source_height{0}; // Video source height resolution used to calculate aspect ratio
   };
 
   class CRenderer : public Observer

diff --git a/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererDX.cpp b/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererDX.cpp
@@ -197,7 +197,7 @@ COverlayImageDX::~COverlayImageDX()
 {
 }
 
-COverlayImageDX::COverlayImageDX(CDVDOverlayImage* o)
+COverlayImageDX::COverlayImageDX(CDVDOverlayImage* o, CRect& rSource)
 {
   if (o->palette.empty())
   {
@@ -213,17 +213,35 @@ COverlayImageDX::COverlayImageDX(CDVDOverlayImage* o)
     Load(rgba.data(), o->width, o->height, o->width * 4);
   }
 
-  if (o->source_width && o->source_height)
+  if (o->source_width > 0 && o->source_height > 0)
   {
-    float center_x = (0.5f * o->width + o->x) / o->source_width;
-    float center_y = (0.5f * o->height + o->y) / o->source_height;
-
-    m_align = ALIGN_VIDEO;
     m_pos = POSITION_RELATIVE;
-    m_x = center_x;
-    m_y = center_y;
-    m_width = static_cast<float>(o->width) / o->source_width;
-    m_height = static_cast<float>(o->height) / o->source_height;
+
+    m_x = (0.5f * o->width + o->x) / o->source_width;
+    m_y = (0.5f * o->height + o->y) / o->source_height;
+
+    if (o->source_height == static_cast<int>(rSource.Height()) ||
+        (static_cast<int>(rSource.Height()) % o->source_height == 0))
+    {
+      // We check also for multiple of source_height because for
+      // example 1080P subtitles can be used on 4K videos
+      m_align = ALIGN_VIDEO;
+      m_width = static_cast<float>(o->width) / o->source_width;
+      m_height = static_cast<float>(o->height) / o->source_height;
+    }
+    else
+    {
+      // If the source_height is higher than the video source height (rSource)
+      // means that the video has been re-encoded/cropped (removed black bars).
+      // May happens that the value instead is lower with 4k videos.
+      // Then we cannot align to video otherwise the subtitles will be deformed
+      // better align to screen by keeping the aspect-ratio.
+      m_align = ALIGN_SCREEN_AR;
+      m_width = static_cast<float>(o->width);
+      m_height = static_cast<float>(o->height);
+      m_source_width = static_cast<float>(o->source_width);
+      m_source_height = static_cast<float>(o->source_height);
+    }
   }
   else
   {

diff --git a/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererDX.h b/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererDX.h
@@ -37,7 +37,11 @@ namespace OVERLAY {
     : public COverlay
   {
   public:
-    explicit COverlayImageDX(CDVDOverlayImage* o);
+    /*! \brief Create the overlay for rendering
+     *  \param o The overlay image
+     *  \param rSource The video source rect size
+     */
+    explicit COverlayImageDX(CDVDOverlayImage* o, CRect& rSource);
     explicit COverlayImageDX(CDVDOverlaySpu*   o);
     virtual ~COverlayImageDX();
 

diff --git a/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererGL.cpp b/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererGL.cpp
@@ -157,7 +157,7 @@ static void LoadTexture(GLenum target
   *v = (GLfloat)height / height2;
 }
 
-COverlayTextureGL::COverlayTextureGL(CDVDOverlayImage* o)
+COverlayTextureGL::COverlayTextureGL(CDVDOverlayImage* o, CRect& rSource)
 {
   m_texture = 0;
 
@@ -185,17 +185,35 @@ COverlayTextureGL::COverlayTextureGL(CDVDOverlayImage* o)
 
   glBindTexture(GL_TEXTURE_2D, 0);
 
-  if (o->source_width && o->source_height)
+  if (o->source_width > 0 && o->source_height > 0)
   {
-    float center_x = (0.5f * o->width  + o->x) / o->source_width;
-    float center_y = (0.5f * o->height + o->y) / o->source_height;
-
-    m_align = ALIGN_VIDEO;
     m_pos = POSITION_RELATIVE;
-    m_x = center_x;
-    m_y = center_y;
-    m_width = static_cast<float>(o->width) / o->source_width;
-    m_height = static_cast<float>(o->height) / o->source_height;
+
+    m_x = (0.5f * o->width + o->x) / o->source_width;
+    m_y = (0.5f * o->height + o->y) / o->source_height;
+
+    if (o->source_height == static_cast<int>(rSource.Height()) ||
+        (static_cast<int>(rSource.Height()) % o->source_height == 0))
+    {
+      // We check also for multiple of source_height because for
+      // example 1080P subtitles can be used on 4K videos
+      m_align = ALIGN_VIDEO;
+      m_width = static_cast<float>(o->width) / o->source_width;
+      m_height = static_cast<float>(o->height) / o->source_height;
+    }
+    else
+    {
+      // If the source_height is higher than the video source height (rSource)
+      // means that the video has been re-encoded/cropped (removed black bars).
+      // May happens that the value instead is lower with 4k videos.
+      // Then we cannot align to video otherwise the subtitles will be deformed
+      // better align to screen by keeping the aspect-ratio.
+      m_align = ALIGN_SCREEN_AR;
+      m_width = static_cast<float>(o->width);
+      m_height = static_cast<float>(o->height);
+      m_source_width = static_cast<float>(o->source_width);
+      m_source_height = static_cast<float>(o->source_height);
+    }
   }
   else
   {

diff --git a/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererGL.h b/xbmc/cores/VideoPlayer/VideoRenderers/OverlayRendererGL.h
@@ -24,8 +24,12 @@ namespace OVERLAY {
   class COverlayTextureGL : public COverlay
   {
   public:
-     explicit COverlayTextureGL(CDVDOverlayImage* o);
-     explicit COverlayTextureGL(CDVDOverlaySpu* o);
+    /*! \brief Create the overlay for rendering
+     *  \param o The overlay image
+     *  \param rSource The video source rect size
+     */
+    explicit COverlayTextureGL(CDVDOverlayImage* o, CRect& rSource);
+    explicit COverlayTextureGL(CDVDOverlaySpu* o);
     ~COverlayTextureGL() override;
 
     void Render(SRenderState& state) override;