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