FreeDATA/modem/modem.py

496 lines
18 KiB
Python
Raw Normal View History

2020-12-23 16:48:54 +00:00
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Created on Wed Dec 23 07:04:24 2020
@author: DJ2LS
"""
2022-12-26 11:49:01 +00:00
# pylint: disable=invalid-name, line-too-long, c-extension-no-member
# pylint: disable=import-outside-toplevel
import atexit
2020-12-23 16:48:54 +00:00
import ctypes
2023-11-09 16:14:22 +00:00
import queue
import threading
import time
import codec2
import numpy as np
import sounddevice as sd
import structlog
2023-02-14 21:02:30 +00:00
import tci
2023-10-29 22:10:12 +00:00
import cw
from queues import RIGCTLD_COMMAND_QUEUE
import audio
2023-11-29 16:35:23 +00:00
import demodulator
2021-07-10 21:27:33 +00:00
2023-12-16 11:54:16 +00:00
TESTMODE = False
class RF:
"""Class to encapsulate interactions between the audio device and codec2"""
log = structlog.get_logger("RF")
def __init__(self, config, event_manager, fft_queue, service_queue, states) -> None:
2023-11-08 13:24:54 +00:00
self.config = config
2023-11-09 21:11:53 +00:00
self.service_queue = service_queue
self.states = states
self.event_manager = event_manager
self.sampler_avg = 0
self.buffer_avg = 0
2022-05-09 00:41:49 +00:00
# these are crc ids now
self.audio_input_device = config['AUDIO']['input_device']
self.audio_output_device = config['AUDIO']['output_device']
2023-11-11 19:38:13 +00:00
self.tx_audio_level = config['AUDIO']['tx_audio_level']
self.enable_audio_auto_tune = config['AUDIO']['enable_auto_tune']
2023-11-12 22:28:10 +00:00
self.tx_delay = config['MODEM']['tx_delay']
2023-11-18 16:55:49 +00:00
self.radiocontrol = config['RADIO']['control']
self.rigctld_ip = config['RIGCTLD']['ip']
self.rigctld_port = config['RIGCTLD']['port']
self.states.setTransmitting(False)
self.ptt_state = False
self.radio_alc = 0.0
2023-11-12 22:22:53 +00:00
self.tci_ip = config['TCI']['tci_ip']
self.tci_port = config['TCI']['tci_port']
2023-12-15 17:25:01 +00:00
self.AUDIO_SAMPLE_RATE = 48000
self.MODEM_SAMPLE_RATE = codec2.api.FREEDV_FS_8000
# 8192 Let's do some tests with very small chunks for TX
self.AUDIO_FRAMES_PER_BUFFER_TX = 1200 if self.radiocontrol in ["tci"] else 2400 * 2
2023-12-15 17:25:01 +00:00
# 8 * (self.AUDIO_SAMPLE_RATE/self.MODEM_SAMPLE_RATE) == 48
self.AUDIO_CHANNELS = 1
self.MODE = 0
2023-11-28 22:46:55 +00:00
self.rms_counter = 0
2022-05-09 00:41:49 +00:00
# Make sure our resampler will work
2023-12-15 17:25:01 +00:00
assert (self.AUDIO_SAMPLE_RATE / self.MODEM_SAMPLE_RATE) == codec2.api.FDMDV_OS_48 # type: ignore
2022-05-09 00:41:49 +00:00
2023-11-29 16:35:23 +00:00
self.modem_received_queue = queue.Queue()
self.audio_received_queue = queue.Queue()
self.data_queue_received = queue.Queue()
2023-11-09 16:14:22 +00:00
self.fft_queue = fft_queue
2023-11-29 16:35:23 +00:00
self.demodulator = demodulator.Demodulator(self.config,
self.audio_received_queue,
self.modem_received_queue,
self.data_queue_received,
self.states,
2023-12-16 10:05:53 +00:00
self.event_manager,
self.fft_queue
)
2023-11-29 16:35:23 +00:00
2023-12-21 16:47:48 +00:00
2023-12-15 17:25:01 +00:00
def tci_tx_callback(self, audio_48k) -> None:
self.radio.set_ptt(True)
self.event_manager.send_ptt_change(True)
self.tci_module.push_audio(audio_48k)
2023-11-11 09:41:16 +00:00
def start_modem(self):
2023-12-21 18:42:35 +00:00
if TESTMODE:
return True
elif self.radiocontrol.lower() == "tci":
if not self.init_tci():
return False
2023-11-11 09:41:16 +00:00
else:
2023-12-21 18:42:35 +00:00
if not self.init_audio():
raise RuntimeError("Unable to init audio devices")
self.demodulator.start(self.sd_input_stream)
atexit.register(self.sd_input_stream.stop)
2023-11-11 09:41:16 +00:00
2023-12-21 18:42:35 +00:00
# Initialize codec2, rig control, and data threads
self.init_codec2()
self.init_rig_control()
self.init_data_threads()
2023-12-21 18:42:35 +00:00
return True
2023-11-11 09:41:16 +00:00
def stop_modem(self):
try:
# let's stop the modem service
self.service_queue.put("stop")
# simulate audio class active state for reducing cli output
# self.stream = lambda: None
# self.stream.active = False
# self.stream.stop
2023-11-11 09:41:16 +00:00
except Exception:
self.log.error("[MDM] Error stopping modem")
2023-11-11 09:41:16 +00:00
2023-11-08 13:24:54 +00:00
def init_audio(self):
2023-11-11 09:53:01 +00:00
self.log.info(f"[MDM] init: get audio devices", input_device=self.audio_input_device,
output_device=self.audio_output_device)
2023-11-11 09:41:16 +00:00
try:
2023-11-11 09:53:01 +00:00
result = audio.get_device_index_from_crc(self.audio_input_device, True)
if result is None:
raise ValueError("Invalid input device")
else:
in_dev_index, in_dev_name = result
result = audio.get_device_index_from_crc(self.audio_output_device, False)
if result is None:
raise ValueError("Invalid output device")
else:
out_dev_index, out_dev_name = result
self.log.info(f"[MDM] init: receiving audio from '{in_dev_name}'")
self.log.info(f"[MDM] init: transmiting audio on '{out_dev_name}'")
self.log.debug("[MDM] init: starting pyaudio callback and decoding threads")
2023-12-15 17:25:01 +00:00
sd.default.samplerate = self.AUDIO_SAMPLE_RATE
sd.default.device = (in_dev_index, out_dev_index)
2023-11-11 09:53:01 +00:00
# init codec2 resampler
self.resampler = codec2.resampler()
2023-12-15 17:25:01 +00:00
# SoundDevice audio input stream
self.sd_input_stream = sd.InputStream(
2023-11-11 09:53:01 +00:00
channels=1,
dtype="int16",
2023-12-15 17:25:01 +00:00
callback=self.demodulator.sd_input_audio_callback,
device=in_dev_index,
samplerate=self.AUDIO_SAMPLE_RATE,
2023-11-11 09:53:01 +00:00
blocksize=4800,
)
2023-12-15 17:25:01 +00:00
self.sd_input_stream.start()
2023-11-11 09:53:01 +00:00
return True
except Exception as audioerr:
self.log.error("[MDM] init: starting pyaudio callback failed", e=audioerr)
2023-11-11 09:41:16 +00:00
self.stop_modem()
2023-11-11 09:53:01 +00:00
return False
2023-11-11 09:41:16 +00:00
def init_tci(self):
# placeholder area for processing audio via TCI
# https://github.com/maksimus1210/TCI
2023-11-12 22:22:53 +00:00
self.log.warning("[MDM] [TCI] Not yet fully implemented", ip=self.tci_ip, port=self.tci_port)
2023-11-11 09:41:16 +00:00
# we are trying this by simulating an audio stream Object like with mkfifo
class Object:
"""An object for simulating audio stream"""
active = True
self.stream = Object()
# lets init TCI module
self.tci_module = tci.TCICtrl(self.audio_received_queue)
2023-11-11 09:41:16 +00:00
2023-12-16 11:54:16 +00:00
return True
def audio_auto_tune(self):
# enable / disable AUDIO TUNE Feature / ALC correction
if self.enable_audio_auto_tune:
if self.radio_alc == 0.0:
self.tx_audio_level = self.tx_audio_level + 20
elif 0.0 < self.radio_alc <= 0.1:
print("0.0 < self.radio_alc <= 0.1")
self.tx_audio_level = self.tx_audio_level + 2
self.log.debug("[MDM] AUDIO TUNE", audio_level=str(self.tx_audio_level),
alc_level=str(self.radio_alc))
elif 0.1 < self.radio_alc < 0.2:
print("0.1 < self.radio_alc < 0.2")
self.tx_audio_level = self.tx_audio_level
self.log.debug("[MDM] AUDIO TUNE", audio_level=str(self.tx_audio_level),
alc_level=str(self.radio_alc))
elif 0.2 < self.radio_alc < 0.99:
print("0.2 < self.radio_alc < 0.99")
self.tx_audio_level = self.tx_audio_level - 20
self.log.debug("[MDM] AUDIO TUNE", audio_level=str(self.tx_audio_level),
alc_level=str(self.radio_alc))
elif 1.0 >= self.radio_alc:
print("1.0 >= self.radio_alc")
self.tx_audio_level = self.tx_audio_level - 40
self.log.debug("[MDM] AUDIO TUNE", audio_level=str(self.tx_audio_level),
alc_level=str(self.radio_alc))
else:
self.log.debug("[MDM] AUDIO TUNE", audio_level=str(self.tx_audio_level),
alc_level=str(self.radio_alc))
def transmit(
2023-12-30 21:44:18 +00:00
self, mode, repeats: int, repeat_delay: int, frames: bytearray
) -> bool:
"""
Args:
2022-05-09 00:41:49 +00:00
mode:
repeats:
repeat_delay:
frames:
"""
2023-12-16 11:54:16 +00:00
if TESTMODE:
return
2023-12-03 14:05:19 +00:00
self.demodulator.reset_data_sync()
2023-12-15 13:41:11 +00:00
# get freedv instance by mode
mode_transition = {
2023-12-16 09:28:30 +00:00
codec2.FREEDV_MODE.signalling: self.freedv_datac13_tx,
codec2.FREEDV_MODE.datac0: self.freedv_datac0_tx,
codec2.FREEDV_MODE.datac1: self.freedv_datac1_tx,
codec2.FREEDV_MODE.datac3: self.freedv_datac3_tx,
codec2.FREEDV_MODE.datac4: self.freedv_datac4_tx,
codec2.FREEDV_MODE.datac13: self.freedv_datac13_tx,
2023-12-15 13:41:11 +00:00
}
if mode in mode_transition:
freedv = mode_transition[mode]
else:
2023-12-15 15:22:38 +00:00
print("wrong mode.................")
print(mode)
return False
# Wait for some other thread that might be transmitting
self.states.waitForTransmission()
self.states.setTransmitting(True)
2024-01-04 09:01:29 +00:00
#self.states.channel_busy_event.wait()
2023-12-30 21:44:18 +00:00
2023-01-29 11:26:54 +00:00
start_of_transmission = time.time()
2022-05-09 00:41:49 +00:00
# Open codec2 instance
self.MODE = mode
2023-12-25 09:31:00 +00:00
txbuffer = bytes()
# Add empty data to handle ptt toggle time
if self.tx_delay > 0:
2023-12-25 09:31:00 +00:00
self.transmit_add_silence(txbuffer, self.tx_delay)
2023-03-06 11:48:27 +00:00
self.log.debug(
2023-12-30 21:44:18 +00:00
"[MDM] TRANSMIT", mode=self.MODE.name, delay=self.tx_delay
)
2022-05-09 00:41:49 +00:00
if not isinstance(frames, list): frames = [frames]
for _ in range(repeats):
# Create modulation for all frames in the list
for frame in frames:
2023-12-16 09:35:06 +00:00
2023-12-25 09:31:00 +00:00
txbuffer = self.transmit_add_preamble(txbuffer, freedv)
txbuffer = self.transmit_create_frame(txbuffer, freedv, frame)
txbuffer = self.transmit_add_postamble(txbuffer, freedv)
# Add delay to end of frames
2023-12-25 09:31:00 +00:00
self.transmit_add_silence(txbuffer, repeat_delay)
2022-05-09 00:41:49 +00:00
# Re-sample back up to 48k (resampler works on np.int16)
x = np.frombuffer(txbuffer, dtype=np.int16)
2023-03-04 09:59:43 +00:00
self.audio_auto_tune()
2023-11-29 16:35:23 +00:00
x = audio.set_audio_volume(x, self.tx_audio_level)
2023-12-25 09:31:00 +00:00
if self.radiocontrol not in ["tci"]:
2023-03-29 10:20:06 +00:00
txbuffer_out = self.resampler.resample8_to_48(x)
else:
txbuffer_out = x
2023-12-25 09:31:00 +00:00
# transmit audio
2023-12-15 17:25:01 +00:00
self.transmit_audio(txbuffer_out)
2022-03-31 19:13:30 +00:00
self.radio.set_ptt(False)
self.event_manager.send_ptt_change(False)
self.states.setTransmitting(False)
end_of_transmission = time.time()
transmission_time = end_of_transmission - start_of_transmission
self.log.debug("[MDM] ON AIR TIME", time=transmission_time)
2023-12-16 11:54:16 +00:00
return True
2023-12-25 09:31:00 +00:00
def transmit_add_preamble(self, buffer, freedv):
# Init buffer for preample
n_tx_preamble_modem_samples = codec2.api.freedv_get_n_tx_preamble_modem_samples(
freedv
)
mod_out_preamble = ctypes.create_string_buffer(n_tx_preamble_modem_samples * 2)
# Write preamble to txbuffer
codec2.api.freedv_rawdatapreambletx(freedv, mod_out_preamble)
buffer += bytes(mod_out_preamble)
return buffer
def transmit_add_postamble(self, buffer, freedv):
# Init buffer for postamble
n_tx_postamble_modem_samples = (
codec2.api.freedv_get_n_tx_postamble_modem_samples(freedv)
)
mod_out_postamble = ctypes.create_string_buffer(
n_tx_postamble_modem_samples * 2
)
# Write postamble to txbuffer
codec2.api.freedv_rawdatapostambletx(freedv, mod_out_postamble)
# Append postamble to txbuffer
buffer += bytes(mod_out_postamble)
return buffer
def transmit_add_silence(self, buffer, duration):
data_delay = int(self.MODEM_SAMPLE_RATE * (duration / 1000)) # type: ignore
mod_out_silence = ctypes.create_string_buffer(data_delay * 2)
buffer += bytes(mod_out_silence)
return buffer
def transmit_create_frame(self, txbuffer, freedv, frame):
# Get number of bytes per frame for mode
bytes_per_frame = int(codec2.api.freedv_get_bits_per_modem_frame(freedv) / 8)
payload_bytes_per_frame = bytes_per_frame - 2
# Init buffer for data
n_tx_modem_samples = codec2.api.freedv_get_n_tx_modem_samples(freedv)
mod_out = ctypes.create_string_buffer(n_tx_modem_samples * 2)
# Create buffer for data
# Use this if CRC16 checksum is required (DATAc1-3)
buffer = bytearray(payload_bytes_per_frame)
# Set buffersize to length of data which will be send
buffer[: len(frame)] = frame # type: ignore
# Create crc for data frame -
# Use the crc function shipped with codec2
# to avoid CRC algorithm incompatibilities
# Generate CRC16
crc = ctypes.c_ushort(
codec2.api.freedv_gen_crc16(bytes(buffer), payload_bytes_per_frame)
)
# Convert crc to 2-byte (16-bit) hex string
crc = crc.value.to_bytes(2, byteorder="big")
# Append CRC to data buffer
buffer += crc
assert (bytes_per_frame == len(buffer))
data = (ctypes.c_ubyte * bytes_per_frame).from_buffer_copy(buffer)
# modulate DATA and save it into mod_out pointer
codec2.api.freedv_rawdatatx(freedv, mod_out, data)
txbuffer += bytes(mod_out)
return txbuffer
2023-05-17 13:23:49 +00:00
def transmit_morse(self, repeats, repeat_delay, frames):
self.states.waitForTransmission()
self.states.setTransmitting(True)
2023-05-17 13:23:49 +00:00
# if we're transmitting FreeDATA signals, reset channel busy state
self.log.debug(
"[MDM] TRANSMIT", mode="MORSE"
)
start_of_transmission = time.time()
2023-10-29 22:10:12 +00:00
txbuffer_out = cw.MorseCodePlayer().text_to_signal("DJ2LS-1")
2023-05-17 13:23:49 +00:00
2023-12-15 17:25:01 +00:00
self.transmit_audio(txbuffer_out)
self.radio.set_ptt(False)
self.event_manager.send_ptt_change(False)
2023-05-17 13:23:49 +00:00
self.states.setTransmitting(False)
2023-05-17 13:23:49 +00:00
end_of_transmission = time.time()
transmission_time = end_of_transmission - start_of_transmission
self.log.debug("[MDM] ON AIR TIME", time=transmission_time)
2023-11-08 13:24:54 +00:00
def init_codec2(self):
# Open codec2 instances
# INIT TX MODES - here we need all modes.
self.freedv_datac0_tx = codec2.open_instance(codec2.FREEDV_MODE.datac0.value)
self.freedv_datac1_tx = codec2.open_instance(codec2.FREEDV_MODE.datac1.value)
self.freedv_datac3_tx = codec2.open_instance(codec2.FREEDV_MODE.datac3.value)
self.freedv_datac4_tx = codec2.open_instance(codec2.FREEDV_MODE.datac4.value)
self.freedv_datac13_tx = codec2.open_instance(codec2.FREEDV_MODE.datac13.value)
2023-11-08 13:24:54 +00:00
2023-11-29 16:35:23 +00:00
def init_data_threads(self):
worker_received = threading.Thread(
target=self.demodulator.worker_received, name="WORKER_THREAD", daemon=True
2022-10-10 07:00:45 +00:00
)
2023-11-29 16:35:23 +00:00
worker_received.start()
2022-10-10 07:00:45 +00:00
2023-12-15 17:25:01 +00:00
# Low level modem audio transmit
def transmit_audio(self, audio_48k) -> None:
self.radio.set_ptt(True)
self.event_manager.send_ptt_change(True)
2022-05-09 00:41:49 +00:00
2023-12-15 17:25:01 +00:00
if self.radiocontrol in ["tci"]:
self.tci_tx_callback(audio_48k)
2023-12-25 09:31:00 +00:00
# we need to wait manually for tci processing
self.tci_module.wait_until_transmitted(audio_48k)
2023-12-15 17:25:01 +00:00
else:
sd.play(audio_48k, blocking=True)
return
2023-11-08 13:24:54 +00:00
def init_rig_control(self):
# Check how we want to control the radio
if self.radiocontrol == "rigctld":
2023-11-08 13:24:54 +00:00
import rigctld as rig
elif self.radiocontrol == "tci":
2023-11-08 13:24:54 +00:00
self.radio = self.tci_module
else:
import rigdummy as rig
if not self.radiocontrol in ["tci"]:
2023-11-08 13:24:54 +00:00
self.radio = rig.radio()
self.radio.open_rig(
rigctld_ip=self.rigctld_ip,
rigctld_port=self.rigctld_port,
2023-11-08 13:24:54 +00:00
)
2023-12-21 18:32:42 +00:00
hamlib_thread = threading.Thread(
target=self.update_rig_data, name="HAMLIB_THREAD", daemon=True
)
2023-11-08 13:24:54 +00:00
hamlib_thread.start()
hamlib_set_thread = threading.Thread(
target=self.set_rig_data, name="HAMLIB_SET_THREAD", daemon=True
)
hamlib_set_thread.start()
def set_rig_data(self) -> None:
"""
Set rigctld parameters like frequency, mode
THis needs to be processed in a queue
"""
while True:
cmd = RIGCTLD_COMMAND_QUEUE.get()
if cmd[0] == "set_frequency":
# [1] = Frequency
2023-03-29 05:47:31 +00:00
self.radio.set_frequency(cmd[1])
2023-01-04 19:12:03 +00:00
if cmd[0] == "set_mode":
# [1] = Mode
2023-03-29 05:47:31 +00:00
self.radio.set_mode(cmd[1])
def update_rig_data(self) -> None:
"""
Request information about the current state of the radio via hamlib
"""
while True:
2023-05-20 07:53:57 +00:00
try:
# this looks weird, but is necessary for avoiding rigctld packet colission sock
2023-11-18 22:50:40 +00:00
#threading.Event().wait(0.1)
self.states.set("radio_status", self.radio.get_status())
#threading.Event().wait(0.25)
self.states.set("radio_frequency", self.radio.get_frequency())
2023-02-01 12:39:18 +00:00
threading.Event().wait(0.1)
self.states.set("radio_mode", self.radio.get_mode())
2023-05-20 07:53:57 +00:00
threading.Event().wait(0.1)
self.states.set("radio_bandwidth", self.radio.get_bandwidth())
2023-05-20 07:53:57 +00:00
threading.Event().wait(0.1)
if self.states.isTransmitting():
self.radio_alc = self.radio.get_alc()
2023-05-20 07:53:57 +00:00
threading.Event().wait(0.1)
self.states.set("radio_rf_power", self.radio.get_level())
2023-11-18 22:50:40 +00:00
threading.Event().wait(0.1)
self.states.set("radio_strength", self.radio.get_strength())
2023-05-20 07:53:57 +00:00
except Exception as e:
self.log.warning(
"[MDM] error getting radio data",
e=e,
)
threading.Event().wait(1)