osx_write.c: Add doxygen description for struct private_osx_write_data
[paraslash.git] / NEWS
1 NEWS
2 ====
3
4 ------------------------------------------------
5 0.2.14 (to be announced) "transient singularity"
6 ------------------------------------------------
7
8 The only major enhancement of this version is the osx writer which completes
9 the Mac OS Port and was originally planned already for 0.2.13 but had to wait
10 until now for reasons beyond the scope of this changelog entry.
11
12         - new output plugin for Mac Os: the osx writer
13         - rename configure command line options from --enable-xxx-headers to
14           --with-xxx-headers and  --enable-xxx-libs to --with-xxx-libs
15         - configure: new command line options: --with-mad-headers,
16           --with-mad-libs, --with-oggvorbis-headers, and --with-oggvorbis-libs
17         - some robustness fixes
18         - dymamic audio format recognition for audiod
19         - para_server: new command line option: --autoplay_delay
20         - para_audiod: new command line option: --clock_diff_count
21
22 ---------------------------------------
23 0.2.13 (2006-07-14) "sonic convolution"
24 ---------------------------------------
25
26 A bunch of new features and core changes.
27
28         - the new paraslash scheduler, short and sweet.
29         - Support for m4a/mp4 files via the new aac audio format
30           handler/filter (requires libfaad).
31         - each writer has its own command line parser, just like
32           para_recv and para_filter.
33         - para_client and para_audioc use the error subsystem
34         - writers are integrated in para_audiod (currently linux-only)
35         - para_client is integrated in para_audiod
36         - random/playlist selector: improved info strings
37         - new audiod commands: tasks, kill
38         - update to libortp-0.10.1
39         - para_fade: wake time defaults to 8 hours from now
40         - update to autoconf-2.60
41
42
43 ------------------------------------------
44 0.2.12 (2006-05-12) "oriented abstraction"
45 ------------------------------------------
46
47 Many user-visible changes in this release and lots of new
48 features:
49
50
51         - the new optional dccp sender/receiver. It uses the datagram
52           congestion control protocol. You'll need a fairly new kernel
53           for this.
54         - paraslash works on Mac OS X (thanks to Gerd Becker)
55         - para_play renamed to para_write
56         - modular output plugin design (writers) for para_write
57         - new file_writer output plugin for para_write
58         - compress filter speed improvements
59         - update to libortp-0.9.1
60         - update to gengetopt-2.17rc
61         - para_client no longer depends on libreadline (as the
62           code for the interactive mode was removed).
63         - gcc-2-95 is no longer a supported compiler. It may still
64           work, but it gets no more testing.
65         - the tarball no longer contains the screenshot images which
66           reduces its size quite a bit.
67         - configure: new command line options: --enable-mysql-headers
68           and --enable-mysql-libs
69
70 ------------------------------------
71 0.2.11 (2006-03-11) "atomic duality"
72 ------------------------------------
73
74 Here it is, the first paraslash release developed with git. There
75 are fairly many user-visible changes in this release. As two out of
76 the three "database tools" of paraslash don't use a database at all,
77 they are now called "audio file selectors" instead.
78
79
80         - the cdt command (change database tool) becomes chs (change
81           selector)
82         - no more colon separators: The syntax of some options of
83           para_audiod and para_filter have changed. Use --help for
84           more info (and some examples).
85         - update to gengetopt-2.16 (thanks to Lorenzo Bettini)
86         - switch from cvs to git (should've done that earlier)
87         - the new ipc subsystem
88         - new audio file selector: playlist
89         - para_server: the dopey selector is now called "random",
90           and is the default selector. Use the --selector option to
91           choose another selector at startup, or the chs command to
92           change the selector at runtime.
93         - X86_64 fixes (thanks to Steffen Klassert)
94         - para_play fixes
95
96
97 --------------------------------------
98 0.2.10 (2006-02-17) "cyclic attractor"
99 --------------------------------------
100
101 Huge documentation update, a scrollable window for para_gui, ortp
102 improvements, and of course many small fixes not mentioned here.
103 The diffstat below is rather misleading as most insertions are due
104 to the new source documentation.
105
106         - autoconf cleanup
107         - para_server also uses the new error subsystem
108         - lots of new documentation (UTSL)
109         - gui improvements:
110                 - keysyms for cursor keys and for next/previous page keys
111                 - scrollable output window
112                 - new internal commands: scroll up/down, page up/down
113                 - fix color of command output.
114         - ortp: the --chunk_time and --header flags are no longer needed
115         for para_recv/para_audiod as this information is now encoded in
116         each rtp packet sent by para_server.
117
118
119 -------------------------------------------
120 0.2.9 (2006-01-24) "progressive turbulence"
121 -------------------------------------------
122
123 Internal audiod receivers/filters, the new error subsystem and
124 a lot of small improvements.
125
126         - para_recv and para_filter are integrated into the para_audiod
127           binary, i.e. audiod no longer spawns a new process for
128           each receiver/filter. As para_recv and para_filter might be
129           useful as standalone programs, they still get built (linked
130           against the same object files that are also used for audiod).
131         - further ortp timing improvements should reduce the CPU usage
132           of the ortp receiver.
133         - improved audio grabbing. The 'grab' command of para_audiod
134           has its own set of command line options. Read the output of
135           "para_audioc help grab" for more info.
136         - oggdec: configurable input prebuffer size.
137         - the new error subsystem gives better error diagnostics
138           and reduces code size.
139
140
141 -----------------------------------------
142 0.2.8 (2006-01-02) "dynamic accumulation"
143 -----------------------------------------
144
145 The new modular filter design and the para_play-hangs bugfix.
146
147         - new executable: para_filter. It combines para_mp3dec,
148           para_oggdec and para_compress. It also adds a further filter
149           type, wav, that just inserts a wave header at the desired point
150           of the filter chain. All 'piping' is done in-memory (i.e. no
151           read/write operations are used).
152         - para_play: fix a stupid bug that caused it to hang under
153           certain circumstances.
154
155
156 -------------------------------------------
157 0.2.7 (2006-12-27) "transparent invariance"
158 -------------------------------------------
159
160 Not many user-visible changes but a fair amount of internal improvements.
161
162
163         - The http sender buffers data if it can not be sent
164           out immediately (because the socket is not writable). This
165           should prevent para_server from shutting down the connection
166           too early on a loaded network.
167         - para_play also prebuffers data if it is told to start at a
168           future time by the --start_time option.
169         - The return of para_recv: It combines para_ortp_recv and
170           para_http_recv. Use the --receiver option to switch between
171           the two. para_recv builds without libortp, but contains
172           only the http receiver in this case.
173         - update to ortp 0.8.1. As this ortp release contains incompatible
174           changes, para_recv-0.2.7 won't link against older ortp libs.
175         - improved ortp timings.
176         - use of gcc-extensions that #define away for non-gcc and
177           gcc < 3.0.
178
179
180 -------------------------------------------
181 0.2.6 (2005-10-29) "recursive compensation"
182 -------------------------------------------
183
184 Transparent session encryption (uses openssl's Alleged RC4 cipher),
185 the internal find command and several other improvements and cleanups.
186
187         - Encrypt the session if encryption is requested by the client
188           (default for para_client 0.2.6). This is backwards
189           compatible, so older clients can still connect to para_server
190           0.2.6. Use the new client option --plain to request an
191           uncrypted session (off by default, must be set to on in
192           order to connect to para_server 0.2.x with 0 <= x <= 5).
193         - para_server uses an internal function to locate audio files
194           rather than calling find(1). The server option
195           --mysql_audio_file_dir replaces --mysql_find_cmd.
196         - documentation update
197         - man pages
198         - header file cleanup
199         - para_client code cleanup
200         - para_gui: faster display of output of display commands
201
202
203 ------------------------------------------
204 0.2.5 (2005-10-13) "aggressive_resolution"
205 ------------------------------------------
206
207 This release adds internal senders, i.e. no more external programs are
208 spawned for sending out the audio data. There are two different senders
209 available: The http sender and the ortp sender (former para_send which
210 is no longer needed).
211
212 The new sender code has a plugin-like design so it can be easily
213 extended should there be be any future need for supporting another
214 network streaming protocol. All senders are completely independent of
215 each other. In particular, the http and the ortp sender can operate
216 in parallel.
217
218         - new server command: sender to control senders at runtime.
219           Read the output of "para_server -h" and "para_client help
220           sender" for more information.
221         - para_recv renamed to para_ortp_recv
222         - new executable: para_http_recv, a simple command line
223           http receiver.
224         - major afs/mp3/ogg code simplifications due to internal
225           senders.
226         - ogg timing improvements
227         - fix several minor memory leaks (found by valgrind)
228         - empty stream definitions work again
229         - com_ne(): ignore errors on remove
230         - audiod: fix segfault on server restart
231
232
233 ---------------------------------------
234 0.2.4 (2005-09-21) "toxic anticipation"
235 ---------------------------------------
236
237 Several small improvements, fixes and the new grab command.
238
239         - audiod:
240                 - new command: "grab" to grab the output of the stream reader
241                   or any filters. Read the output of "para_audioc help grab"
242                   for more information.
243                 - fix memory leak
244                 - code cleanup
245         - audioc: new command line option: --bufsize to specify a
246           buffer size different from the default size 8192.
247         - improved error diagnostics for para_play.
248         - new configure option: --enable-ssldir so search for openssl in
249           non-standard places
250         - sdl_gui: Make it look nice again for 1024x768
251         - server: report total size of memory allocated with sbrk by malloc,
252           new command line option: --announce_time
253
254
255 -----------------------------------------
256 0.2.3 (2005-09-01) "hydrophilic movement"
257 -----------------------------------------
258
259 Two new executables and major feature enhancements.
260
261         - audiod filters: It is now possible to specify arbitrary many
262           (including none) filters for each supported audio
263           format. This can be used e.g. for normalizing volume,
264           transforming or grabbing the audio stream, or for using
265           visualizers.  Read the output of "para_audiod -h" for the
266           syntax of the new --filter_cmd option.
267         - new executable: para_play, a tiny alsa player. It
268           can play wave files or raw pcm (16 bit little endian)
269           from stdin.
270         - new executable: para_compress, a dynamic range compressor
271           intended to keep audio output at a consistent volume. Derived
272           from AudioCompress, http://trikuare.cx/code/AudioCompress.html.
273         - audiod: New option: --stream_delay. This can be used in
274           a local network to syncronize the audio output of all
275           clients that play the same stream.
276
277
278 ------------------------------------------
279 0.2.2 (2005-08-19) "tangential excitation"
280 ------------------------------------------
281
282 Mostly internal changes in this release, but also some new commands
283 for the mysql database tool.
284
285         - cleanup exec.c, fix para_exec bug
286         - compile time loglevel (log messages below the given level
287           won't be compiled in, which reduces the size of the
288           resulting binaries)
289         - new log macros that shorten the size of the source code.
290         - workaround a gcc-4.1 bug (?) that caused send_cred_buffer()
291           to send only zeros. With this workaround, para_audioc works
292           again.
293         - avoid gcc-4 warning: conflicting types for built-in function 'clog'
294         - new mysql commands: "rm" (remove entry), "mv" (rename entry) "ne"
295           (new entry), "snp" (set numplayed). Read the manual for more
296           information.
297
298
299 ---------------------------------------
300 0.2.1 (2005-08-15) "surreal experience"
301 ---------------------------------------
302
303 Here comes paraslash-0.2.1. It contains a couple of new features and,
304 surprise, only minor bug fixes.
305
306         - kill noisy mp3 debug message
307         - cleanup of the build system
308         - para_server and para_client directly use the crypto routines
309           of the openssl library rather than invoking the openssl command
310           line utitlity
311         - server/audiod: new option --user to switch to the given user
312           when invoked as root. Read the output of "para_server -h" for
313           more information.
314         - gui/sdl_gui: new option --stat_cmd to be used to retrieve the
315           status. Default: "para_audioc stat"
316         - sdl_gui: new option --pic_cmd to be used to download the picture.
317           Default: "para_client pic"
318         - audiod: 5 slots ought to be enough for everybody
319         - audiod: new status item: Uptime, kill hup command
320
321
322
323 ------------------------------------------
324 0.2.0 (2005-08-06) "distributed diffusion"
325 ------------------------------------------
326
327 After several month of increased development activity, paraslash-0.2.0
328 has arrived. It contains many new features and is much more
329 self-contained than the old 0.1.x series. Enjoy!
330
331
332         - para_server: fix hang on song change and crash on sighup.
333           Speed up mysql queries. The DIR_LIKE macro is gone.
334         - new executables: para_audiod, the local audio daemon that
335           starts playback (uses SCM_CREDENTIALS socket magic) and
336           para_audioc, the corresponding client.
337         - new executables: para_mp3dec/para_oggdec, two really teensy
338           decoders. para_mp3dec is based on libmad, para_oggdec requires
339           libvorbisfile.
340         - ovsend/ovrecv are capable of streaming ogg as well as mp3, so
341           they are now called para_send and para_recv respectively.
342         - documentation updates
343         - para_gui is themable. For now there is the default theme that
344           looks as before and the simple theme: blue and easy.
345         - gui: audio streaming is now handled by audiod. Time display shows
346           playback time rather than streaming time
347         - slider: update to libzmw-0.2.0
348         - para_krell: fix crash on server shutdown
349         - switch from gzip to bzip2
350
351
352 ----------------------------------------
353 0.1.7 (2005-04-18) "melting penetration"
354 ----------------------------------------
355
356 The main change in this release is clearly the oggvorbis rewrite,
357 but there are also lots of smaller changes. If you intend to use both
358 the mp3 and the ogg plugin, it is recommended to use software mixing,
359 e.g. the dmix plugin which is provided by ALSA.
360
361         - new executables: para_ovsend and para_ovrecv for sending/receiving
362           oggvorbis files via rtp. Requires the open rtp library. Get it at
363           http://www.linphone.org/ortp/
364         - rewrite of the ogg_vorbis core code
365         - configure detects libzmw and, if detected, includes
366           para_slider to the list of binaries to be built by make
367         - server stream writers read from their associated fifo rather
368           than from stdin
369         - slider: two new sliders, lastplayed and numplayed
370         - fix nasty double free bug which caused random segfaults in case of
371           mp3 files with invalid header information
372         - gui: new command line option: --stream_timeout=seconds  to
373           deactivate a slot if it is idle for that many seconds (default=`5')
374         - diffstats
375
376
377 ---------------------------------------
378 0.1.6 (2005-03-05) "asymptotic balance"
379 ---------------------------------------
380
381 Only little user-visible changes in this release. Mainly bugfixes and
382 core code cleanup. This is probably the most stable version ever if you
383 stick to mp3...
384
385         - fix several memory leaks
386         - rename default name of mysql database from "music" to "paraslash".
387           Use para_server's  --mysql_database option if you do not want to
388           rename your old database.
389         - rework ogg vorbis code
390         - make update command work on mysql servers with LOCAL_INFILE
391           disabled
392         - gui: improved stream I/O (slots)
393         - simplified audio format API
394         - para_pob_ogg is gone
395
396 ------------------------------------
397 0.1.5 (2004-12-31) "opaque eternity"
398 ------------------------------------
399
400 Let's slide gently into the new year.
401
402         - new: para_slider (not built automatically, type "make
403           para_slider" to build). A toy for those who always felt that
404           creating stream definitions is difficult. See screenshots,
405           README and FEATURES for more info.
406         - improved signal handling. Fixes server segfault on SIGHUP
407           for linux kernels newer than Aug 24 2004 and makes para_gui
408           race-free.
409         - reload database tool on SIGHUP
410         - improved help message for sl
411         - do not log "broken pipe" messages as errors. They are
412           perfectly ok.
413         - fix wrong error message on permission errors
414
415 -----------------------------------------
416 0.1.4 (2004-12-19) "tunneling transition"
417 -----------------------------------------
418
419 Bugfix release. As expected, 0.1.3 introduced a bunch of new bugs.
420 Hopefully, most of them got wiped out with this release. Some
421 enhancements went also in.
422
423         - improved error diagnostics for all commands
424         - stradd/picadd: overwrite previous contents if entry already
425           exists, rather than returning errors
426         - stradd: use current stream if invoked without args
427         - faster (and hopefully more stable) ogg-vorbis handling
428         - para_krell: reap children to avoid zombie-flooding in case
429           no server is running
430         - si: report also server pid
431         - server: don't busy-loop if dbtool reports only invalid files.
432         - gui: CTRL+C works again, fix stream_read command line option
433         - fix pic_add, hist
434         - fix mysql dbtool startup in case no database exists
435         - many small fixes and cleanups
436
437 ---------------------------------------
438 0.1.3: (2004-12-10) "vanishing inertia"
439 ---------------------------------------
440
441 Starting from this release, the database tools are integrated in the
442 server binary. This decreases server startup time, reduces code size
443 and speeds up database commands. However, the layout of the underlying
444 mysql database changed only slightly and 0.1.3 should be backwards
445 compatible in that respect.
446
447 Visible changes:
448
449         - If mysql is not detected at compile time, or fails to init
450           at runtime, fall back to the dopey database tool which should
451           always work.
452         - para_dbtool and dbtool.conf are gone. All mysql specific
453           options are read from server.conf and are prefixed by 'mysql_'.
454         - new command: cdt (change database tool)
455         - new command line option: dbtool (choose startup database tool)
456         - The name of current stream is now stored in the database,
457           so paraslash remembers its current stream when restarted.
458         - new command: csp (change stream and play)
459         - para_gui also reports current database tool and server uptime
460
461
462 -------------------------------------------
463 0.1.2: (2004-11-28) "spherical fluctuation"
464 -------------------------------------------
465
466 Point release before the big dbtool changes go in.
467
468         - dbtool: rename ca to cam (copy all meta data). It now also
469           copies numplayed and lastplayed time as well as the picture
470           id.
471         - fix endless-loop-bug caused by mp3 files with invalid header
472
473 -----------------------------------------
474 0.1.1: (2004-11-05) "floating atmosphere"
475 -----------------------------------------
476
477         - gkrellm plugin
478         - new dbtool command: mbox. Browse your sound-file collection
479           with your favorite mail reader.
480         - several small fixes
481
482 -------------------------------------
483 0.1.0: (2204-10-22) "rotating cortex"
484 -------------------------------------
485
486         - fix logging bug for loglevel > VERBOSE
487         - fix skip command
488         - correct timings for vbr mp3s
489         - modular audio format support
490         - ogg-vorbis support (experimental)
491         - new server option: autoplay
492
493 -----------------------------------------
494 0.0.99: (2004-07-25) "harmonic deviation"
495 -----------------------------------------
496
497         - rename projectname from icc to paraslash (play, archive, rate
498           and stream large audio sets happily)
499         - paraslash is no longer restricted to one particular audio
500           streaming software
501         - new dbtool commands (stradd, strq, strdel) for easy stream
502           managment w/o configuration file. That obsoletes stream_defs
503           file/config option for dbtool.
504         - picadd accepts jpeg data from stdin
505         - new server commands: ps (select previous stream), sc (song change)
506         - new default pictures for sdl_gui
507         - gui: new key_map option for binding commands and internal
508           functions to arbitrary keys, nice help screen, rip out
509           soundcard/linux specific stuff, avoid noise artefacts while jumping,
510           show silly logo on startup
511         - new executables: para_fade for fading volume, para_dbadm for
512           manipulating attributes
513         - cdb adds _all_ tables to mysql database
514         - revised and beautified documentation
515         - sample dbtool rewritten in C
516         - autoconf
517
518 ---------------------------------------------
519 0.0.98: (2003-12-26) "incremental smoothness"
520 ---------------------------------------------
521
522         - kick icecast in favour of poc. That removes some races and reduces
523           core code considerably.
524         - cbr/vbr is displayed by stat and gui/sdl_gui. New status flags
525           give finer info on afs' status.
526         - gui can start decoder (see config options). Further new gui
527           commands: refresh (^L), jmp (F1-F10)
528         - gui rereads conf on SIGUSR1 instead of SIGHUP. SIGHUP
529           terminates gui. This fixes dead instances consuming memory
530           continuously.
531         - new dbtool command: verb for sending verbatim sql queries.
532         - fix pid_list races (by removing pid_list)
533         - codename funnies
534
535 --------------------
536 0.0.97: (2003-10-26)
537 --------------------
538
539         - installation prefix now defaults to /usr/local
540         - new commands for gui: snozze, sleep and reread config
541         - config file for gui and sdl_gui
542         - fix problems with filenames containing funny characters
543           (reported by Thomas Forell)
544         - improved signal handling for gui, now it rereads conf on SIGHUP
545         - new dbtool command: cdb (create database)
546         - switch from argtable to gengetopt
547         - major code cleanup and speed improvements
548         - fix several potential buffer overflows
549         - many small fixes and cleanups
550
551 -------------------
552 0.0.96 (2003-08-30)
553 -------------------
554
555         - easy stream_defs syntax
556         - sdl_gui can display images associated to the file being played
557         - Major feature enhancements for icc_gui including dynamic text
558           placement and the top/bottom window design
559         - vrfy/clean now also checks for NULL values in attributes as
560           well as for invalid picture pointers
561         - fix long outstanding case sensitivity bug
562         - many small fixes and cleanups
563
564 -------------------
565 0.0.95 (2003-06-29)
566 -------------------
567
568         - sdl gui runs much faster
569         - new dbtool command: ca (copy attributes)
570         - count and display number of times the song has been played
571         - new feature: scoring
572         - command line options for sdl_gui
573         - simpler syntax of streams file
574         - decrease network traffic of stat
575         - fix zombie bug
576         - many small fixes and cleanups
577
578 -------------------
579 0.0.94 (2003-05-04)
580 -------------------
581
582         - new server command: ns (next stream)
583         - new icc_gui command: c (change stream)
584         - internal mp3info
585         - stat shows also id3 tag info
586         - new sdl based gui
587         - log flodding bug fixed
588         - many small fixes and cleanups
589
590 -------------------
591 0.0.93 (2003-03-28)
592 -------------------
593
594         - colors for icc_gui
595         - icc_gui sets volume directly (linux only)
596         - proper locking that fixes some races
597         - fix security bug that caused commands to be executed even
598           with unsufficient permissions
599         - new command: hup to make all servers reread their configuration file
600         - icecast meta data streaming
601         - many small fixes and cleanups