1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-12-17 23:28:50 -05:00

ATV plugins: update doc

This commit is contained in:
f4exb 2017-03-14 18:59:45 +01:00
parent fa106b82c1
commit 7f125828bc
2 changed files with 29 additions and 21 deletions

View File

@ -2,9 +2,9 @@
<h2>Introduction</h2>
This plugin can be used to view amateur analog television transmissions a.k.a ATV. The video signal is in fact a 625 lines standard signal black and white or color (PAL, NTSC) but only the black and white levels (luminance) is retained. There is no provision to demodulate the audio subcarrier either. The modulation can be either AM or FM.
This plugin can be used to view amateur analog television transmissions a.k.a ATV. The transmitted video signal can be black and white or color (PAL, NTSC) but only the black and white levels (luminance) is retained and hence image is black and white. There is no provision to demodulate the audio subcarrier either. The modulation can be either AM or FM. A plugin supporting audio can be used in the same passband to demodulate an audio carrier but not a subcarrier which excludes FM.
The whole bandwidth available to the channel is used. That is it runs at the device sample rate possibly downsampled by a power of two in the source plugin. It expects an integer number of MS/s and acceptable results require a sample rate of at least 6 MS/s (Airspy Mini, Airspy, BladerRF, HackRF).
The whole bandwidth available to the channel is used. That is it runs at the device sample rate possibly downsampled by a power of two in the source plugin. It expects an integer number of MS/s and standard image quality requires a sample rate of at least 4 MS/s. The Airspy Mini 3 MS/s mode may still be acceptable. Anything below should be considered experimental quality.
<h2>Interface</h2>
@ -26,6 +26,9 @@ For FM choose the algorithm that best suits your conditions.
This combo lets you chose between a 25 FPS or 30 FPS standard.
- 25 FPS corresponds to the PAL 625 lines standard (PAL B,G,I,L)
- 30 FPS corresponds to the PAL 525 lines standard (PAL M)
<h3>4: Horizontal sync</h3>
Check/uncheck this box to toggle horizontal synchronization processing.

View File

@ -2,8 +2,11 @@
<h2>Introduction</h2>
This plugin can be used to generate an analog TV signal mostly used in amateur radio. It is limited to black and white images as only the luminance (256 levels) is supported.
This plugin can be used to generate an analog TV signal mostly used in amateur radio. It is limited to black and white images as only the luminance (256 levels) is supported.
There is no sound either but you may use any of the plugins supporting audio to create a mixed signal. Be aware that in this case the power of the video and audio channels is reduced by 3 dB. There is also a performance hit due to the high interpolation factor on the audio side (from 48 kS/s to several MS/s). Another option is to use two different physical devices for video and audio and mix their RF outputs at the PA input or antenna.
In practice 4 MS/s is the lowest sample rate that produces a standard image quality. Lower sample rates down to 1 MS/s produce low quality images that may still be acceptable depending on requirements.
<h2>Interface</h2>
![ATV Modulator plugin GUI](../../../doc/img/ATVMod_plugin.png)
@ -18,29 +21,31 @@ Use the wheels to adjust the frequency shift in Hz from the center frequency of
<h3>3: Channel power</h3>
Average total power in dB relative to a +/- 1.0 amplitude signal generated in the pass band.
Average total power in dB relative to a &#177;1.0 amplitude signal generated in the pass band.
<h3>4: Channel mute</h3>
Use this button to toggle mute for this channel.
Use this button to toggle mute for this channel. The radio waves on the icon are toggled on (active) and off (muted) accordingly. Default is channel active.
<h3>5: Modulation type</h3>
The video signal can modulate the carrier in the following modes:
- AM: Amplitude modulation. Modulation index is 90%.
- FM: Frequency modulation. Excursion is half the bandwidth available given the channel sample rate. e.g. for 4 MS/s sample rate this is +/-1 MHz (2 MHz total)
- FM: Frequency modulation. Excursion is half the bandwidth available given the channel sample rate. e.g. for 4 MS/s sample rate this is &#177;1 MHz (2 MHz total)
<h3>6: RF bandwidth</h3>
This is the bandwidth in MHz of the channel filter when the interpolator is engaged. If the sink sample rate is an integer multiple of the base rate that depends on the standard then there is no interpolation else the channel rate is set to the integer multiple of the base rate just below the sink sample rate.
This is the bandwidth in MHz of the channel filter when the interpolator is engaged. If the sink sample rate is an integer multiple of the base rate that depends on the standard then there is no interpolation else the channel rate is set to the closest integer multiple of the base rate below the sink sample rate.
The base rate depending on the standard is:
- PAL625L: 1 MS/s
- PAL525L: 1.008 MS/s
Each horizontal line (including sync and porchs) is split in a number of points so that each point represents a sample. e.g. for a 3 MS/s sample rate in PAL625L standard each point will last 1/3 us (3 points per base rate period).
The modulating video signal sample rate is the same as the channel sample rate hence for example with a channel sample rate of 4 MS/s a video sample will last 1/4 = 0.25 &#956;s. In PAL625L a complete horizontal line lasts 64 &#956;s hence it will be composed of 64 &#215; 4 = 256 samples while the useful image line that lasts about 52 &#956;s will be composed of 52 &#215; 4 = 204 samples or points.
When no interpolation and hence no soft RF filtering in the channel takes place then filtering relies on the hardware. The hardware filter bandwidth can be set in the sink plugin.
<h3>7: Video signal level meter</h3>
@ -50,7 +55,7 @@ This is the level meter fed with the video signal. Units are the percentage of t
This is the analog TV standard in use. Use the checkbox to choose between:
- PAL625L: this is the PAL 625 lines standard with 25 FPS. Since only black and white (luminance) is supported this corresponds to any of the B,G or L PAL standards
- PAL625L: this is the PAL 625 lines standard with 25 FPS. Since only black and white (luminance) is supported this corresponds to any of the B,G,I or L PAL standards
- PAL525L: this is the PAL 525 lines standard with 30 FPS. This corresponds to the PAL M standard.
<h3>9: Input source</h3>
@ -60,20 +65,20 @@ This combo box lets you choose between various inputs for the video signal:
- Uniform: the image has a uniform luminance level given by the luminance level adjusted with the button next (10)
- H Bars: horizontal bars from black level on the left to white level on the right
- V Bars: vertical bars from black level on the top to white level on the bottom
- Chess: chessboard alternating black squares and squares with the luminance level adjusted with button (10)
- Chess: chessboard pattern alternating black squares and squares with the luminance level adjusted with button (10)
- H Grad: horizontal gradient from black level on the left to white level on the right
- V Grad: vertical gradient from black level on the top to white level on the bottom
- Image: still image read from the file selected with button (13). If no image is selected an uniform image is displayed with the luminance adjusted with button (10)
- Video: video file read from the file selected with button (14). If no image is selected an uniform image is displayed with the luminance adjusted with button (10). Buttons (15) and (16) control the play.
- Camera: video signal from a webcam or supported video source connected to the system. If no source is selected an uniform image is displayed with the luminance adjusted with button (10). Button (21) selects the source. Button (20) plays or stops the camera on a still image.
- Image: still image read from the file selected with button (13). If no image is selected an uniform image is sent with the luminance adjusted with button (10)
- Video: video file read from the file selected with button (14). If no image is selected an uniform image is sent with the luminance adjusted with button (10). Buttons (15) and (16) control the play.
- Camera: video signal from a webcam or supported video source connected to the system. If no source is selected an uniform image is sent with the luminance adjusted with button (10). Button (21) selects the camera source. Button (20) plays or stops the camera on a still image.
<h3>10. Luminance level</h3>
This button lets you adjust the luminance level of the "blank" screens displays, the lighter squares on the chessboard and the overlay text
This button lets you adjust the luminance level of the "blank" screens displays, the lighter squares on the chessboard and the overlay text.
<h3>11. Show overlay text toggle</h3>
This button toggles the display of an overlay text on a still image, or a video signal from a file or a camera. Note that for still images you will have to toggle off/on this button to take any change of text or text color into account.
This button toggles the display of an overlay text on a still image, or a video signal from a file or a camera. Note that for still images you will have to toggle off/on this button to take any change of text or text brightness into account.
<h3>12. Overlay text</h3>
@ -93,13 +98,13 @@ Use this button to toggle on/off playing the video file in a loop
<h3>16. Play/Pause video</h3>
Use this button to toggle on/off the video file play. When play stops the current image is displayed as a still image. When video is stopped the button is dark and a play (triangle) icon is displayed on the button. When video runs the button is lit and a pause (two bars) icon is displayed on the button.
Use this button to toggle on/off the video file play. When play stops the current image is displayed as a still image. When video is stopped the button is dark and a play (&#9658;) icon is displayed on the button. When video runs the button is lit and a pause (&#9611;&#9611;) icon is displayed on the button.
<h3>17. Current video position</h3>
This is the current video file play position in time units relative to the start
<h3>18. Video file lengt</h3>
<h3>18. Video file length</h3>
This is the video file play length in time units
@ -109,13 +114,13 @@ This slider can be used to randomly set the currennt position in the file when f
<h3>20. Play/Pause camera</h3>
Use this button to toggle on/off the camera play. When play stops the current image is displayed as a still image. When camera is stopped the button is dark and a play (triangle) icon is displayed on the button. When camera runs the button is lit and a pause (two bars) icon is displayed on the button.
Use this button to toggle on/off the camera play. When play stops the current image is displayed as a still image. When camera is stopped the button is dark and a play (&#9658;) icon is displayed on the button. When camera runs the button is lit and a pause (&#9611;&#9611;) icon is displayed on the button.
When the play button is engaged for the first time the FPS of the camera is scanned which can take some time (100 frames are read). A message box appears while the operation is running.
On Linux systems when the play button is engaged for the first time the FPS of the camera is scanned which can take some time (100 frames are read). A message box appears while the operation is running.
<h3>21. Camera select</h3>
Use this combo to select the camera source when more than one is available. the number corresponds to the index of the camera during the camera scan at the startup of the plugin instance. A maximum of 4 cameras are scanned in whichever order presented by the system. Note that multiple camera support is experimental and concurrent use of cameras may or may not work wih your system.
Use this combo to select the camera source when more than one is available. the number corresponds to the index of the camera during the camera scan at the startup of the plugin instance. A maximum of 4 cameras are scanned in whichever order presented by the system.
<h3>22. Camera device number</h3>
@ -123,7 +128,7 @@ This is the device number used by OpenCV which on Linux systems correspond to th
<h3>23. Camera FPS</h3>
This is the camera FPS obtained from the FPS scanning reduced by 5% for a safeguard margin.
This is the camera FPS. On Windows there is no dynamic FPS check and a fixed 5 FPS is set for each camera. On Linux 90% of the calculated FPS is divided by the number of scanned cameras to give the final FPS. This is an attempt to avoid congestion when multiple cameras are available however this was only tested with two cameras.
<h3>24. Camera image size</h3>