1 Installation Documentation
3 Copyright (C) 2004 Ushodaya Enterprises Limited
4 Author: Charles Yates <charles.yates@pandora.be>
5 Last Revision: 2004-04-13
11 This document provides a description of the MLT project installation and
18 The directory heirarchy is defined as follows:
20 + demo - A selection of samples to show off capabilities.
21 + docs - Location of all documentation
22 + src - All project source is provided here
23 + framework - The mlt media framework
24 + modules - All services are defined here
25 + avformat - libavformat dependent services
26 + bluefish - Bluefish dependent services (*)
27 + core - Independent MLT services
28 + dv - libdv dependent services
29 + fezzik - A giant (meta) service to load and normalise media
30 + gtk2 - pango and pixbuf dependent services
31 + mainconcept - mainconcept dependent services (*)
32 + normalize - audio normalisation functions (**)
33 + resample - libresample dependent services (**)
34 + sdl - SDL dependent services
35 + vorbis - vorbis dependenent services
36 + westley - Nice and clever XML services
37 + xine - Xine-derived sources (**)
38 + albino - A simple console (protocol level) example
39 + inigo - A media playing test application
40 + humperdink - A terminal-based example client
41 + miracle - The server implementation
42 + tests - Reserved for regression and unit tests
43 + valerie - Client API to access the server
45 Additional subdirectories may be nested below those shown and should be
46 documented in their parent.
48 (*) Not posted to CVS due to licensing issues.
49 (**) Contains GPL dependencies or code.
55 The MLT core is dependent on:
57 * a C99 compliant C compiler
59 * standard posix libraries
61 The MLT applications and libraries provided are all dependent on the core.
63 The modules have the following dependencies:
65 ----------- ----------------------------------------------------------
67 ----------- ----------------------------------------------------------
68 avformat Provided from ffmpeg CVS and compiled as a shared library.
69 URL: http://ffmpeg.sf.net
70 ----------- ----------------------------------------------------------
71 bluefish Bluefish hardware and software development kit
72 URL: http://www.bluefish444.com
73 ----------- ----------------------------------------------------------
74 dv libdv 0.102 or later.
75 URL: http://libdv.sf.net
76 ----------- ----------------------------------------------------------
77 gtk2 GTK2 and associated dependencies.
78 URL: http://www.gtk.org
79 ----------- ----------------------------------------------------------
80 mainconcept Mainconcept MPEG and DVCPRO Release SDKs.
81 URL: http://www.mainconcept.com
82 ----------- ----------------------------------------------------------
83 resample libsamplerate 0.15 or later
84 URL: http://www.mega-nerd.com/SRC/ (GPL)
85 ----------- ----------------------------------------------------------
87 URL: http://www.libsdl.org
88 ----------- ----------------------------------------------------------
89 vorbis libvorbis 1.0.1 or later.
90 URL: http://www.vorbis.com/
91 ----------- ----------------------------------------------------------
92 westley libxml2 2.5 or later.
93 URL: http://www.xmlsoft.org/
94 ----------- ----------------------------------------------------------
100 Configuration is triggered from the top level directory via a
103 Each source bearing subdirectory shown above have their own configure
104 script which are called automatically from the top level.
106 Typically, new modules can be introduced without modification to the
107 configure script and arguments are accepted and passed through to all
110 More information on usage is found by running:
114 NB: This script must be run to register new services after a CVS checkout
115 or subsequent update.
121 Makefiles are generated during configuration and these are based on
122 a per directory template which must be provided by the developer.
128 To execute the mlt tools without installation, or to test a new version
129 on a system with an already installed mlt version, you should run:
133 NB: This applies to your current shell only and it assumes sh or bash.
139 The install is triggered by running make install from the top level
142 The framework produces a single shared object which is installed in
143 $prefix/lib/ and public header files which are installed in
144 $prefix/include/mlt/framework.
146 Valerie produces a single shared object which is installed in
147 $prefix/lib/ and public header which are installed in
148 $prefix/include/mlt/valerie.
150 Miracle produces a single exectuable which is installed in
151 $prefix/bin/, a library in $prefix/lib and associated header files in
154 The modules produce a shared object per module and update text files
155 containing a list of modules provided by this build. These are installed
156 in $prefix/share/mlt/modules. It is at the discretion of the module to
157 install additional support files.
159 To allow the development of external components, mlt-config and scripts
160 are generated and installed in $prefix/bin.
162 After install, only those modules listed are usable by the server. No
163 module is loaded unless explicitly requested via server configuration
166 External modules are also placed in this $prefix/share/mlt/modules, and the
167 installation of those must modify the text file accordingly before they
168 will be considered at runtime.
174 All compilation in the project has {top-level-dir}/src on the include path.
175 All headers are included as:
177 #include <framework/file.h>
179 All external modules have {prefix}/include/mlt on the include path. All
180 headers should also be included as:
182 #include <framework/file.h>
184 This allows migration of source between external and internal modules.
185 The configuration and Makefile template requirements will require