Set the cut path properly when a non-default output path is specified
[atscap.git] / atscut.1
blobc1a851458cfb632262d916b631d047ddc891b774
1 .TH atscut 1 "2007-Dec-07" "atscut-1.1.6" "(C) 2004-2007 inkling@users.sourceforge.net"
2 .SH NAME
3 .B atscut \- ATSC Transport Stream Container UTility
5 .SH SYNOPSIS
6 .PP
7 .B atscut infile
8 .IP
9 .B [-fghnqs]
10 .br
11 .B [-p outpath]
12 .br
13 .B [-o outbase]
14 .br
15 .B [-e pgmnum]
16 .br
17 .B [-k pid]
18 .br
19 .B [-y pid]
20 .br
21 .B [-r pmtfile]
22 .br
23 .B [-d num]
24 .br
26 .SH DESCRIPTION
27 .PP
28 This manual page describes the options for
29 .B atscut,
30 a tool for analyzing packets in
31 North American ATSC broadcast transport streams.
33 .SH RUNNING WITHOUT OPTIONS
34 Defaults generate a report of
35 .B infile
36 with stream counts and errors.
38 .SH OPTIONS WITHOUT PARAMETERS
39 These options allow user to select output methods.
40 .TP
41 .B \-f
42 Forge PAT + PMT to one video + one audio. See
43 .B -e
45 .TP
46 .B \-g
47 EPG Guide dump at end of processing. See
48 .B -q
49 and
50 .B BUGS
52 .TP
53 .B \-h
54 Help. May be more up-to-date than this manual page.
56 .TP
57 .B \-n
58 NULLs: keeps the bitrate same as source file.
60 .TP
61 .B \-q
62 Quiet, redux stdout to only version changes + PES.
64 .TP
65 .B \-s
66 Generate frame/sequence .tsx files for xtscut.
67 .IP
68 This requires single VC capture or extract to work. Use
69 .B atscap -m
70 option to generate .tsx files during single program capture.
71 You can also use
72 .B atscut -e
73 to extract a single program stream before using
74 .B atscut -s.
76 .SH OPTIONS WITH PARAMETERS
77 These options allow user to supply output parameters.
78 .PP
79 Packet extraction control (PIDs are given in hexadecimal):
80 .TP
81 .B \-p outpath
82 Output path. Default is ./
84 .TP
85 .B \-o outbase
86 Use this output basename instead of basename from input.
88 .TP
89 .B \-d int
90 Duty cycle %, e.g. -d95. Default 100, no sleeping.
91 Lower CPU usage prevents interference with capture program.
93 .TP
94 .B \-e pgm
95 Extract single Program number pgm from multiplex capture.
96 .IP
97 Program numbers are 1-65534, not 0 or 65535. A multiplex capture the
98 same as Full capture mode in atscap. It gets the entire stream. If
99 there are multiple Video and Audio streams, like most cable stations
100 and broadcast stations with secondary Virtual Channels, the full
101 capture will not work with
102 .B Xtscut.
104 .B atscut
105 can use the full multiplex stream to extract ATSC information, including
106 the EPG and other useful ATSC information. The MPEG multiplex information
107 can also be inspected with
108 .B atscut.
110 This option is used to extract a single program from from all the noise
111 so you can do further processing with
112 .B atscut
113 or perhaps do some cutting on the stream with
114 .B Xtscut.
115 The extract is in the same Transport Stream format as the source material.
118 .B \-y pid
119 Extracts Video ES from Transport Stream PID.
121 It still has some non-video junk like PES header 1E0, User Private Stream
122 header 1B2, and maybe others depending on the source material. The output
123 will work with mpeg2dec, and it should also work with
124 .B Xtscut.
126 This option is considered
127 .B EXPERIMENTAL
128 since the output has no audio and Xine does not like to play it with the
129 above mentioned junk start codes in the stream.
132 .B \-k pid
133 Keep this hexadecimal
134 .B PID (Packet ID)
135 and save to outbase.
137 Output filename is input with -pid inserted before .ts.
139 You may specify multiple -k's options to get more than one hexadecimal 
140 .B pid.
143 .B -k mgt
144 will keep ATSC PSIP packets for debug,
145 but requires full stream capture via
146 .B atscap
147 or other tools for raw ATSC data. EPG or capture problems
148 can be solved by looking at this data.
150 .SH OPTIONS FOR DEBUGGING
152 .B \-r patfile
153 Replace Progam Association PID 0000 with 188 bytes from
154 .B patfile.
155 You shouldn't have to use this unless your station is really out of spec,
156 or your source material is is poorly constructed.
158 .SH OPTIONS FOR VERBOSITY
160 Default is to give summary counts at EOF because video/audio errors
161 become more interesting, after understanding the ATSC PSIP bugs.
163 You may specify these options multiple times, too.
166 .B \-v num
167 Verbose bits, global enables: see -m -a
168  1:PKT   2:ATSC 4:MPEG   8: SYN
170 16:PSI0 32:xxx 64:xxx  128:xxxx
173 .B \-m num
174 MPEG detail level bits:
175  1:PAT  2:PMT  4:AUD   8:VID
177 16:SMB 32:PAY 64:PCR 128:IPB
180 .B \-a num
181 ATSC detail level bits (only for full streams):
182  1:MGT  2:VCT  4:EIT   8:ETT
184 16:RRT 32:PAY 64:STT 128:CVCT
187 .SH BUGS/LIMITATIONS
189 Some
190 .B -g
191 EPG output is missing when using
192 .B -q
193 option because EIT/ETT version chicken-and-egg. Don't use -q with -g.
194 -g may disable -q in later versions to cause further user confusion.
196 .SH SEE ALSO
197 atscap(1), xtscut(1)
199 .SH AUTHOR
201 The author of this manual page is <inkling@users.sourceforge.net>.
202 .SH COPYRIGHT
204 This manual page is part of the atscap-1.1 distribution software.
206 atscut is Copyright (C) 2004-2007 by 
207 .B <inkling@users.sourceforge.net>
209 .SH LICENSE
211 Permission is granted to copy, distribute and/or modify this document
212 under the terms of the GNU General Public License, Version 2.
214 A copy of the license with the file name COPYING or LICENSE should have been
215 included in this distribution. If it was not included, or you did not receive
216 the sourcecode for this software, please contact me,
217 .B <inkling@users.sourceforge.net>,
218 or write to:
220  The Free Software Foundation, Inc.
221  51 Franklin Street, Fifth Floor
222  Boston, MA 02110-1301, USA