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