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