Improved usage()
authorjmvalin <jmvalin@0101bb08-14d6-0310-b084-bc0e0c8e3800>
Sun, 30 Jun 2002 04:51:28 +0000 (04:51 +0000)
committerjmvalin <jmvalin@0101bb08-14d6-0310-b084-bc0e0c8e3800>
Sun, 30 Jun 2002 04:51:28 +0000 (04:51 +0000)
git-svn-id: http://svn.xiph.org/trunk/speex@3449 0101bb08-14d6-0310-b084-bc0e0c8e3800

src/speexdec.c
src/speexenc.c

index e3330f5..f569f0a 100644 (file)
@@ -102,12 +102,27 @@ FILE *out_file_open(char *outFile, int rate)
 
 void usage()
 {
-   fprintf (stderr, "speexenc [options] <input file> <output file>\n");
+
+   fprintf (stderr, "Speex decoder version " VERSION "\n");
+   fprintf (stderr, "\n");
+   fprintf (stderr, "usage: speexdec [options] input_file.spx\n");
+   fprintf (stderr, "       speexdec [options] input_file.spx output_file.wav\n");
+   fprintf (stderr, "\n");
+   fprintf (stderr, "input_file can be:\n");
+   fprintf (stderr, "  filename.spx          regular Speex file\n");
+   fprintf (stderr, "  -                     stdin\n");
+   fprintf (stderr, "\n");  
+   fprintf (stderr, "output_file can be:\n");
+   fprintf (stderr, "  filename.wav          wav file\n");
+   fprintf (stderr, "  filename.*            raw PCM file (any extension other that .wav)\n");
+   fprintf (stderr, "  -                     stdout\n");
+   fprintf (stderr, "  (nothing)             will be played to soundcard\n");
+   fprintf (stderr, "\n");  
    fprintf (stderr, "options:\n");
-   fprintf (stderr, "\t--help       -h      This help\n"); 
-   fprintf (stderr, "\t--version    -v      Version information\n"); 
-   fprintf (stderr, "\t--pf                 Enable post-filter\n"); 
-   fprintf (stderr, "\t--no-pf              Disable post-filter\n");
+   fprintf (stderr, "  --help       -h      This help\n");
+   fprintf (stderr, "  --version    -v      Version information\n");
+   fprintf (stderr, "  --pf                 Enable post-filter\n");
+   fprintf (stderr, "  --no-pf              Disable post-filter (default FOR NOW)\n");
 }
 
 void version()
index 24d846a..96cf203 100644 (file)
@@ -43,15 +43,29 @@ int oe_write_page(ogg_page *page, FILE *fp)
 
 void usage()
 {
-   fprintf (stderr, "speexenc [options] <input file> <output file>\n");
+   fprintf (stderr, "Speex encoder version " VERSION "\n");
+   fprintf (stderr, "\n");
+   fprintf (stderr, "usage: speexenc [options] input_file output_file\n");
+   fprintf (stderr, "\n");
+   fprintf (stderr, "input_file can be:\n");
+   fprintf (stderr, "  filename.wav          wav file\n");
+   fprintf (stderr, "  filename.*            raw PCM file (any extension other than .wav)\n");
+   fprintf (stderr, "  -                     stdin\n");
+   fprintf (stderr, "\n");  
+   fprintf (stderr, "output_file can be:\n");
+   fprintf (stderr, "  filename.spx          Speex file\n");
+   fprintf (stderr, "  -                     stdout\n");
+   fprintf (stderr, "\n");  
    fprintf (stderr, "options:\n");
-   fprintf (stderr, "\t--narrowband -n    Narrowband (8 kHz) input file\n"); 
-   fprintf (stderr, "\t--wideband   -w    Wideband (16 kHz) input file\n"); 
-   fprintf (stderr, "\t--quality n        Encoding quality setting from 0 to 10\n"); 
-   fprintf (stderr, "\t--lbr              Low bit-rate mode (equivalent to --quality 3)\n"); 
-   fprintf (stderr, "\t--help       -h    This help\n"); 
-   fprintf (stderr, "\t--version    -v    Version information\n"); 
-   fprintf (stderr, "\nInput must be raw audio (mono, no header), 16 bits or a mono wav file\n"); 
+   fprintf (stderr, "  --narrowband -n    Narrowband (8 kHz) input file\n"); 
+   fprintf (stderr, "  --wideband   -w    Wideband (16 kHz) input file\n"); 
+   fprintf (stderr, "  --quality n        Encoding quality setting from 0 to 10\n"); 
+   fprintf (stderr, "  --lbr              Low bit-rate mode (equivalent to --quality 3)\n"); 
+   fprintf (stderr, "  --help       -h    This help\n"); 
+   fprintf (stderr, "  --version    -v    Version information\n"); 
+   fprintf (stderr, "\n");  
+   fprintf (stderr, "Input must be mono\n"); 
+   fprintf (stderr, "Raw PCM needs to be 16-bit little-endian\n"); 
 }
 
 void version()