PlexKodiConnect/resources/lib/player.py

# -*- coding: utf-8 -*-

#################################################################################################

import json

import xbmc
import xbmcgui

import utils
import clientinfo
import downloadutils
import websocket_client as wsc

from urllib import urlencode

#################################################################################################


@utils.logging
class Player(xbmc.Player):

    # Borg - multiple instances, shared state
    _shared_state = {}

    played_info = {}
    playStats = {}
    currentFile = None

    def __init__(self):

        self.__dict__ = self._shared_state

        self.clientInfo = clientinfo.ClientInfo()
        self.doUtils = downloadutils.DownloadUtils()
        self.ws = wsc.WebSocket_Client()
        self.xbmcplayer = xbmc.Player()

        self.logMsg("Starting playback monitor.", 2)

        # Should we start notification or is this done by Plex Companion?
        self.doNotify = False if (utils.settings('plexCompanion') == 'true') \
            else True
        if self.doNotify:
            self.logMsg("PMS notifications not done by Plex Companion", 2)
        else:
            self.logMsg("PMS notifications done by Plex Companion", 2)

    def GetPlayStats(self):
        return self.playStats

    def onPlayBackStarted( self ):
        # Will be called when xbmc starts playing a file
        xbmcplayer = self.xbmcplayer
        self.stopAll()

        # Get current file
        try:
            currentFile = xbmcplayer.getPlayingFile()
            xbmc.sleep(300)
        except:
            currentFile = ""
            count = 0
            while not currentFile:
                xbmc.sleep(100)
                try:
                    currentFile = xbmcplayer.getPlayingFile()
                except: pass

                if count == 5: # try 5 times
                    self.logMsg("Cancelling playback report...", 1)
                    break
                else: count += 1


        if currentFile:

            self.currentFile = currentFile
            # Save currentFile for cleanup later
            utils.window('plex_lastPlayedFiled', value=currentFile)
            # We may need to wait for info to be set in kodi monitor
            itemId = utils.window("emby_%s.itemid" % currentFile)
            tryCount = 0
            while not itemId:
                
                xbmc.sleep(200)
                itemId = utils.window("emby_%s.itemid" % currentFile)
                if tryCount == 20: # try 20 times or about 10 seconds
                    self.logMsg("Could not find itemId, cancelling playback report...", 1)
                    break
                else: tryCount += 1
            
            else:
                utils.window('Plex_currently_playing_itemid', value=itemId)
                self.logMsg("ONPLAYBACK_STARTED: %s itemid: %s" % (currentFile, itemId), 0)

                # Only proceed if an itemId was found.
                embyitem = "emby_%s" % currentFile
                runtime = utils.window("%s.runtime" % embyitem)
                refresh_id = utils.window("%s.refreshid" % embyitem)
                playMethod = utils.window("%s.playmethod" % embyitem)
                itemType = utils.window("%s.type" % embyitem)
                utils.window('emby_skipWatched%s' % itemId, value="true")

                # Suspend library sync thread while movie is playing
                self.logMsg("Playing itemtype is: %s" % itemType, 1)
                if itemType in ['movie', 'audio']:
                    self.logMsg("Suspending library sync while playing", 1)
                    utils.window('suspend_LibraryThread', value='true')

                if (utils.window('emby_customPlaylist') == "true" and
                        utils.window('emby_customPlaylist.seektime')):
                    # Start at, when using custom playlist (play to Kodi from webclient)
                    seektime = utils.window('emby_customPlaylist.seektime')
                    self.logMsg("Seeking to: %s" % seektime, 1)
                    xbmcplayer.seekTime(int(seektime)/10000000.0)
                    utils.window('emby_customPlaylist.seektime', clear=True)

                seekTime = xbmcplayer.getTime()

                # Get playback volume
                volume_query = {

                    "jsonrpc": "2.0",
                    "id": 1,
                    "method": "Application.GetProperties",
                    "params": {

                        "properties": ["volume", "muted"] 
                    }
                }
                result = xbmc.executeJSONRPC(json.dumps(volume_query))
                result = json.loads(result)
                result = result.get('result')
                
                volume = result.get('volume')
                muted = result.get('muted')

                # Postdata structure to send to Emby server
                url = "{server}/:/timeline?"
                postdata = {

                    'QueueableMediaTypes': "Video",
                    'CanSeek': True,
                    'ItemId': itemId,
                    'MediaSourceId': itemId,
                    'PlayMethod': playMethod,
                    'VolumeLevel': volume,
                    'PositionTicks': int(seekTime * 10000000),
                    'IsMuted': muted
                }

                # Get the current audio track and subtitles
                if playMethod == "Transcode":
                    # property set in PlayUtils.py
                    postdata['AudioStreamIndex'] = utils.window("%sAudioStreamIndex" % currentFile)
                    postdata['SubtitleStreamIndex'] = utils.window("%sSubtitleStreamIndex"
                                                                    % currentFile)
                else:
                    # Get the current kodi audio and subtitles and convert to Emby equivalent
                    tracks_query = {

                        "jsonrpc": "2.0",
                        "id": 1,
                        "method": "Player.GetProperties",
                        "params": {

                            "playerid": 1,
                            "properties": ["currentsubtitle","currentaudiostream","subtitleenabled"]
                        }
                    }
                    result = xbmc.executeJSONRPC(json.dumps(tracks_query))
                    result = json.loads(result)
                    result = result.get('result')

                    try: # Audio tracks
                        indexAudio = result['currentaudiostream']['index']
                    except (KeyError, TypeError):
                        indexAudio = 0
                    
                    try: # Subtitles tracks
                        indexSubs = result['currentsubtitle']['index']
                    except (KeyError, TypeError):
                        indexSubs = 0

                    try: # If subtitles are enabled
                        subsEnabled = result['subtitleenabled']
                    except (KeyError, TypeError):
                        subsEnabled = ""

                    # Postdata for the audio
                    postdata['AudioStreamIndex'] = indexAudio + 1
                    
                    # Postdata for the subtitles
                    if subsEnabled and len(xbmc.Player().getAvailableSubtitleStreams()) > 0:
                        
                        # Number of audiotracks to help get Emby Index
                        audioTracks = len(xbmc.Player().getAvailableAudioStreams())
                        mapping = utils.window("%s.indexMapping" % embyitem)

                        if mapping: # Set in playbackutils.py
                            
                            self.logMsg("Mapping for external subtitles index: %s" % mapping, 2)
                            externalIndex = json.loads(mapping)

                            if externalIndex.get(str(indexSubs)):
                                # If the current subtitle is in the mapping
                                postdata['SubtitleStreamIndex'] = externalIndex[str(indexSubs)]
                            else:
                                # Internal subtitle currently selected
                                subindex = indexSubs - len(externalIndex) + audioTracks + 1
                                postdata['SubtitleStreamIndex'] = subindex
                        
                        else: # Direct paths enabled scenario or no external subtitles set
                            postdata['SubtitleStreamIndex'] = indexSubs + audioTracks + 1
                    else:
                        postdata['SubtitleStreamIndex'] = ""
                

                # Post playback to server
                # self.logMsg("Sending POST play started: %s." % postdata, 2)
                # self.doUtils.downloadUrl(url, postBody=postdata, type="POST")
                
                # Ensure we do have a runtime
                try:
                    runtime = int(runtime)
                except ValueError:
                    runtime = xbmcplayer.getTotalTime()
                    self.logMsg("Runtime is missing, Kodi runtime: %s" % runtime, 1)

                playQueueVersion = utils.window(
                    'playQueueVersion')
                playQueueID = utils.window(
                    'playQueueID')
                playQueueItemID = utils.window(
                    'plex_%s.playQueueItemID' % currentFile)
                # Save data map for updates and position calls
                data = {
                    'playQueueVersion': playQueueVersion,
                    'playQueueID': playQueueID,
                    'playQueueItemID': playQueueItemID,
                    'runtime': runtime * 1000,
                    'item_id': itemId,
                    'refresh_id': refresh_id,
                    'currentfile': currentFile,
                    'AudioStreamIndex': postdata['AudioStreamIndex'],
                    'SubtitleStreamIndex': postdata['SubtitleStreamIndex'],
                    'playmethod': playMethod,
                    'Type': itemType,
                    'currentPosition': int(seekTime)
                }
                
                self.played_info[currentFile] = data
                self.logMsg("ADDING_FILE: %s" % self.played_info, 1)

                # log some playback stats
                '''if(itemType != None):
                    if(self.playStats.get(itemType) != None):
                        count = self.playStats.get(itemType) + 1
                        self.playStats[itemType] = count
                    else:
                        self.playStats[itemType] = 1
                        
                if(playMethod != None):
                    if(self.playStats.get(playMethod) != None):
                        count = self.playStats.get(playMethod) + 1
                        self.playStats[playMethod] = count
                    else:
                        self.playStats[playMethod] = 1'''

    def reportPlayback(self):
        # Don't use if Plex Companion is enabled
        if not self.doNotify:
            return

        self.logMsg("reportPlayback Called", 2)
        xbmcplayer = self.xbmcplayer

        # Get current file
        currentFile = self.currentFile
        data = self.played_info.get(currentFile)

        # only report playback if emby has initiated the playback (item_id has value)
        if data:
            # Get playback information
            itemId = data['item_id']
            audioindex = data['AudioStreamIndex']
            subtitleindex = data['SubtitleStreamIndex']
            playTime = data['currentPosition']
            playMethod = data['playmethod']
            paused = data.get('paused', False)
            duration = data.get('runtime', '')


            # Get playback volume
            volume_query = {

                    "jsonrpc": "2.0",
                    "id": 1,
                    "method": "Application.GetProperties",
                    "params": {

                        "properties": ["volume", "muted"] 
                    }
                }
            result = xbmc.executeJSONRPC(json.dumps(volume_query))
            result = json.loads(result)
            result = result.get('result')

            volume = result.get('volume')
            muted = result.get('muted')

            # Postdata for the websocketclient report
            # postdata = {

            #     'QueueableMediaTypes': "Video",
            #     'CanSeek': True,
            #     'ItemId': itemId,
            #     'MediaSourceId': itemId,
            #     'PlayMethod': playMethod,
            #     'PositionTicks': int(playTime * 10000000),
            #     'IsPaused': paused,
            #     'VolumeLevel': volume,
            #     'IsMuted': muted
            # }
            if paused == 'stopped':
                state = 'stopped'
            elif paused is True:
                state = 'paused'
            else:
                state = 'playing'
            postdata = {
                'ratingKey': itemId,
                'state': state,   # 'stopped', 'paused', 'buffering', 'playing'
                'time': int(playTime) * 1000,
                'duration': int(duration) * 1000
            }

            # For PMS playQueues/playlists only
            if data.get('playQueueID'):
                postdata['containerKey'] = '/playQueues/' + data.get('playQueueID')
                postdata['playQueueVersion'] = data.get('playQueueVersion')
                postdata['playQueueItemID'] = data.get('playQueueItemID')

            if playMethod == "Transcode":
                # Track can't be changed, keep reporting the same index
                postdata['AudioStreamIndex'] = audioindex
                postdata['AudioStreamIndex'] = subtitleindex

            else:
                # Get current audio and subtitles track
                tracks_query = {

                        "jsonrpc": "2.0",
                        "id": 1,
                        "method": "Player.GetProperties",
                        "params": {

                            "playerid": 1,
                            "properties": ["currentsubtitle","currentaudiostream","subtitleenabled"]
                        }
                    }
                result = xbmc.executeJSONRPC(json.dumps(tracks_query))
                result = json.loads(result)
                result = result.get('result')

                try: # Audio tracks
                    indexAudio = result['currentaudiostream']['index']
                except (KeyError, TypeError):
                    indexAudio = 0
                
                try: # Subtitles tracks
                    indexSubs = result['currentsubtitle']['index']
                except (KeyError, TypeError):
                    indexSubs = 0

                try: # If subtitles are enabled
                    subsEnabled = result['subtitleenabled']
                except (KeyError, TypeError):
                    subsEnabled = ""

                # Postdata for the audio
                data['AudioStreamIndex'], postdata['AudioStreamIndex'] = [indexAudio + 1] * 2
                
                # Postdata for the subtitles
                if subsEnabled and len(xbmc.Player().getAvailableSubtitleStreams()) > 0:
                    
                    # Number of audiotracks to help get Emby Index
                    audioTracks = len(xbmc.Player().getAvailableAudioStreams())
                    mapping = utils.window("emby_%s.indexMapping" % currentFile)

                    if mapping: # Set in PlaybackUtils.py
                        
                        self.logMsg("Mapping for external subtitles index: %s" % mapping, 2)
                        externalIndex = json.loads(mapping)

                        if externalIndex.get(str(indexSubs)):
                            # If the current subtitle is in the mapping
                            subindex = [externalIndex[str(indexSubs)]] * 2
                            data['SubtitleStreamIndex'], postdata['SubtitleStreamIndex'] = subindex
                        else:
                            # Internal subtitle currently selected
                            subindex = [indexSubs - len(externalIndex) + audioTracks + 1] * 2
                            data['SubtitleStreamIndex'], postdata['SubtitleStreamIndex'] = subindex
                    
                    else: # Direct paths enabled scenario or no external subtitles set
                        subindex = [indexSubs + audioTracks + 1] * 2
                        data['SubtitleStreamIndex'], postdata['SubtitleStreamIndex'] = subindex
                else:
                    data['SubtitleStreamIndex'], postdata['SubtitleStreamIndex'] = [""] * 2

            # Report progress via websocketclient
            # postdata = json.dumps(postdata)
            # self.ws.sendProgressUpdate(postdata)
            self.doUtils.downloadUrl(
                "{server}/:/timeline?" + urlencode(postdata), type="GET")

    def onPlayBackPaused( self ):

        currentFile = self.currentFile
        self.logMsg("PLAYBACK_PAUSED: %s" % currentFile, 2)

        if self.played_info.get(currentFile):
            self.played_info[currentFile]['paused'] = True
        
            self.reportPlayback()

    def onPlayBackResumed( self ):

        currentFile = self.currentFile
        self.logMsg("PLAYBACK_RESUMED: %s" % currentFile, 2)

        if self.played_info.get(currentFile):
            self.played_info[currentFile]['paused'] = False
        
            self.reportPlayback()

    def onPlayBackSeek( self, time, seekOffset ):
        # Make position when seeking a bit more accurate
        currentFile = self.currentFile
        self.logMsg("PLAYBACK_SEEK: %s" % currentFile, 2)

        if self.played_info.get(currentFile):
            position = self.xbmcplayer.getTime()
            self.played_info[currentFile]['currentPosition'] = position

            self.reportPlayback()
    
    def onPlayBackStopped( self ):
        # Will be called when user stops xbmc playing a file
        self.logMsg("ONPLAYBACK_STOPPED", 2)
        utils.window('emby_customPlaylist', clear=True)
        utils.window('emby_customPlaylist.seektime', clear=True)
        utils.window('emby_playbackProps', clear=True)
        self.logMsg("Clear playlist properties.", 1)
        utils.window('suspend_LibraryThread', clear=True)
        self.stopAll()

    def onPlayBackEnded( self ):
        # Will be called when xbmc stops playing a file
        self.logMsg("ONPLAYBACK_ENDED", 2)
        utils.window('emby_customPlaylist.seektime', clear=True)
        utils.window('suspend_LibraryThread', clear=True)
        self.stopAll()

    def stopAll(self):

        doUtils = self.doUtils

        if not self.played_info:
            return 
            
        self.logMsg("Played_information: %s" % self.played_info, 1)
        # Process each items
        for item in self.played_info:
            
            data = self.played_info.get(item)
            if data:
                
                self.logMsg("Item path: %s" % item, 2)
                self.logMsg("Item data: %s" % data, 2)

                runtime = data['runtime']
                currentPosition = data['currentPosition']
                itemid = data['item_id']
                refresh_id = data['refresh_id']
                currentFile = data['currentfile']
                type = data['Type']
                playMethod = data['playmethod']

                if currentPosition and runtime:
                    try:
                        percentComplete = currentPosition / int(runtime)
                    except ZeroDivisionError:
                        # Runtime is 0.
                        percentComplete = 0
                        
                    markPlayedAt = float(utils.settings('markPlayed')) / 100
                    self.logMsg(
                        "Percent complete: %s Mark played at: %s"
                        % (percentComplete, markPlayedAt), 1)

                    # Prevent manually mark as watched in Kodi monitor
                    utils.window('emby_skipWatched%s' % itemid, value="true")

                    self.stopPlayback(data)
                    # Stop transcoding
                    if playMethod == "Transcode":
                        self.logMsg("Transcoding for %s terminated." % itemid, 1)
                        url = "{server}/video/:/transcode/universal/stop?session=%s" % self.clientInfo.getDeviceId()
                        doUtils.downloadUrl(url, type="GET")

                    # Send the delete action to the server.
                    offerDelete = False

                    if type == "Episode" and utils.settings('deleteTV') == "true":
                        offerDelete = True
                    elif type == "Movie" and utils.settings('deleteMovies') == "true":
                        offerDelete = True

                    if utils.settings('offerDelete') != "true":
                        # Delete could be disabled, even if the subsetting is enabled.
                        offerDelete = False

                    # Plex: never delete
                    offerDelete = False
                    if percentComplete >= markPlayedAt and offerDelete:
                        if utils.settings('skipConfirmDelete') != "true":
                            resp = xbmcgui.Dialog().yesno(
                                                    heading="Confirm delete",
                                                    line1="Delete file on Emby Server?")
                            if not resp:
                                self.logMsg("User skipped deletion.", 1)
                                continue

                        url = "{server}/emby/Items/%s?format=json" % itemid
                        self.logMsg("Deleting request: %s" % itemid)
                        doUtils.downloadUrl(url, type="DELETE")

        # Clean the WINDOW properties
        for filename in self.played_info:
            cleanup = (
                'emby_%s.itemid' % filename,
                'emby_%s.runtime' % filename,
                'emby_%s.refreshid' % filename,
                'emby_%s.playmethod' % filename,
                'emby_%s.type' % filename,
                'plex_%s.playQueueItemID' % filename,
                'plex_%s.playlistPosition' % filename,
                'plex_%s.guid' % filename
            )
            for item in cleanup:
                utils.window(item, clear=True)

        self.played_info.clear()

    def stopPlayback(self, data):
        self.logMsg("stopPlayback called", 2)

        itemId = data['item_id']
        playTime = data['currentPosition']
        duration = data.get('runtime', '')

        url = "{server}/:/timeline?"
        args = {
            'ratingKey': itemId,
            'state': 'stopped',   # 'stopped', 'paused', 'buffering', 'playing'
            'time': int(playTime) * 1000,
            'duration': int(duration)
        }
        url = url + urlencode(args)
        self.doUtils.downloadUrl(url, type="GET")