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