postfish/postfish.1

   1 .TH postfish 1 2004-05-29
   2 .SH NAME
   3 postfish \- a heavyweight, Gtk2-based live recording postprocessor
   4 .SH SYNOPSIS
   5 .B postfish
   6 .RB [ options ]
   7 .B infile
   8 .RB [ infile ]+
   9 .RB [ -g
  10 .B infile
  11 .RB [ infile ]+]+
  12 >
  13 .B output
  14
  15 .SH DESCRIPTION
  16
  17 the Postfish
  18 is a digital audio post-processing, restoration,
  19 filtering and mixdown tool.  It works as a linear audio filter, much
  20 like a rack of analog effects.  The first stage of the filter
  21 pipeline provides a bank of configurable per-channel processing
  22 filters for up to 32 input channels.  The second stage provides
  23 mixdown of the processed input audio into a group of up to eight
  24 output channels.  The third stage applies processing filters to the
  25 output group post-mixdown.
  26
  27 The Postfish is a stream filter; feed it audio from a list of files
  28 or input stream, and it renders audio to standard out, as well as
  29 optionally providing a configurable audio playback monitor via a
  30 sound device.  If the input audio is being taken from files,
  31 Postfish also provides simple forward/back/cue seeking and A-B
  32 looping control.
  33
  34 .SH OPTIONS
  35 .TP
  36 .B \-c --configuration-file
  37 load state from alternate configuration file
  38
  39 .TP
  40 .B \-g --group
  41 place following input files in a new channel grouping
  42
  43 .TP
  44 .B \-h --help
  45 print this help
  46
  47 .SH INPUT
  48
  49 Postfish takes WAV/AIFF input either from stdin or from a list of
  50 files specified on the command line.  A list of input files is handled
  51 as time-continguous entries, each holding audio data that continues at
  52 the instant the previous file ends.  Files may also be arranged into
  53 groups with -g; each group represents additional input channels
  54 parallel to preceeding groups. All input files must be the same
  55 sampling rate.  Files in a group must have the same number of
  56 channels.
  57
  58 .B Examples:
  59
  60 Files a.wav, b.wav, c.wav and d.wav are all four channels and
  61 ten minutes each.
  62
  63 .B postfish a.wav b.wav c.wav d.wav
  64
  65 This command line treats the input as forty minutes of four channel
  66 audio in the order a.wav, b.wav, c.wav, d.wav.
  67
  68 .B postfish a.wav b.wav \-g c.wav d.wav
  69
  70 This command line treats the input as twenty minutes of eight channel
  71 audio.  Channels 1-4 are taken from files a.wav and b.wav while channels
  72 5-8 are taken from files c.wav  and d.wav.
  73
  74 .B cat a.wav | postfish
  75
  76 This command line sends a.wav to Postfish as a non-seekable stream
  77 of four-channel data. If the WAV (or AIFF) header is complete, Postfish
  78 obeys the length encoded in the header and halts after processing to
  79 that length.  If the data length in the header is unset (0 or -1),
  80 Postfish will continue processing data until EOF on stdin.
  81
  82 .SH OUTPUT
  83
  84 Postfish writes output to stdout.
  85
  86 If stdout is piped, the output is nonseekable and Postfish marks the
  87 produced header incomplete (length of -1).  Stopping and re-starting
  88 processing writes a fresh stream to stdout.
  89
  90 If stdout is redirected to a file, Postfish will write a complete header
  91 upon processing halt or program exit.  If processing halts and restarts,
  92 the file is re-written from scratch.
  93
  94 If stdout is a pipe or redirected to a file, the user may specify
  95 parallel audio monitor through the audio device using the 'mOn' activator
  96 button in the main panel's 'master' section, or on the output config
  97 panel.  The audio device selected for playback is configurable on the
  98 output config panel.
  99
 100 If stdout is redirected to an audio device, output is sent to that audio
 101 device exclusively and the 'mOn' activator on the main panel will not
 102 be available.
 103
 104 .SH STATE/CONFIG
 105
 106 By default, persistent panel state is loaded from the file
 107 'postfish-staterc' in the current working directory.  Postfish rewrites
 108 this file with all current panel state upon exit.  -c specifies loading
 109 from and saving to an alternate configuration file name.
 110
 111 .SH BUGS
 112
 113 This is Postfish's first prerelease; none known but many certainly exist.
 114
 115 .SH AUTHORS
 116
 117 Monty <monty@xiph.org>