.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.11.
.TH HACKTV "1" "September 2019" "hacktv " "User Commands"
.SH NAME
hacktv \- Analogue TV transmitter for the HackRF
.SH SYNOPSIS
.B hacktv
[\fI\,options\/\fR] \fI\,input \/\fR[\fI\,input\/\fR...]
.SH DESCRIPTION
.TP
\fB\-o\fR, \fB\-\-output\fR <target>
Set the output device or file, Default: hackrf
.TP
\fB\-m\fR, \fB\-\-mode\fR <name>
Set the television mode. Default: i
.TP
\fB\-s\fR, \fB\-\-samplerate\fR <value>
Set the sample rate in Hz. Default: 16MHz
.TP
\fB\-l\fR, \fB\-\-level\fR <value>
Set the output level. Default: 1.0
.TP
\fB\-D\fR, \fB\-\-deviation\fR <value>
Override the mode's FM deviation. (Hz)
.TP
\fB\-G\fR, \fB\-\-gamma\fR <value>
Override the mode's gamma correction value.
.TP
\fB\-r\fR, \fB\-\-repeat\fR
Repeat the inputs forever.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Enable verbose output.
.TP
\fB\-\-teletext\fR <path>
Enable teletext output. (625 line modes only)
.TP
\fB\-\-wss\fR <mode>
Enable WSS output. (625 line modes only)
.TP
\fB\-\-videocrypt\fR <mode>
Enable Videocrypt I scrambling. (PAL only)
.TP
\fB\-\-videocrypt2\fR <mode>
Enable Videocrypt II scrambling. (PAL only)
.TP
\fB\-\-videocrypts\fR <mode>
Enable Videocrypt S scrambling. (PAL only)
.TP
\fB\-\-syster\fR
Enable Nagravision Syster scambling. (PAL only)
.TP
\fB\-\-filter\fR
Enable experimental VSB modulation filter.
.TP
\fB\-\-noaudio\fR
Suppress all audio subcarriers.
.PP
Input options
.TP
test:colourbars
Generate and transmit a test pattern.
.TP
ffmpeg:<file|url>
Decode and transmit a video file with ffmpeg.
.IP
If no valid input prefix is provided, ffmpeg: is assumed.
.PP
HackRF output options
.HP
\fB\-o\fR, \fB\-\-output\fR hackrf[:<serial>] Open a HackRF for output.
.TP
\fB\-f\fR, \fB\-\-frequency\fR <value>
Set the RF frequency in Hz, 0MHz to 7250MHz.
.TP
\fB\-a\fR, \fB\-\-amp\fR
Enable the TX RF amplifier.
.TP
\fB\-g\fR, \fB\-\-gain\fR <value>
Set the TX VGA (IF) gain, 0\-47dB. Default: 0dB
.IP
Only modes with a complex output are supported by the HackRF.
.PP
SoapySDR output options
.HP
\fB\-o\fR, \fB\-\-output\fR soapysdr[:<opts>] Open a SoapySDR device for output.
.TP
\fB\-f\fR, \fB\-\-frequency\fR <value>
Set the RF frequency in Hz.
.TP
\fB\-g\fR, \fB\-\-gain\fR <value>
Set the TX level. Default: 0dB
.TP
\fB\-A\fR, \fB\-\-antenna\fR <name>
Set the antenna.
.PP
File output options
.TP
\fB\-o\fR, \fB\-\-output\fR file:<filename>
Open a file for output. Use \- for stdout.
.TP
\fB\-t\fR, \fB\-\-type\fR <type>
Set the file data type.
.PP
Supported file types:
.IP
uint8
int8
uint16
int16
int32
float
.IP
The default output is int16. The TV mode will determine if the output
is real or complex.
.IP
If no valid output prefix is provided, file: is assumed.
.PP
Supported television modes:
.TP
i
= PAL colour, 25 fps, 625 lines, AM (complex), 6.0 MHz FM audio
.TP
b, g
= PAL colour, 25 fps, 625 lines, AM (complex), 5.5 MHz FM audio
.TP
pal\-fm
= PAL colour, 25 fps, 625 lines, FM (complex), 6.5 MHz FM audio
.TP
pal
= PAL colour, 25 fps, 625 lines, unmodulated (real)
.TP
m
= NTSC colour, 30/1.001 fps, 525 lines, AM (complex)
.TP
ntsc
= NTSC colour, 30/1.001 fps, 525 lines, unmodulated (real)
.TP
l
= SECAM colour, 25 fps, 625 lines, AM (complex), 6.5 MHz AM
.IP
audio
.TP
secam
= SECAM colour, 25 fps, 625 lines, unmodulated (real)
.TP
e
= No colour, 25 fps, 819 lines, AM (complex)
.TP
819
= No colour, 25 fps, 819 lines, unmodulated (real)
.TP
a
= No colour, 25 fps, 405 lines, AM (complex)
.TP
405
= No colour, 25 fps, 405 lines, unmodulated (real)
.TP
240\-am
= No colour, 25 fps, 240 lines, AM (complex)
.TP
240
= No colour, 25 fps, 240 lines, unmodulated (real)
.TP
30\-am
= No colour, 12.5 fps, 30 lines, AM (complex)
.TP
30
= No colour, 12.5 fps, 30 lines, unmodulated (real)
.IP
apollo\-fsc\-fm = Field sequential colour, 30/1.001 fps, 525 lines, FM (complex)
.IP
1.25 MHz FM audio
.TP
apollo\-fsc
= Field sequential colour, 30/1.001 fps, 525 lines, unmodulated
.IP
(real)
.TP
apollo\-fm
= No colour, 10 fps, 320 lines, FM (complex), 1.25 MHz FM audio
.TP
apollo
= No colour, 10 fps, 320 lines, unmodulated (real)
.PP
NOTE: The number of samples per line is rounded to the nearest integer,
which may result in a slight frame rate error.
.PP
For modes which include audio you also need to ensure the sample rate
is adequate to contain both the video signal and audio subcarriers.
.PP
16MHz works well with PAL modes, and 13.5MHz for NTSC modes.
.PP
Teletext
.PP
Teletext is a digital information service transmitted within the VBI lines of
the video signal. Developed in the UK in the 1970s, it was used throughout
much of Europe until the end of analogue TV in the 2010s.
.PP
hacktv supports TTI files. The path can be either a single file or a
directory. All files in the directory will be loaded.
.PP
Raw packet sources are also supported with the raw:<source> path name.
The input is expected to be 42 byte teletext packets. Use \- for stdin.
.PP
Lines 7\-22 and 320\-335 are used, 16 lines per field.
.PP
Teletext support in hacktv is only compatible with 625 line PAL modes.
NTSC and SECAM variations exist and may be supported in the future.
.PP
WSS (Widescreen Signaling)
.PP
WSS provides a method to signal to a TV the intended aspect ratio of
the video. The following modes are supported:
.TP
4:3
= Video is 4:3.
.TP
16:9
= Video is 16:9 (Anamorphic).
.IP
14:9\-letterbox = Crop a 4:3 video to 14:9.
16:9\-letterbox = Crop a 4:3 video to 16:9.
auto           = Automatically switch between 4:3 and 16:9.
.PP
Currently only supported in 625 line modes. A 525 line variant exists and
may be supported in future.
.PP
Videocrypt I
.PP
A video scrambling system used by the Sky TV analogue satellite service in
the UK in the 1990s. Each line of the image is cut at a point determined by
a pseudorandom number generator, then the two parts are swapped.
.PP
hacktv supports the following modes:
.TP
free
= Free\-access, no subscription card is required to decode.
.IP
conditional = A valid Sky card is required to decode. Sample data from MTV.
.PP
Videocrypt is only compatiable with 625 line PAL modes. This version
works best when used with samples rates at multiples of 14MHz.
.PP
Videocrypt II
.PP
A variation of Videocrypt I used throughout Europe. The scrambling method is
identical to VC1, but has a higher VBI data rate.
.PP
hacktv supports the following modes:
.TP
free
= Free\-access, no subscription card is required to decode.
.PP
Both VC1 and VC2 cannot be used together except if both are in free\-access mode.
.PP
Videocrypt S (Simulation)
.PP
A variation of Videocrypt II used on the short lived BBC Select service. This
mode uses line\-shuffling rather than line cut\-and\-rotate.
.PP
hacktv supports the following modes:
.TP
free
= Free\-access, no subscription card is required to decode.
.PP
This is a simulation and will not work with real hardware.
Audio inversion is not yet supported.
.PP
Nagravision Syster
.PP
Another video scrambling system used in the 1990s in Europe. The video lines
are vertically shuffled within a field.
.PP
Syster is only compatible with 625 line PAL modes and does not currently work
with most hardware.
.PP
Audio inversion is not yet supported.
.PP
Usage: hacktv [options] input [input...]
.TP
\fB\-o\fR, \fB\-\-output\fR <target>
Set the output device or file, Default: hackrf
.TP
\fB\-m\fR, \fB\-\-mode\fR <name>
Set the television mode. Default: i
.TP
\fB\-s\fR, \fB\-\-samplerate\fR <value>
Set the sample rate in Hz. Default: 16MHz
.TP
\fB\-l\fR, \fB\-\-level\fR <value>
Set the output level. Default: 1.0
.TP
\fB\-D\fR, \fB\-\-deviation\fR <value>
Override the mode's FM deviation. (Hz)
.TP
\fB\-G\fR, \fB\-\-gamma\fR <value>
Override the mode's gamma correction value.
.TP
\fB\-r\fR, \fB\-\-repeat\fR
Repeat the inputs forever.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Enable verbose output.
.TP
\fB\-\-teletext\fR <path>
Enable teletext output. (625 line modes only)
.TP
\fB\-\-wss\fR <mode>
Enable WSS output. (625 line modes only)
.TP
\fB\-\-videocrypt\fR <mode>
Enable Videocrypt I scrambling. (PAL only)
.TP
\fB\-\-videocrypt2\fR <mode>
Enable Videocrypt II scrambling. (PAL only)
.TP
\fB\-\-videocrypts\fR <mode>
Enable Videocrypt S scrambling. (PAL only)
.TP
\fB\-\-syster\fR
Enable Nagravision Syster scambling. (PAL only)
.TP
\fB\-\-filter\fR
Enable experimental VSB modulation filter.
.TP
\fB\-\-noaudio\fR
Suppress all audio subcarriers.
.PP
Input options
.TP
test:colourbars
Generate and transmit a test pattern.
.TP
ffmpeg:<file|url>
Decode and transmit a video file with ffmpeg.
.IP
If no valid input prefix is provided, ffmpeg: is assumed.
.PP
HackRF output options
.HP
\fB\-o\fR, \fB\-\-output\fR hackrf[:<serial>] Open a HackRF for output.
.TP
\fB\-f\fR, \fB\-\-frequency\fR <value>
Set the RF frequency in Hz, 0MHz to 7250MHz.
.TP
\fB\-a\fR, \fB\-\-amp\fR
Enable the TX RF amplifier.
.TP
\fB\-g\fR, \fB\-\-gain\fR <value>
Set the TX VGA (IF) gain, 0\-47dB. Default: 0dB
.IP
Only modes with a complex output are supported by the HackRF.
.PP
SoapySDR output options
.HP
\fB\-o\fR, \fB\-\-output\fR soapysdr[:<opts>] Open a SoapySDR device for output.
.TP
\fB\-f\fR, \fB\-\-frequency\fR <value>
Set the RF frequency in Hz.
.TP
\fB\-g\fR, \fB\-\-gain\fR <value>
Set the TX level. Default: 0dB
.TP
\fB\-A\fR, \fB\-\-antenna\fR <name>
Set the antenna.
.PP
File output options
.TP
\fB\-o\fR, \fB\-\-output\fR file:<filename>
Open a file for output. Use \- for stdout.
.TP
\fB\-t\fR, \fB\-\-type\fR <type>
Set the file data type.
.PP
Supported file types:
.IP
uint8
int8
uint16
int16
int32
float
.IP
The default output is int16. The TV mode will determine if the output
is real or complex.
.IP
If no valid output prefix is provided, file: is assumed.
.PP
Supported television modes:
.TP
i
= PAL colour, 25 fps, 625 lines, AM (complex), 6.0 MHz FM audio
.TP
b, g
= PAL colour, 25 fps, 625 lines, AM (complex), 5.5 MHz FM audio
.TP
pal\-fm
= PAL colour, 25 fps, 625 lines, FM (complex), 6.5 MHz FM audio
.TP
pal
= PAL colour, 25 fps, 625 lines, unmodulated (real)
.TP
m
= NTSC colour, 30/1.001 fps, 525 lines, AM (complex)
.TP
ntsc
= NTSC colour, 30/1.001 fps, 525 lines, unmodulated (real)
.TP
l
= SECAM colour, 25 fps, 625 lines, AM (complex), 6.5 MHz AM
.IP
audio
.TP
secam
= SECAM colour, 25 fps, 625 lines, unmodulated (real)
.TP
e
= No colour, 25 fps, 819 lines, AM (complex)
.TP
819
= No colour, 25 fps, 819 lines, unmodulated (real)
.TP
a
= No colour, 25 fps, 405 lines, AM (complex)
.TP
405
= No colour, 25 fps, 405 lines, unmodulated (real)
.TP
240\-am
= No colour, 25 fps, 240 lines, AM (complex)
.TP
240
= No colour, 25 fps, 240 lines, unmodulated (real)
.TP
30\-am
= No colour, 12.5 fps, 30 lines, AM (complex)
.TP
30
= No colour, 12.5 fps, 30 lines, unmodulated (real)
.IP
apollo\-fsc\-fm = Field sequential colour, 30/1.001 fps, 525 lines, FM (complex)
.IP
1.25 MHz FM audio
.TP
apollo\-fsc
= Field sequential colour, 30/1.001 fps, 525 lines, unmodulated
.IP
(real)
.TP
apollo\-fm
= No colour, 10 fps, 320 lines, FM (complex), 1.25 MHz FM audio
.TP
apollo
= No colour, 10 fps, 320 lines, unmodulated (real)
.PP
NOTE: The number of samples per line is rounded to the nearest integer,
which may result in a slight frame rate error.
.PP
For modes which include audio you also need to ensure the sample rate
is adequate to contain both the video signal and audio subcarriers.
.PP
16MHz works well with PAL modes, and 13.5MHz for NTSC modes.
.PP
Teletext
.PP
Teletext is a digital information service transmitted within the VBI lines of
the video signal. Developed in the UK in the 1970s, it was used throughout
much of Europe until the end of analogue TV in the 2010s.
.PP
hacktv supports TTI files. The path can be either a single file or a
directory. All files in the directory will be loaded.
.PP
Raw packet sources are also supported with the raw:<source> path name.
The input is expected to be 42 byte teletext packets. Use \- for stdin.
.PP
Lines 7\-22 and 320\-335 are used, 16 lines per field.
.PP
Teletext support in hacktv is only compatible with 625 line PAL modes.
NTSC and SECAM variations exist and may be supported in the future.
.PP
WSS (Widescreen Signaling)
.PP
WSS provides a method to signal to a TV the intended aspect ratio of
the video. The following modes are supported:
.TP
4:3
= Video is 4:3.
.TP
16:9
= Video is 16:9 (Anamorphic).
.IP
14:9\-letterbox = Crop a 4:3 video to 14:9.
16:9\-letterbox = Crop a 4:3 video to 16:9.
auto           = Automatically switch between 4:3 and 16:9.
.PP
Currently only supported in 625 line modes. A 525 line variant exists and
may be supported in future.
.PP
Videocrypt I
.PP
A video scrambling system used by the Sky TV analogue satellite service in
the UK in the 1990s. Each line of the image is cut at a point determined by
a pseudorandom number generator, then the two parts are swapped.
.PP
hacktv supports the following modes:
.TP
free
= Free\-access, no subscription card is required to decode.
.IP
conditional = A valid Sky card is required to decode. Sample data from MTV.
.PP
Videocrypt is only compatiable with 625 line PAL modes. This version
works best when used with samples rates at multiples of 14MHz.
.PP
Videocrypt II
.PP
A variation of Videocrypt I used throughout Europe. The scrambling method is
identical to VC1, but has a higher VBI data rate.
.PP
hacktv supports the following modes:
.TP
free
= Free\-access, no subscription card is required to decode.
.PP
Both VC1 and VC2 cannot be used together except if both are in free\-access mode.
.PP
Videocrypt S (Simulation)
.PP
A variation of Videocrypt II used on the short lived BBC Select service. This
mode uses line\-shuffling rather than line cut\-and\-rotate.
.PP
hacktv supports the following modes:
.TP
free
= Free\-access, no subscription card is required to decode.
.PP
This is a simulation and will not work with real hardware.
Audio inversion is not yet supported.
.PP
Nagravision Syster
.PP
Another video scrambling system used in the 1990s in Europe. The video lines
are vertically shuffled within a field.
.PP
Syster is only compatible with 625 line PAL modes and does not currently work
with most hardware.
.PP
Audio inversion is not yet supported.