{{{
#!rst

=====================
Elisa / Dapper HowTo
=====================

This howto details step by step how to get Elisa running on Ubuntu
Dapper Drake.

.. sectnum::

.. contents::

Requirements
============

Hardware
--------

Elisa should run fine on any nowaday computer. Since it heavily relies
on OpenGL for the GUI rendering, Elisa will run better on computers
equiped with NVidia or ATI video hardware, and the proprietary video
drivers. The purpose of this howto isn't to explain the reader how to
install these drivers, read the Ubuntu docs for that.


Repositories configuration
--------------------------

By default multiverse and some other APT repositories are disabled,
you need to enable everything in the file
/etc/apt/sources.list. Moreover you'll need to add Marillat's
repository. Here is a valid sources.list file:

::

  deb http://fr.archive.ubuntu.com/ubuntu/ dapper main restricted
  deb-src http://fr.archive.ubuntu.com/ubuntu/ dapper main restricted

  ## Major bug fix updates produced after the final release of the
  ## distribution.
  deb http://fr.archive.ubuntu.com/ubuntu/ dapper-updates main restricted
  deb-src http://fr.archive.ubuntu.com/ubuntu/ dapper-updates main restricted

  ## Uncomment the following two lines to add software from the 'universe'
  ## repository.
  ## N.B. software from this repository is ENTIRELY UNSUPPORTED by the Ubuntu
  ## team, and may not be under a free licence. Please satisfy yourself as to
  ## your rights to use the software. Also, please note that software in
  ## universe WILL NOT receive any review or updates from the Ubuntu security
  ## team.
  deb http://fr.archive.ubuntu.com/ubuntu/ dapper universe
  deb-src http://fr.archive.ubuntu.com/ubuntu/ dapper universe

  ## Uncomment the following two lines to add software from the 'backports'
  ## repository.
  ## N.B. software from this repository may not have been tested as
  ## extensively as that contained in the main release, although it includes
  ## newer versions of some applications which may provide useful features.
  ## Also, please note that software in backports WILL NOT receive any review
  ## or updates from the Ubuntu security team.
  deb http://fr.archive.ubuntu.com/ubuntu/ dapper-backports main restricted universe multiverse
  deb-src http://fr.archive.ubuntu.com/ubuntu/ dapper-backports main restricted universe multiverse

  deb http://security.ubuntu.com/ubuntu dapper-security main restricted
  deb-src http://security.ubuntu.com/ubuntu dapper-security main restricted
  deb http://security.ubuntu.com/ubuntu dapper-security universe
  deb-src http://security.ubuntu.com/ubuntu dapper-security universe

  deb http://www.debian-multimedia.org sid main



GStreamer
---------

After the repository configuration, you are safe to install packages
that will allow you to play all your multimedia files with GStreamer
on Elisa:

::

  $ sudo apt-get install gstreamer0.10-plugins-bad gstreamer0.10-ffmpeg gstreamer0.10-plugins-ugly



Miscellaneous
-------------

If you're willing to try the latest bleeding edge code from our Subversion repository, 
you need a subversion client:

::
  
  $ sudo apt-get install subversion

To build Elisa source code you'll need to install further more
packages:

::

  $ sudo apt-get install gcc libsdl1.2-dev libcairo-dev python2.4-dev \ 
    python2.4-imaging python2.4-twisted python-gst0.10 python2.4-elementtree \
    python2.4-soappy sqlite3 libsqlite3-dev libglu1-mesa-dev


Installing Elisa
================

Checkout the code
-----------------

If you're testing code hosted at our Subversion repository:

::

  $ svn co https://core.fluendo.com/elisa/svn/trunk elisa

Else, you only need to unpack latest release archive somewhere on your home directory (for instance)

Create the Elisa environment
----------------------------

If you don't want to install Elisa system-wide, create a mini-jail
where Elisa and its plugins will be linked from the source files:

::

  $ python env.py
  Updating Elisa jail in elisa-env
  Making working environment in elisa-env
  Creating lib/python2.4
  Creating lib/python2.4/distutils
  Creating bin
  Creating src
  Creating conf
  Creating file lib/python2.4/distutils/distutils.cfg
  Creating file bin/activate
  Creating file lib/python2.4/distutils/__init__.py
  Downloading http://cheeseshop.python.org/packages/2.4/s/setuptools/setuptools-0.6b3-py2.4.egg
  Creating /home/phil/tmp/elisa/elisa-env/lib/python2.4/site.py
  Processing setuptools-0.6b3-py2.4.egg
  [...]
  Installed /home/phil/tmp/elisa/elisa-env/lib/python2.4/setuptools-0.6b3-py2.4.egg
  Processing dependencies for setuptools==0.6b3

So, once the elisa-env is created, activate it. Activation only update
the $PYTHONPATH and $PATH environment variables:

::

  $ source ./elisa-env/bin/activate

Extra requirements
------------------

There are optional dependencies you can install so as to get all
plugins working. Unfortunately Ubuntu Dapper doesn't provides these
ones, so you need to install them in your local Elisa environment
using easy_install (which was installed by env.py):

::

  $ easy_install cElementTree
  $ easy_install PySQLite


Local Elisa installation
------------------------

To compile and install Elisa locally, issue a single command:

::

  $ python setup.py develop
  [...snip...]
  Installed /home/phil/tmp/elisa/
  Processing dependencies for Elisa==0.1


Play with it!
-------------

You're now ready to run :-)

::

  $ python elisa.py

You should see a window pop up with a menu, use the keyboard shortcuts
to navigate, etc:

- Arrows : for navigation
- Enter : Action (play video ...)
- space : Hide/Show menu.
- p : play
- l : pause
- s : stop
- f : fullscreen toggle
- c : seek+
- x : seek-
- v : next
- w : previous
- m : mute
- u : volume up
- i : volume down

If you want to customize Elisa (media locations for instance), you can copy the default config file and tell elisa.py to use it:

::

  $ cp elisa.conf local.conf
  $ gedit local.conf
  $ # edit and save local.conf
  $ python elisa.py local.conf


}}}