-Installation Documentation
-
-Copyright (C) 2004 Ushodaya Enterprises Limited
-Author: Charles Yates <charles.yates@pandora.be>
-Last Revision: 2004-04-13
-
-
-INSTALL
--------
-
- This document provides a description of the MLT project installation and
- organisation.
-
-
-Directories
------------
-
- The directory heirarchy is defined as follows:
-
- + demo - A selection of samples to show off capabilities.
- + docs - Location of all documentation
- + src - All project source is provided here
- + framework - The mlt media framework
- + modules - All services are defined here
- + core - Independent MLT services
- + dv - libdv dependent services
- + ffmpeg - ffmpeg dependent services
- + avformat - libavformat dependent services
- + vorbis - vorbis dependenent services
- + sdl - SDL dependent services
- + resample - libresample dependent services
- + gtk2 - pango and pixbuf dependent services
- + fezzik - A giant (meta) service to load and normalise media
- + westley - Nice and clever XML services
- + vorbis - Ogg Vorbis dependent services
- + xine - Xine-derived sources
- + bluefish - Bluefish dependent services (*)
- + mainconcept - mainconcept dependent services (*)
- + inigo - A media playing test application
- + valerie - Client API to access the server
- + miracle - The server implementation
- + albino - A simple console (protocol level) example
- + humperdink - A terminal-based example client
- + tests - Reserved for regression and unit tests
-
- Additional subdirectories may be nested below those shown and should be
- documented in their parent.
-
- (*) Not posted to CVS due to licensing issues.
-
-
-Dependencies
-------------
-
- The MLT core is dependent on:
-
- * a C99 compliant C compiler
- * posix threading
- * standard posix libraries
-
- The MLT applications and libraries provided are all dependent on the core.
-
- The modules have the following dependencies:
-
- ----------- ----------------------------------------------------------
- MODULE DESCRIPTION
- ----------- ----------------------------------------------------------
- avformat Provided from ffmpeg CVS and compiled as a shared library.
- URL: http://ffmpeg.sf.net
- ----------- ----------------------------------------------------------
- bluefish Bluefish hardware and software development kit
- URL: http://www.bluefish444.com
- ----------- ----------------------------------------------------------
- dv libdv 0.102 or later.
- URL: http://libdv.sf.net
- ----------- ----------------------------------------------------------
- gtk2 GTK2 and associated dependencies.
- URL: http://www.gtk.org
- ----------- ----------------------------------------------------------
- mainconcept Mainconcept MPEG and DVCPRO Release SDKs.
- URL: http://www.mainconcept.com
- ----------- ----------------------------------------------------------
- resample libsamplerate 0.15 or later
- URL: http://www.mega-nerd.com/SRC/
- ----------- ----------------------------------------------------------
- sdl SDL 1.2 or later.
- URL: http://www.libsdl.org
- ----------- ----------------------------------------------------------
- vorbis libvorbis 1.0.1 or later.
- URL: http://www.vorbis.com/
- ----------- ----------------------------------------------------------
- westley libxml2 2.5 or later.
- URL: http://www.xmlsoft.org/
- ----------- ----------------------------------------------------------
-
-
-Configuration
--------------
-
- Configuration is triggered from the top level directory via a
- ./configure script.
-
- Each source bearing subdirectory shown above have their own configure
- script which are called automatically from the top level.
-
- Typically, new modules can be introduced without modification to the
- configure script and arguments are accepted and passed through to all
- subdirectories.
-
- Top level usage is:
-
- ./configure --help - report all configure options
- ./configure --prefix=[dir] - target install directory (default: /usr/local)
- ./configure --disable-[mod] - do not compile specified module(s)
- ./configure --[other] - pass through to children
-
- NB: This script must be run to register new services after a CVS checkout
- or subsequent update.
-
-
-Compilation
------------
-
- Makefiles are generated during configuration and these are based on
- a per directory template which must be provided by the developer.
-
-
-Testing
--------
-
- To execute the mlt tools without installation, or to test a new version
- on a system with an already installed mlt version, you should run:
-
- . setenv
+---+ Installation Documentation
+
+Last Revision: 2013-09-07
+
+ This document provides a description of the MLT project installation and
+ organisation.
+
+
+---++ Directories
+
+ The directory heirarchy is defined as follows:
+
+ * demo - A selection of samples to show off capabilities.
+ * docs - Location of all documentation
+ * presets - Properties presets for various services
+ * profiles - MLT profile configurations
+ * src - All project source is provided here
+ * framework - The MLT media framework
+ * melt - A media playing test application (*)
+ * mlt++ - C++ wrapper for framework
+ * modules - All services are defined here
+ * avformat - FFmpeg/Libav dependent services
+ * avsync - services to help test audio/video synchronization
+ * core - independent MLT services
+ * decklink - Blackmagick Design SDI/HDMI services
+ * dgraft - ports of Donald Graft's filters (*)
+ * dv - libdv dependent services
+ * effectv - ports of !EffecTV filters (*)
+ * feeds - templates for use with core's data filters
+ * frei0r - adapter for frei0r video plugins
+ * gtk2 - GTK+ pango and pixbuf dependent services
+ * jackrack - adapter for LADSPA audio plugins and JACK server
+ * kdenlive - services contributed by Kdenlive project
+ * kino - DV/AVI demuxer from Kino project (*)
+ * linsys - DVEO SDI card consumer (*)
+ * lumas - wipe file generator for core's luma transition
+ * motion_est - motion estimation-based filters (*)
+ * normalize - audio normalisation functions (*)
+ * oldfilm - filters to make pristine video dirty
+ * opengl - !OpenGL dependent services (*)
+ * plus - miscellaneous services (pending move to core)
+ * qt - Qt dependent services (*)
+ * resample - libresample dependent services (*)
+ * rotoscoping - spline-based alpha mask filter (*)
+ * rtaudio - audio consumer based on !RtAudio project code
+ * sdl - SDL dependent services
+ * sox - !SoX dependent audio filters
+ * swfdec - Swfdec dependent producer for Flash files
+ * videostab - video stabilization filters (*)
+ * vmfx - services contributed by (defunct) Visual Media FX
+ * vorbis - vorbis dependenent services
+ * xine - Xine-derived sources (*)
+ * xml - XML (de)serialization services
+ * swig - High level language bindings using SWIG
+ * tests - Reserved for regression and unit tests
+ * win32 - Windows-specific helper functions