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