X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=doc%2Fmainpage.txt;h=ec1e6ed2df029b2ea9fde59616a54aeadd819981;hp=1e371852b21ba69ee34f0c36e417792fc6a8b9d9;hb=2d4e8c5f69cc694625ad95dcee554499605f823b;hpb=94201bd2a5a4cb391b7f2bdeba56b928fed7cfe1 diff --git a/doc/mainpage.txt b/doc/mainpage.txt index 1e371852b..ec1e6ed2d 100644 --- a/doc/mainpage.txt +++ b/doc/mainpage.txt @@ -1,32 +1,26 @@ /** @mainpage DCP-o-matic * * DCP-o-matic is a tool to create digital cinema packages (DCPs) from - * video files, or from sets of image files. It is written in C++ + * 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 DCP-o-matic. DCP-o-matic's output has been - * tested on numerous digital projectors. + * More details can be found at https://dcpomatic.com/ * - * DCP-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. + * The source is split into four main parts: * - * DCP-o-matic can also make DCPs from still images, for advertisements and such-like. - * - * Parts of DCP-o-matic are based on OpenDCP (http://code.google.com/p/opendcp), - * written by Terrence Meiczinger. + * 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 * - * DCP-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/). ImageMagick - * (http://www.imagemagick.org/) is used for still-image encoding and decoding, and the GUI is - * built using wxWidgets (http://wxwidgets.org/). + * It is build with `waf`, using something like \code * - * Thanks are due to the authors and communities of all DCP-o-matic's dependencies. + * ./waf configure --enable-debug --prefix=/opt + * ./waf + * sudo ./waf install * - * Email correspondance is welcome to carl@dcpomatic.com + * \endcode * - * More details can be found at http://dcpomatic.com/ */