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