src/subtitles/STS.h

   1 /*
   2  *      Copyright (C) 2003-2006 Gabest
   3  *      http://www.gabest.org
   4  *
   5  *  This Program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2, or (at your option)
   8  *  any later version.
   9  *
  10  *  This Program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with GNU Make; see the file COPYING.  If not, write to
  17  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  18  *  http://www.gnu.org/copyleft/gpl.html
  19  *
  20  */
  21
  22 #pragma once
  23
  24 #include <atlcoll.h>
  25 #include <wxutil.h>
  26 #include "TextFile.h"
  27 #include "GFN.h"
  28
  29 typedef enum {TIME, FRAME} tmode; // the meaning of STSEntry::start/end
  30
  31 //Coordinate System 2: target scale applied
  32
  33 typedef int IntCoor2;
  34 typedef float FloatCoor2;
  35 typedef double DoubleCoor2;
  36 typedef POINT POINTCoor2;
  37 typedef CPoint CPointCoor2;
  38 typedef SIZE SIZECoor2;
  39 typedef CSize CSizeCoor2;
  40 typedef RECT RECTCoor2;
  41 typedef CRect CRectCoor2;
  42 typedef FwRect FwRectCoor2;
  43
  44 struct STSStyleBase
  45 {
  46     int         charSet;
  47     CString fontName;
  48     double      fontSize; // height
  49     int         fontWeight;
  50     bool        fItalic;
  51     bool        fUnderline;
  52     bool        fStrikeOut;
  53
  54     bool operator == (const STSStyleBase& s)const;
  55 };
  56
  57 LOGFONTA& operator <<= (LOGFONTA& lfa, const STSStyleBase& s);
  58 LOGFONTW& operator <<= (LOGFONTW& lfw, const STSStyleBase& s);
  59
  60 struct STSStyle: public STSStyleBase
  61 {
  62 public:
  63         FwRect  marginRect; // measured from the sides
  64         int             scrAlignment; // 1 - 9: as on the numpad, 0: default
  65         int             borderStyle; // 0: outline, 1: opaque box
  66         double  outlineWidthX, outlineWidthY;
  67         double  shadowDepthX, shadowDepthY;
  68         COLORREF colors[4]; // usually: {primary, secondary, outline/background, shadow}
  69         BYTE    alpha[4];
  70
  71         double  fontScaleX, fontScaleY; // percent
  72         double  fontSpacing; // +/- pixels
  73
  74         double  fBlur;
  75         double  fGaussianBlur;
  76         double  fontAngleZ, fontAngleX, fontAngleY;
  77         double  fontShiftX, fontShiftY;
  78         int             relativeTo; // 0: window, 1: video, 2: undefined (~window)
  79
  80         STSStyle();
  81
  82         void SetDefault();
  83
  84         bool operator == (const STSStyle& s)const;
  85         bool IsFontStyleEqual(const STSStyle& s) const;
  86
  87         void operator = (const LOGFONT& lf);
  88
  89         friend CString& operator <<= (CString& style, const STSStyle& s);
  90         friend STSStyle& operator <<= (STSStyle& s, const CString& style);
  91 };
  92
  93 typedef ::boost::flyweights::flyweight<STSStyle, ::boost::flyweights::no_locking> FwSTSStyle;
  94
  95 //for FwSTSStyle
  96 static inline std::size_t hash_value(const STSStyleBase& s)
  97 {
  98     std::size_t hash = CStringElementTraits<CString>::Hash(s.fontName);
  99     hash = (hash<<5) + (hash) + s.charSet;
 100     hash = (hash<<5) + (hash) + hash_value(s.fontSize);
 101     hash = (hash<<5) + (hash) + s.fontWeight;
 102     hash = (hash<<5) + (hash) + s.fItalic;          //Todo: fix me
 103     hash = (hash<<5) + (hash) + s.fUnderline;
 104     hash = (hash<<5) + (hash) + s.fStrikeOut;
 105     return  hash;
 106 }
 107
 108 static inline std::size_t hash_value(const STSStyle& s)
 109 {
 110     //Todo: fix me
 111     std::size_t hash = hash_value(static_cast<const STSStyleBase&>(s));
 112     hash = (hash<<5) + (hash) + s.colors[0];
 113     hash = (hash<<5) + (hash) + s.colors[2];
 114     hash = (hash<<5) + (hash) + hash_value(s.fontScaleX);
 115     hash = (hash<<5) + (hash) + hash_value(s.fontScaleY);
 116     hash = (hash<<5) + (hash) + hash_value(s.fontAngleX);
 117     hash = (hash<<5) + (hash) + hash_value(s.fontAngleY);
 118     hash = (hash<<5) + (hash) + hash_value(s.fontAngleZ);
 119     hash = (hash<<5) + (hash) + hash_value(s.fontShiftX);
 120     hash = (hash<<5) + (hash) + hash_value(s.fontShiftY);
 121
 122     return  hash;
 123 }
 124
 125 class CSTSStyleMap : public CAtlMap<CString, STSStyle*, CStringElementTraits<CString> >
 126 {
 127 public:
 128         CSTSStyleMap() {}
 129         virtual ~CSTSStyleMap() {Free();}
 130         void Free();
 131 };
 132
 133 typedef struct
 134 {
 135         CStringW str;
 136         bool fUnicode;
 137         CString style, actor, effect;
 138         CRect marginRect;
 139         int layer;
 140         int start, end;
 141         int readorder;
 142 } STSEntry;
 143
 144 class STSSegment
 145 {
 146 public:
 147         int start, end;
 148         bool animated; //if this segment has animate effect
 149         CAtlArray<int> subs;
 150
 151         STSSegment() { animated=false; }
 152         STSSegment(int s, int e) {start = s; end = e; animated = false;}
 153         STSSegment(const STSSegment& stss) {*this = stss;}
 154         void operator = (const STSSegment& stss) {start = stss.start; end = stss.end; animated = stss.animated; subs.Copy(stss.subs);}
 155 };
 156
 157 class CSimpleTextSubtitle
 158 {
 159         friend class CSubtitleEditorDlg;
 160
 161 protected:
 162     CAtlArray<STSEntry> m_entries;
 163     CAtlArray<STSSegment> m_segments;
 164         virtual void OnChanged() {}
 165
 166 public:
 167         CString m_name;
 168         LCID m_lcid;
 169         tmode m_mode;
 170         CTextFile::enc m_encoding;
 171         CString m_path;
 172
 173         CSize m_dstScreenSize;
 174         int m_defaultWrapStyle;
 175         int m_collisions;
 176         bool m_fScaledBAS;
 177
 178         bool m_fUsingAutoGeneratedDefaultStyle;
 179
 180         CSTSStyleMap m_styles;
 181
 182         enum EPARCompensationType
 183         {
 184                 EPCTDisabled = 0,
 185                 EPCTDownscale = 1,
 186                 EPCTUpscale = 2,
 187                 EPCTAccurateSize = 3
 188         };
 189
 190         EPARCompensationType m_ePARCompensationType;
 191         double m_dPARCompensation;
 192
 193     enum YCbCrMatrix
 194     {
 195         YCbCrMatrix_BT601,
 196         YCbCrMatrix_BT709,
 197         YCbCrMatrix_AUTO
 198     };
 199     enum YCbCrRange
 200     {
 201         YCbCrRange_PC,
 202         YCbCrRange_TV,
 203         YCbCrRange_AUTO
 204     };
 205     YCbCrMatrix m_eYCbCrMatrix;
 206     YCbCrRange m_eYCbCrRange;
 207 public:
 208         CSimpleTextSubtitle();
 209         virtual ~CSimpleTextSubtitle();
 210
 211         virtual void Copy(CSimpleTextSubtitle& sts);
 212         virtual void Empty();
 213
 214     bool IsEmpty();
 215
 216         void Sort(bool fRestoreReadorder = false);
 217     void RemoveAllEntries();
 218         void CreateSegments();
 219
 220         void Append(CSimpleTextSubtitle& sts, int timeoff = -1);
 221
 222         bool Open(CString fn, int CharSet, CString name = _T(""));
 223         bool Open(CTextFile* f, int CharSet, CString name);
 224         bool Open(BYTE* data, int len, int CharSet, CString name);
 225         bool SaveAs(CString fn, exttype et, double fps = -1, CTextFile::enc = CTextFile::ASCII);
 226
 227         void Add(CStringW str, bool fUnicode, int start, int end, CString style = CString(_T("Default")),
 228         const CString& actor = CString(_T("")),
 229         const CString& effect = CString(_T("")),
 230         const CRect& marginRect = CRect(0,0,0,0), int layer = 0, int readorder = -1);
 231     //void Add(CStringW str, bool fUnicode, int start, int end, const CString& style, const CString& actor, const CString& effect, const CRect& marginRect, int layer, int readorder);
 232     //void Add(CStringW str, bool fUnicode, int start, int end);
 233
 234     //add an STSEntry obj to the array
 235     //NO addition segments added
 236     //remember to call sort when all STSEntrys are ready
 237         void AddSTSEntryOnly(CStringW str, bool fUnicode, int start, int end, CString style = _T("Default"), const CString& actor = _T(""), const CString& effect = _T(""), const CRect& marginRect = CRect(0,0,0,0), int layer = 0, int readorder = -1);
 238
 239         STSStyle* CreateDefaultStyle(int CharSet);
 240         void ChangeUnknownStylesToDefault();
 241         void AddStyle(CString name, STSStyle* style); // style will be stored and freed in Empty() later
 242         bool CopyStyles(const CSTSStyleMap& styles, bool fAppend = false);
 243
 244         bool SetDefaultStyle(STSStyle& s);
 245         bool GetDefaultStyle(STSStyle& s);
 246
 247         void ConvertToTimeBased(double fps);
 248         void ConvertToFrameBased(double fps);
 249
 250         int TranslateStart(int i, double fps);
 251         int TranslateEnd(int i, double fps);
 252         int SearchSub(int t, double fps);
 253
 254         int TranslateSegmentStart(int i, double fps);
 255         int TranslateSegmentEnd(int i, double fps);
 256         void TranslateSegmentStartEnd(int i, double fps, /*out*/int& start, /*out*/int& end);
 257
 258         //find the first STSSegment with stop time > @t
 259         //@iSegment: return the index, 0 based, of the STSSegment found, return STSSegments count if all STSSegments' stop time are NOT bigger than @t
 260         //@nSegment: return the STSSegments count
 261         //@return: the ptr to the STSSegment found, return NULL if such STSSegment not exist
 262         const STSSegment* SearchSubs(int t, double fps, /*[out]*/ int* iSegment = NULL, int* nSegments = NULL);
 263
 264         //find STSSegment with a duration containing @t, i.e. with a start time <= @t and a stop time > @t
 265         //@iSegment: return the index, 0 based, of the STSSegment found. Return -1 if such STSSegment not exist
 266         //@nSegment: return the STSSegments count
 267         //@return: the ptr to the STSSegment found, return NULL if such STSSegment not exist
 268         STSSegment* SearchSubs2(int t, double fps, /*[out]*/ int* iSegment=NULL, int* nSegments=NULL);
 269
 270         const STSSegment* GetSegment(int iSegment) {return iSegment >= 0 && iSegment < (int)m_segments.GetCount() ? &m_segments[iSegment] : NULL;}
 271
 272         STSStyle* GetStyle(int i);
 273         bool GetStyle(int i, STSStyle* const stss);
 274         int GetCharSet(int i);
 275         bool IsEntryUnicode(int i);
 276         void ConvertUnicode(int i, bool fUnicode);
 277
 278         CStringA GetStrA(int i, bool fSSA = false);
 279         CStringW GetStrW(int i, bool fSSA = false);
 280         CStringW GetStrWA(int i, bool fSSA = false);
 281
 282 #ifdef UNICODE
 283 #define GetStr GetStrW
 284 #else
 285 #define GetStr GetStrA
 286 #endif
 287
 288         void SetStr(int i, CStringA str, bool fUnicode /* ignored */);
 289         void SetStr(int i, CStringW str, bool fUnicode);
 290
 291     friend bool OpenMicroDVD(CTextFile* file, CSimpleTextSubtitle& ret, int CharSet);
 292 };
 293
 294 extern BYTE CharSetList[];
 295 extern TCHAR* CharSetNames[];
 296 extern int CharSetLen;
 297
 298 class CHtmlColorMap : public CAtlMap<CString, DWORD, CStringElementTraits<CString> > {public: CHtmlColorMap();};
 299 extern CHtmlColorMap g_colors;
 300
 301
 302