// 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_file.cpp /// @brief Overall storage of subtitle files, undo management and more /// @ingroup subs_storage #include "config.h" #ifndef AGI_PRE #include #include #include #include #include #include #endif #include "ass_attachment.h" #include "ass_dialogue.h" #include "ass_file.h" #include "ass_override.h" #include "ass_style.h" #include "charset_detect.h" #include "compat.h" #include "main.h" #include "standard_paths.h" #include "subtitle_format.h" #include "text_file_reader.h" #include "text_file_writer.h" #include "utils.h" #include "version.h" namespace std { template<> void swap(AssFile &lft, AssFile &rgt) { lft.swap(rgt); } } /// @brief AssFile constructor AssFile::AssFile () : commitId(0) , loaded(false) { } /// @brief AssFile destructor AssFile::~AssFile() { delete_clear(Line); } /// @brief Load generic subs void AssFile::Load(const wxString &_filename,wxString charset,bool addToRecent) { try { if (charset.empty()) { charset = CharSetDetect::GetEncoding(_filename); } // Get proper format reader SubtitleFormat *reader = SubtitleFormat::GetReader(_filename); if (!reader) { wxMessageBox("Unknown file type","Error loading file",wxICON_ERROR | wxOK); return; } // Read file AssFile temp; reader->SetTarget(&temp); reader->ReadFile(_filename,charset); swap(temp); } catch (agi::UserCancelException const&) { return; } // Real exception catch (agi::Exception &e) { wxMessageBox(lagi_wxString(e.GetChainedMessage()), "Error loading file", wxICON_ERROR|wxOK); return; } // Other error catch (...) { wxMessageBox("Unknown error","Error loading file",wxICON_ERROR | wxOK); return; } // Set general data loaded = true; filename = _filename; wxFileName fn(filename); StandardPaths::SetPathValue("?script", fn.GetPath()); // Save backup of file if (CanSave() && OPT_GET("App/Auto/Backup")->GetBool()) { wxFileName file(filename); if (file.FileExists()) { wxString path = lagi_wxString(OPT_GET("Path/Auto/Backup")->GetString()); if (path.empty()) path = file.GetPath(); wxFileName dstpath(path); if (!dstpath.IsAbsolute()) path = StandardPaths::DecodePathMaybeRelative(path, "?user/"); path += "/"; dstpath.Assign(path); if (!dstpath.DirExists()) { wxMkdir(path); } wxString backup = path + file.GetName() + ".ORIGINAL." + file.GetExt(); wxCopyFile(file.GetFullPath(), backup, true); } } // Add comments and set vars AddComment(wxString("Script generated by Aegisub ") + GetAegisubLongVersionString()); AddComment("http://www.aegisub.org/"); SetScriptInfo("ScriptType","v4.00+"); // Push the initial state of the file onto the undo stack UndoStack.clear(); RedoStack.clear(); undoDescription.clear(); Commit("", COMMIT_NEW); savedCommitId = commitId; // Add to recent if (addToRecent) AddToRecent(filename); FileOpen(filename); } void AssFile::Save(wxString filename, bool setfilename, bool addToRecent, wxString encoding) { SubtitleFormat *writer = SubtitleFormat::GetWriter(filename); if (!writer) throw "Unknown file type."; if (setfilename) { savedCommitId = commitId; this->filename = filename; StandardPaths::SetPathValue("?script", wxFileName(filename).GetPath()); } FileSave(); writer->SetTarget(this); writer->WriteFile(filename, encoding); if (addToRecent) { AddToRecent(filename); } } wxString AssFile::AutoSave() { if (!loaded || commitId == autosavedCommitId) return ""; wxFileName origfile(filename); wxString path = lagi_wxString(OPT_GET("Path/Auto/Save")->GetString()); if (!path) path = origfile.GetPath(); wxFileName dstpath(path); if (!dstpath.IsAbsolute()) path = StandardPaths::DecodePathMaybeRelative(path, "?user/"); dstpath.AssignDir(path); if (!dstpath.DirExists()) wxMkdir(path); wxString name = origfile.GetName(); if (name.empty()) dstpath.SetFullName("Untitled.AUTOSAVE.ass"); else dstpath.SetFullName(name + ".AUTOSAVE.ass"); Save(dstpath.GetFullPath(), false, false); autosavedCommitId = commitId; return dstpath.GetFullPath(); } void AssFile::SaveMemory(std::vector &dst,const wxString encoding) { // Set encoding wxString enc = encoding; if (enc.IsEmpty()) enc = "UTF-8"; if (enc != "UTF-8") throw "Memory writer only supports UTF-8 for now."; // Check if subs contain at least one style // Add a default style if they don't for compatibility with libass/asa if (GetStyles().Count() == 0) InsertStyle(new AssStyle()); // Prepare vector dst.clear(); dst.reserve(0x4000); // Write file entryIter cur; unsigned int lineSize = 0; unsigned int targetSize = 0; unsigned int pos = 0; wxCharBuffer buffer; for (cur=Line.begin();cur!=Line.end();cur++) { // Convert wxString temp = (*cur)->GetEntryData() + "\r\n"; buffer = temp.mb_str(wxConvUTF8); lineSize = strlen(buffer); // Raise capacity if needed targetSize = dst.size() + lineSize; if (dst.capacity() < targetSize) { unsigned int newSize = dst.capacity(); while (newSize < targetSize) newSize *= 2; dst.reserve(newSize); } // Append line pos = dst.size(); dst.resize(targetSize); memcpy(&dst[pos],buffer,lineSize); } } bool AssFile::CanSave() { // ASS format? wxString ext = filename.Lower().Right(4); if (ext == ".ass") return true; // Never save texts if (ext == ".txt") return false; // Check if it's a known extension SubtitleFormat *writer = SubtitleFormat::GetWriter(filename); if (!writer) return false; // Scan through the lines AssStyle defstyle; AssStyle *curstyle; AssDialogue *curdiag; for (entryIter cur=Line.begin();cur!=Line.end();cur++) { // Check style, if anything non-default is found, return false curstyle = dynamic_cast(*cur); if (curstyle) { if (curstyle->GetEntryData() != defstyle.GetEntryData()) return false; } // Check for attachments, if any is found, return false if (dynamic_cast(*cur)) return false; // Check dialog curdiag = dynamic_cast(*cur); if (curdiag) { // Timed? if (curdiag->Start != 0 || curdiag->End != 0) return false; // Overrides? curdiag->ParseASSTags(); for (size_t i=0;iBlocks.size();i++) { if (curdiag->Blocks[i]->GetType() != BLOCK_PLAIN) return false; } curdiag->ClearBlocks(); } } // Success return true; } // I strongly advice you against touching this function unless you know what you're doing; // even moving things out of order might break ASS parsing - AMZ. void AssFile::AddLine(wxString data,wxString group,int &version,wxString *outGroup) { if (data.empty()) return; // Group wxString origGroup = group; static wxString keepGroup; if (!keepGroup.empty()) group = keepGroup; if (outGroup) *outGroup = group; wxString lowGroup = group.Lower(); // Attachment if (lowGroup == "[fonts]" || lowGroup == "[graphics]") { // Check if it's valid data size_t dataLen = data.Length(); bool validData = (dataLen > 0) && (dataLen <= 80); for (size_t i=0;i= 97) validData = false; } // Is the filename line? bool isFilename = (data.StartsWith("fontname: ") || data.StartsWith("filename: ")); // The attachment file is static, since it is built through several calls to this // After it's done building, it's reset to NULL static AssAttachment *attach = NULL; // Attachment exists, and data is over if (attach && (!validData || isFilename)) { attach->Finish(); keepGroup.Clear(); group = origGroup; lowGroup = group.Lower(); Line.push_back(attach); attach = NULL; } // Create attachment if needed if (isFilename) { attach = new AssAttachment(data.Mid(10)); attach->group = group; keepGroup = group; return; } // Valid data? if (attach && validData) { // Insert data attach->AddData(data); // Done building if (data.Length() < 80) { attach->Finish(); keepGroup.Clear(); group = origGroup; lowGroup = group.Lower(); Line.push_back(attach); attach = NULL; } // Not done else { return; } } } // Dialogue else if (lowGroup == "[events]") { if (data.StartsWith("Dialogue:") || data.StartsWith("Comment:")) Line.push_back(new AssDialogue(data,version)); else if (data.StartsWith("Format:")) Line.push_back(new AssEntry("Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text", group)); else Line.push_back(new AssEntry(data, group)); } // Style else if (lowGroup == "[v4+ styles]") { if (data.StartsWith("Style:")) Line.push_back(new AssStyle(data,version)); else if (data.StartsWith("Format:")) Line.push_back(new AssEntry("Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding", group)); else Line.push_back(new AssEntry(data, group)); } // Script info else if (lowGroup == "[script info]") { // Comment if (data.StartsWith(";")) { // Skip stupid comments added by other programs // Of course, we'll add our own in place later... ;) return; } // Version if (data.StartsWith("ScriptType:")) { wxString versionString = data.Mid(11); versionString.Trim(true); versionString.Trim(false); versionString.MakeLower(); int trueVersion; if (versionString == "v4.00") trueVersion = 0; else if (versionString == "v4.00+") trueVersion = 1; else if (versionString == "v4.00++") trueVersion = 2; else throw "Unknown SSA file format version"; if (trueVersion != version) { if (!(trueVersion == 2 && version == 1)) wxLogMessage("Warning: File has the wrong extension."); version = trueVersion; } } // Everything Line.push_back(new AssEntry(data, group)); } // Unrecognized group else { Line.push_back(new AssEntry(data, group)); } } void AssFile::Clear() { delete_clear(Line); loaded = false; filename.clear(); UndoStack.clear(); RedoStack.clear(); undoDescription.clear(); } void AssFile::LoadDefault(bool defline) { Clear(); // Write headers AssStyle defstyle; int version = 1; AddLine("[Script Info]","[Script Info]",version); AddLine("Title: Default Aegisub file","[Script Info]",version); AddLine("ScriptType: v4.00+","[Script Info]",version); AddLine("WrapStyle: 0", "[Script Info]",version); AddLine("ScaledBorderAndShadow: yes","[Script Info]",version); AddLine("Collisions: Normal","[Script Info]",version); AddLine("","[Script Info]",version); AddLine("[V4+ Styles]","[V4+ Styles]",version); AddLine("Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding","[V4+ Styles]",version); AddLine(defstyle.GetEntryData(),"[V4+ Styles]",version); AddLine("","[V4+ Styles]",version); AddLine("[Events]","[Events]",version); AddLine("Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text","[Events]",version); if (defline) { AssDialogue def; AddLine(def.GetEntryData(),"[Events]",version); } Commit("", COMMIT_NEW); savedCommitId = commitId; loaded = true; StandardPaths::SetPathValue("?script", ""); FileOpen(""); } void AssFile::swap(AssFile &that) throw() { // Intentionally does not swap undo stack related things std::swap(loaded, that.loaded); std::swap(commitId, that.commitId); std::swap(undoDescription, that.undoDescription); std::swap(Line, that.Line); } AssFile::AssFile(const AssFile &from) : undoDescription(from.undoDescription) , commitId(from.commitId) , filename(from.filename) , loaded(from.loaded) { std::transform(from.Line.begin(), from.Line.end(), std::back_inserter(Line), std::mem_fun(&AssEntry::Clone)); } AssFile& AssFile::operator=(AssFile from) { std::swap(*this, from); return *this; } void AssFile::InsertStyle (AssStyle *style) { using std::list; AssEntry *curEntry; list::iterator lastStyle = Line.end(); list::iterator cur; wxString lastGroup; // Look for insert position for (cur=Line.begin();cur!=Line.end();cur++) { curEntry = *cur; if (curEntry->GetType() == ENTRY_STYLE || (lastGroup == "[V4+ Styles]" && curEntry->GetEntryData().substr(0,7) == "Format:")) { lastStyle = cur; } lastGroup = curEntry->group; } // No styles found, add them if (lastStyle == Line.end()) { // Add space curEntry = new AssEntry(""); curEntry->group = lastGroup; Line.push_back(curEntry); // Add header curEntry = new AssEntry("[V4+ Styles]"); curEntry->group = "[V4+ Styles]"; Line.push_back(curEntry); // Add format line curEntry = new AssEntry("Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding"); curEntry->group = "[V4+ Styles]"; Line.push_back(curEntry); // Add style style->group = "[V4+ Styles]"; Line.push_back(style); } // Add to end of list else { lastStyle++; style->group = (*lastStyle)->group; Line.insert(lastStyle,style); } } void AssFile::InsertAttachment (AssAttachment *attach) { // Search for insertion point std::list::iterator insPoint=Line.end(),cur; for (cur=Line.begin();cur!=Line.end();cur++) { // Check if it's another attachment AssAttachment *att = dynamic_cast(*cur); if (att) { if (attach->group == att->group) insPoint = cur; } // See if it's the start of group else if ((*cur)->GetType() == ENTRY_BASE) { AssEntry *entry = (AssEntry*) (*cur); if (entry->GetEntryData() == attach->group) insPoint = cur; } } // Found point, insert there if (insPoint != Line.end()) { insPoint++; Line.insert(insPoint,attach); } // Otherwise, create the [Fonts] group and insert else { int version=1; AddLine("",Line.back()->group,version); AddLine(attach->group,attach->group,version); Line.push_back(attach); AddLine("",attach->group,version); } } void AssFile::InsertAttachment (wxString filename) { wxFileName fname(filename); AssAttachment *newAttach = new AssAttachment(fname.GetFullName()); try { newAttach->Import(filename); } catch (...) { delete newAttach; throw; } // Insert wxString ext = filename.Right(4).Lower(); if (ext == ".ttf" || ext == ".ttc" || ext == ".pfb") newAttach->group = "[Fonts]"; else newAttach->group = "[Graphics]"; InsertAttachment(newAttach); } wxString AssFile::GetScriptInfo(wxString key) { key.MakeLower(); key += ":"; bool GotIn = false; for (std::list::iterator cur = Line.begin(); cur != Line.end(); ++cur) { if ((*cur)->group == "[Script Info]") { GotIn = true; wxString curText = (*cur)->GetEntryData(); if (curText.Lower().StartsWith(key)) return curText.Mid(key.size()).Trim(true).Trim(false); } else if (GotIn) return ""; } return ""; } int AssFile::GetScriptInfoAsInt(const wxString key) { long temp = 0; GetScriptInfo(key).ToLong(&temp); return temp; } void AssFile::SetScriptInfo(wxString const& key, wxString const& value) { wxString search_key = key.Lower() + ":"; size_t key_size = search_key.size(); std::list::iterator script_info_end; bool found_script_info = false; for (std::list::iterator cur = Line.begin(); cur != Line.end(); ++cur) { if ((*cur)->group == "[Script Info]") { found_script_info = true; wxString cur_text = (*cur)->GetEntryData().Left(key_size).Lower(); if (cur_text == search_key) { if (value.empty()) { delete *cur; Line.erase(cur); } else { (*cur)->SetEntryData(key + ": " + value); } return; } script_info_end = cur; } else if (found_script_info) { if (value.size()) { AssEntry *entry = new AssEntry(key + ": " + value); entry->group = "[Script Info]"; Line.insert(script_info_end, entry); } return; } } } void AssFile::GetResolution(int &sw,int &sh) { sw = GetScriptInfoAsInt("PlayResX"); sh = GetScriptInfoAsInt("PlayResY"); // Gabest logic? if (sw == 0 && sh == 0) { sw = 384; sh = 288; } else if (sw == 0) { if (sh == 1024) sw = 1280; else sw = sh * 4 / 3; } else if (sh == 0) { // you are not crazy; this doesn't make any sense if (sw == 1280) sh = 1024; else sh = sw * 3 / 4; } } void AssFile::AddComment(const wxString _comment) { wxString comment = "; "; comment += _comment; std::list::iterator cur; int step = 0; for (cur=Line.begin();cur!=Line.end();cur++) { // Start of group if (step == 0 && (*cur)->group == "[Script Info]") step = 1; // First line after a ; else if (step == 1 && !(*cur)->GetEntryData().StartsWith(";")) { AssEntry *prev = *cur; AssEntry *comm = new AssEntry(comment); comm->group = prev->group; Line.insert(cur,comm); break; } } } wxArrayString AssFile::GetStyles() { wxArrayString styles; AssStyle *curstyle; for (entryIter cur=Line.begin();cur!=Line.end();cur++) { curstyle = dynamic_cast(*cur); if (curstyle) { styles.Add(curstyle->name); } } return styles; } AssStyle *AssFile::GetStyle(wxString name) { for (entryIter cur=Line.begin();cur!=Line.end();cur++) { AssStyle *curstyle = dynamic_cast(*cur); if (curstyle && curstyle->name == name) return curstyle; } return NULL; } void AssFile::AddToRecent(wxString file) { config::mru->Add("Subtitle", STD_STR(file)); wxFileName filepath(file); OPT_SET("Path/Last/Subtitles")->SetString(STD_STR(filepath.GetPath())); } wxString AssFile::GetWildcardList(int mode) { if (mode == 0) return SubtitleFormat::GetWildcards(0); else if (mode == 1) return "Advanced Substation Alpha (*.ass)|*.ass"; else if (mode == 2) return SubtitleFormat::GetWildcards(1); else return ""; } int AssFile::Commit(wxString desc, int type, int amendId, AssEntry *single_line) { ++commitId; // Allow coalescing only if it's the last change and the file has not been // saved since the last change if (commitId == amendId+1 && RedoStack.empty() && savedCommitId+1 != commitId && autosavedCommitId+1 != commitId) { // If only one line changed just modify it instead of copying the file if (single_line) { entryIter this_it = Line.begin(), undo_it = UndoStack.back().Line.begin(); while (*this_it != single_line) { ++this_it; ++undo_it; } delete *undo_it; *undo_it = single_line->Clone(); } else { UndoStack.back() = *this; } AnnounceCommit(type); return commitId; } RedoStack.clear(); // Place copy on stack undoDescription = desc; UndoStack.push_back(*this); // Cap depth int depth = OPT_GET("Limits/Undo Levels")->GetInt(); while ((int)UndoStack.size() > depth) { UndoStack.pop_front(); } if (OPT_GET("App/Auto/Save on Every Change")->GetBool()) { if (!filename.empty() && CanSave()) Save(filename); } AnnounceCommit(type); return commitId; } void AssFile::Undo() { if (UndoStack.size() <= 1) return; RedoStack.push_back(AssFile()); std::swap(RedoStack.back(), *this); UndoStack.pop_back(); *this = UndoStack.back(); AnnounceCommit(COMMIT_NEW); } void AssFile::Redo() { if (RedoStack.empty()) return; std::swap(*this, RedoStack.back()); UndoStack.push_back(*this); RedoStack.pop_back(); AnnounceCommit(COMMIT_NEW); } wxString AssFile::GetUndoDescription() const { return IsUndoStackEmpty() ? "" : UndoStack.back().undoDescription; } wxString AssFile::GetRedoDescription() const { return IsRedoStackEmpty() ? "" : RedoStack.back().undoDescription; } bool AssFile::CompStart(const AssDialogue* lft, const AssDialogue* rgt) { return lft->Start < rgt->Start; } bool AssFile::CompEnd(const AssDialogue* lft, const AssDialogue* rgt) { return lft->End < rgt->End; } bool AssFile::CompStyle(const AssDialogue* lft, const AssDialogue* rgt) { return lft->Style < rgt->Style; } void AssFile::Sort(CompFunc comp) { Sort(Line, comp); } namespace { struct AssEntryComp : public std::binary_function { AssFile::CompFunc comp; bool operator()(const AssEntry* a, const AssEntry* b) const { return comp(static_cast(a), static_cast(b)); } }; } void AssFile::Sort(std::list &lst, CompFunc comp) { AssEntryComp compE; compE.comp = comp; // Sort each block of AssDialogues separately, leaving everything else untouched for (entryIter begin = lst.begin(); begin != lst.end(); ++begin) { if (!dynamic_cast(*begin)) continue; entryIter end = begin; while (end != lst.end() && dynamic_cast(*end)) ++end; // used instead of std::list::sort for partial list sorting std::list tmp; tmp.splice(tmp.begin(), lst, begin, end); tmp.sort(compE); lst.splice(end, tmp); begin = --end; } } void AssFile::Sort(std::list &lst, CompFunc comp) { lst.sort(comp); } AssFile *AssFile::top;