The original Soundscape app is an iOS only app that provides 3D audio navigation for the blind or visually impaired. The main aim of this project is to widen the Soundscape availability by creating a very similar app that runs on Android. A secondary aim is that by using modern technologies we can also generate an iOS app from the same codebase.
The app is developed using Android Studio with the majority of the app code written in Kotlin. For 3D audio rendering, the code uses FMOD Studio audio engine by Firelight Technologies Pty Ltd.. That library is wrapped in a C++ library with an API exposed to Kotlin. Note that for non-commercial use the FMOD license allows use without payment. This project is non-commercial with an open source license and meets this requirement.
It’s very early days in the project. We’ve done various proof of concept, and the code for those has mostly landed in this repo, but a lot of it is not actually used yet. The app will be made available via the Google Play Store, initially to a small group for ‘internal testing’. Obviously, anyone can download and build the code from this repo, but testing should be done on the Play Store releases. Once we have something worth testing, we’ll update here with how to join up.
The quickest way to get started building the app is to run Android Studio and select File/New/Project from version control from the menu. Select Git as the version control and paste in the HTTPS code link for this project from above. Click on Clone and the project will download, open and initialize ready to build.
Then you’ll need to setup the tileProviderApiKey in your local.properties file. Ask someone from the team to get that key. like this :
tileProviderApiKey=TODO_COMPLETE_WITH_CORRECT_KEY
See the document here to learn about the GitHub actions used and how they are configured.
See the document here for information about how we configure and use mapping data.
Here are the latest release notes.