feature: Add option to disable background images (#380)

Co-authored-by: PartyDonut <PartyDonut@users.noreply.github.com>

lib/l10n/app_en.arb

@@ -721,6 +721,7 @@
   "@settingsContinue": {},
   "settingsEnableOsMediaControls": "Enable OS media controls",
   "@settingsEnableOsMediaControls": {},
+  "settingsEnableOsMediaControlsDesc": "Allow for playback control using media-keys and show current playing media in OS",
   "settingsHomeBannerDescription": "Display as a slideshow, carousel, or hide the banner",
   "@settingsHomeBannerDescription": {},
   "settingsHomeBannerTitle": "Home banner",
@@ -1235,5 +1236,7 @@
       }
     }
   },
-  "newUpdateFoundOnGithub": "Found a new update on Github"
+  "newUpdateFoundOnGithub": "Found a new update on Github",
+  "enableBackgroundPostersTitle": "Enable background posters",
+  "enableBackgroundPostersDesc": "Show random posters in applicable screens"
 }

lib/models/settings/client_settings_model.dart

@@ -34,6 +34,7 @@ class ClientSettingsModel with _$ClientSettingsModel {
     @Default(false) bool showAllCollectionTypes,
     @Default(2) int maxConcurrentDownloads,
     @Default(DynamicSchemeVariant.rainbow) DynamicSchemeVariant schemeVariant,
+    @Default(true) bool backgroundPosters,
     @Default(true) bool checkForUpdates,
     String? lastViewedUpdate,
     int? libraryPageSize,

lib/models/settings/client_settings_model.freezed.dart

@@ -40,6 +40,7 @@ mixin _$ClientSettingsModel {
   bool get showAllCollectionTypes => throw _privateConstructorUsedError;
   int get maxConcurrentDownloads => throw _privateConstructorUsedError;
   DynamicSchemeVariant get schemeVariant => throw _privateConstructorUsedError;
+  bool get backgroundPosters => throw _privateConstructorUsedError;
   bool get checkForUpdates => throw _privateConstructorUsedError;
   String? get lastViewedUpdate => throw _privateConstructorUsedError;
   int? get libraryPageSize => throw _privateConstructorUsedError;
@@ -80,6 +81,7 @@ abstract class $ClientSettingsModelCopyWith<$Res> {
       bool showAllCollectionTypes,
       int maxConcurrentDownloads,
       DynamicSchemeVariant schemeVariant,
+      bool backgroundPosters,
       bool checkForUpdates,
       String? lastViewedUpdate,
       int? libraryPageSize});
@@ -119,6 +121,7 @@ class _$ClientSettingsModelCopyWithImpl<$Res, $Val extends ClientSettingsModel>
     Object? showAllCollectionTypes = null,
     Object? maxConcurrentDownloads = null,
     Object? schemeVariant = null,
+    Object? backgroundPosters = null,
     Object? checkForUpdates = null,
     Object? lastViewedUpdate = freezed,
     Object? libraryPageSize = freezed,
@@ -200,6 +203,10 @@ class _$ClientSettingsModelCopyWithImpl<$Res, $Val extends ClientSettingsModel>
           ? _value.schemeVariant
           : schemeVariant // ignore: cast_nullable_to_non_nullable
               as DynamicSchemeVariant,
+      backgroundPosters: null == backgroundPosters
+          ? _value.backgroundPosters
+          : backgroundPosters // ignore: cast_nullable_to_non_nullable
+              as bool,
       checkForUpdates: null == checkForUpdates
           ? _value.checkForUpdates
           : checkForUpdates // ignore: cast_nullable_to_non_nullable
@@ -244,6 +251,7 @@ abstract class _$$ClientSettingsModelImplCopyWith<$Res>
       bool showAllCollectionTypes,
       int maxConcurrentDownloads,
       DynamicSchemeVariant schemeVariant,
+      bool backgroundPosters,
       bool checkForUpdates,
       String? lastViewedUpdate,
       int? libraryPageSize});
@@ -281,6 +289,7 @@ class __$$ClientSettingsModelImplCopyWithImpl<$Res>
     Object? showAllCollectionTypes = null,
     Object? maxConcurrentDownloads = null,
     Object? schemeVariant = null,
+    Object? backgroundPosters = null,
     Object? checkForUpdates = null,
     Object? lastViewedUpdate = freezed,
     Object? libraryPageSize = freezed,
@@ -362,6 +371,10 @@ class __$$ClientSettingsModelImplCopyWithImpl<$Res>
           ? _value.schemeVariant
           : schemeVariant // ignore: cast_nullable_to_non_nullable
               as DynamicSchemeVariant,
+      backgroundPosters: null == backgroundPosters
+          ? _value.backgroundPosters
+          : backgroundPosters // ignore: cast_nullable_to_non_nullable
+              as bool,
       checkForUpdates: null == checkForUpdates
           ? _value.checkForUpdates
           : checkForUpdates // ignore: cast_nullable_to_non_nullable
@@ -402,6 +415,7 @@ class _$ClientSettingsModelImpl extends _ClientSettingsModel
       this.showAllCollectionTypes = false,
       this.maxConcurrentDownloads = 2,
       this.schemeVariant = DynamicSchemeVariant.rainbow,
+      this.backgroundPosters = true,
       this.checkForUpdates = true,
       this.lastViewedUpdate,
       this.libraryPageSize})
@@ -466,6 +480,9 @@ class _$ClientSettingsModelImpl extends _ClientSettingsModel
   final DynamicSchemeVariant schemeVariant;
   @override
   @JsonKey()
+  final bool backgroundPosters;
+  @override
+  @JsonKey()
   final bool checkForUpdates;
   @override
   final String? lastViewedUpdate;
@@ -474,7 +491,7 @@ class _$ClientSettingsModelImpl extends _ClientSettingsModel
 
   @override
   String toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) {
-    return 'ClientSettingsModel(syncPath: $syncPath, position: $position, size: $size, timeOut: $timeOut, nextUpDateCutoff: $nextUpDateCutoff, themeMode: $themeMode, themeColor: $themeColor, amoledBlack: $amoledBlack, blurPlaceHolders: $blurPlaceHolders, blurUpcomingEpisodes: $blurUpcomingEpisodes, selectedLocale: $selectedLocale, enableMediaKeys: $enableMediaKeys, posterSize: $posterSize, pinchPosterZoom: $pinchPosterZoom, mouseDragSupport: $mouseDragSupport, requireWifi: $requireWifi, showAllCollectionTypes: $showAllCollectionTypes, maxConcurrentDownloads: $maxConcurrentDownloads, schemeVariant: $schemeVariant, checkForUpdates: $checkForUpdates, lastViewedUpdate: $lastViewedUpdate, libraryPageSize: $libraryPageSize)';
+    return 'ClientSettingsModel(syncPath: $syncPath, position: $position, size: $size, timeOut: $timeOut, nextUpDateCutoff: $nextUpDateCutoff, themeMode: $themeMode, themeColor: $themeColor, amoledBlack: $amoledBlack, blurPlaceHolders: $blurPlaceHolders, blurUpcomingEpisodes: $blurUpcomingEpisodes, selectedLocale: $selectedLocale, enableMediaKeys: $enableMediaKeys, posterSize: $posterSize, pinchPosterZoom: $pinchPosterZoom, mouseDragSupport: $mouseDragSupport, requireWifi: $requireWifi, showAllCollectionTypes: $showAllCollectionTypes, maxConcurrentDownloads: $maxConcurrentDownloads, schemeVariant: $schemeVariant, backgroundPosters: $backgroundPosters, checkForUpdates: $checkForUpdates, lastViewedUpdate: $lastViewedUpdate, libraryPageSize: $libraryPageSize)';
   }
 
   @override
@@ -503,6 +520,7 @@ class _$ClientSettingsModelImpl extends _ClientSettingsModel
       ..add(
           DiagnosticsProperty('maxConcurrentDownloads', maxConcurrentDownloads))
       ..add(DiagnosticsProperty('schemeVariant', schemeVariant))
+      ..add(DiagnosticsProperty('backgroundPosters', backgroundPosters))
       ..add(DiagnosticsProperty('checkForUpdates', checkForUpdates))
       ..add(DiagnosticsProperty('lastViewedUpdate', lastViewedUpdate))
       ..add(DiagnosticsProperty('libraryPageSize', libraryPageSize));
@@ -546,6 +564,7 @@ abstract class _ClientSettingsModel extends ClientSettingsModel {
       final bool showAllCollectionTypes,
       final int maxConcurrentDownloads,
       final DynamicSchemeVariant schemeVariant,
+      final bool backgroundPosters,
       final bool checkForUpdates,
       final String? lastViewedUpdate,
       final int? libraryPageSize}) = _$ClientSettingsModelImpl;
@@ -594,6 +613,8 @@ abstract class _ClientSettingsModel extends ClientSettingsModel {
   @override
   DynamicSchemeVariant get schemeVariant;
   @override
+  bool get backgroundPosters;
+  @override
   bool get checkForUpdates;
   @override
   String? get lastViewedUpdate;

lib/models/settings/client_settings_model.g.dart

@@ -41,6 +41,7 @@ _$ClientSettingsModelImpl _$$ClientSettingsModelImplFromJson(
       schemeVariant: $enumDecodeNullable(
               _$DynamicSchemeVariantEnumMap, json['schemeVariant']) ??
           DynamicSchemeVariant.rainbow,
+      backgroundPosters: json['backgroundPosters'] as bool? ?? true,
       checkForUpdates: json['checkForUpdates'] as bool? ?? true,
       lastViewedUpdate: json['lastViewedUpdate'] as String?,
       libraryPageSize: (json['libraryPageSize'] as num?)?.toInt(),
@@ -68,6 +69,7 @@ Map<String, dynamic> _$$ClientSettingsModelImplToJson(
       'showAllCollectionTypes': instance.showAllCollectionTypes,
       'maxConcurrentDownloads': instance.maxConcurrentDownloads,
       'schemeVariant': _$DynamicSchemeVariantEnumMap[instance.schemeVariant]!,
+      'backgroundPosters': instance.backgroundPosters,
       'checkForUpdates': instance.checkForUpdates,
       'lastViewedUpdate': instance.lastViewedUpdate,
       'libraryPageSize': instance.libraryPageSize,

lib/screens/settings/client_sections/client_settings_visual.dart

@@ -1,8 +1,8 @@
-import 'package:fladder/l10n/generated/app_localizations.dart';
 import 'package:flutter/material.dart';
 
 import 'package:flutter_riverpod/flutter_riverpod.dart';
 
+import 'package:fladder/l10n/generated/app_localizations.dart';
 import 'package:fladder/providers/settings/client_settings_provider.dart';
 import 'package:fladder/screens/settings/settings_list_tile.dart';
 import 'package:fladder/screens/settings/widgets/settings_label_divider.dart';
@@ -80,12 +80,25 @@ List<Widget> buildClientSettingsVisual(
       ),
       SettingsListTile(
         label: Text(context.localized.settingsEnableOsMediaControls),
+        subLabel: Text(context.localized.settingsEnableOsMediaControlsDesc),
         onTap: () => ref.read(clientSettingsProvider.notifier).setMediaKeys(!clientSettings.enableMediaKeys),
         trailing: Switch(
           value: clientSettings.enableMediaKeys,
           onChanged: (value) => ref.read(clientSettingsProvider.notifier).setMediaKeys(value),
         ),
       ),
+      SettingsListTile(
+        label: Text(context.localized.enableBackgroundPostersTitle),
+        subLabel: Text(context.localized.enableBackgroundPostersDesc),
+        onTap: () => ref
+            .read(clientSettingsProvider.notifier)
+            .update((cb) => cb.copyWith(backgroundPosters: !clientSettings.backgroundPosters)),
+        trailing: Switch(
+          value: clientSettings.backgroundPosters,
+          onChanged: (value) =>
+              ref.read(clientSettingsProvider.notifier).update((cb) => cb.copyWith(backgroundPosters: value)),
+        ),
+      ),
       SettingsListTile(
         label: Text(context.localized.settingsNextUpCutoffDays),
         trailing: SizedBox(

lib/widgets/navigation_scaffold/components/background_image.dart

@@ -6,6 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart';
 import 'package:fladder/models/item_base_model.dart';
 import 'package:fladder/models/items/images_models.dart';
 import 'package:fladder/providers/api_provider.dart';
+import 'package:fladder/providers/settings/client_settings_provider.dart';
 import 'package:fladder/util/fladder_image.dart';
 
 class BackgroundImage extends ConsumerStatefulWidget {
@@ -35,38 +36,45 @@ class _BackgroundImageState extends ConsumerState<BackgroundImage> {
   }
 
   void updateItems() {
+    final enabled = ref.read(clientSettingsProvider.select((value) => value.backgroundPosters));
+
     WidgetsBinding.instance.addPostFrameCallback((value) async {
+      if (!enabled && mounted) return;
+
       if (widget.images.isNotEmpty) {
-        setState(() {
-          backgroundImage = widget.images.shuffled().firstOrNull?.primary;
-        });
+        final image = widget.images.shuffled().firstOrNull?.primary;
+        if (mounted) setState(() => backgroundImage = image);
         return;
       }
-      final randomItem = widget.items.shuffled().firstOrNull;
+
       if (widget.items.isEmpty) return;
+
+      final randomItem = widget.items.shuffled().firstOrNull;
       final itemId = switch (randomItem?.type) {
-            FladderItemType.folder => randomItem?.id,
-            FladderItemType.series => randomItem?.parentId ?? randomItem?.id,
-            _ => randomItem?.id,
-          } ??
-          randomItem?.id;
+        FladderItemType.folder => randomItem?.id,
+        FladderItemType.series => randomItem?.parentId ?? randomItem?.id,
+        _ => randomItem?.id,
+      };
+
       if (itemId == null) return;
-      final apiProvider = await ref.read(jellyApiProvider).usersUserIdItemsItemIdGet(
-            itemId: itemId,
-          );
-      setState(() {
-        backgroundImage = apiProvider.body?.parentBaseModel.getPosters?.randomBackDrop ??
-            apiProvider.body?.getPosters?.randomBackDrop;
-      });
+
+      final apiResponse = await ref.read(jellyApiProvider).usersUserIdItemsItemIdGet(itemId: itemId);
+      final image =
+          apiResponse.body?.parentBaseModel.getPosters?.randomBackDrop ?? apiResponse.body?.getPosters?.randomBackDrop;
+
+      if (mounted) setState(() => backgroundImage = image);
     });
   }
 
   @override
   Widget build(BuildContext context) {
-    return FladderImage(
-      image: backgroundImage,
-      fit: BoxFit.cover,
-      blurOnly: false,
-    );
+    final enabled = ref.watch(clientSettingsProvider.select((value) => value.backgroundPosters));
+    return enabled
+        ? FladderImage(
+            image: backgroundImage,
+            fit: BoxFit.cover,
+            blurOnly: false,
+          )
+        : const SizedBox.shrink();
   }
 }