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