diff --git a/README.md b/README.md index 00680d8d..01e81112 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,10 @@ Moved details to [CHANGELOG.md](https://github.com/eddyizm/tempo/blob/main/CHANG Fork [**sponsorship here**](https://ko-fi.com/eddyizm). +## Usage + +[Documentation](USAGE.md) (work in progress) + ## Features - **Subsonic Integration**: Tempo seamlessly integrates with your Subsonic server, providing you with easy access to your entire music collection on the go. - **Sleek and Intuitive UI**: Enjoy a clean and user-friendly interface designed to enhance your music listening experience, tailored to your preferences and listening history. diff --git a/USAGE.md b/USAGE.md new file mode 100644 index 00000000..31fbd060 --- /dev/null +++ b/USAGE.md @@ -0,0 +1,146 @@ +# App Name Usage Guide +[<- back home](README.md) + +## Table of Contents +- [Prerequisites](#prerequisites) +- [Getting Started](#getting-started) +- [Server Configuration](#server-configuration) +- [Main Features](#main-features) +- [Navigation](#navigation) +- [Playback Controls](#playback-controls) +- [Favorites](#favorites) +- [Playlist Management](#playlist-management) +- [Android Auto](#android-auto) +- [Settings](#settings) +- [Troubleshooting](#troubleshooting) + +## Prerequisites + +**Important Notice**: This app is a Subsonic-compatible client and does not provide any music content itself. To use this application, you must have: + +- An active Subsonic API server (or compatible service) already set up +- Valid login credentials for your Subsonic server +- Music content uploaded and organized on your server + +### Verified backends +This app works with any service that implements the Subsonic API, including: +- [LMS - Lightweight Music Server](https://github.com/epoupon/lms) - *personal fave and my backend* +- [Navidrome](https://www.navidrome.org/) +- [Gonic](https://github.com/sentriz/gonic) + + + + +## Getting Started + +### Installation +1. Download the APK from the [Releases](https://github.com/eddyizm/tempo/releases) section +2. Enable "Install from unknown sources" in your Android settings +3. Install the application + +### First Launch +1. Open the application +2. You will be prompted to configure your server connection +3. Grant necessary permissions for media playback and background operation + +## Server Configuration + +### Initial Setup +**IN PROGRESS** +1. Enter your server URL (e.g., `https://your-subsonic-server.com`) +2. Provide your username and password +3. Test the connection to ensure proper configuration + +### Advanced Settings +**TODO** + +## Main Features + +### Library View +**TODO** + +### Now Playing Screen +**TODO** + +## Navigation + +### Bottom Navigation Bar +**IN PROGRESS** +- **Home**: Recently played and server recommendations +- **Library**: Your server's complete music collection +- **Download**: Locally downloaded files from server + +## Playback Controls + +### Streaming Controls +**TODO** + +### Advanced Controls +**TODO** + +## Favorites + +### Favorites (aka heart aka star) to albums and artists +- Long pressing on an album gives you access to heart/unheart an album + +

+ +

+ +- Long pressing on an artist cover gets you the same access to to heart/unheart an album + +

+ +

+ + +## Playlist Management + +### Server Playlists +**TODO** + +### Creating Playlists +**TODO** + +## Settings + + +## Android Auto + +### Enabling on your head unit +- You have to enable Android Auto developer options, which are different from actual Android dev options. Then you have to enable "Unknown sources" in Android Auto, otherwise the app won't appear as it isn't downloaded from Play Store. (screenshots needed) + + +### Server Settings +**IN PROGRESS** +- Manage multiple server connections +- Configure sync intervals +- Set data usage limits for streaming + +### Audio Settings +**IN PROGRESS** +- Streaming quality settings +- Offline caching preferences + +### Appearance +**TODO** + +## Troubleshooting + +### Connection Issues + +**TODO** + +### Common Issues + +**TODO** + +### Support +For additional help: +- Question? Start a [Discussion](https://github.com/eddyizm/tempo/discussions) +- Open an [issue](https://github.com/eddyizm/tempo/issues) if you don't find a discussion solving your issue. +- Consult your Subsonic server's documentation + +--- + +*Note: This app requires a pre-existing Subsonic-compatible server with music content.* \ No newline at end of file diff --git a/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredAlbumSyncDialog.java b/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredAlbumSyncDialog.java index 6e6ef303..64500eac 100644 --- a/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredAlbumSyncDialog.java +++ b/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredAlbumSyncDialog.java @@ -12,7 +12,7 @@ import androidx.lifecycle.ViewModelProvider; import androidx.media3.common.util.UnstableApi; import com.cappielloantonio.tempo.R; -import com.cappielloantonio.tempo.databinding.DialogStarredSyncBinding; +import com.cappielloantonio.tempo.databinding.DialogStarredAlbumSyncBinding; import com.cappielloantonio.tempo.model.Download; import com.cappielloantonio.tempo.util.DownloadUtil; import com.cappielloantonio.tempo.util.MappingUtil; @@ -26,10 +26,16 @@ import java.util.stream.Collectors; public class StarredAlbumSyncDialog extends DialogFragment { private StarredAlbumsSyncViewModel starredAlbumsSyncViewModel; + private Runnable onCancel; + + public StarredAlbumSyncDialog(Runnable onCancel) { + this.onCancel = onCancel; + } + @NonNull @Override public Dialog onCreateDialog(Bundle savedInstanceState) { - DialogStarredSyncBinding bind = DialogStarredSyncBinding.inflate(getLayoutInflater()); + DialogStarredAlbumSyncBinding bind = DialogStarredAlbumSyncBinding.inflate(getLayoutInflater()); starredAlbumsSyncViewModel = new ViewModelProvider(requireActivity()).get(StarredAlbumsSyncViewModel.class); @@ -74,6 +80,7 @@ public class StarredAlbumSyncDialog extends DialogFragment { Button negativeButton = dialog.getButton(Dialog.BUTTON_NEGATIVE); negativeButton.setOnClickListener(v -> { Preferences.setStarredAlbumsSyncEnabled(false); + if (onCancel != null) onCancel.run(); dialog.dismiss(); }); } diff --git a/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredSyncDialog.java b/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredSyncDialog.java index 9f1cc3a1..3d9b07a9 100644 --- a/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredSyncDialog.java +++ b/app/src/main/java/com/cappielloantonio/tempo/ui/dialog/StarredSyncDialog.java @@ -26,6 +26,12 @@ import java.util.stream.Collectors; public class StarredSyncDialog extends DialogFragment { private StarredSyncViewModel starredSyncViewModel; + private Runnable onCancel; + + public StarredSyncDialog(Runnable onCancel) { + this.onCancel = onCancel; + } + @NonNull @Override public Dialog onCreateDialog(Bundle savedInstanceState) { @@ -75,6 +81,7 @@ public class StarredSyncDialog extends DialogFragment { Button negativeButton = dialog.getButton(Dialog.BUTTON_NEGATIVE); negativeButton.setOnClickListener(v -> { Preferences.setStarredSyncEnabled(false); + if (onCancel != null) onCancel.run(); dialog.dismiss(); }); } diff --git a/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/AlbumListPageFragment.java b/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/AlbumListPageFragment.java index 9a1557a6..38dc9b10 100644 --- a/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/AlbumListPageFragment.java +++ b/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/AlbumListPageFragment.java @@ -12,7 +12,7 @@ import android.view.ViewGroup; import android.view.inputmethod.EditorInfo; import android.view.inputmethod.InputMethodManager; import android.widget.PopupMenu; -import android.widget.SearchView; +import androidx.appcompat.widget.SearchView; import androidx.annotation.NonNull; import androidx.annotation.Nullable; diff --git a/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/SettingsFragment.java b/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/SettingsFragment.java index 9250adfa..e8ddf2b2 100644 --- a/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/SettingsFragment.java +++ b/app/src/main/java/com/cappielloantonio/tempo/ui/fragment/SettingsFragment.java @@ -21,6 +21,7 @@ import androidx.media3.common.util.UnstableApi; import androidx.preference.ListPreference; import androidx.preference.Preference; import androidx.preference.PreferenceFragmentCompat; +import androidx.preference.SwitchPreference; import com.cappielloantonio.tempo.BuildConfig; import com.cappielloantonio.tempo.R; @@ -257,9 +258,11 @@ public class SettingsFragment extends PreferenceFragmentCompat { findPreference("sync_starred_tracks_for_offline_use").setOnPreferenceChangeListener((preference, newValue) -> { if (newValue instanceof Boolean) { if ((Boolean) newValue) { - StarredSyncDialog dialog = new StarredSyncDialog(); + StarredSyncDialog dialog = new StarredSyncDialog(() -> { + ((SwitchPreference)preference).setChecked(false); + }); dialog.show(activity.getSupportFragmentManager(), null); - } + } } return true; }); @@ -269,7 +272,9 @@ public class SettingsFragment extends PreferenceFragmentCompat { findPreference("sync_starred_albums_for_offline_use").setOnPreferenceChangeListener((preference, newValue) -> { if (newValue instanceof Boolean) { if ((Boolean) newValue) { - StarredAlbumSyncDialog dialog = new StarredAlbumSyncDialog(); + StarredAlbumSyncDialog dialog = new StarredAlbumSyncDialog(() -> { + ((SwitchPreference)preference).setChecked(false); + }); dialog.show(activity.getSupportFragmentManager(), null); } } diff --git a/app/src/main/res/layout/fragment_download.xml b/app/src/main/res/layout/fragment_download.xml index 6e3e264e..0a454508 100644 --- a/app/src/main/res/layout/fragment_download.xml +++ b/app/src/main/res/layout/fragment_download.xml @@ -49,8 +49,9 @@ diff --git a/app/src/main/res/values-es-rES/strings.xml b/app/src/main/res/values-es-rES/strings.xml index 518931af..13439c7c 100644 --- a/app/src/main/res/values-es-rES/strings.xml +++ b/app/src/main/res/values-es-rES/strings.xml @@ -6,6 +6,7 @@ Por favor, desactive las optimizaciones de batería para continuar la reproducción multimedia mientras la pantalla está apagada. Optimizaciones de batería Modo sin conexión + Añadir a la lista de reproducción Añadir a la cola Descargar todo Ir al artista @@ -68,7 +69,7 @@ Descargar Se descargarán todas las pistas de esta carpeta. Las pistas en las subcarpetas no se descargarán. Descargar las pistas - Una vez que descargues un tema, lo encontrarás aquí + Una vez que descargues una pista, la encontrarás aquí No hay descargas %1$s • %2$s elementos %1$s elementos @@ -89,6 +90,7 @@ Descargas Selecciona dos o más filtros Filtrar + Filtrar artistas Filtrar géneros (%1$d) (+%1$d) @@ -115,6 +117,7 @@ Descargar Descargar estas pistas usará una gran cantidad de datos Parece que hay algunas pistas destacadas para sincronizar + Los álbumes marcados como favoritos estarán disponibles en el modo sin conexión. Lo mejor de Descubrir Todo en aleatorio @@ -159,7 +162,9 @@ Servidores de Subsonic Emitir Añadir + Añadir a la lista de reproducción Descargar todo + Valorar álbum Descargas Todo Descargado @@ -195,6 +200,7 @@ Año %1$.2fx Limpiar la cola de reproducción + Cola de reproducción guardada Prioridad del servidor Formato desconocido Transcodificando @@ -205,6 +211,7 @@ Cancelar Crear Añadir a una lista de reproducción + Error al añadir a la lista %1$d pistas • %2$s Duración • %1$s Pulsación larga para eliminar @@ -247,7 +254,7 @@ Cancelar Guardar Valorar - Buscar tema, artistas o álbumes + Buscar pista, artistas o álbumes Introduzca al menos tres caracteres Álbumes Ajustes de audio @@ -306,6 +313,7 @@ Si está habilitada, se mostrará la sección de pódcasts. Reinicia la aplicación para que los cambios surtan efecto. Mostrar calidad de audio La tasa de bits y el formato de audio se mostrarán para cada pista de audio. + Si está habilitada, muestra la valoración de la pista como barra de 5 estrellas en la página del control de reproducción.\n\n*Requiere reiniciar la aplicación Mostrar valoración de los elementos Sincronizar cola de reproducción para este usuario Mostrar emisoras de radio @@ -314,6 +322,7 @@ Tamaño de las esquinas Si está habilitada, establece un ángulo de curvatura para todas las portadas de álbumes. Los cambios se aplicarán después de reiniciar la app. Escanear biblioteca + Cambiar la ubicación de los archivos en caché a otro almacenamiento puede causar el borrado de todos los archivos en caché en el anterior almacenamiento. Seleccióna un tipo de almacenamiento Externo Interno @@ -410,13 +419,20 @@ La prioridad que se aplica al modo de transcodificación. Si se selecciona \"Reproducción directa\", la tasa de bits del archivo no cambiará. Descargar las pistas destacadas podría consumir una gran cantidad de datos Sincronizar las pistas destacadas + Sincronizar álbumes favoritos Para que los cambios tengan efecto, reinicia la app. Descarga los archivos multimedia transcodificados. Si esta opción está habilitada, no se usará el endpoint de descarga, sino las siguientes opciones.\n\nSi el formato de transcodificación para las descargas se establece en \"Descarga directa\", no se modificará la tasa de bits del archivo. Cuando el archivo se transcodifica en tiempo real, el cliente normalmente no muestra la duración de la pista. Es posible solicitar a los servidores que soporten esta característica, que calculen la duración de la pista que se está reproduciendo, pero los tiempos de respuesta podrían aumentar. + Sincronizar álbumes favoritos para uso sin conexión Si está habilitada, las pistas destacadas se descargarán para uso sin conexión. El archivo se ha descargado usando las APIs de Subsonic. El códec y la tasa de bits del archivo se mantienen sin cambios respecto al archivo de origen. La aplicación pedirá al servidor transcodificar el archivo y modificar su tasa de bits. El códec pedido por el usuario es %1$s, con una tasa de bits de %2$s. Cualquier cambio en el códec y tasa de bits del archivo en el formato elegido será manejado por el servidor, que puede, o no, soportar esta operación. La aplicación solo leerá el archivo original ofrecido por el servidor. La app pedirá al servidor, de forma explícita, el archivo sin transcodificar con la tasa de bits de origen. La calidad del archivo a reproducir queda a decisión del servidor. La app no forzará la elección del códec y la tasa de bits para ninguna posible transcodificación. La aplicación pedirá al servidor modificar la tasa de bits del archivo. El usuario ha pedido una tasa de bits de %1$s, mientras que el códec del archivo origen se mantendrá sin cambios. Cualquier cambio en la tasa de bits del archivo en el formato seleccionado será realizado por el servidor, que podrá soportar, o no, la operación. + Se ha añadido a la lista + Mostrar valoración de las pistas + Sincronizar álbumes favoritos + Si está habilitada, los álbumes favoritos se descargarán para uso sin conexión. + Descargar los álbumes favoritos puede consumir una gran cantidad de datos. \ No newline at end of file diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index 2ffe2c60..619766d5 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -317,7 +317,7 @@ Show audio quality The bitrate and audio format will be shown for each audio track. Show song star rating - If enabled, hides 5 star rating for track on song page\n\n*Requires App restart + If enabled, shows 5 star rating for track on song page\n\n*Requires App restart Show item rating If enabled, the item\'s rating and whether it is marked as a favorite will be displayed. Sync timer diff --git a/mockup/usage/fave_album.png b/mockup/usage/fave_album.png new file mode 100644 index 00000000..51c2c728 Binary files /dev/null and b/mockup/usage/fave_album.png differ diff --git a/mockup/usage/fave_artist.png b/mockup/usage/fave_artist.png new file mode 100644 index 00000000..62c9fb8a Binary files /dev/null and b/mockup/usage/fave_artist.png differ