REVISIONS REV DESCRIPTION DATE APPROVED A Original Release (ECO 2034536) 03/11/2003 Tim Ryan B Remove proprietary markings, and incorporate additions, and further descriptions 05/12/2003 Tim Ryan C Incorporate requests for ruby characters, horizontal grouping, variable space, and rotated characters. 03/31/2005 Tim Ryan TEXAS INSTRUMENTS INCORPORATED (c) COPYRIGHT 2005 TEXAS INSTRUMENTS UNPUBLISHED, ALL RIGHTS RESERVED 2504382 DWN/CHK Tim Ryan DATE TITLE Subtitle Specification (XML File Format) 2502643 ENGR Tim Ryan DATE for DLP Cinema TM Projection Technology 2504840 314PH DATE NHA Used On QA DATE SIZE A DRAWING NO 2504760 REV C APPLICATION APVD Bill Werner DATE SCALE NONE SHEET 1 OF 36 Subtitle Specification (XML File Format) for DLP Cinema TM Projection Technology ( Version 1.1 ) Data in this specification is subject to correction or change as required. DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 2 IMPORTANT NOTICE Texas Instruments and its subsidiaries (TI) reserve the right to make changes to their products or to discontinue any product or service without notice, and advise customers to obtain the latest version of relevant information to verify, before placing orders, that information being relied on is current and complete. All products are sold subject to the terms and conditions of sale supplied at the time of order acknowledgment, including those pertaining to warranty, patent infringement, and limitation of liability. TI warrants performance of its products to the specifications applicable at the time of sale in accordance with TI’s standard warranty. Testing and other quality control techniques are utilized to the extent TI deems necessary to support this warranty. Specific testing of all parameters of each device is not necessarily performed, except those mandated by government requirements. In order to minimize risks associated with the customer’s applications, adequate design and operating safeguards must be provided by the customer to minimize inherent or procedural hazards. TI assumes no liability for applications assistance or customer product design. TI does not warrant or represent that any license, either express or implied, is granted under any patent right, copyright, mask work right, or other intellectual property right of TI covering or relating to any combination, machine, or process in which such products or services might be or are used. TI’s publication of information regarding any third party’s products or services does not constitute TI’s approval, license, warranty or endorsement thereof. Reproduction of information in TI data books or data sheets is permissible only if reproduction is without alteration and is accompanied by all associated warranties, conditions, limitations and notices. Representation or reproduction of this information with alteration voids all warranties provided for an associated TI product or service, is an unfair and deceptive business practice, and TI is not responsible nor liable for any such use. Resale of TI’s products or services with statements different from or beyond the parameters stated by TI for that product or service voids all express and any implied warranties for the associated TI product or service, is an unfair and deceptive business practice, and TI is not responsible nor liable for any such use. Also see: Standard Terms and Conditions of Sale for Semiconductor Products. www.ti.com/sc/docs/stdterms.htm DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 3 Preface Read This First About This Manual This document describes the XML file format used by the DLP Cinema™ Subtitling Process. It is intended as a reference. How to Use This Manual Chapter 1 describes relevant parts of the XML standard, while Chapter 2 describes each supported tag in detail. Chapter 3 has an example of a subtitle file expressed as an XML document. Notational Conventions XML examples are shown in a special typeface. Related Documentation From Texas Instruments No other documents should be required to create a complete subtitle file for a DLP Cinema TM projector. Trademarks The Texas Instruments logo and Texas Instruments are registered trademarks of Texas Instruments. Trademarks of Texas Instruments include: TI, DLP, DLP Cinema, CineCanvas, Digital Light Processing, DMD and Digital Micromirror Device. DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 4 Contents IMPORTANT NOTICE ____________________________________________________________________________ 2 Read This First______________________________________________________________________________________ 3 About This Manual ________________________________________________________________________________ 3 How to Use This Manual____________________________________________________________________________ 3 Notational Conventions_____________________________________________________________________________ 3 Related Documentation From Texas Instruments _______________________________________________________ 3 Trademarks ______________________________________________________________________________________ 3 Contents ___________________________________________________________________________________________ 4 Examples___________________________________________________________________________________________ 5 Tables _____________________________________________________________________________________________ 6 XML Standards______________________________________________________________________________________ 7 1.1 Well-formed XML Documents_________________________________________________________________7 1.2 Character Sets ______________________________________________________________________________ 7 1.3 XML Prolog ________________________________________________________________________________7 1.4 Predefined Entities __________________________________________________________________________ 7 1.5 Elements ___________________________________________________________________________________8 1.6 Attributes __________________________________________________________________________________ 8 1.7 Binary Data ________________________________________________________________________________8 1.8 Comments__________________________________________________________________________________ 8 DLP Cinema™ Subtitling XML Tags ____________________________________________________________________9 2.1 DCSubtitle _________________________________________________________________________________ 9 2.2 SubtitleFile ________________________________________________________________________________10 2.3 SubtitleID _________________________________________________________________________________ 11 2.4 MovieTitle ________________________________________________________________________________ 12 2.5 ReelNumber _______________________________________________________________________________12 2.6 Language _________________________________________________________________________________13 2.7 LoadFont _________________________________________________________________________________13 2.8 Font______________________________________________________________________________________ 14 2.9 Subtitle ___________________________________________________________________________________17 2.10 Text______________________________________________________________________________________ 19 2.11 Ruby _____________________________________________________________________________________ 23 DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 5 2.12 Rb _______________________________________________________________________________________23 2.13 Rt________________________________________________________________________________________ 23 2.14 Space_____________________________________________________________________________________ 26 2.15 HGroup___________________________________________________________________________________ 27 2.16 Rotate ____________________________________________________________________________________ 28 2.17 Image ____________________________________________________________________________________29 Example DLP Cinema™ Subtitle XML File______________________________________________________________ 31 DLP Cinema™ Subtitle DTD__________________________________________________________________________33 Other Resources ____________________________________________________________________________________ 35 Examples Example 1. DCSubtitle usage ________________________________________________________________________ 9 Example 2. SubtitleFile usage _______________________________________________________________________ 11 Example 3. SubtitleID usage ________________________________________________________________________11 Example 4. MovieTitle usage________________________________________________________________________ 12 Example 5. ReelNumber usage ______________________________________________________________________ 12 Example 6. Language usage ________________________________________________________________________13 Example 7. LoadFont usage ________________________________________________________________________ 14 Example 8. Font usage_____________________________________________________________________________16 Example 9. Subtitle usage __________________________________________________________________________18 Example 10. Text usage___________________________________________________________________________ 20 Example 11. Text horizontal positioning graphical representation _______________________________________ 21 Example 12. Text vertical positioning graphical representation _________________________________________ 22 Example 13. Ruby usage __________________________________________________________________________25 Example 14. Space usage__________________________________________________________________________26 Example 15. HGroup usage________________________________________________________________________ 27 Example 16. Rotate usage _________________________________________________________________________28 Example 17. Image usage _________________________________________________________________________30 DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 6 Tables DCSubtitle properties _________________________________________________________________________________ 9 DLP Cinema™ Software DCSubtitle Version Compatibility _________________________________________________10 SubtitleFile properties _______________________________________________________________________________ 10 LoadFont properties_________________________________________________________________________________13 Font properties _____________________________________________________________________________________ 14 Subtitle properties___________________________________________________________________________________17 Text Position properties ______________________________________________________________________________ 19 Ruby text properties _________________________________________________________________________________23 Space property _____________________________________________________________________________________26 Rotate property _____________________________________________________________________________________ 28 Image Position properties_____________________________________________________________________________ 29 DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 7 Chapter 1 XML Standards XML is a standard established by the World Wide Web Consortium (W3C), which is the central standards body of the web. The DLP Cinema™ subtitle XML format, as part of the CineCanvas TM technology, follows the 1.0 version of the standard, and can be found at http://www.w3.org/TR/2000/REC-xml-20001006. The following sections of the XML standard are particularly important with regards to a DLP Cinema™ subtitle XML file. 1.1 Well-formed XML Documents Section 2.1 of the standard defines what is necessary for an XML document to be well- formed. All DLP Cinema™ subtitle XML files must be well-formed and valid. A document type declaration (DTD) specific to the DLP Cinema™ subtitle format is defined to validate against. The DTD is shown in Appendix A. 1.2 Character Sets A well-formed XML file is made up of Unicode characters, expressed in some encoding. The DLP Cinema™ subtitling capability supports both UTF-8 and UTF-16 encodings. Encoding should be indicated via use of the “encoding=” declaration in the prolog of the XML file. 1.3 XML Prolog All well-formed XML files must begin with a prolog. The prolog is used for several things: It definitely establishes the file as being in XML format. It can specify which version of XML is used by the file. It can specify a character set encoding (such as UTF-8 or UTF-16). It can specify a DTD which provides a grammar for the document. DLP Cinema™ subtitling expects the following prolog (although the encoding may differ as described above): <?xml version=”1.0” encoding=”UTF-8”?> 1.4 Predefined Entities Since XML uses the ‘<’, ‘>’ and ‘&’ characters for special purposes, their use as content must be escaped. DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 8 Similarly, any Unicode character can be specified by using its decimal code-point preceded by “&#” and terminated with “;”. For example, “&#65;” represents the character ‘A’. Unicode characters can also be specified using hexadecimal notation by preceding its code-point value with “&#x”. For example, “&#x41;” represents the character ‘A’. 1.5 Elements The basic building blocks of any XML document are the elements. Each element is delimited by open and close tags. An open tag begins with a ‘<’, contains the element name, and ends with a ‘>’. A close tag begins with a ‘</’, contains the same element name as the open tag, and ends with a ‘>’. <MyElement> … </MyElement> Everything between the open and close tags is the value of the element. Elements can be nested, and constitute a parent / child relationship. If an element has no value, you do not have to specify both open and close tags for that element. It can be represented by an empty tag as shown. <MyEmptyElement /> 1.6 Attributes Attributes are used to tell something about, or add description to, an element without affecting its value. Elements may have attributes and no value at all, hence the empty tag described above. Attributes are inherited from parent to child. <MyElement MyAttribute=”something”> … </MyElement> A more relevant example might be: <Font Size=”24” Color=”FFFFFFFF”> … </Font> 1.7 Binary Data Since XML is always text, there is currently no standard way to include binary data within the body of an XML document. Normally, an XML document is expected to point to binary data in external files using URLs. This specification does not support embedded binary data at this time. 1.8 Comments Comments in XML must begin with “<! “ and end with “ >”. For example: <! this is an example XML comment > DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 9 Chapter 2 DLP Cinema™ Subtitling XML Tags There are two distinct types of DLP Cinema™ subtitling files. The first type, called the Presentation List, is a list of subtitling files. This acts like a table of contents for an entire presentation. The second type, called the Presentation Data, contains the actual subtitles themselves. Each portion, or reel, of a presentation can have an individual presentation data file. This will allow the replacement of reels of a presentation and the accompanying subtitles easily. Therefore a presentation list consists of one or more presentation data files. If the presentation is not divided into multiple reels, then there is no need to specify a Presentation List. This chapter is a reference to all of the XML tags used in a DLP Cinema™ subtitling file, and what their individual requirements and restrictions are. 2.1 DCSubtitle All data inside a well formed XML document must be included in the document element. There can be only one document element per XML file. The document element for a Digital Cinema Subtitle XML file is denoted with the DCSubtitle tag. DCSubtitle properties Attribute Value Version Specifies the version of this subtitle XML file. The current version is 1.1. Future versions of the DLP Cinema™ subtitling system may support additional or reduced capabilities. The version is a required attribute. Projectors at a DLP Cinema™ release prior to release 9.0 will require Version=”1.0”. Projectors at DLP Cinema™ release 9.0 and higher will require Version=”1.X”. All XML constructs added in future releases of this specification will be ignored if the DLP Cinema™ release is not sufficient to recognize it. Example 1. DCSubtitle usage <?xml version=”1.0” encoding=”UTF-8”?> <DCSubtitle Version=”1.1”> XML subtitle contents </DCSubtitle> DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 10 DLP Cinema™ Software DCSubtitle Version Compatibility DLP Cinema™ Software Release DCSubtitle Version=”1.0” DCSubtitle Version=”1.1” Prior to 6.0 No No 6.0 – 8.1 Yes No 9.0+ Yes Yes 2.2 SubtitleFile The SubtitleFile tag is used to denote presentation data files inside a presentation list. At a minimum, a presentation list must contain a single DCSubtitle tag followed by one or more SubtitleFile tags. XML elements that are allowed in a presentation list include, DCSubtitle, SubtitleFile, SubtitleID, MovieTitle, and Language. Mixing SubtitleFile tags and other subtitle tags described in this chapter, with the exception of the tags mentioned in this paragraph, is not allowed. The value of each SubtitleFile tag should be an URI (URL) that points to a well formed presentation data file, or another presentation list. Care must be taken to avoid circular references. The URI can be fully qualified, or a relative name. A relative name is relative to the location specified by the server when establishing communications with the projector upon presentation start. Both are shown in the example below. The SubtitleFile tag has one optional property, Offset. It is specified as an XML attribute and described in the table below. If Offset is not specified, then the default offset of 0 is assumed. The time reference used in subtitle files is described in section 2.9. SubtitleFile properties Attribute Value Offset A time reference offset that denotes the difference in time between the time reference coming from the server and the time reference in the subtitle file. Offset can be used to “push” the time reference back to allow trailers or other “pre-movie” material to be shown without affecting the time references in the XML files. [...].. .DLP CinemaTM Products Subtitle Specification (XML File Format) Example 2 SubtitleFile usage http://www.mystudio.com/mymovie/opening_credits_reel.xml /subtitle_ reel1.xml /subtitle_ reel2.xml ... VPosition= 0) Baseline of Subtitle Offset from Center of Image (VAlign = center VPosition = 2 0) SUBTITLE SUBTITLE Image Image Baseline of Subtitle Offset from Bottom of Image (VAlign = bottom VPosition = 2 0) Baseline of Subtitle Offset from Top of Image (VAlign = top VPosition = 8 0) SUBTITLE SUBTITLE DRAWING NO REV 2504760 C SHEET 22 DLP CinemaTM Products Subtitle Specification (XML File Format) 2.11 Ruby... *** XML Subtitle File *** > DRAWING NO REV 2504760 C SHEET 32 DLP CinemaTM Products Subtitle Specification (XML File Format) Appendix A DLP Cinema™ Subtitle DTD The DLP Cinema TM subtitle XML file should be validated against a document type declaration (DTD) The DTD for this version of the specification is defined below This DTD is provided by, and maintained by Texas Instruments A.1 DTD Specification. .. of Subtitle Offset from Left Edge of Image (HAlign = left HPosition = 1 0) Right Edge of Subtitle Offset from Right Edge of Image (HAlign = right HPosition = 1 0) SUBTITLE SUBTITLE DRAWING NO REV 2504760 C SHEET 21 DLP CinemaTM Products Subtitle Specification (XML File Format) Example 12 Text vertical positioning graphical representation Image Image Baseline of Subtitle Aligned with Center of Image (VAlign... DRAWING NO REV 2504760 C SHEET 11 DLP CinemaTM Products Subtitle Specification (XML File Format) 2.4 MovieTitle The MovieTitle tag is used to denote the title of the movie that this subtitle file was generated for MovieTitle is required in Presentation Data files, and must precede any Subtitle elements Example 4 MovieTitle usage ... Example 5 ReelNumber usage 40950d85-63eb-4ee2-b1e8-45c126601b94 Bedtime For Bonzo 1 other XML subtitle contents DRAWING NO REV 2504760 C SHEET 12 DLP CinemaTM Products Subtitle Specification (XML File Format) 2.6 Language The Language tag... This is the time for all good men DRAWING NO REV 2504760 C SHEET 20 DLP CinemaTM Products Subtitle Specification (XML File Format) Example 11 Text horizontal positioning graphical representation Image Image Center of Subtitle Offset from Center of Image (HAlign = center HPosition = 1 0) Center of Subtitle Aligned with Center of Image (HAlign = center HPosition = 0) SUBTITLE SUBTITLE Image... Subtitle* )> Version CDATA #REQUIRED> (# CDATA)> (# CDATA)> (# CDATA)> (# CDATA)> (# PCDATA | Font | Subtitle. .. 2504760 C SHEET 27 DLP CinemaTM Products Subtitle Specification (XML File Format) 2.16 Rotate The Rotate tag is new in version 1.1 It has no definition in a version 1.0 subtitle file and any text inside it will be ignored It is a container tag used to specify a string of characters that are to be rotated either right or left by 90 degrees before they are rendered on screen This is most common for special... < /Subtitle> DRAWING NO REV 2504760 C SHEET 16 DLP CinemaTM Products Subtitle Specification (XML File Format) 2.9 Subtitle The Subtitle tag denotes the beginning of a particular subtitle The Subtitle element is a parent element It includes five distinct properties and one or more child elements, but no other data Children of the Subtitle element are Text, and Image The different subtitle . NONE SHEET 1 OF 36 Subtitle Specification (XML File Format) for DLP Cinema TM Projection Technology ( Version 1. 1 ) Data. XML files. DLP Cinema TM Products Subtitle Specification (XML File Format) DRAWING NO 2504760 REV C SHEET 11 Example 2. SubtitleFile