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