Sonarr_Example_invoke_external_application.py

#!/usr/bin/env python
#

###################################################################################################
### SONARR POST-PROCESSING SCRIPT                                                               ###
#                                                                                               ###
# Script to rip srt subtitles out of .mkv files                                                 ###
#                                                                                               ###
# Used to extract subtitles from .mkv files.                                                    ###
# Example usecases are:                                                                         ###
#                                                                                               ###
# 1) Handling of embedded and external subtitles can differ in functionality                    ###
# 2) Prevent unneeded subtitle searches by 3rth party tools                                     ###
#                                                                                               ###
# To specify the languages extracted, you need to alter the values for                          ###
# Lang_X_StreamIds, Lang_X_Ext(.2chr_language_tag.srt), Lang_X_chr3Ext (.3chr_language_tag.srt) ###
#                                                                                               ###
# Processing files which contain multiple subtitle streams for the same language will only      ###
# result in the first and the last stream being extracted.                                      ###
# This is often the case with WEB-DL.                                                           ###
# ISO_639-1 codes are recommended, 2 character for the 1st language, 3 character for the 2nd.   ###
#                                                                                               ###
#                       !!! Make sure to alter your log file location !!!                       ###
#                           !!! Make sure to alter your ffmpeg path !!!                         ###
#                                                                                               ###
# Credits to BenV for the basecode                                                              ###
#                                                                                               ###
# Changed in v2:                                                                                ###
# - Decided not to make the overwrite a variable due to potential script stalls                 ###
# - Simplify troubleshooting so no script alterations are needed                                ###
# - Made script suitable for 2 subtitle streams of the same language                            ###
# - Make language tag / Ext input a variable .nl.srt                                            ###
#                                                                                               ###
###################################################################################################


from re import findall
from subprocess import Popen, PIPE
from datetime import datetime
from os import environ, path
from sys import argv

                        ### Variables ###

    # Get the video file name from the environment variables or argv
    # Manual troubleshoot mode example command: python scriptname.py /volume1/Sonarr/Series/SeriesE01.mkv
if len(argv) >= 2:
    filePath = argv[1]
else:
    filePath = environ.get('sonarr_episodefile_path')

    #Extracting the filename and extension for logfile usage
fileName = filePath.split('/')[-1]

    #Logfile location and open it unbuffered so you can read it during execution.
fp = open('/volume1/Sonarr/postprocess.log', 'a',0)

    # If the ffmpeg excutable is in the path use this
#ffmpeg = 'D:\\aaa\\ffmpeg.exe'
    # if you want to use an ffmpeg version from the SynoCommunity use this:
ffmpeg = '/volume1/@appstore/ffmpeg/bin/ffmpeg'

    # This list contains possible subtitle stream identifiers for the first preferred language
Lang1StreamIds = ['nl','nld','dut','dutch','qoq','qoq-team']

    # This will determine the 2 character language tag used for the first preffered language
Lang1Ext = '.nl.srt'

    # This will determine the 3 character language tag used for the first preffered language
Lang1chr3Ext = '.nld.srt'

    # This counter is used for counting the matches for the first preffered language
Lang1ExtCount = 0

    # This list contains possible subtitle stream identifiers for the second preferred language
Lang2StreamIds = ['en','eng','english']

    # This will determine the language tag used for the first preffered language
Lang2Ext = '.en.srt'

    # This will determine the 3 character language tag used for the first preffered language
Lang2chr3Ext = '.eng.srt'

    # This counter is used for counting the matches for the first preffered language
Lang2ExtCount = 0

                        ### Processing script ###

    #Timestamp variable for logfile
sttime = datetime.now().strftime('%Y%m%d %H:%M:%S - ')
if not filePath.lower().endswith('.mkv'):
    fp.write(sttime + fileName + ' is not an .mkv file, processing stopped.\n\n')
    fp.close()
    raise SystemExit
else:
    fp.write(sttime + fileName + ' is an .mkv file, processing started.\n')

    # First read the information from the video with ffmpeg.
    # ffmpeg writes this info to the stderr and not to stdout.
Cmd = [ffmpeg,'-i', filePath]
Merge = Popen(Cmd, stdout=PIPE, stderr=PIPE)
    # After the command is prepared we execute it and wait for it to finish with the communicate command
output,err = Merge.communicate()

    # ffmpeg writes to stderr
    # make lines insted of one large buffer
err= err.splitlines()

    # loop through the information lines, find the stream identifiers and count them
NonSubStreamCount = 0
for Line in err:
    if 'Stream #' in Line:
        NonSubStreamCount += 1
            # if it is a subtitle stream, get the stream info
        if 'Subtitle: subrip' in Line:
            NonSubStreamCount -= 1
                # use some regexes to find the stream info
            StreamNum = int(findall(r'\d+\.{0,1}\d*', Line)[1]) - NonSubStreamCount
            StreamLang = findall(r'\((.*?)\)', Line)[0]
                # compose the map identifiers for the ffmpeg command.
            Streamspec = '0:s:' + str(StreamNum)
                # try to identify the language and create the correct file extension belonging to that language.
            Ext = ''
                # First we look to see if it is a sub matching preferred language 1
            for Id in Lang1StreamIds:
                if Id == StreamLang.lower():
                    Ext = Lang1Ext
                    Lang1ExtCount += 1
                    break
                # If not, we look to see if it is a sub matching preferred language 2
            if not Ext:
                for Id in Lang2StreamIds:
                    if Id == StreamLang.lower():
                        Ext = Lang2Ext
                        Lang2ExtCount += 1
                        break
                # We only process the files is their is a preferred language match
            if Ext:
                OutputFile = filePath[:-4] + Ext
                if Ext == Lang1Ext:
                    if Lang1ExtCount >= 2:
                        OutputFile = filePath[:-4] + Lang1chr3Ext
                if Ext == Lang2Ext:
                    if Lang2ExtCount >= 2:
                        OutputFile = filePath[:-4] + Lang2chr3Ext
                Cmd =[ffmpeg, '-y', '-loglevel','-32','-i', filePath,'-map',Streamspec,OutputFile]
                Merge = Popen(Cmd, stdout=PIPE, stderr=PIPE)
                sttime = datetime.now().strftime('%Y%m%d_%H:%M:%S - ')
                fp.write(sttime + 'Extracting stream ' + Streamspec + ' language = ' + StreamLang + '\n')
                output,err = Merge.communicate()
                if err:
                    fp.write('Problem extracting subtitle.\n')
                    fp.write(err + '\n')

sttime = datetime.now().strftime('%Y%m%d_%H:%M:%S - ')
fp.write(sttime + 'Processing finished.\n\n')

    # close the logfile and exit back to Sonarr
fp.close()
raise SystemExit