4 This document provides a description of the MLT project installation and
7 It provides *CRITICAL* architecture information, so please read carefully
8 if you plan to extend or use the MLT code base.
14 The directory heirarchy is defined as follows:
16 + demo - A selection of samples to show off capabilities.
17 + docs - Location of all documentation
18 + src - All project source is provided here
19 + framework - The mlt media framework
20 + modules - All services are defined here
21 + core - Independent MLT services
22 + dv - libdv dependent services
23 + ffmpeg - ffmpeg dependent services
24 + avformat - libavformat dependent services
25 + vorbis - vorbis dependenent services
26 + sdl - SDL dependent services
27 + resample - libresample dependent services
28 + gtk2 - pango and pixbuf dependent services
29 + fezzik - A giant (meta) service to load and normalise media
30 + westley - Nice and clever XML services
31 + vorbis - Ogg Vorbis dependent services
32 + xine - Xine-derived sources
33 + bluefish - Bluefish dependent services (*)
34 + mainconcept - mainconcept dependent services (*)
35 + inigo - A media playing test application
36 + valerie - Client API to access the server
37 + miracle - The server implementation
38 + albino - A simple console (protocol level) example
39 + humperdink - A terminal-based example client
40 + tests - Reserved for regression and unit tests
42 Additional subdirectories may be nested below those shown and should be
43 documented in their parent.
45 (*) Not posted to CVS due to licensing issues.
51 Configuration is triggered from the top level directory via a
54 Each source bearing subdirectory shown above have their own configure
55 script which are called automatically from the top level.
57 Typically, new modules can be introduced without modification to the
58 configure script and arguments are accepted and passed through to all
63 ./configure --help - report all configure options
64 ./configure --prefix=[dir] - target install directory (default: /usr/local)
65 ./configure --disable-[mod] - do not compile specified module(s)
66 ./configure --[other] - pass through to children
68 NB: This script must be run to register new services after a CVS checkout
75 Makefiles are generated during configuration and these are based on
76 a per directory template which must be provided by the developer.
82 To execute the mlt tools without installation, or to test a new version
83 on a system with an already installed mlt version, you should run:
87 NB: This applies to your current shell only.
93 The install is triggered by running make install from the top level
96 The framework produces a single shared object which is installed in
97 $prefix/lib/ and public header files which are installed in
98 $prefix/include/mlt/framework.
100 Valerie produces a single shared object which is installed in
101 $prefix/lib/ and public header which are installed in
102 $prefix/include/mlt/valerie.
104 Miracle produces a single exectuable which is installed in
105 $prefix/bin/, a library in $prefix/lib and associated header files in
108 The modules produce a shared object per module and update text files
109 containing a list of modules provided by this build. These are installed
110 in $prefix/share/mlt/modules. It is at the discretion of the module to
111 install additional support files.
113 To allow the development of external components, mlt-config and scripts
114 are generated and installed in $prefix/bin.
116 After install, only those modules listed are usable by the server. No
117 module is loaded unless explicitly requested via server configuration
120 External modules are also placed in this $prefix/share/mlt/modules, and the
121 installation of those must modify the text file accordingly before they
122 will be considered at runtime.
128 All compilation in the project has {top-level-dir}/src on the include path.
129 All headers are included as:
131 #include <framework/file.h>
133 All external modules have {prefix}/include/mlt on the include path. All
134 headers should also be included as:
136 #include <framework/file.h>
138 This allows migration of source between external and internal modules.
139 The configuration and Makefile template requirements will require