updated/corrected documentation
authorkramm <kramm>
Fri, 6 Feb 2004 16:44:01 +0000 (16:44 +0000)
committerkramm <kramm>
Fri, 6 Feb 2004 16:44:01 +0000 (16:44 +0000)
avi2swf/avi2swf.1
avi2swf/avi2swf.cc

index 86e0465..87a6a5a 100644 (file)
@@ -1,42 +1,52 @@
-.TH avi2swf "1" "January 2003" "avi2swf" "swftools"
+.TH avi2swf "1" "February 2004" "avi2swf" "swftools"
 .SH NAME
 .SH NAME
-avi2swf - convert AVI files into SWF
+avi2swf - Converts an avi video file to SWF.
+
 .SH Synopsis
 .SH Synopsis
-.B avi2swf
-[\fIoptions\fR] \fIfile.avi\fR [-o \fIfile.swf\fR]
+.B avi2swf file.avi [-o output.swf]
+
 .SH DESCRIPTION
 .SH DESCRIPTION
-This tools converts AVI Video files into Flash SWF Animation
-files.
+Converts an AVI video file to SWF.
+.PP
+From Version 6 on, SWF supports h.263 video rendering. This tool generates,
+among some other formats (see below), SWF movies which contain such h.263 video 
+from AVI files.
+
 .SH OPTIONS
 .TP
 .SH OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
-Print short help message and exit
+\fB\-h\fR, \fB\-\-help\fR 
+    Print help and exit
 .TP
 .TP
-\fB\-V\fR, \fB\-\-version\fR
-Print version info and exit
+\fB\-o\fR, \fB\-\-output\fR filename
+    Specify output filename
 .TP
 .TP
-\fB\-v\fR, \fB\-\-verbose\fR
-Be verbose. Use more than one -v for greater effect.
+\fB\-A\fR, \fB\-\-adjust\fR seconds
+    Audio adjust: Shift sound -seconds to the future or +seconds into the past.
 .TP
 .TP
-\fB\-o\fR \fIfilename\fR, \fB\-\-output\fR \fIfilename\fR
-Set output filename to \fIfilename\fR.
+\fB\-n\fR, \fB\-\-num\fR frames
+    Number of frames to encode
 .TP
 .TP
-\fB\-p\fR, \fB\-\-flip\fR
-Turn the movie upside down.
+\fB\-m\fR, \fB\-\-mp3-bitrate\fR \fIrate\fR (kbps)
+    Set the mp3 bitrate to encode audio with
 .TP
 .TP
-\fB\-x\fR, \fB\-\-extragood\fR
-Enable highest-quality encoding. Warning: This is slow!
+\fB\-r\fR, \fB\-\-mp3-samplerate\fR \fIrate\fR (Hz)
+    Set the mp3 samplerate to encode audio with (default: 11025)
 .TP
 .TP
-\fB\-S\fR \fIn\fR, \fB\-\-skip \fIn\fR\fR
-Skip \fIn\fR frames before starting to encode.
+\fB\-d\fR, \fB\-\-scale\fR \fIval\fR
+    Scale down to factor \fIval\fR. (in %%, e.g. 100 = original size)
 .TP
 .TP
-\fB\-s\fR \fIfactor\fR, \fB\-\-scale \fIfactor\fR\fR
-Scale movie by factor%. factor must be in the range 1-100.
+\fB\-p\fR, \fB\-\-flip\fR 
+    Turn movie upside down
 .TP
 .TP
-\fB\-q\fR \fIq\fR, \fB\-\-quality\fR \fIq\fR
-Set the compression quality to \fIq\fR. \fIq\fR must be
-in the range 1-100. (1=worst, 100=best).
-
-.SH AUTHOR
-
-Matthias Kramm <kramm@quiss.org>
+\fB\-q\fR, \fB\-\-quality\fR \fIval\fR
+    Set the quality to \fIval\fR. (0-100, 0=worst, 100=best, default:80)
+.TP
+\fB\-x\fR, \fB\-\-extragood\fR 
+    Enable some \fIvery\fR expensive compression strategies. You may
+    want to let this run overnight.
+.TP
+\fB\-T\fR, \fB\-\-flashversion\fR \fIn\fR
+    used for n >= 6.
+.TP
+\fB\-V\fR, \fB\-\-version\fR 
+    Print program version and exit
index d0fd823..48dc921 100644 (file)
@@ -74,21 +74,20 @@ static float audio_adjust = 0;
 static int mp3_bitrate = 32;
 static int samplerate = 11025;
 
 static int mp3_bitrate = 32;
 static int samplerate = 11025;
 
-struct options_t options[] =
-{
- {"v","verbose"},
- {"A","adjust"},
- {"o","output"},
- {"p","flip"},
- {"m","mp3-bitrate"},
- {"r","mp3-samplerate"},
- {"q","quality"},
- {"s","scale"},
- {"S","skip"},
- {"x","extragood"},
- {"T","flashversion"},
- {"V","version"},
- {0,0}
+static struct options_t options[] = {
+{"h", "help"},
+{"o", "output"},
+{"A", "adjust"},
+{"n", "num"},
+{"m", "mp3-bitrate"},
+{"r", "mp3-samplerate"},
+{"d", "scale"},
+{"p", "flip"},
+{"q", "quality"},
+{"x", "extragood"},
+{"T", "flashversion"},
+{"V", "version"},
+{0,0}
 };
 
 int args_callback_option(char*name,char*val)
 };
 
 int args_callback_option(char*name,char*val)
@@ -167,24 +166,24 @@ int args_callback_longoption(char*name,char*val)
 {
     return args_long2shortoption(options, name, val);
 }
 {
     return args_long2shortoption(options, name, val);
 }
-void args_callback_usage(char*name)
-{    
-    printf("\nUsage: %s file.avi\n", name);
-    printf("\t-h , --help\t\t Print help and exit\n");
-    printf("\t-o , --output filename\t Specify output filename\n"); 
-    printf("\t-A , --adjust seconds\t Audio adjust: Shift sound -seconds to the future or +seconds into the past.\n"); 
-    printf("\t-n , --num frames\t Number of frames to encode\n");
-    printf("\t-m , --mp3-bitrate <rate> (kbps)\t Set the mp3 bitrate to encode audio with\n");
-    printf("\t-r , --mp3-samplerate <rate> (Hz)\t Set the mp3 samplerate to encode audio with (default: 11025)\n");
-    printf("\t-d , --scale <val>\t Scale down to factor <val>. (in %, e.g. 100 = original size)\n");
-    printf("\t-p , --flip\t\t Turn movie upside down\n");
-    printf("\t-q , --quality <val>\t Set the quality to <val>. (0-100, 0=worst, 100=best, default:80)\n");
-    printf("\t-x , --extragood\t Enable some *very* expensive compression strategies. You may\n");
-    printf("\t                \t want to let this run overnight.\n");
-    printf("\t-T , --flashversion <n>\t Set output flash version to <n>. Notice: H.263 compression will only be\n");
-    printf("\t                       \t used for n >= 6.\n");
-    printf("\t-V , --version\t\t Print program version and exit\n");
-    exit(0);
+void args_callback_usage(char *name)
+{
+    printf("\n");
+    printf("Usage: %s file.avi [-o output.swf]\n", name);
+    printf("\n");
+    printf("-h , --help                    Print help and exit\n");
+    printf("-o , --output filename         Specify output filename\n");
+    printf("-A , --adjust seconds          Audio adjust: Shift sound -seconds to the future or +seconds into the past.\n");
+    printf("-n , --num frames              Number of frames to encode\n");
+    printf("-m , --mp3-bitrate <rate> (kbps)    Set the mp3 bitrate to encode audio with\n");
+    printf("-r , --mp3-samplerate <rate> (Hz)    Set the mp3 samplerate to encode audio with (default: 11025)\n");
+    printf("-d , --scale <val>             Scale down to factor <val>. (in %, e.g. 100 = original size)\n");
+    printf("-p , --flip                    Turn movie upside down\n");
+    printf("-q , --quality <val>           Set the quality to <val>. (0-100, 0=worst, 100=best, default:80)\n");
+    printf("-x , --extragood               Enable some *very* expensive compression strategies.\n");
+    printf("-T , --flashversion <n>        Set output flash version to <n>. Notice: H.263 compression will only be\n");
+    printf("-V , --version                 Print program version and exit\n");
+    printf("\n");
 }
 int args_callback_command(char*name,char*val)
 {
 }
 int args_callback_command(char*name,char*val)
 {