FormatAudioFile.py

# Author: Alexander Senger
# Version: 0.0.3

import eyed3
import os
import sys
import time
import string
import argparse
import logging
logging.basicConfig(level=logging.ERROR)

# relative path of the default tracks folder of the folder where the program is
MUSIC_PATH = os.path.join(sys.path[0], "tracks")

# additional not needed string extensions at the end of the file title
appendix = [
  " (Original Mix)",
  " (Extended Mix)",
  " (Extended)",
  " (DJ Mix)"
]

fileExtensions = [
  "mp3",
  "flac",
  "wav"
]

def reconstructDataOutOfFilename(fileString):

  # remove first leading numbers and replace all underscores
  tempString = fileString.lstrip(string.digits).replace("_", " ")
  # detect the file extension
  _, fileExtension = os.path.splitext(tempString)
  # remove the file extension
  tempString = tempString[:-len(fileExtension)]
  # remove all hyphens
  artistName, trackName = tempString.split(" - ")

  # prepare the artistName
  artistName = artistName.replace("-", "")
  artistName = artistName.replace(" and ", "&")
  artistName = artistName.replace(" Feat. ", " Ft. ")
  artistName = artistName.replace(" feat. ", " ft. ")
  artistName = artistName.lstrip(' ')  # removes first white space

  # prepare the trackName
  for element in appendix:
    if trackName.title().endswith(element):
      trackName = trackName[:-(len(element))]
      break

  return artistName.title(), trackName.title()

def renameFile(artistName, trackName, fileString, newFileString):

  # only rename the file if the filenames are unidentical
  if fileString != newFileString:
    src = MUSIC_PATH + os.sep + fileString
    dst = MUSIC_PATH + os.sep + newFileString

    print(f"[{fileString}] -> [{newFileString}]")

    try:
      os.rename(src, dst)
    except OSError:
      print(f'Error: File in use [{fileString}]')


# TODO: consider to check if one of the tags is valid and reconstruct the other part out of the filename
def examineFileString(artistNameTag, trackNameTag, fileString, audiofile):

  if (artistNameTag and trackNameTag):
    artistName = artistNameTag
    trackName = trackNameTag
  else:
    artistName, trackName = reconstructDataOutOfFilename(fileString)
    # check later on if it's .mp3 before writing it in tags
    audiofile.tag.artist = artistName
    audiofile.tag.title = trackName
    audiofile.tag.save()
    
  newFileString = f"{artistName} - {trackName}.mp3"
  return artistName, trackName, newFileString

def getArtistNameAndTrackNameFromTag(audiofile):
  if audiofile.tag.artist is None:
    artistName = None
  else:
    artistName = audiofile.tag.artist.lstrip(' ') #remove first white space

  if audiofile.tag.title is None:
    trackName = None
  else:
    trackName = audiofile.tag.title.lstrip(' ') #remove first white space
    for element in appendix:
      if trackName.endswith(element):
        trackName = trackName[:-(len(element))]
        break
    audiofile.tag.title = trackName
    audiofile.tag.save()

  return artistName, trackName

def adjustFile(audiofile, fileString):
  # try to get data from tags
  artistNameTag, trackNameTag = getArtistNameAndTrackNameFromTag(audiofile)

  artistName, trackName, newFileString = examineFileString(artistNameTag, trackNameTag, fileString, audiofile)

  renameFile(artistName, trackName, fileString, newFileString)

# read the command line argument and check if it's a dir path
# returns the newly selected path or the default path and creates the default folder if it's not existing
def getCommandLineDirectory():
  parser = argparse.ArgumentParser()
  parser.add_argument(
    "-p","--path", help="Select the folder of the transforming tracks.", nargs=1, type=str)
  args = parser.parse_args()
  if args.path:
    if os.path.isdir(args.path[0]) == False:
      print("Error: Path is invalid.")
      sys.exit()
    else:
      return args.path[0]
  else:
    if os.path.exists(MUSIC_PATH) == False:
      try:
        os.mkdir(MUSIC_PATH)
      except OSError:
        print(
            f"Creation of the directory [{MUSIC_PATH}] failed. Program terminated.")
      else:
        print(f"Successfully created default track directory [{MUSIC_PATH}].\nYou can put your music files now in there and execute again. Program terminated.")
        sys.exit()
    return MUSIC_PATH
    
def findMusicFiles():

  global MUSIC_PATH
  MUSIC_PATH = getCommandLineDirectory()

  # scan files in the directory
  fileNameList = [f for f in os.listdir(
  MUSIC_PATH) if os.path.isfile(os.path.join(MUSIC_PATH, f))]

  if len(fileNameList) == 0: 
    print(f"No files in folder [{MUSIC_PATH}] found. Program terminated.")
    sys.exit()

  # endswith can be extended by e.g. (('.mp3', '.flac'))
  musicFiles = [el for el in fileNameList if el.lower().endswith('.mp3')]

  if len(musicFiles) == 0:
    print(f"No music files in folder [{MUSIC_PATH}] found. Program terminated.")
    sys.exit()

  return musicFiles

def main():
  
  musicFiles = findMusicFiles()
  for musicFileString in musicFiles:
    audiofile = eyed3.load(os.path.join(MUSIC_PATH, musicFileString))
    # TODO: if musicFileString endswith .wav/.mp3/.flac
    adjustFile(audiofile, musicFileString)
  print('Done')

if __name__ == '__main__':
  executionStartTime = time.time()
  main()
  executionEndTime = time.time()
  print(f'Execution time: {executionEndTime - executionStartTime}s')