SoundScapeRenderer / ssr

Main source code repository for the SoundScape Renderer
http://spatialaudio.net/ssr/
GNU General Public License v3.0
134 stars 53 forks source link

Disable `ssr` script #325

Closed mgeier closed 1 year ago

mgeier commented 1 year ago

About a decade ago, there was only a ssr binary. Then I created a binary for each renderer type, ssr-binaural, ssr-wfs etc. and added the ssr script for backwards compatibility.

At some point, I wanted to delete this, maybe this time has come?

Two years ago, I have also removed it from the user manual: #236.

umlaeute commented 1 year ago

why don't you just get rid of the script completely?

put a big fat warning on the download page and into the README, and be done with it (automagically closing #330 along the way)

mgeier commented 1 year ago

I thought you like it if users get helpful error messages (see e.g. #16)?

And let's be honest: nobody is reading (much less remembering) warnings in the documentation.

umlaeute commented 1 year ago

i do like helpful error messages. but that doesn't mean that i like error messages for the sake of error messages.

i don't see much help here: the script is basically just saying that it doesn't exist.


as for documentation: sure, i hardly ever read documentation after i first acquainted myself with the software.

however, if things go horribly wrong (like: i invoked my favorite program (say... ssr) right after I've supposedly installed it, and it this said program cannot be found), then I will start to investigate:

mgeier commented 1 year ago

i don't see much help here: the script is basically just saying that it doesn't exist.

Exactly. I think most people who use the SSR for listening tests will use some kind of scripts, and if they use ssr in their scripts, those scripts will break. And I think it is much more helpful to see this:

$ ./my-script.sh 
The script 'ssr' is not supported anymore, please use the full name:
ssr-binaural, ssr-brs, ssr-vbap, ssr-wfs, ssr-aap, ssr-dca or ssr-generic

... instead of this:

$ ./my-script.sh 
./my-script.sh: 3: ssr: not found