[New feature] External subtitles over UPnP #6184

7pepo7 · 2015-01-11T21:24:10Z

Like in title, it allows to play video with external subtitle over UPnP.

Supported subtitle file extensions: txt, srt, ssa, ass, sub, smi. (most
popular ones)

Subtitle files are searched like in internal player (in video file
folder and in folders specified in options). If more than one subtitle
file are found (multiple language versions), Kodi takes the one with
language choosed in options (prefered language for subtitles), otherwise
first found.

Subtitles are added as 2 resources, 2 sec resources and 3 attributes added to
video file resource, for greater compatibility with more UPnP devices.
Device take the last one it could handle, and skip ones it can't
"understand":

<res protocolInfo="http-get::video/mp4:" xmlns:pv="http://www.pv.com/pvns/" pv:subtitleFileUri="http://192.168.1.13:1722/video.srt" pv:subtitleFileType="SRT">http://192.168.1.13:1722/video.mp4 </res>
<res protocolInfo="http-get::text/srt:"> http://192.168.1.13:1722/video.srt </res>
<res protocolInfo="http-get::smi/caption:"> http://192.168.1.13:1722/video.srt </res>
<sec:CaptionInfoEx sec:type="srt">http://192.168.1.13:1722/video.srt</sec:CaptionInfoEx>
<sec:CaptionInfo sec:type="srt">http://192.168.1.13:1722/video.srt</sec:CaptionInfo>

Samsung devices get subtitles uri from "CaptionInfo.sec" field in http response header for movie file request (it contains "getCaptionInfo.sec" field).

This all should be (and probably it would be) changed, when Profile Manager (for DLNA devices) will be available in Kodi.

lib/libUPnP/Platinum/Source/Devices/MediaServer/PltMediaItem.cpp

+            while (entry)
+            {
+                didl += " ";
+                PLT_Didl::AppendXmlEscape(didl, (NPT_String&)(*entry)->GetKey());


Montellese · 2015-01-12T12:22:57Z

I don't use subtitles but this looks like it will make a lot of people happy.

Please split this into three commits:

Only the changes to lib/libUPnP/Platinum/
Add a patch file of the previous commit to lib/libUPnP/patches
All the other changes to our UPnP integration

7pepo7 · 2015-01-12T14:19:30Z

Thanks for review. I'll try to do changes as quickly as possible. But I have few questions. I'm new in github. I work in Mercurial with SourceTree and mostly for sync my code between work and home, not for team work, so I didn't make pull requests and patches. Could you explain me how to split this to three commits: make new 3 commits and new pull request or something else? What with this pull request? And how to make a patch and add it to remote folder. Sorry for neewbe questions, but I prefer to ask than to do something for which you want to kill me :D Please for understanding :D

Montellese · 2015-01-12T15:32:51Z

No need for hurry. I can only provide you the git bash commands as I'm not using any GUI for git. You need to be on the branch for this PR i.e. master-subtitles.

git reset --soft HEAD^ will remove the commit but keep the changes staged
git reset HEAD will unstage the changed files but still keep the changes
Make the necessary changes to the source code and make sure it still compiles and works
Use git add for every changed file in lib/libUPnP/Platinum/
Use git commit -m "<message>" to commit those changes
git format-patch -1 will create a .patch file in your working directory of the previous commit.
Move that file to lib/libUPnP/patches and change the leading number accordingly to be the last in the list of the patches
Use git add on the patch file
Use git commit -m "<message>" to commit the patch file
Use git add to add the remaining files/changes
Use git commit -m "<message>" to commit those changes
git push -f origin master-subtitles will force push your changes to your remote branch and this PR will automatically be updated.

7pepo7 · 2015-01-12T16:44:22Z

Wow, thank you for so detailed explanation. I'll make changes as soon as I find some time. Thanks again.

Added custom data to resources field - needed to add some attributes to res. Added new struct PLK_SecResource - needed by Somasung devices. It's not specialized struct (just general one), because I can't find any "sec" specification.

7pepo7 · 2015-01-22T07:45:07Z

OK. If you could review it, Montellese.

I didn't change logic for searching best subtitles, cause in DVDPlayer it's based on streams, and here it's worked on files (on paths). I did'nt want to make changes in DVDPlayer class.

It's all should be changed when ProfileManager will be available for Kodi. Now subtitles are added in any available way, to support most of devices. But it should add subtitles only in one way (specific for target device), descibed in Profile for target device. I don't have too much free time, but I'll try to implement ProfileManager feature (but it could take some time). For now I think, that this solution will make some people happy (mostly no English-speaking).

Montellese · 2015-01-22T10:06:55Z

Thanks for the adjustments. There are only a few minors left in the last commit.

7pepo7 · 2015-01-22T17:39:27Z

Ok, I made adjustments. Thanks for guide me in git.

7pepo7 · 2015-01-22T18:44:26Z

I think that now it's ok. Sorry for that. It's Visual Studio and its automatic tabulation.

Montellese · 2015-01-22T18:47:13Z

Looks good for the next merge window. Thanks for taking the time to clean this up.

ace20022 · 2015-01-22T19:01:04Z

Just a general note, preferred is misspelt.

Supported subtitle file extensions: txt, srt, ssa, ass, sub, smi. (most popular ones) Subtitle files are searched like in internal player (in video file folder and in folders specified in options). If more than one subtitle file are found (multiple language versions), Kodi takes the one with language choosed in options (prefered language for subtitles), otherwise first found. Subtitles are added as 2 resources, 2 sec resources and 3 attributes added to video file resource, for greater compatibility with more UPnP devices. Device take the last one it could handle, and skip ones it can't "understand": <res protocolInfo="http-get::video/mp4:" xmlns:pv="http://www.pv.com/pvns/" pv:subtitleFileUri="http://192.168.1.13:1722/video.srt" pv:subtitleFileType="SRT">http://192.168.1.13:1722/video.mp4 </res> <res protocolInfo="http-get::text/srt:"> http://192.168.1.13:1722/video.srt </res> <res protocolInfo="http-get::smi/caption:"> http://192.168.1.13:1722/video.srt </res> <sec:CaptionInfoEx sec:type="srt">http://192.168.1.13:1722/video.srt</sec:CaptionInfoEx> <sec:CaptionInfo sec:type="srt">http://192.168.1.13:1722/video.srt</sec:CaptionInfo> Samsung devices get subtitles uri from "CaptionInfo.sec" field in http response header for movie file request (it contains "getCaptionInfo.sec" field). This all should be (and probably it would be) changed, when Profile Manager (for DLNA devices) will be available in Kodi.

7pepo7 · 2015-01-22T19:31:23Z

Thanks for notice, ace20022 (english it's not my primary language). Corrected.

Montellese · 2015-01-28T12:09:16Z

jenkins build this please

ace20022 · 2015-01-28T12:19:44Z

Thanks for notice, ace20022

Thanks for this great contribution! As Montellese already said: "it'll make a lot of people happy" 👍

MartijnKaijser · 2015-01-29T17:36:03Z

@Montellese can we get your alpha2 milestone list merged as well?

Montellese · 2015-01-29T19:17:48Z

@MartijnKaijser: I don't follow. All of the PRs I've assigned to the next merge window should be ready to be merged (and have been built by jenkins).

MartijnKaijser · 2015-01-30T13:59:43Z

it's not worth releasing a first alpha1 while we still have frequent crashing on Android-x86 and Windows. So might as well already get the rest in and close merge window nearing ending of February. That way you can also go through your PRs more rapid.

upnp: support for external subtitles

Forage · 2015-02-03T17:15:24Z

Not sure to what extend the bug tracker is being monitored for this feature, but this PR mean that at least http://trac.kodi.tv/ticket/15142 can be closed/updated.

NedScott · 2015-03-10T10:30:05Z

Just a heads up, it seems this is causing quite a heavy load for some people's networks: http://forum.kodi.tv/showthread.php?tid=220840

Montellese · 2015-03-10T10:38:40Z

@NedScott: Thanks for the hint. The logic should probably be adjusted to only look for external subtitles and provide them in the DIDL response if an item is starting to play. In all other cases the information about additional subtitles is not really of any use.

@7pepo7: Do you have time to look into this?

7pepo7 · 2015-03-11T07:33:01Z

Ok. I'll take a look into this at saturday (sorry, no time at the moment).

Montellese · 2015-03-11T10:29:56Z

I've taken a stab at this in https://github.com/Montellese/xbmc/commits/upnp_fix_ext_subtitles but I won't be able to test it myself but a forum user has volunteered. Will report back once I get some test results.

Implemented streaming of subtitles over DLNA/UPnP I noticed Kodi (XBMC) has recently added the feature of transmitting external subtitles over UPnP: xbmc/xbmc#6184 I got inspired and decided to try implementing it for Popcorn Time. I did a little study regarding the UPnP protocol, and found out that it is possible to pass a xml-encoded metadata to the UPnP renderer device. You have to fill the `CurrentURIMetaData` parameter of the `SetAVTransportURI` function of the `AVTransport`. The nodejs module `upnp-mediarenderer-client` handles these messages, and it is already used by Popcorn Time to transmit video through UPnP. Fortunately, its latest version (0.0.3) added support for passing the metadata information to the client object. The XML metadata contains the URIs of the video and of the subtitle, disposed in several different ways. This is necessary to maximize the compatibility with different UPnP/DLNA devices, since each vendo implements the retrieval of subtitles over UPnP in different ways. For instance, Samsung devices inspect the CaptionInfo information. I also noticed that some devices (XBMC, for example) require a title for the video. This is an example of the XML tree I'm using so far, and seems to be working well: ```XML <DIDL-Lite xmlns="urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:upnp="urn:schemas-upnp-org:metadata-1-0/upnp/" xmlns:dlna="urn:schemas-dlna-org:metadata-1-0/" xmlns:sec="http://www.sec.co.kr/" xmlns:xbmc="urn:schemas-xbmc-org:metadata-1-0/"> <item id="0" parentID="-1" restricted="1"> <dc:title>Popcorn Time Video</dc:title> <res protocolInfo="http-get:*:video/mp4:" xmlns:pv="http://www.pv.com/pvns/" pv:subtitleFileUri="http://192.168.1.3:9999/video.srt" pv:subtitleFileType="srt">http://192.168.1.3:60082/video.mp4</res> <res protocolInfo="http-get:*:text/srt:*">http://192.168.1.3:9999/video.srt</res> <res protocolInfo="http-get:*:smi/caption:*">http://192.168.1.3:9999/video.srt</res> <sec:CaptionInfoEx sec:type="srt">http://192.168.1.3:9999/video.srt</sec:CaptionInfoEx> <sec:CaptionInfo sec:type="srt">http://192.168.1.3:9999/video.srt</sec:CaptionInfo> <upnp:class>object.item.videoItem.movie</upnp:class> </item> </DIDL-Lite> ``` So far, the metadata is sent only if there's a subtitle selected/available. Notice that it can be used to send many other information, like description, date and even the cover/poster art images. For future versions, it would be interesting seeing, for example, the posters of the movies in external DLNA players. I was able to test and confirm it is working in these devices: - Kodi 14.1 - Raspbmc (XBMC for Raspberry Pi) - LG TV 2012 - LG Home Theater 2014 (partially) The LG HT was crashing at the beginning. I noticed the HT was indeed interpreting the metadata correctly, and was even requesting the "video.srt" file. Later, I realized that the issue was that, due to a bug in Popcorn Time's subtitle server (which does not handle partial range-based http requests of the file), the HT was indefinitely requesting the subtitle file from Popcorn Time, and this was causing both PT and the HT to crash. I figured out a way to fix this, but I plan to create a separate issue and merge request for this, since this touches more files and (hopefully) affects only some devices. This crash is apparently rare, and does not happen when not using subtitles. **Steps to test the feature:** 1. Turn on and setup a DLNA/UPnP renderer device in the same network of the Popcorn Time. 2. Open Popcorn Time in your computer, and select a movie/tv in the main screen; 3. Select a subtitle language from the list; 4. Select your DLNA/UPnP device from the list of external players; 5. Click on play, and wait for the video to start streaming in the device; 6. Test either subtitles are shown or not. Please report the vendor/type of your device or software used as DLNA/UPnP player. See merge request !17

Montellese reviewed Jan 12, 2015
View reviewed changes

lib/libUPnP/Platinum/Source/Devices/MediaServer/PltMediaItem.cpp

while (entry)

{

didl += " ";

PLT_Didl::AppendXmlEscape(didl, (NPT_String&)(*entry)->GetKey());

This comment was marked as spam.

Sign in to view

7pepo7 added 2 commits January 17, 2015 15:55

PATCH for Platinum library needed to external subtitles over UPnP works.

e1dd709

7pepo7 force-pushed the master-subtitles branch 3 times, most recently from d639b95 to ad6aa8e Compare January 21, 2015 18:59

Montellese added Type: Feature non-breaking change which adds functionality v15 Isengard labels Jan 22, 2015

7pepo7 force-pushed the master-subtitles branch from ad6aa8e to 91432eb Compare January 22, 2015 17:37

7pepo7 force-pushed the master-subtitles branch from 91432eb to a68b542 Compare January 22, 2015 18:41

Montellese added this to the I******* 15.0-alpha2 milestone Jan 22, 2015

Montellese self-assigned this Jan 22, 2015

7pepo7 force-pushed the master-subtitles branch from a68b542 to e46e419 Compare January 22, 2015 19:29

Montellese added a commit that referenced this pull request Jan 31, 2015

Merge pull request #6184 from 7pepo7/master-subtitles

30350ff

upnp: support for external subtitles

Montellese merged commit 30350ff into xbmc:master Jan 31, 2015

MartijnKaijser modified the milestones: I******* 15.0-alpha2, I******* 15.0-alpha1 Feb 1, 2015

oleksii-frolov mentioned this pull request Jul 9, 2015

Are subtitles supported or is there a plan to support them? ConnectSDK/Connect-SDK-Android#214

Closed

CrystalP mentioned this pull request Mar 31, 2024

[videoplayer] Fix Playback Delay for Items from uPnP sources #24922

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[New feature] External subtitles over UPnP #6184

[New feature] External subtitles over UPnP #6184

7pepo7 commented Jan 11, 2015

This comment was marked as spam.

Montellese commented Jan 12, 2015

7pepo7 commented Jan 12, 2015

Montellese commented Jan 12, 2015

7pepo7 commented Jan 12, 2015

7pepo7 commented Jan 22, 2015

Montellese commented Jan 22, 2015

7pepo7 commented Jan 22, 2015

7pepo7 commented Jan 22, 2015

Montellese commented Jan 22, 2015

ace20022 commented Jan 22, 2015

7pepo7 commented Jan 22, 2015

Montellese commented Jan 28, 2015

ace20022 commented Jan 28, 2015

MartijnKaijser commented Jan 29, 2015

Montellese commented Jan 29, 2015

MartijnKaijser commented Jan 30, 2015

Forage commented Feb 3, 2015

NedScott commented Mar 10, 2015

Montellese commented Mar 10, 2015

7pepo7 commented Mar 11, 2015

Montellese commented Mar 11, 2015

[New feature] External subtitles over UPnP #6184

[New feature] External subtitles over UPnP #6184

Conversation

7pepo7 commented Jan 11, 2015

This comment was marked as spam.

Montellese commented Jan 12, 2015

7pepo7 commented Jan 12, 2015

Montellese commented Jan 12, 2015

7pepo7 commented Jan 12, 2015

7pepo7 commented Jan 22, 2015

Montellese commented Jan 22, 2015

7pepo7 commented Jan 22, 2015

7pepo7 commented Jan 22, 2015

Montellese commented Jan 22, 2015

ace20022 commented Jan 22, 2015

7pepo7 commented Jan 22, 2015

Montellese commented Jan 28, 2015

ace20022 commented Jan 28, 2015

MartijnKaijser commented Jan 29, 2015

Montellese commented Jan 29, 2015

MartijnKaijser commented Jan 30, 2015

Forage commented Feb 3, 2015

NedScott commented Mar 10, 2015

Montellese commented Mar 10, 2015

7pepo7 commented Mar 11, 2015

Montellese commented Mar 11, 2015