-
Notifications
You must be signed in to change notification settings - Fork 8
/
VideoSlimmer.py
677 lines (420 loc) · 22.1 KB
/
VideoSlimmer.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
import os
import sys
import logging
import logging.handlers
import re
import StringIO
import subprocess
from distutils.version import StrictVersion
# set videoslimmer version numbers
latest_vs_version = "1.0.3"
# define path to videoslimmer root
videoslimmer_root_path_uni = os.path.dirname(os.path.realpath(__file__)).decode("utf-8")
# define path to videoslimmer logs folder
videoslimmer_logs_path_uni = os.path.join(videoslimmer_root_path_uni, u"logs")
# check version of python is 2.6.x or 2.7.x
if sys.version_info < (2, 6, 0) or sys.version_info >= (3, 0, 0):
sys.stderr.write(u"videoslimmer requires python 2.6.x/2.7.x installed, your running version %s"), sys.version_info
sys.exit()
else:
# create full path to modules
sitepackages_modules_full_path = os.path.join(videoslimmer_root_path_uni, u"modules/argparse")
sitepackages_modules_full_path = os.path.normpath(sitepackages_modules_full_path)
# append full path to sys
sys.path.insert(1, sitepackages_modules_full_path)
# import argparse in order to support python 2.6.x
import argparse
#########
# tools #
#########
# debug for text type
def string_type(text):
# prints out whether string, unicode or other
if isinstance(text, str):
print "byte string"
elif isinstance(text, unicode):
print "unicode string"
else:
print "not string"
# used to decode byte strings to unicode, either utf-8 (normally used on linux) or cp1252 (windows)
def byte_to_uni(name):
# if type is byte string then decode to unicode, otherwise assume already unicode
if isinstance(name, str) and name is not None:
try:
# linux default encode
name = name.decode('utf8')
except UnicodeEncodeError:
# windows default encode
name = name.decode('windows-1252')
return name
# used to encode unicode to byte strings, either utf-8 (normally used on linux) or cp1252 (windows)
def uni_to_byte(name):
# if type is unicode then encode to byte string, otherwise assume already byte string
if isinstance(name, unicode) and name is not None:
if os.name == "nt":
try:
# windows default encode
name = name.encode('windows-1252')
except UnicodeEncodeError:
# linux default encode
name = name.encode('utf8')
else:
try:
# linux default encode
name = name.encode('utf8')
except UnicodeEncodeError:
# windows default encode
name = name.encode('windows-1252')
return name
# get output from mkvmerge command using regex to filter
audio_regex = re.compile(ur"Track ID (\d+): audio.*")
subtitle_regex = re.compile(ur"Track ID (\d+): subtitles.*")
language_regex = re.compile(ur"(?<=language:)[a-zA-Z]+")
trackid_regex = re.compile(ur"(?<=Track ID\s)\d+")
title_regex = re.compile(ur"(?<=title:).*(?=\sduration)")
# custom argparse to redirect user to help if unknown argument specified
class ArgparseCustom(argparse.ArgumentParser):
def error(self, message):
sys.stderr.write('\n')
sys.stderr.write('error: %s\n' % message)
sys.stderr.write('\n')
self.print_help()
sys.exit(2)
# setup argparse description and usage, also increase spacing for help to 50
commandline_parser = ArgparseCustom(prog="VideoSlimmer", description="%(prog)s " + latest_vs_version, usage="%(prog)s [--help] --mkvmerge <path> --media <path> --lang <code> [--edit-title yes] [--delete-title yes] [--dry-run yes] [--log <level>] [--keep-all-subtitles] [--version]", formatter_class=lambda prog: argparse.HelpFormatter(prog, max_help_position=70))
# add argparse command line flags
commandline_parser.add_argument(u"--mkvmerge", metavar=u"<path>", required=True, help=u"specify the path to mkvmerge e.g. --mkvmerge c:\Program Files\mkvtoolnix\mkvmerge.exe")
commandline_parser.add_argument(u"--media", metavar=u"<path>", required=True, help=u"specify the path to your media e.g. --media c:\media\movies")
commandline_parser.add_argument(u"--lang", metavar=u"<code>", required=True, help=u"specify the language you want to keep e.g. --lang eng")
commandline_parser.add_argument(u"--edit-title", metavar=u"yes", help=u"specify whether you want to change the title metadata to match the filename e.g. --edit-title yes")
commandline_parser.add_argument(u"--delete-title", metavar=u"yes", help=u"specify whether you want to delete the title metadata e.g. --delete-title yes")
commandline_parser.add_argument(u"--dry-run", metavar=u"no", help=u"specify whether you want to perform a dry run e.g. --dry-run yes")
commandline_parser.add_argument(u"--logpath", metavar=u"<path>", help=u"specify the path to your log files e.g. --logpath c:\videoslimmer")
commandline_parser.add_argument(u"--loglevel", metavar=u"<level>", help=u"specify the logging level, debug, info, warning, error, debug being the most verbose e.g. --loglevel info")
commandline_parser.add_argument(u"--keep-all-subtitles", action=u"store_true", help=u"Keep all subtitles regardless of language")
commandline_parser.add_argument(u"--version", action=u"version", version=latest_vs_version)
# save arguments in dictionary
args = vars(commandline_parser.parse_args())
# save mkvmerge location
if os.path.exists(args["mkvmerge"]):
mkvmerge_cli_str = args["mkvmerge"]
mkvmerge_cli_uni = byte_to_uni(mkvmerge_cli_str)
mkvmerge_cli_utf8 = uni_to_byte(mkvmerge_cli_uni)
else:
sys.stderr.write(u"mkvmerge location does not exist")
sys.exit()
# save media location
if os.path.exists(args["media"]):
media_root_path_str = args["media"]
media_root_path_uni = byte_to_uni(media_root_path_str)
media_root_path_utf8 = uni_to_byte(media_root_path_uni)
else:
sys.stderr.write(u"media location does not exist")
sys.exit()
# save preferred language
if len(args["lang"]) == 3:
preferred_lang_str = args["lang"]
preferred_lang_uni = byte_to_uni(preferred_lang_str)
preferred_lang_utf8 = uni_to_byte(preferred_lang_uni)
else:
sys.stderr.write(u"language code incorrect length, should be 3 characters")
sys.exit()
# if enabled then edit metadata "title" field to filename minus extension
if args["edit_title"] == "yes":
edit_title = True
else:
edit_title = False
# if enabled then delete metadata in "title" field
if args["delete_title"] == "yes":
delete_title = True
else:
delete_title = False
# if enabled then perform dry run
if args["dry_run"] == "yes":
dry_run = True
else:
dry_run = False
# save log path
if args["logpath"] is None:
videoslimmer_logs_file_uni = os.path.join(videoslimmer_logs_path_uni, u"videoslimmer.log")
else:
logs_path_uni = byte_to_uni(args["logpath"])
if not os.path.exists(logs_path_uni):
os.makedirs(logs_path_uni)
videoslimmer_logs_file_uni = os.path.join(logs_path_uni, u"videoslimmer.log")
# save log level
if args["loglevel"] is None:
log_level = u"info"
elif args["loglevel"] == "debug" or args["loglevel"] == "info" or args["loglevel"] == "warning" or args["loglevel"] == "error":
log_level = args["loglevel"]
log_level = byte_to_uni(log_level)
else:
sys.stderr.write(u"incorrect logging level specified, defaulting to log level 'info'")
log_level = u"info"
# check version of mkvmerge is 6.5.0 or greater
cmd = [mkvmerge_cli_str, "--vesion"]
mkvmerge = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = mkvmerge.communicate()
mkmerge_version = re.compile(ur"(?<=v)[\d.]+", re.IGNORECASE).search(stdout)
# if min version not met, then exit
if StrictVersion(mkmerge_version.group()) < StrictVersion("6.5.0"):
sys.stderr.write(u"mkvmerge version is less than 6.5.0, please upgrade")
sys.exit()
###########
# logging #
###########
def videoslimmer_logging():
# setup formatting for log messages
videoslimmer_formatter = logging.Formatter(u"%(asctime)s %(levelname)s %(module)s %(funcName)s :: %(message)s")
# setup logger for videoslimmer
videoslimmer_logger = logging.getLogger(u"videoslimmer")
# add rotating log handler
videoslimmer_rotatingfilehandler = logging.handlers.RotatingFileHandler(videoslimmer_logs_file_uni, "a", maxBytes=10485760, backupCount=3, encoding="utf-8")
# set formatter for videoslimmer
videoslimmer_rotatingfilehandler.setFormatter(videoslimmer_formatter)
# add the log message handler to the logger
videoslimmer_logger.addHandler(videoslimmer_rotatingfilehandler)
# setup logging to console
console_streamhandler = logging.StreamHandler()
# set formatter for console
console_streamhandler.setFormatter(videoslimmer_formatter)
# add handler for formatter to the console
videoslimmer_logger.addHandler(console_streamhandler)
# set level of logging
if log_level == u"debug":
console_streamhandler.setLevel(logging.DEBUG)
videoslimmer_logger.setLevel(logging.DEBUG)
elif log_level == u"info":
console_streamhandler.setLevel(logging.INFO)
videoslimmer_logger.setLevel(logging.INFO)
elif log_level == u"warning":
console_streamhandler.setLevel(logging.WARNING)
videoslimmer_logger.setLevel(logging.WARNING)
elif log_level == u"exception":
console_streamhandler.setLevel(logging.ERROR)
videoslimmer_logger.setLevel(logging.ERROR)
else:
console_streamhandler.setLevel(logging.INFO)
videoslimmer_logger.setLevel(logging.INFO)
return videoslimmer_logger
# store the logger instances
vs_log = videoslimmer_logging()
def audio_tracks(mkvmerge_info_stdout_uni):
# create empty lists for audio to remove and preferred audio
remove_audio_list = []
pref_audio_list = []
audio_track_list = []
# search for audio tracks using regex
for line in StringIO.StringIO(mkvmerge_info_stdout_uni):
audio_track_search = audio_regex.search(line)
if audio_track_search:
audio_track_list.append(audio_track_search.group())
# find audio to remove and keep
if audio_track_list:
# find audio tracks to remove, if not found then skip
for audio_track_item in audio_track_list:
audio_lang_search = language_regex.search(audio_track_item)
if audio_lang_search is not None:
audio_lang = audio_lang_search.group()
if audio_lang != preferred_lang_str:
remove_audio_trackid_search = trackid_regex.search(audio_track_item)
if remove_audio_trackid_search is not None:
remove_audio_trackid = remove_audio_trackid_search.group()
remove_audio_list.append(remove_audio_trackid)
if not remove_audio_list:
vs_log.info(u"no audio tracks to remove")
else:
vs_log.info(
u"audio track id(s) that dont match preferred are %s" % (byte_to_uni(", ".join(remove_audio_list))))
# find audio tracks with preferred language, if not found then skip
for audio_track_item in audio_track_list:
audio_lang_search = language_regex.search(audio_track_item)
if audio_lang_search is not None:
audio_lang = audio_lang_search.group()
if audio_lang == preferred_lang_str:
pref_audio_trackid_search = trackid_regex.search(audio_track_item)
if pref_audio_trackid_search is not None:
pref_audio_trackid = pref_audio_trackid_search.group()
pref_audio_list.append(pref_audio_trackid)
if not pref_audio_list:
vs_log.info(u"no audio tracks with preferred language, skipping removal")
else:
vs_log.info(u"preferred audio track present, marking for removal of other audio tracks")
else:
vs_log.info(u"no audio tracks present")
return remove_audio_list, pref_audio_list
def subtitle_tracks(mkvmerge_info_stdout_uni):
if args['keep_all_subtitles']:
vs_log.info(u"--keep-all-subtitles flags is set. Any existing subtitles will be kept")
return [], []
# create empty lists for subtitles to remove and preferred subtitles
remove_subtitle_list = []
pref_subtitle_list = []
subtitle_track_list = []
# search for subtitle tracks using regex
for line in StringIO.StringIO(mkvmerge_info_stdout_uni):
subtitle_track_search = subtitle_regex.search(line)
if subtitle_track_search:
subtitle_track_list.append(subtitle_track_search.group())
# find subtitle to remove and keep
if subtitle_track_list:
# find subtitle tracks to remove, if not found then skip
for subtitle_track_item in subtitle_track_list:
subtitle_lang_search = language_regex.search(subtitle_track_item)
if subtitle_lang_search is not None:
subtitle_lang = subtitle_lang_search.group()
if subtitle_lang != preferred_lang_str:
remove_subtitle_trackid_search = trackid_regex.search(subtitle_track_item)
if remove_subtitle_trackid_search is not None:
remove_subtitle_trackid = remove_subtitle_trackid_search.group()
remove_subtitle_list.append(remove_subtitle_trackid)
if not remove_subtitle_list:
vs_log.info(u"no subtitles to remove")
else:
vs_log.info(
u"subtitle id(s) that dont match preferred are %s" % (byte_to_uni(", ".join(remove_subtitle_list))))
# find subtitle tracks with preferred language, if not found then skip
for subtitle_track_item in subtitle_track_list:
subtitle_lang_search = language_regex.search(subtitle_track_item)
if subtitle_lang_search is not None:
subtitle_lang = subtitle_lang_search.group()
if subtitle_lang == preferred_lang_str:
pref_subtitle_trackid_search = trackid_regex.search(subtitle_track_item)
if pref_subtitle_trackid_search is not None:
pref_subtitle_trackid = pref_subtitle_trackid_search.group()
pref_subtitle_list.append(pref_subtitle_trackid)
if not pref_subtitle_list:
vs_log.info(u"no subtitle with preferred language, skipping removal")
else:
vs_log.info(u"preferred subtitle present, marking for removal of other subtitles")
else:
vs_log.info(u"no subtitles present")
return remove_subtitle_list, pref_subtitle_list
def edit_metadata_title(mkvmerge_info_stdout_uni, media_file_bare):
# if set or delete title is enabled then identify if we need to edit metadata field
if edit_title or delete_title:
metadata_title = None
# find metadata title
for line in StringIO.StringIO(mkvmerge_info_stdout_uni):
metadata_title_search = title_regex.search(line)
if metadata_title_search:
metadata_title = metadata_title_search.group()
metadata_title = re.sub(ur"\\s", u" ", metadata_title)
vs_log.debug(u"metadata title is %s" % metadata_title)
break
if edit_title:
if metadata_title != media_file_bare:
write_title = True
vs_log.info(u"metadata title and filename do NOT match, marking for rewrite...")
else:
write_title = False
vs_log.debug(u"metadata title and filename match for title field")
else:
if metadata_title != u"":
write_title = True
vs_log.info(u"metadata title is not blank, marking for rewrite...")
else:
write_title = False
vs_log.debug(u"metadata title is already blank")
else:
write_title = False
vs_log.debug(u"metadata not configured to rewrite, skipping")
return write_title
def videoslimmer():
vs_log.info(u"[BEGIN] VideoSlimmer processing started")
# walk media root path, convert to byte string before walk
for root, dirs, files in os.walk(media_root_path_uni):
for media_filename in files:
# filter out non mkv files
if not media_filename.endswith(u".mkv"):
vs_log.warning(u"File \"%s\" does not have an mkv extension, skipping file" % media_filename)
continue
# create filename minus extension
media_file_bare = os.path.splitext(media_filename)[0]
media_file_bare_uni = byte_to_uni(media_file_bare)
vs_log.debug(u"filename without extension is \"%s\"" % media_file_bare)
if dry_run is True:
vs_log.info(u"[DRY RUN] No files will be modified")
# create full path to media file
media_file_path_uni = os.path.join(root, media_filename)
media_file_path_str = uni_to_byte(media_file_path_uni)
vs_log.info(u"Processing file %s" % media_file_path_uni)
# create full path to temporary file
temp_file_path_uni = (u"%s.temp" % media_file_path_uni)
temp_file_path_str = uni_to_byte(temp_file_path_uni)
# create temporary file
temp_file_uni = u"%s.temp" % media_filename
# delete any previously failed merge files
if os.path.exists(temp_file_path_str):
os.remove(temp_file_path_str)
vs_log.debug(u"deleted temporary file %s" % temp_file_path_uni)
vs_log.debug(u"analysing file \"%s\"" % media_filename)
vs_log.debug(u"path to file is \"%s\"" % root)
# build command line
mkvmerge_cmd = [mkvmerge_cli_uni, u"--identify-verbose", media_file_path_uni]
vs_log.debug(u"mkvmerge command to query file is \"%s\"" % mkvmerge_cmd)
# get file system encoding type and then encode all items in the list
file_system_encoding = sys.getfilesystemencoding()
mkvmerge_cmd = [x.encode(file_system_encoding) for x in mkvmerge_cmd]
# use mkvmerge to get info for file
mkvmerge_info = subprocess.Popen(mkvmerge_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
mkvmerge_info_stdout, mkvmerge_info_stderr = mkvmerge_info.communicate()
mkvmerge_info_stdout_uni = byte_to_uni(mkvmerge_info_stdout)
if mkvmerge_info.returncode != 0:
vs_log.warning(u"mkvmerge failed to identify file %s"), media_file_path_uni
continue
remove_audio_list, pref_audio_list = audio_tracks(mkvmerge_info_stdout_uni)
remove_subtitle_list, pref_subtitle_list = subtitle_tracks(mkvmerge_info_stdout_uni)
write_title = edit_metadata_title(mkvmerge_info_stdout_uni, media_file_bare)
# if no audio or subtitles to remove then skip to next iteration
if not (pref_audio_list and remove_audio_list):
if not (pref_subtitle_list and remove_subtitle_list):
if write_title is False:
vs_log.info(u"No audio, subtitles or metadata to change")
vs_log.info(u"[SKIPPED] Processing finished")
continue
# build command line
mkvmerge_cmd = [mkvmerge_cli_uni, u"-o", temp_file_path_uni]
if write_title is True:
# if write of title detected then build title for cli
if edit_title is True:
mkvmerge_cmd += [u"--title", u"%s" % media_file_bare_uni]
elif delete_title is True:
mkvmerge_cmd += [u"--title", u""]
# check preferred audio exists, and there are audio tracks to remove
if pref_audio_list and remove_audio_list:
mkvmerge_cmd += [u"--audio-tracks", u"%s" % (u",".join(pref_audio_list))]
mkvmerge_cmd += [u"--default-track", u"%s" % (pref_audio_list[0])]
# check preferred subtitle exists, and there are subtitles to remove
if pref_subtitle_list and remove_subtitle_list:
mkvmerge_cmd += [u"--subtitle-tracks", u"%s" % (u",".join(pref_subtitle_list))]
mkvmerge_cmd += [u"--default-track", u"%s" % (pref_subtitle_list[0])]
mkvmerge_cmd += [media_file_path_uni]
vs_log.debug(u"mkvmerge command to edit file is \"%s\"" % mkvmerge_cmd)
file_system_encoding = sys.getfilesystemencoding()
mkvmerge_cmd = [x.encode(file_system_encoding) for x in mkvmerge_cmd]
if dry_run is True:
vs_log.info(u"[DRY RUN] mkvmerge command is %s" % mkvmerge_cmd)
else:
# process file
mkvmerge_info = subprocess.Popen(mkvmerge_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
mkvmerge_info_stdout, mkvmerge_info_stderr = mkvmerge_info.communicate()
if mkvmerge_info.returncode != 0:
vs_log.warning(u"[FAILED] output from mkvmerge is %s" % (byte_to_uni(mkvmerge_info_stdout)))
if os.path.exists(temp_file_path_str):
# if failed then delete temp file
os.remove(temp_file_path_str)
vs_log.debug(u"deleted temporary file %s" % temp_file_uni)
vs_log.warning(u"[FAILED] mkvmerge returned non zero return code")
continue
vs_log.debug(u"mkvmerge returned success")
# remove source file and rename temp
os.remove(media_file_path_str)
vs_log.debug(u"removed source file \"%s\"" % media_file_path_uni)
os.rename(temp_file_path_str, media_file_path_str)
vs_log.debug(u"renamed temporary file from \"%s\" to \"%s\"" % (temp_file_uni, media_filename))
vs_log.info(u"[SUCCESS] Processing finished")
vs_log.info(u"[EXIT] VideoSlimmer finished")
if __name__ == '__main__':
# run main function
videoslimmer()