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