Changes between Version 3 and Version 4 of doc/app/img2video

Timestamp:

Oct 15, 2010 1:05:09 PM (15 years ago)

Author:

maronga

Comment:

--

doc/app/img2video

@@ -14 +14 @@
 1. Prepare a folder with your input files. \\e.g. “/localdata/dvrp/video” containing the files “image0000.tiff”  to “image3999.tiff” in TIFF format (as used by the DVRP software).
 
-2. Run img2video with at least the -i and -n parameter from command line, \\e.g. “./img2video -i /localdata/dvrp/video -n image”. Other parameters can be used as follows:\\[[#a|-a..]] [[#c|-c..]] [[#C|-C..]] [[#f|-f..]] [[#h|-h]] [[#i|-i..]] [[#k|-k]] [[#n|-n..]] [[#o|-o..]] [[#r|-r]] [[#R|-R]] [[#s|-s..]] [[#S|-S..]] [[#t|-t..]] [[#w|-w]] [[#X|-X]] \\
+2. Run img2video with at least the -i and -n parameter from command line, \\e.g. “./img2video -i /localdata/dvrp/video -n image”. You can get a short list of all parameters from command line typing “img2video ?”.\\\\Full list of parameters with description:\\[[#a|-a..]] [[#c|-c..]] [[#C|-C..]] [[#f|-f..]] [[#h|-h]] [[#i|-i..]] [[#k|-k]] [[#n|-n..]] [[#o|-o..]] [[#r|-r]] [[#R|-R]] [[#s|-s..]] [[#S|-S..]] [[#t|-t..]] [[#w|-w]] [[#X|-X]] \\
 ||='''Parameter Name'''  =||='''Default Value'''  =||='''Explanation'''  =||
 |----------------
@@ -197 +197 @@
 }}}
 
-You can get a short list of these parameters from command line typing “img2video ?”.
-
 3. When img2video is finished, check your output_path. If no error occurred, you will find your animation as well as a preview image. 
 
+== Notes ==
+
+The conversion of the original images (e.g. from TIFF) takes some time, especially when using animated gif. Thus, using the “-k” parameters should only be used with care, otherwise your JPEG files will be lost. Running img2video on the file system where your input files are located is the best choice. The output_path should be located on the same file system. This will speed up the conversion.\\
+\\
+The preview image might be helpful and is necessary for the web page presentation. It shows the last frame of the simulation.\\
+\\
+For the file conversion, the input files don't need to have file extensions (karman***** will work as good as karman*****.tiff), if the option "-t" was set properly.\\
+\\
+img2video uses cycle numbers if an video with the same filename already exists, e.g.  {{{cube_1acc_mpeg.avi -->  cube_1acc_mpeg_1.avi}}}.
+
+== Examples ==
+
+Example joblines for producing videos from images located in the folder “/localdata/dvrp/karman”, named “karman0000” to “karman3999”  might look like this:
+
+1. Standard settings for a mjpeg animation:\\{{{img2video -c mjpeg -i /localdata/dvrp/karman -n karman}}}
+
+2. Settings for an animated gif with a speed-up of factor 2:\\{{{img2video -c gif -i /localdata/dvrp/karman -n karman -S 2}}}
+
+3. Settings for an animated gif of a few EPS files (2 images per seconds displayed):\\{{{img2video -c gif -i /localdata/dvrp/karman -n karman -t "eps" -a 2}}}
+
+Example of the img2video shell interface\\{{{img2video -n "cube" -i /home/maronga/scripts/img2video/testfilm -c mpeg}}}\\\\
+{{{
+#--------------------------------------------------------------#
+| img2video  Rev: 1 $            Fri Jul 23 18:02:34 CEST 2010 |
+|                                                              |
+| Initialization parameters                                    |
+| Jobname:            cube                                     |
+| Input path:         /home/maronga/scripts/img2video/testfilm |
+| Output path:        /home/maronga/scripts/img2video/testfilm |
+|                     /cube                                    |
+| Video codec:        mpeg (msmpeg4v2)                         |
+| Input file type:    tiff                                     |
+| Video speed-up:     1                                        |
+| fps:                25                                       |
+| Scaling video to    1024px width                             |
+| Watermark           disabled                                 |
+| HQ-options:         disabled                                 |
+|                                                              |
+| Additional settings                                          |
+| - Image files will be stored at the end.                     |
+| - img2video will generate new images.                        |
+|                                                              |
+| Video will be saved as cube_1acc_mpeg.avi                    |
+|                                                              |
+#--------------------------------------------------------------#
+ *** Creating directory: /home/maronga/scripts/img2video/testfilm/
+     cube/images_jpg... done.
+ *** Outdated images will be deleted in /home/maronga/scripts/img2video/
+     testfilm/cube/images_jpg... done.
+ *** Converting images... done.
+ --> Converted 101 images.
+ *** Encoding video... done.
+ --> All actions finished. Video saved as /home/maronga/scripts/
+     img2video/testfilm/cube/cube_1acc_mpeg.avi.
+}}}