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