Merge pull request #39 from NielsMasdorp/feature/android_auto

Implement Android Auto support

Author: Niels Masdorp

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: 'Build & test'
+
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v3
+
+      - name: "Setup Java"
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'adopt'
+
+      - name: "Validate gradle wrapper"
+        uses: gradle/wrapper-validation-action@v1
+
+      - name: "Use cached gradle wrapper"
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: "Check for code violations"
+        run: ./gradlew detekt
+
+      - name: "Build, test and lint"
+        run: ./gradlew app:assDebug test app:lintDebug

README.md

@@ -2,7 +2,7 @@
 
 Stream popular dutch radio stations.
 
-This is mostly a pet project created to learn Jetpack Compose and the new Jetpack Media3 API's.
+This is mostly a pet project created to learn Jetpack Compose and the new Jetpack Media3 API
 
 Nederadio is built using all the latest practices in Android development:
 
@@ -13,28 +13,64 @@ Nederadio is built using all the latest practices in Android development:
  - Material3
  - Material You on Android 12 and higher
  - Dark/Light mode
- - Cast support
- - Live song updates
- - Sleep timer
+ - Cast support including to TVs
+ - Android Auto support
+ - Current song information (except when casting or the stream does not support it)
+ - Sleep timer which slowly fades the volume and stops the stream after a set time
 
-## Screenshots
+## In action
+
+### App
+
+https://user-images.githubusercontent.com/5968599/236145601-d423e644-0a26-4b85-84f2-b05d3e9b19aa.mp4
+
+### Android Auto
 
 <p float="left">
-  <img src="/app/screenshots/screenshot1.png" width="150" />
-  <img src="/app/screenshots/screenshot2.png" width="150" />
-  <img src="/app/screenshots/screenshot3.png" width="150" />
-  <img src="/app/screenshots/screenshot4.png" width="150" />
-  <img src="/app/screenshots/screenshot5.png" width="150" />
+  <img src="/app/screenshots/auto_1.png" width="600" />
+  <img src="/app/screenshots/auto_2.png" width="600" />
 </p>
 
 ## Change data
 
-You could easily use your own streams in this app, the data set is located in `backend/public/nederadio/data.json`. It is currently served on my own server but you could change the endpoint in `StreamApi` to whatever you like.
+You could easily use your own streams in this app, the data set is located in `backend/public/nederadio/data.json`. And it contains a NodeJS app that can run on on your backend of choosing. It is currently served on my own server but you could change the endpoint in `StreamApi` to whatever you like.
+
+## Current issues and future enhancements
+
+* When switching to cast, the same media session is used as when using Exoplayer, which leads to a media notification that does not adhere to the casting guidelines. See https://github.com/androidx/media/issues/39 and https://github.com/androidx/media/issues/264
+* Playback resumption seems iffy, need to take a better look. See https://android-developers.googleblog.com/2020/08/playing-nicely-with-media-controls.html and the implementation of `onGetLibraryRoot()` and `onGetChildren` in `StreamService`
+* CastPlayer implementation in Media3 does not implement the required API to show live song updates unfortunately. Need to revisit in the future
+* Landscape UI not implemented
+* Search for Google Assistant/Android Auto not implemented, see: https://developer.android.com/training/cars/media#support_voice
+
+Want to help? Open a PR! Be sure to add Detekt via:
+
+### Detekt
+
+Please add this to `<<your-repo>>/.git/hooks/pre-commit` and make it executable by `chmod +x pre-commit`.
+This will make sure Detekt runs and prevents any commits that fail our coding standards.
+
+```
+#!/usr/bin/env bash
+echo "Running detekt check..."
+OUTPUT="/tmp/detekt-$(date +%s)"
+./gradlew detekt > $OUTPUT
+EXIT_CODE=$?
+if [ $EXIT_CODE -ne 0 ]; then
+  cat $OUTPUT
+  rm $OUTPUT
+  echo "***********************************************"
+  echo "                 Detekt failed                 "
+  echo " Please fix the above issues before committing "
+  echo "***********************************************"
+  exit $EXIT_CODE
+fi
+rm $OUTPUT
+```
 
 ## Used libraries
 
 * [Koin](https://github.com/InsertKoinIO/koin)
-* [Cokoin](https://github.com/burnoo/cokoin)
 * [Jetpack Media3](https://github.com/androidx/media)
 * [Jetpack Compose](https://developer.android.com/jetpack/compose)
 * [Ktor](https://github.com/ktorio/ktor)

app/build.gradle

@@ -41,6 +41,12 @@ android {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
+
+    android {
+        lintOptions {
+            baseline file("lint-baseline.xml")
+        }
+    }
 }
 
 dependencies {
@@ -77,11 +83,11 @@ dependencies {
     //kotlin
     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$kotlinx_coroutines_android_version"
     implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinx_serialization_version"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-guava:$kotlinx_guava_version"
 
     // Koin
-    implementation "dev.burnoo:cokoin:$cokoin_version"
-    implementation "dev.burnoo:cokoin-android-viewmodel:$cokoin_version"
-    implementation "dev.burnoo:cokoin-android-navigation:$cokoin_version"
+    implementation "io.insert-koin:koin-android:$koin_version"
+    implementation "io.insert-koin:koin-androidx-compose:$koin_compose_version"
 
     //Ktor
     implementation "io.ktor:ktor-client-android:$ktor_version"