Skip to content

Add Subtitle Extract plugin #937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 6, 2024
Merged

Add Subtitle Extract plugin #937

merged 1 commit into from
Apr 6, 2024

Conversation

ericswpark
Copy link
Contributor

From jellyfin/jellyfin-plugin-subtitleextract#22

This PR adds the Subtitle Extract plugin to the documentation and also encourages new Jellyfin administrators to install them.

Honestly I think the SE plugin should be integrated into Jellyfin given the horrible experience users will get without it, but I remember seeing a PR that integrated it into Jellyfin getting closed because it relied on some side effect? Can't find the URL for it at the moment but I remember @crobibero commented on it, and he did spin it out to the SE plugin.

Finally, I'm not sure about the wording for recommending individual plugins -- I do get that some people will find this recommendation useless, but I honestly do believe that a majority if not all Jellyfin admins would want to have this plugin by default. Without it, the UX of enabling and viewing subtitles becomes really annoying for viewers as it can take more than a couple of seconds to sometimes a couple of minutes (depending on server load, file size that impacts how long ffmpeg takes to map the subtitle stream out from the container, etc.) for the subtitle to show. Please suggest any alternative wording if you think there's a better option!

@felix920506
Copy link
Member

Adding the plugin to the list of plugins is fine. However we are still discussing internally whether we want a recommended plugins sections or not.

@ericswpark
Copy link
Contributor Author

@felix920506 that's what I figured. Feel free to leave the PR open until the discussion is resolved or close it altogether for an alternate solution.

@felix920506
Copy link
Member

felix920506 commented Apr 5, 2024

We have decided against having a recommended plugins section in our docs. Coby originally meant for the plugin to be added as a troubleshooting tip. I will review your other changes in this PR shortly.

@ericswpark
Copy link
Contributor Author

@felix920506 I've removed the recommended section and removed the extra blank lines.

@ericswpark ericswpark requested a review from felix920506 April 5, 2024 11:47
@ericswpark ericswpark changed the title Add Subtitle Extract plugin and recommend for new installations Add Subtitle Extract plugin Apr 5, 2024
@ericswpark
Copy link
Contributor Author

@felix920506 @crobibero just wondering what you guys meant by the plugin being added as a "troubleshooting tip" and it depending on a "side effect." Because on my server, with files as small as 20 GB the subtitles take a while to mux out with ffmpeg. I've seen wait times around 30+ seconds to 90 seconds even, and even longer than that if there are other processes competing for I/O.

Granted this is only for sessions that can't direct play the file, but that's nearly all of the play sessions from our server as we use a mix of different devices with apps/browsers used to access Jellyfin. In addition, if we are playing outside the home network and the bitrate goes over our uplink speed then it'll always transcode and we'll run into the subtitle delay. What exactly do you guys mean with the above? Is this unexpected behavior on Jellyfin's side, or something else that I'm not understanding clearly here?

@felix920506
Copy link
Member

felix920506 commented Apr 6, 2024

There is a troubleshooting page in the documentation.
https://jellyfin.org/docs/general/administration/troubleshooting
If you want you can add that in this PR. Alternatively I can merge this PR in its current state and you can add it to troubleshooting in another PR.

@ericswpark
Copy link
Contributor Author

ericswpark commented Apr 6, 2024

@felix920506 right, but I was just curious as to why this plugin is considered a troubleshooting step. Unless I'm mistaken, all Jellyfin admins will run into this with giant files that have subtitles muxed in.

Unless the intended behavior of Jellyfin is show "fetching additional data" for several minutes while the server works on extracting the subtitle data over and over again when it is requested, I don't think this plugin should be deemed a "troubleshooting step."

At any rate, this PR can be merged in its current state. I just thought it would be nice to let potential users of Jellyfin know that this is available.

@felix920506
Copy link
Member

This isn't really that common of an issue among the JF users that show up in the various troubleshooting channels.
It is a troubleshooting step in that most people will think that it is a performance issue when they see it.

@felix920506 felix920506 merged commit 35a9397 into jellyfin:master Apr 6, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants