[cig-commits] commit: Adding documentation for the Output Formats in glucifer.
Mercurial
hg at geodynamics.org
Mon Nov 24 11:29:34 PST 2008
changeset: 76:f464044cb7c7
user: RobertTurnbull
date: Fri Aug 29 04:28:46 2008 +0000
files: OutputFormats/src/EncoderLibavcodec.meta OutputFormats/src/EncoderLibfame.meta OutputFormats/src/OutputJPEG.meta OutputFormats/src/OutputPNG.meta OutputFormats/src/OutputPPM.meta OutputFormats/src/OutputTIFF.meta
description:
Adding documentation for the Output Formats in glucifer.
diff -r bacc24c8e298 -r f464044cb7c7 OutputFormats/src/EncoderLibavcodec.meta
--- a/OutputFormats/src/EncoderLibavcodec.meta Wed Aug 27 05:33:31 2008 +0000
+++ b/OutputFormats/src/EncoderLibavcodec.meta Fri Aug 29 04:28:46 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucEncoderLibavcodec</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/OutputFormats/src/</param>
@@ -11,9 +11,9 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOutputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://ffmpeg.mplayerhq.hu/</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Encodes the output of a lucRenderingEngine into an MPEG movie.</param>
<!--Now the interesting stuff-->
@@ -22,46 +22,46 @@
<struct>
<param name="Name">codec</param>
<param name="Type">String</param>
- <param name="Default">"mpeg1video"</param>
- <param name="Description">...</param>
+ <param name="Default">mpeg1video</param>
+ <param name="Description">The encoding codec to use. For a full list see: http://www.mplayerhq.hu/DOCS/HTML/en/menc-feat-enc-libavcodec.html</param>
</struct>
<struct>
<param name="Name">frameRate</param>
<param name="Type">UnsignedInt</param>
<param name="Default">25</param>
- <param name="Description">...</param>
+ <param name="Description">How many frames in the movie for second.</param>
</struct>
<struct>
<param name="Name">bitRate</param>
<param name="Type">UnsignedInt</param>
- <param name="Default">400000 )</param>
- <param name="Description">...</param>
+ <param name="Default">400000</param>
+ <param name="Description">The quality of the encoded movie.</param>
+ </struct>
+ <struct>
+ <param name="Name">includeFrame0</param>
+ <param name="Type">Bool</param>
+ <param name="Default">False</param>
+ <param name="Description">Whether or not to include the initial frame at timestep 0.</param>
</struct>
</list>
<list name="Dependencies">
+
<struct>
<param name="Essential">True</param>
<param name="Name">Window</param>
<param name="Type">lucWindow</param>
- <param name="Description">...</param>
+ <param name="Description">The window to encode into a movie.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 207 of the c file and then remove this comment afterwards -->
-
- <struct>
- <param name="Essential">True</param>
- <param name="Name">context</param>
- <param name="Type">AbstractContext</param>
- <param name="Description">...</param>
- </struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 208 of the c file and then remove this comment afterwards -->
-
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="movie">
+ <param name="Type">lucEncoderLibavcodec</param>
+ <param name="Window">window</param>
+ </struct>
+</param>
</StGermainData>
diff -r bacc24c8e298 -r f464044cb7c7 OutputFormats/src/EncoderLibfame.meta
--- a/OutputFormats/src/EncoderLibfame.meta Wed Aug 27 05:33:31 2008 +0000
+++ b/OutputFormats/src/EncoderLibfame.meta Fri Aug 29 04:28:46 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucEncoderLibfame</param>
-<param name="Author">...</param>
+<param name="Author">Greg Watson</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/OutputFormats/src/</param>
@@ -11,37 +11,41 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOutputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://fame.sourceforge.net/</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Encodes the output of a lucRenderingEngine into an MPEG movie.</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
<struct>
<param name="Name">keyframe</param>
<param name="Type">UnsignedInt</param>
<param name="Default">4</param>
- <param name="Description">...</param>
+ <param name="Description">How often there is an intra-coded (JPEG-like) Key Frame compared to the general motion compressed frames. The smaller the number, the more frequent the Key Frames.</param>
</struct>
<struct>
<param name="Name">quality</param>
<param name="Type">UnsignedInt</param>
<param name="Default">93</param>
- <param name="Description">...</param>
+ <param name="Description">A percentage which controls compression verses quality.</param>
</struct>
<struct>
<param name="Name">framesPerSecond</param>
<param name="Type">UnsignedInt</param>
<param name="Default">30</param>
- <param name="Description">...</param>
+ <param name="Description">How many frames in the movie for second.</param>
</struct>
<struct>
<param name="Name">profile</param>
<param name="Type">String</param>
- <param name="Default">"profile/mpeg1" )</param>
- <param name="Description">...</param>
+ <param name="Default">"profile/mpeg1"</param>
+ <param name="Description">Encoding profile. Options are "profile/mpeg1" and "profile/mpeg4".</param>
+ </struct>
+ <struct>
+ <param name="Name">includeFrame0</param>
+ <param name="Type">Bool</param>
+ <param name="Default">False</param>
+ <param name="Description">Whether or not to include the initial frame at timestep 0.</param>
</struct>
</list>
@@ -51,23 +55,15 @@
<param name="Essential">True</param>
<param name="Name">Window</param>
<param name="Type">lucWindow</param>
- <param name="Description">...</param>
+ <param name="Description">The window to encode into a movie.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 211 of the c file and then remove this comment afterwards -->
-
- <struct>
- <param name="Essential">True</param>
- <param name="Name">context</param>
- <param name="Type">AbstractContext</param>
- <param name="Description">...</param>
- </struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 212 of the c file and then remove this comment afterwards -->
-
-
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="movie">
+ <param name="Type">lucEncoderLibfame</param>
+ <param name="Window">window</param>
+ </struct>
+</param>
</StGermainData>
diff -r bacc24c8e298 -r f464044cb7c7 OutputFormats/src/OutputJPEG.meta
--- a/OutputFormats/src/OutputJPEG.meta Wed Aug 27 05:33:31 2008 +0000
+++ b/OutputFormats/src/OutputJPEG.meta Fri Aug 29 04:28:46 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucOutputJPEG</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/OutputFormats/src/</param>
@@ -11,27 +11,29 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOutputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://www.jpeg.org/</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Outputs an image rendered in a lucRenderingEngine as a JPEG. Only is compiled if libjpeg is installed.</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
<struct>
<param name="Name">quality</param>
<param name="Type">Int</param>
- <param name="Default">93 )</param>
- <param name="Description">...</param>
+ <param name="Default">93</param>
+ <param name="Description">The quality setting of the encoder. A percentage.</param>
</struct>
</list>
<list name="Dependencies">
-
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="imageOutput">
+ <param name="Type">lucOutputJPEG</param>
+ <param name="quality">90</param>
+ </struct>
+</param>
</StGermainData>
diff -r bacc24c8e298 -r f464044cb7c7 OutputFormats/src/OutputPNG.meta
--- a/OutputFormats/src/OutputPNG.meta Wed Aug 27 05:33:31 2008 +0000
+++ b/OutputFormats/src/OutputPNG.meta Fri Aug 29 04:28:46 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucOutputPNG</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/OutputFormats/src/</param>
@@ -11,9 +11,9 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOutputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://www.libpng.org/pub/png/</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Outputs an image rendered in a lucRenderingEngine as a compressed PNG. Only is compiled if libpng is installed.</param>
<!--Now the interesting stuff-->
@@ -26,6 +26,10 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="imageOutput">
+ <param name="Type">lucOutputPNG</param>
+ </struct>
+</param>
</StGermainData>
diff -r bacc24c8e298 -r f464044cb7c7 OutputFormats/src/OutputPPM.meta
--- a/OutputFormats/src/OutputPPM.meta Wed Aug 27 05:33:31 2008 +0000
+++ b/OutputFormats/src/OutputPPM.meta Fri Aug 29 04:28:46 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucOutputPPM</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/OutputFormats/src/</param>
@@ -11,9 +11,9 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOutputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://netpbm.sourceforge.net/doc/ppm.html</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Outputs an image rendered in a lucRenderingEngine as a PPM. PPM is a very basic image format without any compression.</param>
<!--Now the interesting stuff-->
@@ -26,6 +26,10 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="imageOutput">
+ <param name="Type">lucOutputPPM</param>
+ </struct>
+</param>
</StGermainData>
diff -r bacc24c8e298 -r f464044cb7c7 OutputFormats/src/OutputTIFF.meta
--- a/OutputFormats/src/OutputTIFF.meta Wed Aug 27 05:33:31 2008 +0000
+++ b/OutputFormats/src/OutputTIFF.meta Fri Aug 29 04:28:46 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucOutputTIFF</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/OutputFormats/src/</param>
@@ -11,21 +11,22 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOutputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://www.remotesensing.org/libtiff/</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Outputs an image rendered in a lucRenderingEngine as a TIFF. This component is only compiled if you have libtiff installed.</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
-
</list>
<list name="Dependencies">
+</list>
-</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="imageOutput">
+ <param name="Type">lucOutputTIFF</param>
+ </struct>
+</param>
</StGermainData>
More information about the CIG-COMMITS
mailing list