[Dirac-commits] soc_javadec_luis INSTALL, NONE, 1.1 README, NONE, 1.1 README.txt, 1.6, NONE

[Luis F. S. M. <lui...@us...>]

Update of /cvsroot/dirac/soc_javadec_luis
In directory sc8-pr-cvs12.sourceforge.net:/tmp/cvs-serv23865

Added Files:
	INSTALL README 
Removed Files:
	README.txt 
Log Message:
some small cosmetic stuff



--- NEW FILE: README ---
README for Google Summer of Code 2006 project by Luis Felipe Strano Moraes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Introduction
~~~~~~~~~~~~~~~

This project is a Dirac decoder written in Java. It was implemented from scratch
using the Dirac specification as reference. 


2. Building and installing
~~~~~~~~~~~~~~~~~~~~~~~~~~

In order to run it, all that's needed so far is Sun's JDK 5.0 (it might not work
with previous versions, but only because of minor syntatic issues, nothing big)
and Ant (http://ant.apache.org) installed.
Tests will also be made with GCJ as soon as possible.
In order to compile it, just run :
	$ ant
	
There is no installation script as of this time.

3. Usage
~~~~~~~~

To test it directly, just put a dirac video with the filename test.drc
on the root directory of the project and run :
	$ ant test

Otherwise, the program can be called on an arbitrary file in the following way :
	$ java main/Main <file.drc>
	
4. Source Code
~~~~~~~~~~~~~~

The source code is spread amongst the following directories :

debug) contains only the Debug class that is used statically during the decoding process to print messages to the user

decoder) this is where the action takes place (tough I'm seriously considering moving some of this stuff outside, mainly
		 the byteio stuff). There is an enumeration called Status to describe where in the decoding process we currently
		 are, and two classes : ByteIO which is responsible for all of the low-level operations on the input stream, and
		 Decoder which has basically everything else (this class will be broken in several others in the near future)

frame) the Frame class is the class where all of the data that is being parsed about a frame is stored, and contains
	   methods that initialize it's variables according to the defaults described on the Dirac documentation. There is 
	   another class on this directory called Data that is (for C programmers basically a struct and is) used by Frame

main) the Main class is responsible for the interaction with the user (not that there is much of that right now) and 
	  for starting the decoding process

I've tried to follow the naming conventions used on the Dirac documentation for the methods and variables used in the code.

5. Documentation
~~~~~~~~~~~~~~~~

For now, all of the documentation is the code itself. If you would like to generate html from the javadoc comments,
you can use ant :
	$ ant doc
	
The generated HTML files will then be available inside of the doc/ directory.

6. Contact
~~~~~~~~~~

I can be reached by e-mail or instant messaging on the following places :

e-mail : lui...@gm...
jabber : lui...@ja...
icq : 45249786

Dirac ftw
--- NEW FILE: INSTALL ---
There's no real installation right now, see the README file.

--- README.txt DELETED ---