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