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