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