Define first preview version number 0.pre.01

Rewrite README, INSTALL and AUTHORS
as foundation for the Debian package

AUTHORS

@@ -1,58 +1,134 @@
+Lumiera Authors and Credits
+===========================
+Version: 0.pre.0.1
+Date: 2/2011
 
-Cinelerra(2) Authors
-====================
 
-hv=Jack Crossfire <broadcast@earthling.net>
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-j6t=Johannes Sixt <johannes.sixt@telecom.at>
+Architecture and Design,
-minmax=Andraz Tori <Andraz.tori1@guest.arnes.si>
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-herman=Herman Robak <herman@skolelinux.no>
+graphical user interface, JOEL HOLDSWORTH
-baver=Richard Baverstock <baver@thebeever.com>
+ 			, CLAY BARNES
-pere=Petter Reinholdtsen <pere@hungry.com>
+processing layer	, HERMANN VOSSELER
-tfheen=Tollef Fog Heen <tollef@add.no>
+backend 		, CHRISTIAN THÄTER
-andreask=Andreas Kielb <andreaskielb@web.de>
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-theraz=Tyler Geddes <tgeddes@wgeddes.com>
-dyce=Gergely Erdelyi <dyce@rovidzar.hu>
-dreamlx=David Arendt <admin@prnet.org>
-ga=Gustavo Iniguez <ga@kutxa.homeunix.org>
-memenk=Michael Eric Menk <meklev@osys.grm.hia.no>
-benjif=Benjamin Flaming <cinelerra@solobanjo.com>
-cobra=Kevin Brosius <cobra@compuserve.com>
-taraba=Mark Taraba <m_taraba@yahoo.com>
-nate=Nathan Kurz <nate@verse.com>
-mammique=Camille Harang <mammique@garbure.org>
-kbielefe=Karl Bielefeldt <uhauufo02@sneakemail.com>
-alexf=Alex Ferrer <alex@ftconsult.com>
-pmdumuid=Pierre Dumuid <pierre.dumuid@adelaide.edu.au>
-giskard=Riccardo Setti <giskard@autistici.org>
-jstewart=Joe Stewart <jstewart@lurhq.com>
-doudou=Sylvain Joyeux <doudou@melix.net>
-rafael2k=Rafael Diniz <rafael@riseup.net>
-nicolasm=Nicolas Maufrais <e.conti@gmx.net>
 
-Involved in Lumiera development
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-===============================
+Programming,
-cehteh=Christian Thaeter <ct@pipapo.org>
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-ichthyo=Hermann Vosseler <Ichthyostega@web.de>
+rendering engine,	HERMANN VOSSELER
-plouj=Michael Ploujnikov <ploujj@gmail.com>
+backend,		CHRISTIAN THÄTER
+GTK-GUI,          JOEL HOLDSWORTH
+       ,          STEFAN KANGAS
+library,	      HERMANN VOSSELER
+       ,          CHRISTIAN THÄTER
+       ,          ANTON YAKOVLEV
+       ,          SIMEON VÖLKEL
+testsuite,		CHRISTIAN THÄTER
+       ,		NICHOLAS SINNOTT-ARMSTRONG
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Programming Documentation,
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+, MICHAEL PLOUJNIKOV
+, ODIN HØRTHE OMDAL
+, SIMON LARCHER
+, SIMEON VÖLKEL
+, MANO STIENEN
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Used Software and Libraries,
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+boost libraries,
+gavl libraries,
+gtk+ toolkit,
+lua,
+nobug,
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Builddrone,
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+idea and implementation, CHRISTIAN THÄTER
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+//'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// ,Testing
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// ,
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Workflow design,
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+concept	, NIKOLA DUPER
+		, BRIAN RYTEL
+		, MIKE PROVOST
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Server Administration,
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+, CHRISTIAN THÄTER
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+Cinelerra
+---------
+
+Lumiera is an offspring of the Cinelerra video editor. +
+It started out as a partial rewrite of Cinelerra in 2007
+and turned into a complete rewrite and redesign in Spring 2008
+
+
+'`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The Lumiera project feels especially obliged to,
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Cinelerra's original Author, ADAM WILLIAMS / aka. "Jack Crossfire" / aka "HV"
+Cinelerra-CV , all the numerous contributors
+             , of the "Community Version"
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ 
+
+
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
-_______________________________________________________________
 Further Credits
+---------------
 
 Parts of the Proc-Layer Implementation are heavily inspired by
-The Loki Library
+
-    Copyright (c) 2001 by Andrei Alexandrescu
+
-    Loki is governed by a MIT-License.
+.The Loki Library
-    See: http://loki-lib.sourceforge.net
+[quote]
-         and the book:
+__________________________________________________________________________
-            Alexandrescu, Andrei. 
+Copyright (c) 2001 by *Andrei Alexandrescu* +
-                "Modern C++ Design: Generic Programming and Design
+
-                Patterns Applied". Copyright (c) 2001. Addison-Wesley.
+.Loki Copyright Notice
-                ISBN 0201704315
+* Loki is governed by a MIT-License. See: http://loki-lib.sourceforge.net
-        
+* Permission to use, copy, modify, distribute and sell this software for any
-  Loki Copyright Notice: 
-  Permission to use, copy, modify, distribute and sell this software for any
   purpose is hereby granted without fee, provided that the above copyright
   notice appear in all copies and that both that copyright notice and this
   permission notice appear in supporting documentation.
   The author makes no representations about the suitability of this software
   for any purpose. It is provided "as is" without express or implied warranty.
+
+
+.the ``Loki Book''
+[verse]
+Alexandrescu, Andrei. 
+ "Modern C++ Design: Generic Programming and Design Patterns Applied".
+ Copyright (c) 2001. Addison-Wesley.
+ ISBN 0201704315
+_____________________________________________________________________________
+
+

INSTALL

@@ -1,46 +1,71 @@
-Running / Installing Lumiera Prototype
-======================================
-
-From:
-http://www.pipapo.org/pipawiki/Lumiera/NewbiesTutorials
-
-
 Newbies Tutorials
+=================
 
-This page contains some tutorials for beginners that want to help to the
+This page contains some tutorials for beginners interested in Lumiera development.
-developers of Lumiera.
 
-Trying the Lumiera GUI from Joel
 
-You need to have:
+Building Lumiera from source
+----------------------------
+Currently, after building the application, you can try out the Lumiera GUI
+and you can run the testsuite.
 
-  * libboost
+For building Lumiera, besides the GNU C/C++ compiler (Version 4.X), you'll need:
-  * libtool
-  * git
-  * libgavl
-  * nobug(see below)
 
-For Ubuntu Hardy also:
+ * http://git-scm.com/[git]
+ * http://www.gnu.org/software/libtool/[libtool]
+ * http://www.boost.org/[Boost libraries]
+ * http://gmerlin.sourceforge.net/[GAVL library]
+ * *NoBug* (see below)
 
-  * libglade2-dev
+TIP: Generally speaking, when you want to build software, you need the _development_ version
-  * libgdl-1-dev
+of the packages, containing the headers and pre-built libraries to link against. Usually,
-  * libgtkmm-2.4-dev
+these packages are named `-devel` or `-dev`
-  * libxv-dev
 
-also check http://gnuradio.org/trac/wiki/UbuntuInstall#InstallationOptions to
+.Notes for Ubuntu:
-see that all your installations options are met.
 
-Installing nobug from git
+On Hardy you need also:
 
-Create a temp directory where you can have the sourcecode of the libraries you
+ * libglade2-dev
-will use as well as lumieras branches you want to try. Example ~/temp. cd to
+ * libgtkmm-2.4-dev
-that directory and run:
+ * libxv-dev
 
+For most Debian based systems, e.g. Ubuntu Intrepid and Jaunty, you can install these dependencies with:
+
+------------------------------------------------------------
+sudo apt-get install build-essential autoconf libboost-dev libboost-program-options-dev libboost-regex-dev \
+             libtool libgavl-dev libglade2-dev libgdl-1-dev libgtkmm-2.4-dev libxv-dev scons valgrind librsvg2-dev git-core
+------------------------------------------------------------
+
+
+Build directory
+~~~~~~~~~~~~~~~
+You need a directory for checking out the sources and running the build. This could be a temp directory,
+or some "workspace" directory below your home directory. We'll call it _workspace directory_ from now on.
+
+Lumiera specific libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Now that you have your basic build system setup, Lumiera needs a few more special support libraries.
+Currently you need to build those from source and install them, so the Lumiera build process can
+pick them up.
+
+WARNING: Note that the following procedures will try to install files into your base system below `/usr/local`.
+To do so, you'll need administrative permissions for the machine you're working on. These additions might interfere
+with other libraries installed by your package manager (if you get into trouble updating your system later on,
+sometimes you need to remove these manually built librararies). 
+
+Installing NoBug
+^^^^^^^^^^^^^^^^
+
+*NoBug* is an instrumentation and diagnostics library. +
+Go into the mentioned _workspace direcory_ (maybe create a new directory). First, let's get the NoBug source code:
+
+------------------------------------------------------------
 git clone git://git.pipapo.org/nobug
+------------------------------------------------------------
+This will create a (sub)directory called nobug with sourcecode in your current directory. +
+Compile NoBug with the following commands
 
-This will create a directory called nobug with sourcecode in your current
+------------------------------------------------------------
-directory.
-
 cd nobug
 autoreconf -i
 mkdir build
@@ -48,11 +73,78 @@ cd build
 ../configure
 make
 make install
+------------------------------------------------------------
 
-Getting the Lumiera source code
+Installing GDL
+^^^^^^^^^^^^^^
+The *GNOME Docking library* is generally available through your package manager, but
+we contributed some improvements, which are only available in the very recent development
+versions of GDL. Thus, for now we created a special package, which doesn't interfere with
+an existing (older) installation of GDL.
 
-In the temp directory
+Ubuntu 9.04 note: intltool-update is not patched, you must add /usr/share/intltool-debian/ to get the gdl-package to configure correctly (JSC).
 
+------------------------------------------------------------
+git clone git://git.lumiera.org/gdl-package
+cd gdl-package
+./configure
+make
+sudo make install
+------------------------------------------------------------
+
+For more detailed instructions on how to build gdl (also how to build it into a debian package) see
+http://lists.lumiera.org/pipermail/lumiera/2009-April/000891.html[this message on the Lumiera Mailinglist].
+
+
+check library linkage
+^^^^^^^^^^^^^^^^^^^^^
+The compile will warn you to add various directories to /etc/ld.so.conf and then run ldconfig. This
+will allow your dynamic liker to pick up the newly built libraries later when you try to start Lumiera.
+If you don't want to reconfigure your system and add `/usr/local/lib` to the mentioned linker configuration,
+you may alternatively just add the directories to your LD_LIBRARY_PATH environment variable.
+
+Either way, check that all libraries are accessible and ok:
+
+------------------------------------------------------------
+sudo ldconfig -v | grep 'gdl-lum\|nobug'
+------------------------------------------------------------
+
+and you should get a list of the libraries, part of which should look like this:
+
+------------------------------------------------------------
+        libnobug.so.0 -> /usr/local/lib/libnobug.so.0.0.0
+        libnobugmt.so.0 -> /usr/local/lib/libnobugmt.so.0.0.0
+        libgdl-lum.so.0 -> /usr/local/lib/libgdl-lum.so.0.0.0
+------------------------------------------------------------
+
+or similar. If any if this libs are not listed, investigate why before continuing. 
+
+
+Building Lumiera
+~~~~~~~~~~~~~~~~
+Lumiera has two maintained (and equivalent) build systems: *scons* and *autotools*. You can pick the one you
+feel more comfortable with.
+
+When trying to build a development version of Lumiera, it might well be that at times one of the builds doesn't work temporarily. It is always a good idea to check the current build stats from our *builddrone*, which automatically builds the latest version from master repository. +
+Please have a look at this http://lumiera.org/builddrone/table.html[current build stats]-page.
+
+Next, after having built and installed the prerequisite libraries, go into the _workspace directory_ to retrieve the Lumiera source code and build it.
+
+
+ * to retrieve the sourcecode with git and then build with *scons*:
++ 
+(see available build options by issuing `scons -h` )
++
+-----------------
+git clone git://git.lumiera.org/LUMIERA
+cd LUMIERA
+scons
+-----------------
++
+   
+ * alternatively, if you prefer building with *autotools*:
++
+-----------------
 git clone git://git.lumiera.org/LUMIERA
 cd LUMIERA
 autoreconf -fi
@@ -60,40 +152,52 @@ mkdir build
 cd build
 ../configure
 make
+-----------------
 
-maybe run the testsuite by
+maybe build and run the testsuite by issuing `scons check` or `make check`
 
-make check
+This will take some time.
 
-This will take some time. After it has finished:
+NOTE: you can't _install_ Lumiera currently. Don't try it, it won't work.
+Just run it from the build directory.
 
-./lumigui
+After the build has finished successfully, you should be able to start Lumiera.
+Currently, this will bring up the GUI, without any further functionality
 
-[NewbiesTut]
+ * for autotools build: issue `./lumiera` (from within the `build` subdirectory)
+ * for scons build:
++
+-------------------
+cd bin
+./lumiera
+-------------------
 
-Contibuting
+you should see something like (screenshot from 1/2009):
 
-Nothing is easier, follow the basic instructions at http://www.kernel.org/pub/
+image:http://www.pipapo.org/pipawiki/Lumiera/GuiBrainstorming?action=AttachFile&do=get&target=screenshot090124-resources.jpg[]
-software/scm/git/docs/gittutorial.html, notably the
 
+
+
+Contributing
+------------
+
+Nothing is easier, follow the http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html[the basic instructions],
+notably the following parts:
+------------------------------------------------------------
 $ git config --global user.name "Your Name Comes Here"
 $ git config --global user.email you@yourdomain.example.com
-
+------------------------------------------------------------
-parts.
+
-
+
-Then you are ready to go, you can edit and commit the lumiera code locally in
+Then you are ready to go, you can edit and commit the lumiera code locally in your cloned repository. Please do small commits which fix/improve only one single thing and use meaningful commit messages. 
-your cloned repository. Please do small commits which fix/improve only one
+
-single thing and use meaningful commit messages. Check that you didn't broke
+Check that you didn't break anything, by running the testsuite (see above)
-anything
+
-
+Finally you can push your changes to the lumiera server to the 'mob' repository:
-  * by running 'make check'.
+
-
+------------------------------------------------------------
-Finally you can push your changes to the lumiera server to the 'mob'
+$ git push git://git.lumiera.org/lumiera/mob master:refs/heads/YOURNAME 
-repository:
+------------------------------------------------------------
-
+This creates a new branch 'YOURNAME' on the mob repository. Then you notify the other devs on the mailinglist and they may merge your code into the mainline.
-$ git push git://git.lumiera.org/lumiera/mob master:refs/heads/YOURNAME
-
-This creates a new branch 'YOURNAME' on the mob repository. Then you notify the
-other devs on the mailinglist and they may merge your code into the mainline.
 
 

README

@@ -1,44 +1,73 @@
-====================================
 Lumiera -- the video NLE for Linux
 ====================================
 
- Lumiera is a nonlinear video editing and compositing tool. 
+*************************************************************
- It understands some of the common multimedia formats
+Lumiera is a nonlinear video editing and compositing tool. 
- (quicktime, avi, ogg) and audio/video compression
+It understands some of the common multimedia formats
- codecs (divx, xvid, mpeg1/2/4, ...)
+(quicktime, avi, ogg) and audio/video compression
- .
+codecs (divx, xvid, mpeg1/2/4, ...)
- It features non-destructive editing, compositing tools,
- a selection of effects plugins, processing in RGB, YUV
- and RGB-float colormodels and the ability to mix media
- with differing sizes and framerates.
 
-For more information about Lumiera visit http://lumiera.org/
+It features non-destructive editing, compositing tools,
-For more information about Cinelerra visit http://cinelerra.org/
+a selection of effects plugins, processing in RGB, YUV
+and RGB-float colormodels and the ability to mix media
+with differing sizes and framerates.
 
+More Informations at http://lumiera.org/[Lumiera.org]
+****************************************************************
 
-----------------------------
+Lumiera pre-Alpha Versions
-"Lumiera" prototype code
+--------------------------
-----------------------------
 
-**This source tree doesn't yet contain a working video editing application**
+**This source tree doesn't yet contain a working video editing application** +
-Rather, it contains the initial framework and core modules of the lower and
+Rather, it contains the framework and technology core of the envisioned Application ``Lumiera''.
-middle layer of the envisioned new Application "Lumiera".
 
-As of 7/2007, we start here with some backend and render engine modules
+As of _7/2007_::
+we start here with the backend and render engine modules
 together with some unit tests. You should find a wiki with detailed
 design considerations and developer documentation and a UML model
 (usable with BOUML 2.29) in the sibling directories.
 
-As of 2/2008 the project has been separated completely from his ancestor "Cinelerra"
+As of _2/2008_::
+the project has been separated completely from his ancestor ``Cinelerra''
 The Community, which is largely identical to the Cinelerra-CV community, choose the
-new project name "Lumiera". The basic project infrastructure is up and running,
+new project name ``Lumiera''. The basic project infrastructure is up and running,
 and work on the new codebase is going on continuosely. We can show nothing but
-a running test suite for now. 
+a running test suite for some time to come. 
 
+As of _1/2011_::
+the project has created and documented a fairly consistent design,
+partially already coded up -- starting from the technical foundations and working up.
+The code base is approaching 100k LOC. Roughly half of this is testcode.
+The Application can be installed and started to bring up an GTK GUI outline,
+but the GUI is very preliminary and not connected to core functionality.
+The video processing pipeline is still not complete.
+
+See the http://issues.lumiera.org/roadmap[Project roadmap]
 
 
 Build Requirements
 ------------------
 
-*to be written*
+For building Lumiera, you'll need:
+
+ - GNU C/C++ compiler (Version > 4.3)
+ - Git Version management system
+ - http://www.boost.org/[Boost libraries]
+ - http://gmerlin.sourceforge.net/[GAVL library]
+ - http://lumiera.org/nobug_manual.html[NoBug library]
+ - GTK\--
+ - Cairo and Glade libraries
+ - X libraries
+ - http://scons.org[SCons] or Autotools build system
+
+See the online documentation at http://lumiera.org/Lumiera/NewbiesTutorials
+or the local Copy of this page in the file INSTALL
+
+
+Debian Package
+--------------
+[verse]
+Hermann Vosseler (aka Ichthyo) maintains a *Debian* packaging of the source tree,
+which can be pulled from +git://git.lumiera.org/lumiera/debian+
+It can be built by +git-buildpackage+
 

SConstruct

@@ -30,7 +30,7 @@
 
 #-----------------------------------Configuration
 TARGDIR      = 'target'
-VERSION      = '0.1+pre.01'
+VERSION      = '0.pre.01'
 TOOLDIR      = './admin/scons'    # SCons plugins
 SCRIPTDIR    = './admin'
 OPTCACHE     = 'optcache'