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