<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libburn: comments Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>comments</h1><a href="comments.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span>
<a name="l00002"></a>00002 <span class="comment"> @author Mario Danic, Thomas Schmitt</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> @mainpage Libburn Documentation Index</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> @section intro Introduction</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">Libburnia is an open-source project for reading, mastering and writing</span>
<a name="l00009"></a>00009 <span class="comment">optical discs. This page is about its capability to handle optical media.</span>
<a name="l00010"></a>00010 <span class="comment">For now this means CD-R, CD-RW, DVD-RAM, DVD+RW, DVD+R, DVD+R/DL, DVD-RW,</span>
<a name="l00011"></a>00011 <span class="comment">DVD-R, BD-R, BD-RE.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment">Not supported yet are DVD-R/DL. Testers wanted.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">Our scope is currently Linux 2.4 and 2.6, or FreeBSD . For ports to other</span>
<a name="l00016"></a>00016 <span class="comment">systems we would need : login on a development machine resp. a live OS on CD</span>
<a name="l00017"></a>00017 <span class="comment">or DVD, advise from a system person about the equivalent of Linux sg or FreeBSD</span>
<a name="l00018"></a>00018 <span class="comment">CAM, volunteers for testing of realistic use cases.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">libburn is the library by which preformatted data get onto optical media.</span>
<a name="l00021"></a>00021 <span class="comment">Its code is independent of cdrecord. Its DVD capabilities are learned from</span>
<a name="l00022"></a>00022 <span class="comment">studying the code of dvd+rw-tools and MMC-5 specs. No code but only the pure</span>
<a name="l00023"></a>00023 <span class="comment">SCSI knowledge has been taken from dvd+rw-tools, though.</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">cdrskin is a limited cdrecord compatibility wrapper for libburn.</span>
<a name="l00026"></a>00026 <span class="comment">cdrecord is a powerful GPL'ed burn program included in Joerg Schilling's</span>
<a name="l00027"></a>00027 <span class="comment">cdrtools. cdrskin strives to be a second source for the services traditionally</span>
<a name="l00028"></a>00028 <span class="comment">provided by cdrecord. Additionally it provides libburn's DVD/BD capabilities,</span>
<a name="l00029"></a>00029 <span class="comment">where only -sao is compatible with cdrecord.</span>
<a name="l00030"></a>00030 <span class="comment">cdrskin does not contain any bytes copied from cdrecord's sources.</span>
<a name="l00031"></a>00031 <span class="comment">Many bytes have been copied from the message output of cdrecord runs, though.</span>
<a name="l00032"></a>00032 <span class="comment">See cdrskin/README for more.</span>
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">The burn API example of libburn is named test/libburner.c . The API for media</span>
<a name="l00035"></a>00035 <span class="comment">information inquiry is demonstrated in test/telltoc.c .</span>
<a name="l00036"></a>00036 <span class="comment">Explore these examples if you look for inspiration.</span>
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">SONAME:</span>
<a name="l00039"></a>00039 <span class="comment">libburn.so.4 (since 0.3.4, March 2007),</span>
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> @section using Using libburn</span>
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">Our build system is based on autotools.</span>
<a name="l00045"></a>00045 <span class="comment">User experience tells us that you will need at least autotools version 1.7.</span>
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment">To build libburn and its companion applications go into its toplevel directory</span>
<a name="l00048"></a>00048 <span class="comment">and execute</span>
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">- ./bootstrap (needed if you downloaded from SVN)</span>
<a name="l00051"></a>00051 <span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment">- ./configure</span>
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment">- make</span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">To make the libraries accessible for running resp. developing applications </span>
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">- make install</span>
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">@section libburner Libburner</span>
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment">libburner is a minimal demo application for the library libburn </span>
<a name="l00064"></a>00064 <span class="comment">(see: libburn/libburn.h) as provided on http://libburnia-project.org .</span>
<a name="l00065"></a>00065 <span class="comment">It can list the available devices, can burn to recordable CD, DVD, or BD,</span>
<a name="l00066"></a>00066 <span class="comment">can blank a CD-RW or DVD-RW, and can format unformatted DVD-RW, BD-R, or BD-RE. </span>
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">It's main purpose, nevertheless, is to show you how to use libburn and also</span>
<a name="l00069"></a>00069 <span class="comment">to serve the libburnia team as reference application. libburner does indeed</span>
<a name="l00070"></a>00070 <span class="comment">define the standard way how above gestures can be implemented and stay upward</span>
<a name="l00071"></a>00071 <span class="comment">compatible for a good while.</span>
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> @subsection libburner-help Libburner --help</span>
<a name="l00074"></a>00074 <span class="comment"><pre></span>
<a name="l00075"></a>00075 <span class="comment">Usage: test/libburner</span>
<a name="l00076"></a>00076 <span class="comment"> [--drive <address>|<driveno>|"-"] [--audio]</span>
<a name="l00077"></a>00077 <span class="comment"> [--blank_fast|--blank_full|--format] [--try_to_simulate]</span>
<a name="l00078"></a>00078 <span class="comment"> [--multi] [<one or more imagefiles>|"-"]</span>
<a name="l00079"></a>00079 <span class="comment">Examples</span>
<a name="l00080"></a>00080 <span class="comment">A bus scan (needs rw-permissions to see a drive):</span>
<a name="l00081"></a>00081 <span class="comment"> test/libburner --drive -</span>
<a name="l00082"></a>00082 <span class="comment">Burn a file to drive chosen by number, leave appendable:</span>
<a name="l00083"></a>00083 <span class="comment"> test/libburner --drive 0 --multi my_image_file</span>
<a name="l00084"></a>00084 <span class="comment">Burn a file to drive chosen by persistent address, close:</span>
<a name="l00085"></a>00085 <span class="comment"> test/libburner --drive /dev/hdc my_image_file</span>
<a name="l00086"></a>00086 <span class="comment">Blank a used CD-RW (is combinable with burning in one run):</span>
<a name="l00087"></a>00087 <span class="comment"> test/libburner --drive /dev/hdc --blank_fast</span>
<a name="l00088"></a>00088 <span class="comment">Blank a used DVD-RW (is combinable with burning in one run):</span>
<a name="l00089"></a>00089 <span class="comment"> test/libburner --drive /dev/hdc --blank_full</span>
<a name="l00090"></a>00090 <span class="comment">Format a DVD-RW, BD-RE or BD-R:</span>
<a name="l00091"></a>00091 <span class="comment"> test/libburner --drive /dev/hdc --format</span>
<a name="l00092"></a>00092 <span class="comment">Burn two audio tracks (to CD only):</span>
<a name="l00093"></a>00093 <span class="comment"> lame --decode -t /path/to/track1.mp3 track1.cd</span>
<a name="l00094"></a>00094 <span class="comment"> test/dewav /path/to/track2.wav -o track2.cd</span>
<a name="l00095"></a>00095 <span class="comment"> test/libburner --drive /dev/hdc --audio track1.cd track2.cd</span>
<a name="l00096"></a>00096 <span class="comment">Burn a compressed afio archive on-the-fly:</span>
<a name="l00097"></a>00097 <span class="comment"> ( cd my_directory ; find . -print | afio -oZ - ) | \</span>
<a name="l00098"></a>00098 <span class="comment"> test/libburner --drive /dev/hdc -</span>
<a name="l00099"></a>00099 <span class="comment">To be read from *not mounted* media via: afio -tvZ /dev/hdc</span>
<a name="l00100"></a>00100 <span class="comment"></pre></span>
<a name="l00101"></a>00101 <span class="comment">libburner has two companions, telltoc and dewav, which help to perform some</span>
<a name="l00102"></a>00102 <span class="comment">peripheral tasks of burning.</span>
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment">telltoc prints a table of content (sessions, tracks and leadouts), it tells</span>
<a name="l00105"></a>00105 <span class="comment">about type and state of media, and also is able to provide the necessary</span>
<a name="l00106"></a>00106 <span class="comment">multi-session information for program mkisofs option -C. Especially helpful</span>
<a name="l00107"></a>00107 <span class="comment">are its predictions with "Write multi" and "Write modes" where availability</span>
<a name="l00108"></a>00108 <span class="comment">of "TAO" indicates that tracks of unpredicted length can be written.</span>
<a name="l00109"></a>00109 <span class="comment">See: test/telltoc --help.</span>
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment">dewav extracts raw byte-swapped audio data from files of format .wav (MS WAVE)</span>
<a name="l00112"></a>00112 <span class="comment">or .au (SUN Audio). See example in libburner --help.</span>
<a name="l00113"></a>00113 <span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment"> @subsection libburner-source Sourceode of libburner</span>
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment">Click on blue names of functions, structures, variables, etc in oder to</span>
<a name="l00117"></a>00117 <span class="comment">get to the according specs of libburn API or libburner sourcecode.</span>
<a name="l00118"></a>00118 <span class="comment"> </span>
<a name="l00119"></a>00119 <span class="comment">@include libburner.c</span>
<a name="l00120"></a>00120 <span class="comment">*/</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Sep 2009 for libburn by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
