X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=doc%2Fmainpage.txt;h=ec1e6ed2df029b2ea9fde59616a54aeadd819981;hp=a944238bf828d74c37f0293d4d8e8aabbc496f9c;hb=c41fcae660993fcf731266b1774fe94d169bf640;hpb=bb767c7e338414beee132af3e96829c1448e214b diff --git a/doc/mainpage.txt b/doc/mainpage.txt index a944238bf..ec1e6ed2d 100644 --- a/doc/mainpage.txt +++ b/doc/mainpage.txt @@ -1,37 +1,26 @@ -/** @mainpage DVD-o-matic +/** @mainpage DCP-o-matic * - * DVD-o-matic is a tool to create digital cinema packages (DCPs) from - * video files, or from sets of TIFF image files. It is written in C++ + * DCP-o-matic is a tool to create digital cinema packages (DCPs) from + * video files, sets of image files, sound and subtitle files. It is written in C++ * and distributed under the GPL. * - * Video files are decoded using FFmpeg (http://ffmpeg.org), so any video - * supported by FFmpeg should be usable with DVD-o-matic. Most testing has, however, - * happened with files from DVD. DVD-o-matic's output has been tested on Christie - * digital projectors with Doremi servers. - * - * DVD-o-matic allows you to crop black borders from movies, scale them to the correct - * aspect ratio and apply FFmpeg filters. The time-consuming encoding of JPEG2000 files - * can be parallelised amongst any number of processors on the local host and any number - * of servers over a network. - * - * Portions of DVD-o-matic are based on OpenDCP (http://code.google.com/p/opendcp), - * written by Terrence Meiczinger, and two of OpenDCP's command-line tools are called - * by DVD-o-matic. - * - * DVD-o-matic uses libopenjpeg (http://code.google.com/p/openjpeg/) for JPEG2000 encoding - * and libsndfile (http://www.mega-nerd.com/libsndfile/) for WAV file manipulation. It - * also makes heavy use of the boost libraries (http://www.boost.org/). libtiff - * (http://www.libtiff.org/) is used for TIFF encoding and decoding, and the GUI is - * built using GTK (http://www.gtk.org/) and GTKMM (http://www.gtkmm.org). It also uses libmhash (http://mhash.sourceforge.net/) - * for debugging purposes. - * - * Thanks are due to the authors and communities of all DVD-o-matic's dependencies. - * - * DVD-o-matic is distributed in the hope that there are still cinemas with projectionists - * who might want to use it. As Mark Kermode says, "if it doesn't have a projectionist - * it's not a cinema - it's a sweetshop with a video-screen." - * - * Email correspondance is welcome to cth@carlh.net - * - * More details can be found at http://carlh.net/dvdomatic + * More details can be found at https://dcpomatic.com/ + * + * The source is split into four main parts: + * + * Directory | Description + * ------------|--------------------------------------------------------------------------------------------- + * `src/lib` | ‘backend’ library with no user interface code. + * `src/wx` | wxWidgets front end code that is common to all tools. + * `src/tools` | Command line and GUI front-ends for the separate tools (main DCP-o-matic, KDM creator etc.) + * `test` | Unit tests + * + * It is build with `waf`, using something like \code + * + * ./waf configure --enable-debug --prefix=/opt + * ./waf + * sudo ./waf install + * + * \endcode + * */