SRT2VOBSUB README

---------------------------------

srt2vobsub is a command-line tool for linux or other Unix-like systems that
generates a pair of .idx/.sub subtitle files from a textual subtitles file.
It should be noted that the resulting vobsub subtitles are not strictly
standards compliant, whether they will work as expected or not depends on the
player device, resp. the playback software.

Natively it supports .srt files as input. Other file formats will be converted
into temporary .srt files with ffmpeg (if supported).

srt2vobsub uses ideas originally developed by "Phantome" and released
as "2dsub" at code.google.com under the terms of the GNU GPL v.3.
Today this seems to be available only at:
https://web.archive.org/web/20130728210155/https://code.google.com/p/srt2vob

----------------------------------

SOFTWARE REQUIREMENTS

The program needs Python3 (https://www.python.org/), the
Python-Chardet module for Python3 for detecting the input file encoding
(https://pypi.org/project/chardet/), the Python3 version of
Wand (a Python implementation of libmagickwand) to render subtitle images
(https://pypi.org/project/Wand/), fc-list to detect the font file from a
given font name, ffmpeg (https://ffmpeg.org/) to convert non-srt input files,
mediainfo (https://mediaarea.net/de/MediaInfo) to query video file properties
and bdsup2sub (https://github.com/mjuhasz/BDSup2Sub) to generate the vobsub
subtitle stream.

The program supports both bdsup2sub version 4 and 5 (which have a completely
different command line interface).
For best results it is recommended to use the latest available version of
bdsup2sub v. 5.

When using a Debian- or Ubuntu-based system, the required packages are:
python3, python3-chardet, python3-wand, fontconfig, ffmpeg, mediainfo and
bdsup2sub. The latter seems to be available as a pre-built debian package only
from deb-multimedia (http://www.deb-multimedia.org/).

fc-list, ffmpeg and mediainfo are not strictly necessary to run the program,
however without fc-list you will have  to pass the complete path to the font
file of your choice (or stick with the default DejaVuSans that comes with
srt2vobsub), without ffmpeg you will not be able to use input files other than
.srt and without mediainfo the script will not be able to detect the video
properties from a video file.

----------------------------------

3RD PARTY SOFTWARE

srt2vobsub includes version 1.11.0 of the srt.py module written by Chris Down
and released into the public domain at:

    https://pypi.org/project/srt/

If you are working with srt subtitles files and use the Python programming
language, check out the complete srt package which includes API documentation
of the srt module and a number of rather cool command-line utilities!

For the exact license terms of srt.py please see the file LICENSE.srt .

The package also includes a copy of the DejaVuSans truetype font that is used
as a fall back if a font requested by the user cannot be found.

For the exact license terms of DejaVuSans.ttf please see the file
LICENSE.DejaVu.

----------------------------------

INSTALLATION

Since srt2vobsub consists of a single Python script no installation is
required. You can simply type on the command line:

    $ ./srt2vobsub.py <options> subtitlesfile

If you want to install srt2vobsub system wide, use the install script:

    # ./install

to copy the program files to /usr/local/share/srt2vobsub and create
a symbolic link to srt2vobsub.py at /usr/local/bin/srt2vobsub .

To remove a previous installation you can do:

    # ./install --remove

----------------------------------

USAGE

Generate vobsub files foo.idx and foo.sub with default parameters:

    $ srt2vobsub foo.srt

Retrieve video properties from movie and generate vobsub files with matching
name from an advanced substation alpha subtitles file:

    $ srt2vobsub -m "Life of Brian.mp4" -n "Life of Brian" foo.ass

Create subtitles with 1080x720 px. resolution and save corrected subtitles file
to subs_proc.srt :

     $ srt2vobsub -r 720p -S 1 subs.srt

For complete usage instructions please refer to the srt2vobsub man page.

----------------------------------

LICENSE

srt2vobsub is licensed under the terms of the GNU General Public License v.3
(https://www.gnu.org/licenses/gpl-3.0.en.html). See the file LICENSE for
details.

----------------------------------

PROJECT HOME PAGE

https://srt2vobsub.sourceforge.net

CONTACT:

Michael Lange <klappnase@users.sf.net>

BUGS:

https://sourceforge.net/p/srt2vobsub/tickets/
