SubtitleEdit/libse/SubtitleFormats/FinalCutProXml.cs

618 lines
26 KiB
C#

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;
using System.Xml;
namespace Nikse.SubtitleEdit.Core.SubtitleFormats
{
// - Mom, when you were my age
what did you want to do?
public class FinalCutProXml : SubtitleFormat
{
public override string Extension
{
get { return ".xml"; }
}
public override string Name
{
get { return "Final Cut Pro Xml"; }
}
public override bool IsTimeBased
{
get { return true; }
}
public override bool IsMine(List<string> lines, string fileName)
{
var subtitle = new Subtitle();
var oldFrameRate = Configuration.Settings.General.CurrentFrameRate;
LoadSubtitle(subtitle, lines, fileName);
Configuration.Settings.General.CurrentFrameRate = oldFrameRate;
return subtitle.Paragraphs.Count > 0;
}
public static string GetFrameRateAsString()
{
if (Configuration.Settings.General.CurrentFrameRate < 24)
return "24"; // ntsc 23.976
if (Configuration.Settings.General.CurrentFrameRate < 25)
return "24";
if (Configuration.Settings.General.CurrentFrameRate < 29)
return "25";
if (Configuration.Settings.General.CurrentFrameRate < 29)
return "25";
if (Configuration.Settings.General.CurrentFrameRate < 30)
return "30"; // ntsc 29.97
if (Configuration.Settings.General.CurrentFrameRate < 40)
return "30";
if (Configuration.Settings.General.CurrentFrameRate < 40)
return "30";
if (Configuration.Settings.General.CurrentFrameRate < 60)
return "60"; // ntsc 59.94
return "60";
}
public static string GetNtsc()
{
if (Configuration.Settings.General.CurrentFrameRate < 24)
return "TRUE"; // ntsc 23.976
if (Configuration.Settings.General.CurrentFrameRate < 25)
return "FALSE";
return "TRUE";
}
public override string ToText(Subtitle subtitle, string title)
{
int duration = 0;
if (subtitle.Paragraphs.Count > 0)
duration = (int)Math.Round(subtitle.Paragraphs[subtitle.Paragraphs.Count - 1].EndTime.TotalSeconds * Configuration.Settings.General.CurrentFrameRate);
string xmlStructure =
"<?xml version=\"1.0\" encoding=\"utf-8\" ?>" + Environment.NewLine +
"<xmeml version=\"5\">" + Environment.NewLine +
"<sequence id=\"X\">" + Environment.NewLine +
@" <uuid>5B3B0C07-9A9D-42AA-872C-C953923F97D8</uuid>
<updatebehavior>add</updatebehavior>
<name>X</name>
<duration>" + duration + @"</duration>
<rate>
<ntsc>" + GetNtsc() + @"</ntsc>
<timebase>" + GetFrameRateAsString() + @"</timebase>
</rate>
<timecode>
<rate>
<ntsc>" + GetNtsc() + @"</ntsc>
<timebase>" + GetFrameRateAsString() + @"</timebase>
</rate>
<string>00:00:00:00</string>
<frame>0</frame>
<source>source</source>
<displayformat>NDF</displayformat>
</timecode>
<in>0</in>
<out>" + duration + @"</out>
<media>
<video>
<format>
<samplecharacteristics>
<width>1920</width>
<height>1080</height>
<anamorphic>FALSE</anamorphic>
<pixelaspectratio>Square</pixelaspectratio>
<fielddominance>none</fielddominance>
<rate>
<ntsc>" + GetNtsc() + @"</ntsc>
<timebase>" + GetFrameRateAsString() + @"</timebase>
</rate>
<colordepth>24</colordepth>
<codec>
<name>Apple ProRes 422</name>
<appspecificdata>
<appname>Final Cut Pro</appname>
<appmanufacturer>Apple Inc.</appmanufacturer>
<appversion>7.0</appversion>
<data>
<qtcodec>
<codecname>Apple ProRes 422</codecname>
<codectypename>Apple ProRes 422 (HQ)</codectypename>
<codectypecode>apch</codectypecode>
<codecvendorcode>appl</codecvendorcode>
<spatialquality>1024</spatialquality>
<temporalquality>0</temporalquality>
<keyframerate>0</keyframerate>
<datarate>0</datarate>
</qtcodec>
</data>
</appspecificdata>
</codec>
</samplecharacteristics>
<appspecificdata>
<appname>Final Cut Pro</appname>
<appmanufacturer>Apple Inc.</appmanufacturer>
<appversion>7.0</appversion>
<data>
<fcpimageprocessing>
<useyuv>TRUE</useyuv>
<usesuperwhite>FALSE</usesuperwhite>
<rendermode>Float10BPP</rendermode>
</fcpimageprocessing>
</data>
</appspecificdata>
</format>
<track>
</track>
</video>
</media>
</sequence>
</xmeml>";
string xmlTrackStructure =
@" <generatoritem id='Outline Text[NUMBER]'>
<name>Outline Text</name>
<duration>3000</duration>
<rate>
<ntsc>" + GetNtsc() + @"</ntsc>
<timebase>" + GetFrameRateAsString() + @"</timebase>
</rate>
<in>1380</in>
<out>1474</out>
<start>8228</start>
<end>8322</end>
<enabled>TRUE</enabled>
<anamorphic>FALSE</anamorphic>
<alphatype>black</alphatype>
<masterclipid>Outline Text1</masterclipid>
<effect>
<name>Outline Text</name>
<effectid>Outline Text</effectid>
<effectcategory>Text</effectcategory>
<effecttype>generator</effecttype>
<mediatype>video</mediatype>
<parameter>
<parameterid>part1</parameterid>
<name>Text Settings</name>
<value/>
</parameter>
<parameter>
<parameterid>str</parameterid>
<name>Text</name>
<value>[TEXT]</value>
</parameter>
<parameter>
<parameterid>font</parameterid>
<name>Font</name>
<value>[FONTNAME]</value>
</parameter>
<parameter>
<parameterid>style</parameterid>
<name>Style</name>
<valuemin>1</valuemin>
<valuemax>4</valuemax>
<valuelist>
<valueentry>
<name>Plain</name>
<value>1</value>
</valueentry>
<valueentry>
<name>Bold</name>
<value>2</value>
</valueentry>
<valueentry>
<name>Italic</name>
<value>3</value>
</valueentry>
<valueentry>
<name>Bold/Italic</name>
<value>4</value>
</valueentry>
</valuelist>
<value>[FONTSTYLE]</value>
</parameter>
<parameter>
<parameterid>align</parameterid>
<name>Alignment</name>
<valuemin>1</valuemin>
<valuemax>3</valuemax>
<valuelist>
<valueentry>
<name>Left</name>
<value>1</value>
</valueentry>
<valueentry>
<name>Center</name>
<value>2</value>
</valueentry>
<valueentry>
<name>Right</name>
<value>3</value>
</valueentry>
</valuelist>
<value>2</value>
</parameter>
<parameter>
<parameterid>size</parameterid>
<name>Size</name>
<valuemin>0</valuemin>
<valuemax>200</valuemax>
<value>[FONTSIZE]</value>
</parameter>
<parameter>
<parameterid>track</parameterid>
<name>Tracking</name>
<valuemin>0</valuemin>
<valuemax>100</valuemax>
<value>1</value>
</parameter>
<parameter>
<parameterid>lead</parameterid>
<name>Leading</name>
<valuemin>-100</valuemin>
<valuemax>100</valuemax>
<value>0</value>
</parameter>
<parameter>
<parameterid>aspect</parameterid>
<name>Aspect</name>
<valuemin>0</valuemin>
<valuemax>4</valuemax>
<value>1</value>
</parameter>
<parameter>
<parameterid>linewidth</parameterid>
<name>Line Width</name>
<valuemin>0</valuemin>
<valuemax>200</valuemax>
<value>20</value>
</parameter>
<parameter>
<parameterid>linesoft</parameterid>
<name>Line Softness</name>
<valuemin>0</valuemin>
<valuemax>100</valuemax>
<value>5</value>
</parameter>
<parameter>
<parameterid>textopacity</parameterid>
<name>Text Opacity</name>
<valuemin>0</valuemin>
<valuemax>100</valuemax>
<value>100</value>
</parameter>
<parameter>
<parameterid>center</parameterid>
<name>Center</name>
<value>
<horiz>0.00833333</horiz>
<vert>0.390741</vert>
</value>
</parameter>
<parameter>
<parameterid>textcolor</parameterid>
<name>Text Color</name>
<value>
<alpha>255</alpha>
<red>255</red>
<green>255</green>
<blue>255</blue>
</value>
</parameter>
<parameter>
<parameterid>supertext</parameterid>
<name>Text Graphic</name>
</parameter>
<parameter>
<parameterid>linecolor</parameterid>
<name>Line Color</name>
<value>
<alpha>255</alpha>
<red>0</red>
<green>0</green>
<blue>0</blue>
</value>
</parameter>
<parameter>
<parameterid>part2</parameterid>
<name>Background Settings</name>
<value/>
</parameter>
<parameter>
<parameterid>xscale</parameterid>
<name>Horizontal Size</name>
<valuemin>0</valuemin>
<valuemax>200</valuemax>
<value>0</value>
</parameter>
<parameter>
<parameterid>yscale</parameterid>
<name>Vertical Size</name>
<valuemin>0</valuemin>
<valuemax>200</valuemax>
<value>0</value>
</parameter>
<parameter>
<parameterid>xoffset</parameterid>
<name>Horizontal Offset</name>
<valuemin>-100</valuemin>
<valuemax>100</valuemax>
<value>0</value>
</parameter>
<parameter>
<parameterid>yoffset</parameterid>
<name>Vertical Offset</name>
<valuemin>-100</valuemin>
<valuemax>100</valuemax>
<value>0</value>
</parameter>
<parameter>
<parameterid>backcolor</parameterid>
<name>Back Color</name>
<value>
<alpha>255</alpha>
<red>255</red>
<green>255</green>
<blue>255</blue>
</value>
</parameter>
<parameter>
<parameterid>superback</parameterid>
<name>Back Graphic</name>
</parameter>
<parameter>
<parameterid>crop</parameterid>
<name>Crop</name>
<value>FALSE</value>
</parameter>
<parameter>
<parameterid>autokern</parameterid>
<name>Auto Kerning</name>
<value>TRUE</value>
</parameter>
</effect>
<sourcetrack>
<mediatype>video</mediatype>
</sourcetrack>
</generatoritem>";
if (string.IsNullOrEmpty(title))
title = "Subtitle Edit subtitle";
var xml = new XmlDocument();
xml.LoadXml(xmlStructure);
xml.DocumentElement.SelectSingleNode("sequence").Attributes["id"].Value = title;
xml.DocumentElement.SelectSingleNode("sequence/name").InnerText = title;
xml.DocumentElement.SelectSingleNode("sequence/uuid").InnerText = Guid.NewGuid().ToString().ToUpper();
if (!string.IsNullOrEmpty(subtitle.Header))
{
var header = new XmlDocument();
try
{
header.LoadXml(subtitle.Header);
var node = header.DocumentElement.SelectSingleNode("sequence/uuid");
if (node != null)
xml.DocumentElement.SelectSingleNode("sequence/uuid").InnerText = node.InnerText;
}
catch
{
}
}
XmlNode trackNode = xml.DocumentElement.SelectSingleNode("sequence/media/video/track");
const string newLine = "_____@___";
int number = 1;
foreach (Paragraph p in subtitle.Paragraphs)
{
XmlNode generatorItem = xml.CreateElement("generatoritem");
string fontStyle = "1"; //1==plain
var s = HtmlUtil.RemoveOpenCloseTags(p.Text, HtmlUtil.TagFont).Trim();
if ((s.StartsWith("<i><b>") && s.EndsWith("</b></i>")) || (s.StartsWith("<b><i>") && s.EndsWith("</i></b>")))
fontStyle = "4"; //4==bold/italic
else if (s.StartsWith("<i>") && s.EndsWith("</i>"))
fontStyle = "3"; //3==italic
generatorItem.InnerXml = xmlTrackStructure.Replace("[NUMBER]", number.ToString()).Replace("[FONTSTYLE]", fontStyle).
Replace("[FONTSIZE]", Configuration.Settings.SubtitleSettings.FcpFontSize.ToString(CultureInfo.InvariantCulture)).
Replace("[FONTNAME]", Configuration.Settings.SubtitleSettings.FcpFontName).
Replace("[NUMBER]", number.ToString(CultureInfo.InvariantCulture));
double frameRate = Configuration.Settings.General.CurrentFrameRate;
XmlNode start = generatorItem.SelectSingleNode("generatoritem/start");
start.InnerText = ((int)Math.Round(p.StartTime.TotalSeconds * frameRate)).ToString();
XmlNode end = generatorItem.SelectSingleNode("generatoritem/end");
end.InnerText = ((int)Math.Round(p.EndTime.TotalSeconds * frameRate)).ToString();
XmlNode text = generatorItem.SelectSingleNode("generatoritem/effect/parameter[parameterid='str']/value");
text.InnerText = HtmlUtil.RemoveHtmlTags(p.Text);
text.InnerXml = text.InnerXml.Replace(Environment.NewLine, newLine);
trackNode.AppendChild(generatorItem.SelectSingleNode("generatoritem"));
number++;
}
string xmlAsText = ToUtf8XmlString(xml);
xmlAsText = xmlAsText.Replace("xmeml[]", "xmeml");
xmlAsText = xmlAsText.Replace(newLine, "&#13;");
return xmlAsText;
}
public override void LoadSubtitle(Subtitle subtitle, List<string> lines, string fileName)
{
_errorCount = 0;
var frameRate = Configuration.Settings.General.CurrentFrameRate;
var sb = new StringBuilder();
lines.ForEach(line => sb.AppendLine(line));
var xml = new XmlDocument { XmlResolver = null };
try
{
xml.LoadXml(sb.ToString().Trim());
var header = new XmlDocument { XmlResolver = null };
header.LoadXml(sb.ToString());
if (header.SelectSingleNode("sequence/media/video/track") != null)
header.RemoveChild(header.SelectSingleNode("sequence/media/video/track"));
subtitle.Header = header.OuterXml;
if (xml.DocumentElement.SelectSingleNode("sequence/rate") != null && xml.DocumentElement.SelectSingleNode("sequence/rate/timebase") != null)
{
try
{
frameRate = double.Parse(xml.DocumentElement.SelectSingleNode("sequence/rate/timebase").InnerText);
}
catch
{
frameRate = Configuration.Settings.General.CurrentFrameRate;
}
}
foreach (XmlNode node in xml.SelectNodes("xmeml/sequence/media/video/track"))
{
try
{
foreach (XmlNode generatorItemNode in node.SelectNodes("generatoritem"))
{
XmlNode rate = generatorItemNode.SelectSingleNode("rate");
if (rate != null)
{
XmlNode timebase = rate.SelectSingleNode("timebase");
if (timebase != null)
frameRate = double.Parse(timebase.InnerText);
}
double startFrame = 0;
double endFrame = 0;
XmlNode startNode = generatorItemNode.SelectSingleNode("start");
if (startNode != null)
startFrame = double.Parse(startNode.InnerText);
XmlNode endNode = generatorItemNode.SelectSingleNode("end");
if (endNode != null)
endFrame = double.Parse(endNode.InnerText);
string text = string.Empty;
foreach (XmlNode parameterNode in generatorItemNode.SelectNodes("effect/parameter[parameterid='str']"))
{
XmlNode valueNode = parameterNode.SelectSingleNode("value");
if (valueNode != null)
text += valueNode.InnerText;
}
if (text.Length == 0)
{
foreach (XmlNode parameterNode in generatorItemNode.SelectNodes("effect/parameter[parameterid='str1']"))
{
XmlNode valueNode = parameterNode.SelectSingleNode("value");
if (valueNode != null)
text += valueNode.InnerText;
}
}
if (text.Length == 0)
{
foreach (XmlNode parameterNode in generatorItemNode.SelectNodes("effect/parameter[parameterid='str2']"))
{
XmlNode valueNode = parameterNode.SelectSingleNode("value");
if (valueNode != null)
text += valueNode.InnerText;
}
}
if (text.Length == 0)
{
foreach (XmlNode parameterNode in generatorItemNode.SelectNodes("effect/parameter[parameterid='sourcetext']"))
{
XmlNode valueNode = parameterNode.SelectSingleNode("value");
if (valueNode != null)
text += valueNode.InnerText;
}
}
if (text.Length == 0)
{
foreach (XmlNode parameterNode in generatorItemNode.SelectNodes("effect/parameter[parameterid='text']"))
{
XmlNode valueNode = parameterNode.SelectSingleNode("value");
if (valueNode != null)
text += valueNode.InnerText;
}
}
bool italic = false;
bool bold = false;
foreach (XmlNode parameterNode in generatorItemNode.SelectNodes("effect/parameter[parameterid='style']"))
{
XmlNode valueNode = parameterNode.SelectSingleNode("value");
var valueEntries = parameterNode.SelectNodes("valuelist/valueentry");
if (valueNode != null)
{
int no;
if (int.TryParse(valueNode.InnerText, out no))
{
no--;
if (no < valueEntries.Count)
{
var styleNameNode = valueEntries[no].SelectSingleNode("name");
if (styleNameNode != null)
{
string styleName = styleNameNode.InnerText.ToLower().Trim();
italic = styleName == "italic" || styleName == "bold/italic";
bold = styleName == "bold" || styleName == "bold/italic";
}
}
}
}
}
if (!bold && !italic)
{
foreach (XmlNode parameterNode in generatorItemNode.SelectNodes("effect/parameter[parameterid='fontstyle']"))
{
XmlNode valueNode = parameterNode.SelectSingleNode("value");
var valueEntries = parameterNode.SelectNodes("valuelist/valueentry");
if (valueNode != null)
{
int no;
if (int.TryParse(valueNode.InnerText, out no))
{
no--;
if (no < valueEntries.Count)
{
var styleNameNode = valueEntries[no].SelectSingleNode("name");
if (styleNameNode != null)
{
string styleName = styleNameNode.InnerText.ToLower().Trim();
italic = styleName == "italic" || styleName == "bold/italic";
bold = styleName == "bold" || styleName == "bold/italic";
}
}
}
}
}
}
if (text.Length > 0)
{
if (!text.Contains(Environment.NewLine))
text = text.Replace("\r", Environment.NewLine);
if (bold)
text = "<b>" + text + "</b>";
if (italic)
text = "<i>" + text + "</i>";
subtitle.Paragraphs.Add(new Paragraph(text, Convert.ToDouble((startFrame / frameRate) * 1000), Convert.ToDouble((endFrame / frameRate) * 1000)));
}
}
}
catch
{
_errorCount++;
}
}
subtitle.Renumber();
}
catch
{
_errorCount = 1;
return;
}
Configuration.Settings.General.CurrentFrameRate = frameRate;
}
}
}