Aegisub/aegisub/src/ass_style.h
Thomas Goyne 6f167e9293 Add functions for converting between SSA and ASS aligns to AssStyle
Originally committed to SVN as r6598.
2012-03-25 04:04:54 +00:00

119 lines
4.3 KiB
C++

// Copyright (c) 2005, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file ass_style.h
/// @see ass_style.cpp
/// @ingroup subs_storage
///
#ifndef AGI_PRE
#include <wx/colour.h>
#endif
#include "ass_entry.h"
/// DOCME
/// @class AssColor
/// @brief DOCME
///
/// DOCME
struct AssColor {
int r; ///< Red component
int g; ///< Green component
int b; ///< Blue component
int a; ///< Alpha component
AssColor();
AssColor(int r, int g, int b, int a = 0);
AssColor(const wxColour &color);
bool operator==(const AssColor &col) const;
bool operator!=(const AssColor &col) const;
wxColor GetWXColor() const; // Return as a wxColor
void SetWXColor(const wxColor &color); // Sets from a wxColor
void Parse(wxString const& value); // Parse SSA or ASS-style color
wxString GetASSFormatted(bool alpha,bool stripped=false,bool isStyle=false) const; // Gets color formated in ASS format
wxString GetSSAFormatted() const;
};
/// DOCME
/// @class AssStyle
/// @brief DOCME
///
/// DOCME
class AssStyle : public AssEntry {
public:
wxString name; ///< Name of the style; must be case-insensitively unique within a file despite being case-sensitive
wxString font; ///< Font face name
double fontsize; ///< Font size
AssColor primary; ///< Default text color
AssColor secondary; ///< Text color for not-yet-reached karaoke syllables
AssColor outline; ///< Outline color
AssColor shadow; ///< Shadow color
bool bold;
bool italic;
bool underline;
bool strikeout;
double scalex; ///< Font x scale with 100 = 100%
double scaley; ///< Font y scale with 100 = 100%
double spacing; ///< Additional spacing between characters in pixels
double angle; ///< Counterclockwise z rotation in degrees
int borderstyle; ///< 1: Normal; 3: Opaque box; others are unused in Aegisub
double outline_w; ///< Outline width in pixels
double shadow_w; ///< Shadow distance in pixels
int alignment; ///< \an-style line alignment
int Margin[4]; ///< Left/Right/Vertical/Unused margins in pixels
int encoding; ///< ASS font encoding needed for some non-unicode fonts
int relativeTo; ///< ASS2 extension; do not use
/// Update the raw line data after one or more of the public members have been changed
void UpdateData();
/// @brief Get a list of valid ASS font encodings
static void GetEncodings(wxArrayString &encodingStrings);
AssStyle();
AssStyle(wxString data, int version=1);
AssStyle& operator=(AssStyle const&);
wxString GetSSAText() const;
ASS_EntryType GetType() const { return ENTRY_STYLE; }
AssEntry *Clone() const;
/// Convert an ASS alignment to the equivalent SSA alignment
static int AssToSsa(int ass_align);
/// Convert a SSA alignment to the equivalent ASS alignment
static int SsaToAss(int ssa_align);
};