Modified the command line encoder and decoder to accept input from stdin and
[schroedinger-tools.git] / USAGE
blob0d065ccb0935b69939c807bca0c070ccb4341524
1 schro_encode
2 ============
4 schro_encode uses the schroedinger library to convert planar YUV files to
5 dirac encoded bytestreams.
7 USAGE : schro_encode [flags] input output
8 FLAG LIST : schro_encode --help
10 The command line flags can be of the following types
12 uint    Expects an unsigned integer numerical argument
13 int     Expects a signed integer numerical argument
14 double  Expects a floating point or integer numerical argument
15 string  Expects a string argument
16 bool    Expects a boolean argument, choose from [0|1|true|false|yes|no]
17 enum    Expects a string from the list given via --help.
18           A numerical index into the enumeration is accepted
20 There are four groups of flags given on the command line:
22 1) Input video format options
24 Input video format options are describe the format of the input video and are
25 used by the encoder to encode the video.
27 2) Video format metadata
29 Video format metadata is additional information about the input video which
30 is placed into the bitstream by the encoder. This metadata has no effect
31 on the encoding process, and is simply informative information that may
32 be used by a dirac decoder or subsequent display device.
34 3) Encoder parameters
36 Encoder parameters are extracted from the schroedinger library at runtime.
37 They expose all of the available encoder settings. The settings available
38 will depend upon the particular version of the schroedinger library in use. 
40 4) Other parameters
42 The Other parameters control the operation of the schro_encode program.
43 These parameters include the input and output file names.
45 schro_decode
46 ============
48 schro_decode uses the schroedinger library to convert dirac coded bytestreams
49 to planar YUV files.
51 USAGE : schro_decode [flags] input outputi
52 FLAGS :
54   --help                        Show help message
55   -v [ --verbose ]              Enable verbose decoding
56   --input arg           string  Dirac bitstream to decode
57   --output arg          string  YUV planar output file