/soundscreen

A concept of a live wallpaper integrated with SoundCloud

Primary LanguageJava

Project requirements

  • [Done] Android 2.1+ compatible

    The project is Android 2.1 compatibile.

  • [Done] Don't unnecessarily drain battery.

    It does not unnecessary drain battery life.

    The SyncService is spawned on wallpaper's engine creation, it fetches the initial data (for example: "/users/stevevaihimself/tracks.json"), puts it into the db (ContentProvider + SQLite3) and schedules itself within AlarmManager for periodic updates (default is 1h, but it can be set with the app settings). After a successful update it schedules a download task with the FileService.

    File Service checks for any left (CACHED=0 and USED=0) tracks stored in the db. It takes some number of left tracks (the default number is 10, but can be changed with settings) and downloads the tracks waveform and artwork and caches them in the internal memory (this will be changed and made settings dependent). After the first pair is downloaded the service broadcasts (localy) the ACTION_FILE_AVAILABLE intent which is received by wallpaper engine's receiver. Then the receiver triggers the wallpaper update.

    The application downloads the files in a batch and it syncs using AlarmManager.setInexactRepeating() to prevent the radio from being used inefficiently.

  • [Done] Make sure network settings are honoured.

    The network settings are honored.

    The user can set the downlaod policy with the app's settings. The app makes sure that this policy does not violate the global network settings.

  • [Done] Use the SoundCloud API to obtain the PNG with the waveform

  • [Done] The displayed waveforms should change from time to time

    The user can set the display time in wallpaper's settings.

  • [Done] The waveform should look nice, so some form of post-processing is probably needed. It should also fit the screen.

    The waveform is processed to fit the screensize.

  • [Done] Optional: the user should be able to interact with the screen background

    The user can double-tap the wallpaper to be redirected to the track's url. If Soundcloud app is present on the device - the track will be displayed with the Soundcloud app itself. If there is no Soundcloud app present on the device the track will be opened within the browser.

  • [To be done] Optional: display the name of the track on the home screen

Notes on the project

Doing the same thing the same way over and over again was never my favourite part of every-day programming, so I wanted to try out some new ideas while having this opportunity. And I wanted to have fun ;)

SQLBuilder

Writing native SQL code is tedious and error-prone. The idea was/is to introduce a lightweight, flexible and convenient wrapper (probably as a small utility library someday) around native SQL code that helps you generate your SQL code with ease and confidence.

Please treat this idea as an experiment/proof-of-concept rather than finished/polished product/code.

The next step woud be to add support for constraints in table definitions.

ContentProvider, SQLiteOpenHelper and UriMatcher

Have you ever seen a ContentProvider, SQLiteOpenHelper or UriMatcher serving tens of models in tens of configurations, thus growing and growing to some huge volume? Well, I have, so I wanted to tackle this problem with a first small step - decomposition.

So I've created specialized, model-specific classes encapsulating appropriate functionalities (like TracksHelper for DataSQLiteOpenHelper, TracksMatcher for DataUriMatcher) and made the delegation easy by having them wrapped with a Table enum and enabled iteration over the existing models (by "model" I mean a set of all db-specific classes).

Again, please treat this idea as an experiment/proof-of-concept rather than finished/polished product/code.

The next step is to try out Provider-specific class and polish handling db migradions with Helper classes (onUpgrade()).

How to build the project

  1. Open the project with Android Studio or delete the ".idea" directory and import the project to your IDE of choice.

  2. Create a "soundcloud.properties" file in your main project directory and fill in your client_id and client_secret:

     client_id = YOUR_CIENT_ID
 client_secret = YOUR_CLIENT_SECRET

  3. Place your debug.keystore and release.keystore in your main project directory.

Both "debug.keystore" and "release.keystore" files are gitignored. The idea is to keep them safe away from the github repo, so that the repository hosts only the source code and no credentials of any kind.

The same reasoning applies for the "soundcloud.properties" file.

Gradle

If you want to speed up your builds use gradlew with --daemon and --parallel arguments or add these lines to your gradle.properties:

org.gradle.daemon=true
org.gradle.parallel=true

Note:

Keep in mind that System.console() call returns null if running "gradle --daemon" (verified for Java 6 and Java 7), so please remove/comment appropriate line in gradle.properties when running the release build (I'm trying to find a workaround, for example useing the SwingBuilder).

#org.gradle.daemon=true

References:

Produard

ActionBarSherlock:

Warning: com.actionbarsherlock.internal.ActionBarSherlockCompat: can't find referenced class com.actionbarsherlock.BuildConfig

References:

Tests

Initially the idea was to have Roboletric setup with a bit of sweetnes, like Mockito and FEST Android or to play a little with RoboSpock. I was also wondering how/if you can test this kind of app with Robotium and/or Calabash.

Unfortunatelly, while adding robolectric setup I was not able to overcome the issue mentioned in Android Studio 0.3.5 release note, so I introduced a small set of classic instrumentation tests only. You can run them with your IDE or with:

./gradlew clean connectedInstrumentTest

References:

Todo

  • Check for storage left when caching files
  • Add some nice exponential backoff mechanism to SyncService
  • Enable wallpaper scrolling
  • Add some nice paralax effect to wallpaper (try using AndEngine)
  • Try reusing/enabling SoundCloud auth to fetch user's data
  • Introduce better cache management (Memory/Internal/External)
  • Add some nice transition effect when switching wallpapers
  • Think of adding some showcase for better discoverability (for example the double tap)
  • Enable adding aome picture from the Gallery as the background fillin
  • Create some custom IntegerListPreference