API tools faq
paste
Advertisement
Guest User

Apple DVDStudioPro Manual Section 19 Chapter 13

a guest
Aug 9th, 2019
749
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 12.92 KB | None | 0 0
raw download clone embed print report
  1. ::: {#page_content .content_body}
  2. ::: {.Section}
  3. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-1028272}
  4.  
  5. Creating an STL Format Subtitle File
  6. ====================================
  7.  
  8. An easy and flexible way to create subtitle files is to use the STL
  9. format developed by Spruce Technologies. The STL format allows you to
  10. configure most subtitle settings, and change the settings on a subtitle
  11. by subtitle basis. It supports both the single file method and the
  12. graphics file method, and even allows you to use both methods in the
  13. same file.
  14.  
  15. STL format files can be saved as either plain text files or as RTF files
  16. (as created with TextEdit). You must use RTF files if your text contains
  17. Unicode characters.
  18.  
  19. ::: {.Section}
  20. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-1028277}
  21.  
  22. Basic STL Format
  23. ----------------
  24.  
  25. There are three parts to an STL format subtitle file: commands,
  26. comments, and entries.
  27.  
  28. - ::: {.ItemHeading}
  29. [Commands: ]{.Emphasis}These are preceded by the dollar sign (\$).
  30. It is these commands that allow you to configure the various aspects
  31. of the subtitles, such as their font and position. See [[STL
  32. Commands](chapter_19_section_13.html#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-1028301)]{.Cross-Ref_Gray}
  33. for more information.
  34. :::
  35.  
  36. - ::: {.ItemHeading}
  37. [Comments: ]{.Emphasis}These are preceded by a double slash (//).
  38. These allow you to add text comments throughout the subtitle file
  39. without affecting its import.
  40. :::
  41.  
  42. - ::: {.ItemHeading}
  43. [Entries: ]{.Emphasis}These include the start and end timecode
  44. values and the text or graphics file for that subtitle clip.
  45. :::
  46.  
  47. Following is an example of a simple STL subtitle file.
  48.  
  49. ::: {.CodeListing}
  50. ::: {.CodeLines}
  51. ::: {.CodeBlock}
  52. \$FontName = Arial
  53. :::
  54.  
  55. ::: {.CodeBlock}
  56. \$FontSize = 65
  57. :::
  58.  
  59. ::: {.CodeBlock}
  60. //The following subtitles are for scene one.
  61. :::
  62.  
  63. ::: {.CodeBlock}
  64. 00:00:12:04 , 00:00:14:12 , Lemurs are the bullies of the wild.
  65. :::
  66.  
  67. ::: {.CodeBlock}
  68. 00:00:16:14 , 00:00:19:08 , Here we see them bring down a moose.
  69. :::
  70. :::
  71. :::
  72.  
  73. Commands, which are always preceded by a dollar sign, use the equal sign
  74. (=) to separate the command name from its value. The entries use commas
  75. to separate their fields. In both cases, you can add tab characters to
  76. align the fields and make the file easier to read.
  77.  
  78. [Note: ]{.yNote}[If you add spaces between the comma and the text entry,
  79. they are considered part of the text and appear in the subtitle. You can
  80. use the tab character to provide space between the comma and the text
  81. entry without affecting the text.]{.Para}
  82.  
  83. You can add a command multiple times within a file to change a setting
  84. for specific subtitles.
  85.  
  86. ::: {.CodeListing}
  87. ::: {.CodeLines}
  88. ::: {.CodeBlock}
  89. \$FontName = Arial
  90. :::
  91.  
  92. ::: {.CodeBlock}
  93. \$FontSize = 65
  94. :::
  95.  
  96. ::: {.CodeBlock}
  97. 00:00:12:04 , 00:00:14:12 , Lemurs are the bullies of the wild.
  98. :::
  99.  
  100. ::: {.CodeBlock}
  101. \$FontSize = 50
  102. :::
  103.  
  104. ::: {.CodeBlock}
  105. 00:00:16:14 , 00:00:19:08 , Here we see them bring down a moose.
  106. :::
  107. :::
  108. :::
  109.  
  110. In this case, both subtitles will use the same font, with the first one
  111. at a size of 65 and the second one at 50.
  112. :::
  113.  
  114. ::: {.Section}
  115. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-1028301}
  116.  
  117. STL Commands
  118. ------------
  119.  
  120. Following is a list of the commands supported by the STL format.
  121.  
  122. [Note: ]{.yNote}[These commands override the settings in DVD Studio Pro
  123. Preferences, which provide the default settings for all settings that
  124. have not been overridden.]{.Para}
  125.  
  126. ::: {.Section}
  127. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW70}
  128.  
  129. ### Font Commands
  130.  
  131. The font commands set all commonly used font properties.
  132.  
  133. - ::: {.ItemHeading}
  134. [\$FontName: ]{.Emphasis}Sets the name of the font the subtitles
  135. use. Use the family name as it appears in the Fonts window, which
  136. can be opened by clicking Show Fonts in the toolbar or choosing
  137. Format \> Fonts \> Show Fonts.
  138. :::
  139.  
  140. - ::: {.ItemHeading}
  141. [\$FontSize: ]{.Emphasis}Sets the size of the font.
  142. :::
  143.  
  144. - ::: {.ItemHeading}
  145. [\$Bold: ]{.Emphasis}Selects the bold version of the font (if
  146. available). Enter True to select the bold version and False to
  147. disable it.
  148. :::
  149.  
  150. - ::: {.ItemHeading}
  151. [\$Italic: ]{.Emphasis}Selects the italic version of the font (if
  152. available). Enter True to select the italic version and False to
  153. disable it.
  154. :::
  155.  
  156. - ::: {.ItemHeading}
  157. [\$Underlined: ]{.Emphasis}Adds an underline to the subtitle text.
  158. Enter True to turn on the underline and False to turn it off.
  159. :::
  160. :::
  161.  
  162. ::: {.Section}
  163. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW71}
  164.  
  165. ### Color Commands
  166.  
  167. The color commands choose the colors from the default subtitle Color
  168. Palette to apply to the subtitle. The values range from 0 to 15. You can
  169. assign the colors to the default Color Palette in DVD Studio Pro
  170. Preferences.
  171.  
  172. - ::: {.ItemHeading}
  173. [\$ColorIndex1: ]{.Emphasis}Chooses the text color.
  174. :::
  175.  
  176. - ::: {.ItemHeading}
  177. [\$ColorIndex2: ]{.Emphasis}Chooses the text's outline 1 color.
  178. :::
  179.  
  180. - ::: {.ItemHeading}
  181. [\$ColorIndex3: ]{.Emphasis}Chooses the text's outline 2 color.
  182. :::
  183.  
  184. - ::: {.ItemHeading}
  185. [\$ColorIndex4: ]{.Emphasis}Chooses the background color.
  186. :::
  187. :::
  188.  
  189. ::: {.Section}
  190. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW72}
  191.  
  192. ### Contrast Commands
  193.  
  194. The contrast commands set the opacity of the colors assigned to the
  195. subtitle. The values range from 0 (transparent) to 15 (opaque).
  196.  
  197. - ::: {.ItemHeading}
  198. [\$TextContrast: ]{.Emphasis}Sets the opacity of the text color.
  199. :::
  200.  
  201. - ::: {.ItemHeading}
  202. [\$Outline1Contrast: ]{.Emphasis}Sets the opacity of the text's
  203. outline 1 color.
  204. :::
  205.  
  206. - ::: {.ItemHeading}
  207. [\$Outline2Contrast: ]{.Emphasis}Sets the opacity of the text's
  208. outline 2 color.
  209. :::
  210.  
  211. - ::: {.ItemHeading}
  212. [\$BackgroundContrast: ]{.Emphasis}Sets the opacity of the
  213. background color. This is usually set to 0, unless you are using a
  214. graphic that does not use white as the background color.
  215. :::
  216. :::
  217.  
  218. ::: {.Section}
  219. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW73}
  220.  
  221. ### Position Commands
  222.  
  223. These commands control the subtitle's position.
  224.  
  225. - ::: {.ItemHeading}
  226. [\$HorzAlign: ]{.Emphasis}Sets the subtitle's horizontal alignment.
  227. You can enter left, center, or right.
  228. :::
  229.  
  230. - ::: {.ItemHeading}
  231. [\$VertAlign: ]{.Emphasis}Sets the subtitle's vertical alignment.
  232. You can enter top, center, or bottom.
  233. :::
  234.  
  235. - ::: {.ItemHeading}
  236. [\$XOffset: ]{.Emphasis}Allows you to modify the subtitle's
  237. horizontal position from where the horizontal alignment placed it.
  238. The values you enter are in pixels, with positive values moving the
  239. subtitle to the right and negative values moving it to the left.
  240. :::
  241.  
  242. - ::: {.ItemHeading}
  243. [\$YOffset: ]{.Emphasis}Allows you to modify the subtitle's vertical
  244. position from where the vertical alignment placed it. The values you
  245. enter are in pixels, with positive values moving the subtitle up and
  246. negative values moving it down.
  247. :::
  248. :::
  249.  
  250. ::: {.Section}
  251. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW74}
  252.  
  253. ### Display Commands
  254.  
  255. These commands control how a subtitle displays.
  256.  
  257. - ::: {.ItemHeading}
  258. [\$ForceDisplay: ]{.Emphasis}Forces the subtitle to display
  259. regardless of whether subtitles are turned on by the DVD player. You
  260. can enter True (subtitles are forced to display) or False (subtitle
  261. display is controlled by the DVD player).
  262. :::
  263.  
  264. - ::: {.ItemHeading}
  265. [\$FadeIn: ]{.Emphasis}Sets the fade time used to gradually dissolve
  266. the subtitles on. Enter a value in frames.
  267. :::
  268.  
  269. - ::: {.ItemHeading}
  270. [\$FadeOut: ]{.Emphasis}Sets the fade time used to gradually
  271. dissolve the subtitles off. Enter a value in frames.
  272. :::
  273. :::
  274.  
  275. ::: {.Section}
  276. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW75}
  277.  
  278. ### Graphics File Command
  279.  
  280. Use this command if this subtitle file uses graphics files in addition
  281. to, or in place of, text entries.
  282.  
  283. - ::: {.ItemHeading}
  284. [\$SetFilePathToken: ]{.Emphasis}Sets a token that you use on any
  285. subtitle entries that contain a graphics filename instead of
  286. subtitle text. The entry must be such that it never appears in
  287. normal text or filenames. The normal convention is to surround the
  288. text with dual angle brackets, making it easier to locate within an
  289. STL file. For example, you could use [\_Graphic\_]{.CodeBody}. See
  290. [[Referencing Graphics Files in STL Subtitle
  291. Files](chapter_19_section_13.html#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-1028390)]{.Cross-Ref_Gray}
  292. for details.
  293. :::
  294. :::
  295.  
  296. ::: {.Section}
  297. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW3}
  298.  
  299. ### Timeline Command
  300.  
  301. By default, the timecode values in an STL file are in reference to the
  302. video stream's zero-based time, which starts at 00:00:00:00. You can use
  303. this command to reference the file's timecode values to the video
  304. stream's asset-based timecode.
  305.  
  306. - ::: {.ItemHeading}
  307. [\$TapeOffset: ]{.Emphasis}Controls how the timecode values in the
  308. STL file are referenced to the video stream. You can enter False to
  309. reference them to the stream's zero-based timecode (which begins at
  310. 00:00:00:00), or True (the default setting) to reference them to the
  311. asset-based timecode.
  312. :::
  313.  
  314. [Note: ]{.yNote}[When referenced to the asset-based timecode, the Track
  315. Inspector's Track Offset setting is ignored---only the actual asset's
  316. timecode is used.]{.Para}
  317. :::
  318. :::
  319.  
  320. ::: {.Section}
  321. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-1028369}
  322.  
  323. Controls Embedded in the Subtitle Text
  324. --------------------------------------
  325.  
  326. You can embed several controls in the text part of the entries. These
  327. controls can force a line break and turn on and off the bold and italic
  328. font versions.
  329.  
  330. ::: {.Section}
  331. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW77}
  332.  
  333. ### Line Breaks
  334.  
  335. Subtitle text does not automatically wrap at the edges of the screen. To
  336. make it fit you must either reduce the font size or break it into
  337. multiple lines by inserting line breaks. To insert a line break, add the
  338. vertical pipe character (\|) to the text.
  339.  
  340. ::: {.CodeListing}
  341. ::: {.CodeLines}
  342. ::: {.CodeBlock}
  343. 00:00:12:04 , 00:00:14:12 , Lemurs are the bullies \| of the wild.
  344. :::
  345. :::
  346. :::
  347.  
  348. In the above example, the text will appear as two lines.
  349. :::
  350.  
  351. ::: {.Section}
  352. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-SW78}
  353.  
  354. ### Bold, Italic, and Underlined Characters
  355.  
  356. You can embed controls that change the state of the bold and italic
  357. attributes within the text part of an entry.
  358.  
  359. To change the state of the bold setting, insert an up arrow followed by
  360. the letter "B" (\^B).
  361.  
  362. ::: {.CodeListing}
  363. ::: {.CodeLines}
  364. ::: {.CodeBlock}
  365. 00:00:12:04 , 00:00:14:12 , Lemurs are \^Bbullies\^B.
  366. :::
  367. :::
  368. :::
  369.  
  370. In the above example, the bold status changes for the word "bullies"
  371. only. If the bold attribute had not already been activated, "bullies"
  372. would change to bold. If the bold attribute had already been activated,
  373. "bullies" would not be bold.
  374.  
  375. To change the state of the italic setting, insert an up arrow followed
  376. by the letter "I" (\^I). You can also use bold and italic together.
  377.  
  378. ::: {.CodeListing}
  379. ::: {.CodeLines}
  380. ::: {.CodeBlock}
  381. 00:00:12:04 , 00:00:14:12 , Lemurs are \^B\^Ibullies\^B\^I.
  382. :::
  383. :::
  384. :::
  385.  
  386. In the above example, the word "bullies" has both the bold and italic
  387. attributes change.
  388.  
  389. To add an underline to portions of the text, insert an up arrow followed
  390. by the letter "U" (\^U). You can use the underline along with the bold
  391. and italic settings.
  392. :::
  393. :::
  394.  
  395. ::: {.Section}
  396. []{#apple_ref:doc:uid:DVDStudioPro-UserManual-43664SUB-1028390}
  397.  
  398. Referencing Graphics Files in STL Subtitle Files
  399. ------------------------------------------------
  400.  
  401. An STL subtitle file can contain a mix of text subtitle entries and
  402. references to graphics files. You must use the \$SetFilePathToken
  403. command in the file before any lines that reference a graphics file.
  404.  
  405. ::: {.CodeListing}
  406. ::: {.CodeLines}
  407. ::: {.CodeBlock}
  408. \$SetFilePathToken = \_Graphic\_
  409. :::
  410.  
  411. ::: {.CodeBlock}
  412. 00:00:12:04 , 00:00:14:12 , \_Graphic\_RabidLemur.tif
  413. :::
  414.  
  415. ::: {.CodeBlock}
  416. 00:00:16:14 , 00:00:19:08 , \_Graphic\_MooseLemur.tif
  417. :::
  418. :::
  419. :::
  420.  
  421. [Important: ]{.yAlert}[Do not add spaces between the token
  422. ([\_Graphic\_]{.CodeBody} in this example) and the
  423. filename.]{.ImportantPara}
  424.  
  425. The STL subtitle file and the graphics it references must be in the same
  426. folder. And, just like the other assets that you import into your
  427. project, the graphics files must not be moved, renamed, or deleted until
  428. after you build your project.
  429. :::
  430. :::
  431.  
  432. ::: {.copyright}
  433. [Copyright © []{.CopyrightYear} Apple Inc. All rights
  434. reserved.](Copyright.html)
  435. :::
  436. :::
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!