allow extension independent soundfile path, fix #642

[illwieckz]

Hi, this PR allows the engine to use extension independent sound path, so mappers can just write elemusic to load elemusic.wav or elemusic.opus, if one of them is available.

Also, the engine can load the elemusic.opus path if the bsp was compiled with elemusic.wav path. It allows asset managers to convert sound file without having to recompile the bsp.

It's the first time I'm writing some c++ lines in my life, so your comments are welcome, perhaps there is a better way to do it! 😉

This will also help out-of-tree map packaging, allowing mappers to compile their map against lossless assets and distribute them with lossy assets.

This PR fixes issue #642.

[Amanieu]

Use FS::Path::Extension and FS::Path::BaseName instead of doing it manually. Looks good otherwise.

[Kangz]

Please consider using the same approach as in tr_image: https://github.com/Unvanquished/Unvanquished/blob/master/daemon/src/engine/renderer/tr_image.cpp#L2030 as it handles paks dependencies too.
I don't like that we silently replace the extension as it is a bit confusing though. Can we only add an extension of none is present?

[DolceTriade]

Hm, I didn't read the code close enough. I agree with kangz that we should prefer extension if given, otherwise, if none is provided or the extension given is not found, then we try all the available extensions and see what sticks.

[illwieckz]

Use FS::Path::Extension and FS::Path::BaseName instead of doing it manually. Looks good otherwise.

Hum, it's ok for FS::Path::Extension, it returns .ogg if file is sound/ui/heartbeat2.ogg.
But FS::Path::BaseName is not the good one to use: it returns heartbeat2.ogg but I need sound/ui/heartbeat2.

Sorry if I fooled you with the “basename” variable, I need the full path without extension. Is there a FS::Path function to achieve that?

[Amanieu]

Oh sorry, the correct function should have been FS::Path::StripExtension

[illwieckz]

Thanks, and I will use another variable name to be more explicit. :-)

[illwieckz]

So, I modified my patch using FS::Path::Extension and FS::Path::StripExtension and with a package prioritization when looking for an alternative name if file is missing or use an unknown file format.

The travis-ci's build errored because of The command "sudo apt-key adv --keyserver x-hkp://pool.sks-keyservers.net --recv-key 06AF4C14" failed and exited with 2 during ., it's not related to this patch.

[Edit: after a force-push with the exact same code, travis-ci is fine]

[Kangz]

That's much better, thanks for the iteration! I'll merge it soon unless @DolceTriade or @Amanieu have other concerns.

[illwieckz]

@Amanieu, @Kangz, @DolceTriade, do you need something more (perhaps spacing?) to be able to merge this PR in unv 0.42.0 ?

[DolceTriade]

LGTM

[illwieckz]

Thanks for the merge.