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