chiark / gitweb /
Merge new Disobedience manual
[disorder] / CHANGES.html
CommitLineData
b0a578cb
RK
1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2<html>
3<head>
4<title>DisOrder Change History</title>
5<style type="text/css">
6body {
7 color: black;
8 background-color: white;
9 font-family: times,serif;
10 font-weight: normal;
11 font-size: 12pt;
12 font-variant: normal
13}
14
15div.section {
16 margin-left:1em
17}
18
19h1 {
20 background-color: #e0ffe0;
21 font-family: helvetica,sans-serif;
22 padding: 0.2em
23}
24
25h2 {
26 background-color: #e0ffe0;
27 font-family: helvetica,sans-serif;
28 padding: 0.2em
29}
30
31h3 {
32 background-color: #f0f0f0;
33 font-family: helvetica,sans-serif;
34 padding: 0.2em
35}
36
37h4 {
38 font-family: helvetica,sans-serif
39}
40
41table.bugs {
42 width: 100%
43}
44
45table.bugs th {
46 text-align: left
47}
48
49span.command {
50 font-family: monospace
51}
52</style>
53</head>
54
55<body>
56<h1>DisOrder Change History</h1>
57
d8b95785
RK
58<p>This file documents recent user-visible changes to <a
59 href="http://www.greenend.org.uk/rjk/disorder/">DisOrder</a>.</p>
60
f5fd9a6b
RK
61<h2>Changes up to version 4.4</h2>
62
63 <div class=section>
64
f207f710
RK
65 <h3>Server</h3>
66
f5fd9a6b
RK
67 <div class=section>
68
fe33cfc0 69 <p>The <tt>device</tt> configuration option now works under OS X.
7cd4dd21 70 Devices may
f207f710 71 be specified either by UID or name. Fixes <a
f5fd9a6b
RK
72 href="http://code.google.com/p/disorder/issues/detail?id=27">Issue
73 27</a>.</p>
f207f710 74
f71fc3ab 75 <p>Gapless play should be more reliable, and playback latency over RTP
6762ac8a 76 should be a bit lower. Note though that all the sound output code has
f71fc3ab
RK
77 been reorganized and in some cases completely rewritten, so it's possible
78 that bugs may have been (re-)introduced.</p>
7cd4dd21
RK
79
80 <p>The <tt>command</tt> backend now (optionally) sends silence instead
81 of suspending writes when a pause occurs or no track is playing.</p>
c3feb35b
RK
82
83 <p>If <a href="http://www.mega-nerd.com/SRC/">libsamplerate</a> is
84 available at build time then that will be used instead of invoking
317dc3e8
RK
85 <a href="http://sox.sourceforge.net/">SoX</a>. SoX support will be
86 removed in a future version.</p>
c3feb35b 87
79ab6bd2
RK
88 <p>Playlists are now supported. These allow a collection of tracks to be
89 prepared offline and played as a unit.</p>
90
7cd4dd21
RK
91 </div>
92
6a7eb118
RK
93 <h3>Disobedience</h3>
94
95 <div class=section>
96
69c456f3
RK
97 <p>Multiple tracks can now be dragged in the queue in a single operation.
98 Furthermore, it is now possible to drag tracks from the
99 &ldquo;Recent&rdquo;, &ldquo;Added&rdquo; and &ldquo;Choose&rdquo; tabs
100 to the queue.</p>
6a7eb118 101
79ab6bd2
RK
102 <p>Disobedience now supports playlist editing.</p>
103
6a7eb118
RK
104 </div>
105
7cd4dd21
RK
106 <h3>Web Interface</h3>
107
108 <div class=section>
53710d44 109
7cd4dd21
RK
110 <p>Confirmation URLs should be cleaner (and in particular not end
111 with punctuation). (Please see <a
112 href="README.upgrades">README.upgrades</a> for more about this.)</p>
113
f207f710
RK
114 </div>
115
116 <h3>RTP Player</h3>
117
118 <div class=section>
119
120 <p>There is a new <tt>--command</tt> option which allows the RTP player
121 to send audio data to a user-chosen command instead of an audio API. See
122 the man page for details.</p>
123
124 <p>The <tt>--device</tt> option to <tt>disorder-playrtp</tt> now works
125 under OS X (as above).</p>
f5fd9a6b
RK
126
127 </div>
7cd4dd21
RK
128
129 <h3>General</h3>
f5fd9a6b 130
7cd4dd21
RK
131 <div class=section>
132
133 <p>IPv6 should now work. Network address specifications
134 (<tt>listen</tt>, <tt>connect</tt> etc) can now be prefixed with
135 <tt>-4</tt> or <tt>-6</tt> to force use
136 of IPv4 or IPv6, though normally this should not be needed.</p>
137
2cb9bc5f
RK
138 <p>Unicode support has been upgraded to <a
139 href="http://www.unicode.org/versions/Unicode5.1.0/">Unicode
140 5.1.0</a>.</p>
141
7cd4dd21
RK
142 <p>Various elements of the source code have been
143 rationalized.</p>
144
145 </div>
146
f5fd9a6b
RK
147 <h3>Bugs fixed</h3>
148
149 <div class=section>
150
151 <table class=bugs>
152 <tr>
153 <th>ID</th>
154 <th>Description</th>
155 </tr>
156
157 <tr>
158 <td><a href="http://code.google.com/p/disorder/issues/detail?id=27">#27</a></td>
159 <td>Mac DisOrder uses wrong sound device</td>
160 </tr>
161
7cd4dd21
RK
162 <tr>
163 <td><a href="http://code.google.com/p/disorder/issues/detail?id=33">#33</a></d>
164 <td>(Some) plugins need -lm.</td>
165 </tr>
6762ac8a
RK
166
167 <tr>
168 <td><a href="http://code.google.com/p/disorder/issues/detail?id=39">#39</a></d>
169 <td>Double bind() non-multicast AF_INET</td>
170 </tr>
171
172 <tr>
173 <td><a href="http://code.google.com/p/disorder/issues/detail?id=40">#40</a></d>
174 <td>Missing stub function</td>
175 </tr>
176
177 <tr>
178 <td><a href="http://code.google.com/p/disorder/issues/detail?id=41">#41</a></d>
179 <td>Missing includes for timeval</td>
180 </tr>
181
182 <tr>
183 <td><a href="http://code.google.com/p/disorder/issues/detail?id=42">#42</a></d>
184 <td>syntax error in empeg_host section</td>
185 </tr>
186
187 <tr>
93379b3d
RK
188 <td><a href="http://code.google.com/p/disorder/issues/detail?id=43">#43</a></d>
189 <td>decoder segfault with FLAC 1.2.1</td>
190 </tr>
191
192 <tr>
6762ac8a
RK
193 <td><a href="http://code.google.com/p/disorder/issues/detail?id=44">#44</a></d>
194 <td>gcc 4.3.2-1ubuntu12 SUYB patch</td>
195 </tr>
196
197 <tr>
198 <td><a href="http://code.google.com/p/disorder/issues/detail?id=45">#45</a></d>
199 <td>disobedience doesn't configure its back end</td>
200 </tr>
fa667301
RK
201
202 <tr>
203 <td><a href="http://code.google.com/p/disorder/issues/detail?id=48">#48</a></d>
204 <td>build-time dependency on <tt>oggdec</tt> removed</td>
205 </tr>
206
7cd4dd21 207
f5fd9a6b
RK
208 </table>
209
210 </div>
211 </div>
212
a0e78d96 213<h2>Changes up to version 4.3</h2>
d8b95785
RK
214
215 <div class=section>
216
217 <h3>Disobedience</h3>
218
219 <div class=section>
220
221 <p>A bug was fixed in the calculation of how much of the track had
e02f9807
RK
222 played. This would lead to the counter showing incorrect values in
223 various situations.</p>
d8b95785
RK
224
225 <p>Disobedience's icons have been changed to larger, more colorful
226 ones. The SVG source is included if you want to fiddle with them.</p>
227
a0e78d96
RK
228 <p>&ldquo;Select all&rdquo; is now no longer available in the choose
229 tab. Instead there is a new &ldquo;Select children&rdquo; option which
230 selects the file children of a single subdirectory.</p>
231
d8b95785
RK
232 </div>
233
6151ae7e
RK
234 <h3>Server</h3>
235
236 <div class=section>
237
238 <p>The selection bias for newly added tracks was reduced by half. You
239 can put it back to the old very neophilic value with
240 &ldquo;<tt>new_bias 900000</tt>&rdquo; in the config file.</p>
241
ff45af7c
RK
242 <p>It is now possible to &lsquo;adopt&rsquo; randomly picked tracks.
243 Disobedience and the command-line client support this but the web
244 interface does not.</p>
245
e02f9807
RK
246 <p>The default track name parsing was modified to handle filenames
247 generated by iTunes.</p>
248
6151ae7e
RK
249 </div>
250
10a6c925 251 <h3>Miscellaneous</h3>
d8b95785
RK
252
253 <div class=section>
254
10a6c925
RK
255 <p><tt>disorderfm</tt> now preserves directory permissions.</p>
256
e7eb3a27
RK
257 <p>DisOrder is now licensed under <a
258 href="http://www.gnu.org/licenses/gpl-3.0.html">GPL v3</a>. The main
259 goal is to prohibit <a
260 href="http://en.wikipedia.org/wiki/Tivoization">Tivoization</a>.</p>
261
d8b95785 262 <p>The build system will now automatically cope with Fink's broken GTK+
e02f9807
RK
263 packages. There are a number of improvements to the Debian
264 packaging.</p>
d8b95785 265
74cfbeaa
RK
266 <p>DisOrder now builds on 64-bit Linux systems.</p>
267
e02f9807 268 <p>There are various minor fixes.</p>
d8b95785
RK
269
270 </div>
271
e02f9807
RK
272 <h3>Bugs fixed</h3>
273
274 <div class=section>
275
276 <table class=bugs>
277 <tr>
278 <th>ID</th>
279 <th>Description</th>
280 </tr>
281
282 <tr>
283 <td><a href="http://code.google.com/p/disorder/issues/detail?id=24">#24</a></td>
284 <td>Fails to build on ubuntu 8.10</td>
285 </tr>
286 <tr>
287 <td><a href="http://code.google.com/p/disorder/issues/detail?id=26">#26</a></td>
288 <td>Disobedience shows wrong track elapsed time after a pause</td>
289 </tr>
290 </table>
291
292 </div>
d8b95785 293 </div>
b0a578cb 294
eb2a1fe9
RK
295<h2>Changes up to version 4.2</h2>
296
297<div class=section>
298
299 <h3>Disobedience</h3>
300
301 <div class=section>
302
303 <p>The login window now has a 'remote' switch. If this is turned off
304 then Disobedience will connect to a local server. Formerly it would
305 always use TCP/IP.</p>
306
307 <p>The Delete and backspace keys will now remove tracks from the queue.
308 Escape will now dismiss the properties, users or login windows and return
309 now works in the login and properties windows.</p>
310
311 </div>
312
313 <h3>Documentation</h3>
314
315 <div class=section>
316
317 <p>Track and global preferences are now described in a new
318 <b>disorder_preferences</b>(5) man page.</p>
319
320 </div>
cc5b0a8e
RK
321
322 <h3>Bugs fixed</h3>
323
324 <div class=section>
325
326 <table class=bugs>
327 <tr>
328 <th>ID</th>
329 <th>Description</th>
330 </tr>
331
332 <tr>
333 <td><a href="http://code.google.com/p/disorder/issues/detail?id=21">#21</a></td>
334 <td>CGI should use PATH_INFO more sensibly</td>
335 </tr>
336 </table>
337
338 </div>
eb2a1fe9
RK
339</div>
340
341
68210888
RK
342<h2>Changes up to version 4.1.1</h2>
343
344<div class=section>
345
346 <p>Disobedience's &ldquo;Login&rdquo; window now works when you are logged
347 in.</p>
348
349</div>
350
452ad6ba
RK
351<h2>Changes up to version 4.1</h2>
352
353<div class=section>
354
355 <h3>Disobedience</h3>
356
357 <div class=section>
358
359 <p>Disobedience has been largely rewritten:</p>
360
361 <ul>
362
363 <li>All the tabs now use native GTK+ list/tree widgets, resulting in
364 greater speed in some cases and more consistency with other GTK+
365 applications.</li>
366
367 <li>You can now use type-ahead find in the choose tab. The initiation
368 of a search is delayed slightly to avoid lots of updates when you're
369 half way through entering search terms.</li>
370
371 <li>The choose tab now shows track lengths.</li>
372
373 <li>Many buttons are now more reliably made insensitive when they can't
374 be used.</li>
30f2f8c9
RK
375
376 <li>You can now play tracks off the recent tab.</li>
377
452ad6ba
RK
378 </ul>
379
380 <p>Disobedience attempts to cope with servers from older versions, up to
381 a point, but this is not well tested and it's best to keep the server
382 fully up to date.</p>
383
384 </div>
385
386 <h3>Server</h3>
387
388 <div class=section>
389
390 <p>When a track shares a directory with its alias, the real track name is
391 now returned instead of the alias (the opposite way round to the previous
392 behaviour).</p>
393
394 </div>
395</div>
396
32918782
RK
397<h2>Changes up to version 4.0.2</h2>
398
399<div class=section>
400
401 <p>Corrected web browser linked from Disobedience.</p>
402
403</div>
404
f03d4184
RK
405<h2>Changes up to version 4.0.1</h2>
406
407<div class=section>
408
409 <p>Libtool and Automake now install the CGI correctly. As part of this,
410 <tt>cgidir</tt> has been renamed to <tt>cgiexecdir</tt>. The configure
411 script will report an error if you try to use the old name.</p>
412
413</div>
414
0ba75c7f 415<h2>Changes up to version 4.0</h2>
b0a578cb
RK
416
417<div class=section>
418
419 <h3>Server</h3>
420
421<div class=section>
422
423 <p>The <tt>gap</tt> directive will no longer work. It could be
424 restored if there is real demand.</p>
425
426 <h4>Event Scheduling</h4>
427
428<div class=section>
429
430 <p>It is now possible to schedule events to occur in the future.
431 Currently the supported actions are playing a specific track, and
432 changing a global preference (thus allowing e.g. random play to be
433 turned on or off). See the <tt>schedule-*</tt>
434 commands described in disorder(1).</p>
435
436</div>
437
438<h4>Random Track Choice</h4>
439
440<div class=section>
441
442 <p>This has been completely rewritten to support new features:</p>
443
444 <ul>
445
446 <li>tracks in the recently-played list or in the queue are no longer
447 eligible for random choice.</li>
448
449 <li>there is a new <tt>weight</tt> track preference allowing for
450 non-uniform track selection. See disorder(1) for details.</li>
451
452 <li>there is a new configuration item <tt>replay_min</tt> defining
453 the minimum time before a played track can be picked at random.
454 The default is 8 hours (which matches the earlier behaviour).</li>
455
456 <li>recently added tracks are biased up; see <tt>new_bias</tt> and
457 <tt>new_bias_age</tt> in disorder_config(5).</li>
458
459 </ul>
460
461</div>
462
463<h4>Web Interface</h4>
464
465<div class=section>
466
467 <p>This has been largely rewritten. The most immediate benefits are:</p>
468
469 <ul>
470
471 <li>the search page is integrated into the choose page, and
472 includes links to parent directories.</li>
473
474 <li>if you try to do something you have insufficient rights for,
475 instead of getting an error page or nothing happening, you are
476 redirected to the login page.</li>
477
478 </ul>
479
480 <p>Customizers should find their lives easier: the syntax is less onerous, it
481 is possible to define macros to avoid repetition, and the documentation is
482 less monolithic (see disorder.cgi(8) as a starting point).</p>
483
2eee4b0c
RK
484 <p>Mail is now sent via the system sendmail program, though it remains
485 possible to use TCP to connect to an SMTP server. See <tt>sendmail</tt> and
486 <tt>smtp_server</tt> in disorder_config(5).</p>
4cbafe13 487
64ac73bb
RK
488 <p>The web interface is now installed automatically. If you don't want it,
489 use <tt>./configure --without-cgi</tt>. If you want it in a non-default
490 location, or no location for it is detected, set <tt>cgidir</tt>
491 and <tt>httpdir</tt> on the <tt>./configure</tt> command line.</p>
2eee4b0c 492
b0a578cb
RK
493</div>
494
495</div>
496
497<h3>Disobedience</h3>
498
499<div class=section>
500
501 <p>There is now a new user management window. From here you can add and
502 remove users or modify their settings.</p>
503
504 <p>Relatedly, the server will only allow remote user management if you set
505 <tt>remote_userman</tt> to <tt>yes</tt>.</p>
506
507</div>
508
509<h3>Miscellaneous</h3>
510
511<div class=section>
512
513 <p><tt>scripts/setup</tt> now honors command line options, and can
514 set up network play as well as the local default sound device.</p>
515
516</div>
517
518<h3>Bugs Fixed</h3>
519
520<div class=section>
521
522 <table class=bugs>
523 <tr>
524 <th>ID</th>
525 <th>Description</th>
526 </tr>
527
528 <tr>
529 <td><a href="http://code.google.com/p/disorder/issues/detail?id=2">#2</a></td>
530 <td>Search results should link to directories</td>
531 </tr>
532
533 <tr>
534 <td><a href="http://code.google.com/p/disorder/issues/detail?id=6">#6</a></td>
535 <td>Schedule tracks for a particular time</td>
536 </tr>
537
538 <tr>
539 <td><a href="http://code.google.com/p/disorder/issues/detail?id=10">#10</a></td>
540 <td>Non-uniform track selection</td>
541 </tr>
542
543 <tr>
544 <td><a href="http://code.google.com/p/disorder/issues/detail?id=11">#11</a></td>
545 <td>Bias random selection to newly added tracks</td>
546 </tr>
547
548 <tr>
549 <td><a href="http://code.google.com/p/disorder/issues/detail?id=13">#13</a></td>
550 <td>Default encoding for debian setup scripts</td>
551 </tr>
552
553 <tr>
554 <td><a href="http://code.google.com/p/disorder/issues/detail?id=16">#16</a></td>
555 <td>Cookie expiry causes user to be silently logged out and not
556 subsequently redirected to login page</td>
557 </tr>
558
559 <tr>
560 <td><a href="http://code.google.com/p/disorder/issues/detail?id=20">#20</a></td>
561 <td>Broken aliasing rules</td>
562 </tr>
563
564 </table>
565
566</div>
567
568</div>
569
570<h2>Changes up to version 3.0.2</h2>
571
572<div class=section>
573
574 <p>Builds <tt>--without-server</tt> should work again.</p>
575
576 <p>The web interface is a bit more liberal in the cookie value
577 syntax it will accept.</p>
578
579 <p>Clients fail more gracefully if no password is available.</p>
580
581</div>
582
583<h2>Changes up to version 3.0.1</h2>
584
585<div class=section>
586
587 <p>Debian upgrades from 2.0.x should now work better.</p>
588
589</div>
590
591<h2>Changes up to version 3.0</h2>
592
593<div class=section>
594
595 <p><b>Important</b>! See <a
596 href="README.upgrades">README.upgrades</a> when upgrading.</p>
597
598 <h3>Platforms And Installation</h3>
599
600<div class=section>
601
602 <p>Mac OS X and FreeBSD are somewhat supported. There is now a bash
603 script in <tt>scripts/setup</tt> which will automate the setup after
604 <tt>make install</tt>.</p>
605
606</div>
607
608<h3>Server</h3>
609
610<div class=section>
611
612 <p>Users are now stored in the database rather than a configuration
613 file.</p>
614
615 <p>The server now has a built-in list of stopwords and players, so
616 only additions to these need be mentioned in the configuration file.</p>
617
618 <p>The default inter-track gap is now 0s.</p>
619
620 <p>How sound is played is now controlled via the new <tt>api</tt>
621 configuration command. This also controls how the volume is set,
622 which now works with ALSA as well as OSS.</p>
623
624 <p>A bug in the MP3 decoder was fixed (also in 2.0.4).</p>
625
626</div>
627
628<h3>Web Interface</h3>
629
630<div class=section>
631
632 <p>The web interface now uses cookies to remember user identity, and
633 allows online registration of new users. Also it is no longer
634 necessary to manually specify the URL of the web interface (but you
635 can override it if you don't like the value it figures out).</p>
636
637 <p>It is possible to allow users to register via the web interface.</p>
638
639 <p>The web interface's browser support has been improved. It has
640 been tested with Firefox 2, Safari 3, Konqueror 3, Internet Explorer
641 7 and Opera 9.</p>
642
643</div>
644
645<h3>Disobedience</h3>
646
647<div class=section>
648
649 <p>A bug which would cause a crash if you attempt to rearrange the
650 queue while no track was playing has been fixed. There is a new
651 'deselect all tracks' option, mirroring 'select all tracks.</p>
652
653</div>
654
655</div>
656
657<!--
658Local Variables:
659fill-column:79
4cbafe13 660indent-tabs-mode:nil
b0a578cb
RK
661End:
662-->