libburn  1.4.8
comments
Go to the documentation of this file.
1 /**
2  @author Mario Danic, Thomas Schmitt
3 
4  @mainpage Libburn Documentation Index
5 
6  @section intro Introduction
7 
8 Libburnia is an open-source project for reading, mastering and writing
9 optical discs. This page is about its capability to handle optical media.
10 For now this means CD-R, CD-RW, DVD-RAM, DVD+RW, DVD+R, DVD+R/DL, DVD-RW,
11 DVD-R, DVD-R/DL, BD-R, BD-RE.
12 
13 Our scope is currently Linux 2.4 and 2.6, FreeBSD, OpenSolaris, or NetBSD.
14 For ports to other systems we would need : login on a development machine or
15 an OS that is installable on an AMD 64-bit PC, advise from a system person
16 about the equivalent of Linux sg or FreeBSD CAM, volunteers for testing of
17 realistic use cases.
18 
19 libburn is the library by which preformatted data get onto optical media.
20 Its code is independent of cdrecord. Its DVD capabilities are learned from
21 studying the code of dvd+rw-tools and MMC-5 specs. No code but only the pure
22 SCSI knowledge has been taken from dvd+rw-tools, though.
23 
24 cdrskin is a limited cdrecord compatibility wrapper for libburn.
25 cdrecord is a powerful GPL'ed burn program included in Joerg Schilling's
26 cdrtools. cdrskin strives to be a second source for the services traditionally
27 provided by cdrecord. Additionally it provides libburn's DVD/BD capabilities,
28 where only -sao is compatible with cdrecord.
29 cdrskin does not contain any bytes copied from cdrecord's sources.
30 Many bytes have been copied from the message output of cdrecord runs, though.
31 See cdrskin/README for more.
32 
33 The burn API example of libburn is named test/libburner.c . The API for media
34 information inquiry is demonstrated in test/telltoc.c .
35 Explore these examples if you look for inspiration.
36 
37 SONAME:
38 libburn.so.4 (since 0.3.4, March 2007),
39 
40 
41  @section using Using libburn
42 
43 Our build system is based on autotools.
44 User experience tells us that you will need at least autotools version 1.7.
45 
46 To build libburn and its companion applications go into its toplevel directory
47 and execute
48 
49 - ./bootstrap (needed if you downloaded from SVN)
50 
51 - ./configure
52 
53 - make
54 
55 To make the libraries accessible for running and developing applications
56 
57 - make install
58 
59 
60 @section libburner Libburner
61 
62 libburner is a minimal demo application for the library libburn
63 (see: libburn/libburn.h) as provided on http://libburnia-project.org .
64 It can list the available devices, can burn to recordable CD, DVD, or BD,
65 can blank a CD-RW or DVD-RW, and can format unformatted DVD-RW, BD-R, or BD-RE.
66 
67 It's main purpose, nevertheless, is to show you how to use libburn and also
68 to serve the libburnia team as reference application. libburner does indeed
69 define the standard way how above gestures can be implemented and stay upward
70 compatible for a good while.
71 
72  @subsection libburner-help Libburner --help
73 <pre>
74 Usage: test/libburner
75  [--drive address|driveno|"-"] [--audio]
76  [--blank_fast|--blank_full|--format] [--try_to_simulate]
77  [--multi] [one or more imagefiles|"-"]
78 Examples
79 A bus scan (needs rw-permissions to see a drive):
80  test/libburner --drive -
81 Burn a file to drive chosen by number, leave appendable:
82  test/libburner --drive 0 --multi my_image_file
83 Burn a file to drive chosen by persistent address, close:
84  test/libburner --drive /dev/hdc my_image_file
85 Blank a used CD-RW (is combinable with burning in one run):
86  test/libburner --drive /dev/hdc --blank_fast
87 Blank a used DVD-RW (is combinable with burning in one run):
88  test/libburner --drive /dev/hdc --blank_full
89 Format a DVD-RW, BD-RE or BD-R:
90  test/libburner --drive /dev/hdc --format
91 Burn two audio tracks (to CD only):
92  lame --decode -t /path/to/track1.mp3 track1.cd
93  test/dewav /path/to/track2.wav -o track2.cd
94  test/libburner --drive /dev/hdc --audio track1.cd track2.cd
95 Burn a compressed afio archive on-the-fly:
96  ( cd my_directory ; find . -print | afio -oZ - ) | \
97  test/libburner --drive /dev/hdc -
98 To be read from *not mounted* media via: afio -tvZ /dev/hdc
99 </pre>
100 libburner has two companions, telltoc and dewav, which help to perform some
101 peripheral tasks of burning.
102 
103 telltoc prints a table of content (sessions, tracks and leadouts), it tells
104 about type and state of media, and also is able to provide the necessary
105 multi-session information for program mkisofs option -C. Especially helpful
106 are its predictions with "Write multi" and "Write modes" where availability
107 of "TAO" indicates that tracks of unpredicted length can be written.
108 See: test/telltoc --help.
109 
110 dewav extracts raw byte-swapped audio data from files of format .wav (MS WAVE)
111 or .au (SUN Audio). See example in libburner --help.
112 
113  @subsection libburner-source Sourceode of libburner
114 
115 Click on blue names of functions, structures, variables, etc in oder to
116 get to the according specs of libburn API or libburner sourcecode.
117 
118 @include libburner.c
119 */

Generated for libburn by  doxygen 1.8.14