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