Skip to content
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.

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

lc3: Moved LC3 #826

Merged
merged 2 commits into from
Sep 8, 2022
Merged

lc3: Moved LC3 #826

merged 2 commits into from
Sep 8, 2022

Conversation

koffes
Copy link
Contributor

@koffes koffes commented Sep 7, 2022

Moved LC3 from separate repo to sdk-nrfxlib

Signed-off-by: Kristoffer Rist Skøien kristoffer.skoien@nordicsemi.no

@CLAassistant
Copy link

CLAassistant commented Sep 7, 2022

CLA assistant check
All committers have signed the CLA.

@@ -0,0 +1,115 @@
#
# Copyright (c) 2022 Nordic Semiconductor ASA

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this long license here? Or can we use the short 5-Clause one?

*
* All rights reserved.
*
* SPDX-License-Identifier: Nordic-5-Clause

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use the short 5-Clause license?
It looks like lc3/Cmakelists.txt uses the short one

*
* All rights reserved.
*
* SPDX-License-Identifier: Nordic-5-Clause

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use short 5-Clause here as well?

Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The readme.mds and other txt and html files cannot go into nrfxlib in the current form.
As this is a major addition to the nrfxlib and the docs, I suggest the PR to be moved to after 2.1.0.

@rlubos
Copy link
Contributor

rlubos commented Sep 8, 2022

@greg-fer @carlescufi lc3/doc/T2_LC3_API_Documentation_1.5.pdf - I don't think this file should end up in sdk-nrfxlib either? Something's causing compliance check crash, I strongly suspect this file.

@rlubos rlubos added this to the 2.1.0 milestone Sep 8, 2022
@koffes koffes force-pushed the move_lc3 branch 2 times, most recently from 646e2cc to 4b56752 Compare September 8, 2022 09:20
@b-gent
Copy link
Contributor

b-gent commented Sep 8, 2022

The readme.mds and other txt and html files cannot go into nrfxlib in the current form. As this is a major addition to the nrfxlib and the docs, I suggest the PR to be moved to after 2.1.0.

+1 to remove the milestone from this, documentation needs a thorough review and we are 1 day away from the doc improvement freeze (not mentioning this is not a doc improvement but a whole new lib getting added).

@carlescufi
Copy link
Contributor

@greg-fer @b-gent @rlubos will ping you all offline.

@koffes koffes force-pushed the move_lc3 branch 2 times, most recently from 0427c8e to 1ffecb7 Compare September 8, 2022 09:36
Copy link
Contributor

@tejlmand tejlmand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@rlubos
Copy link
Contributor

rlubos commented Sep 8, 2022

@koffes Can you sign the CLA (#826 (comment))? Or did you do that already and it's just the CLA check failure (it happens sometimes)?

Moved LC3 from separate repo to sdk-nrfxlib

Signed-off-by: Kristoffer Rist Skøien <kristoffer.skoien@nordicsemi.no>
@carlescufi
Copy link
Contributor

carlescufi commented Sep 8, 2022

@koffes Can you sign the CLA (#826 (comment))? Or did you do that already and it's just the CLA check failure (it happens sometimes)?

@rlubos I think it's a one-off because the CLA appears signed in the sdk-nrf PR:
nrfconnect/sdk-nrf#8673 (review)

@koffes
Copy link
Contributor Author

koffes commented Sep 8, 2022

As per the CLA: This work is Submitted on behalf of a third-party T2 Software/Nordic Semiconductor

@greg-fer greg-fer requested a review from b-gent as a code owner September 8, 2022 12:33
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Sep 8, 2022
lc3/README.rst Outdated Show resolved Hide resolved

/* Set unique session to 0 for using the default sharing memory setting.
*
* This could lead to higher heap consumtion, but is able to manipulate
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* This could lead to higher heap consumtion, but is able to manipulate
* This could lead to higher heap consumption, but is able to manipulate

*
* When LC3_SAMPLE_RATE_ALL and/or LC3FrameSizeBothConfig are used and the
* uniqueSessions value is less than the number of (sample rates * frame sizes),
* the codec allocates the worse case shared memory required based on the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* the codec allocates the worse case shared memory required based on the
* the codec allocates the worst case shared memory required based on the

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cannot edit this file due to legal reasons.


/**@brief Closes an LC3 Decoder session.
*
* This function closes the decodeHandle's session and and releases allocated session memory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* This function closes the decodeHandle's session and and releases allocated session memory.
* This function closes the decodeHandle's session and releases allocated session memory.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cannot edit this file due to legal reasons.

Copy link
Contributor Author

@koffes koffes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I can't approve my own PR.

lc3/README.rst Outdated
:depth: 2

Low Complexity Communication Codec (LC3) is the default software codec for the :ref:`nrf53_audio_app` application, conformant to the `Bluetooth® LE Audio specifications`_ (Bluetooth 5.2, QDID #156294).
It is used only by this application for encoding and decoding purposes, but can be used with any other audio application developed with the nRF5340 Audio DK.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite precise. I think it is better to refer to license.txt not to duplicate info

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed line.

Created a readme file with changelog included.
Moved the API PDF to FTP and included link in the readme.
Moved legal files to top folder.
Deleted original doc files.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
@carlescufi carlescufi merged commit 9a6637e into nrfconnect:main Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.