dvpackager GUI - handling failed files

libbyhopfauf commented 1 year ago

I had a few files in a queue of 10 files (packaging from 3 files) and two of them got the little X (fail) icon in the queue, but when I opened them they played fine. At first I thought this might happen when a segment happens to end with a timecode break at the last frame. For the first two times it happened in my particular instance, the two files that failed to encode did end with a timecode break, but since then, not all files that end that way fail, but most of the ones that fail do contain a timecode break. See images below and example files here. Screen Shot 2023-03-22 at 5 54 45 PM

Screen Shot 2023-03-22 at 6 00 52 PM

libbyhopfauf commented 1 year ago

After the dvpackager process runs there's a bunch of checks to make sure everything is as expected (like that the source and output have the same frame counts). Currently we have 3 error codes:

file-missing (as in ffmpeg failed to create an output file)
audio-video-duration-mismatch
input-output-framecount-mismatch We don't have (yet) a method for the gui to show the error code (or to potentially show the ffmpeg output log for debugging). Any ideas how to present that?

Originally posted by @dericed in https://github.com/mipops/dvrescue/issues/617#issuecomment-1482956244

libbyhopfauf commented 1 year ago

@dericed That's super helpful to know about the error codes! I think for "missing file" we could continue using the fail icon and add a hover message that says the file is missing. For the other two errors, we could one of two things:

make it so that instead of the fail symbol, the icon is like the ! one we use for changes in the analysis table (either the same one or I could create more of a warning symbol with the triangle and !). And (again similar to the one in the analysis table) we could make it so that when the user hovers their cursor over the icon, the error message is displayed (and possibly a note about what the user should do to resolve it or if they need to worry about it).
for the other two errors I could design a symbol for each that could be display, but we could still add the hover messages for the description and possible solutions.

Let me know what you think!

dericed commented 1 year ago

For 'missing-file' I suppose the output error is thus handled from ffmpeg. It means the output file was never written, which could happen because the output directory is write-only, or the command to ffmpeg is invalid, or some other reason.

btw with the file that gave the error can you paste in the terminal output of the command line process of dvpackager, it would be worthwhile to address that error too.

On the fail symbol, I think showing the output error is worthwhile, but perhaps the mouseover should include a link to the corresponding section of documentation. If you can create the url's, I can start on the design for an error-code lookup.
I agree about distinguishing the errors as you did and having one icon per error. Could you add them to https://github.com/mipops/dvrescue/tree/main/Source/GUI/dvrescue/dvrescue/icons and just match to the style of https://github.com/mipops/dvrescue/blob/main/Source/GUI/dvrescue/dvrescue/icons/dvpackager_processing-failed-canceled.svg.
Also maybe we should change the term from 'missing-file' to 'ffmpeg-error' since that's more accurate to what happened.

libbyhopfauf commented 1 year ago

@dericed

For 'missing-file' I suppose the output error is thus handled from ffmpeg. It means the output file was never written, which could happen because the output directory is write-only, or the command to ffmpeg is invalid, or some other reason.

btw with the file that gave the error can you paste in the terminal output of the command line process of dvpackager, it would be worthwhile to address that error too.

Sure thing! I'll see if I can recreate it and send you what I get.

On the fail symbol, I think showing the output error is worthwhile, but perhaps the mouseover should include a link to the corresponding section of documentation. If you can create the url's, I can start on the design for an error-code lookup.

I agree about distinguishing the errors as you did and having one icon per error. Could you add them to https://github.com/mipops/dvrescue/tree/main/Source/GUI/dvrescue/dvrescue/icons and just match to the style of https://github.com/mipops/dvrescue/blob/main/Source/GUI/dvrescue/dvrescue/icons/dvpackager_processing-failed-canceled.svg.

No problem! I'll work on some mock-ups next week for both the documentation and the icons!

Also maybe we should change the term from 'missing-file' to 'ffmpeg-error' since that's more accurate to what happened.

I think that makes more sense!

libbyhopfauf commented 10 months ago

How about these icons for the three issues?

Is there a way to resolve any of these? Like it would be good if we had hover tips or at least a key for them in the documentation like we do for dvanalysis that gives suggestions to resolve or at least explains how the error likely occurred. Or are these just files that dvpackager can't work with?

libbyhopfauf commented 3 months ago

@dericed what about these instead?

They would look like this in the GUI (and would have a hover tooltip):

dericed commented 2 months ago

@libbyhopfauf got icons?

libbyhopfauf commented 2 months ago

@dericed Sure do! See https://github.com/mipops/dvrescue/pull/894

mipops / dvrescue

dvpackager GUI - handling failed files #686