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