Documentation

We believe that good documentation is an important part of the Dirac project. Documentation is organised under a number of categories; support, algorithm, code, tools and publications. An FAQ page is also included.

The aim is to make it as simple as possible for anyone who wishes to use this software or contribute to its development. We welcome feedback on our documentation.

Support

Readme

Instructions on how to build Dirac (part of the Dirac release).

plain text

Developer readme

Code standards and instructions for developers (part of the Dirac release).

plain text

To do list

List of known development to be carried out.

html

Bug tracker

List of bugs on SourceForge

html

Tests page

html

For further support see the forums.

top

Algorithm

Dirac fundamentals

Summarises the original compression algorithms employed in the Dirac video codec:

html | zip

A more detailed description, in relation to the software classes (incomplete -- the constant bit rate algorithm is missing):

dirac_software_alg0.2.pdf

top

Code

Programmer's guide

A brief walkthrough of the code from the perspective of a programmer new to the Dirac codec

html | pdf (152 KB) | zip

Code documentation

Documentation of the code produced by Doxygen

html | zip

top

Tools

Diagnostic tools

Instrumentation display of encoder decisions for diagnostics

html | pdf (1.85 MB) | zip

top

Publications

LinuxWorld expo

General documentation produced for the LinuxWorld expo event, 6-7 October 2004.

pdf (149 KB)

IBC

General documentation produced for the IBC demonstrations, September 2006.

pdf (470 kB)

General documentation produced for the IBC demonstrations, September 2007.

pdf (1.3 MB)

pdf (1.1 MB)

top