@database "DVDAUTHOR"
@master ""DVDAUTHOR"."1""
@remark "manual page source format generated by PolyglotMan v3.2 available at http://polyglotman.sourceforge.net/"
@wordwrap
@tab 8
 
@node sect0 "Name"
dvdauthor - assembles multiple mpeg program streams into a suitable DVD filesystem 
@endnode

@node sect1 "Synopsis"
 @{b}dvdauthor@{ub} [ @{b}-o @{i}output-dir@{b}@{ub}@{ui}@{ub} ] @{b}-x @{i}xml-config-file@{b}@{ub}@{ui}@{ub}   @{b}dvdauthor@{ub} [ @{b}-o @{i}output-dir@{b}@{ub}@{ui}@{ub} ] [ @{b}-j@{ub} | @{b}--jumppad@{ub} | @{b}-g@{ub} | @{b}--allgprm@{ub} ] [ @{b}-T@{ub} | @{b}--toc@{ub} ] [ @{b}@{i}menu or title options@{b}@{ub}@{ui}@{ub} ]  
@endnode

@node sect2 "Dvd Background"
At a high level, a DVD is a collection of menus and titles. Conceptually, a menu contains buttons which can be assigned actions and provides a list of choices to the end user, while a title contains the main content of the DVD.  However, in reality many of the features available in menus (including buttons, pausing, and looping) are also available in titles. 

The menus and titles are divided into titlesets and the VMGM menu set. A titleset can contain a number of menus and titles which are meant to act together.  The "menu", "audio", "subtitle", and "angle" buttons on the DVD player's remote control will all access menus in the same titleset as the title which is being played.  All the titles and menus of a given titleset have the same video, audio, and subtitle settings (the definitions for the menus are independent from the definitions for the titles), so if you want to have different settings (for example widescreen vs standard aspect ratios), then you need separate titlesets.  Titlesets are not meant to jump to one another, so the VMGM menu domain is used.  It is a collection of menus (no titles) that can access the menus and titles of all the titlesets. 

One of the most frusterating things when deciding how to author a DVD is that there are often many ways to accomplish the same task.  For example, you must decide whether to locate menus at the VMGM level or the titleset level.  A typical setup is to locate the high level menus at the VMGM level, and the low level configuration menus (scene / audio / subtitle selection) at the titleset.  If there are DVD extras, perhaps with a lower quality audio track and a 4:3 aspect ratio, then they would be in a separate titleset with a menu to select among the extras located at the titleset level. 


@endnode

@node sect3 "Dvdauthor Description"
@{b}dvdauthor@{ub} works in discrete operations.  It authors each titleset one at a time, and then finally authors the VMGM to complete the disc.  At that point the contents can be written out to a DVD.  If you are controlling @{b}dvdauthor@{ub} with command line arguments, then each step will occur independently; however if you are using the XML configuration file, then you have the option of combining some or all the steps into one. 

The VOBs passed to @{b}dvdauthor@{ub} must have DVD NAV (VOBU) packets multiplexed in at the correct locations.  Many tools can do this, including @{b}mplex@{ub} from mjpegtools 1.6.0 or later.  @{b}dvdauthor@{ub} will then fill these packets in with the correct data.  Special care has been taken to ensure @{b}dvdauthor@{ub} is fifo compliant; that is every source VOB can be the output of another program (such as @{b}mplex@{ub}).  This can make execution faster on many systems by avoiding extra filesystem accesses. 


@endnode

@node sect4 "Command Line Description"


· @{b}-o @{i}output-dir@{b}@{ub}@{ui}@{ub} @{lindent 3}
The destination directory to store the DVD-Video file structure in. @{lindent 0}

· @{b}-j@{ub} @{lindent 3}
@{lindent 0}

· @{b}--jumppad@{ub} @{lindent 3}
foo @{lindent 0}

· @{b}-g@{ub} @{lindent 3}
@{lindent 0}

· @{b}--allgprm@{ub} @{lindent 3}
Enable the use of all 16 general purpose registers.  Prohibits the use of jumppad and some complex expressions that require temporary registers. @{lindent 0}

· @{b}-T@{ub} @{lindent 3}
Creates the table of contents file instead of a titleset. If this option is used, it should be listed first, and you may not specify any titles. @{lindent 0}

· @{b}-m@{ub} @{lindent 3}
Creates a menu. @{lindent 0}

· @{b}-t@{ub} @{lindent 3}
Creates a title. @{lindent 0}

· @{b}-v @{i}video-opts@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--video=@{i}video-opts@{b}@{ub}@{ui}@{ub} @{lindent 3}
A plus (+) separated list of video options.  Dvdauthor will try to infer any unspecified options.  pal, ntsc, 4:3, 16:9, 720xfull, 720x576, 720x480, 704xfull, 704x576, 704x480, 352xfull, 352x576, 352x480, 352xhalf, 352x288, 352x240, nopanscan, noletterbox, crop. Default is ntsc, 4:3, 720xfull @{lindent 0}

· @{b}-a @{i}audio-opts@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--audio=@{i}audio-opts@{b}@{ub}@{ui}@{ub} @{lindent 3}
A plus (+) separated list of options for an audio track, with each track separated by a comma (,).  For example -a ac3+en,mp2+de specifies two audio tracks: the first is an English track encoded in AC3, the second is a German track encoded using MPEG-1 layer 2 compression.  ac3, mp2, pcm, dts, 16bps, 20bps, 24bps, drc, surround, nolang, 1ch, 2ch, 3ch, 4ch, 5ch, 6ch, 7ch, 8ch, and any two letter ISO 639 language abbreviation.  Default is 1 track, mp2, 20bps, nolang, 2ch.  'ac3' implies drc, 6ch. @{lindent 0}

· @{b}-s @{i}subpicture-opts@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--subpictures=@{i}subpicture-opts@{b}@{ub}@{ui}@{ub} @{lindent 3}
A plus (+) separated list of options for a subpicture track, with each track separated by a comma (,). nolang and any two letter language abbreviation (see -a) Default is no subpicture tracks. @{lindent 0}

· @{b}-e @{i}entry(s)@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--entry=@{i}entry(s)@{b}@{ub}@{ui}@{ub} @{lindent 3}
Makes the current menu the default for certain circumstances. It is a comma separated list of any of:  for TOC menus: title  for VTS menus: root, ptt, audio, subtitle, angle @{lindent 0}

· @{b}-p @{i}palette-file@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--palette=@{i}palette-file@{b}@{ub}@{ui}@{ub} @{lindent 3}
Specifies where to get the subpicture palette. Settable per title and per menu. If the filename ends in .rgb (case insensitive) then it is assumed to be RGB, otherwise it is YUV. Entries should be 6 hexadecimal digits. @{i}FILE@{ui} defaults to xste-palette.dat @{lindent 0}

· @{b}-c @{i}chapterpts@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--chapters=@{i}chapterpts@{b}@{ub}@{ui}@{ub} @{lindent 3}
Specifies a comma (,) separated list of chapter markers. Each marker is of the form [[h:]mm:]ss[.frac] and is relative to the SCR of the next file listed (independent of any timestamp transposing that occurs within dvdauthor). The chapter markers ONLY apply to the next file listed. Defaults to 0. @{lindent 0}

· @{b}-f @{i}mpeg-file@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--file=@{i}mpeg-file@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}@{i}mpeg-file@{b}@{ub}@{ui}@{ub} @{lindent 3}
Specifies either a file, a pipe, or a shell command ending in | which supplies an MPEG-2 system stream with VOB sectors inserted in the appropriate places (using mplex -f 8 to generate) @{lindent 0}

· @{b}-b @{i}buttondef@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--button=@{i}X1xY1-X2xY2,commandlist@{b}@{ub}@{ui}@{ub} @{lindent 3}
creates a button of the specified size. See LANGUAGE DESCRIPTION for a description of @{i}commandlist@{ui}. @{lindent 0}

· @{b}-i @{i}[pre|post]=commandlist@{b}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}--instructions=@{i}[pre|post]=commandlist@{b}@{ub}@{ui}@{ub} @{lindent 3}
Executes the @{i}commandlist@{ui} instructions either before or at the end of the menu/title.  See LANGUAGE DESCRIPTION for the format of @{i}commandlist.@{ui} @{lindent 0}


@endnode

@node sect5 "Xml Description"
Here is the basic structure of the configuration file:  
@{code}<dvdauthor [dest="output-dir"] [jumppad="1|on|yes" | allgprm="1|on|yes"]>
   <vmgm>
      [<fpc>commands;</fpc>]
      <menus [lang="language-code"] >
         <video [format="ntsc|pal"] [aspect="4:3|16:9"]
                [resolution="XxY"] [caption="field1|field2"]
                [widescreen="nopanscan|noletterbox|crop"] />
         <audio [format="mp2|ac3|dts|pcm"] [channels="numchannels"]
                [quant="16bps|20bps|24bps|drc"] [dolby="surround"]
                [samplerate="48khz|96khz"] [lang="language"] />
         [<audio ... />]
         <subpicture lang="language" />
         <pgc [entry="title"] [palette="yuvfile|rgbfile"]
              [pause="seconds|inf"]>
            <pre> commands; </pre>
            <vob file="file.mpg" [chapters="chapter-list"]
                 [pause="seconds|inf"] />
            [<vob ... />]
            <button [name="buttonname"]> commands; </button>
            [<button ... />]
            <post> commands; </post>
         </pgc>
         [<pgc ... />]
      </menus>
   </vmgm>
   <titleset>
      <menus>
         [<video ... />]
         [<audio ... />]
         <pgc [entry="entries"]
              [palette="yuvfile|rgbfile"] [pause="seconds|inf"]>
            [...]
         </pgc>
         [<pgc ... />]
      </menus>
      <titles>
         [<video ... />]
         [<audio ... />]
         <pgc [palette="yuvfile|rgbfile"] [pause="seconds|inf"]>
            [...]
         </pgc>
         [<pgc ... />]
      </titles>
   </titleset>
   [<titleset ... />]
</dvdauthor>
@{body}


A breakdown of the config file: 



· @{b}<dvdauthor [dest="@{i}output-dir@{b}"] [jumppad="1|on|yes" | allgprm="1|on|yes"]>@{ub}@{ui}@{ub} @{lindent 3}
Initiates dvdauthor.  dest denotes the directory where @{b}dvdauthor@{ub} will write the files.  It overrides the -o option.  Contains up to one <vmgm> tag and any number of <titleset>'s. @{lindent 0}

· @{b}<vmgm>@{ub} @{lindent 3}
@{lindent 0}

· @{b}<titleset>@{ub} @{lindent 3}
Constructs of a VMGM level menu set or a title set. Contains up to one <menus> tag and if a titleset, up to one <titles> tag. @{lindent 0}

· @{b}<menus [lang="@{i}language-code@{b}"] >@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}<titles>@{ub} @{lindent 3}
Marks the list of menus or titles for this VMGM menu set or titleset, called in @{b}dvdauthor@{ub} terminology a "pgcgroup."  Contains up to one <video> tag, up to eight <audio> tags, up to 32 <subpicture> tags, and any number of <pgc> tags. @{lindent 0}

· @{b}<video [format="ntsc|pal"] [aspect="4:3|16:9"] [resolution="@{i}XxY@{b}"] [caption="field1|field2"] [widescreen="nopanscan|noletterbox|crop"] />@{ub}@{ui}@{ub} @{lindent 3}
Manually configures the video parameters for this pgcgroup.  If any of these are not set, then they will be inferred from the source stream.  Note that the DVD format only specifically supports 720x480, 704x480, 352x480, and 352x240 resolutions for NTSC, and 720x576, 704x576, 352x576, and 352x288 resolutions for PAL, but DVD author will accept a wider range of inputs and round up to the nearest size. @{lindent 0}

· @{b}<audio [format="mp2|ac3|dts|pcm"] [channels="@{i}numchannels@{b}"] [dolby="surround"] [quant="16bps|20bps|24bps|drc"] [samplerate="48khz|96khz"] [lang="@{i}language@{b}"] />@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
Manually configures an audio channel for this pgcgroup.  List once for each channel.  Most parameters are inferred automatically from the source VOBs except for PCM parameters. However, language must be manually specified.  Note that it is possible to just list the language attribute and let @{b}dvdauthor@{ub} fill in the rest. @{lindent 0}

· @{b}<subpicture lang="@{i}language@{b}" />@{ub}@{ui}@{ub} @{lindent 3}
foo @{lindent 0}

· @{b}<pgc [entry="@{i}entries@{b}"] [palette="@{i}yuvfile|rgbfile@{b}"] [pause="@{i}seconds@{b}|inf"]>@{ub}@{ui}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
A PGC is just a fancy term for either a menu or a title.  It has a special meaning in the DVD spec so I have retained its use here.  PGC's can have commands that get executed before they start playing or after they finish; see pre and post tags below.  If the PGC is a menu, you can specify one or more entries for it.  This means that if you press the corresponding button on your DVD remote, then it will go to this menu.  For a VMGM level menu, the only choice is title, which on my remote corresponds to the top menu button.  For a titleset level menu, you can use root, subtitle, audio, angle, and ptt.  If you want more than one, separate them by a space or a comma.  Note that root entry is meant for commands that jump from a VMGM level menu to a titleset menu.  All button and menu masks and all subtitles within a PGC must share the same 16 color palette.  If you use @{b}spumux@{ub} to generate the subtitle/subpicture packets, then the color information will be automatically passed to @{b}dvdauthor@{ub}; however, if you use another subtitler or want to have more control over the palette, you can manually specify it with the palette attribute.  The first 16 entries of the file should be the 16 colors of the palette, listed as 6 digit hexadecimal numbers representing either the RGB breakdown (if the filename ends in .rgb or the YUV breakdown (if the filename does not end in .rgb.  After that, the button group information can be listed as pairs of 8 digit hexadecimal numbers; up to three button groups may be specified.  If you have a short video sequence or just want the video to pause at the end, you can use the pause attribute to set the number of seconds (as an integer) from 1 to 254.  If you want the video to pause indefinitely, use inf. @{lindent 0}

· @{b}<pre> @{i}commands;@{b} </pre>@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}<post> @{i}commands;@{b} </post>@{ub}@{ui}@{ub} @{lindent 3}
Sets the commands to execute before or after a PGC plays.  It can be used to loop the current video (by having a <post> jump ... </post> sequence), or to conditionally skip certain chapters if a flag has been set. @{lindent 0}

· @{b}<fpc> @{i}commands;@{b} </fpc>@{ub}@{ui}@{ub} @{lindent 3}
Sets the commands to execute when the disk is first put in the player (FPC = First Program Chain).  It can be used to jump to a particular menu or initialize registers on startup.  If not specified, an implicit one will be created that jumps to the first menu found, or if there is no menu it will jump to the first title.. @{lindent 0}

· @{b}<vob file="@{i}file.mpg@{b}" [chapters="@{i}chapter-list@{b}"] [pause="@{i}seconds@{b}|inf"] />@{ub}@{ui}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
foo @{lindent 0}

· @{b}<cell [start="@{i}timestamp@{b}"] [end="@{i}timestamp@{b}"] [chapter="1|on|yes" | program="1|on|yes"] [pause="@{i}seconds@{b}|inf"] />@{ub}@{ui}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
foo @{lindent 0}

· @{b}<button [name="@{i}buttonname@{b}"]> @{i}commands;@{b} </button>@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
foo @{lindent 0}


@endnode

@node sect6 "Language Description"
The language is quite simple and roughly looks like C. 



· · @{lindent 3}
Statements are terminated with a semicolon. @{lindent 0}

· · @{lindent 3}
Statements can span multiple lines. @{lindent 0}

· · @{lindent 3}
Multiple statements can appear on one line. @{lindent 0}

· · @{lindent 3}
Whitespace (space, tab, newlines) are not important, except to separate keywords and identifiers. @{lindent 0}



@{b}Variables@{ub}

The DVD virtual machine processes 16 bit values.  It supports up to 16 general purpose registers; however @{b}dvdauthor@{ub} reserves 3 for internal use.  Thus register 0-12 are avaialable for use and are referred to as g0 through g12. 

There are also 24 system registers, which can be referred to as s0 through s23.  Not all of these can be set.  Many of these have pseodonyms. 



· @{b}audio (s1, rw)@{ub} @{lindent 3}
Denotes the audio channel, ranging from 0-7. @{lindent 0}

· @{b}subtitle (s2, rw)@{ub} @{lindent 3}
The subtitle track, ranging from 0-31.  If you want the subtitle to always be displayed, then you should add 64 (i.e. choose 64-95).  Simply selecting the track (0-31) means that only the forced subtitles will be displayed, whereas enabling the track (64-95) means that all the subtitles will be displayed.  This allows you to have forced subtitles only for the parts of the movie where the actors are speaking a foreign (to the viewer) language, but still have normal subtitles for the hearing impaired.  The hearing impaired viewers would enable the track (64-95) while the other viewers would just select the track (0-31) they would be able to share the track. @{lindent 0}

· @{b}angle (s3, rw)@{ub} @{lindent 3}
Selects the angle (currently untested). @{lindent 0}

· @{b}button (s8, rw)@{ub} @{lindent 3}
Denotes the currently highlighted button.  Note that the value is multiplied by 1024, so the first button is 1024, the second is 2048, etc. @{lindent 0}



@{b}Expressions@{ub}

Expressions follow typical C syntax except that booleans are not convertible to integers and vice versa.  Operators and comparisons are: 

==, !=, >=, >, <=, <, &&, ||, !, eq, ne, ge, gt, le, lt, and, or, xor, not, +, -, *, /, %, &, |, ^ 

Since the code is encapsulated in XML, the parser will catch any unescaped < characters, thus alphabetic mnemonics have been provided for all comparison operators for consistency. 

There is also a numerical function: 



· @{b}random(@{i}EXPRESSION@{b})@{ub}@{ui}@{ub} @{lindent 3}
Computes a psuedo-random number, between 1 and the supplied number, inclusively. @{lindent 0}



@{b}Blocks@{ub}

Blocks are either a single statement (terminated by a semicolon), or a group of statements wrapped in curly braces.  For example: 



· · @{lindent 3}

@{code}g3=s7;
@{body}
@{lindent 0}

· · @{lindent 3}

@{code}{
  audio=1;
  subtitle=65;
  jump vmgm menu 3;
}
@{body}
@{lindent 0}



@{b}Statements@{ub}

The statements supported are fairly simple at the moment. 



· @{b}@{i}VARIABLE@{b}=@{i}EXPRESSION@{b};@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
Sets a variable equal to the result of an equation. @{lindent 0}

· @{b}if (@{i}EXPRESSION@{b}) @{i}BLOCK;@{b}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}if (@{i}EXPRESSION@{b}) @{i}BLOCK;@{b} else @{i}BLOCK;@{b}@{ub}@{ui}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
Calculates the expression; if true, then it executes the block of code. @{lindent 0}

· @{b}jump @{i}TARGET@{b};@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}call @{i}TARGET@{b} [resume @{i}CELL@{b}];@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 3}
@{lindent 0}

· @{b}resume;@{ub} @{lindent 3}
Jumps to a particular title or menu, or calls a particular menu, or returns to the calling title.  You can only execute a call from a title to a menu; all other forms are illegal. The purpose of using call instead of jump (besides the fact that they support a mutually exclusive list of targets) is to allow the menu to return to the point in the title where the call originated using resume.  You can manually specify the return cell by using the resume keyword, however if you do not specify one and you use the command in a post instruction block, then it will presume cell 1.  The following are possible targets: @{lindent 6}
@{lindent 3}

· @{b}[vmgm | titleset @{i}X@{b}] menu@{ub}@{ui}@{ub} @{lindent 6}
@{lindent 3}

· @{b}[vmgm | titleset @{i}X@{b}] menu @{i}Y@{b}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 6}
@{lindent 3}

· @{b}[vmgm | titleset @{i}X@{b}] menu entry @{i}Z@{b}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 6}
Targets either the default menu, a menu number Y, or the menu denoted as the entry for Z.  The menu is in either the VMGM or titleset domain.  If you wish to target a menu in the current domain then you can omit the domain moniker. @{lindent 3}

· @{b}[vmgm | titleset @{i}X@{b}] title @{i}Y@{b} [chapter @{i}Z@{b}]@{ub}@{ui}@{ub}@{ui}@{ub}@{ui}@{ub} @{lindent 6}
Targets a title, or a chapter in a title.  Numbering starts at 1.  All of the titles on the disc are accessible in the VMGM domain, or you can access them by titleset instead. @{lindent 3}

· @{b}chapter @{i}Z@{b}@{ub}@{ui}@{ub} @{lindent 6}
@{lindent 3}

· @{b}program @{i}Z@{b}@{ub}@{ui}@{ub} @{lindent 6}
@{lindent 3}

· @{b}cell @{i}Z@{b}@{ub}@{ui}@{ub} @{lindent 6}
Targets a chapter, program, or cell in the current title or menu (note that menus do not have chapters).  You can use this to create looping menus: jump cell 1; @{lindent 3}

@{lindent 0}

@endnode
@node main ""DVDAUTHOR"("1")"
@next sect0
@{b}Table of Contents@{ub}

@{"Name" link sect0}
@{"Synopsis" link sect1}
@{"Dvd Background" link sect2}
@{"Dvdauthor Description" link sect3}
@{"Command Line Description" link sect4}
@{"Xml Description" link sect5}
@{"Language Description" link sect6}
@{lindent 3}
Variables
Expressions
Blocks
Statements

@endnode
