rename_multimedia_files.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

'''
批量修改照片文件名称的Python脚本程序。
遍历指定目录（含子目录）的照片文件，并
根据拍照时间将照片文件名修改为以下格式：
    IMG_20140315_091230.JPG
如果存在重名文件，则尝试如下文件名：
    IMG_20140315_091230_01.JPG
    ...
    IMG_20140315_091230_99.jpg

本程序需要安装下列模块：
    $ sudo apt install python3-pip
    $ pip3 --version

    $ sudo pip3 install exifread
    $ pip3 show exifread
      Name: ExifRead
      Version: 2.3.2
      Summary: Read Exif metadata from tiff and jpeg files.
      Home-page: https://github.com/ianare/exif-py
      Author: Ianaré Sévi
      Author-email: ianare@gmail.com
      License: BSD
      Location: /usr/local/lib/python3.8/dist-packages
      Requires:
      Required-by:

    $ pip3 install python-dateutil
    $ pip3 show python-dateutil
      Name: python-dateutil
      Version: 2.8.1
      Summary: Extensions to the standard Python datetime module
      Home-page: https://dateutil.readthedocs.io
      Author: Gustavo Niemeyer
      Author-email: gustavo@niemeyer.net
      License: Dual License
      Location: /home/chenwx/.local/lib/python3.8/site-packages
      Requires: six
      Required-by:

    $ sudo apt install exiftool
'''

import os
import stat
import time
import exifread
import argparse
import subprocess
from datetime import datetime
from dateutil import tz
from pathlib import Path

# FILE_TYPE
IMG_FILE_TYPE = "IMG_"
VID_FILE_TYPE = "VID_"
AUD_FILE_TYPE = "AUD_"

# Extension Names
IMG_SUFFIX_FILTER = [ '.JPG', '.PNG', '.BMP', '.JPEG' ]
VID_SUFFIX_FILTER = [ '.MP4', '.MPG', '.MOV', '.AVI' ]
AUD_SUFFIX_FILTER = [ '.M4A', '.WAV' ]

# Global Variables
isRecursive     = False
isExecute       = False
aFile           = ""
useModifiedDate = False
handlePhoto     = False
handleVedio     = False
handleAudio     = False
useAbsPath      = False
isQuiet         = True

# China Time Zone
CN_TIME_ZONE = "+08:00"


def parseArguments():
    # Parse arguments
    parser = argparse.ArgumentParser(description='')
    parser.add_argument("-d", "--directory", help="Specify directory.")
    parser.add_argument("-r", "--recursive", action="store_true", help="Recursive all sub-directories.")
    parser.add_argument("-e", "--execute", action="store_true", help="Execute the rename action.")
    parser.add_argument("-f", "--file", help="Specify a file.")
    parser.add_argument("-m", "--modified", action="store_true", help="Use modified date if EXIF data missing.")
    parser.add_argument("-a", "--all", action="store_true", help="Process photos and vedios.")
    parser.add_argument("-p", "--photo", action="store_true", help="Process photos.")
    parser.add_argument("-v", "--vedio", action="store_true", help="Process vedios.")
    parser.add_argument("-b", "--abspath", action="store_true", help="Print abspath.")
    parser.add_argument("-n", "--notquiet", action="store_true", help="Print all rename info.")
    args = parser.parse_args()

    # -d, --directory
    path = "."
    if args.directory and Path(args.directory).exists():
        path = args.directory

    # -r, --recursive
    global isRecursive
    if args.recursive:
        isRecursive = True

    # -e, --execute
    global isExecute
    if args.execute:
        isExecute = True

    # -f, --file
    global aFile
    if args.file:
        aFile = args.file

    # -m, --modified
    global useModifiedDate
    if args.modified:
        useModifiedDate = True

    # -a, --all
    global handlePhoto
    global handleVedio
    global handleAudio
    if args.all:
        handlePhoto = True
        handleVedio = True
        handleAudio = True
    # -p, --photo
    if args.photo:
        handlePhoto = True
    # -v, --vedio
    if args.vedio:
        handleVedio = True

    # -b, --abspath
    global useAbsPath
    if args.abspath:
        useAbsPath = True

    # -n, --notquiet
    global isQuiet
    if args.notquiet:
        isQuiet = False

    print("Path              :", os.path.abspath(path))
    print("Recursive         :", isRecursive)
    print("Execute           :", isExecute)
    print("aFile             :", aFile)
    print("Use Modified Date :", useModifiedDate)
    print("Handle Photo      :", handlePhoto)
    print("Handle Vedio      :", handleVedio)
    print("Handle Audio      :", handleAudio)
    print("Use AbsPath       :", useAbsPath)
    print("Quiet             :", isQuiet)
    print('\n')

    return path


def isTargetFileType(fileName):
    # 根据文件扩展名，判断是否是需要处理的文件类型
    fileNameNoPath = os.path.basename(fileName)
    f, e = os.path.splitext(fileNameNoPath)
    if e.upper() in IMG_SUFFIX_FILTER:
        return True, IMG_FILE_TYPE
    elif e.upper() in VID_SUFFIX_FILTER:
        return True, VID_FILE_TYPE
    elif e.upper() in AUD_SUFFIX_FILTER:
        return True, AUD_FILE_TYPE
    else:
        return False, ""


def isSameFileName(fileName, newFileName):
    retVal = False

    lenExt = 4
    if len(newFileName) <= lenExt:
        return False

    lenName = len(newFileName) - lenExt
    if fileName[:lenName] == newFileName[:lenName] and fileName[-lenExt:] == newFileName[-lenExt:]:
        retVal = True

    return retVal


def generateNewFileName(fileName):
    # 根据照片的拍照时间生成新的文件名。如果获取不到拍照时间，则直接跳过
    try:
        if os.path.isfile(fileName):
            fd = open(fileName, 'rb')
        else:
            raise "[%s] is not a file!\n" % fileName
    except:
        raise "unopen file[%s]\n" % fileName

    # Default value
    retVal = False
    newFileName = ""

    # 原文件信息
    absPathFile = os.path.abspath(fileName)
    dirname = os.path.dirname(absPathFile)
    fileNameNoPath = os.path.basename(absPathFile)
    f, e = os.path.splitext(fileNameNoPath)

    # Check if the file can be handled or not
    isSupported, fileType = isTargetFileType(fileName)
    if isSupported == False:
        return retVal, newFileName

    myDataFormat = fileType + '%Y%m%d_%H%M%S'
    if fileType == IMG_FILE_TYPE and handlePhoto == True:
        # 如果取得Exif信息，则根据照片的拍摄日期重命名文件
        exifTags = exifread.process_file(fd)
        if exifTags:
            try:
                # 取得照片的拍摄日期，并转换成 yyyymmdd_hhmmss 格式
                t = exifTags [ 'EXIF DateTimeOriginal' ]
                dateStr = fileType + str(t).replace(":", "")[:8] + "_" + str(t)[11:].replace(":", "")
                # 生成新文件名
                newFileName = os.path.join(dateStr + e).upper()
                retVal = True
            except:
                pass
    elif fileType == VID_FILE_TYPE and handleVedio == True:
        exiftoolCmd = "exiftool " + fileName
        exiftoolVal = subprocess.run(exiftoolCmd, shell=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE)
        metaData = str(exiftoolVal.stdout).split("\\n")
        src_zone = tz.tzutc()
        dst_zone = tz.tzlocal()

        # For ".MP4":
        #   File Type                       : MP4
        #   File Type Extension             : mp4
        #   MIME Type                       : video/mp4
        #   Major Brand                     : MP4 v2 [ISO 14496-14]
        if e.upper() == ".MP4":
            for element in metaData:
                if "Media Create Date" in element:
                    try:
                        mediaCreateDate = (element.split(" : ")[1])
                        utcDateTime = datetime.strptime(mediaCreateDate, '%Y:%m:%d %H:%M:%S')
                        utcDateTime = utcDateTime.replace(tzinfo=src_zone)
                        locDateTime = utcDateTime.astimezone(dst_zone)
                        dateStr = locDateTime.strftime(myDataFormat)
                        newFileName = os.path.join(dateStr + e).upper()
                        retVal = True
                        break
                    except:
                        retVal = False
                        break
        # For ".MPG":
        #   File Type                       : MPEG
        #   File Type Extension             : mpg
        #   MIME Type                       : video/mpeg
        elif e.upper() == ".MPG":
            for element in metaData:
                if "File Modification Date/Time" in element:
                    try:
                        fileModificationDateTime = (element.split(" : ")[1])
                        modificationDateTime = fileModificationDateTime[:19]
                        timeZone = fileModificationDateTime[19:]
                        if timeZone == CN_TIME_ZONE:
                            locDateTime = datetime.strptime(modificationDateTime, '%Y:%m:%d %H:%M:%S')
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                        else:
                            utcDateTime = datetime.strptime(modificationDateTime, '%Y:%m:%d %H:%M:%S')
                            utcDateTime = utcDateTime.replace(tzinfo=src_zone)
                            locDateTime = utcDateTime.astimezone(dst_zone)
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                    except:
                        retVal = False
                        break
        # For ".MOV":
        #   File Type                       : MOV
        #   File Type Extension             : mov
        #   MIME Type                       : video/quicktime
        #   Major Brand                     : Apple QuickTime (.MOV/QT)
        elif e.upper() == ".MOV":
            for element in metaData:
                if "Creation Date" in element:
                    try:
                        creationDate = (element.split(" : ")[1])
                        creationDateTime = creationDate[:19]
                        timeZone = creationDate[19:]
                        if timeZone == CN_TIME_ZONE:
                            locDateTime = datetime.strptime(creationDateTime, '%Y:%m:%d %H:%M:%S')
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                        else:
                            utcDateTime = datetime.strptime(creationDateTime, '%Y:%m:%d %H:%M:%S')
                            utcDateTime = utcDateTime.replace(tzinfo=src_zone)
                            locDateTime = utcDateTime.astimezone(dst_zone)
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                    except:
                        retVal = False
                        break
    elif fileType == AUD_FILE_TYPE and handleAudio == True:
        exiftoolCmd = "exiftool " + fileName
        exiftoolVal = subprocess.run(exiftoolCmd, shell=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE)
        metaData = str(exiftoolVal.stdout).split("\\n")
        src_zone = tz.tzutc()
        dst_zone = tz.tzlocal()

        # For ".M4A":
        #   File Type                       : M4A
        #   File Type Extension             : m4a
        #   MIME Type                       : audio/mp4
        #   Major Brand                     : Apple iTunes AAC-LC (.M4A) Audio
        if e.upper() == ".M4A":
            for element in metaData:
                if "Create Date" in element:
                    try:
                        creationDate = (element.split(" : ")[1])
                        creationDateTime = creationDate[:19]
                        timeZone = creationDate[19:]
                        if timeZone == CN_TIME_ZONE:
                            locDateTime = datetime.strptime(creationDateTime, '%Y:%m:%d %H:%M:%S')
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                        else:
                            utcDateTime = datetime.strptime(creationDateTime, '%Y:%m:%d %H:%M:%S')
                            utcDateTime = utcDateTime.replace(tzinfo=src_zone)
                            locDateTime = utcDateTime.astimezone(dst_zone)
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                    except:
                        retVal = False
                        break
        # For ".WAV":
        #   File Type                       : WAV
        #   File Type Extension             : wav
        #   MIME Type                       : audio/x-wav
        #   Encoding                        : Microsoft PCM
        elif e.upper() == ".WAV":
            for element in metaData:
                if "File Modification Date/Time" in element:
                    try:
                        creationDate = (element.split(" : ")[1])
                        creationDateTime = creationDate[:19]
                        timeZone = creationDate[19:]
                        if timeZone == CN_TIME_ZONE:
                            locDateTime = datetime.strptime(creationDateTime, '%Y:%m:%d %H:%M:%S')
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                        else:
                            utcDateTime = datetime.strptime(creationDateTime, '%Y:%m:%d %H:%M:%S')
                            utcDateTime = utcDateTime.replace(tzinfo=src_zone)
                            locDateTime = utcDateTime.astimezone(dst_zone)
                            dateStr = locDateTime.strftime(myDataFormat)
                            newFileName = os.path.join(dateStr + e).upper()
                            retVal = True
                            break
                    except:
                        retVal = False
                        break

    # 如果获取Exif信息失败，则采用该照片的创建日期重命名文件
    if retVal == False and useModifiedDate == True:
        state = os.stat(fileName)
        dateStr = time.strftime(myDataFormat, time.localtime(state[-2]))
        newFileName = os.path.join(dateStr + e).upper()
        retVal = True

    # 检查新文件名是否合法
    if retVal == True:
        # 如果新文件名与原文件名相同，则无需改名
        if isSameFileName(fileName, newFileName):
            retVal = False
        # 如果新文件名与其他文件重名，则在新文件明后加后缀 _01, _02, .., _99
        elif newFileName in os.listdir(dirname):
            for i in range(1, 100):
                tmpDateStr = dateStr + "_" + str(i).zfill(2)
                newFileName = os.path.join(tmpDateStr + e).upper()
                if isSameFileName(fileName, newFileName):
                    retVal = False
                    break
                elif newFileName not in os.listdir(dirname):
                    retVal = True
                    break
        else:
            retVal = True

    return retVal, newFileName


def scanDir(startdir):
    # 只检查指定的一个文件
    if aFile != "":
        if os.path.isfile(aFile):
            obj = aFile
            # 对满足过滤条件的文件进行改名处理
            retVal, newFileName = generateNewFileName(obj)
            if retVal:
                try:
                    if isExecute == True:
                        os.rename(obj, newFileName)
                    if useAbsPath == True:
                        print(os.path.abspath(obj), "\t=>\t", newFileName)
                    else:
                        print(obj, "\t=>\t", newFileName)
                except:
                    if isQuiet == False:
                        if useAbsPath == True:
                            print(os.path.abspath(obj), "\t=>\tcannot rename to ", newFileName)
                        else:
                            print(obj, "\t=>\tcannot rename to ", newFileName)
            else:
                if isQuiet == False:
                    if useAbsPath == True:
                        print(os.path.abspath(obj), "\t=>\tNo change")
                    else:
                        print(obj, "\t=>\tNo change")
        else:
            print(obj, " is not a vaild file!")
        return

    # 遍历指定目录以及子目录，对满足条件的文件进行改名
    os.chdir(startdir)
    for obj in os.listdir(os.curdir):
        if os.path.isfile(obj):
            # 对满足过滤条件的文件进行改名处理
            retVal, newFileName = generateNewFileName(obj)
            if retVal:
                try:
                    if isExecute == True:
                        os.rename(obj, newFileName)
                    if useAbsPath == True:
                        print(os.path.abspath(obj), "\t=>\t", newFileName)
                    else:
                        print(obj, "\t=>\t", newFileName)
                except:
                    if isQuiet == False:
                        if useAbsPath == True:
                            print(os.path.abspath(obj), "\t=>\tcannot rename to ", newFileName)
                        else:
                            print(obj, "\t=>\tcannot rename to ", newFileName)
            else:
                if isQuiet == False:
                    if useAbsPath == True:
                        print(os.path.abspath(obj), "\t=>\tNo change")
                    else:
                        print(obj, "\t=>\tNo change")
        elif os.path.isdir(obj) and isRecursive == True:
            scanDir(obj)
            os.chdir(os.pardir)


if __name__ == "__main__":
    path = parseArguments()
    scanDir(path)