upstream: 2:3d07b022a7df [aggregated changes for version 0.79.8]

This commit is contained in:
dvdisaster developers
2021-05-12 10:19:08 +02:00
committed by Stéphane Lesimple
parent eac7884373
commit 90b5ab6443
107 changed files with 300 additions and 684 deletions

Binary file not shown.

View File

@@ -35,12 +35,14 @@
\fancyfoot[LO]{created: \today}
\fancyfoot[RE]{\paperversion}
\input{../config/version.tex}
\begin{document}
\definecolor{lightblue}{RGB}{224,224,255}
\pagecolor{lightblue}
\title{The dvdisaster Reed-Solomon Codec specification}
\author{Carsten Gnörlich\\carsten@dvdisaster.org}
\author{The dvdisaster development team\\support@dvdisaster.org}
\date{}
\maketitle
\thispagestyle{empty}
@@ -59,7 +61,7 @@ Reed-Solomon codecs which are currently called RS01, RS02 and RS03.
The codecs create Reed-Solomon parity data to protect data stored on optical media.
Depending on the codec, parity data can either be stored in a separate file
or be integrated with the .iso image on the same medium.
See \url{http://dvdisaster.org} for additional resources on the dvdisaster project,
See \homepage for additional resources on the dvdisaster pro\-ject,
e.g. for the {\em orange manual} (manual.pdf) containing information for end users.
\end{abstract}
@@ -69,7 +71,7 @@ e.g. for the {\em orange manual} (manual.pdf) containing information for end use
dvdisaster developers and, when the final version has been crafted, as an implementation
guide for third party developers who wish to create and process dvdisaster error correction data.
It is {\bf neither intended nor suitable} as end-user documentation; for usage information
please refer to the online documentation at \url{http://dvdisaster.org}.
please refer to the online documentation at \homepage.
\bigskip
@@ -81,7 +83,8 @@ of programming in C is also assumed.
\vfill
\begin{center}
{\em
Copyright 2008-2015 Carsten Gnörlich.
Copyright 2008-2015 Carsten Gnörlich.\\
Copyright 2021 The dvdisaster development team.\\
Verbatim copying and distribution of this entire article is permitted in any medium,
provided this notice is preserved.}
\end{center}

View File

@@ -11,7 +11,7 @@ archclean: clean
single:
pdflatex manual
manual.pdf: preface.tex background.tex defect-reporting.tex howtos.tex manual.tex qa.tex burning-compatibility.tex download.tex local.tex overview.tex
manual.pdf: preface.tex background.tex defect-reporting.tex howtos.tex manual.tex qa.tex download.tex local.tex overview.tex
pdflatex manual
pdflatex manual
pdflatex manual

View File

@@ -1,196 +0,0 @@
\section{Burning software compatibility}
\label{burning-compatibility}
dvdisaster must be used in conjunction with a CD/DVD/BD writing suite (``burning program'')
in order to generate ISO images and to write augmented ISO image files. Unfortunately,
not all burning programs provide the required features to work with dvdisaster.
Some burning programs may even produce media and/or ISO images which can not be
used with dvdisaster.
\smallskip
For your convenience, the dvdisaster project has tested some free burning programs
available for GNU/Linux. Please note that this list will always be incomplete and
only be a snapshot of a certain program version. It is likely to be outdated when
you are reading this page. It is therefore recommended that you test your specific
burning program version by following the \tlnk{howto-compat-overview}{instructions} given
in the howto section.
\paragraph{Recommended software}\quad
\medskip
The dvdisaster project recommends either using the command line tools
listed below or using the K3B burning application (which is actually
a graphical wrapper around the command line tools).
\paragraph{Burning program compatibility table}\quad
\medskip
\newcommand{\tgrey}[1]{\cellcolor{dkgrey}#1}
\newcommand{\tturquoise}[1]{\cellcolor{turquoise}#1}
\newcommand{\tpink}[1]{\cellcolor{pink}#1}
\newcommand{\tblue}[1]{\cellcolor{dkblue}#1}
\newcommand{\tred}[1]{&\begin{minipage}{10mm}{\cellcolor{ltred}#1}\end{minipage}}
\newcommand{\tyellow}[1]{&\begin{minipage}{10mm}\cellcolor{ltyellow}{#1}\end{minipage}}
\newcommand{\ok}{&\cellcolor{ltgreen}OK}
\newcommand{\na}{&\cellcolor{ltgrey}n.a.}
\newcommand{\nt}{&\begin{minipage}{10mm}{not tested}\end{minipage}}
\begin{tabular}{|c|c|c|c|c|c|c|c|c|c|}
\hline
\tgrey{} & \tgrey{} & \tgrey{} & \tturquoise{Create} &
\multicolumn{3}{c|}{\tpink{Burning images}} & \multicolumn{3}{c|}{\tblue{Burning images}} \\
\tgrey{Program} & \tgrey{Version} & \tgrey{Testing} & \tturquoise{ISO/} &
\multicolumn{3}{c|}{\tpink{for error}} &
\multicolumn{3}{c|}{\tblue{with embedded}} \\
\tgrey{} & \tgrey{} & \tgrey{Date} & \tturquoise{UDF} &
\multicolumn{3}{c|}{\tpink{correction files}} &
\multicolumn{3}{c|}{\tblue{error correction}} \\
\cline{5-10}
\tgrey{} & \tgrey{} & \tgrey{} &\tturquoise{Image} &\tpink{CD} &\tpink{DVD} &\tpink{BD} &\tblue{CD} &\tblue{DVD} &\tblue{BD} \\
\hline
\multicolumn{10}{|c|}{\cellcolor{ltgrey}Command line tools} \\
\hline
genisoimage & 1.1.11 & Jul'14 \ok \na \na \na \na \na \na \\
\hline
wodim & 1.1.11 & Jul'14 \na \ok \ok \na \ok \ok \na \\
\hline
growisofs & 7.1 & Jul'14 \na \na \ok \ok \na \ok \ok \\
\hline
\multicolumn{10}{|c|}{\cellcolor{ltgrey}Tools with a graphical user interface} \\
\hline
brasero & 3.4.1 & Jul'14 \tred{no UDF$^{1)}$} \tyellow{avoid$^{2)}$} \ok \na \tyellow{avoid$^{2)}$} \ok \na \\
\hline
K3B & 2.0.2 & Jul'14 \ok \ok \ok \na \ok \ok \na \\
\hline
xfburn & 0.4.3 & Jul'14 \ok \tyellow{re-read only$^{3)}$} \tyellow{re-read only$^{3)}$} \na \tred{do not use$^{3)}$} \tred{do not use$^{3)}$} \na \\
\hline
\end{tabular}
\bigskip
\paragraph{Testing conditions and objectives}\quad
\medskip
Testing was done using Debian 7.5 (wheezy) on an amd64 machine.
Versions of the tested writing software are indicated in the table above.
\medskip
Evaluation of the burning software is done for the two major cases where
interoperability with dvdisaster is required:
\bigskip
a) Creating error correction files
\medskip
The burning program is used to assemble an ISO image from a selected set of files,
and to write a CD, DVD or BD disc from it. An \tlnk{howto-eccfile}{error correction file} will
be created to protect this medium.
\smallskip
There are two ways of obtaining the ISO image for creating the error correction file:
\begin{enumerate}
\item The burning program is used to create an ISO image which is stored on hard disk.
This image is used for burning the medium and for creating the error correction file.
If the writing software creates a medium which does not exactly match the image,
the resulting error correction file may be useless.
A respective \tlnk{howto-compat-file}{testing method} is described
in the ``Howtos'' section. An ``OK'' in the table above indicates that
this test has been passed. But you are strongly advised to
\tlnk{howto-compat-file}{do your own test} at least
once to make sure that you are working on the same versions and premises.
\smallskip
If it is not possible to use a pre-made ISO image for both writing the medium
and for creating the error correction file, the writing software is
rated ``Re-read only'' in the table. In that case, use the alternative
approach described below (topic 2).
\item The burning program is used to write a medium, either by using a
pre-made ISO image or by creating the image on-the-fly while writing
the medium. Afterwards, the pre-made ISO image is discarded. dvdisaster
is used to read back a new ISO image from the newly written medium. From
this newly created ISO image the error correction file is created. This
process should always work; if not, the respective burning software is
marked as being unusable in the table.
\end{enumerate}
\bigskip
b) Augmenting a medium with error correction data
\medskip
\tlnk{howto-augment-write-iso}{Creating a medium}
\tlnk{howto-augment}{with embedded error correction data} is comprised of
several sub tasks: First, the burning application converts a selection of files
into an ISO image stored on hard disk. dvdisaster augments the image residing
on the hard disk with error correction data. Then, the burning application
writes the augmented image to the CD, DVD or BD. The ISO image content or format
must not be altered during the writing process. Especially, the added error correction
sectors must not be removed and no padding sectors must be added to the image during
the writing process. The ``Howto'' section describes
\tlnk{howto-compat-augment}{a test for compatibility between
a writing software and dvdisaster}. An ``OK'' in the table above indicates that this
test has been passed; otherwise you can not use the respective software for writing
augmented images. You are strongly advised to \tlnk{howto-compat-augment}{do your own test} at
least once to make sure that you are working on the same versions
and premises even with software marked as compatible in the table above.
\bigskip
c) Creating ISO images
\medskip
In addition, the table indicates whether the burning application can convert
a selection of files into an ISO image and store that ISO image on hard disk
for further processing with dvdisaster.
\paragraph{Notes (why a certain software failed a test)}\quad
\medskip
$^{1)}${\bf brasero} can only create ISO images, not ISO/UDF. This is not
recommended for DVD-Video authoring and has the disadvantage that files
with sizes greater than 2GiB can not be used in a portable way (the tested
version can not use files larger than 2GiB at all even if it says otherwise).
\bigskip
$^{2)}${\bf brasero} does not support the ``disc at once'' writing strategy. This
creates two spurious unreadable sectors at the end of CD media. dvdisaster
can handle such media, but will issue a warning and requires a preferences
setting each time such media is processed.
\bigskip
$^{3)}${\bf xfburn} can not be used to write RS02/RS03 augmented images due to a
wrong implementation of padding sector handling. In a correct implementation,
a burning program would add 150 zero padding sectors to an image it has created
itself. However padding sectors must never be added to an image which was created
or manipulated by a foreign application, such as an image being augmented by dvdisaster.
This results in the image being read back with wrong checksums, and dvdisaster will
rightfully complain that the ``Image file is 150 sectors longer than expected.''.
Error correction files can - for the same reason - not be used when created from
the original image, but it is possible to re-read the image from the written
medium and create error correction files from that image.

View File

@@ -15,8 +15,8 @@ the \href{http://www.gnu.org/licenses/gpl-3.0.txt}{GNU General Public License v3
\bigskip
The dvdisaster developer site (\url{https://web.archive.org/web/20180428070843/http://dvdisaster.net}) contains
the latest source code releases for the FreeBSD, GNU/Linux and NetBSD
The dvdisaster developer site (\homepage) contains
source code releases for the FreeBSD, GNU/Linux and NetBSD
operating systems. These are mostly aimed at maintainers of binary packages for
the beforementioned platforms. As an end user you might find it more convenient
to install dvdisaster from the package system of your operating system bundle or
@@ -36,7 +36,7 @@ is optional; you can use dvdisaster directly from the build tree.
\paragraph{Hardware requirements}\quad
\begin{itemize}
\item x86, PowerPC or Sparc processor;
\item x86, ARM or PowerPC processor;
\item an up-to-date CD/DVD/BD drive with ATAPI, SATA or SCSI interface;
\item enough hard disk space for creating .iso images from processed media.
\end{itemize}
@@ -73,7 +73,7 @@ NetBSD & 6.1.5 \\
\medskip
Support for Windows and Mac OS has been ended
Support for Windows and Mac OS X has been ended
and is not planned to be resumed in the
future (see \tlnk{qa-discontinued-os}{QA item 2.4 for an explanation)}.
@@ -93,6 +93,13 @@ won't do, we have compiled the following list:
\smallskip
The dvdisaster project uses the following web site for supplying software downloads:
\begin{center}
\homepage
\end{center}
\begin{comment}
The dvdisaster project uses the following internet domains for publishing
its web sites and supplying software downloads:
@@ -106,6 +113,8 @@ dvdisaster.org
\end{center}
All domains are forwarded to the same site at dvdisaster.net.
\end{comment}
No other internet or download sites are run by the dvdisaster project.
\paragraph{No money or personal data required.}\quad

View File

@@ -2069,9 +2069,8 @@ want to re-invent medium writing in dvdisaster, as a lot of useful programs
have already been written for this task. You should however pick a writing
application which supports SAO/DAO (session at once / disc at once) writing
on CD media and does not modify ISO images supplied by third-party software
(like dvdisaster). Some common free burning programs for GNU/Linux have been
\tlnk{burning-compatibility}{evaluated in the burning software compatibility section}.
For a start try using the K3B burning program.
(like dvdisaster). Not all burning programs are \tlnk{howto-compat-overview}{compatible with dvdisaster}, so new programs should be
\tlnk{howto-compat-augment}{checked before using}. For a start we recommend the K3B burning program.
\bigskip
@@ -3625,14 +3624,6 @@ writing the error correction data to the medium. Make sure that your
writing software does \tlnk{howto-compat-augment}{correctly transfer the error correction data}
when using it with augmented images for the first time.
\end{itemize}
\smallskip
Please see also the \tlnk{burning-compatibility}{burning software compatibility list}. From time
to time the dvdisaster project evaluates some of the most popular burning
software for the GNU/Linux platform and summarizes the results there.
%\newpage
\subsubsection{Testing compatibility with CD/DVD/BD writing software for error correction files}
\label{howto-compat-file}
@@ -3646,6 +3637,8 @@ In order to save time you do the following:
\item You create the error correction file from the same image.
\end{enumerate}
\newpage
\paragraph{Possible incompatibility:} The writing software creates a medium which
does not exactly match the image. This might prevent the error correction from recovering
the medium contents when it becomes defective.

Binary file not shown.

View File

@@ -11,6 +11,7 @@
\usepackage{color}
\usepackage[table]{xcolor}
\usepackage{hyperref}
\usepackage{comment}
\marginsize{30mm}{20mm}{20mm}{20mm} % Seitenränder links, rechts, oben, unten
\parindent0em % Keine amerikanische Einrückung am Anfang von Paragraphen
@@ -40,7 +41,7 @@
\hypersetup{
pdftitle={dvdisaster User's Manual},
pdfauthor={Carsten Gnörlich},
pdfauthor={Written by the dvdisaster development team},
colorlinks=true,
linkcolor=linkblue,
citecolor=linkblue,
@@ -72,7 +73,7 @@
\definecolor{lightorange}{RGB}{255,224,150}
\pagecolor{lightorange}
\title{The dvdisaster User's Manual}
\author{Carsten Gnörlich\\carsten@dvdisaster.org}
\author{Written by the dvdisaster development team\\support@dvdisaster.org}
\date{}
\maketitle
\thispagestyle{empty}
@@ -92,7 +93,7 @@ for optical media such as CD, DVD and BD discs.
Use cases for creating ecc data, recovering defective media
using ecc data and for general maintenanance of optical
media are given.
See \url{http://dvdisaster.org} for additional resources on
See \homepage for additional resources on
the dvdisaster project, e.g. for the {\em blue} manual (codecs.pdf)
containing a formal specification of the error correction data format.
\end{abstract}
@@ -100,9 +101,10 @@ containing a formal specification of the error correction data format.
\vfill
\begin{center}
{\em
Copyright 2008-2018 Carsten Gnörlich.
Verbatim copying and distribution of this entire article is permitted in any medium,
provided this notice is preserved.}
Copyright 2008-2017 Carsten Gnörlich.\\
Copyright 2019-2021 The dvdisaster development team.\\
Verbatim copying and distribution of this entire article is permitted in
any medium, provided this notice is preserved.}
\end{center}
\newpage
@@ -131,9 +133,6 @@ provided this notice is preserved.}
\input{background}
\newpage
\input{burning-compatibility}
\newpage
\input{defect-reporting}
\label{LastPage}\label{missing}

View File

@@ -37,7 +37,7 @@ protected media, you're looking at the wrong place. Such functions are
outside the scope of dvdisaster's internal design and goals.
Contrary to some myths saying otherwise: dvdisaster contains
no hidden program fragments or switches for reading protected discs.
Check the source code for yourself if you don't trust me.
Check the source code for yourself if you don't trust us.
\subsection{How to use this manual}
@@ -79,9 +79,8 @@ and finally a few \tlnk{background-eccfile-storage}{hints for storing error corr
\smallskip
As not all optical disc burning software may be compatible with dvdisaster,
you might want to check
the \tlnk{burning-compatibility}{compatibility table} and the additional
information provided with it.
you might want to
the \tlnk{howto-compat-overview}{perform compatibility tests} before using it .
\smallskip

View File

@@ -1,6 +1,19 @@
\section*{Preface}
\markboth{Preface}{Preface}
\label{preface}
After the publishing of version 0.79.5, the project has been dormant for another half decade. As time has passed by, it is foreseeable that optical media will become extinct just like floppy discs did long ago. Still, it is important to preserve the contents of already existing optical media. Towards this end, we will maintain dvdisaster to keep it usable on current hardware and OS versions.
We do not plan for a rapid release cycle. Neither will many new features be introduduced like it was at the beginning of the project. Instead, we will strive to fill in the missing gaps left over from the still open RS03 release cycle. Afterwards, dvdisaster shall be kept sound and complete as long as optical media are still in use.
\bigskip
{\em -- -- The dvdisaster development team, Spring 2021}
\newpage
\section*{Preface for version 0.79.5}
Since the release of dvdisaster 0.79.3\footnote{Version 0.79.4 was never finished
and released.}, nearly five years have passed.
This was partly due to changed circumstances in its