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