Add in app download functionality by 7ritn · Pull Request #1404 · jellyfin/jellyfin-android

7ritn · 2024-06-03T17:36:56Z

This PR internalizes the download process.

Changes
Downloads are stored inside the app directory including thumbnail and external subtitle files. MediaSource data is downloaded as well and stored inside the Room Database.
A new Downloads fragment is added to show available downloads. Downloads are played back using the Exoplayer.

What's left
This is not a complete list

better download overview
add functionality to remove downloads
add button in main menu to get to downloads (currently only available from server selection)
overall polish

Notes
There is still lots of work to do, but it is already working. I new to Android development, so I am really sorry if something is not correct. Furthermore I implement this functionality as part of my Master's degree, so even if for whatever reason this PR is rejected, I will still complete the project to my best ability. I sorry that I changed some ExoPlayer code even though, it is currently reworked, but due to time constraints, I could not wait.

Thanks for any feedback :)

7ritn · 2024-06-04T09:45:35Z

Updated download page so it looks somewhat nice. Also added functionality to delete downloads.

7ritn · 2024-06-06T08:11:22Z

So I would call the PR in a beta state. Feature wise, I think it is already at a good point. Adding the view downloads button requires modifying the web app. If something is missing I can still add it, but otherwise next step would be the polish.

rcv11x · 2024-06-06T08:33:15Z

Thank you very much for this PR, it looks very good, I have a few questions to ask you:

1 - This is to download media on the device and watch them locally without internet?
2 - When you download the media are they compressed so that they take up less space on the device or are they downloaded with the actual size they occupy? ❤️

7ritn · 2024-06-06T08:42:05Z

Thank you very much for this PR, it looks very good, I have a few questions to ask you:
1 - This is to download media on the device and watch them locally without internet?

Yes. Currently downloads are saved using Android's built-in DownloadManager. They are saved in for example the Downloads folder so one can playback the file using VLC. This PR adds the functionality to save the download to the app internal storage making playback from within the app possible.

2 - When you download the media are they compressed so that they take up less space on the device or are they downloaded with the actual size they occupy? ❤️

Video files are usually already very well compressed through the used codecs, adding a conventional lossless compression such as zstandard would barely reduce the size. The next step after this PR could adding functionality to support downloads in different bitrates, enabling smaller downloads.

7ritn · 2024-06-24T08:41:13Z

While thinking about implementing the ability to download transcoded media (streams), I realized it would be better if ExoPlayer would handle downloading, since it natively supports HLS streams, making future efforts easier. So I rewrote the download logic to utilize ExoPlayers in-buildt download capabilities.

Oh yeah this also makes regular video playback use the downloade / cached files if available.

satmandu · 2024-06-30T14:55:21Z

I would love to test this if you want to post some builds...

I have a flight coming up. 😅

neBM

Much of the detekt issues blocking the PR seems like quick fixes except for one :/
Looks like we're the unlucky PR that needs that final param and hit the limit! 😆

I've thought of a potential solution but it's by no means perfect.

7ritn · 2024-08-20T12:11:57Z

Commit #7ce600c fixes the HLS content source error. Problem was that the exoplayer cache cached videos when playing them back, this was not intended and let to complication. The commit makes the cache read-only.

7ritn · 2024-08-22T16:50:03Z

Commit #6db98b7 improves download notification when multiple downloads are in progress. This should fix all current outstanding problems.

felixschndr · 2024-11-13T10:11:33Z

Would it be possible for someone to take a look at this PR and review it please? That'd be great ❤️

Maxr1998 · 2025-01-27T17:23:21Z

Sorry for taking so long to look into this. I'd like to get these changes in next. Would you mind rebasing this onto the latest master so that I can properly test and review it?

7ritn · 2025-01-30T04:50:23Z

I currently can't really test changes rn. So I can't that any guarantees if it still works.
Is this conflict-resolving commit enough or do you want a proper rebase? I am not really used to having to rebase onto so many new commits lol Otherwise I think neBM had some proposal.

7ritn · 2025-05-06T14:25:50Z

I have to be real, this feature is the most requested feature of the official Jellyfin project (https://features.jellyfin.org/?view=most-wanted). It is understandable that people lead busy lives, but if the maintainer is not able to look into this for almost a whole year, then maybe a solution needs to be found. It makes sense that there are many other Jellyfin Android apps with more features and better maintenance.

satmandu · 2025-05-06T14:33:04Z

@nielsvanvelzen would you be ok with an edge release with some of these long waiting PRs pulled in?

A quarterly or sooner unstable release cadence with lower expected polish, separate from the default ship it when it is ready schedule would help keep outside developers who want to collaborate interested...

nielsvanvelzen · 2025-05-06T14:47:55Z

@satmandu I agree with you that the current situation is not ideal. If someone is willing to help out with one or all of these tasks we can proceed with merging:

Fixing the merge conflicts (ideally the author of course)
Reviewing the code
Testing the new functionality

Polishing and fixing smaller issues can be done in separate pull requests.

7ritn · 2025-05-06T14:54:17Z

Sure I can look into this again. At least now I finished my semester abroad

7ritn · 2025-05-06T15:29:11Z

Removed merge conflict, will now make sure everything works.

Maxr1998 · 2025-05-06T23:42:32Z

I have to be real, this feature is the most requested feature of the official Jellyfin project (https://features.jellyfin.org/?view=most-wanted). It is understandable that people lead busy lives, but if the maintainer is not able to look into this for almost a whole year, then maybe a solution needs to be found. It makes sense that there are many other Jellyfin Android apps with more features and better maintenance.

I get you, the situation totally sucks. I probably shouldn't even have left the project for so long, because getting back into it only got harder because of that. The reality is that I simply have no time to actively maintain this app right now, and it pains me since I also had a lot of plans (including unfinished work like the player UI rewrite). The little time I can spend on it every few weeks to months usually goes mostly into housekeeping and basic maintenance aka dependency updates and such, but that may be the wrong approach. I'm honestly fine with pulling in this PR mostly unreviewed at this point, considering multiple community members already worked on it.

@nielsvanvelzen would you be ok with an edge release with some of these long waiting PRs pulled in?

A quarterly or sooner unstable release cadence with lower expected polish, separate from the default ship it when it is ready schedule would help keep outside developers who want to collaborate interested...

That was already my plan when I last talked to Niels, but that was probably weeks if not months ago, again. Having a download feature in the app would be amazing, and merging this and other bigger PRs would then allow us to iterate on the existing state without risking to break other open PRs again and again. So yes, absolutely agree.

Unfortunately, I really can't and don't want to promise anything right now. But I definitely hear and understand the frustration, and won't get in the way while trying to find a solution.

7ritn · 2025-05-07T05:59:04Z

Fixed cache not being properly used when downloading.

Tested:

- detekt builds successfully (when runnig gradlew detekt)

- watching an episode not downloaded using ExoPlayer while online with external and embedded subtitles
- watching an episode dowloaded using Exoplayer while online
	- uses download cache in DirectPlay
	- fast seeking
- downloading multiple episodes
	- progress notification for total download progress
	- individual success notification for each download
- disrupting download
	- when going offline, download is resumed when connected again
	- when Jellyfin is closed, the download service continues
- watching a downloaded episode while offline with external and embedded subtitles
	- seeking in the episode is instant
	- subtitle switching works seemless
- deleting episode from Downloads
	- episodes is removed from Available Downloads
	- cache is cleared

+    <string name="store_videos_in_internal_storage">Store videos in internal storage</string>
+    <string name="stored_videos_in_internal_storage_desc">Videos such as movies and TV shows will be stored in the app\'s internal storage. Allowing access from within the app.</string>
+    <string name="tv_show_desc">%1$s - S%2$dE%3$d</string>
+    <string name="downloading_desc">Downloading %1$d titles</string>


nielsvanvelzen

Approving (& merging) for the sake of progression. I have not reviewed or tested these changes, I just looked over it briefly.

As mentioned in my previous comment, any issues with these changes can be resolved in separate pull requests. If you're interested in helping out please do so! We'd appreciate any testers/reviewers & developers. For questions please visit our Android chat via Matrix or Discord (listed at jellyfin.org/contact)

7ritn · 2025-05-07T06:16:44Z

Just one thing I noticed that when downloading at lot of episodes at the same time, the total download progress tends to reset, when an episode finishes downloading. Could look into it the next few days.

Maxr1998 · 2024-07-02T13:43:36Z

-                val customPrefs = displayPreferencesDto.customPrefs
-
-                displayPreferences = DisplayPreferences(
-                    skipBackLength = customPrefs[Constants.DISPLAY_PREFERENCES_SKIP_BACK_LENGTH]?.toLongOrNull()
-                        ?: Constants.DEFAULT_SEEK_TIME_MS,
-                    skipForwardLength = customPrefs[Constants.DISPLAY_PREFERENCES_SKIP_FORWARD_LENGTH]?.toLongOrNull()
-                        ?: Constants.DEFAULT_SEEK_TIME_MS,
-                )
+                customPrefs = displayPreferencesDto.customPrefs
            } catch (e: ApiClientException) {
-                Timber.e(e, "Failed to load display preferences")
+                Timber.e(e, "Failed to load display preferences from API")
            }
+
+            displayPreferences = DisplayPreferences(
+                skipBackLength = customPrefs?.get(Constants.DISPLAY_PREFERENCES_SKIP_BACK_LENGTH)?.toLongOrNull()
+                    ?: Constants.DEFAULT_SEEK_TIME_MS,
+                skipForwardLength = customPrefs?.get(Constants.DISPLAY_PREFERENCES_SKIP_FORWARD_LENGTH)?.toLongOrNull()
+                    ?: Constants.DEFAULT_SEEK_TIME_MS,
+            )


The default display preferences should already use these defaults, so I'm not sure these changes are necessary..

Emily Ehlert added 5 commits May 27, 2024 14:33

Add initial code for client internal downloads

53f5ec3

Add download to internal storage

bfd25c9

Extend ExoPlayer to be able to play downloads

7258688

Store Download Information separately

114c2de

Working Downloads Fragment

b133929

jellyfin-bot added this to the v2.7.0 milestone Jun 3, 2024

Emily Ehlert added 4 commits June 4, 2024 08:22

Add openDownloads to NativeInterface

6486fbe

Add ability to remove downloads

b2978eb

Improve Download Method Check

56179f9

Add detail to DownloadItem

b25b6b2

Emily Ehlert added 6 commits June 4, 2024 13:53

Add option in settings to choose between external and internal download

109ec0d

Update layout dimensions

a039e9f

Fix order of deletion

bff1b17

Improve download speed

ce17f38

Improve exception handling for missing files

874b639

Improve layout and localization

fa9937c

Move media and subtitle download to ExoPlayer Download Service

d3b7ae5

github-advanced-security AI found potential problems Jun 26, 2024

View reviewed changes

7ritn marked this pull request as ready for review June 26, 2024 08:30

neBM reviewed Jun 30, 2024

View reviewed changes

Comment thread app/src/main/java/org/jellyfin/mobile/player/source/JellyfinMediaSource.kt Outdated

Resolve detekt errors

ed904f2

neBM mentioned this pull request Jun 30, 2024

Resolve linting issues 7ritn/jellyfin-android#1

Merged

neBM added 2 commits July 1, 2024 21:18

Abstract JellyfinMediaSource

db53c86

Rename KILOBYTE const to better communicate it's function

3c85198

Emily Ehlert added 2 commits August 22, 2024 18:48

Move byte size conversion to separate file

6f942e0

Improve download notifications

6db98b7

Fix detekt

48c9eb4

jellyfin-bot added the merge conflict Conflicts prevent merging label Jan 26, 2025

Merge branch 'master' into download

4754762

jellyfin-bot removed the merge conflict Conflicts prevent merging label Jan 30, 2025

This comment was marked as off-topic.

Sign in to view

jellyfin-bot added the merge conflict Conflicts prevent merging label Mar 18, 2025

Merge branch 'master' into download

3f216d6

jellyfin-bot removed the merge conflict Conflicts prevent merging label May 6, 2025

github-advanced-security AI found potential problems May 6, 2025

View reviewed changes

Fix download cache

57a984f

github-advanced-security AI found potential problems May 7, 2025

View reviewed changes

nielsvanvelzen approved these changes May 7, 2025

View reviewed changes

nielsvanvelzen merged commit 215a97a into jellyfin:master May 7, 2025

7ritn deleted the download branch May 7, 2025 06:18

Maxr1998 reviewed May 8, 2025

View reviewed changes

Uh oh!

Uh oh!

Conversation

7ritn commented Jun 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

7ritn commented Jun 4, 2024

Uh oh!

7ritn commented Jun 6, 2024

Uh oh!

rcv11x commented Jun 6, 2024

Uh oh!

7ritn commented Jun 6, 2024

Uh oh!

7ritn commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

satmandu commented Jun 30, 2024

Uh oh!

neBM left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

7ritn commented Aug 20, 2024

Uh oh!

7ritn commented Aug 22, 2024

Uh oh!

felixschndr commented Nov 13, 2024

Uh oh!

Maxr1998 commented Jan 27, 2025

Uh oh!

7ritn commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as off-topic.

7ritn commented May 6, 2025

Uh oh!

satmandu commented May 6, 2025

Uh oh!

nielsvanvelzen commented May 6, 2025

Uh oh!

7ritn commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

7ritn commented May 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Maxr1998 commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

7ritn commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Check warning

nielsvanvelzen left a comment

Choose a reason for hiding this comment

Uh oh!

7ritn commented May 7, 2025

Uh oh!

Uh oh!

Maxr1998 Jul 2, 2024

7ritn commented Jun 3, 2024 •

edited

Loading

7ritn commented Jun 24, 2024 •

edited

Loading

7ritn commented Jan 30, 2025 •

edited

Loading

7ritn commented May 6, 2025 •

edited

Loading

Maxr1998 commented May 6, 2025 •

edited

Loading

7ritn commented May 7, 2025 •

edited

Loading