Repository navigation
fix(export): let an MP4 export be cancelled mid-render - #1044
Merged
Merged
Conversation
…ed file run_composited_multi now takes the GIF export's control (renamed ExportControl, shared by both formats) and checks it before every frame on all three platforms. The MP4 is muxed into a staged file beside the destination and renamed over it once complete: a cancel leaves no partial and an existing file intact. RAII guards close the muxer on every exit. On Windows the leaked handle made the partial MP4 undeletable. The addon adds create_mp4_export_control / cancel_mp4_export and an optional control on export_multi; a cancelled export rejects with MP4_EXPORT_CANCELLED.
Every export now carries an ID and runs as a job of its window, MP4 like GIF, so the dialog's Cancel reaches the native control. The registry and the cancel action (cancelExport) are no longer GIF-specific. An addon built before MP4 cancellation still exports: it refuses the cancel, and the dialog goes back to showing the progress instead of a frozen spinner.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (22)
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 4 remain after this review. 📝 WalkthroughWalkthroughMP4 exports can now be cancelled through the shared export-job path used by GIF exports. The platform pipelines check cancellation during frame processing and write to staged files before publishing output. The export dialog, native bridge, and IPC layer pass export IDs and cancellation requests through the stack. ChangesShared MP4 and GIF export cancellation
Priority: ➖ Normal Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Bug fix · Severity of issue fixed: Medium Sequence Diagram(s)sequenceDiagram
participant ExportDialog
participant compositorViewClient
participant nativeBridge
participant ExportJobs
participant CompositorViewService
participant NAPI
participant run_composited_multi_cancellable
ExportDialog->>compositorViewClient: Start MP4 export with exportId
compositorViewClient->>nativeBridge: Send exportMulti request
nativeBridge->>ExportJobs: Register export job
ExportJobs->>CompositorViewService: Start export job
CompositorViewService->>NAPI: Call exportMulti with ExportControl
NAPI->>run_composited_multi_cancellable: Render with shared control
ExportDialog->>compositorViewClient: Send cancelExport with exportId
compositorViewClient->>nativeBridge: Send cancelExport request
nativeBridge->>ExportJobs: Cancel matching job
ExportJobs->>CompositorViewService: Invoke job cancellation
CompositorViewService->>NAPI: Call cancelMp4Export
NAPI->>run_composited_multi_cancellable: Observe cancellation during frame processing
Merge Risk: ⚪ Minimal · up to No actionable issue is established from the supplied evidence. The in-app MP4 cancellation scenario should still be checked with a rebuilt addon as planned. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 46.43% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 56 functions across 20 files. (2 skipped: 2 unsupported.)
✨ Finishing Touches 💡 2📝 Generate docstrings 💡
🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Warning Some tools did not complete. Review the errors below. 🔧 Clippy (1.98.1)Clippy execution failed Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
1 participant
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
ExportControlbefore every frame on Windows, macOS and Linux. The MP4 is staged beside the destination and renamed over it only once complete, so a cancel leaves no partial file and an existing destination untouched.createMp4ExportControl/cancelMp4Export. The main process runs MP4 exports through the per-window export jobs (renamed from the GIF-only registry), and the cancel action is nowcancelExportfor both formats..partial.mp4beside the destination, and a destination locked by another program fails at the end of the render instead of the start.Related issue
Closes #1014
Type of change
Release impact
Desktop impact
Testing
cargo test -p openscreen-compositor --lib, plus--test export_timingwith generated media: the new GPU test cancels mid-render, stops at the next frame, returnsExportCancelled, keeps the destination and leaves no partial file.cargo check -p openscreen-compositor -p compositor-view-napi --all-targetson Windows; macOS and Linux compile in CI.🤖 Generated with Claude Code