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