roc-streaming / roc-toolkit

Real-time audio streaming over the network.

https://roc-streaming.org

Mozilla Public License 2.0

1.06k stars 211 forks source link

Closed nolan-veed closed 12 months ago

nolan-veed commented 12 months ago

Why

Chose to use a struct for the layout of the slot when supplying memory to user.
- Owner is first member, then canary guard, then zero-length array data.
- The actual data follows, then another canary guard.
Added new flag.
Updated logic to set/check owner.
Some compile time enums/structs for sizeof AlignMax and aligning size based on that.
- This is so that embedded storage size is easily calculated, with the size per slot in the impl class.

gavv commented 12 months ago

CI is failing (doxygen). BTW if you install doxygen and pass --enable-doxygen to scons, you'll be able to catch these issues locally. See https://roc-streaming.org/toolkit/docs/building/developer_cookbook.html

nolan-veed commented 12 months ago

Sorry about that.

gavv commented 12 months ago

LGTM, thanks!

gavv commented 12 months ago

Here is a small follow-up commit: 25e4d98307d43b28e7e28e8f364bf742ef1e0609

improved comments
fixed calculation of slotsize: moved max() call inside align_max() call (needed in potential case when Slot is not max-aligned)
fixed calculation of object_sizepadding: take into account possible alignment for SlotHeader (needed in potential case when SlotHeader os not max-aligned)

I think in practice both Slot and SlotHeader will be max-aligned, but since it's not guaranteed and explicit, I fixed the code to handle it.