Documentation for mp3dec_ex_read_frame()?
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- c
- Domain
- documentation
Research direction
The request is to add the missing README.md documentation for mp3dec_ex_read_frame(). Start by reading the function's declaration and implementation (search the single header for mp3dec_ex_read_frame) and the commit d86f4cbc that added frame_info, focusing on whether frame_info must be reset after mp3dec_ex_seek. Then document the zero-initialization and seek behavior in README.md; done means a newcomer can tell from the README alone how to use frame_info.
Written by the indexing model from the issue text.
Description
It took me a while, but I'm finally updating my Rust bindings: https://github.com/mgeier/minimp3_ex-sys/pull/3
While doing that, I didn't find any documentation of mp3dec_ex_read_frame() in the README.md.
I think its usage is mostly clear from its similarity with mp3dec_ex_read(), but I'm wondering about the exact requirements for the frame_info parameter (which has been added in d86f4cbc9742c45b94cfb3e6cd86b951eeea7e5c).
I understand that it has to be zero-initialized in the beginning, but does it have to be reset at any later point in time?
Especially when seeking, should frame_info be reset after that or not?
- Dominant language
- C
- Stars
- 2k
- Forks
- 271
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from lieff/minimp3
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
[Bug]signed left-shift overflow in mp3dec_skip_id3v1 when parsing the APEv2 tag-size field (CWE-190)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Integer overflow in Xing/Info VBR header parsing leads to ~10TB allocation (DoS)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 Half a day Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
Similar issues
-
Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/nuttx-apps#3942 ·
Maintainers usually reply within 1 day
-
Add missing unit tests for IsAdmissionPolicyName and IsCertManagerResourceNamePossibly taken @a1h8 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
kubernetes-sigs/security-profiles-operator#3644 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 70/100
ly05010419/MacNativeGames#1340 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day