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