Feat/gpu decode

[LemurPwned]

Summary by Sourcery

Add experimental GPU decoding support for NVIDIA GPUs. Update documentation to describe the new feature and its limitations.

New Features:

• Add experimental support for GPU-based video decoding using NVIDIA GPUs.

Tests:

• Add tests for the new GPU video sampler.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces GPU decoding support as an experimental feature. It adds a --use-gpu-decoder flag to the command-line interface and a corresponding configuration option. The implementation uses the PyNvVideoCodec library for decoding and includes considerations for timestamp estimation and keyframe handling. Documentation and dependencies are updated accordingly.

Sequence diagram for GPU video decoding process

sequenceDiagram
    participant User
    participant GPUVideoSampler
    participant CUDA
    participant NvDecoder
    User->>GPUVideoSampler: sample(video_path)
    GPUVideoSampler->>CUDA: init()
    GPUVideoSampler->>CUDA: create context
    GPUVideoSampler->>NvDecoder: create decoder
    loop For each packet
        NvDecoder->>NvDecoder: decode frame
        NvDecoder->>GPUVideoSampler: return decoded frame
        GPUVideoSampler->>GPUVideoSampler: process frame
    end
    GPUVideoSampler->>CUDA: cleanup context

Loading

Class diagram showing the new GPU sampler implementation

classDiagram
    class BaseSampler {
        +sample(video_path: str)
        +write_queue(path: str, q: Queue, subs: str)
        +init_sampler()
    }
    class VideoSampler {
        +sample(video_path: str, subs: str)
        +write_queue(video_path: str, q: Queue, subs: str)
    }
    class GPUVideoSampler {
        +sample(video_path: str, subs: str)
        note for GPUVideoSampler "New GPU-based implementation"
    }
    BaseSampler <|-- VideoSampler
    VideoSampler <|-- GPUVideoSampler

Loading

File-Level Changes

Change	Details	Files
Added GPU decoding support.	Added --use-gpu-decoder flag to enable GPU decoding. Added use_gpu_decoder option to the SamplerConfig. Added GPUVideoSampler class. Updated documentation to describe GPU decoding usage and limitations. Added PyNvVideoCodec to dependencies. Updated changelog to reflect the addition of GPU decoding support. Added a config file example for GPU decoding. Refactored type hints for optional arguments. Added error handling for missing GPU decoding dependencies.	video_sampler/__main__.py video_sampler/config.py video_sampler/samplers/__init__.py video_sampler/samplers/gpu_sampler.py video_sampler/samplers/video_sampler.py video_sampler/samplers/base_sampler.py pyproject.toml README.md CHANGELOG.md configs/hash_gpu.yaml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @LemurPwned - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 4 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}