1 | sipbmp3 |
---|
2 | The SIPB MP3 Music Spooler |
---|
3 | |
---|
4 | We would love you forever if you took this README/INSTALL document and made |
---|
5 | a Debian package out of it. That would be uber-awesome. But otherwise, we're |
---|
6 | assuming that you just want to get sipbmp3 up and running on your own |
---|
7 | system. Well, maybe we shouldn't assume that. |
---|
8 | |
---|
9 | |
---|
10 | What does sipbmp3 do? |
---|
11 | --------------------- |
---|
12 | |
---|
13 | sipbmp3 is a music spooler. As it turns out, streaming music is a hard |
---|
14 | problem, with lots of proprietary protocols, client and server software. |
---|
15 | All of these jiggety bits are kind of a pain to get working correctly, |
---|
16 | so, we built sipbmp3 on top of... a printer system. It's very simple: |
---|
17 | you print an mp3 file to a special "printer", and it gets played on |
---|
18 | whatever speakers you're hooked up to. |
---|
19 | |
---|
20 | |
---|
21 | Prerequisites |
---|
22 | ------------- |
---|
23 | |
---|
24 | You'll need a server hooked up to an audio system that you want to use, with |
---|
25 | Debathena installed on top of it. Ubuntu Server Edition tends to work |
---|
26 | well. |
---|
27 | |
---|
28 | |
---|
29 | Installing sipbmp3 |
---|
30 | ------------------ |
---|
31 | |
---|
32 | |
---|
33 | 1. Configuring your sound |
---|
34 | |
---|
35 | If you're installing sipbmp3 on a server environment, it's highly likely |
---|
36 | that you have a bare bones audio setup and everything is muted. Make sure |
---|
37 | your sound works! One common problem is that the daemon user (the user which |
---|
38 | will be actually playing the songs, or the user that your lpd, the print server, |
---|
39 | will be running under), isn't in the group audio, and thus can't play |
---|
40 | anything. If you're on Ubuntu Desktop, you'll probably have pulse-audio |
---|
41 | installed, in which case you should add lpd to the pulse-audio group |
---|
42 | as well, and make pulse-audio a single, system-wide instance. See |
---|
43 | this URL for detailed instructions: |
---|
44 | |
---|
45 | http://www.pulseaudio.org/wiki/SystemWideInstance |
---|
46 | |
---|
47 | |
---|
48 | 2. Install some prerequisite software |
---|
49 | |
---|
50 | On a vanilla Ubuntu server install, sipbmp3 will also need the following |
---|
51 | packages to work properly: |
---|
52 | |
---|
53 | * mplayer |
---|
54 | * libimage-exiftool-perl |
---|
55 | |
---|
56 | mpg123 can also be useful for testing, but is not strictly necessary. |
---|
57 | |
---|
58 | |
---|
59 | 3. Setup sipbmp3 |
---|
60 | |
---|
61 | The Git repository for sipbmp3 is located in: |
---|
62 | |
---|
63 | /afs/sipb/project/sipbmp3/sipbmp3.git |
---|
64 | |
---|
65 | While sudo'ed as root, you should git clone this somewhere; zsr has |
---|
66 | it dumped in /usr/local/bin, while scourge puts it the more cordoned |
---|
67 | off /root/sipbmp3. |
---|
68 | |
---|
69 | |
---|
70 | 4. Configure sipbmp3 |
---|
71 | |
---|
72 | sipbmp3 will send zephyrs during playback start and end. Since you don't |
---|
73 | want to be spamming sipb-auto (which is the default zephyr class these |
---|
74 | are sent to), you should create a configuration file: |
---|
75 | |
---|
76 | /etc/sipbmp3-filter-config.pl |
---|
77 | |
---|
78 | That looks like: |
---|
79 | |
---|
80 | $zephyr_class = "my-auto-class" |
---|
81 | $host = "hostname" |
---|
82 | |
---|
83 | XXX: Auto-detect hostname and invent a sane default zephyr class off of it. |
---|
84 | |
---|
85 | |
---|
86 | 5. Configure sipbmp3 init scripts |
---|
87 | |
---|
88 | sipbmp3 will attempt to drop some information into /var/run/sipbmp3, which |
---|
89 | needs to exist and you can't simply mkdir since /var/run on Ubuntu is |
---|
90 | a tempfs. Thus, add the following lines to a new file, /etc/init.d/sipbmp3: |
---|
91 | |
---|
92 | #!/bin/sh |
---|
93 | mkdir /var/run/sipbmp3 |
---|
94 | touch /var/run/sipbmp3/status |
---|
95 | chmod 0777 /var/run/sipbmp3/status |
---|
96 | |
---|
97 | You should also run these commands yourself. :-) |
---|
98 | |
---|
99 | XXX: We need better permissions for status. Also, quentin wants to put this |
---|
100 | file in AFS. |
---|
101 | |
---|
102 | |
---|
103 | 6. Configure lpd |
---|
104 | |
---|
105 | You'll need to setup a printcap file so that your machine will be actually |
---|
106 | running a printer! The magic lines are: |
---|
107 | |
---|
108 | :if=|/path/to/sipbmp3-filter |
---|
109 | :lp=/dev/null |
---|
110 | |
---|
111 | Which mean that we pipe the mp3 files through sipbmp3-filter (which does |
---|
112 | the actual playing), and then dump the rest of the output into /dev/null, |
---|
113 | since we don't actually care about it. |
---|
114 | |
---|
115 | A standard printcap entry looks like this: |
---|
116 | |
---|
117 | printername |
---|
118 | :server |
---|
119 | :cm=Human Readable Printer Name |
---|
120 | :lp=/dev/null |
---|
121 | :if=|/path/to/sipbmp3-filter |
---|
122 | :sd=/var/spool/lpd/printername |
---|
123 | :ml=0:mx=0:sh:sf |
---|
124 | :auth_forward=kerberos5 |
---|
125 | :use_auth=kerberos5 |
---|
126 | :create_files |
---|
127 | |
---|
128 | printcap is located in /etc/printcap, but you can also edit the symlink |
---|
129 | in /etc/lprng/printcap. |
---|
130 | |
---|
131 | To check your modifications, and create the necessary files and folders, |
---|
132 | you should run: |
---|
133 | |
---|
134 | checkpc -V -f |
---|
135 | |
---|
136 | (As root, of course). You might get a failure on a directory |
---|
137 | /var/spool/lpd/%P doesn't exist; simply mkdir it and run checkpc -V -f |
---|
138 | again. |
---|
139 | |
---|
140 | With recent versions of lprng, you will also need to make lpd less paranoid |
---|
141 | about accepting connections. This usually means the following two changes: |
---|
142 | |
---|
143 | In /etc/lprng/lpd.perms: |
---|
144 | |
---|
145 | REJECT NOT SERVER |
---|
146 | |
---|
147 | should be commented out, as: |
---|
148 | |
---|
149 | #REJECT NOT SERVER |
---|
150 | |
---|
151 | And, in /etc/lprng/lpd.conf: |
---|
152 | |
---|
153 | printcap_path=... |
---|
154 | |
---|
155 | add /etc/lprng/printcap to the beginning of the pathlist, so it looks like: |
---|
156 | |
---|
157 | printcap_path=/etc/lprng/printcap:|/usr/lib/get_hesiod_pcap |
---|
158 | |
---|
159 | /etc/printcap will also work, assuming lprng doesn't do something funky |
---|
160 | in the future. |
---|
161 | |
---|
162 | You will also need to add this line: |
---|
163 | |
---|
164 | lpd_listen_port=515 |
---|
165 | |
---|
166 | XXX: I don't think this configuration handles users wanting to lprm their |
---|
167 | own items correctly yet. |
---|
168 | |
---|
169 | |
---|
170 | 7. Test, round one |
---|
171 | |
---|
172 | The first test you should do to make sure sipbmp3 is configured properly is |
---|
173 | to attempt to play an mp3 file locally, via lpr. The command you should use |
---|
174 | is: |
---|
175 | |
---|
176 | mit-lpr -Pprintername@localhost filename.mp3 |
---|
177 | |
---|
178 | Note the "mit-" prefix; Debathena defaults to CUPS, which we have not set |
---|
179 | up yet. |
---|
180 | |
---|
181 | See below for troubleshooting tips. |
---|
182 | |
---|
183 | |
---|
184 | 8. Test, round two |
---|
185 | |
---|
186 | The second test you should do is try playing an MP3 remotely. The appropriate |
---|
187 | command is: |
---|
188 | |
---|
189 | mit-lpr -Pprintername@hostname filename.mp3 |
---|
190 | |
---|
191 | (Once again, with "mit-"). See below for troubleshooting tips. |
---|
192 | |
---|
193 | |
---|
194 | 9. Troubleshooting |
---|
195 | |
---|
196 | So, it didn't work. How did it fail? |
---|
197 | |
---|
198 | ---- |
---|
199 | sending job 'ezyang@vivace+800' to asdfasdf@localhost |
---|
200 | connecting to 'localhost', attempt 1 |
---|
201 | cannot open connection to localhost - No such file or directory |
---|
202 | ---- |
---|
203 | |
---|
204 | This means that lpd is not accepting connections properly. Check to see |
---|
205 | if you configured lpd.perms and lpd.conf correctly. Try rebooting lpd |
---|
206 | by pkill lpd && lpd. Use nmap to check of port 515 is open, both on the |
---|
207 | local machine and on a remote machine. Check if networking is working |
---|
208 | on the server. Use netstat to see what programs are listening to port |
---|
209 | 515, and from which hosts. Check iptables. |
---|
210 | |
---|
211 | ---- |
---|
212 | lpr: The printer or class was not found. |
---|
213 | ---- |
---|
214 | |
---|
215 | You're using lpr, not mit-lpr. |
---|
216 | |
---|
217 | ---- |
---|
218 | (no output, but no sound) |
---|
219 | ---- |
---|
220 | |
---|
221 | It looks like you managed to send the file over. To diagnose the problems |
---|
222 | further: |
---|
223 | |
---|
224 | * Check the zephyr logs of the class sipbmp3 was configured to |
---|
225 | send messages to: |
---|
226 | |
---|
227 | - If you see a reasonably full and formatted message, that means |
---|
228 | that either: 1. your volume is turned off, or 2. mplayer is |
---|
229 | horribly broken (XXX: it probably isn't, but I don't know what |
---|
230 | error message it gives in that case) |
---|
231 | |
---|
232 | By the way, be sure to check both the *hardware* and the |
---|
233 | *software* volume. |
---|
234 | |
---|
235 | - If you see a blank zephyr, that means that sipbmp3-filter died |
---|
236 | trying to get a handle to /var/run/sipbmp3/status and failing. |
---|
237 | Check if you created the file correctly, and that daemon has |
---|
238 | permissions to write to it. If you rebooted recently, check if |
---|
239 | you have the appropriate init.d script setup. |
---|
240 | |
---|
241 | * Otherwise, check /var/spool/lpd/printername/status.pr (most of all the |
---|
242 | other files are useless, especially including log): |
---|
243 | |
---|
244 | - If you see a Perl error, fix it. The most common cause is because |
---|
245 | exiftools is not installed. |
---|
246 | |
---|
247 | * Otherwise, double check the userland code in sipbmp3-filter. XXX: There |
---|
248 | are some edge-cases that don't give nice error messages, for example |
---|
249 | the failed write to /var/run/sipbmp3/status |
---|
250 | |
---|
251 | |
---|
252 | 10. Deploying CUPS |
---|
253 | ------------------ |
---|
254 | |
---|
255 | The final step is to give your newfangled printer a cups.mit.edu record. |
---|
256 | In order to do this, you will need to ask IS&T for a Moira pcap entry |
---|
257 | request. Send mail to hesreq@mit.edu, specifying that you are setting |
---|
258 | up a sipbmp3 clone, that you want a Moira pcap entry, the printer name |
---|
259 | and server name of your queue, and that you want hwtype=LOCAL. It wouldn't |
---|
260 | hurt to also tell them where your print queue is, and a contact list. |
---|
261 | |
---|
262 | Once you get the pcap entry, ping sipb-cups@mit.edu to add your machine |
---|
263 | to the public list. |
---|
264 | |
---|
265 | |
---|
266 | X. Setting up remctl commands |
---|
267 | ----------------------------- |
---|
268 | |
---|
269 | It's useful to be able to control the volume. Remctl is the way to do |
---|
270 | this without asking people to ssh in, and then alsamix(er). XXX: These |
---|
271 | batch scripts and remctl files are not yet public. |
---|
272 | |
---|
273 | |
---|
274 | X. Deploying sipbmp3web |
---|
275 | ------------------------ |
---|
276 | |
---|
277 | sipbmp3 web provides a nice and user-friendly interface for some common |
---|
278 | tasks. XXX: It is currently not portable beyond zsr. Stay tuned! |
---|
279 | |
---|