chiark / gitweb /
Shadow disorder.dev
[disorder] / CHANGES
1 * Changes up to version 3.1
2
3 ** Server
4
5 The 'gap' directive will no longer work.  It could be restored if there
6 is real demand.
7
8 *** Random Track Choice
9
10 This has been completely rewritten to support new features:
11    - tracks in the recently-played list or in the queue are no longer
12      eligible for random choice
13    - there is a new 'weight' track preference allowing for non-uniform
14      track selection.  See disorder(1) for details.
15    - there is a new configuration item replay_min defining the minimum
16      time before a played track can be picked at random.  The default is
17      8 hours (which matches the earlier behaviour).
18    - recently added tracks are biased up; see new_bias and new_bias_age
19      in disorder_config(5).
20
21 *** Web Interface
22
23 This has been largely rewritten.  The most immediate benefits are:
24    - the search page is integrated into the choose page, and includes
25      links to parent directories
26    - if you try to do something you have insufficient rights for,
27      instead of getting an error page or nothing happening, you are
28      redirected to the login page
29
30 Customizers should find their lives easier: the syntax is less onerous,
31 it is possible to define macros to avoid repetition, and the
32 documentation is less monolithic.
33
34 ** Disobedience
35
36 There is now a new user management window.  From here you can add and
37 remove users or modify their settings.
38
39 Relatedly, the server will only allow remote user management if you set
40 remote_userman to 'yes'.
41
42 ** Miscellaneous
43
44 scripts/setup now honors command line options, and can set up network
45 play as well as the local default sound device.
46
47 ** Bugs Fixed
48
49  #2 Search results should link to directories
50 #10 Non-uniform track selection
51 #11 Bias random selection to newly added tracks
52 #16 Cookie expiry causes user to be silently logged out and not
53     subsequently redirected to login page
54 #20 Broken aliasing rules
55
56 * Changes up to version 3.0.2
57
58 Builds --without-server should work again.
59
60 The web interface is a bit more liberal in the cookie value syntax it
61 will accept.
62
63 Clients fail more gracefully if no password is available.
64
65 * Changes up to version 3.0.1
66
67 Debian upgrades from 2.0.x should now work better.
68
69 * Changes up to version 3.0
70
71 Important!  See README.upgrades when upgrading.
72
73 ** Platforms And Installation
74
75 Mac OS X and FreeBSD are somewhat supported.  There is now a bash script
76 in scripts/setup which will automate the setup after 'make install'.
77
78 ** Server
79
80 Users are now stored in the database rather than a configuration file.
81
82 The server now has a built-in list of stopwords and players, so only
83 additions to these need be mentioned in the configuration file.
84
85 The default inter-track gap is now 0s.
86
87 How sound is played is now controlled via the new 'api' configuration
88 command.  This also controls how the volume is set, which now works with
89 ALSA as well as OSS.
90
91 A bug in the MP3 decoder was fixed (also in 2.0.4).
92
93 ** Web Interface
94
95 The web interface now uses cookies to remember user identity, and allows
96 online registration of new users.  Also it is no longer necessary to
97 manually specify the URL of the web interface (but you can override it
98 if you don't like the value it figures out).
99
100 It is possible to allow users to register via the web interface.
101
102 The web interface's browser support has been improved.  It has been
103 tested with Firefox 2, Safari 3, Konqueror 3, Internet Explorer 7 and
104 Opera 9.
105
106 ** Disobedience
107
108 A bug which would cause a crash if you attempt to rearrange the queue
109 while no track was playing has been fixed.  There is a new 'deselect all
110 tracks' option, mirroring 'select all tracks.
111
112 * Changes up to version 2.0
113
114 ** General
115
116 Tracks can now have tags associated with them.  See tags in disorder(1)
117 or the preferences documentation for the web interface or Disobedience.
118
119 The search facility knows how to limit results by tag (see search
120 documentation for any interface) as well as by word search.  It is
121 possible to limit random play by tag (see required-tags and
122 prohibited-tags in disorder_config(5)).
123
124 Unicode support is improved.  Case-folding and word breaking now follows
125 the rules given in the Unicode standard (with a bit of tailoring in the
126 latter case).
127
128 ** Disobedience
129
130 There is a new client, 'Disobedience', that depends on the GTK+ library.
131 Feedback on the interface would be very welcome.
132
133 ** Web Interface
134
135 The "New" screen display tracks recently added to the database.  From
136 here they can be played or their preferences changed.
137
138 Long track names are truncated so they fit better on the screen.  Hover
139 for the full name.
140
141 ** Network Play
142
143 DisOrder can broadcast audio over a network, allowing it to be played on
144 multiple client machines.  See README.streams for details.
145
146 ** Server
147
148 Slow file lookups are cached in the server.  This should help
149 installations with large collections and/or slow platforms.
150
151 The 'enabled' and 'random_enabled' configuration options are now gone.
152 Instead the state survives from one run of the server to the next.
153 'disable now' is gone as well - if you want to emulate it disable
154 playing and then scratch the current track.
155
156 The 'pick' plugin has been abolished.  All the logic formerly done there
157 is now built into the server, where it can be done much more
158 efficiently.
159
160 'tracklength' plugins must be explicitly specified.
161
162 A bug where removing a collection (from the configuration) could cause a
163 crash when random play was enabled has been fixed.
164
165 A new configuration option 'queue_pad' allows the number of random
166 tracks kept on the queue to be controlled.
167
168 There is a new utility disorder-decode which can decode OGG, MP3, WAV
169 and FLAC.  The example config file uses it.
170
171 Database statistics are computed in a subprocess so that the main server
172 (and all clients) are not blocked for the duration.
173
174 ** disorderfm
175
176 There is a new command line tool called 'disorderfm' which is designed
177 for filename translation on (for instance) digital audio repositories.
178 It is not yet feature-complete.  See its man page for additional
179 details.
180
181 ** Build And Configuration
182
183 You can control which components are built with new --with options.  See
184 README.
185
186 options.transform and the 'transform' web option have gone, replaced
187 with a 'transform' configuration command.  Both this and 'namepart' are
188 now optional.
189
190 ** Thanks
191
192 Ross Younger, Colin Watson, Michael Stevens and Mark Wooding all
193 contributed in some way to this release.
194
195 * Changes up to version 1.5.1
196
197 ** Web Interface
198
199 Correct regexp for non-alpha tracks.
200
201 * Changes up to version 1.5
202
203 ** Web Interface
204
205 Regexp-based filtering of tracks (for instance as used by the initial
206 'Choose' page) now does the regexp matching in the server, limiting the
207 amount of data transferred to the web interface only to be discarded.
208
209 ** Client
210
211 Regexp-base filtering of tracks is now available to the command line
212 client.
213
214 ** Server
215
216 New server_nice, speaker_nice and rescan_nice configuration options
217 allow independent control of process priorities.
218
219 Scratches are now attributed to the user who requested them.
220
221 Bugs fixed:
222   A file descriptor was leaked for each track played.
223   The amount of a track played so far was not reported.
224   The speaker process could crash on underrun.
225   The server would crash if you paused a non-pause capable track.
226   Regexp matching in the file and directory list commands was not
227   reliable.
228   Handling of variable-argument commands in the client was broken.
229
230 * Changes up to version 1.4
231
232 ** General
233
234 Raw format players are now supported.  See README.upgrades and
235 README.raw for details.  This allows pausing and eliminating the
236 inter-track gap.
237
238 Pausing is also supported with suitably modified standalone player
239 plugins, though none of the supplied ones are capable of this.
240
241 When random play is enabled the randomly picked track now appears in the
242 queue, and can be moved around the queue, removed from it, etc.
243
244 ** Web Interface
245
246 Switches (random play, pause, ...) are now presented as a
247 fixed-appearance switch with an adjacent state indicator.
248
249 The 'Manage' screen has new buttons to move tracks to the head or tail
250 of the queue.
251
252 You can now edit the preferences for all the tracks in an album in a
253 single screen, rather than having to visit each separately.  For the
254 time being the raw preferences editing has gone; it can be reintroduced
255 on some form if there is demand.  (You can still edit raw preferences
256 from the command line.)
257
258 Labels are now documented in options.labels rather than
259 disorder_config(5).
260
261 ** Server
262
263 If you tried to start up on any empty database with random play enabled
264 the server would exit with an error.
265
266 The server no longer risks failing if you strace its player
267 subprocesses.
268
269 It was possible for the server to hang when a 'reconfigure' command was
270 issued.  This should no longer be the case.
271
272 The default signal to forcibly terminate players is now SIGKILL.
273
274 ** Plugins
275
276 Plugins must now declare a type word.  This allows them to document
277 whether they are a standalone player or a raw-format player, and whether
278 they support pausing.  They can also arrange to get setup and cleanup
279 calls in the main server.  See disorder(3) for more details.
280
281 * Changes up to version 1.3
282
283 ** Dependencies
284
285 Berkeley DB 4.2 is no longer supported.  Use 4.3.
286
287 ** Client
288
289 There is a new 'authorize' command to simplify the addition of local
290 users.  Please report successes as well as failures.
291
292 There is a new 'resolve' command to return the real track name behind an
293 alias.
294
295 The 'rescan' command no longer takes an argument.
296
297 ** Server
298
299 The track database code has been largely rewritten to improve
300 maintainability.
301
302 There is a new 'lock' directive.  By default the server uses a lockfile
303 to prevent multiple copies of itself running simultaneously; this can be
304 inhibited e.g. if you are using a filesystem that does not support
305 locking and are confident you can prevent concurrent running yourself.
306
307 Aliases for track names, constructed from trackname_display_
308 preferences, now appear in the virtual filesystem.  
309
310 The server now executes a subprocess for the rescan operation.  It also
311 runs a separate deadlock manager.
312
313 Standard output and standard error from subprocesses are now logged.
314 This is handy if you need to figure out why a player failed unexpectedly
315 but might lead to huge log files if you have needlessly verbose players.
316
317 ** Web Interface
318
319 Enable/disable buttons are now colored to reflect current state.
320
321 Entering numeric volume values (rather than clicking on the arrows) now
322 works.
323
324 Connection errors are reported more gracefully.
325
326 ** Plugins
327
328 Scanner plugins are now always invoked in a subprocess.
329
330 disorder_track_count() and disorder_track_getn() are no longer
331 available.  Instead use disorder_track_random().
332
333 Plugins are now opened with RTLD_NOW, so link errors are detected
334 immediately.
335
336 ** Tools
337
338 disorder-dump now insists on the input/output file being a named regular
339 file, rather than using stdin or stdout.
340
341 ** Other
342
343 Some missing files have been added, and some notes added regarding
344 getting text encoding right.
345
346 * Changes up to version 1.2
347
348 See README.upgrades when upgrading to this version.
349
350 ** Bugs Fixed
351
352 Avoid accumulating overlarge recently played list.
353
354 When the server was stopped, the currently playing track would not be
355 added to the recently played list.  This has been fixed.
356
357 Reloading the 'volume' page no longer repeats the last volume-changing
358 action.
359
360 The search facility now works properly for multiple hits within a single
361 artist or album.
362
363 ** Server
364
365 New namepart directive replaces web interface's trackname-part.  There
366 are associated changes to the protocol and clients.
367
368 The number of database queries per candidate match required when
369 searching has been reduced.
370
371 The operator can control the signal used to scratch playing tracks.  The
372 default has been changed to SIGINT from SIGKILL.
373
374 The 'log' command now provides a formalised event log, rather than raw
375 access to the server's ordinary log output.
376
377 ** Web Interface Changes
378
379 *** Choosing Tracks
380
381 When picking a track the client now stays on the same screen rather than
382 redirecting back to the 'Playing' screen.  So that the user gets
383 feedback from their action, playing and queued tracks are now marked as
384 such in the track picking screen.
385
386 It is possible to revert to the old behaviour by removing the back=
387 argument from the choose.html and search.html templates (and optionally
388 the trackstate lines).
389
390 *** Search
391
392 Non-ASCII characters are now properly supported in search terms.
393
394 *** Syntax
395
396 The template syntax has been changed slightly to ignore whitespace in
397 certain places.
398
399 *** Miscellaneous
400
401 Some formerly textual buttons are now replaced by images (with ALT text
402 reflecting the old value).  The stylesheet is now a .css file (installed
403 in the same place as the images) rather than being embedded into every
404 template.
405
406 Artist and album names in the playing and recently-played lists are now
407 links to the corresponding directory.
408
409 More functions are now available from the 'manage' screen.
410
411 The menus are now (by default) across the top of the screen instead of
412 down the side.  Set the 'menu' label to 'sidebar' to restore the old
413 appearance.  'Volume' is not present in this new menu, use 'Manage'
414 instead (or edit the template).
415
416 ** tkdisorder
417
418 tkdisorder now displays artist, album and title in the queue and
419 recently played widgets, rather than just the title (as formerly).
420
421 * Changes up to version 1.1
422
423 ** Bugs Fixed
424
425 Corrected various problems with UTF-8 parsing.
426
427 In the web interface, "The Beatles" (etc) are now grouped under 'B' not
428 'T' when grouping tracks by initial letter.
429
430 ** Server
431
432 The list of recently played tracks is now preserved across server
433 restarts.
434
435 Track IDs are more compact.
436
437 Versions of libdb before 4.2 are no longer supported.  4.2 and 4.3 both
438 work now.  4.2 support will be removed in some future release.
439
440 Prehistoric backwards-compatibility logic removed.  Only affects people
441 upgrading from long before 1.0 (who should upgrade to 1.0 and then to
442 1.1.)
443
444 ** Command Line
445
446 Tracks can be moved in the queue from the command line.
447
448 'disorder queue' now reports track IDs.
449
450 $pkgdatadir/completion.bash provides tab completion over commands and
451 options.
452
453 ** Web Interface
454
455 New 'cooked' preferences interface saves users having to know arcane
456 details of trackname preferences and so on.  Non-ASCII characters are
457 now properly supported in this context.
458
459 CGI arguments to the web interface are now checked for UTF-8 compliance.
460
461 Local Variables:
462 mode:outline
463 fill-column:72
464 End: