r.out.mpeg(1)		      Grass User's Manual		 r.out.mpeg(1)



NNAAMMEE
       rr..oouutt..mmppeegg - Raster File Series to MPEG Conversion Program

GGRRAASSSS VVEERRSSIIOONN
       4.x, 5.x

SSYYNNOOPPSSIISS
       rr..oouutt..mmppeegg

       rr..oouutt..mmppeegg hheellpp

       rr..oouutt..mmppeegg							 [--qqcc]
       vviieeww11==_n_a_m_e_[_,_n_a_m_e_,_._._._][vviieeww22==_n_a_m_e_[_,_n_a_m_e_,_._._._]][vviieeww33==_n_a_m_e_[_,_n_a_m_e_,_._._._]][vviieeww44==_n_a_m_e_[_,_n_a_m_e_,_._._._]]
       [oouuttppuutt==_n_a_m_e] [qquuaall==_v_a_l_u_e]

DDEESSCCRRIIPPTTIIOONN
       _r_._o_u_t_._m_p_e_g  is a tool for combining a series of GRASS raster files into
       a single MPEG-1 (Motion Pictures Expert Group) format file.  MPEG-1  is
       a  "lossy"  video  compression format, so the quality of each resulting
       frame of the animation will be much diminished from the original raster
       image.	The  resulting	output	file  may  then  be  viewed using your
       favorite mpeg-format viewing program.


       The user may define up to four  "views",  or  sub-windows,  to  animate
       simultaneously.	 e.g., View 1 could be rainfall, View 2 flooded areas,
       View 3 damage to bridges or levees, View 4 other economic  damage,  all
       animated as a time series. A black border 2 pixels wide is drawn around
       each view. There is an arbitrary limit of 100 files per view (100  ani-
       mation frames).	Temporary files are created in the conversion process,
       so lack of adequate tmp space could also limit the number of frames you
       are able to convert.


       The  environment  variable  GMPEG_SIZE is checked for a value to use as
       the dimension, in pixels, of the longest  dimension  of	the  animation
       image.	If  GMPEG_SIZE	is not set, the animation size defaults to the
       rows & columns in the current GRASS region, scaling if necessary  to  a
       default	minimum  size  of 200 and maximum of 500.  These size defaults
       are overridden when using the -c flag (see below).  The	resolution  of
       the  current  GRASS  region  is	maintained, independent of image size.
       Playback programs have to  decode  the  compressed  data  "on-the-fly",
       therefore  smaller  dimensioned	animations  will  provide higher frame
       rates and smoother animations.


       UNIX - style wild cards may be used with the command  line  version  in
       place of a raster file name, but it must be quoted.


       Example: _r_._o_u_t_._m_p_e_g _v_i_e_w_1_=_"_r_a_i_n_[_1_-_9_]_"_,_"_r_a_i_n_1_[_0_-_2_]_" _v_i_e_w_2_=_"_t_e_m_p_*_"


       If  the number of files differs for each view, the view with the fewest
       files will determine the number of frames in the animation.

OOPPTTIIOONNSS
   FFllaaggss::
       --qq     Quiet - suppress progress report.

       --cc     Convert "on the fly", uses less disk space  by  using  _r_._o_u_t_._p_p_m
	      with  stdout  option to convert frames as needed instead of con-
	      verting all frames to ppm before encoding.  Only use when encod-
	      ing  a  single view.  Use of this option also overrides any size
	      defaults, using the CURRENTLY DEFINED GRASS REGION for the  out-
	      put size. So be careful to set region to a reasonable size prior
	      to encoding.


   PPaarraammeetteerrss::
       vviieeww11  Raster file(s) for View1.

       vviieeww22  Raster file(s) for View2.

       vviieeww33  Raster file(s) for View3.

       vviieeww44  Raster file(s) for View4.

       oouuttppuutt Name for MPEG output file.  Default: gmovie.mpg

       qquuaall   Quality factor (1-5).  Default: 3

       A quality value of _q_u_a_l_=_1 will yield higher quality  images,  but  with
       less compression (larger MPEG file size).  Compression ratios will vary
       depending on the number of frames in the animation, but	an  MPEG  pro-
       duced  using _q_u_a_l_=_5 will usually be about 60% the size of the MPEG pro-
       duced using _q_u_a_l_=_1.

BBUUGGSS
       MPEG images must be 16-pixel aligned for successful compression, so  if
       the  rows  & columns of the calculated image size (scaled, with borders
       added) are not evenly divisible by 16, a few rows/columns will  be  cut
       off the bottom & right sides of the image. The MPEG format is optimized
       to recognize image MOTION, so abrupt changes from one frame to  another
       will cause a "noisy" encoding.

NNOOTTEESS
       This program requires the program _m_p_e_g___e_n_c_o_d_e:


       MPEG-1 Video Software Encoder

       (Version 1.3; March 14, 1994)


       Lawrence  A.  Rowe,  Kevin  Gong, Ketan Patel, and Dan Wallach Computer
       Science Division-EECS, Univ. of Calif. at Berkeley


       Available by anonymous ftp from: s2k-ftp.CS.Berkeley.EDU


       Use of the _-_c flag also requires the program _r_._o_u_t_._p_p_m with the	_s_t_d_o_u_t
       option.

AAUUTTHHOORR
       Bill Brown, U.S. Army Construction Engineering Research Laboratories

       _L_a_s_t _c_h_a_n_g_e_d_: _$_D_a_t_e_: _2_0_0_2_/_0_1_/_2_5 _0_5_:_4_5_:_3_4 _$



GRASS 5.0							 r.out.mpeg(1)
