annotate README.icecast @ 2922:12588a9a458f

added some docs about Icecast plugin
author Andrew O. Shadoura <bugzilla@tut.by>
date Wed, 20 Aug 2008 02:46:53 +0300
parents
children 2bcafe0a224e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2922
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
1 Icecast plugin notes
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
2 --------------------
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
3
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
4 0. Build-time requirements
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
5 ==========================
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
6
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
7 To build Icecast plugin successfully, you need at least:
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
8
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
9 * Audacious development files (audacious-dev package)
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
10
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
11 * Audacious plugins sources themselves
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
12 and all their build-time dependencies
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
13
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
14 * libshout development files (libshout3-dev package)
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
15
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
16 Please note that Icecast plugin must be compiled *after* FileWriter plugin,
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
17 as they share some pieces of code (namely, encoding backends and format
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
18 conversion routines). If you build all plugins, this is done automagically.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
19
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
20
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
21 1. Run-time requirements
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
22 ========================
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
23
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
24 To run Icecast plugin, you need:
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
25
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
26 * Icecast 2 server running somewhere, maybe at your local host,
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
27 to which you have "source" access
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
28
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
29 * libshout version 2.0+ (libshout3 package)
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
30
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
31
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
32 2. Usage recommendations
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
33 ========================
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
34
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
35 The plugin is implemented as both output and effect. This means that you can
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
36 set it as the only Audacious output, if you don't need to hear anything, or
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
37 you can listen to music and send the same audio data to Icecast server.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
38
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
39 Please note that using plugin as effect is recommended. If you want to turn off
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
40 your speakers, just use Null audio output plugin.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
41
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
42 The next thing you need to do is to decide what kind of stream do you want. You
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
43 can use MPEG Layer 3 or Ogg Vorbis encoder. Currently supported are LAME and
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
44 vorbisenc. Depending on your system configuration you may or may not have LAME,
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
45 as it has patent problems with Fraunhofer IIS, and Debian doesn't provide
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
46 packages for it.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
47
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
48 If you are Debian user and want to use LAME anyway, refer to debian-multimedia
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
49 project.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
50
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
51
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
52 3. Configuration
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
53 ================
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
54
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
55 First of all, you need to set up Icecast 2 properly. Note: previous versions of
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
56 Icecast as well as any versions of Shoutcast were not tested and are not
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
57 guaranteed to work at all.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
58
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
59 Usually, if you have single-user Icecast 2 setup, you should use user name
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
60 "source" and appropriate password. In either case, refer to Icecast 2 manual
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
61 for details.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
62
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
63 Mount point is a path on Icecast server, where your stream will be available.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
64 I.e., if you have server at your local machine on default port, and mountpoint
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
65 is "/test", the whole URL of your stream would be
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
66
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
67 http://127.1:8000/test
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
68
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
69 If you don't specify mount point, mount point is set to "/". Don't do this.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
70
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
71 The connection timeout option is treated differently when plugin is in output
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
72 or effect mode. When being used as output plugin, this setting specifies the
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
73 time between last song ends (or "Stop" button click) and actual disconnect.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
74 When being used as effect plugin, this setting specifies maximum time between
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
75 sequential portions of audio data sent to server.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
76
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
77 Plugin has internal buffer which collects audio data being sent to server. You
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
78 can fine tune size of this buffer. If buffer is too small, data will be sent
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
79 directly to the server bypassing this buffer. If buffer is too big, there can
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
80 be large pauses in audio data.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
81
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
82 You can set some information about your stream. First of all, you can provide
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
83 stream name, its description, music genre (or genres), URL of site where
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
84 listeners can read more about your radio. Also, you can ask server to list
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
85 the stream in any directories it knows about. Please refer to Icecast 2
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
86 documentation for more details about this.
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
87
12588a9a458f added some docs about Icecast plugin
Andrew O. Shadoura <bugzilla@tut.by>
parents:
diff changeset
88 -- Andrew O. Shadoura <bugzilla@tut.by>