Move things round a bit.
[dcpomatic.git] / doc / mainpage.txt
1 /** @mainpage DVD-o-matic
2  *
3  *  DVD-o-matic is a tool to create digital cinema packages (DCPs) from
4  *  video files, or from sets of TIFF image files.  It is written in C++
5  *  and distributed under the GPL.
6  *
7  *  Video files are decoded using FFmpeg (http://ffmpeg.org), so any video
8  *  supported by FFmpeg should be usable with DVD-o-matic.  Most testing has, however,
9  *  happened with files from DVD.  DVD-o-matic's output has been tested on Christie
10  *  digital projectors with Doremi servers.
11  *
12  *  DVD-o-matic allows you to crop black borders from movies, scale them to the correct
13  *  aspect ratio and apply FFmpeg filters.  The time-consuming encoding of JPEG2000 files
14  *  can be parallelised amongst any number of processors on the local host and any number
15  *  of servers over a network.
16  * 
17  *  Portions of DVD-o-matic are based on OpenDCP (http://code.google.com/p/opendcp),
18  *  written by Terrence Meiczinger, and two of OpenDCP's command-line tools are called
19  *  by DVD-o-matic.
20  *
21  *  DVD-o-matic uses libopenjpeg (http://code.google.com/p/openjpeg/) for JPEG2000 encoding
22  *  and libsndfile (http://www.mega-nerd.com/libsndfile/) for WAV file manipulation.  It
23  *  also makes heavy use of the boost libraries (http://www.boost.org/).  libtiff
24  *  (http://www.libtiff.org/) is used for TIFF encoding and decoding, and the GUI is
25  *  built using GTK (http://www.gtk.org/) and GTKMM (http://www.gtkmm.org).  It also uses libmhash (http://mhash.sourceforge.net/)
26  *  for debugging purposes.
27  *
28  *  Thanks are due to the authors and communities of all DVD-o-matic's dependencies.
29  * 
30  *  DVD-o-matic is distributed in the hope that there are still cinemas with projectionists
31  *  who might want to use it.  As Mark Kermode says, "if it doesn't have a projectionist
32  *  it's not a cinema - it's a sweetshop with a video-screen."
33  *
34  *  Email correspondance is welcome to cth@carlh.net
35  *
36  *  More details can be found at http://carlh.net/dvdomatic
37  */