=====================================
Codec Installer Application (Codeina)
=====================================

The installer can be called in two ways:

 a) with no command line arguments; in this mode, it should show all available
    plugins to buy (and those already bought and installed), and show whether
    there are newer versions available etc.

    Example:

       $ ./bin/codeina

 b) with a bunch of command line arguments indicating one or more missing
    GStreamer plugins (e.g. missing decoder/demuxer or protocol source); in
    this mode it should show all available plugins that match the required
    components and offer them for buying (or upgrade) etc.

    Example:

       $ ./bin/codeina 'gstreamer|0.10|totem|MP3 Decoder|decoder-audio/mpeg, mpegversion=(int)1, layer=(int)3'
       $ ./bin/codeina 'gstreamer|0.10|totem|Microsoft Media Server (MMS) protocol source|urisource-mms'
       $ ./bin/codeina --transient-for=982 'gstreamer|0.10|totem|Dolby AC3 Decoder|decoder-audio/x-ac3'

       (multiple missing components may be specified in one go as well)


===== Testing auto-codec installation =====

 a) You need a recent enough GStreamer using application that uses the
    pbutils library; e.g. Totem or Rhythmbox from TRUNK as of 2007-03-11

 b) Start them with the GST_INSTALL_PLUGINS_HELPER environment variable set:
    GST_INSTALL_PLUGINS_HELPER=/path/to/codeina/trunk/bin/codeina totem

===== Testing .tar.gz installation code ====

    $ python codeina/install.py /path/to/plugin-bundle.tar.gz

    should install the given .tar.gz into ~/.gstreamer-0.10/plugins/ after
    testing that the plugins are in fact loadable.

===== Debugging ====

You can control the debugging output with the environment variable
CODEINA_DEBUG.

To get all possible log information, use
CODEINA_DEBUG=5

===== Utilities ====

 a) small utility to output a 'provides' string for available-plugins.xml from
    a given .tar.gz archive containing GStreamer plugin .so files (only works
    on linux so far, requires GStreamer core >= 0.10.11.1 for the gst-inspect
    support, but recommended is core 0.10.12.1 from CVS due to a small bugfix):

    e.g.

      $ python codeina/inspect.py /path/to/plugin-bundle.tar.gz

      ***** myplugin-bundle.tar.gz
      provides='element-avidemux; decoder-video/x-msvideo; element-avimux; encoder-video/x-msvideo'
