Export labeled frames stuck after adding an SLP file as a video

[hl8536]

Bug description

Export labeled frames stuck at 76.5% and does not progress. I suspect that this is due to my erroneous addition of a predictions.slp file as a video into the project. This also broke the videos pane, which now displays 0 videos instead of the total of 6. This means I cannot remove the incorrectly added video. I cannot replace this video either as the "replace video" options looks for another file with the same .slp extension.

Please advise on how to resolve this issue and proceed with labels export. Thanks!

Screenshots

[Marielamend]

Hi @hl8536!
Just wanted to check in to see if you resolved this issue or needed additional help?

Best,
Mariela

[hl8536]

Hi @hl8536! Just wanted to check in to see if you resolved this issue or needed additional help?

Best, Mariela

Fixed the issue by directly editing the project.slp file itself and with some patchwork with various files. However, this was not a straightforward fix and required going beyond what is possible within the intended user interface. It might be good for developers to address this issue for future users who may encounter something similar, as I could resolve this only with the help of someone who had significantly more experience working with SLEAP backend.

[talmo]

Hi @hl8536,

Thanks for letting us know. It sounds like the source of the issue is that you were able to add an SLP file as a video in the first place.

I'm reopening this so we can look into why this is even possible and to fix it. If you're able to share any details about how you fixed it, that might also help us reproduce it.

Alternatively, if you still have the SLP file (male_broken.slp) and wouldn't mind sharing it with us, it'll help us diagnose the root problem and how to prevent it from happening in the future.

Thanks,

Talmo

[hl8536]

Hi @hl8536,

Thanks for letting us know. It sounds like the source of the issue is that you were able to add an SLP file as a video in the first place.

I'm reopening this so we can look into why this is even possible and to fix it. If you're able to share any details about how you fixed it, that might also help us reproduce it.

Alternatively, if you still have the SLP file (male_broken.slp) and wouldn't mind sharing it with us, it'll help us diagnose the root problem and how to prevent it from happening in the future.

Thanks,

Talmo

Submitted. Thanks for taking a look.

[talmo]

Update: Tracked down the root of the problem -- we can import SLP files as videos because we support packaged videos with embedded images. Specifically, here:

sleap/sleap/gui/dialogs/importvideos.py

Lines 79 to 97 in d4ad3bb

	any_video_exts = " ".join(["*." + ext for ext in available_video_exts()])
	media_video_exts = " ".join(["*." + ext for ext in MediaVideo.EXTS])
	hdf5_video_exts = " ".join(["*." + ext for ext in HDF5Video.EXTS])
	numpy_video_exts = " ".join(["*." + ext for ext in NumpyVideo.EXTS])
	imgstore_video_exts = " ".join(["*." + ext for ext in ImgStoreVideo.EXTS])
	siv_video_exts = " ".join(["*." + ext for ext in SingleImageVideo.EXTS])
	filenames, filter = FileDialog.openMultiple(
	None,
	"Select videos to import...", # dialogue title
	".", # initial path
	f"Any Video ({any_video_exts});;"
	f"Media ({media_video_exts});;"
	f"HDF5 ({hdf5_video_exts});;"
	f"Numpy ({numpy_video_exts});;"
	f"ImgStore ({imgstore_video_exts});;"
	f"Single image ({siv_video_exts});;"
	"Any File (*.*)",
	)

sleap/sleap/io/video.py

Lines 1628 to 1640 in d4ad3bb

	def available_video_exts() -> Tuple[str]:
	"""Return tuple of supported video extensions.
	Returns:
	Tuple of supported video extensions.
	"""
	return (
	MediaVideo.EXTS
	+ HDF5Video.EXTS
	+ NumpyVideo.EXTS
	+ SingleImageVideo.EXTS
	+ ImgStoreVideo.EXTS
	)

sleap/sleap/io/video.py

Line 66 in d4ad3bb

EXTS = ("h5", "hdf5", "slp")

We could remove "slp" from that list, but I'm not sure if this will break other stuff. Maybe it's safer to just check for embedded files?

Alternatively, since we really don't support direct SLP file import as videos alone, maybe we should just remove it from the import videos command.

In any case, the appropriate way of importing SLP files is via the File --> Merge functionality, which properly imports all the contents of a SLP file and deduplicates things where possible.

Given the low chance of this affecting others, I'm going to convert it to a discussion. If anyone else runs into this edge case, please let us know and we'll prioritize a smarter GUI functionality to prevent this from reoccurring.