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