diff options
| author | Martin Braun <martin.braun@ettus.com> | 2014-03-07 16:18:16 +0100 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2014-03-07 18:10:21 +0100 |
| commit | e44fe2887ad3755c9320b77d8ac3e5162a9ac665 (patch) | |
| tree | b66b77c1643a87346a8014d50e850e63668d268e /gr-vocoder/doc/vocoder.dox | |
| parent | 01c4267261937e495545942131b5bd496eba2269 (diff) | |
vocoder: Fixed GSM GRC bindings and improved docs, provided example
Diffstat (limited to 'gr-vocoder/doc/vocoder.dox')
| -rw-r--r-- | gr-vocoder/doc/vocoder.dox | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/gr-vocoder/doc/vocoder.dox b/gr-vocoder/doc/vocoder.dox index 3973ca56fc..0e12566a80 100644 --- a/gr-vocoder/doc/vocoder.dox +++ b/gr-vocoder/doc/vocoder.dox @@ -20,4 +20,14 @@ by using: help(vocoder) \endcode +\section using Using the vocoders + +Note that most vocoders use short inputs instead of floats. This means you +must convert audio signals from float to short by using a type conversion +and a scaling factor. See the examples. + +The format of the encoded audio is different for every encoder. See the +individual block's documention for the data format. Encoded data is usually +a vector of fixed length, and can either be packed or unpacked. + */ |