comicsansg/CubicSDR
1
0
Fork 0
mirror of https://github.com/cjcliffe/CubicSDR.git synced 2026-10-08 00:00:23 -04:00
Code Issues Projects Releases Wiki Activity

missed info check

Browse Source
This commit is contained in:
Charles J. Cliffe
2026-07-24 00:44:59 -04:00
parent cf16e874c1
commit 6fbd118500
6 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/RECOMMENDATIONS.md
+1 -1
View File
@@ -16,7 +16,7 @@
| Issue | Severity |
|-------|----------|
| **Zero test coverage** — no test framework, no test files, CI only builds | Critical |
| **Monolithic files** — `AppFrame.cpp` is ~2,700 lines | High |
| **Monolithic files** — `AppFrame.cpp` is ~3,200 lines | High |
| **Memory safety** — raw `new`/`delete` for threads, `reinterpret_cast` type punning in DataTree, suppressed MSVC C4996 warnings | High |
| **Outdated CMake** — targets 2.8.12, uses `-std=c++0x` draft flag, deprecated patterns | Medium |
| **Incomplete .gitignore** — missing IDE, OS, and build artifact patterns | Medium |
docs/design/README.md
+7
View File
@@ -24,6 +24,8 @@ src/
process/ FFT and visual data processing
util/ Core utilities (queues, timers, data trees)
rig/ Hamlib CAT control (optional)
forms/ UI forms (device selection, bookmarks, dialogs)
panel/ Display panels (scope, spectrum, waterfall, meter)
```
### Key Classes
@@ -32,12 +34,17 @@ src/
|-------|------|------|
| `CubicSDR` | `src/CubicSDR.h` | Application singleton, owns all global threads |
| `AppFrame` | `src/AppFrame.h` | Main wxWidgets window, UI event loop |
| `AppConfig` | `src/AppConfig.h` | Application configuration persistence |
| `SDRThread` | `src/sdr/SoapySDRThread.h` | Reads IQ samples from hardware |
| `SDRPostThread` | `src/sdr/SDRPostThread.h` | Channelizes and distributes IQ data |
| `SDREnumerator` | `src/sdr/SDREnumerator.h` | Background device discovery |
| `DemodulatorInstance` | `src/demod/DemodulatorInstance.h` | Orchestrates one demodulator's thread chain |
| `DemodulatorMgr` | `src/demod/DemodulatorMgr.h` | Manages all demodulator instances |
| `DemodulatorWorkerThread` | `src/demod/DemodulatorWorkerThread.h` | Offloaded modem/filter creation |
| `Modem` | `src/modules/modem/Modem.h` | Abstract modem base class with factory pattern |
| `AudioThread` | `src/audio/AudioThread.h` | Manages RtAudio output device |
| `AudioSinkThread` | `src/audio/AudioSinkThread.h` | Per-demod audio sink (base class) |
| `AudioSinkFileThread` | `src/audio/AudioSinkFileThread.h` | WAV file recording |
| `IOThread` | `src/IOThread.h` | Base class for all worker threads |
| `ThreadBlockingQueue` | `src/util/ThreadBlockingQueue.h` | Primary inter-thread communication mechanism |
docs/design/signal-flow.md
+1 -1
View File
@@ -27,7 +27,7 @@ SDR Hardware (SoapySDR)
[Stage 4] DemodulatorThread
|---[pipeAudioData]---------> AudioThread (speaker output)
|---[audioVisOutputQueue]---> ScopeVisualProcessor (scope display)
|---[audioSinkOutputQueue]--> AudioSinkThread (WAV recording)
|---[audioSinkOutputQueue]--> AudioSinkFileThread (WAV recording)
v
[Stage 5] AudioThread -> RtAudio hardware callback -> speakers/headphones
```
docs/design/threading.md
+3 -1
View File
@@ -41,7 +41,8 @@ On macOS, `DemodulatorPreThread` and `DemodulatorThread` use `pthread_create` wi
| Demodulator Thread (N) | `DemodulatorThread` | `src/demod/DemodulatorThread.h` | Core demodulation, squelch, signal levels |
| Audio Thread (N) | `AudioThread` | `src/audio/AudioThread.h` | Per-demod audio processing and device binding |
| Audio Controller | `AudioThread` | `src/audio/AudioThread.h` | Per-device RtAudio stream owner and mixer |
| Audio Sink (N) | `AudioSinkThread` | `src/audio/AudioSinkThread.h` | WAV file recording |
| Audio Sink (N) | `AudioSinkThread` | `src/audio/AudioSinkThread.h` | Base audio sink for demodulator output |
| Audio Sink File (N) | `AudioSinkFileThread` | `src/audio/AudioSinkFileThread.h` | WAV file recording |
| Rig Control (optional) | `RigThread` | `src/rig/RigThread.h` | Hamlib CAT control |
## Communication Patterns
@@ -141,6 +142,7 @@ On macOS, threads are assigned scheduling priorities:
| Demodulator Pre-Thread | `SCHED_FIFO` | max - 1 |
| Demodulator Thread | `SCHED_FIFO` | max - 1 |
| Audio Thread (controller) | `SCHED_RR` | max - 1 |
| Audio Sink Thread | `SCHED_RR` | max - 1 |
Note: SDR Thread has `SCHED_FIFO` priority code but it is currently commented out.
docs/plans/resolve-todos.md
+2 -2
View File
@@ -18,8 +18,8 @@ Multiple TODO/FIXME markers in project source code:
| `DemodulatorThread.cpp` | `TODO: handle digital modems with audio output` | Convert to GitHub issue |
| `DemodulatorMgr.cpp` | `TODO: This is probably unnecessary and confusing` | Investigate and either fix or remove |
| `SoapySDRThread.cpp` | Various TODOs about timing and bandwidth (x3) | Convert to GitHub issues |
| `GainCanvas.cpp` | `TODO: if not desirable, do not update in AGC mode` | Convert to GitHub issue |
| `ScopeCanvas.cpp` | `TODO: find out why frontbuffer drawing stopped in wx 3.1.0?` | Investigate; may be fixed in newer wxWidgets |
| `GainCanvas.cpp` | `TODO: if it not desirable, do not update in AGC mode` | Convert to GitHub issue |
| `ScopeCanvas.cpp` | `TODO: find out why frontbuffer drawing has stopped working in wx 3.1.0?` | Investigate; may be fixed in newer wxWidgets |
| `PrimaryGLContext.cpp` | `TODO: Better recording indicator...` | Convert to GitHub issue |
| `BookmarkView.cpp` | `TODO: keys for other actions?` | Convert to GitHub issue |
docs/plans/split-appframe.md
+1 -1
View File
@@ -4,7 +4,7 @@ See also: [RECOMMENDATIONS.md](../RECOMMENDATIONS.md) | [PLAN.md](../PLAN.md) |
## Current State
- `AppFrame.cpp`: ~2,700 lines in a single file
- `AppFrame.cpp`: ~3,200 lines in a single file
- `AppFrame.h`: multiple hundreds of lines
- Handles menus, keyboard, device management, UI layout, hamlib, sessions, idle handlers, and accessors