Skip to content

Add known issue about overflow to docs #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ed-xmos merged 3 commits into from
Oct 20, 2023
Merged

Add known issue about overflow to docs #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e47c082
Add known issue about overflow to docs
ed-xmos Oct 18, 2023
994f4b3
Character spacing
ed-xmos Oct 18, 2023
dd1f4cb
Fix changelog
ed-xmos Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ lib_src change log
library
* ADDED: Auto-generated ASRC and SSRC performance plots in documentation
* CHANGED: Documents built under Jenkins instead of Github Actions
* ADDED: Documentation warning about overflow in XS3 optimized SRC components

2.3.0
-----
Expand Down
6 changes: 6 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ There are three different component options that support fixed factor of 3 up/do
#. If voice quality (65 dB SNR) is required running on xCORE-200, use ds3_voice or us3_voice.
#. If voice quality (75 dB SNR) is required running xcore-ai, use ff3_96t_ds or ff3_96t_us.

.. warning::
Synchronous fixed factor of 3 and 3/2 downsample and oversample functions for voice applications optimized for the XS3 Vector Processing Unit
currently overflow rather than saturate in cases where a full scale input causes a perturbation above full scale at the output.
To avoid this scenario, please ensure that the input amplitude is always 3.5 dB below full scale.
The overflow behavior of these SRC components will be replaced by saturating behavior (to match all other SRC components) in a future release.


Related Application Notes
.........................
Expand Down
6 changes: 6 additions & 0 deletions doc/programming_guide/fixed_ratio_src.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,12 @@ They have been designed for voice applications and, in particular, conformance t
.. note::
These filters will only run on XCORE-AI due to the inner dot product calculation employing the XS3 VPU.

.. warning::
Synchronous fixed factor of 3 and 3/2 downsample and oversample functions for voice applications optimized for the XS3 Vector Processing Unit
currently overflow rather than saturate in cases where a full scale input causes a perturbation above full scale at the output.
To avoid this scenario, please ensure that the input amplitude is always 3.5 dB below full scale.
The overflow behavior of these SRC components will be replaced by saturating behavior (to match all other SRC components) in a future release.


.. _ff3_voice_vpu_hdr:

Expand Down