tougbia09 / agkaraoke

Basic karaoke app for Android and Google Glass

Karaoke for Android and Google Glass

This is (yet and likely forever) minimalistic Karaoke pet project for Android and Google Glass devices. Uses Ultrastar Delux song format.

Building

Just clone and build in Android Studio. You most likely will be required to install Glass Development Kit add-on. Project consist of 3 modules:

• karaoke.core, a shared module where all the logic and custom views are located
• app - version for phones/tablets
• glass - version Google Glass

Running

• you'll need to obtain some songs in Ultrastar Delux format first. A few free ones could be downloaded here.
• put (unpacked) songs directories to the Music directory on the device. You can omit video files, since they are not supported anyway.
• launch the application:
  • on Google Glass, say "Show lyrics", or start the application from Home card menu.
  • on usual Android device just start the app.

On phones and tablets, usage of headphones is strongly recommended since the mic pick ups music playing, and messes up the tone detection.

On Google glass, earbud is a good idea since it provides much better audio quality, and much lower battery consumption.

Notes

Application has two algorithms to detect pitch of the sound: autocorrelation, taken from Ultrastar Delux and optimized for integer math, and Goertzel algorithm, as described in Wikipedia. Toggle is only available from source code for now.

Code quality is far from production: Weak error checking, using string hashes as unique ids, and so on.

Future plans

• Both algorithms have huge performance problems on the Google Glass (which is strange, actually) leading to lags and overheating. So, JNI implementation should be added.
• Since I am an awful singer, and can't match the pitch of any song to check the pitch detection, some test audio files with real performances are required. Adding a couple unit tests based on these would be nice.
• The way lyrics and pitch are displayed is different from other Karaoke software:
  • next line is not displayed until it played
  • there is no visual timing cue on long pauses
  • pitch plot width is matched to text width, which is unnecessary
• There is no scoring.
• Some songs are not loaded properly due to deviations in formating.
• A lot of UI work needed, especially on the phones.
• Since Google Glass seems to render UI in the software mode, there is a chance that using OpenGL for rendering can make things a bit faster. Or just optimize the plot/lyrics rendering by avoiding unnecessary invalidations.