dirac banner 
      logo
Navigation item arrowHome
Navigation item arrowThomas's Blog
Navigation item arrowFAQ
Navigation item arrowSpecification
Navigation item arrowSchrodinger
Navigation item arrow Documentation
Navigation item 
                arrowSupport
Navigation item 
                arrowAlgorithm
Navigation item 
                arrowCode
Navigation item 
                arrowTools
Navigation item 
                arrowPublications
Navigation item arrowlicences
Navigation item arrowGetting involved
Navigation item arrowContact us
Navigation item
                arrowSourceforge
Navigation item
                arrowProject page
Navigation item 
                arrowDownload
Navigation item
                arrowBrowse CVS
Navigation item
                arrowForums
SourceForge.net Logo
Valid XHTML 1.1!

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

Horizontal rule

Readme

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

TEXT plain text

Developer readme

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

TEXTplain text

To do list

List of known development to be carried out.

HTML html

Bug tracker

List of bugs on SourceForge

HTML html

Tests page

HTML html

For further support see the forums.

Arrow
                  uptop

Algorithm Horizontal rule

Dirac fundamentals

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

HTMLhtml | ZIPzip

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

PDFdirac_software_alg0.2.pdf

Arrow
                  uptop

Code

Horizontal rule

Programmer's guide

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

HTMLhtml | PDFpdf (152 KB) | ZIPzip

Code documentation

Documentation of the code produced by Doxygen

HTMLhtml | ZIPzip

Arrow
                  uptop

Tools Horizontal rule

Diagnostic tools

Instrumentation display of encoder decisions for diagnostics

HTMLhtml | PDFpdf (1.85 MB) | ZIPzip

Arrow
                  uptop

Publications

Horizontal rule

LinuxWorld expo

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

PDFpdf (149 KB)

IBC

General documentation produced for the IBC demonstrations, September 2006.

PDFpdf (470 kB)

General documentation produced for the IBC demonstrations, September 2007.

PDFpdf (1.3 MB)

PDFpdf (1.1 MB)

Arrow
                  uptop