zeya/README at master · fragmede/zeya · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
Zeya - a web music server.


AUTHORS

Copyright (C) 2009 Phil Sung <psung at alum.mit.edu>
Copyright (C) 2009 Samson Yeung <fragmede at onepatchdown.net>
Copyright (C) 2009 Romain Francoise <romain at orebokech.com>

Zeya uses public-domain icons from tango-icon-theme.
  More information: <http://tango.freedesktop.org/>


INSTRUCTIONS

1. (Optional) Add the directory containing zeya.py to your PATH.

2. Install dependencies:

   Install the Ogg/Vorbis encoder and the decoders for one or more of the
   following: Ogg/Vorbis, FLAC, and MP3. On an Ubuntu system you can do this
   with:

     aptitude install vorbis-tools    # Vorbis encoder and decoder
     aptitude install flac mpg123     # Flac and MP3 decoders

   Make sure you have Python 2.5 or 2.6 installed:

     aptitude install python2.6

   Python 2.5 users will need to install the simplejson library:

     aptitude install python-simplejson

   If you're using the 'dir' (directory) backend, also install tagpy:

     aptitude install python-tagpy

3. Run zeya.py. The --help flag shows the available options. We support two
   backends:

   'dir': read all music in a directory and its subdirectories. This is the
          default.

     $ zeya.py --path=/path/to/music   # If omitted, --path defaults to ./

   'rhythmbox': read files from the current user's Rhythmbox library.

     $ zeya.py --backend=rhythmbox


CLIENT SUPPORT

Zeya works well in Firefox 3.5+ and well enough on Chrome 3+. See the section
below, titled "NOTES ON SUPPORTED CLIENTS", for more details.

We also provide zeyaclient.py, a rudimentary Python client (1) for use when a
more lightweight client is needed or when no HTML5-compliant browser is
available and (2) as a simple example of programmatic (and non browser-based)
access to a Zeya servers.


NOTES ON SUPPORTED CLIENTS

* Firefox

  All Firefox versions >= 3.5 should work.

  Zeya is known to work in Firefox 3.5.3 on GNU/Linux and Windows.

* Chrome

  Zeya is known to work in Chrome 4.0.223.*, on GNU/Linux, Windows, and Mac OS.

  Known issues:

  Latency between when you click on a song and when it starts playing is very
  high.

    Chrome seems to require the Content-Length header to be set on audio data,
    so we have to finish encoding the entire file before we can send any data
    to the client.

  The Previous button (and the "k" key) doesn't work in Chrome.

    This is apparently related to Chrome not implementing audio.currentTime.

* Internet Explorer (with Chrome Frame plugin)

  Known Issues: see Chrome KIs above.


DEVELOPMENT AND TESTING

You can invoke our test suite by running zeyatest.py.