-
-
Notifications
You must be signed in to change notification settings - Fork 65
/
OpenSubtitlesDownload.py
executable file
·1086 lines (890 loc) · 46.4 KB
/
OpenSubtitlesDownload.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# OpenSubtitlesDownload.py / Version 6.4
# This software is designed to help you find and download subtitles for your favorite videos!
# You can browse the project's GitHub page:
# - https://github.com/emericg/OpenSubtitlesDownload
# Learn much more about it on the wiki:
# - https://github.com/emericg/OpenSubtitlesDownload/wiki
# Copyright (c) 2024 by Emeric GRANGE <[email protected]>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import os
import sys
import time
import shutil
import struct
import argparse
import mimetypes
import subprocess
import json
import urllib
import urllib.request
import urllib.error
# ==== OpenSubtitles.com server settings =======================================
# Track API availability:
# > https://92500a62-df9e-42ed-82a4-e6b3eeb89365.site.hbuptime.com/
# API endpoints
API_URL = 'https://api.opensubtitles.com/api/v1/'
API_URL_LOGIN = API_URL + 'login'
API_URL_LOGOUT = API_URL + 'logout'
API_URL_SEARCH = API_URL + 'subtitles'
API_URL_DOWNLOAD = API_URL + 'download'
# This application is registered:
APP_NAME = 'OpenSubtitlesDownload'
APP_VERSION = '6.4'
APP_API_KEY = 'FNyoC96mlztsk3ALgNdhfSNapfFY9lOi'
# ==== OpenSubtitles.com account (required) ====================================
# A valid account from opensubtitles.com is REQUIRED.
# You can use a VIP account to avoid "in-subtitles" advertisement and bypass download limits.
# The username is NOT your account email address, but in fact, your username...
# Be careful about your password security, it will be stored right here in plain text...
# Can be overridden at run time with '-u' and '-p' arguments.
osd_username = ''
osd_password = ''
# ==== Language settings =======================================================
# Full guide: https://github.com/emericg/OpenSubtitlesDownload/wiki/Adjust-settings
# 1/ Change the search language by using any supported 2-letter (ISO 639-1) language code:
# > https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
# > Supported language codes: https://opensubtitles.stoplight.io/docs/opensubtitles-api/1de776d20e873-languages
# > Ex: opt_languages = 'en'
# 2/ Search for subtitles in several languages by using multiple codes separated by a comma:
# > Ex: opt_languages = 'en,fr'
opt_languages = 'en'
# Write language code (ex: _en) at the end of the subtitles file. 'on', 'off' or 'auto'.
# If you are regularly searching for several language at once, you sould use 'on'.
opt_language_suffix = 'auto'
# Character used to separate file path from the language code (ex: file_en.srt).
opt_language_suffix_separator = '_'
# ==== Search settings =========================================================
# Subtitles search mode. Can be overridden at run time with '-s' argument.
# - hash (search using file hash only)
# - filename (search using filename only)
# - hash_then_filename (search using file hash, then if no results, by filename) (default)
# - hash_and_filename (search using both methods)
opt_search_mode = 'hash_then_filename'
# Search and download a subtitles even if one already exists.
opt_search_overwrite = True
# Subtitles selection mode. Can be overridden at run time with '-t' argument.
# - default (in case of multiple results, lets you choose the subtitles you want)
# - manual (always let you choose the subtitles you want)
# - auto (automatically select the best subtitles found)
opt_selection_mode = 'default'
# Customize subtitles download path. Can be overridden at run time with '-o' argument.
# By default, subtitles are downloaded next to their video file.
opt_output_path = ''
# Ignore Hearing Impaired (HI) subtitles?
opt_ignore_hi = False
# Ignore machine translated subtitles?
opt_ignore_machine_translated = True
# Ignore AI translated subtitles?
opt_ignore_ai_translated = False
# Ignore "foreign parts only" subtitles?
opt_ignore_foreign_parts_only = False
# ==== GUI settings ============================================================
# Select your GUI. Can be overridden at run time with '--gui=xxx' argument.
# - auto (autodetection, fallback on CLI)
# - gnome (GNOME/GTK based environments, using 'zenity' backend)
# - kde (KDE/Qt based environments, using 'kdialog' backend)
# - cli (Command Line Interface)
opt_gui = 'auto'
# Change the subtitles selection GUI size:
opt_gui_width = 940
opt_gui_height = 480
# Various GUI columns to show/hide during subtitles selection. You can set them to 'on', 'off' or 'auto'.
opt_selection_language = 'auto'
opt_selection_match = 'auto'
opt_selection_hi = 'auto'
opt_selection_fps = 'off'
opt_selection_rating = 'off'
opt_selection_count = 'off'
# ==== HOOK ====================================================================
# Use a secondary tool on the subtitles file after a successful download?
custom_command = ""
# ==== Check file path & type ==================================================
def checkFileValidity(path):
"""Check mimetype and/or file extension to detect valid video file"""
if os.path.isfile(path) is False:
superPrint("info", "File not found", f"The file provided was not found:<br><i>{path}</i>")
return False
fileMimeType, encoding = mimetypes.guess_type(path)
if fileMimeType is None:
fileExtension = path.rsplit('.', 1)
if fileExtension[1] not in ['avi', 'mov', 'mp4', 'mp4v', 'm4v', 'mkv', 'mk3d', 'webm', \
'ts', 'mts', 'm2ts', 'ps', 'vob', 'evo', 'mpeg', 'mpg', \
'asf', 'wm', 'wmv', 'rm', 'rmvb', 'divx', 'xvid']:
#superPrint("error", "File type error!", f"This file is not a video (unknown mimetype AND invalid file extension):<br><i>{path}</i>")
return False
else:
fileMimeType = fileMimeType.split('/', 1)
if fileMimeType[0] != 'video':
#superPrint("error", "File type error!", f"This file is not a video (unknown mimetype):<br><i>{path}</i>")
return False
return True
# ==== Check for existing subtitles file =======================================
def checkSubtitlesExists(path):
"""Check if a subtitles already exists for the current file"""
extList = ['srt', 'sub', 'mpl', 'webvtt', 'dfxp', 'txt', 'sbv', 'smi', 'ssa', 'ass', 'usf']
sepList = ['_', '-', '.']
tryList = ['']
if opt_language_suffix_separator not in sepList:
sepList.append(opt_language_suffix_separator)
if opt_language_suffix in ('on', 'auto'):
for language in languageList:
for sep in sepList:
tryList.append(sep + language)
for ext in extList:
for teststring in tryList:
subPath = path.rsplit('.', 1)[0] + teststring + '.' + ext
if os.path.isfile(subPath) is True:
superPrint("info", "Subtitles already downloaded!", f"A subtitles file already exists for this file:<br><i>{subPath}</i>")
return True
return False
# ==== Hashing algorithm =======================================================
# Info: https://trac.opensubtitles.org/projects/opensubtitles/wiki/HashSourceCodes
# This particular implementation is coming from SubDownloader: https://subdownloader.net
def hashFile(path):
"""Produce a hash for a video file: size + 64bit chksum of the first and
last 64k (even if they overlap because the file is smaller than 128k)"""
try:
longlongformat = 'Q' # unsigned long long little endian
bytesize = struct.calcsize(longlongformat)
fmt = "<%d%s" % (65536//bytesize, longlongformat)
f = open(path, "rb")
filesize = os.fstat(f.fileno()).st_size
filehash = filesize
if filesize < 65536 * 2:
superPrint("error", "File size error!", f"File size error while generating hash for this file:<br><i>{path}</i>")
return "SizeError"
buf = f.read(65536)
longlongs = struct.unpack(fmt, buf)
filehash += sum(longlongs)
f.seek(-65536, os.SEEK_END) # size is always > 131072
buf = f.read(65536)
longlongs = struct.unpack(fmt, buf)
filehash += sum(longlongs)
filehash &= 0xFFFFFFFFFFFFFFFF
f.close()
returnedhash = "%016x" % filehash
return returnedhash
except IOError:
superPrint("error", "I/O error!", f"Input/Output error while generating hash for this file:<br><i>{path}</i>")
return "IOError"
except Exception:
print("Unexpected error (line " + str(sys.exc_info()[-1].tb_lineno) + "): " + str(sys.exc_info()[0]))
# ==== String escaping =========================================================
# Title and filename may need string sanitizing to avoid zenity/kdialog handling errors
def escapeGUI_title(string):
if opt_gui != 'cli':
string = string.replace('"', '\\"')
return string
def escapeGUI_zenity(string):
if opt_gui == 'gnome':
string = string.replace('"', '\\"')
string = string.replace("'", "\\'")
string = string.replace('`', '\\`')
string = string.replace("&", "&")
return string
def escapeGUI_kdialog(string):
if opt_gui == 'kde':
string = string.replace('"', '\\"')
string = string.replace('`', '\\`')
return string
def escapePath_wget(string):
string = string.replace('"', '\\"')
string = string.replace('`', '\\`')
return string
# ==== Super Print =============================================================
# priority: info, warning, error
# title: only for zenity and kdialog messages
# message: full text, with tags and breaks (tags will be cleaned up for CLI)
def superPrint(priority, title, message):
"""Print messages through terminal, zenity or kdialog"""
if opt_gui == 'gnome':
# Adapt to zenity
message = message.replace("<br>", "\n")
# Escape
message = escapeGUI_zenity(message)
# Print message
subprocess.call(['zenity', '--width=' + str(opt_gui_width), f'--{priority}', f'--title={title}', f'--text={message}'])
elif opt_gui == 'kde':
# Adapt to kdialog
message = message.replace("\n", "<br>")
if priority == 'warning':
priority = 'sorry'
elif priority == 'info':
priority = 'msgbox'
# Print message
subprocess.call(['kdialog', '--geometry=' + str(opt_gui_width-220) + 'x' + str(opt_gui_height-128) + '+128+128', f'--title={title}', f'--{priority}={message}'])
else:
# Clean up format tags and line breaks
message = message.replace("\n\n", "\n")
message = message.replace("<br><br>", "\n")
message = message.replace("<br>", "\n")
message = message.replace("<i>", "")
message = message.replace("</i>", "")
message = message.replace("<b>", "")
message = message.replace("</b>", "")
# Print message
print(">> " + message)
# ==== GNOME selection window ==================================================
def selectionGnome(subtitlesResultList):
"""GNOME subtitles selection window using zenity"""
subtitlesSelectedName = u''
subtitlesSelectedIndex = -1
subtitlesItems = u''
subtitlesMatchedByHash = 0
subtitlesMatchedByName = 0
columnHi = ''
columnLn = ''
columnMatch = ''
columnRate = ''
columnCount = ''
columnFPS = ''
videoTitle_window = escapeGUI_title(videoTitle)
videoTitle_escaped = escapeGUI_zenity(videoTitle)
videoFileName_escaped = escapeGUI_zenity(videoFileName)
# Generate selection window content
for idx, item in enumerate(subtitlesResultList['data']):
if opt_ignore_hi and item['attributes'].get('hearing_impaired', False) == True:
continue
if opt_ignore_foreign_parts_only and item['attributes'].get('foreign_parts_only', False) == True:
continue
if opt_ignore_ai_translated and item['attributes'].get('ai_translated', False) == True:
continue
if opt_ignore_machine_translated and item['attributes'].get('machine_translated', False) == True:
continue
if item['attributes'].get('moviehash_match', False) == True:
subtitlesMatchedByHash += 1
else:
subtitlesMatchedByName += 1
subtitlesItems += f'{idx} "' + escapeGUI_zenity(item['attributes']['files'][0]['file_name']) + '" '
if opt_selection_hi == 'on':
columnHi = '--column="HI" '
if item['attributes'].get('hearing_impaired', False) == True:
subtitlesItems += u'"✔" '
else:
subtitlesItems += '"" '
if opt_selection_language == 'on':
columnLn = '--column="Language" '
subtitlesItems += '"' + item['attributes']['language'] + '" '
if opt_selection_match == 'on':
columnMatch = '--column="MatchedBy" '
if item['attributes'].get('moviehash_match', False) == True:
subtitlesItems += '"HASH" '
else:
subtitlesItems += '"name" '
if opt_selection_rating == 'on':
columnRate = '--column="Rating" '
subtitlesItems += '"' + str(item['attributes']['ratings']) + '" '
if opt_selection_count == 'on':
columnCount = '--column="Downloads" '
subtitlesItems += '"' + str(item['attributes']['download_count']).zfill(5) + '" '
if opt_selection_fps == 'on':
columnFPS = '--column="FPS" '
subtitlesItems += '"' + str(item['attributes']['fps']) + '" '
if subtitlesMatchedByName == 0:
tilestr = f' --title="Subtitles for: {videoTitle_window}" '
textstr = f' --text="<b>Video title:</b> {videoTitle_escaped}\n<b>File name:</b> {videoFileName_escaped}" '
elif subtitlesMatchedByHash == 0:
tilestr = ' --title="Subtitles Search" '
textstr = f' --text="Search results using file name, NOT video detection. <b>May be unreliable...</b>\n<b>File name:</b> {videoFileName_escaped}" '
else: # a mix of the two
tilestr = f' --title="Subtitles for: {videoTitle_window}" '
textstr = f' --text="Search results using file name AND video detection.\n<b>Video title:</b> {videoTitle_escaped}\n<b>File name:</b> {videoFileName_escaped}" '
# Spawn zenity "list" dialog
process_subtitlesSelection = subprocess.Popen('zenity --width=' + str(opt_gui_width) + ' --height=' + str(opt_gui_height) + ' --list' + tilestr + textstr + ' --column "id" --hide-column=1 ' +
'--column="Available subtitles" ' + columnHi + columnLn + columnMatch + columnRate + columnCount + columnFPS + subtitlesItems + ' --print-column=ALL',
shell=True, stdout=subprocess.PIPE)
# Get back the user's choice
result_subtitlesSelection = process_subtitlesSelection.communicate()
# The results contain a subtitles?
if result_subtitlesSelection[0]:
result = str(result_subtitlesSelection[0], 'utf-8', 'replace').strip("\n")
# Get index and result
[subtitlesSelectedIndex, subtitlesSelectedName] = result.split('|')[0:2]
else:
if process_subtitlesSelection.returncode == 0:
subtitlesSelectedName = subtitlesResultList['data'][0]['attributes']['files'][0]['file_name']
subtitlesSelectedIndex = 0
# Return the result (selected subtitles name and index)
return (subtitlesSelectedName, subtitlesSelectedIndex)
# ==== KDE selection window ====================================================
def selectionKDE(subtitlesResultList):
"""KDE subtitles selection window using kdialog"""
subtitlesSelectedName = u''
subtitlesSelectedIndex = -1
subtitlesItems = u''
subtitlesMatchedByHash = 0
subtitlesMatchedByName = 0
videoTitle_window = videoTitle
videoTitle_escaped = videoTitle
videoFileName_escaped = escapeGUI_kdialog(videoFileName)
# Generate selection window content
# TODO doesn't support additional columns
index = 0
for idx, item in enumerate(subtitlesResultList['data']):
if opt_ignore_hi and item['attributes'].get('hearing_impaired', False) == True:
continue
if opt_ignore_foreign_parts_only and item['attributes'].get('foreign_parts_only', False) == True:
continue
if opt_ignore_ai_translated and item['attributes'].get('ai_translated', False) == True:
continue
if opt_ignore_machine_translated and item['attributes'].get('machine_translated', False) == True:
continue
if item['attributes'].get('moviehash_match', False) == True:
subtitlesMatchedByHash += 1
else:
subtitlesMatchedByName += 1
# key + subtitles name
subtitlesItems += str(index) + ' "' + item['attributes']['files'][0]['file_name'] + '" '
index += 1
if subtitlesMatchedByName == 0:
tilestr = f' --title="Subtitles for {videoTitle_window}" '
menustr = f' --menu="<b>Video title:</b> {videoTitle_escaped}<br><b>File name:</b> {videoFileName_escaped}" '
elif subtitlesMatchedByHash == 0:
tilestr = ' --title="Subtitles Search" '
menustr = f' --menu="Search results using file name, NOT video detection. <b>May be unreliable...</b><br><b>File name:</b> {videoFileName_escaped}" '
else: # a mix of the two
tilestr = f' --title="Subtitles for {videoTitle_window}" '
menustr = f' --menu="Search results using file name AND video detection.<br><b>Video title:</b> {videoTitle_escaped}<br><b>File name:</b> {videoFileName_escaped}" '
# Spawn kdialog "radiolist"
process_subtitlesSelection = subprocess.Popen('kdialog --geometry=' + str(opt_gui_width-220) + 'x' + str(opt_gui_height-128) + f'+128+128 {tilestr} {menustr} {subtitlesItems}',
shell=True, stdout=subprocess.PIPE)
# Get back the user's choice
result_subtitlesSelection = process_subtitlesSelection.communicate()
# The results contain the key matching a subtitles?
if result_subtitlesSelection[0]:
subtitlesSelectedIndex = int(str(result_subtitlesSelection[0], 'utf-8', 'replace').strip("\n"))
subtitlesSelectedName = subtitlesResultList['data'][subtitlesSelectedIndex]['attributes']['files'][0]['file_name']
# Return the result (selected subtitles name and index)
return (subtitlesSelectedName, subtitlesSelectedIndex)
# ==== CLI selection mode ======================================================
def selectionCLI(subtitlesResultList):
"""Command Line Interface, subtitles selection inside your current terminal"""
subtitlesSelectedName = u''
subtitlesSelectedIndex = -1
subtitlesMatchedByHash = 0
subtitlesMatchedByName = 0
# Check if search has results by hash or name
for item in subtitlesResultList['data']:
if item['attributes'].get('moviehash_match', False) == True:
subtitlesMatchedByHash += 1
else:
subtitlesMatchedByName += 1
# Print video infos
if subtitlesMatchedByName == 0:
print("\n>> Subtitles for: " + videoTitle)
elif subtitlesMatchedByHash == 0:
print("\n>> Subtitles for file: " + videoFileName)
print(">> Search results using file name, NOT video detection. May be unreliable...")
else: # a mix of the two
print("\n>> Subtitles for: " + videoTitle)
print(">> Search results using using file name AND video detection.")
print("\n>> Available subtitles:")
# Print subtitles list on the terminal
for idx, item in enumerate(subtitlesResultList['data']):
if opt_ignore_hi and item['attributes'].get('hearing_impaired', False) == True:
continue
if opt_ignore_foreign_parts_only and item['attributes'].get('foreign_parts_only', False) == True:
continue
if opt_ignore_ai_translated and item['attributes'].get('ai_translated', False) == True:
continue
if opt_ignore_machine_translated and item['attributes'].get('machine_translated', False) == True:
continue
subtitlesItemPre = u'> '
subtitlesItem = u'"' + item['attributes']['files'][0]['file_name'] + u'"'
subtitlesItemPost = u''
if opt_selection_match == 'on':
if item['attributes'].get('moviehash_match', False) == True:
subtitlesItemPre += '(hash) > '
else:
subtitlesItemPre += '(name) > '
if opt_selection_language == 'on':
subtitlesItemPre += item['attributes']['language'].upper() + ' > '
if opt_selection_hi == 'on' and item['attributes'].get('hearing_impaired', False) == True:
subtitlesItemPost += ' > ' + '\033[44m' + ' HI ' + '\033[0m'
if opt_selection_fps == 'on':
subtitlesItemPost += ' > ' + '\033[100m' + str(item['attributes']['fps']) + ' FPS' + '\033[0m'
if opt_selection_rating == 'on':
subtitlesItemPost += ' > ' + '\033[100m' + 'Rating: ' + str(item['attributes']['ratings']) + '\033[0m'
if opt_selection_count == 'on':
subtitlesItemPost += ' > ' + '\033[100m' + 'Downloads: ' + str(item['attributes']['download_count']) + '\033[0m'
# type # season_number # episode_number
if (item['attributes']['feature_details'].get('season_number', 0) != 0 and item['attributes']['feature_details'].get('episode_number', 0) != 0):
subtitlesItemPost += ' > ' + '\033[100m' + 'S' + str(item['attributes']['feature_details']['season_number']).zfill(2) + 'E' + str(item['attributes']['feature_details']['episode_number']).zfill(2) + '\033[0m'
idx += 1 # We display subtitles indexes starting from 1, 0 is reserved for cancel
if item['attributes'].get('moviehash_match', False) == True:
print("\033[92m[" + str(idx).rjust(2, ' ') + "]\033[0m " + subtitlesItemPre + subtitlesItem + subtitlesItemPost)
else:
print("\033[93m[" + str(idx).rjust(2, ' ') + "]\033[0m " + subtitlesItemPre + subtitlesItem + subtitlesItemPost)
# Ask user to selected a subtitles
print("\033[91m[ 0]\033[0m Cancel search")
while (subtitlesSelectedIndex < 0 or subtitlesSelectedIndex > idx):
try:
subtitlesSelectedIndex = int(input("\n>> Enter your choice [0-" + str(idx) + "]: "))
except KeyboardInterrupt:
sys.exit(1)
except:
subtitlesSelectedIndex = -1
if subtitlesSelectedIndex <= 0:
print("Cancelling search...")
return ("", -1)
subtitlesSelectedIndex -= 1
subtitlesSelectedName = subtitlesResultList['data'][subtitlesSelectedIndex]['attributes']['files'][0]['file_name']
# Return the result (selected subtitles name and index)
return (subtitlesSelectedName, subtitlesSelectedIndex)
# ==== Automatic selection mode ================================================
def selectionAuto(subtitlesResultList, languageList):
"""Automatic subtitles selection using filename match"""
subtitlesSelectedName = u''
subtitlesSelectedIndex = -1
videoFileParts = videoFileName.replace('-', '.').replace(' ', '.').replace('_', '.').lower().split('.')
languageListReversed = list(reversed(languageList))
maxScore = -1
for idx, item in enumerate(subtitlesResultList['data']):
score = 0
# points to respect languages priority
score += languageListReversed.index(item['attributes']['language']) * 100
# extra point if the sub is found by hash
if item['attributes'].get('moviehash_match', False) == True:
score += 1
# points for filename mach
subFileParts = item['attributes']['files'][0]['file_name'].replace('-', '.').replace(' ', '.').replace('_', '.').lower().split('.')
for subPart in subFileParts:
for filePart in videoFileParts:
if subPart == filePart:
score += 1
if score > maxScore:
maxScore = score
subtitlesSelectedIndex = idx
subtitlesSelectedName = subtitlesResultList['data'][subtitlesSelectedIndex]['attributes']['files'][0]['file_name']
# Return the result (selected subtitles name and index)
return (subtitlesSelectedName, subtitlesSelectedIndex)
# ==== Check dependencies ======================================================
def pythonChecker():
"""Check the availability of Python 3 interpreter"""
if sys.version_info < (3, 0):
superPrint("error", "Wrong Python version", "You need <b>Python 3</b> to use OpenSubtitlesDownload.")
return False
return True
def dependencyChecker():
"""Check the availability of tools used as dependencies"""
if opt_gui == 'gnome':
for tool in ['wget']:
path = shutil.which(tool)
if path is None:
superPrint("error", "Missing dependency!", f"<b>{tool}</b> is not available, please install it!")
return False
return True
# ==== REST API helpers ========================================================
def getUserToken(username, password):
try:
headers = {
"User-Agent": f"{APP_NAME} v{APP_VERSION}",
"Api-key": f"{APP_API_KEY}",
"Accept": "application/json",
"Content-Type": "application/json"
}
payload = {
"username": username,
"password": password
}
data = json.dumps(payload).encode('utf-8')
req = urllib.request.Request(API_URL_LOGIN, data=data, headers=headers)
with urllib.request.urlopen(req) as response:
response_data = json.loads(response.read().decode('utf-8'))
#print("getUserToken() response data: " + str(response_data))
return response_data['token']
except (urllib.error.HTTPError, urllib.error.URLError) as err:
print("Urllib error (", err.code, ") ", err.reason)
superPrint("error", "OpenSubtitles.com login error!", "An error occurred while connecting to the OpenSubtitles.com server")
sys.exit(2)
except Exception:
print("Unexpected error (line " + str(sys.exc_info()[-1].tb_lineno) + "): " + str(sys.exc_info()[0]))
superPrint("error", "OpenSubtitles.com login error!", "An error occurred while connecting to the OpenSubtitles.com server")
sys.exit(2)
def destroyUserToken(USER_TOKEN):
try:
headers = {
"User-Agent": f"{APP_NAME} v{APP_VERSION}",
"Api-key": f"{APP_API_KEY}",
"Authorization": f"Bearer {USER_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json"
}
req = urllib.request.Request(API_URL_LOGOUT, headers=headers)
with urllib.request.urlopen(req) as response:
response_data = json.loads(response.read().decode('utf-8'))
#print("destroyUserToken() response data: " + str(response_data))
return response_data
except (urllib.error.HTTPError, urllib.error.URLError) as err:
print("Urllib error (", err.code, ") ", err.reason)
except Exception:
print("Unexpected error (line " + str(sys.exc_info()[-1].tb_lineno) + "): " + str(sys.exc_info()[0]))
def searchSubtitles(**kwargs):
try:
headers = {
"User-Agent": f"{APP_NAME} v{APP_VERSION}",
"Api-key": f"{APP_API_KEY}"
}
query_params = urllib.parse.urlencode(kwargs)
url = f"{API_URL_SEARCH}?{query_params}"
req = urllib.request.Request(url, headers=headers)
with urllib.request.urlopen(req) as response:
response_data = json.loads(response.read().decode('utf-8'))
#print("searchSubtitles() response data: " + str(response_data))
return response_data
except (urllib.error.HTTPError, urllib.error.URLError) as err:
print("Urllib error (", err.code, ") ", err.reason)
except Exception:
print("Unexpected error (line " + str(sys.exc_info()[-1].tb_lineno) + "): " + str(sys.exc_info()[0]))
def getSubtitlesInfo(USER_TOKEN, file_id):
try:
headers = {
"User-Agent": f"{APP_NAME} v{APP_VERSION}",
"Api-key": f"{APP_API_KEY}",
"Authorization": f"Bearer {USER_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json"
}
payload = {
"file_id": file_id
}
data = json.dumps(payload).encode('utf-8')
req = urllib.request.Request(API_URL_DOWNLOAD, data=data, headers=headers)
with urllib.request.urlopen(req) as response:
response_data = json.loads(response.read().decode('utf-8'))
#print("getSubtitlesInfo() response data:" + response_data)
return response_data
except (urllib.error.HTTPError, urllib.error.URLError) as err:
print("Urllib error (", err.code, ") ", err.reason)
except Exception:
print("Unexpected error (line " + str(sys.exc_info()[-1].tb_lineno) + "): " + str(sys.exc_info()[0]))
def downloadSubtitles(USER_TOKEN, subURL, subPath):
try:
headers = {
"User-Agent": f"{APP_NAME} v{APP_VERSION}",
"Api-key": f"{APP_API_KEY}",
"Authorization": f"Bearer {USER_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json"
}
req = urllib.request.Request(subURL, headers=headers)
with urllib.request.urlopen(req) as response:
decodedStr = response.read().decode('utf-8')
byteswritten = open(subPath, 'w', encoding='utf-8', errors='replace').write(decodedStr)
if byteswritten > 0:
return 0
return 1
except (urllib.error.HTTPError, urllib.error.URLError) as err:
print("Urllib error (", err.code, ") ", err.reason)
except Exception:
print("Unexpected error (line " + str(sys.exc_info()[-1].tb_lineno) + "): " + str(sys.exc_info()[0]))
# ==============================================================================
# ==== Main program (execution starts here) ====================================
# ==============================================================================
# ==== Exit code returned by the software. You can use them to improve scripting behaviours.
# 0: Success, and subtitles downloaded
# 1: Success, but no subtitles found or downloaded
# 2: Failure
ExitCode = 2
# ==== File and language lists
videoPathList = []
languageList = []
currentVideoPath = u""
currentLanguage = u""
# ==== Argument parsing
# Get OpenSubtitlesDownload.py script absolute path
if os.path.isabs(sys.argv[0]):
scriptPath = sys.argv[0]
else:
scriptPath = os.getcwd() + "/" + str(sys.argv[0])
# Setup ArgumentParser
parser = argparse.ArgumentParser(prog='OpenSubtitlesDownload.py',
description='Automatically find and download the right subtitles for your favorite videos!',
formatter_class=argparse.RawTextHelpFormatter)
parser.add_argument('--cli', help="Force CLI mode", action='store_true')
parser.add_argument('-g', '--gui', help="Select the GUI you want from: auto, kde, gnome, cli (default: auto)")
parser.add_argument('-u', '--username', help="Set opensubtitles.com account username")
parser.add_argument('-p', '--password', help="Set opensubtitles.com account password")
parser.add_argument('-l', '--lang', help="Specify the language in which the subtitles should be downloaded (default: en).\nSyntax:\n-l en,fr: search in both language")
parser.add_argument('-s', '--search', help="Search mode: hash, filename, hash_then_filename, hash_and_filename (default: hash_then_filename)")
parser.add_argument('-t', '--select', help="Selection mode: manual, default, auto")
parser.add_argument('-a', '--auto', help="Force automatic selection and download of the best subtitles found", action='store_true')
parser.add_argument('-i', '--skip', help="Skip search if an existing subtitles file is detected", action='store_true')
parser.add_argument('-o', '--output', help="Override subtitles download path, instead of next to their video file")
parser.add_argument('-x', '--suffix', help="Force language code file suffix", action='store_true')
parser.add_argument('--noai', help="Ignore AI or machine translated subtitles", action='store_true')
parser.add_argument('--nohi', help="Ignore HI (hearing impaired) subtitles", action='store_true')
parser.add_argument('searchPathList', help="The video file(s) or folder(s) for which subtitles should be searched and downloaded", nargs='+')
arguments = parser.parse_args()
# Handle arguments
if arguments.cli:
opt_gui = 'cli'
if arguments.gui:
opt_gui = arguments.gui
if arguments.username and arguments.password:
osd_username = arguments.username
osd_password = arguments.password
if arguments.lang:
opt_languages = arguments.lang
if arguments.search:
opt_search_mode = arguments.search
if arguments.skip:
opt_search_overwrite = False
if arguments.select:
opt_selection_mode = arguments.select
if arguments.auto:
opt_selection_mode = 'auto'
if arguments.output:
opt_output_path = arguments.output
if arguments.suffix:
opt_language_suffix = 'on'
if arguments.noai:
opt_ignore_ai_translated = True
if arguments.nohi:
opt_ignore_hi = True
# GUI auto detection
if opt_gui == 'auto':
# Note: "ps cax" only output the first 15 characters of the executable's names
ps = str(subprocess.Popen(['ps', 'cax'], stdout=subprocess.PIPE).communicate()[0]).split('\n')
for line in ps:
if ('gnome-session' in line) or ('cinnamon-sessio' in line) or ('mate-session' in line) or ('xfce4-session' in line):
opt_gui = 'gnome'
break
elif 'ksmserver' in line:
opt_gui = 'kde'
break
# Sanitize some settings
if opt_gui not in ['gnome', 'kde', 'cli']:
opt_gui = 'cli'
opt_search_mode = 'hash_then_filename'
opt_selection_mode = 'auto'
print("Unknown GUI, falling back to an automatic CLI mode")
if opt_search_mode not in ['hash', 'filename', 'hash_then_filename', 'hash_and_filename']:
opt_search_mode = 'hash_then_filename'
if opt_selection_mode not in ['manual', 'default', 'auto']:
opt_selection_mode = 'default'
# ==== Various checks
# Check for Python 3
if pythonChecker() is False:
sys.exit(2)
# Check for the necessary tools (must be done after GUI auto detection)
if dependencyChecker() is False:
sys.exit(2)
# Check for OSD credentials
if not osd_username or not osd_password:
superPrint("warning", "OpenSubtitles.com account required!", "A valid account from OpenSubtitles.com is <b>REQUIRED</b>, please register on the website!")
sys.exit(2)
# ==== Count languages selected for this search
if isinstance(opt_languages, list):
languageList = opt_languages
else:
languageList = opt_languages.split(',')
languageCount_search = len(languageList)
# ==== Get video paths, validate them, and if needed check if subtitles already exists
for i in arguments.searchPathList:
path = os.path.abspath(i)
if os.path.isdir(path): # if it's a folder
if opt_gui == 'cli': # check all of the folder's (recursively)
for root, _, items in os.walk(path):
for item in items:
localPath = os.path.join(root, item)
if checkFileValidity(localPath):
if opt_search_overwrite or (not opt_search_overwrite and not checkSubtitlesExists(localPath)):
videoPathList.append(localPath)
else: # check all of the folder's files
for item in os.listdir(path):
localPath = os.path.join(path, item)
if checkFileValidity(localPath):
if opt_search_overwrite or (not opt_search_overwrite and not checkSubtitlesExists(localPath)):
videoPathList.append(localPath)
elif checkFileValidity(path): # if it is a file
if opt_search_overwrite or (not opt_search_overwrite and not checkSubtitlesExists(path)):
videoPathList.append(path)
# If videoPathList is empty, abort!
if not videoPathList:
sys.exit(1)
# ==== Instances dispatcher ====================================================
# The first video file will be processed by this instance
currentVideoPath = videoPathList[0]
videoPathList.pop(0)
# The remaining file(s) are dispatched to new instance(s) of this script
for videoPathDispatch in videoPathList:
# Pass settings
command = [ sys.executable, scriptPath,
"-g", opt_gui, "-s", opt_search_mode, "-t", opt_selection_mode, "-l", opt_languages ]
if not opt_search_overwrite:
command.append("-i")
if opt_language_suffix == 'on':
command.append("-x")
if opt_output_path:
command.append("-o")
command.append(opt_output_path)
if arguments.username and arguments.password:
command.append("-u")
command.append(arguments.username)
command.append("-p")
command.append(arguments.password)
# Pass video file
command.append(videoPathDispatch)
# Do not spawn too many instances at once, avoid error '429 Too Many Requests'
time.sleep(2)
if opt_gui == 'cli' and opt_selection_mode != 'auto':
# Synchronous call
process_videoDispatched = subprocess.call(command)
else:
# Asynchronous call
process_videoDispatched = subprocess.Popen(command)
# ==== Search and download subtitles ===========================================
try:
USER_TOKEN = []
subtitlesResultList = []
languageCount_results = 0
## Get file hash, size and name
videoTitle = u''
videoHash = hashFile(currentVideoPath)
videoSize = os.path.getsize(currentVideoPath)
videoFileName = os.path.basename(currentVideoPath)
## Search for subtitles
try:
if (opt_search_mode == 'hash_and_filename'):
subtitlesResultList = searchSubtitles(moviehash=videoHash, query=videoFileName, languages=opt_languages)
#print(f"SEARCH BY HASH AND NAME >>>>> length {len(subtitlesResultList['data'])} >>>>> {subtitlesResultList['data']}")
else:
if any(mode in opt_search_mode for mode in ['hash_then_filename', 'hash']):
subtitlesResultList = searchSubtitles(moviehash=videoHash, languages=opt_languages)
#print(f"SEARCH BY HASH >>>>> length {len(subtitlesResultList['data'])} >>>>> {subtitlesResultList['data']}")
if ((opt_search_mode == 'filename') or
(opt_search_mode == 'hash_then_filename' and len(subtitlesResultList['data']) == 0)):
subtitlesResultList = searchSubtitles(query=videoFileName, languages=opt_languages)
#print(f"SEARCH BY NAME >>>>> length {len(subtitlesResultList['data'])} >>>>> {subtitlesResultList['data']}")
except Exception:
superPrint("error", "Search error!", "Unable to reach opensubtitles.com servers!<br><b>Search error</b>")
sys.exit(2)
## Parse the results of the search query
if subtitlesResultList and 'data' in subtitlesResultList and len(subtitlesResultList['data']) > 0:
# Mark search as successful
languageCount_results += 1
subName = u''
subIndex = 0
# If there is only one subtitles (matched by file hash), auto-select it (except in CLI mode)
if (len(subtitlesResultList['data']) == 1) and (subtitlesResultList['data'][0]['attributes'].get('moviehash_match', False) == True):
if opt_selection_mode != 'manual':
subName = subtitlesResultList['data'][0]['attributes']['files'][0]['file_id']
# Check if we have a valid title, found by hash
for item in subtitlesResultList['data']:
if item['attributes'].get('moviehash_match', False) == True:
videoTitle = item['attributes']['feature_details']['movie_name']
break
# If there is more than one subtitles and opt_selection_mode != 'auto',
# then let the user decide which one will be downloaded
if not subName:
if opt_selection_mode == 'auto':
# Automatic subtitles selection
(subName, subIndex) = selectionAuto(subtitlesResultList, languageList)
else:
# Go through the list of subtitles and handle 'auto' settings activation
for item in subtitlesResultList['data']:
if opt_selection_match == 'auto':
if (opt_search_mode == 'hash_and_filename' or opt_search_mode == 'hash_then_filename'):
if item['attributes'].get('moviehash_match', False) == False:
opt_selection_match = 'on'
if opt_selection_language == 'auto' and languageCount_search > 1:
opt_selection_language = 'on'
if opt_selection_hi == 'auto' and item['attributes'].get('hearing_impaired', False) == True:
opt_selection_hi = 'on'
if opt_selection_rating == 'auto' and item['attributes']['ratings'] != '0.0':
opt_selection_rating = 'on'
if opt_selection_count == 'auto':
opt_selection_count = 'on'
if opt_selection_fps == 'auto' and item['attributes'].get('fps', '0.0') != '0.0':
opt_selection_fps = 'on'
# Spaw selection window
if opt_gui == 'gnome':
(subName, subIndex) = selectionGnome(subtitlesResultList)
elif opt_gui == 'kde':