/usr/share/doc/dvdauthor/html/spumux.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>spumux</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="DVDAuthor"
HREF="index.html"><LINK
REL="UP"
TITLE="DVDAuthor Man Pages"
HREF="manpages.html"><LINK
REL="PREVIOUS"
TITLE="mpeg2desc"
HREF="r2319.html"><LINK
REL="NEXT"
TITLE="spuunmux"
HREF="spuunmux.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>DVDAuthor</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="r2319.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="spuunmux.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPUMUX"
></A
>spumux</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2404"
></A
><H2
>Name</H2
>spumux&nbsp;--&nbsp;generates and multiplexes subtitles into an existing mpeg2 program stream</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2407"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>spumux</B
>  [-m dvd | -m cvd | -m svcd] [-s <TT
CLASS="REPLACEABLE"
><I
>stream</I
></TT
>] [-v <TT
CLASS="REPLACEABLE"
><I
>level</I
></TT
>] [-P] {<TT
CLASS="REPLACEABLE"
><I
>file</I
></TT
>} {&lt; <TT
CLASS="REPLACEABLE"
><I
>mpeg</I
></TT
>} {&gt; <TT
CLASS="REPLACEABLE"
><I
>mpeg-with-subtitles</I
></TT
>}</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2425"
></A
><H2
>Description</H2
><P
><B
CLASS="COMMAND"
>spumux</B
> encodes the subtitles and multiplexes it into the mpeg2 program stream.</P
><DIV
CLASS="GLOSSLIST"
><DL
><DT
><B
>-m <TT
CLASS="REPLACEABLE"
><I
>mode</I
></TT
></B
></DT
><DD
><P
>&#13;Sets the encoding for the subtitles.  Can be dvd, cvd, or svcd.
Default is dvd.&#13;</P
></DD
><DT
><B
>-s <TT
CLASS="REPLACEABLE"
><I
>stream</I
></TT
></B
></DT
><DD
><P
>Sets the subtitle stream id.  Default is 0.</P
></DD
><DT
><B
>-v <TT
CLASS="REPLACEABLE"
><I
>level</I
></TT
></B
></DT
><DD
><P
>Sets the verbosity level.</P
></DD
><DT
><B
>-P</B
></DT
><DD
><P
>Enables a progress bar.</P
></DD
></DL
></DIV
><P
>Here's a sample configuration file:</P
><PRE
CLASS="SYNOPSIS"
>&lt;subpictures&gt;
   &lt;stream&gt;
      &lt;spu start="<TT
CLASS="REPLACEABLE"
><I
>start-time</I
></TT
>" [ end="<TT
CLASS="REPLACEABLE"
><I
>end-time</I
></TT
>" ] [ image="<TT
CLASS="REPLACEABLE"
><I
>picture.png</I
></TT
>" ]
           [ highlight="<TT
CLASS="REPLACEABLE"
><I
>picture.png</I
></TT
>" ] [ select="<TT
CLASS="REPLACEABLE"
><I
>picture.png</I
></TT
>" ]
           [ transparent="<TT
CLASS="REPLACEABLE"
><I
>color-code</I
></TT
>" ] [ force="yes" ]
           [ autooutline="infer" [ outlinewidth="<TT
CLASS="REPLACEABLE"
><I
>width</I
></TT
>" ]
             [ autoorder="rows" | autoorder="columns" ] ]
           [ xoffset="<TT
CLASS="REPLACEABLE"
><I
>x-coord</I
></TT
>" yoffset="<TT
CLASS="REPLACEABLE"
><I
>y-coord</I
></TT
>" ] &gt;
         &lt;button [ name="<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>" ] [ x0="<TT
CLASS="REPLACEABLE"
><I
>x0</I
></TT
>" ] [ y0="<TT
CLASS="REPLACEABLE"
><I
>y0</I
></TT
>" ] [ x1="<TT
CLASS="REPLACEABLE"
><I
>x1</I
></TT
>" ]
                 [ y1="<TT
CLASS="REPLACEABLE"
><I
>y1</I
></TT
>" ] [ up="<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>" ] [ down="<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>" ]
                 [ left="<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>" ] [ right="<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>" ] /&gt;
         &lt;action [ name="<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>" ] /&gt;
      &lt;/spu&gt;
   &lt;/stream&gt;
&lt;/subpictures&gt;</PRE
><P
>&#13;Each subtitle image is described by an &lt;spu&gt; tag.  The start and
optional end attributes describe when the subtitle will be displayed
on the screen, in "HR:MM:SS.HU".  The image attribute describes the
main subtitle image, which can either be a PNG or BMP file.  If your
image is not a full screen image, you can use xoffset and yoffset to
move the picture around.  In the advent that the author is unable to
use a graphics format with an alpha channel, then the transparent
attribute can be used to describe which color should become fully
transparent.  The color is in hexadecimal as "RRGGBB".  If you want to
force the display of the subtitle, regardless of whether the user has
enabled subtitles or not, you can use the force tag.  When you are
making menus, the force tag is required.&#13;</P
><P
>&#13;The remaining attributes and tags are related to menu creation.  The
highlight attribute shows what all the buttons look like when they are
highlighted (i.e. when you are using the arrows in the menu), and the
select attribute shows what all the buttons look like when the are
selected (i.e. for the 1-2 seconds after you press enter in the menu).
If either of these (or the image attribute) are omitted, then spumux
creates a blank (totally transparent) image.  Obviously at least one
tag should be specified.&#13;</P
><P
>&#13;To aid in button creation, the autooutline attribute instructs spumux
to infer where the buttons are located.  It does this by attempting to
draw rectangles around a composition of the highlight and select
images which do not intersect any opaque or semi-opaque pixels.  In
order to support textual buttons, the attribute outlinewidth allows
you to specify the width of the rectangle which is tested.  Wider
rectangles won't be able to squeeze between the letters.  Finally,
autoorder describes which way to order the automatically detected
buttons, which is important for numerically selected buttons and for
mapping buttons to button names or to the implied names.&#13;</P
><P
>&#13;The button and action tags describe the buttons (visibly selectable
objects on the screen) and actions (commands that are executed as soon
as the associated key is pressed on the remote).  If you are using the
autooutline feature, just designing buttons, are happy with the
inferred button navigation, and can deal with the simplistic naming
system, then you actually do not even need to specify any buttons or
actions.  Otherwise, read on.&#13;</P
><P
>&#13;The name attribute is used to give a button or action an easy to refer
to name.  By default they are numbered sequentially starting with "1".
The up, down, left, and right names describe which button or action
should be tied to the corresponding key when the current button is
highlighted, though if omitted spumux will use a reasonably
intelligent algorithm to determine which buttons to move to.&#13;</P
><P
>&#13;The (x0,y0) coordinates describe the upper left hand corner
inclusively, while the (x1,y1) coordinates describe the lower right
hand corner EXclusively.  The coordinates start at 0,0 for the upper
left hand corner.  Ideally, the y0 and y1 coordinates should both be
even, so the button edges fully empasses two interlaced scanlines,
even if there is no data in the extra scanline.  Some DVD players will
fill in the extra scanline if it is not specified; spumux makes an
effort to ensure that will be transparent but there is no guarantee.&#13;</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2476"
></A
><H2
>Handling text based subtitles</H2
><P
>&#13;Spumux is also able to handle text subtitles, which will be rendered to
graphics by spumux. A lot of different text (must be non-graphic) formats
are supported (.sub, .srt, .ssa, .smi, .rt , .txt, .aqt, .jss, .js, ass).
Spumux will try to determine the format automatically. &#13;</P
><P
>&#13;If processing textbased subtitles no other streams can be defined, buttons
or others need to be processed in another pass with spumux, using another
xml file.&#13;</P
><P
>&#13;Following .xml file shows the available tags and their default settings.
Only the textsub tag is mandatory, defaults are used if the specific tag
is not specified.&#13;</P
><PRE
CLASS="SYNOPSIS"
>&lt;subpictures&gt;
   &lt;stream&gt;
      &lt;textsub filename="demo1.srt" characterset="ISO8859-1"
         fontsize="28.0" font="arial.ttf" horizontal-alignment="left"
         vertical-alignment="bottom" left-margin="60" right-margin="60"
         top-margin="20" bottom-margin="30" subtitle-fps="25"
         movie-fps="25" movie-width="720" movie-height="574"
         force="yes"
      /&gt;
   &lt;/stream&gt;
&lt;/subpictures&gt;</PRE
><P
>&#13;The textsub tag defines the settings for the text to graphics rendering. &#13;</P
><P
>&#13;The filename attribute defines the path and name of the input text subtitle
file, this is the only attribute that is mandatory.&#13;</P
><P
>&#13;The characterset attribute defines the characterset to be used, available
charactersets can be found at http://www.gnu.org/software/libiconv.&#13;</P
><P
>&#13;The fontsize attribute defines the size of the font in font units.
The font attribute defines the font used. Spumux will look into the home
directory in subdirectory .spumux for fonts on linux systems and will
look into the windows/fonts and subdirectory spumux of the cygwin/mingw
home directory and into the exucution directory for windows based
execution for the specified font. Looking for free fonts? One listing is
here http://www.microsoft.com/typography/links/links.asp?type=free&amp;part=1
(this is only about fonts, not about operating systems).&#13;</P
><P
>&#13;The horizontal-alignment attribute defines the horizontal alignment of the
subtitles. Options are: "left", "right", "center" and "default".
The "default" value causes spumux to use the attribute that is in the text
subtitle file if the format supports such an attribute.&#13;</P
><P
>&#13;The vertical-alignment attribute defines the vertical alignment.
Options are: "top", "center" and "bottom".&#13;</P
><P
>&#13;The margin attributes define the minimum blank pixel space between the
border of the image and the border of the subtitle lines.&#13;</P
><P
>&#13;Defining the subtitle-fps and movie-fps attributes make it possible for
spumux to recalculate the subtitle timing if these are not the same.&#13;</P
><P
>&#13;The movie-width and movie-height attributes define the maximum size of
the subtitle page, these shouldn't be larger than the fram-size of the
movie frame, normally they are the same. Some DVD-players more like
subtitle frames that are 2 or 4 pixels smaller in height.&#13;</P
><P
>&#13;The force option allows you to force the display of the subtitle,
regardless of whether the user has enabled subtitles or not.&#13;</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="r2319.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="spuunmux.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>mpeg2desc</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manpages.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>spuunmux</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
dvdauthor 0.7.0-1.3 / usr / share / doc / dvdauthor / html / spumux.html
