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