Imported Upstream version 1.1.11
[platform/upstream/cdrkit.git] / icedax / icedax.1
1 '\" t
2 .\" @(#)icedax.1        1.14 02/12/09 Copyright 1998,1999,2000 Heiko Eissfeldt
3 .if t .ds a \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'a
4 .if t .ds o \v'-0.55m'\h'0.00n'\z.\h'0.45n'\z.\v'0.55m'\h'-0.45n'o
5 .if t .ds u \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'u
6 .if t .ds A \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'A
7 .if t .ds O \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'O
8 .if t .ds U \v'-0.77m'\h'0.30n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.75n'U
9 .if t .ds s \\(*b
10 .if t .ds S SS
11 .if n .ds a ae
12 .if n .ds o oe
13 .if n .ds u ue
14 .if n .ds s sz
15 .if t .ds m \\(*m
16 .if n .ds m micro
17 .TH ICEDAX 1
18 .SH NAME
19 icedax \- a sampling utility that dumps CD audio data into wav sound
20 files
21 .SH SYNOPSIS
22 .B icedax
23 .RB [ -c
24 .IR chans ]
25 .RB [ -s ]
26 .RB [ -m ]
27 .RB [ -b
28 .IR bits ]
29 .RB [ -r
30 .IR rate ]
31 .RB [ -a
32 .IR divider ]
33 .RB [ -t
34 .IR track [ +endtrack ]]
35 .RB [ -i
36 .IR index ]
37 .RB [ -o
38 .IR offset ]
39 .RB [ -d
40 .IR duration ]
41 .RB [ -x ]
42 .RB [ -q ]
43 .RB [ -w ]
44 .RB [ -v
45 .IR optlist ]
46 .RB [ -V ]
47 .RB [ -Q ]
48 .RB [ -J ]
49 .RB [ -L
50 .IR cddbmode ]
51 .RB [ -R ]
52 .RB [ -P
53 .IR sectors ]
54 .RB [ -F ]
55 .RB [ -G ]
56 .RB [ -T ]
57 .RB [ -e ]
58 .RB [ -p
59 .IR percentage ]
60 .RB [ -n
61 .IR sectors ]
62 .RB [ -l
63 .IR buffers ]
64 .RB [ -N ]
65 .RB [ -J ]
66 .RB [ -H ]
67 .RB [ -g ]
68 .RB [ -B ]
69 .RB [ -D
70 .IR device ]
71 .RB [ -A
72 .IR auxdevice ]
73 .RB [ -I
74 .IR interface ]
75 .RB [ -O
76 .IR audiotype ]
77 .RB [ -C
78 .IR input-endianess ]
79 .RB [ -E
80 .IR output-endianess ]
81 .RB [ -M
82 .IR count ]
83 .RB [ -S
84 .IR speed ]
85 .RB [ -paranoia ]
86 .RB [ cddbp-server=servername ]
87 .RB [ cddbp-port=portnumber ]
88 .RI [ filename(s)
89 or
90 .IR directories ]
91 .SH DESCRIPTION
92 .B icedax
93 stands for InCrEdible Digital Audio eXtractor. It can retrieve audio tracks
94 .RB ( CDDA )
95 from CDROM drives
96 that are
97 capable of reading audio data digitally to the host
98 (see README for a list of drives).
99
100 .SH OPTIONS
101 .TP
102 .BI dev= device
103 .TP
104 .BI \-D " device
105 .TP
106 .BI \-device " device
107 uses
108 .B device
109 as the source for CDDA reading. For example
110 .B /dev/cdrom
111 or
112 .B Bus,ID,Lun.
113 The device specification can also have influence on the selection of the driver interface (eg. on Linux).
114 See the
115 .B \-I
116 option for details.
117 .sp
118 The setting of the environment variable
119 .B CDDA_DEVICE
120 is overridden by this option.
121 .TP
122 .BI \-A " auxdevice
123 .TP
124 .BI \-auxdevice " auxdevice
125 uses
126 .B auxdevice
127 as CDROM drive for ioctl usage.
128 .TP
129 .BI \-I " interface
130 .TP
131 .BI \-interface " interface
132 specifies the interface for CDROM access:
133 .B generic_scsi
134 or (on Linux, and FreeBSD systems)
135 .BR cooked_ioctl .
136 .sp
137 Using the
138 .B cooked_ioctl
139 is not recommended as this makes
140 .B icedax
141 mainly depend on the audio extraction quality of the operating system
142 which is usually extremely bad.
143 .TP
144 .BI \-c " channels  --channels"
145 uses
146 .B 1
147 for mono, or
148 .B 2
149 for stereo recording,
150 or
151 .B s
152 for stereo recording with both channels swapped.
153 .TP
154 .B \-s " --stereo"
155 sets to stereo recording.
156 .TP
157 .B \-m " --mono"
158 sets to mono recording.
159 .TP
160 .B \-x " --max"
161 sets maximum (CD) quality.
162 .TP
163 .BI \-b " bits  --bits-per-sample"
164 sets bits per sample per channel:
165 .BR 8 ,
166 .B 12
167 or
168 .BR 16 .
169 .TP
170 .BI \-r " rate  --rate"
171 sets rate in samples per second.  Possible values are listed with the
172 .B \-R
173 option.
174 .TP
175 .BI \-a " divider  --divider"
176 sets rate to 44100Hz / divider.  Possible values are listed with the
177 .B \-R
178 option.
179 .TP
180 .B \-R " --dump-rates"
181 shows a list of all sample rates and their dividers.
182 .TP
183 .B \-P " sectors  --set-overlap"
184 sets the initial number of overlap
185 .I sectors
186 for jitter correction.
187 .TP
188 .BI \-n " sectors  --sectors-per-request"
189 reads 
190 .I sectors
191 per request.
192 .TP
193 .BI \-l " buffers  --buffers-in-ring"
194 uses a ring buffer with 
195 .I buffers
196 total.
197 .TP
198 .BI \-t " track+endtrack  --track"
199 selects the start track and optionally the end track.
200 .TP
201 .BI \-i " index  --index"
202 selects the start index.
203 .TP
204 .BI \-o " offset  --offset"
205 starts
206 .I offset
207 sectors behind start track (one sector equivalents 1/75 seconds).
208 .TP
209 .B \-O " audiotype  --output-format"
210 can be 
211 .I wav
212 (for wav files) or
213 .I aiff
214 (for apple/sgi aiff files) or
215 .I aifc
216 (for apple/sgi aifc files) or
217 .I au
218 or
219 .I sun
220 (for sun .au PCM files) or
221 .I cdr
222 or
223 .I raw
224 (for headerless files to be used for cd writers).
225 .TP
226 .BI \-C " endianess  --cdrom-endianess"
227 sets endianess of the input samples to 'little', 'big' or 'guess' to override defaults.
228 .TP
229 .BI \-E " endianess  --output-endianess"
230 sets endianess of the output samples to 'little' or 'big' to override defaults.
231 .TP
232 .BI \-d " duration  --duration"
233 sets recording time in seconds or frames.
234 Frames (sectors) are indicated by a 'f' suffix (like 75f for 75 sectors).
235 .B 0
236 sets the time for whole track.
237 .TP
238 .B \-B " --bulk --alltracks"
239 copies each track into a separate file.
240 .TP
241 .B \-w " --wait"
242 waits for signal, then start recording.
243 .TP
244 .B \-F " --find-extremes"
245 finds extreme amplitudes in samples.
246 .TP
247 .B \-G " --find-mono"
248 finds if input samples are in mono.
249 .TP
250 .B \-T " --deemphasize"
251 undo the effect of pre-emphasis in the input samples.
252 .TP
253 .B \-e " --echo"
254 copies audio data to sound device e.g.
255 .BR /dev/dsp .
256 .TP
257 .B \-p " percentage --set-pitch"
258 changes pitch of audio data copied to sound device.
259 .TP
260 .B \-v " itemlist  --verbose-level"
261 prints verbose information about the CD.
262 .B Level
263 is a list of comma separated suboptions. Each suboption controls the type of information to be reported.
264 .TS H
265 allbox;
266 c cw(1i)
267 r l.
268 Suboption       Description
269 disable no information is given, warnings appear however
270 all     all information is given
271 toc     show table of contents
272 summary show a summary of the recording parameters
273 indices determine and display index offsets
274 catalog retrieve and display the media catalog number MCN
275 trackid T{
276 .na
277 retrieve and display all International Standard Recording Codes ISRC
278 T}
279 sectors T{
280 .na
281 show the table of contents in start sector notation
282 T}
283 titles  T{
284 .na
285 show the table of contents with track titles (when available)
286 T}
287 .TE
288 .TP
289 .B \-N " --no-write"
290 does not write to a file, it just reads (for debugging purposes).
291 .TP
292 .B \-J " --info-only"
293 does not write to a file, it just gives information about the disc.
294 .TP
295 .B \-L " cddb mode --cddb"
296 does a cddbp album- and track title lookup based on the cddb id.
297 The parameter cddb mode defines how multiple entries shall be handled.
298 .TS H
299 allbox;
300 c cw(4i)
301 r l.
302 Parameter       Description
303 0       T{
304 .na
305 interactive mode. The user selects the entry to use.
306 T}
307 1       T{
308 .na
309 first fit mode. The first entry is taken unconditionally.
310 T}
311 .TE
312 .TP
313 .B " cddbp-server=servername"
314 sets the server to be contacted for title lookups.
315 .TP
316 .B " cddbp-port=portnumber"
317 sets the port number to be used for title lookups.
318 .TP
319 .B \-H " --no-infofile"
320 does not write an info file and a cddb file.
321 .TP
322 .B \-g " --gui"
323 formats the output to be better parsable by gui frontends.
324 .TP
325 .B \-M " count --md5"
326 enables calculation of MD-5 checksum for 'count' bytes from a beginning of a
327 track.
328 .TP
329 .B \-S " speed --speed"
330 sets the cdrom device to one of the selectable speeds for reading.
331 .TP
332 .B \-q " --quiet"
333 quiet operation, no screen output.
334 .TP
335 .B \-V " --verbose-SCSI"
336 enable SCSI command logging to the console. This is mainly used for debugging.
337 .TP
338 .B \-Q " --silent-SCSI"
339 suppress SCSI command error reports to the console. This is mainly used for guis.
340 .TP
341 .B \-scanbus
342 Scan all SCSI devices on all SCSI busses and print the inquiry
343 strings. This option may be used to find SCSI address of the 
344 CD/DVD-Recorder on a system.
345 The numbers printed out as labels are computed by: 
346 .B "bus * 100 + target
347 .TP
348 .B \-\-devices
349 Like \-scanbus but works in a more native way, respecting the device name
350 specification on the current operating system. See
351 .B wodim(1)
352 for details.
353 .TP
354 .B \-paranoia
355 use the paranoia library instead of icedax's routines for reading.
356 .TP
357 .B \-h " --help"
358 display version of icedax on standard output.
359 .TP
360 Defaults depend on the
361 .B Makefile
362 and
363 .B environment variable
364 settings (currently
365 .B CDDA_DEVICE
366 ).
367 .SH "ENVIRONMENT VARIABLES"
368 .B CDDA_DEVICE
369 is used to set the device name. The device naming is compatible with the one
370 used by the wodim tool.
371 .TP
372 .B CDDBP_SERVER
373 is used for cddbp title lookups when supplied.
374 .TP
375 .B CDDBP_PORT
376 is used for cddbp title lookups when supplied.
377 .TP
378 .B RSH
379 If the 
380 .B RSH
381 environment variable is present, the remote connection will not be created via
382 .BR rcmd (3)
383 but by calling the program pointed to by
384 .BR RSH .
385 Use e.g. 
386 .BR RSH= /usr/bin/ssh
387 to create a secure shell connection.
388 .sp
389 Note that this forces 
390 .B icedax
391 to create a pipe to the 
392 .B rsh(1)
393 program and disallows
394 .B icedax
395 to directly access the network socket to the remote server.
396 This makes it impossible to set up performance parameters and slows down
397 the connection compared to a 
398 .B root
399 initiated
400 .B rcmd(3)
401 connection.
402 .TP
403 .B RSCSI
404 If the 
405 .B RSCSI
406 environment variable is present, the remote SCSI server will not be the program
407 .B /opt/schily/sbin/rscsi
408 but the program pointed to by
409 .BR RSCSI .
410 Note that the remote SCSI server program name will be ignored if you log in
411 using an account that has been created with a remote SCSI server program as
412 login shell.
413 .SH "RETURN VALUES"
414 .B icedax
415 uses the following exit codes to indicate various degrees of success:
416 .TS H
417 allbox;
418 c cw(1i)
419 r l.
420 Exitcode        Description
421 0       no errors encountered, successful operation.
422 1       usage or syntax error. icedax got inconsistent arguments.
423 2       permission (un)set errors. permission changes failed.
424 3       read errors on the cdrom/burner device encountered.
425 4       T{
426 .na
427 write errors while writing one of the output files encountered.
428 T}
429 5       errors with soundcard handling (initialization/write).
430 6       T{
431 .na
432 errors with stat() system call on the read device (cooked ioctl).
433 T}
434 7       pipe communication errors encountered (in forked mode).
435 8       signal handler installation errors encountered.
436 9       allocation of shared memory failed (in forked mode).
437 10      dynamic heap memory allocation failed.
438 11      errors on the audio cd medium encountered.
439 12      device open error in ioctl handling detected.
440 13      race condition in ioctl interface handling detected.
441 14      error in ioctl() operation encountered.
442 15      internal error encountered. Please report back!!!
443 16      T{
444 .na
445 error in semaphore operation encountered (install / request).
446 T}
447 17      could not get the scsi transfer buffer.
448 18      T{
449 .na
450 could not create pipes for process communication (in forked mode).
451 T}
452 .TE
453 .SH "DISCUSSION"
454 .B icedax
455 is able to read parts of an
456 .B audio
457 CD or
458 .B multimedia
459 CDROM (containing audio parts) directly digitally. These parts can be
460 written to a file, a pipe, or to a sound device.
461 .PP
462 .B icedax
463 stands for
464 .B CDDA
465 to
466 .B WAV
467 (where
468 .B CDDA
469 stands for compact disc digital audio and
470 .B WAV
471 is a sound sample format introduced by MS Windows).  It
472 allows copying
473 .B CDDA
474 audio data from the CDROM drive into a file in 
475 .B WAV
476 or other formats.
477 .PP
478 The latest versions try to get higher real-time scheduling priorities to ensure
479 smooth (uninterrupted) operation. These priorities are available for super users
480 and are higher than those of 'normal' processes. Thus delays are minimized.
481 .PP
482 If your CDROM is on device
483 .B DEV
484 and it is loaded with an audio CD, you may simply invoke
485 .B icedax dev=DEV
486 and it will create the sound file
487 .B audio.wav
488 recording the whole track beginning with track 1 in stereo at 16 bit at 44100
489 Hz sample rate, if your file system has enough space free.  Otherwise
490 recording time will be limited. For details see files
491 .B README
492 and
493 .B README.INSTALL
494 .
495 .SH "HINTS ON OPTIONS"
496 .IP "Options"
497 Most of the options are used to control the format of the WAV file. In
498 the following text all of them are described.
499 .IP "Select Device"
500 .BI \-D " device"
501 selects the CDROM drive device to be used.
502 The specifier given should correspond to the selected interface (see below).
503 .B CHANGE!
504 For the cooked_ioctl interface this is the cdrom device descriptor as before.
505 .B The SCSI devices used with the generic SCSI interface however are now
506 .B addressed with their SCSI-Bus, SCSI-Id, and SCSI-Lun instead of the generic
507 .B SCSI device descriptor!!!
508 One example for a SCSI CDROM drive on bus 0 with SCSI ID 3 and lun 0 is -D0,3,0.
509 .IP "Select Auxiliary device"
510 .BI \-A " auxdevice"
511 is necessary for CD-Extra handling. For Non-SCSI-CDROM drives this is the
512 same device as given by -D (see above). For SCSI-CDROM drives it is the
513 CDROM drive (SCSI) device (i.e.  
514 .B /dev/sr0
515 ) corresponding to the SCSI device (i.e.
516 .B 0,3,0
517 ). It has to match the device used for sampling.
518 .IP "Select Interface"
519 .BI \-I " interface"
520 selects the CDROM drive interface. For SCSI drives use generic_scsi
521 (cooked_ioctl may not yet be available for all devices):
522 .B generic_scsi
523 and
524 .BR cooked_ioctl .
525 The first uses the generic SCSI interface, the latter uses the ioctl of
526 the CDROM driver. The latter variant works only when the kernel driver supports
527 .B CDDA
528 reading. This entry has to match the selected CDROM device (see above).
529 .IP "Enable echo to soundcard"
530 .B \-e
531 copies audio data to the sound card while recording, so you hear it nearly
532 simultaneously. The soundcard gets the same data that is recorded. This
533 is time critical, so it works best with the
534 .B \-q
535 option.  To use
536 .B icedax
537 as a pseudo CD player without recording in a file you could use
538 .B "icedax \-q \-e \-t2 \-d0 \-N"
539 to play the whole second track. This feature reduces the recording speed
540 to at most onefold speed. You cannot make better recordings than your sound card
541 can play (since the same data is used).
542 .IP "Change pitch of echoed audio"
543 .B "\-p percentage"
544 changes the pitch of all audio echoed to a sound card. Only the copy
545 to the soundcard is affected, the recorded audio samples in a file
546 remain the same.
547 Normal pitch, which is the default, is given by 100%.
548 Lower percentages correspond to lower pitches, i.e.
549 -p 50 transposes the audio output one octave lower.
550 See also the script
551 .B pitchplay
552 as an example. This option was contributed by Raul Sobon.
553 .IP "Select mono or stereo recording"
554 .B \-m
555 or
556 .B "\-c 1"
557 selects mono recording (both stereo channels are mixed),
558 .B \-s
559 or
560 .B "\-c 2"
561 or
562 .B "\-c s"
563 selects stereo recording. Parameter s
564 will swap both sound channels.
565 .IP "Select maximum quality"
566 .B \-x
567 will set stereo, 16 bits per sample at 44.1 KHz (full CD quality).  Note
568 that other format options given later can change this setting.
569 .IP "Select sample quality"
570 .B "\-b 8"
571 specifies 8 bit (1 Byte) for each sample in each channel;
572 .B "\-b 12"
573 specifies 12 bit (2 Byte) for each sample in each channel;
574 .B "\-b 16"
575 specifies 16 bit (2 Byte) for each sample in each channel (Ensure that
576 your sample player or sound card is capable of playing 12-bit or 16-bit
577 samples). Selecting 12 or 16 bits doubles file size.  12-bit samples are
578 aligned to 16-bit samples, so they waste some disk space.
579 .IP "Select sample rate"
580 .BI \-r " samplerate"
581 selects a sample rate.
582 .I samplerate
583 can be in a range between 44100 and 900. Option
584 .B \-R
585 lists all available rates.
586 .IP "Select sample rate divider"
587 .BI \-a " divider"
588 selects a sample rate divider.
589 .I divider
590 can be minimally 1 and maximally 50.5 and everything between in steps of 0.5.
591 Option
592 .B \-R
593 lists all available rates.
594 .IP
595 To make the sound smoother at lower sampling rates,
596 .B icedax
597 sums over
598 .I n
599 samples (where
600 .I n
601 is the specific dividend). So for 22050 Hertz output we have to sum over
602 2 samples, for 900 Hertz we have to sum over 49 samples.  This cancels
603 higher frequencies. Standard sector size of an audio CD (ignoring
604 additional information) is 2352 Bytes. In order to finish summing
605 for an output sample at sector boundaries the rates above have to be
606 chosen.  Arbitrary sampling rates in high quality would require some
607 interpolation scheme, which needs much more sophisticated programming.
608 .IP "List a table of all sampling rates"
609 .BI \-R
610 shows a list of all sample rates and their dividers. Dividers can range
611 from 1 to 50.5 in steps of 0.5.
612 .IP "Select start track and optionally end track"
613 .BI \-t " n+m"
614 selects
615 .B n
616 as the start track and optionally
617 .B m
618 as the last track of a range to be recorded.
619 These tracks must be from the table of contents.  This sets
620 the track where recording begins. Recording can advance through the
621 following tracks as well (limited by the optional end track or otherwise
622 depending on recording time). Whether one file or different files are
623 then created depends on the
624 .B \-B
625 option (see below).
626 .IP "Select start index"
627 .BI \-i " n"
628 selects the index to start recording with.  Indices other than 1 will
629 invoke the index scanner, which will take some time to find the correct
630 start position. An offset may be given additionally (see below).
631 .IP "Set recording time"
632 .B \-d " n"
633 sets recording time to
634 .I n
635 seconds or set recording time for whole track if
636 .I n
637 is zero. In order to specify the duration in frames (sectors) also, the
638 argument can have an appended 'f'. Then the numerical argument is to be
639 taken as frames (sectors) rather than seconds.
640 Please note that if track ranges are being used they define the recording
641 time as well thus overriding any
642 .BR \-d " option"
643 specified times.
644 .IP
645 Recording time is defined as the time the generated sample will play (at
646 the defined sample rate). Since it's related to the amount of generated
647 samples, it's not the time of the sampling process itself (which can be
648 less or more).  It's neither strictly coupled with the time information on
649 the audio CD (shown by your hifi CD player).
650 Differences can occur by the usage of the
651 .B \-o
652 option (see below). Notice that recording time will be shortened, unless
653 enough disk space exists. Recording can be aborted at anytime by
654 pressing the break character (signal SIGQUIT).
655    .IP "Record all tracks of a complete audio CD in separate files"
656 .B \-B
657 copies each track into a separate file. A base name can be given. File names
658 have an appended track number and an extension corresponding to the audio
659 format. To record all audio tracks of a CD, use a sufficient high duration
660 (i.e. -d99999).
661 .IP "Set start sector offset"
662 .BI \-o " sectors"
663 increments start sector of the track by
664 .IR sectors .
665 By this option you are able to skip a certain amount at the beginning of
666 a track so you can pick exactly the part you want. Each sector runs for 1/75
667 seconds, so you have very fine control. If your offset is so high that
668 it would not fit into the current track, a warning message is issued
669 and the offset is ignored.  Recording time is not reduced.  (To skip
670 introductory quiet passages automagically, use the
671 .B \-w
672 option see below.)
673 .IP "Wait for signal option"
674 .B \-w
675 Turning on this option will suppress all silent output at startup,
676 reducing possibly file size.
677 .B icedax
678 will watch for any signal in the output signal and switches on writing
679 to file.
680 .IP "Find extreme samples"
681 .B \-F
682 Turning on this option will display the most negative and the most positive
683 sample value found during recording for both channels. This can be useful
684 for readjusting the volume. The values shown are not reset at track
685 boundaries, they cover the complete sampling process. They are taken from
686 the original samples and have the same format (i.e. they are independent
687 of the selected output format).
688 .IP "Find if input samples are in mono"
689 .B \-G
690 If this option is given, input samples for both channels will be compared. At
691 the end of the program the result is printed. Differences in the channels
692 indicate stereo, otherwise when both channels are equal it will indicate mono.
693 .IP "Undo the pre-emphasis in the input samples"
694 .B \-T
695 Some older audio CDs are recorded with a modified frequency response called
696 pre-emphasis. This is found mostly in classical recordings. The correction
697 can be seen in the flags of the Table Of Contents often. But there are
698 recordings, that show this setting only in the subchannels. If this option
699 is given, the index scanner will be started, which reads the q-subchannel
700 of each track. If pre-emphasis is indicated in the q-subchannel of a track,
701 but not in the TOC, pre-emphasis will be assumed to be present, and
702 subsequently a reverse filtering is done for this track before the samples
703 are written into the audio file.
704 .IP "Set audio format"
705 .B \-O " audiotype"
706 can be 
707 .I wav
708 (for wav files) or
709 .I au
710 or
711 .I sun
712 (for sun PCM files) or
713 .I cdr
714 or
715 .I raw
716 (for headerless files to be used for cd writers).
717 All file samples are coded in linear pulse code modulation (as done
718 in the audio compact disc format). This holds for all audio formats.
719 Wav files are compatible to Wind*ws sound files, they have lsb,msb byte order
720 as being used on the audio cd. The default filename extension is '.wav'.
721 Sun type files are not like the older common logarithmically coded .au files,
722 but instead as mentioned above linear PCM is used. The byte order is msb,lsb
723 to be compatible. The default filename extension is '.au'.
724 The AIFF and the newer variant AIFC from the Apple/SGI world store their samples
725 in bigendian format (msb,lsb). In AIFC no compression is used.
726 Finally the easiest 'format',
727 the cdr aka raw format. It is done per default in msb,lsb byte order to satisfy
728 the order wanted by most cd writers. Since there is no header information in this
729 format, the sample parameters can only be identified by playing the samples
730 on a soundcard or similar. The default filename extension is '.cdr' or '.raw'.
731 .IP "Select cdrom drive reading speed"
732 .B \-S " speed"
733 allows to switch the cdrom drive to a certain level of speed in order to
734 reduce read errors. The argument is transfered verbatim to the drive.
735 Details depend very much on the cdrom drives.
736 An argument of 0 for example is often the default speed of the drive,
737 a value of 1 often selects single speed.
738 .IP "Enable MD5 checksums"
739 .B \-M " count"
740 enables calculation of MD-5 checksum for 'count' bytes from the beginning of a
741 track. This was introduced for quick comparisons of tracks.
742 .IP "Use Monty's libparanoia for reading of sectors"
743 .B \-paranoia
744 selects an alternate way of extracting audio sectors. Monty's library is used
745 with the following default options:
746 .sp
747 PARANOIA_MODE_FULL, but without PARANOIA_MODE_NEVERSKIP
748 .sp
749 for details see Monty's libparanoia documentation.
750 In this case the option
751 .B \-P
752 has no effect.
753 .IP "Do linear or overlapping reading of sectors"
754 (This applies unless option
755 .B \-paranoia
756 is used.)
757 .B \-P " sectors"
758 sets the given number of sectors for initial overlap sampling for jitter
759 correction. Two cases are to be distinguished. For nonzero values,
760 some sectors are read twice to enable icedax's jitter correction.
761 If an argument of zero is given, no overlap sampling will be used.
762 For nonzero overlap sectors icedax dynamically adjusts the setting during
763 sampling (like cdparanoia does).
764 If no match can be found, icedax retries the read with an increased overlap.
765 If the amount of jitter is lower than the current overlapped samples, icedax
766 reduces the overlap setting, resulting in a higher reading speed.
767 The argument given has to be lower than the total number of sectors per request
768 (see option
769 .I -n
770 below).
771 Icedax will check this setting and issues a error message otherwise.
772 The case of zero sectors is nice on low load situations or errorfree (perfect)
773 cdrom drives and perfect (not scratched) audio cds.
774 .IP "Set the transfer size"
775 .B \-n " sectors"
776 will set the transfer size to the specified sectors per request.
777 .IP "Set number of ring buffer elements"
778 .B \-l " buffers"
779 will allocate the specified number of ring buffer elements.
780 .IP "Set endianess of input samples"
781 .B \-C " endianess"
782 will override the default settings of the input format.
783 Endianess can be set explicitly to "little" or "big" or to the automatic
784 endianess detection based on voting with "guess".
785 .IP "Set endianess of output samples"
786 .B \-E " endianess"
787 (endianess can be "little" or "big") will override the default settings 
788 of the output format.
789 .IP "Verbose option"
790 .B \-v " itemlist"
791 prints more information. A list allows selection of different
792 information items.
793 .sp
794 .B "disable"
795 keeps quiet
796 .sp
797 .B "toc"
798 displays the table of contents
799 .sp
800 .B "summary"
801 displays a summary of recording parameters
802 .sp
803 .B "indices"
804 invokes the index scanner and displays start positions of indices
805 .sp
806 .B "catalog"
807 retrieves and displays a media catalog number
808 .sp
809 .B "trackid"
810 retrieves and displays international standard recording codes
811 .sp
812 .B "sectors"
813 displays track start positions in absolute sector notation
814 .sp
815 To combine several requests just list the suboptions separated with commas.
816 .IP "The table of contents"
817 The display will show the table of contents with number of tracks and
818 total time (displayed in
819 .IR mm : ss . hh
820 format,
821 .IR mm =minutes,
822 .IR ss =seconds,
823 .IR hh "=rounded 1/100 seconds)."
824 The following list displays track number and track time for each entry.
825 The summary gives a line per track describing the type of the track.
826 .sp
827 .ce 1
828 .B "track preemphasis copypermitted tracktype chans"
829 .sp
830 The
831 .B track
832 column holds the track number.
833 .B preemphasis
834 shows if that track has been given a non linear frequency response.
835 NOTE: You can undo this effect with the
836 .B \-T
837 option.
838 .B "copy-permitted"
839 indicates if this track is allowed to copy.
840 .B "tracktype"
841 can be data or audio. On multimedia CDs (except hidden track CDs) 
842 both of them should be present.
843 .B "channels"
844 is defined for audio tracks only. There can be two or four channels.
845 .IP "No file output"
846 .B \-N
847 this debugging option switches off writing to a file.
848 .IP "No infofile generation"
849 .B \-H
850 this option switches off creation of an info file and a cddb file.
851 .IP "Generation of simple output for gui frontends"
852 .B \-g
853 this option switches on simple line formatting, which is needed to support
854 gui frontends (like xcd-roast).
855 .IP "Verbose SCSI logging"
856 .B \-V
857 this option switches on logging of SCSI commands. This will produce
858 a lot of output (when SCSI devices are being used).
859 This is needed for debugging purposes. The format
860 is the same as being used with the cdrecord program from J\*org Schilling or
861 the wodim tool. See there for details.
862 .IP "Quiet option"
863 .B \-q
864 suppresses all screen output except error messages.
865 That reduces cpu time resources.
866 .IP "Just show information option"
867 .B \-J
868 does not write a file, it only prints information about the disc (depending
869 on the
870 .B \-v
871 option). This is just for information purposes.
872 .SH "CDDBP support"
873 .IP "Lookup album and track titles option"
874 .B \-L " cddbp mode"
875 Icedax tries to retrieve performer, album-, and track titles from a cddbp
876 server. The default server right now is 'freedb.freedb.org'.
877 It is planned to have more control over the server handling later.
878 The parameter defines how multiple entries are handled:
879 .PP
880 0       interactive mode, the user chooses one of the entries.
881 .PP
882 1       take the first entry without asking.
883 .IP "Set server for title lookups"
884 .B cddbp-server " servername"
885 When using \-L or --cddb, the server being contacted can be set with
886 this option.
887 .IP "Set portnumber for title lookups"
888 .B cddbp-port " portnumber"
889 When using \-L or --cddb, the server port being contacted can be set with
890 this option.
891 .SH "HINTS ON USAGE"
892 Don't create samples you cannot read. First check your sample player
893 software and sound card hardware. I experienced problems with very low
894 sample rates (stereo <= 1575 Hz, mono <= 3675 Hz) when trying to play
895 them with standard WAV players for sound blaster (maybe they are not
896 legal in
897 .B WAV
898 format). Most CD-Writers insist on audio samples in a bigendian format.
899 Now icedax supports the 
900 .B \-E " endianess"
901 option to control the endianess of the written samples.
902 .PP
903 If your hardware is fast enough to run icedax
904 uninterrupted and your CD drive is one of the 'perfect' ones, you will
905 gain speed when switching all overlap sampling off with the
906 .B \-P " 0"
907 option. Further fine tuning can be done with the
908 .B \-n " sectors"
909 option. You can specify how much sectors should be requested in one go.
910 .PP
911 Icedax supports
912 .B pipes
913 now. Use a filename of
914 .B \-
915 to let icedax output its samples to standard output.
916 .PP
917 Conversion to other sound formats can be done using the
918 .B sox
919 program package (although the use of
920 .B sox -x
921 to change the byte order of samples should be no more necessary; see option
922 .B \-E
923 to change the output byteorder).
924 .PP
925 If you want to sample more than one track into
926 different files in one run, this is currently possible with the
927 .B \-B
928 option. When recording time exceeds the track limit a new file will
929 be opened for the next track.
930 .SH FILES
931 Icedax can generate a lot of files for various purposes.
932 .sp
933 Audio files:
934 .sp
935 There are audio files containing samples with default extensions
936 .wav, .au, .aifc, .aiff, and .cdr according to the selected sound format.
937 These files are not generated when option (-N) is given. Multiple files may
938 be written when the bulk copy option (-B) is used. Individual file names
939 can be given as arguments. If the number of file names given is sufficient
940 to cover all included audio tracks, the file names will be used verbatim.
941 Otherwise, if there are less file names than files needed to write the
942 included tracks, the part of the file name before the extension is extended
943 with '_dd' where dd represents the current track number.
944 .sp
945 Cddb and Cdindex files:
946 .sp
947 If icedax detects cd-extra or cd-text (album/track) title information,
948 then .cddb and .cdindex files are generated unless suppressed by the
949 option -H. They contain suitable formatted entries for submission to
950 audio cd track title databases in the internet. The CDINDEX and CDDB(tm)
951 systems are currently supported. For more information please visit
952 www.musicbrainz.org and www.freedb.com.
953 .sp
954 Inf files:
955 .sp
956 The inf files are describing the sample files and the part from the audio cd,
957 it was taken from. They are a means to transfer information to a cd burning
958 program like wodim. For example, if the original audio cd had pre-emphasis
959 enabled, and icedax -T did remove the pre-emphasis, then the inf file has
960 pre-emphasis not set (since the audio file does not have it anymore), while
961 the .cddb and the .cdindex have pre-emphasis set as the original does.
962 .SH WARNING
963 .B IMPORTANT:
964 it is prohibited to sell copies of copyrighted material by noncopyright
965 holders. This program may not be used to circumvent copyrights.
966 The user acknowledges this constraint when using the software.
967 .SH BUGS
968 Generation of md5 checksums is currently broken.
969 .sp
970 Performance may not be optimal on slower systems.
971 .sp
972 The index scanner may give timeouts.
973 .sp
974 The resampling (rate conversion code) uses polynomial interpolation, which
975 is not optimal.
976 .sp
977 Icedax should use threads.
978 .sp
979 Icedax currently cannot sample hidden audio tracks (track 1 index 0).
980 .SH ACKNOWLEDGEMENTS
981 Thanks goto Project MODE (http://www.mode.net/) and Fraunhofer Institut f\*ur
982 integrierte Schaltungen (FhG-IIS) (http://www.iis.fhg.de/) for financial
983 support.
984 Plextor Europe and Ricoh Japan provided cdrom disk drives and cd burners
985 which helped a lot to develop this software.
986 Rammi has helped a lot with the debugging and showed a lot of stamina when
987 hearing 100 times the first 16 seconds of the first track of the Krupps CD.
988 Libparanoia contributed by Monty (Christopher Montgomery) xiphmont@mit.edu.
989 .SH AUTHOR
990 Heiko Eissfeldt heiko@colossus.escape.de
991 .PP
992 This manpage describes the program implementation of
993 .B
994 icedax
995 as shipped by the cdrkit distribution. See
996 .B
997 http://alioth.debian.org/projects/debburn/
998 for details. It is a spinoff from the original program cdda2wav as distributed
999 in the cdrtools package [1]. However, the cdrtools developers are not involved
1000 in the development of this spinoff and therefore shall not be made responsible
1001 for any problem caused by it. Do not try to get support for this program by
1002 contacting the original authors.
1003 .PP
1004 If you have support questions, send them to
1005 .PP
1006 .B
1007 debburn-devel@lists.alioth.debian.org
1008 .br
1009 .PP
1010 If you have definitely found a bug, send a mail to this list or to
1011 .PP
1012 .B
1013 submit@bugs.debian.org
1014 .br
1015 .PP
1016 writing at least a short description into the Subject and "Package: cdrkit" into the first line of the mail body.
1017
1018 .SH DATE
1019 26 Sep 2006
1020
1021 .SH SOURCES
1022 .PP
1023 .br
1024 [1] Cdrtools 2.01.01a08 from May 2006, http://cdrecord.berlios.de
1025