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

Workaround for av context closing issue when using AUTO thread_type #8555

Merged
merged 2 commits into from
Oct 18, 2024

Conversation

azhavoro
Copy link
Contributor

@azhavoro azhavoro commented Oct 17, 2024

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Bug Fixes

    • Improved video processing stability by disabling threading in video reading classes, addressing potential memory management issues.
  • New Features

    • Enhanced video handling capabilities with updated threading parameters for better performance during video processing.

@azhavoro azhavoro requested a review from Marishka17 as a code owner October 17, 2024 12:58
Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

Walkthrough

The changes in this pull request focus on the VideoReader and VideoReaderWithManifest classes within the media_extractors.py file. The modifications primarily involve the handling of threading during video processing. The default value of the allow_threading parameter has been changed from True to False, which impacts how video streams are processed. Additionally, adjustments were made to the _AvVideoReading class to disable 'AUTO' threading, addressing potential threading issues related to memory management and stream handling. No new methods were introduced, and existing methods remain intact.

Changes

File Change Summary
cvat/apps/engine/media_extractors.py Updated VideoReader constructor to set allow_threading default to False.
Modified threading behavior in VideoReader and VideoReaderWithManifest classes.
Adjusted _AvVideoReading to disable 'AUTO' threading type for video streams.
Internal logic of iterate_frames methods updated for threading in VideoReader and VideoReaderWithManifest.

Poem

In the land of streams and frames,
A rabbit hops through video games.
With threading now a gentle breeze,
Processing flows with such great ease.
So let us cheer, with joy and glee,
For smoother paths, as bright as can be! 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@azhavoro azhavoro requested a review from nmanovic as a code owner October 17, 2024 12:59
@azhavoro azhavoro requested review from bsekachev and removed request for nmanovic and Marishka17 October 17, 2024 13:00
Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (1)
cvat/apps/engine/media_extractors.py (1)

555-556: Consider adding a reference to an issue tracker for context closing problem

The comments indicate that context closing may get stuck on some videos for an unknown reason, and the thread_type == 'AUTO' setting is disabled for future investigation. To aid in tracking and resolving this issue, consider adding a TODO comment with a reference to an issue number or link to the issue tracker.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ffe45fe and 4ddf0ea.

📒 Files selected for processing (1)
  • cvat/apps/engine/media_extractors.py (4 hunks)
🧰 Additional context used
🔇 Additional comments (2)
cvat/apps/engine/media_extractors.py (2)

640-641: Explicitly setting thread_type to 'NONE' when threading is disabled

The addition of video_stream.thread_type = 'NONE' ensures that threading is explicitly disabled when allow_threading is False. This change aligns with the intention to prevent threading-related issues during video processing.


802-803: Consistent threading behavior in VideoReaderWithManifest

Setting video_stream.thread_type to 'NONE' in the VideoReaderWithManifest class maintains consistency with the VideoReader class when threading is disabled. This ensures that both classes handle threading in the same manner when allow_threading is False.

@@ -583,7 +585,7 @@ def __init__(
stop: Optional[int] = None,
dimension: DimensionType = DimensionType.DIM_2D,
*,
allow_threading: bool = True,
allow_threading: bool = False,
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

⚠️ Potential issue

Issue Found: VideoReader Instantiation Missing allow_threading Parameter

An instance of VideoReader is instantiated without explicitly setting allow_threading, which may lead to unintended side effects due to the default value change.

  • cvat/apps/engine/migrations/0024_auto_20191023_1025.py:68:
    reader = VideoReader([original_video], get_frame_step(frame_filter), start_frame, _stop_frame)
🔗 Analysis chain

Changing default allow_threading to False may introduce unintended side effects

Changing the default value of allow_threading from True to False might impact existing functionality that relies on threading being enabled by default. Please verify that all usages of the VideoReader class are reviewed and updated if necessary to prevent any unintended behavior.

Run the following script to identify instances where VideoReader is instantiated without explicitly setting allow_threading:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find all instantiations of VideoReader without 'allow_threading' parameter specified.

# Expected Output: List of files and line numbers where 'VideoReader' is instantiated without 'allow_threading'.

ast-grep --lang python --pattern $'VideoReader($_, $_, $_, $_, $_)'

Length of output: 68


Script:

#!/bin/bash
# Description: Find all instantiations of VideoReader without 'allow_threading' parameter specified, regardless of the number of parameters.

# Expected Output: List of files and line numbers where 'VideoReader' is instantiated without 'allow_threading'.

ast-grep --lang python --pattern $'VideoReader($_, $$$)' | \
  grep -v 'allow_threading='

Length of output: 257

Copy link

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.26%. Comparing base (c557f70) to head (9f2cacb).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8555      +/-   ##
===========================================
- Coverage    74.26%   74.26%   -0.01%     
===========================================
  Files          400      400              
  Lines        43218    43224       +6     
  Branches      3909     3909              
===========================================
+ Hits         32096    32100       +4     
- Misses       11122    11124       +2     
Components Coverage Δ
cvat-ui 78.72% <ø> (ø)
cvat-server 70.46% <71.42%> (-0.01%) ⬇️

@azhavoro azhavoro merged commit 5be5d59 into develop Oct 18, 2024
34 checks passed
@azhavoro azhavoro deleted the az/fix-task-creating branch October 18, 2024 09:58
@cvat-bot cvat-bot bot mentioned this pull request Oct 18, 2024
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.

3 participants