jgaeddert / liquid-dsp

digital signal processing library for software-defined radios
http://liquidsdr.org
MIT License
1.9k stars 443 forks source link

liquidsdr.org AGC function documentation incorrect #142

Open twitchyliquid64 opened 6 years ago

twitchyliquid64 commented 6 years ago

Sorry if this is the wrong spot.

The docs here mention:

agc_crcf_set_gain_limits(q,gmin,gmax) sets the minimum and maximum gain values, respectively. This effectively specifies e0 and e1 as in [fig-agc-transfer-function] .

This function does not exist:

# github.com/twitchyliquid64/go-liquiddsp
./agc.go:19:2: could not determine kind of name for C.agc_crcf_set_gain_limits

FAIL    github.com/twitchyliquid64/go-liquiddsp [build failed]

Couldnt find a report link on the site for this, so thought I would open a bug here.

jgaeddert commented 6 years ago

Ah, good catch. Reporting here is fine. You can also email me directly using joseph at liquid sdr dot org.

tomneda commented 6 months ago

Hello Joseph,

just stumbled on the same problem here. Needed to limit the maximum gain of the AGC but did not find in the documentation https://liquidsdr.org/doc/agc/ mentioned interface agc_crcf_set_gain_limits().

Also, I wanted to play around with agc_crcf_squelch_enable_auto() but also did not find it in the interface. But I do not really need that.

As you describe the caption auto-squelch in such in detail I would expect the code will somehow exists for agc_crcf_squelch_enable_auto() or maybe also agc_crcf_set_gain_limits(). Maybe I could find it on a side-branch?