README

   1 What is Rygel?
   2 =============
   3
   4 Rygel is a home media solution that allows you to easily share audio, video and
   5 pictures, and control of media player on your home network. In technical terms
   6 it is both a UPnP AV MediaServer and MediaRenderer implemented through a plug-in
   7 mechanism. Interoperability with other devices in the market is achieved by
   8 conformance to very strict requirements of DLNA and on the fly conversion of
   9 media to format that client devices are capable of handling.
  10
  11 Important facts and features
  12 ============================
  13
  14   * Specifically designed for GNOME (Mobile) and is therefore planned to be one
  15     of the key new features of GNOME 3.0 and Maemo platform in the Harmattan
  16     release.
  17   * Based on GUPnP.
  18   * Written entirely in Vala language.
  19   * APIs to ease the implementation of AV devices.
  20   * Export of on-disk media:
  21     * Tracker plugin.
  22     * MediaExport plugin: Recursively exports folders and files specified in
  23                           the user configuration. This plugin supports all
  24                           types of URIs that gio/gvfs and gstreamer can handle.
  25   * Export of online media from 2nd German TV station.
  26   * Export of media hierarchies provided by external applications through
  27     implementation of D-Bus MediaServer spec. Applications that utilize
  28     this feature are:
  29     * DVB Daemon
  30     * Rhythmbox
  31   * Export of GStreamer pipelines as media items on the network, specified
  32     through gst-launch syntax in the user configuration.
  33   * Audio and Video Transcoding: source format could be anything GStreamer's
  34     decodebin2 can handle but output formats are currently limited to: mp3, PCM
  35     and MPEG TS. Fortunately the transcoding framework is flexible enough to
  36     easily add more transcoding targets.
  37   * Standalone MediaRenderer plugin based on GStreamer playbin2 element.
  38   * Export of media players that implement MPRIS2 D-Bus interface, as
  39     MediaRenderer devices. Known implementing applications are:
  40     * Rhythmbox
  41     * VLC
  42
  43 Requirements
  44 ============
  45
  46   * Build-time:
  47     * Core:
  48       * gupnp
  49       * gupnp-av
  50       * dbus-glib
  51       * gstreamer
  52       * gio (part of glib source package)
  53       * libgee
  54       * libuuid
  55       * libsoup
  56       * vala (not if building from release tarballs)
  57     * Preferences UI:
  58       * gtk+
  59     * MediaExport:
  60       * sqlite3
  61   * Run-time:
  62     * Definitely needed:
  63       * gst-plugins-base
  64       * shared-mime-info
  65     * Might be needed (depending on your usage and media collection):
  66       * gst-plugins-good
  67       * gst-ffmpeg
  68       * gst-plugins-bad
  69       * gst-plugins-ugly
  70
  71 To build without gstreamer, use:
  72   --with-media-engine=simple
  73 This will also disable any plugins that use gstreamer.
  74
  75 References
  76 ==========
  77
  78   * http://www.dlna.org
  79   * http://www.upnp.org
  80   * http://maemo.org/intro/platform
  81   * http://wiki.maemo.org/Task:Maemo_roadmap/Harmattan
  82   * http://www.gupnp.org
  83   * http://www.vala-project.org
  84   * http://www.wikipedia.org/wiki/Media_server
  85   * http://www.upnp.org/specs/av/UPnP-av-MediaServer-v2-Device-20060531.pdf
  86   * http://www.gnome.org/projects/tracker
  87   * http://live.gnome.org/DVBDaemon
  88   * http://www.zdf.de
  89   * http://live.gnome.org/Rygel/MediaServer2Spec
  90   * http://www.mpris.org/2.0/spec/
  91