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