feat: add optional reused frame callbacks for zero-copy observers#65
Open
wnnce wants to merge 1 commit into
Open
feat: add optional reused frame callbacks for zero-copy observers#65wnnce wants to merge 1 commit into
wnnce wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds opt-in reused observer callbacks for RTC raw video, encoded video, and selected
audio frame callbacks.
The goal is to reduce per-frame allocations in high-frequency observer paths. The existing
observer callbacks keep their current copy-based behavior. The new callbacks expose SDK-owned
buffers through
unsafe.Sliceand let callers decide when and how to copy into their ownmemory.
What Changed
New observer callbacks
VideoFrameObserver.OnReusedFrameVideoEncodedFrameObserver.OnReusedEncodedVideoFrameAudioFrameObserver.OnReusedRecordAudioFrameAudioFrameObserver.OnReusedPlaybackAudioFrameAudioFrameObserver.OnReusedMixedAudioFrameAudioFrameObserver.OnReusedEarMonitoringAudioFrameCallback behavior
OnPlaybackAudioFrameBeforeMixingis intentionally unchanged.Examples
Added dedicated examples for the new APIs:
go_sdk/examples/send_recv_yuv_reusedgo_sdk/examples/recv_h264_reusedgo_sdk/examples/recv_pcm_reusedThese examples demonstrate the intended usage pattern:
copy inside the callback if the data must outlive the callback.
API Contract
The reused callbacks expose SDK-owned memory and therefore have stricter lifetime rules:
goroutine
This keeps the zero-copy optimization isolated to explicit opt-in APIs without changing the
safety guarantees of the existing callbacks.
Compatibility
This change is backward compatible.
OnReused...callbacks opt into the new memorycontract.