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

Remove crashy unwrap() in on_error #1364

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

emilk
Copy link
Contributor

@emilk emilk commented Oct 4, 2024

I got a crash here, and I don't want a crash :)

thread 'av1_decoder' panicked at 'called `Option::unwrap()` on a `None` value'
6f12e3f/src/decode.rs:4997

It seems like this unwrap was introduced in #663 along with many others.

May I suggest enabling the clippy::unwrap_used lint? Any .unwrap() is a panic waiting to happen :/

EDIT: The crash happens during decode of the chunk starting at timestamp 114176 of this video: https://storage.googleapis.com/rerun-test-assets/video/Sintel_1080_10s_av1.mp4

Comment on lines +4997 to +5000
if f.frame_hdr
.as_ref()
.is_some_and(|frame_hdr| frame_hdr.refresh_context != 0)
{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure what the right behavior is in the None case, but crashing is certainly not it

Copy link
Collaborator

Choose a reason for hiding this comment

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

Places where there is an unwrap should have been unchecked derefs in C, so let me check what C was doing here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

So C is doing the same thing as we are here:

Can you check if you get an error/crash on dav1d here or not? Thanks!

Copy link
Contributor Author

@emilk emilk Oct 4, 2024

Choose a reason for hiding this comment

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

Using https://crates.io/crates/dav1d 0.10.3 I do not get a crash, but I get an Invalid argument error and some useful info printed:

Error parsing frame header
Error parsing OBU data

It should be noted though that dereferencing a null pointer is not necessarily a crash in C - it is Undefined Behavior. The compiler is free to assume the pointer is not null, and do whatever crazy shenanigans that implies.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm, it's possible UB could be doing something weird here, but I'd still expect a segfault for the most part. We likely diverged at some point, so we'll have to figure out where and see if that's something we need to fix or if it's okay to crash, just in a different place.

That said, this video should successfully decode with normal dav1d, but doesn't? Is that a bug with dav1d as well?

Copy link
Contributor Author

@emilk emilk Oct 7, 2024

Choose a reason for hiding this comment

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

or if it's okay to crash

I would prefer a rav1d that never crashes on any input, but returns errors.

That said, this video should successfully decode with normal dav1d, but doesn't? Is that a bug with dav1d as well?

I don't know if the video should successfully decode, or if it is actually a bad video.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would prefer a rav1d that never crashes on any input, but returns errors.

Yup, that would definitely be preferable.

Copy link
Collaborator

@kkysen kkysen left a comment

Choose a reason for hiding this comment

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

What input were you running this on?

@emilk
Copy link
Contributor Author

emilk commented Oct 4, 2024

I was running this video (the crash happens about half-way through it):

https://storage.googleapis.com/rerun-test-assets/video/Sintel_1080_10s_av1.mp4

The crash happens during decode of the chunk starting at timestamp 114176

@kkysen
Copy link
Collaborator

kkysen commented Oct 21, 2024

Hi @emilk, I have some time to look into this bug now. What specific command did you use on Sintel_1080_10s_av1.mp4 that triggered the bug? Sorry, I'm not super familiar with all of the CLI options besides what's run in the tests.

@emilk
Copy link
Contributor Author

emilk commented Nov 4, 2024

Sorry, I don't have a simple repro for you. I used the dav1d API added in #1362

@kkysen
Copy link
Collaborator

kkysen commented Nov 11, 2024

Sorry, I don't have a simple repro for you. I used the dav1d API added in #1362

Hi @emilk. I'm going to need a way to reproduce this to figure it out.

I tried running this:

> wget https://storage.googleapis.com/rerun-test-assets/video/Sintel_1080_10s_av1.mp4
> ffmpeg -i Sintel_1080_10s_av1.mp4 -c:v copy -f ivf Sintel_1080_10s_av1.ivf
> cargo build --release
> target/release/dav1d -i tests/large/Sintel_1080_10s_av1.ivf -o /dev/null
dav1d 966d63c1 - by VideoLAN
Decoded 223/300 frames (74.3%) - 968.60/30.00 fps (32.29x)Error decoding frame: Invalid argument
Error decoding frame: Invalid argument
Decoded 298/300 frames (99.3%) - 897.67/30.00 fps (29.92x)
> dav1d -i tests/large/Sintel_1080_10s_av1.ivf -o /dev/null
dav1d 1.5.0 - by VideoLAN
Decoded 223/300 frames (74.3%) - 889.49/30.00 fps (29.65x)Error decoding frame: Invalid argument
Error decoding frame: Invalid argument
Decoded 298/300 frames (99.3%) - 857.72/30.00 fps (28.59x)

So I'm getting the exact same two Error decoding frame: Invalid argument errors that dav1d is getting in the same location in the video. I'm not seeing any .unwrap() or crashes.

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