using Nikse.SubtitleEdit.Core.Enums; using Nikse.SubtitleEdit.Core.SubtitleFormats; using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; namespace Nikse.SubtitleEdit.Core { public class Subtitle { public const int MaxFileSize = 1024 * 1024 * 20; // 20 MB private List _paragraphs; private readonly List _history; public string Header { get; set; } = string.Empty; public string Footer { get; set; } = string.Empty; public string FileName { get; set; } public static int MaximumHistoryItems => 100; public SubtitleFormat OriginalFormat { get; private set; } public List HistoryItems => _history; public Subtitle() { _paragraphs = new List(); _history = new List(); FileName = "Untitled"; } public Subtitle(List historyItems) : this() { _history = historyItems; } public Subtitle(List paragraphs, List historyItems) : this() { _history = historyItems; _paragraphs = paragraphs; } /// /// Copy constructor (only paragraphs) /// /// Subtitle to copy /// Generate new ID (guid) for paragraphs public Subtitle(Subtitle subtitle, bool generateNewId = true) : this() { if (subtitle == null) { return; } foreach (Paragraph p in subtitle.Paragraphs) { _paragraphs.Add(new Paragraph(p, generateNewId)); } WasLoadedWithFrameNumbers = subtitle.WasLoadedWithFrameNumbers; Header = subtitle.Header; Footer = subtitle.Footer; FileName = subtitle.FileName; } public Subtitle(List paragraphs) : this() { _paragraphs = paragraphs; } public List Paragraphs => _paragraphs; /// /// Get the paragraph of index, null if out of bounds /// /// Index of wanted paragraph /// Paragraph, null if index is index is out of bounds public Paragraph GetParagraphOrDefault(int index) { if (_paragraphs == null || _paragraphs.Count <= index || index < 0) { return null; } return _paragraphs[index]; } public Paragraph GetParagraphOrDefaultById(string id) { return _paragraphs.FirstOrDefault(p => p.Id == id); } public SubtitleFormat ReloadLoadSubtitle(List lines, string fileName, SubtitleFormat format) { Paragraphs.Clear(); if (format != null && format.IsMine(lines, fileName)) { format.LoadSubtitle(this, lines, fileName); OriginalFormat = format; return format; } foreach (SubtitleFormat subtitleFormat in SubtitleFormat.AllSubtitleFormats) { if (subtitleFormat.IsMine(lines, fileName)) { subtitleFormat.LoadSubtitle(this, lines, fileName); OriginalFormat = subtitleFormat; return subtitleFormat; } } return null; } public SubtitleFormat LoadSubtitle(string fileName, out Encoding encoding, Encoding useThisEncoding) { return LoadSubtitle(fileName, out encoding, useThisEncoding, false); } public SubtitleFormat LoadSubtitle(string fileName, out Encoding encoding, Encoding useThisEncoding, bool batchMode, double? sourceFrameRate = null, bool loadSubtitle = true) { FileName = fileName; _paragraphs = new List(); StreamReader sr; if (useThisEncoding != null) { try { sr = new StreamReader(fileName, useThisEncoding); } catch (Exception exception) { System.Diagnostics.Debug.WriteLine(exception.Message); encoding = Encoding.UTF8; return null; } } else { try { sr = new StreamReader(fileName, LanguageAutoDetect.GetEncodingFromFile(fileName), true); } catch { try { var fs = new FileStream(fileName, FileMode.Open, FileAccess.Read, FileShare.ReadWrite); sr = new StreamReader(fs); } catch (Exception exception) { System.Diagnostics.Debug.WriteLine(exception.Message); encoding = Encoding.UTF8; return null; } } } encoding = sr.CurrentEncoding; var lines = sr.ReadToEnd().SplitToLines(); sr.Close(); var ext = Path.GetExtension(fileName).ToLowerInvariant(); foreach (var subtitleFormat in SubtitleFormat.AllSubtitleFormats.Where(p => p.Extension == ext && !p.Name.StartsWith("Unknown", StringComparison.Ordinal))) { if (subtitleFormat.IsMine(lines, fileName)) { return FinalizeFormat(fileName, batchMode, sourceFrameRate, lines, subtitleFormat, loadSubtitle); } } foreach (var subtitleFormat in SubtitleFormat.AllSubtitleFormats.Where(p => p.Extension != ext || p.Name.StartsWith("Unknown", StringComparison.Ordinal))) { if (subtitleFormat.IsMine(lines, fileName)) { return FinalizeFormat(fileName, batchMode, sourceFrameRate, lines, subtitleFormat, loadSubtitle); } } if (useThisEncoding == null) { return LoadSubtitle(fileName, out encoding, Encoding.Unicode); } return null; } private SubtitleFormat FinalizeFormat(string fileName, bool batchMode, double? sourceFrameRate, List lines, SubtitleFormat subtitleFormat, bool loadSubtitle) { Header = null; subtitleFormat.BatchMode = batchMode; subtitleFormat.BatchSourceFrameRate = sourceFrameRate; if (loadSubtitle) { subtitleFormat.LoadSubtitle(this, lines, fileName); } OriginalFormat = subtitleFormat; WasLoadedWithFrameNumbers = OriginalFormat.IsFrameBased; if (WasLoadedWithFrameNumbers) { CalculateTimeCodesFromFrameNumbers(Configuration.Settings.General.CurrentFrameRate); } return subtitleFormat; } public void MakeHistoryForUndo(string description, SubtitleFormat subtitleFormat, DateTime fileModified, Subtitle original, string originalSubtitleFileName, int lineNumber, int linePosition, int linePositionAlternate) { // don't fill memory with history - use a max rollback points if (_history.Count > MaximumHistoryItems) { _history.RemoveAt(0); } _history.Add(new HistoryItem(_history.Count, this, description, FileName, fileModified, subtitleFormat.FriendlyName, original, originalSubtitleFileName, lineNumber, linePosition, linePositionAlternate)); } public bool CanUndo => _history.Count > 0; public string UndoHistory(int index, out string subtitleFormatFriendlyName, out DateTime fileModified, out Subtitle originalSubtitle, out string originalSubtitleFileName) { _paragraphs.Clear(); foreach (Paragraph p in _history[index].Subtitle.Paragraphs) { _paragraphs.Add(new Paragraph(p)); } subtitleFormatFriendlyName = _history[index].SubtitleFormatFriendlyName; FileName = _history[index].FileName; fileModified = _history[index].FileModified; originalSubtitle = new Subtitle(_history[index].OriginalSubtitle); originalSubtitleFileName = _history[index].OriginalSubtitleFileName; Header = _history[index].Subtitle.Header; return FileName; } /// /// Creates subtitle as text in its native format. /// /// Format to output /// Native format as text string public string ToText(SubtitleFormat format) { return format.ToText(this, Path.GetFileNameWithoutExtension(FileName)); } public void AddTimeToAllParagraphs(TimeSpan time) { double milliseconds = time.TotalMilliseconds; foreach (Paragraph p in Paragraphs) { p.StartTime.TotalMilliseconds += milliseconds; p.EndTime.TotalMilliseconds += milliseconds; } } /// /// Calculate the time codes from frame number/frame rate /// /// Number of frames per second /// True if times could be calculated public bool CalculateTimeCodesFromFrameNumbers(double frameRate) { if (OriginalFormat == null || OriginalFormat.IsTimeBased) { return false; } foreach (Paragraph p in Paragraphs) { p.CalculateTimeCodesFromFrameNumbers(frameRate); } return true; } /// /// Calculate the frame numbers from time codes/frame rate /// /// /// public bool CalculateFrameNumbersFromTimeCodes(double frameRate) { if (OriginalFormat == null || OriginalFormat.IsFrameBased) { return false; } foreach (Paragraph p in Paragraphs) { p.CalculateFrameNumbersFromTimeCodes(frameRate); } FixEqualOrJustOverlappingFrameNumbers(); return true; } public void CalculateFrameNumbersFromTimeCodesNoCheck(double frameRate) { foreach (Paragraph p in Paragraphs) { p.CalculateFrameNumbersFromTimeCodes(frameRate); } FixEqualOrJustOverlappingFrameNumbers(); } private void FixEqualOrJustOverlappingFrameNumbers() { for (int i = 0; i < Paragraphs.Count - 1; i++) { Paragraph p = Paragraphs[i]; Paragraph next = GetParagraphOrDefault(i + 1); if (next != null && (p.EndFrame == next.StartFrame || p.EndFrame == next.StartFrame + 1)) { p.EndFrame = next.StartFrame - 1; } } } public void ChangeFrameRate(double oldFrameRate, double newFrameRate) { foreach (Paragraph p in Paragraphs) { p.StartTime.TotalMilliseconds = (p.StartTime.TotalMilliseconds * oldFrameRate / newFrameRate); p.EndTime.TotalMilliseconds = (p.EndTime.TotalMilliseconds * oldFrameRate / newFrameRate); p.CalculateFrameNumbersFromTimeCodes(newFrameRate); } } public bool WasLoadedWithFrameNumbers { get; set; } public void AdjustDisplayTimeUsingPercent(double percent, List selectedIndexes) { for (int i = 0; i < _paragraphs.Count; i++) { if (selectedIndexes == null || selectedIndexes.Contains(i)) { double nextStartMilliseconds = double.MaxValue; if (i + 1 < _paragraphs.Count) { nextStartMilliseconds = _paragraphs[i + 1].StartTime.TotalMilliseconds; } double newEndMilliseconds = _paragraphs[i].EndTime.TotalMilliseconds; newEndMilliseconds = _paragraphs[i].StartTime.TotalMilliseconds + (((newEndMilliseconds - _paragraphs[i].StartTime.TotalMilliseconds) * percent) / 100.0); if (newEndMilliseconds > nextStartMilliseconds) { newEndMilliseconds = nextStartMilliseconds - Configuration.Settings.General.MinimumMillisecondsBetweenLines; } if (percent > 100 && newEndMilliseconds > _paragraphs[i].EndTime.TotalMilliseconds || percent < 100) { _paragraphs[i].EndTime.TotalMilliseconds = newEndMilliseconds; } } } } public void AdjustDisplayTimeUsingSeconds(double seconds, List selectedIndexes) { for (int i = 0; i < _paragraphs.Count; i++) { if (selectedIndexes == null || selectedIndexes.Contains(i)) { double nextStartMilliseconds = double.MaxValue; if (i + 1 < _paragraphs.Count) { nextStartMilliseconds = _paragraphs[i + 1].StartTime.TotalMilliseconds; } double newEndMilliseconds = _paragraphs[i].EndTime.TotalMilliseconds + (seconds * TimeCode.BaseUnit); if (newEndMilliseconds > nextStartMilliseconds) { newEndMilliseconds = nextStartMilliseconds - Configuration.Settings.General.MinimumMillisecondsBetweenLines; } if (seconds < 0) { if (_paragraphs[i].StartTime.TotalMilliseconds + 100 > newEndMilliseconds) { _paragraphs[i].EndTime.TotalMilliseconds = _paragraphs[i].StartTime.TotalMilliseconds + 100; } else { _paragraphs[i].EndTime.TotalMilliseconds = newEndMilliseconds; } } else if (newEndMilliseconds > _paragraphs[i].EndTime.TotalMilliseconds) { _paragraphs[i].EndTime.TotalMilliseconds = newEndMilliseconds; } } } } public void RecalculateDisplayTimes(double maxCharactersPerSecond, List selectedIndexes, double optimalCharactersPerSeconds, bool extendOnly = false) { for (int i = 0; i < _paragraphs.Count; i++) { if (selectedIndexes == null || selectedIndexes.Contains(i)) { RecalculateDisplayTime(maxCharactersPerSecond, i, optimalCharactersPerSeconds, extendOnly); } } } public void RecalculateDisplayTime(double maxCharactersPerSecond, int index, double optimalCharactersPerSeconds, bool extendOnly = false) { Paragraph p = GetParagraphOrDefault(index); if (p == null) { return; } double originalEndTime = p.EndTime.TotalMilliseconds; double duration = Utilities.GetOptimalDisplayMilliseconds(p.Text, optimalCharactersPerSeconds); p.EndTime.TotalMilliseconds = p.StartTime.TotalMilliseconds + duration; var numberOfCharacters = p.Text.CountCharacters(Configuration.Settings.General.CharactersPerSecondsIgnoreWhiteSpace); while (Utilities.GetCharactersPerSecond(p, numberOfCharacters) > maxCharactersPerSecond) { duration++; p.EndTime.TotalMilliseconds = p.StartTime.TotalMilliseconds + duration; } if (extendOnly && p.EndTime.TotalMilliseconds < originalEndTime) { p.EndTime.TotalMilliseconds = originalEndTime; } Paragraph next = GetParagraphOrDefault(index + 1); if (next != null && p.StartTime.TotalMilliseconds + duration + Configuration.Settings.General.MinimumMillisecondsBetweenLines > next.StartTime.TotalMilliseconds) { p.EndTime.TotalMilliseconds = next.StartTime.TotalMilliseconds - Configuration.Settings.General.MinimumMillisecondsBetweenLines; if (p.Duration.TotalMilliseconds <= 0) { p.EndTime.TotalMilliseconds = p.StartTime.TotalMilliseconds + 1; } } } public void SetFixedDuration(List selectedIndexes, double fixedDurationMilliseconds) { for (int i = 0; i < _paragraphs.Count; i++) { if (selectedIndexes == null || selectedIndexes.Contains(i)) { Paragraph p = GetParagraphOrDefault(i); if (p == null) { continue; } p.EndTime.TotalMilliseconds = p.StartTime.TotalMilliseconds + fixedDurationMilliseconds; Paragraph next = GetParagraphOrDefault(i + 1); if (next != null && p.StartTime.TotalMilliseconds + fixedDurationMilliseconds + Configuration.Settings.General.MinimumMillisecondsBetweenLines > next.StartTime.TotalMilliseconds) { p.EndTime.TotalMilliseconds = next.StartTime.TotalMilliseconds - Configuration.Settings.General.MinimumMillisecondsBetweenLines; if (p.Duration.TotalMilliseconds <= 0) { p.EndTime.TotalMilliseconds = p.StartTime.TotalMilliseconds + 1; } } } } } public void Renumber(int startNumber = 1) { var number = startNumber; int l = _paragraphs.Count + number; while (number < l) { var p = _paragraphs[number - startNumber]; p.Number = number++; } } public int GetIndex(Paragraph p) { if (p == null) { return -1; } int index = _paragraphs.IndexOf(p); if (index >= 0) { return index; } for (int i = 0; i < _paragraphs.Count; i++) { if (p.Id == _paragraphs[i].Id) { return i; } if (i < _paragraphs.Count - 1 && p.Id == _paragraphs[i + 1].Id) { return i + 1; } if (Math.Abs(p.StartTime.TotalMilliseconds - _paragraphs[i].StartTime.TotalMilliseconds) < 0.1 && Math.Abs(p.EndTime.TotalMilliseconds - _paragraphs[i].EndTime.TotalMilliseconds) < 0.1) { return i; } if (p.Number == _paragraphs[i].Number && (Math.Abs(p.StartTime.TotalMilliseconds - _paragraphs[i].StartTime.TotalMilliseconds) < 0.1 || Math.Abs(p.EndTime.TotalMilliseconds - _paragraphs[i].EndTime.TotalMilliseconds) < 0.1)) { return i; } if (p.Text == _paragraphs[i].Text && (Math.Abs(p.StartTime.TotalMilliseconds - _paragraphs[i].StartTime.TotalMilliseconds) < 0.1 || Math.Abs(p.EndTime.TotalMilliseconds - _paragraphs[i].EndTime.TotalMilliseconds) < 0.1)) { return i; } } return -1; } /// /// Get paragraph index by time in seconds /// public int GetIndex(double seconds) { var totalMilliseconds = seconds * TimeCode.BaseUnit; for (int i = 0; i < Paragraphs.Count; i++) { var p = Paragraphs[i]; if (totalMilliseconds >= p.StartTime.TotalMilliseconds && totalMilliseconds <= p.EndTime.TotalMilliseconds) { return i; } } return -1; } public Paragraph GetFirstAlike(Paragraph p) { foreach (Paragraph item in _paragraphs) { if (Math.Abs(p.StartTime.TotalMilliseconds - item.StartTime.TotalMilliseconds) < 0.1 && Math.Abs(p.EndTime.TotalMilliseconds - item.EndTime.TotalMilliseconds) < 0.1 && p.Text == item.Text) { return item; } } return null; } public int RemoveEmptyLines() { int count = _paragraphs.Count; if (count > 0) { int firstNumber = _paragraphs[0].Number; for (int i = _paragraphs.Count - 1; i >= 0; i--) { Paragraph p = _paragraphs[i]; if (string.IsNullOrWhiteSpace(p.Text.RemoveControlCharacters())) { _paragraphs.RemoveAt(i); } } if (count != _paragraphs.Count) { Renumber(firstNumber); } } return count - _paragraphs.Count; } /// /// Removes paragrahs by a list of indices /// /// Indices of pargraphs/lines to delete /// Number of lines deleted public int RemoveParagraphsByIndices(IEnumerable indices) { int count = 0; foreach (var index in indices.OrderByDescending(p => p)) { if (index >= 0 && index < _paragraphs.Count) { _paragraphs.RemoveAt(index); count++; } } return count; } /// /// Removes paragrahs by a list of IDs /// /// IDs of pargraphs/lines to delete /// Number of lines deleted public int RemoveParagraphsByIds(IEnumerable ids) { int beforeCount = _paragraphs.Count; _paragraphs = _paragraphs.Where(p => !ids.Contains(p.Id)).ToList(); return beforeCount - _paragraphs.Count; } /// /// Sort subtitle paragraphs /// /// Paragraph sort criteria public void Sort(SubtitleSortCriteria sortCriteria) { switch (sortCriteria) { case SubtitleSortCriteria.Number: _paragraphs = _paragraphs.OrderBy(p => p.Number).ThenBy(p => p.StartTime.TotalMilliseconds).ToList(); break; case SubtitleSortCriteria.StartTime: _paragraphs = _paragraphs.OrderBy(p => p.StartTime.TotalMilliseconds).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.EndTime: _paragraphs = _paragraphs.OrderBy(p => p.EndTime.TotalMilliseconds).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.Duration: _paragraphs = _paragraphs.OrderBy(p => p.Duration.TotalMilliseconds).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.Text: _paragraphs = _paragraphs.OrderBy(p => p.Text, StringComparer.Ordinal).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.TextMaxLineLength: _paragraphs = _paragraphs.OrderBy(p => Utilities.GetMaxLineLength(p.Text)).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.TextTotalLength: _paragraphs = _paragraphs.OrderBy(p => p.Text.Length).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.TextNumberOfLines: _paragraphs = _paragraphs.OrderBy(p => p.NumberOfLines).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.TextCharactersPerSeconds: _paragraphs = _paragraphs.OrderBy(Utilities.GetCharactersPerSecond).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.WordsPerMinute: _paragraphs = _paragraphs.OrderBy(p => p.WordsPerMinute).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.Style: _paragraphs = _paragraphs.OrderBy(p => p.Extra, StringComparer.Ordinal).ThenBy(p => p.Number).ToList(); break; case SubtitleSortCriteria.Actor: _paragraphs = _paragraphs.OrderBy(p => p.Actor, StringComparer.Ordinal).ThenBy(p => p.Number).ToList(); break; } } public int InsertParagraphInCorrectTimeOrder(Paragraph newParagraph) { for (int i = 0; i < Paragraphs.Count; i++) { Paragraph p = Paragraphs[i]; if (newParagraph.StartTime.TotalMilliseconds < p.StartTime.TotalMilliseconds) { Paragraphs.Insert(i, newParagraph); return i; } } Paragraphs.Add(newParagraph); return Paragraphs.Count - 1; } public Paragraph GetFirstParagraphOrDefaultByTime(double milliseconds) { foreach (var p in Paragraphs) { if (p.StartTime.TotalMilliseconds < milliseconds && milliseconds < p.EndTime.TotalMilliseconds) { return p; } } return null; } /// /// Fast hash code for subtitle - includes pre (encoding atm) + header + number + start + end + text. /// /// Hash value that can be used for quick compare public int GetFastHashCode(string pre) { unchecked // Overflow is fine, just wrap { int hash = 17; if (pre != null) { hash = hash * 23 + pre.GetHashCode(); } if (Header != null) { hash = hash * 23 + Header.Trim().GetHashCode(); } var max = Paragraphs.Count; for (int i = 0; i < max; i++) { var p = Paragraphs[i]; hash = hash * 23 + p.Number.GetHashCode(); hash = hash * 23 + p.StartTime.TotalMilliseconds.GetHashCode(); hash = hash * 23 + p.EndTime.TotalMilliseconds.GetHashCode(); hash = hash * 23 + p.Text.GetHashCode(); } return hash; } } /// /// Concatenates all Paragraphs Text property, using the default line terminator between each Text. /// /// Concatenated Text property of all Paragraph present in Paragraphs property. public string GetAllTexts() { int max = Paragraphs.Count; var sb = new StringBuilder(max * 40); for (var index = 0; index < max; index++) { sb.AppendLine(Paragraphs[index].Text); } return sb.ToString(); } } }