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

Mitigate corruption, ask for an IDR every X frames #140

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

BradyBrenot
Copy link
Contributor

@BradyBrenot BradyBrenot commented Aug 8, 2024

To mitigate #117 (Compression artifacts forming when left on the same scene for a while), request an IDR frame from the host every 1000 packets. This seems to reset the decoder well enough to completely avoid slow corruption problem, but shouldn't add too much extra bandwidth.

Unless I'm missing something, Sunshine never sends I or IDR frames after initially establishing the stream unless it's specifically asked to by the client.

(This is a hacky mitigation, not a proper fix. It works but it's not the ideal fix. Since this only seems to happen on this platform, I'm guessing either we're touching memory we shouldn't / in a way we shouldn't, or ffmpeg has a hardware acceleration bug on this platform. Tracking down the root cause is a pain though, especially with UWP's limitations)

Summary by CodeRabbit

  • New Features

    • Improved video decoding stability by implementing a threshold for requesting IDR frames, enhancing performance during frame corruption scenarios.
  • Bug Fixes

    • Enhanced handling of frame management to prevent video output issues.

To mitigate TheElixZammuto#117 (Compression artifacts forming when left on the same scene for a while), request an IDR frame from the host every 1000 packets. This seems to reset the decoder well enough to completely avoid slow corruption problem, but shouldn't add too much extra bandwidth.

Unless I'm missing something, Sunshine never sends I or IDR frames after initially establishing the stream unless it's specifically asked to by the client.
Copy link

coderabbitai bot commented Aug 8, 2024

Walkthrough

The recent modifications to the FFmpeg decoder enhance video frame processing by implementing a mechanism to request IDR frames when a specified threshold of frames is exceeded. By introducing a new constant and a counter for frames since the last IDR, the decoder improves its ability to handle frame corruption, ensuring more stable and higher-quality video playback.

Changes

Files Change Summary
Streaming/FFmpegDecoder.cpp, Streaming/FFmpegDecoder.h Added MAX_DELAY_BETWEEN_IDR_FRAMES constant and framesSinceLastIDR variable to improve IDR frame management and overall decoding stability.

Poem

🐇
In the land of frames so bright,
We count each one with delight.
If too many pass by my way,
An IDR frame I shall say!
Hopping through scenes, clear and fast,
Stability's here, at long last!
🎥


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2f5289c and bdffb80.

Files selected for processing (2)
  • Streaming/FFmpegDecoder.cpp (3 hunks)
  • Streaming/FFmpegDecoder.h (1 hunks)
Additional comments not posted (4)
Streaming/FFmpegDecoder.h (1)

47-47: Addition of framesSinceLastIDR aligns with PR objectives.

The new member variable framesSinceLastIDR in the Decoder struct is a crucial addition for tracking the number of frames since the last IDR frame. This aligns well with the PR's goal to mitigate corruption by periodically requesting IDR frames.

Streaming/FFmpegDecoder.cpp (3)

19-19: Macro MAX_DELAY_BETWEEN_IDR_FRAMES sets a clear threshold.

The definition of MAX_DELAY_BETWEEN_IDR_FRAMES with a value of 1000 frames provides a clear threshold for requesting IDR frames, aligning with the PR's objective to manage frame corruption.


169-169: Initialization of framesSinceLastIDR is necessary.

Setting framesSinceLastIDR to zero in the Init function is essential for correctly tracking the number of frames since the last IDR frame from the start of the decoding process.


222-226: Implementation of periodic IDR frame requests is well-aligned with objectives.

The logic in SubmitDU to increment framesSinceLastIDR and request an IDR frame when the threshold is exceeded is a well-executed implementation of the PR's goal to mitigate video corruption.

@BradyBrenot
Copy link
Contributor Author

I would have liked to have only sent this when the decoder starts to get weird, but I couldn't find any way to detect that. Tried logging anything I could find and nothing really stands out.

@BradyBrenot
Copy link
Contributor Author

I haven't checked:

  • Are there missed frames when the corruption starts? That might be a usable signal.
  • Does the modified frame slicing Sunshine work? (If frame slicing functions, I assume it will, it should be similar to this but smeared out over more frames)

@BradyBrenot
Copy link
Contributor Author

BradyBrenot commented Aug 9, 2024

Looks like missed frames can't be used, at least not for the issue as it happens to me. 0 missed frames and still the corruption starts.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bdffb80 and c51eb76.

Files selected for processing (1)
  • Streaming/FFmpegDecoder.cpp (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • Streaming/FFmpegDecoder.cpp

Copy link

sonarcloud bot commented Aug 9, 2024

@TheElixZammuto
Copy link
Owner

Hi @BradyBrenot,

Just to confirm, have you checked the Sunshine build here #117 (comment) ?

In practice the commit LizardByte/Sunshine@4840aaa of the test build of Sunshine should already do this but on NVEnc only (the issue only occurs there IIRC), on the server side.

#define DECODER_BUFFER_SIZE 1048576
#define MAX_DELAY_BETWEEN_IDR_FRAMES 1000
Copy link
Owner

Choose a reason for hiding this comment

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

Is there a reason for the 1000 value or it's just due to empircal tests?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants