git.sesse.net Git - mlt/blob - README

   1 README
   2 ------
   3
   4         This document provides a description of the MLT project organisation.
   5
   6         It provides *CRITICAL* architecture information, so please read carefully
   7         if you plan to extend or use the MLT code base.
   8
   9 Directories
  10 -----------
  11
  12         The directory heirarchy is defined as follows:
  13
  14         + docs                                  - Location of all documentation
  15         + src                                   - All project source is provided here
  16                 + framework                     - The mlt media framework
  17                 + modules                       - All services are defined here
  18                         + core                  - Independent MLT services
  19                         + dv                    - libdv dependent services
  20                         + ffmpeg                - ffmpeg dependent services
  21                         + sdl                   - SDL dependent services
  22                         + resample              - libresample dependent services
  23                         + gtk2                  - pango and pixbuf dependent services
  24                         + bluefish              - Bluefish dependent services (*)
  25                         + mainconcept   - mainconcept dependent services (*)
  26                 + inigo                         - A media playing test application
  27                 + valerie                       - Client API to access the server
  28                 + miracle                       - The server implementation
  29                 + humperdink            - The evil demo
  30                 + albino                        - The simple but nice demo
  31                 + tests                         - Reserved for regression and unit tests
  32
  33         Additional subdirectories may be nested below those shown and should be
  34         documented in their parent.
  35
  36         (*) Not posted to CVS due to licensing issues.
  37
  38 Configuration
  39 -------------
  40
  41         Configuration is triggered from the top level directory via a
  42         ./configure script.
  43
  44         Each source bearing subdirectory shown above have their own configure
  45         script which are called automatically from the top level.
  46
  47         Typically, new modules can be introduced without modification to the
  48         configure script and arguments are accepted and passed through to all
  49         subdirectories.
  50
  51         Top level usage is:
  52
  53         ./configure --help                      - report all configure options
  54         ./configure --prefix=[dir]      - target install directory (default: /usr/local)
  55         ./configure --disable-[mod] - do not compile specified module(s)
  56         ./configure --[other]           - pass through to children
  57
  58         NB: This script must be run to register new services after a CVS checkout
  59         or subsequent update.
  60
  61 Compilation
  62 -----------
  63
  64         Makefiles are generated during configuration and these are based on
  65         a per directory template which must be provided by the developer.
  66
  67 Testing
  68 -------
  69
  70         To execute the mlt tools without installation, or to test a new version
  71         on a system with an already installed mlt version, you should run:
  72
  73         . setenv
  74
  75         NB: This applies to your current shell only.
  76
  77 Installation
  78 ------------
  79
  80         * NOT IMPLEMENTED YET *
  81
  82         The install is triggered by running make install or make install-strip
  83         from the top level directory.
  84
  85         The framework produces a single shared object which is installed in
  86         $prefix/lib/ and public header files which are installed in
  87         $prefix/include/mlt/framework.
  88
  89         The client produces a single shared object which is installed in
  90         $prefix/lib/ and public header which are installed in
  91         $prefix/include/mlt/client.
  92
  93         The server produces a single exectuable which is installed in
  94         $prefix/bin/. This is linked against the framework shared object and
  95         posix libs but not against any of the modules.
  96
  97         The modules produce a shared object per module and update text files
  98         containing a list of modules provided by this build. These are installed
  99         in $prefix/share/mlt/. It is at the discretion of the module to install
 100         additional support files.
 101
 102         To allow the development of external components, mlt-client-config and
 103         mlt-framework-config scripts are generated and installed in $prefix/bin.
 104
 105         After install, only those modules listed are usable by the server. No
 106         module is loaded unless explicitly requested via server configuration
 107         or usage.
 108
 109         External modules are also placed in this $prefix/share/mlt, and the
 110         installation of those must modify the text file accordingly before they
 111         will be considered at runtime.
 112
 113 Development
 114 -----------
 115
 116         All compilation in the project has {top-level-dir}/src on the include path.
 117         All headers are included as:
 118
 119                 #include <framework/file.h>
 120
 121         All external modules have {prefix}/include/mlt on the include path. All
 122         headers should also be included as:
 123
 124                 #include <framework/file.h>
 125
 126         This allows migration of source between external and internal modules.
 127         The configuration and Makefile template requirements will require
 128         attention though.
 129
 130 Summary
 131 -------
 132
 133         1.      The server will interact with public interfaces from the framework only;
 134         2.      The modules must expose public framework interfaces only;
 135         3.      All modules are dynamically loaded at runtime.
 136