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