Command line Interface

While BDSup2Sub has a graphical interface, it can be used from the command line as well. Note that to start the GUI without an open console, use "javaw" instead under Windows.

In case BDSup2Sub is installed from the *.deb package use the 'bdsup2sub' command instead of 'java -jar BDSup2Sub.jar'.

Syntax1: java -jar BDSup2Sub.jar [options]

If there is no file name given (all passed parameters are options starting with "-"), the GUI is started. Still you can pass options to e.g. pre-select the target frame rate or resolution. If there's only one parameter which is either "--help" or "-h", a short help will be displayed in the console instead (i.e. the GUI will not start).

Syntax2: java -jar BDSup2Sub [options] <input>

If there is only the input file name <input> given, the GUI is started and the file with the given name is loaded immediately. Options passed will be used as default settings if possible.

Syntax3: java -jar BDSup2Sub [options] -o <output> <input>

If there is a source file name <input> and a target file name <output>, the GUI is not started, but BDSup2Sub behaves like a command line application. Note that it's mandatory that the target file name has an extension, which might be either ".sup", ".ifo", ".idx" or ".sub". If the extension of the output file name is ".idx" or ".sub", the output format will be SUB/IDX. If the extension of the output file name is ".sup", the output format will be BD-SUP. If the extension is ".ifo", the output format is SUP/IFO.

Any of the following options may passed:

 -h,--help                       Show usage information and exit.
 -L,--load-settings              Load settings stored in configuration file
                                 even if running in command-line mode.
 -r,--resolution <resolution>    Set resolution to: keep, ntsc=480, pal=576,
	                             720p=720, 1080p=1080, 1440x1080
	                             Default: keep
 -T,--fps-target <fps>           Synchronize target frame rate to <fps>.
	                             Predefined values: 24p=23.976, pal or 25p=25,
	                             ntsc or 30p=29.967, keep (preserves the source
	                             fps for BD&XML, else default)
	                             Default: automatic (dumb!).
 -C,--convert-fps <src>, <trg>   Convert frame rate from <src> to <trg>
	                             Supported values: 24p=23.976, 25p=25,
	                             30p=29.970
	                             auto,<trg> detects source frame rate.
 -d,--delay <delay>              Set delay in ms
	                             Default: 0.0
 -f,--filter <filter>            Set the filter to use for scaling.
	                             Supported values: bilinear, triangle, bicubic,
	                             bell, b-spline, hermite, lanczos3, mitchell
	                             Default: bilinear
 -p,--palette-mode <mode>        Set palette mode.
	                             Supported values: keep, create, dither
	                             Default: create
 -m,--minimum-time <time>        Set minimum display time in ms.
	                             Default: 500
 -x,--merge-time <time>          Set maximum time difference for merging
	                             subtitles in ms.
	                             Default: 200
 -I,--move-in <ratio, offset>    Move captions inside screen ratio <ratio>, +/-
	                             offset <offset>
 -O,--move-out <ratio, offset>   Move captions outside screen ratio <ratio>,
	                             +/- offset <offset>
 -X,--move-x <pos[, offset]>     Move captions horizontally from specified
	                             position. <pos> may be left, right, center
	                             +/- optional offset <offset> (only if moving
	                             left or right)
 -c,--crop-y <n>                 Crop the upper/lower n lines.
	                             Default: 0
 -a,--alpha-crop <n>             Set the alpha cropping threshold.
	                             Default: 10
 -S,--scale <x, y>               Scale captions horizontally and vertically.
	                             Default: 1.0,1.0
 -P,--export-palette             Export target palette in PGCEdit format.
 -D,--forced-only                Export only forced subtitles (when converting
	                             from BD-SUP).
 -F,--force-all <state>          Set or clear the forced flag for all
	                             subtitles.
	                             Supported values: set, clear
 -w,--swap                       Swap Cr/Cb components when loading a BD/HD-DVD
	                             sup file.
 -i,--fix-invisible              Fix zero alpha frame palette for SUB/IDX and
	                             SUP/IFO.
 -t,--palette-file <file>        Load palette file for SUB/IDX conversion.
	                             Overrides default palette.
 -o,--output <arg>               Specify output file.
 -v,--verbose                    Verbose console output mode.
 -V,--version                    Show version information and exit.

The following options only make sense for SUB/IDX or SUP/IFO exports:

 -A,--alpha-thr <n>              Set alpha threshold 0..255 for SUB/IDX
	                             conversion.
	                             Default: 80
 -M,--lum-low-med-thr <n>        Set luminance lo/med threshold 0..255 for
	                             SUB/IDX conversion.
	                             Default: auto
 -H,--lum-med-hi-thr <n>         Set luminance med/hi threshold 0..255 for
	                             SUB/IDX conversion.
	                             Default: auto
 -l,--language <language>        Set language for SUB/IDX export.
	                             Default: en