Giter Club home page Giter Club logo

jellyfin-android's Introduction

Jellyfin

The Free Software Media System


Logo Banner

GPL 2.0 License Current Release Translation Status Azure Builds Docker Pull Count
Donate Submit Feature Requests Chat on Matrix Join our Subreddit Release RSS Feed Master Commits RSS Feed


Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!

For further details, please see our documentation page. To receive the latest updates, get help with Jellyfin, and join the community, please visit one of our communication channels. For more information about the project, please see our about page.

Want to get started?
Check out our downloads page or our installation guide, then see our quick start guide. You can also build from source.

Something not working right?
Open an Issue on GitHub.

Want to contribute?
Check out our contributing choose-your-own-adventure to see where you can help, then see our contributing guide and our community standards.

New idea or improvement?
Check out our feature request hub.

Don't see Jellyfin in your language?
Check out our Weblate instance to help translate Jellyfin and its subprojects.

Detailed Translation Status

Jellyfin Server

This repository contains the code for Jellyfin's backend server. Note that this is only one of many projects under the Jellyfin GitHub organization on GitHub. If you want to contribute, you can start by checking out our documentation to see what to work on.

Server Development

These instructions will help you get set up with a local development environment in order to contribute to this repository. Before you start, please be sure to completely read our guidelines on development contributions. Note that this project is supported on all major operating systems except FreeBSD, which is still incompatible.

Prerequisites

Before the project can be built, you must first install the .NET 8.0 SDK on your system.

Instructions to run this project from the command line are included here, but you will also need to install an IDE if you want to debug the server while it is running. Any IDE that supports .NET 6 development will work, but two options are recent versions of Visual Studio (at least 2022) and Visual Studio Code.

ffmpeg will also need to be installed.

Cloning the Repository

After dependencies are installed you will need to clone a local copy of this repository. If you just want to run the server from source you can clone this repository directly, but if you are intending to contribute code changes to the project, you should set up your own fork of the repository. The following example shows how you can clone the repository directly over HTTPS.

git clone https://github.com/jellyfin/jellyfin.git

Installing the Web Client

The server is configured to host the static files required for the web client in addition to serving the backend by default. Before you can run the server, you will need to get a copy of the web client since they are not included in this repository directly.

Note that it is also possible to host the web client separately from the web server with some additional configuration, in which case you can skip this step.

There are three options to get the files for the web client.

  1. Download one of the finished builds from the Azure DevOps pipeline. You can download the build for a specific release by looking at the branches tab of the pipelines page.
  2. Build them from source following the instructions on the jellyfin-web repository
  3. Get the pre-built files from an existing installation of the server. For example, with a Windows server installation the client files are located at C:\Program Files\Jellyfin\Server\jellyfin-web

Running The Server

The following instructions will help you get the project up and running via the command line, or your preferred IDE.

Running With Visual Studio

To run the project with Visual Studio you can open the Solution (.sln) file and then press F5 to run the server.

Running With Visual Studio Code

To run the project with Visual Studio Code you will first need to open the repository directory with Visual Studio Code using the Open Folder... option.

Second, you need to install the recommended extensions for the workspace. Note that extension recommendations are classified as either "Workspace Recommendations" or "Other Recommendations", but only the "Workspace Recommendations" are required.

After the required extensions are installed, you can run the server by pressing F5.

Running From The Command Line

To run the server from the command line you can use the dotnet run command. The example below shows how to do this if you have cloned the repository into a directory named jellyfin (the default directory name) and should work on all operating systems.

cd jellyfin                          # Move into the repository directory
dotnet run --project Jellyfin.Server --webdir /absolute/path/to/jellyfin-web/dist # Run the server startup project

A second option is to build the project and then run the resulting executable file directly. When running the executable directly you can easily add command line options. Add the --help flag to list details on all the supported command line options.

  1. Build the project
dotnet build                       # Build the project
cd Jellyfin.Server/bin/Debug/net8.0 # Change into the build output directory
  1. Execute the build output. On Linux, Mac, etc. use ./jellyfin and on Windows use jellyfin.exe.

Accessing the Hosted Web Client

If the Server is configured to host the Web Client, and the Server is running, the Web Client can be accessed at http://localhost:8096 by default.

API documentation can be viewed at http://localhost:8096/api-docs/swagger/index.html

Running from GH-Codespaces

As Jellyfin will run on a container on a github hosted server, JF needs to handle some things differently.

NOTE: Depending on the selected configuration (if you just click 'create codespace' it will create a default configuration one) it might take 20-30 secounds to load all extensions and prepare the enviorment while vscode is already open. Just give it some time and wait until you see Downloading .NET version(s) 7.0.15~x64 ...... Done! in the output tab.

NOTE: If you want to access the JF instance from outside, like with a WebClient on another PC, remember to set the "ports" in the lower VsCode window to public.

NOTE: When first opening the server instance with any WebUI, you will be send to the login instead of the setup page. Refresh the login page once and you should be redirected to the Setup.

There are two configurations for you to chose from.

Default - Development Jellyfin Server

This creates a container that has everything to run and debug the Jellyfin Media server but does not setup anything else. Each time you create a new container you have to run though the whole setup again. There is also no ffmpeg, webclient or media preloaded. Use the .NET Launch (nowebclient) lunch config to start the server.

Keep in mind that as this has no web client you have to connect to it via an extenal client. This can be just another codespace container running the WebUI. vuejs does not work from the getgo as it does not support the setup steps.

Development Jellyfin Server ffmpeg

this extens the default server with an default installation of ffmpeg6 though the means described here: https://jellyfin.org/docs/general/installation/linux#repository-manual If you want to install a specific ffmpeg version, follow the comments embedded in the .devcontainer/Dev - Server Ffmpeg/install.ffmpeg.sh file.

Use the ghcs .NET Launch (nowebclient, ffmpeg) launch config to run with the jellyfin-ffmpeg enabled.

Running The Tests

This repository also includes unit tests that are used to validate functionality as part of a CI pipeline on Azure. There are several ways to run these tests.

  1. Run tests from the command line using dotnet test
  2. Run tests in Visual Studio using the Test Explorer
  3. Run individual tests in Visual Studio Code using the associated CodeLens annotation

Advanced Configuration

The following sections describe some more advanced scenarios for running the server from source that build upon the standard instructions above.

Hosting The Web Client Separately

It is not necessary to host the frontend web client as part of the backend server. Hosting these two components separately may be useful for frontend developers who would prefer to host the client in a separate webpack development server for a tighter development loop. See the jellyfin-web repo for instructions on how to do this.

To instruct the server not to host the web content, there is a nowebclient configuration flag that must be set. This can specified using the command line switch --nowebclient or the environment variable JELLYFIN_NOWEBCONTENT=true.

Since this is a common scenario, there is also a separate launch profile defined for Visual Studio called Jellyfin.Server (nowebcontent) that can be selected from the 'Start Debugging' dropdown in the main toolbar.

NOTE: The setup wizard can not be run if the web client is hosted separately.


This project is supported by:

DigitalOcean ย  JetBrains logo

jellyfin-android's People

Contributors

4d1m avatar alanazar avatar animegasan avatar carlosolivo avatar danielxb-ar avatar dependabot[bot] avatar djcand avatar djsweder avatar gradle-update-robot avatar h1dden-da3m0n avatar hdmaniac avatar hoanghuy309 avatar kucharczykl avatar maxr1998 avatar millallo avatar moritzleick avatar newton181 avatar nextlooper42 avatar nielsvanvelzen avatar nyanmisaka avatar oatavandi avatar olavinto avatar queeup avatar renovate-bot avatar renovate[bot] avatar saddfox avatar tschwery avatar weblate avatar wolonggl avatar wwwesten avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jellyfin-android's Issues

Going back after coming from PiP doesn't return to Jellyfin

Describe the bug
When coming out of PIP, when i press back (or 'gesture' back in my case), i return to the homescreen of my phone instead of to jellyfin.

To Reproduce

  1. Play video
  2. Press home to go to PiP mode
  3. Return to fullscreen video
  4. Press back

Expected behavior
Pressing back should return to jellyfin (specifically the last view) instead of to the android homescreen

System (please complete the following information):

  • App version: 2.0.0-rc.3
  • Android version: Android 10
  • Device manufacturer and model: Oneplus 6T
  • Jellyfin server version: 10.6.3
  • The type of video player implementation used: ExoPlayer

Unnecessary x265 transcoding

Describe the bug
When trying to play a x265 10 bit file using the jellyfin android app v2.0.0-rc2 the file is being transcoded with the given reason : VideoCodecNotSupported when I know for a fact that my phone (Xiaomi Mi 9T) supports it. When trying to play the same file using Plex or Emby it is able to direct play.

To Reproduce

  1. Try to play x265 10bit file on android app.
  2. Go to dashboard and see that the file is being transcoded with reason: VideoCodecNotSupported

Expected behavior
The file should direct play.

Logs
Logs of transcode : Log.txt

Screenshots

System (please complete the following information):

  • App version: 2.0.0-rc.2
  • Android version: Android 10
  • Device manufacturer and model: Xiaomi Mi 9T
  • Jellyfin server version: 10.6.3
  • The type of video player implementation used: Jellyfin android player

Additional context

Downloads broken on Android versions below 10

If I try to download a movie it dosent work. Sometimes the app crashes, sometimes nothing happens at all. The app also never requested file write and read premissions...

Nothing Happens

  1. Select movie by tap and holding it
  2. Click Download

The App crashes

  1. Select Show
  2. Select season
  3. On the Episode you want to download click three point menu
  4. tap download
  5. click wlan

System:

  • App version: e.g. 2.0.0-rc.3
  • Android version: Android 9
  • Device manufacturer and model: Xioami Mi A2
  • Jellyfin server version: 10.6.3

Permanently blocked at loading screen

After signing in and out from a server the app is permanently blocked in a loading screen with no way to login, logout or change server. Only way to unblock is to clear app data from android app manager.

Screenshot_1598255472

Playing music stutters when the app is in the background

When i'm paying a song with jellyfin open in the background the song start to stutter (sounds like the song stops for a few milliseconds). As soon as i bring jellyfin to the foreground the song continues to play without any issues. Changing between background and foreground always results in this behavior.

Device: Pixel 2
OS: Android 10 (QQ3A.200805.001)
Jellyfin App: 2.0.0-rc2
Jellyfin Server: 10.6.2

"Start Now" for playing next episode overlaps rewind button

I have an android tablet - B&N 10" Nook - that I use with the JF client. At the end of any TV episode that has another following, the "Start Now" button comes up at the bottom left. However, the particular position overlays the rewind button just below the progress bar. When I press it, instead of starting the next episode, it just rewinds the currently playing episode by 30 seconds. Is there a way to make the overlay buttons the absolute input for the entire space they occupy?

Unnecessary x265 transcoding and broken transcode playback (blackscreen)

When playing a video in HEVC format the player transcodes to H.264 but does not reproduce image. The same happens when transcoding a video due to problems with internet speed. When lowering the quality, this black screen BUG happens and does not reproduce image. My device supports H.265 and other audio and video codecs.

Screenshots
https://imgur.com/EgG4sZ5

System (please complete the following information):

  • App version: [2.0.0-rc.3]
  • Android version: [ Android 9.0]
  • Device manufacturer and model: [LG G4]
  • Jellyfin server version: [10.6.3]
  • The type of video player implementation used: [Integrated player (ExoPlayer)]

ASS Subtitles not working

Describe the bug

Playing video with embedded ASS subtitles doesn't display any subtitle.

To Reproduce

  1. Download mkv anime from this season
  2. Let jellyfin server index said anime
  3. Play said anime on smartphone

Expected behavior

Subtitle visible when playing video

Logs

No error is displayed whatsoever

Screenshots

Sample video media info

image

System (please complete the following information):

  • App version: v2.0.0-rc2
  • Android version: 5
  • Device manufacturer and model: Samsung Galaxy S5 Neo
  • Jellyfin server version: 10.6.0
  • The type of video player implementation used: default player, i think it's the "web" player

Additional context

Only workaround is manually set subtitles to "Off" and the select the subs track again. This sometimes triggers #46

Use EditorConfig from Android TV app

We have 2 Android apps now based on Kotlin. I think it would be a good thing to have the same styling guidelines for both of them. At this moment the android-next app uses spaces as indentation while Android TV chose to use tabs.

The EditorConfig for Android TV is here. We could just copy it over and reformat all Kotlin files.

Shortcut removed from launcher after 1.x -> 2.x play upgrade

Describe the bug
I updated from the latest 1.x version to the 2.x beta channel in the play store and unfortunately the home icon was removed.

To Reproduce

  1. Install app from play store
  2. Add shortcut to home screen
  3. Join beta
  4. Update app
  5. ??
  6. Profit

Expected behavior
The home icon stays on the home screen.

Logs
Not relevant

Screenshots
No

System (please complete the following information):

  • App version: 2.0.0-rc.3
  • Android version: Android 10
  • Device manufacturer and model: Oneplus 6
  • Jellyfin server version: 13.37
  • The type of video player implementation used: No

Additional context
This is why we test

"Client settings" parameter page not following the user display language

Describe the bug
The "client settings" parameter page doesn't follow the display language used by the logged user but the language used by Android.

To Reproduce

  1. Set a display language different than the phone's
  2. Restart the app to apply the changes
  3. Go to "client settings" and see the strings displayed in the phone's language

Expected behavior
It should use the display language specified by the user.

System (please complete the following information):

  • App version: 2.0.0-rc.3
  • Android version: Android 8
  • Device manufacturer and model: Samsung Galaxy A5 2017
  • Jellyfin server version: 10.6.4
  • The type of video player implementation used: N/A

Unable to connect to server

Version: 2.0.0-rc1
Flavor: Both release and debug tested

It's not possible to connect to a server within my Pixel 2 (API 30) emulator. I tried both my personal server and the demo server. Opening both in chrome or another app works. Logcat does not show anything.

image

ExoPlayer profiles don't always work as expected - unnecessary transcoding, broken transcodes

The currently shipped ExoPlayer profile doesn't properly advertise the device capabilities in some cases, e.g. HEVC seems to be transcoded sometimes although it shouldn't need to. Since I'm not very knowledgeable into the internals of Jellyfin transcoding and profiles, I'd request others to help me with getting to profile to work properly with as many devices as possible.

Gesture hint is white on Android 10

As shown in picture on Samsung devices running Android 10 there is white line on the bottom of the screen and it doesn't look nice with Jellyfin dark UI.
Picture
It would be nice to make it transparent like on Iphones

UI mismatch when selecting subtitles with tracks not supported by ExoPlayer

This was already worked around for WebVTT subtitles, but reportedly also occurs with ass/ssa subtitles.
The issue lies within mapping the supplied track numbers to the track is that ExoPlayer uses.
The best way to fix that would be having Jellyfin send both track ids and track number in the request data, and add index pre-checks to the subtitles selection.

Download/cache songs/albums/playlists/(videos?)

Describe the feature you'd like
The only thing I really miss with this app is some sort of download/cache mechanism similar to what you find in e.g. Spotify. At the moment it is possible do download individual media by clicking the download button, but this is downloaded as a regular download and not a cache, so if you then play the media from the app it is still streamed. This would be really useful for when you are travelling and want you favourite album or a film ready to be watched. For me this is most important for audio, but I can see that people would find it useful to be able to cache video as well like you can with e.g. Netflix.

If it was possible to then filter by "downloaded only" that would be extra useful.

Add "screen lock" feature

Describe the feature you'd like
Add a button in the video controls to lock the screen from accidental touch inputs. MX Player had this feature for years and Netflix recently added this too. Would love to have it in the Jellyfin app as well.

Additional context
Here are some screenshots from Netflix and MX Player:

Screenshot_20200830-163607

Screenshot_20200420_170917 0

Add transcoding selector

Support playback quality controls in native player to limit bitrate (and resolution) by transcoding the video files.

Jellyfin for Android 2.0.0 release plan

Release plan

  1. Tag release candidate 2
    • Only available via GitHub, should be tested by people that can report issues
    • When any issues arise start work on a new release candidate before proceeding
  2. Create a new (public) beta channel on Google Play
  3. Push the release candidate to the beta channel
    • When any issues arise start work on a new release candidate and push it to the beta channel
  4. Wait at least 1 week to catch issues from late users
  5. Release 2.0.0
    • Tag 2.0.0
    • Promote the beta channel to stable
    • Update app on the Amazon Appstore
  6. Re-apply for F-Droid (our previous request is based on the old Cordova app which does not exist anymore)

Subtitle selection box missing Off option in media overview

This only seems to happen with media with one subtitle track, as I cannot produce on media with multiple. I can still select no subtitles when media is playing, but not before. This also seems to break the auto subtitle selection.

Cannot reproduce on web (10.6.3), so assuming this is due to an older version of web being in the latest release of the client? Am on v1.0.2, will build master in the morning and see if this is fixed there.

Edit: To clarify, there's no drop-down selection at all, it's like there's no subtitle tracks at all (except there are, well, there's one.)

Subtitles on exoplayer

Subtitles get displayed in a black text box, it would be nice for just the text to appear over the video.

ASS Subtitles not working

Playing video with embedded ASS subtitles doesn't display anything. This is reproducible with most of my video files with ASS subs.

Android 10's 3 button navigation buttons cover the audio playback controls

Describe the bug

In Android 10, I'm using the 3-button system navigation setting (not gestures). These 3 buttons remain visible and active on top of Jellyfin's playback progress bar and play/pause/next controls. I believe they should either autohide or the UI should end above this section of the screen.

To Reproduce

  1. Use 3 button system navigation (System Settings > System > Gestures > System Navigation)
  2. Install Jellyfin (Beta) for Android from the Play Store (beta channel)
  3. Start Jellyfin and connect/login to your server
  4. Observe while browsing media that the 3 navigation buttons are transparently overlaid on top of the Jellyfin UI
  5. Choose a song to play
  6. Observe that the playback controls/display at the bottom appear underneath the transparent system navigation buttons

Expected behavior

I think it makes sense to use the full screen for video playback (with auto-hide navigation buttons), but for audio playback or browsing it may make more sense to limit the UI to just above the navigation buttons.

Screenshots

jellyfin_android_screenshot

System (please complete the following information):

  • App version: 2.0.0-rc.3
  • Android version: Android 10
  • Device manufacturer and model: Google Pixel 4a
  • Jellyfin server version: 10.6.3
  • The type of video player implementation used: web player.

Additional context

I did enable the Make music player notification always display option.

Music playback stops after some time when app is in background.

Describe the bug
Playback abruptly stops some time after pulling another app to the foreground.

To Reproduce

  1. Start playback
  2. Open a different app in foreground
  3. Wait

System (please complete the following information):

  • App version: master at 811d911
  • Android version: Android 9
  • Device manufacturer and model: Xiaomi Redmi Redmi S2
  • Jellyfin server version: 10.6.3

Additional context
Judging by disappearing notification and app reloading when switching back to it, looks like it gets suspended, but all battery optimisations are disabled and system has plenty of memory left. Version present in play store has same issue, but much more often, about every minute, and even when Jellyfin was in foreground.

Skip forward and back doesn't follow settings in exoplayer

Pressing the right side of the screen doesn't skip the set 30s but only 5s

To Reproduce

  1. Set forward and back skip to 30 seconds in settings
  2. Start video
  3. Skip forward and backward by double tapping the sides of the screen

System (please complete the following information):

  • App version: 2.0.0-rc.2
  • Android version: Android 10
  • Device manufacturer and model: OnePlus 6t
  • Jellyfin server version: 10.6.3
  • The type of video player implementation use: integrated player (Exoplayer)

Can't add two instances of same server

I need to access my Jellyfin server differently if I'm within my LAN vs from the internet, but I can't seem to add these two addresses to the android app at the same time. I.e., 192.168.0.3 and mydomain.duckdns.org.

Since these are actually the same server, the last one I enter seems to overwrite the last I want to have both there at once.

I'm using the latest version of the android client from Google Play.

ExoPlayer not playing Jpn AAC file

Describe the bug

I can't play anime files with Jpn AAC audio description. But if the audio file like the one below can run smoothly.

Screenshots

Screenshot_20200830_030246
Screenshot_20200830_032008

System (please complete the following information):

  • App version: 2.0.0-rc.3
  • Android version: Android 8.1
  • Device manufacturer and model: Vivo V7
  • Jellyfin server version: 10.6.2
  • The type of video player implementation used: Integrated player (ExoPlayer)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.