forked from upstream/IPod-Shuffle-4g
567 lines
22 KiB
Python
Executable file
567 lines
22 KiB
Python
Executable file
#!/usr/bin/env python2.7
|
||
# -*- coding: utf-8 -*-
|
||
import sys
|
||
import struct
|
||
import urllib
|
||
import os
|
||
import hashlib
|
||
import mutagen
|
||
import binascii
|
||
import subprocess
|
||
import collections
|
||
import errno
|
||
import argparse
|
||
import shutil
|
||
import re
|
||
import tempfile
|
||
|
||
audio_ext = (".mp3", ".m4a", ".m4b", ".m4p", ".aa", ".wav")
|
||
list_ext = (".pls", ".m3u")
|
||
def make_dir_if_absent(path):
|
||
try:
|
||
os.makedirs(path)
|
||
except OSError as exc:
|
||
if exc.errno != errno.EEXIST:
|
||
raise
|
||
|
||
def raises_unicode_error(str):
|
||
try:
|
||
str.decode('utf-8').encode('latin-1')
|
||
return False
|
||
except (UnicodeEncodeError, UnicodeDecodeError):
|
||
return True
|
||
|
||
def hash_error_unicode(item):
|
||
return "".join(["{0:02X}".format(ord(x)) for x in reversed(hashlib.md5(item).digest()[:8])])
|
||
pass
|
||
|
||
def validate_unicode(path):
|
||
path_list = path.split('/')
|
||
last_raise = False
|
||
for i in xrange(len(path_list)):
|
||
if raises_unicode_error(path_list[i]):
|
||
path_list[i] = hash_error_unicode(path_list[i])
|
||
last_raise = True
|
||
else:
|
||
last_raise = False
|
||
extension = os.path.splitext(path)[1].lower()
|
||
return "/".join(path_list) + (extension if last_raise and extension in audio_ext else '')
|
||
|
||
def exec_exists_in_path(command):
|
||
with open(os.devnull, 'w') as FNULL:
|
||
try:
|
||
subprocess.call([command], stdout=FNULL, stderr=subprocess.STDOUT)
|
||
return True
|
||
except OSError as e:
|
||
return False
|
||
|
||
class Text2Speech(object):
|
||
valid_tts = {'pico2wave': True, 'RHVoice': True}
|
||
|
||
@staticmethod
|
||
def check_support():
|
||
if not exec_exists_in_path("pico2wave"):
|
||
Text2Speech.valid_tts['pico2wave'] = False
|
||
print "Error executing pico2wave, voicever won't be generated using it"
|
||
if not exec_exists_in_path("RHVoice"):
|
||
Text2Speech.valid_tts['RHVoice'] = False
|
||
print "Error executing RHVoice, voicever won't be generated using it"
|
||
|
||
@staticmethod
|
||
def text2speech(out_wav_path, text):
|
||
# ensure we deal with unicode later
|
||
if not isinstance(text, unicode):
|
||
text = unicode(text, 'utf-8')
|
||
lang = Text2Speech.guess_lang(text)
|
||
if lang == "ru-RU":
|
||
Text2Speech.rhvoice(out_wav_path, text)
|
||
else:
|
||
Text2Speech.pico2wave(out_wav_path, text)
|
||
|
||
# guess-language seems like an overkill for now
|
||
@staticmethod
|
||
def guess_lang(unicodetext):
|
||
lang = 'en-GB'
|
||
if re.search(u"[А-Яа-я]", unicodetext) is not None:
|
||
lang = 'ru-RU'
|
||
return lang
|
||
|
||
@staticmethod
|
||
def pico2wave(out_wav_path, unicodetext):
|
||
if not Text2Speech.valid_tts['pico2wave']:
|
||
return False
|
||
subprocess.call(["pico2wave", "-l", "en-GB", "-w", out_wav_path, unicodetext])
|
||
|
||
@staticmethod
|
||
def rhvoice(out_wav_path, unicodetext):
|
||
if not Text2Speech.valid_tts['RHVoice']:
|
||
return False
|
||
|
||
tmp_file = tempfile.NamedTemporaryFile(suffix=".wav", delete=False)
|
||
tmp_file.close()
|
||
|
||
proc = subprocess.Popen(["RHVoice", "--voice=Elena", "--variant=Russian", "--volume=100", "-o", tmp_file.name], stdin=subprocess.PIPE)
|
||
proc.communicate(input=unicodetext.encode('utf-8'))
|
||
# make a little bit louder to be comparable with pico2wave
|
||
subprocess.call(["sox", tmp_file.name, out_wav_path, "norm"])
|
||
|
||
os.remove(tmp_file.name)
|
||
|
||
|
||
class Record(object):
|
||
|
||
def __init__(self, parent):
|
||
self.parent = parent
|
||
self._struct = collections.OrderedDict([])
|
||
self._fields = {}
|
||
self.voiceover = parent.voiceover
|
||
self.rename = parent.rename
|
||
self.trackgain = parent.trackgain
|
||
|
||
def __getitem__(self, item):
|
||
if item not in self._struct.keys():
|
||
raise KeyError
|
||
return self._fields.get(item, self._struct[item][1])
|
||
|
||
def __setitem__(self, item, value):
|
||
self._fields[item] = value
|
||
|
||
def construct(self):
|
||
output = ""
|
||
for i in self._struct.keys():
|
||
(fmt, default) = self._struct[i]
|
||
if fmt == "4s":
|
||
fmt, default = "I", int(binascii.hexlify(default), 16)
|
||
output += struct.pack("<" + fmt, self._fields.get(i, default))
|
||
return output
|
||
|
||
def text_to_speech(self, text, dbid, playlist = False):
|
||
if self.voiceover:
|
||
# Create the voiceover wav file
|
||
fn = "".join(["{0:02X}".format(ord(x)) for x in reversed(dbid)])
|
||
path = os.path.join(self.base, "iPod_Control", "Speakable", "Tracks" if not playlist else "Playlists", fn + ".wav")
|
||
Text2Speech.text2speech(path, text)
|
||
|
||
def path_to_ipod(self, filename):
|
||
if os.path.commonprefix([os.path.abspath(filename), self.base]) != self.base:
|
||
raise IOError("Cannot get Ipod filename, since file is outside the IPOD path")
|
||
baselen = len(self.base)
|
||
if self.base.endswith(os.path.sep):
|
||
baselen -= 1
|
||
ipodname = "/".join(os.path.abspath(filename)[baselen:].split(os.path.sep))
|
||
return ipodname
|
||
|
||
def ipod_to_path(self, ipodname):
|
||
return os.path.abspath(os.path.join(self.base, os.path.sep.join(ipodname.split("/"))))
|
||
|
||
@property
|
||
def shuffledb(self):
|
||
parent = self.parent
|
||
while parent.__class__ != Shuffler:
|
||
parent = parent.parent
|
||
return parent
|
||
|
||
@property
|
||
def base(self):
|
||
return self.shuffledb.base
|
||
|
||
@property
|
||
def tracks(self):
|
||
return self.shuffledb.tracks
|
||
|
||
@property
|
||
def albums(self):
|
||
return self.shuffledb.albums
|
||
|
||
@property
|
||
def artists(self):
|
||
return self.shuffledb.artists
|
||
|
||
@property
|
||
def lists(self):
|
||
return self.shuffledb.lists
|
||
|
||
class TunesSD(Record):
|
||
def __init__(self, parent):
|
||
Record.__init__(self, parent)
|
||
self.track_header = TrackHeader(self)
|
||
self.play_header = PlaylistHeader(self)
|
||
self._struct = collections.OrderedDict([
|
||
("header_id", ("4s", "shdb")),
|
||
("unknown1", ("I", 0x02010001)),
|
||
("total_length", ("I", 64)),
|
||
("total_number_of_tracks", ("I", 0)),
|
||
("total_number_of_playlists", ("I", 0)),
|
||
("unknown2", ("Q", 0)),
|
||
("max_volume", ("B", 0)),
|
||
("voiceover_enabled", ("B", int(self.voiceover))),
|
||
("unknown3", ("H", 0)),
|
||
("total_tracks_without_podcasts", ("I", 0)),
|
||
("track_header_offset", ("I", 64)),
|
||
("playlist_header_offset", ("I", 0)),
|
||
("unknown4", ("20s", "\x00" * 20)),
|
||
])
|
||
|
||
def construct(self):
|
||
# The header is a fixed length, so no need to precalculate it
|
||
self.track_header.base_offset = 64
|
||
track_header = self.track_header.construct()
|
||
|
||
# The playlist offset will depend on the number of tracks
|
||
self.play_header.base_offset = self.track_header.base_offset + len(track_header)
|
||
play_header = self.play_header.construct(self.track_header.tracks)
|
||
self["playlist_header_offset"] = self.play_header.base_offset
|
||
|
||
self["total_number_of_tracks"] = self.track_header["number_of_tracks"]
|
||
self["total_tracks_without_podcasts"] = self.track_header["number_of_tracks"]
|
||
self["total_number_of_playlists"] = self.play_header["number_of_playlists"]
|
||
|
||
output = Record.construct(self)
|
||
return output + track_header + play_header
|
||
|
||
class TrackHeader(Record):
|
||
def __init__(self, parent):
|
||
self.base_offset = 0
|
||
Record.__init__(self, parent)
|
||
self._struct = collections.OrderedDict([
|
||
("header_id", ("4s", "shth")),
|
||
("total_length", ("I", 0)),
|
||
("number_of_tracks", ("I", 0)),
|
||
("unknown1", ("Q", 0)),
|
||
])
|
||
|
||
def construct(self):
|
||
self["number_of_tracks"] = len(self.tracks)
|
||
self["total_length"] = 20 + (len(self.tracks) * 4)
|
||
output = Record.construct(self)
|
||
|
||
# Construct the underlying tracks
|
||
track_chunk = ""
|
||
for i in self.tracks:
|
||
track = Track(self)
|
||
print "[*] Adding track", i
|
||
track.populate(i)
|
||
output += struct.pack("I", self.base_offset + self["total_length"] + len(track_chunk))
|
||
track_chunk += track.construct()
|
||
return output + track_chunk
|
||
|
||
class Track(Record):
|
||
|
||
def __init__(self, parent):
|
||
Record.__init__(self, parent)
|
||
self._struct = collections.OrderedDict([
|
||
("header_id", ("4s", "shtr")),
|
||
("header_length", ("I", 0x174)),
|
||
("start_at_pos_ms", ("I", 0)),
|
||
("stop_at_pos_ms", ("I", 0)),
|
||
("volume_gain", ("I", int(self.trackgain))),
|
||
("filetype", ("I", 1)),
|
||
("filename", ("256s", "\x00" * 256)),
|
||
("bookmark", ("I", 0)),
|
||
("dontskip", ("B", 1)),
|
||
("remember", ("B", 0)),
|
||
("unintalbum", ("B", 0)),
|
||
("unknown", ("B", 0)),
|
||
("pregap", ("I", 0x200)),
|
||
("postgap", ("I", 0x200)),
|
||
("numsamples", ("I", 0)),
|
||
("unknown2", ("I", 0)),
|
||
("gapless", ("I", 0)),
|
||
("unknown3", ("I", 0)),
|
||
("albumid", ("I", 0)),
|
||
("track", ("H", 1)),
|
||
("disc", ("H", 0)),
|
||
("unknown4", ("Q", 0)),
|
||
("dbid", ("8s", 0)),
|
||
("artistid", ("I", 0)),
|
||
("unknown5", ("32s", "\x00" * 32)),
|
||
])
|
||
|
||
def populate(self, filename):
|
||
self["filename"] = self.path_to_ipod(filename)
|
||
|
||
if os.path.splitext(filename)[1].lower() in (".m4a", ".m4b", ".m4p", ".aa"):
|
||
self["filetype"] = 2
|
||
|
||
text = os.path.splitext(os.path.basename(filename))[0]
|
||
audio = mutagen.File(filename, easy = True)
|
||
if audio:
|
||
self["stop_at_pos_ms"] = int(audio.info.length * 1000)
|
||
|
||
artist = audio.get("artist", [u"Unknown"])[0]
|
||
if artist in self.artists:
|
||
self["artistid"] = self.artists.index(artist)
|
||
else:
|
||
self["artistid"] = len(self.artists)
|
||
self.artists.append(artist)
|
||
|
||
album = audio.get("album", [u"Unknown"])[0]
|
||
if album in self.albums:
|
||
self["albumid"] = self.albums.index(album)
|
||
else:
|
||
self["albumid"] = len(self.albums)
|
||
self.albums.append(album)
|
||
|
||
if audio.get("title", "") and audio.get("artist", ""):
|
||
text = u" - ".join(audio.get("title", u"") + audio.get("artist", u""))
|
||
|
||
# Handle the VoiceOverData
|
||
if isinstance(text, unicode):
|
||
text = text.encode('utf-8', 'ignore')
|
||
self["dbid"] = hashlib.md5(text).digest()[:8] #pylint: disable-msg=E1101
|
||
self.text_to_speech(text, self["dbid"])
|
||
|
||
class PlaylistHeader(Record):
|
||
def __init__(self, parent):
|
||
self.base_offset = 0
|
||
Record.__init__(self, parent)
|
||
self._struct = collections.OrderedDict([
|
||
("header_id", ("4s", "shph")),
|
||
("total_length", ("I", 0)),
|
||
("number_of_playlists", ("I", 0)),
|
||
("number_of_podcast_lists", ("I", 0xffffffff)),
|
||
("number_of_master_lists", ("I", 0)),
|
||
("number_of_audiobook_lists", ("I", 0xffffffff)),
|
||
("unknown1", ("I", 0)),
|
||
("unknown2", ("I", 0xffffffff)),
|
||
("unknown3", ("I", 0)),
|
||
("unknown4", ("I", 0xffffffff)),
|
||
("unknown5", ("I", 0)),
|
||
("unknown6", ("I", 0xffffffff)),
|
||
("unknown7", ("20s", "\x00" * 20)),
|
||
])
|
||
|
||
def construct(self, tracks): #pylint: disable-msg=W0221
|
||
# Build the master list
|
||
masterlist = Playlist(self)
|
||
print "[+] Adding master playlist"
|
||
masterlist.set_master(tracks)
|
||
chunks = [masterlist.construct(tracks)]
|
||
|
||
# Build all the remaining playlists
|
||
playlistcount = 1
|
||
for i in self.lists:
|
||
playlist = Playlist(self)
|
||
print "[+] Adding playlist", i
|
||
playlist.populate(i)
|
||
construction = playlist.construct(tracks)
|
||
if playlist["number_of_songs"] > 0:
|
||
playlistcount += 1
|
||
chunks += [construction]
|
||
|
||
self["number_of_playlists"] = playlistcount
|
||
self["number_of_master_lists"] = 0
|
||
self["total_length"] = 0x44 + (self["number_of_playlists"] * 4)
|
||
# Start the header
|
||
|
||
output = Record.construct(self)
|
||
offset = self.base_offset + self["total_length"]
|
||
|
||
for i in range(len(chunks)):
|
||
output += struct.pack("I", offset)
|
||
offset += len(chunks[i])
|
||
|
||
return output + "".join(chunks)
|
||
|
||
class Playlist(Record):
|
||
def __init__(self, parent):
|
||
self.listtracks = []
|
||
Record.__init__(self, parent)
|
||
self._struct = collections.OrderedDict([
|
||
("header_id", ("4s", "shpl")),
|
||
("total_length", ("I", 0)),
|
||
("number_of_songs", ("I", 0)),
|
||
("number_of_nonaudio", ("I", 0)),
|
||
("dbid", ("8s", "\x00" * 8)),
|
||
("listtype", ("I", 2)),
|
||
("unknown1", ("16s", "\x00" * 16))
|
||
])
|
||
|
||
def set_master(self, tracks):
|
||
self["dbid"] = hashlib.md5("masterlist").digest()[:8] #pylint: disable-msg=E1101
|
||
self["listtype"] = 1
|
||
self.text_to_speech("All songs", self["dbid"], True)
|
||
self.listtracks = tracks
|
||
|
||
def populate_m3u(self, data):
|
||
listtracks = []
|
||
for i in data:
|
||
if not i.startswith("#"):
|
||
path = i.strip()
|
||
if self.rename:
|
||
path = validate_unicode(path)
|
||
listtracks.append(path)
|
||
return listtracks
|
||
|
||
def populate_pls(self, data):
|
||
sorttracks = []
|
||
for i in data:
|
||
dataarr = i.strip().split("=", 1)
|
||
if dataarr[0].lower().startswith("file"):
|
||
num = int(dataarr[0][4:])
|
||
filename = urllib.unquote(dataarr[1]).strip()
|
||
if filename.lower().startswith('file://'):
|
||
filename = filename[7:]
|
||
if self.rename:
|
||
filename = validate_unicode(filename)
|
||
sorttracks.append((num, filename))
|
||
listtracks = [ x for (_, x) in sorted(sorttracks) ]
|
||
return listtracks
|
||
|
||
def remove_relatives(self, relative, filename):
|
||
base = os.path.dirname(os.path.abspath(filename))
|
||
if not os.path.exists(relative):
|
||
relative = os.path.join(base, relative)
|
||
fullPath = relative
|
||
ipodpath = self.parent.parent.parent.path
|
||
relPath = fullPath[fullPath.index(ipodpath)+len(ipodpath)+1:].lower()
|
||
fullPath = os.path.abspath(os.path.join(ipodpath, relPath))
|
||
return fullPath
|
||
|
||
def populate(self, filename):
|
||
f = open(filename, "rb")
|
||
data = f.readlines()
|
||
f.close()
|
||
|
||
extension = os.path.splitext(filename)[1].lower()
|
||
if extension == '.pls':
|
||
self.listtracks = self.populate_pls(data)
|
||
elif extension == '.m3u':
|
||
self.listtracks = self.populate_m3u(data)
|
||
# Ensure all paths are not relative to the playlist file
|
||
for i in range(len(self.listtracks)):
|
||
self.listtracks[i] = self.remove_relatives(self.listtracks[i], filename)
|
||
|
||
# Handle the VoiceOverData
|
||
text = os.path.splitext(os.path.basename(filename))[0]
|
||
self["dbid"] = hashlib.md5(text).digest()[:8] #pylint: disable-msg=E1101
|
||
self.text_to_speech(text, self["dbid"], True)
|
||
|
||
def construct(self, tracks): #pylint: disable-msg=W0221
|
||
self["total_length"] = 44 + (4 * len(self.listtracks))
|
||
self["number_of_songs"] = 0
|
||
|
||
chunks = ""
|
||
for i in self.listtracks:
|
||
try:
|
||
position = tracks.index(self.ipod_to_path(i))
|
||
except:
|
||
print tracks
|
||
raise
|
||
if position > -1:
|
||
chunks += struct.pack("I", position)
|
||
self["number_of_songs"] += 1
|
||
self["number_of_nonaudio"] = self["number_of_songs"]
|
||
|
||
output = Record.construct(self)
|
||
return output + chunks
|
||
|
||
class Shuffler(object):
|
||
def __init__(self, path, voiceover=True, rename=False, trackgain=0):
|
||
self.path, self.base = self.determine_base(path)
|
||
self.tracks = []
|
||
self.albums = []
|
||
self.artists = []
|
||
self.lists = []
|
||
self.tunessd = None
|
||
self.voiceover = voiceover
|
||
self.rename = rename
|
||
self.trackgain = trackgain
|
||
|
||
def initialize(self):
|
||
# remove existing voiceover files (they are either useless or will be overwritten anyway)
|
||
for dirname in ('iPod_Control/Speakable/Playlists', 'iPod_Control/Speakable/Tracks'):
|
||
shutil.rmtree(os.path.join(self.path, dirname), ignore_errors=True)
|
||
for dirname in ('iPod_Control/iTunes', 'iPod_Control/Music', 'iPod_Control/Speakable/Playlists', 'iPod_Control/Speakable/Tracks'):
|
||
make_dir_if_absent(os.path.join(self.path, dirname))
|
||
|
||
def dump_state(self):
|
||
print "Shuffle DB state"
|
||
print "Tracks", self.tracks
|
||
print "Albums", self.albums
|
||
print "Artists", self.artists
|
||
print "Playlists", self.lists
|
||
|
||
def determine_base(self, path):
|
||
base = os.path.abspath(path)
|
||
# while not os.path.ismount(base):
|
||
# base = os.path.dirname(base)
|
||
return base, base
|
||
|
||
def populate(self):
|
||
self.tunessd = TunesSD(self)
|
||
for (dirpath, dirnames, filenames) in os.walk(self.path):
|
||
dirnames.sort()
|
||
# Ignore the speakable directory and any hidden directories
|
||
if "ipod_control/speakable" not in dirpath.lower() and "/." not in dirpath.lower():
|
||
for filename in sorted(filenames, key = lambda x: x.lower()):
|
||
fullPath = os.path.abspath(os.path.join(dirpath, filename))
|
||
relPath = fullPath[fullPath.index(self.path)+len(self.path)+1:].lower()
|
||
fullPath = os.path.abspath(os.path.join(self.path, relPath));
|
||
if os.path.splitext(filename)[1].lower() in (".mp3", ".m4a", ".m4b", ".m4p", ".aa", ".wav"):
|
||
self.tracks.append(fullPath)
|
||
if os.path.splitext(filename)[1].lower() in (".pls", ".m3u"):
|
||
self.lists.append(os.path.abspath(os.path.join(dirpath, filename)))
|
||
|
||
def write_database(self):
|
||
f = open(os.path.join(self.base, "iPod_Control", "iTunes", "iTunesSD"), "wb")
|
||
f.write(self.tunessd.construct())
|
||
f.close()
|
||
|
||
#
|
||
# Read all files from the directory
|
||
# Construct the appropriate iTunesDB file
|
||
# Construct the appropriate iTunesSD file
|
||
# http://shuffle3db.wikispaces.com/iTunesSD3gen
|
||
# Use SVOX pico2wave and RHVoice to produce voiceover data
|
||
#
|
||
|
||
def check_unicode(path):
|
||
ret_flag = False # True if there is a recognizable file within this level
|
||
for item in os.listdir(path):
|
||
if os.path.isfile(os.path.join(path, item)):
|
||
if os.path.splitext(item)[1].lower() in audio_ext+list_ext:
|
||
ret_flag = True
|
||
if raises_unicode_error(item):
|
||
src = os.path.join(path, item)
|
||
dest = os.path.join(path, hash_error_unicode(item)) + os.path.splitext(item)[1].lower()
|
||
print 'Renaming %s -> %s' % (src, dest)
|
||
os.rename(src, dest)
|
||
else:
|
||
ret_flag = (check_unicode(os.path.join(path, item)) or ret_flag)
|
||
if ret_flag and raises_unicode_error(item):
|
||
src = os.path.join(path, item)
|
||
new_name = hash_error_unicode(item)
|
||
dest = os.path.join(path, new_name)
|
||
print 'Renaming %s -> %s' % (src, dest)
|
||
os.rename(src, dest)
|
||
return ret_flag
|
||
|
||
def nonnegative_int(string):
|
||
try:
|
||
intval = int(string)
|
||
except ValueError:
|
||
raise argparse.ArgumentTypeError("'%s' must be an integer" % string)
|
||
|
||
if intval < 0 or intval > 99:
|
||
raise argparse.ArgumentTypeError("Track gain value should be in range 0-99")
|
||
return intval
|
||
|
||
if __name__ == '__main__':
|
||
parser = argparse.ArgumentParser()
|
||
parser.add_argument('--disable-voiceover', action='store_true', help='Disable Voiceover Feature')
|
||
parser.add_argument('--rename-unicode', action='store_true', help='Rename Files Causing Unicode Errors, will do minimal required renaming')
|
||
parser.add_argument('--track-gain', type=nonnegative_int, default=0, help='Specify volume gain (0-99) for all tracks; 0 (default) means no gain and is usually fine; e.g. 60 is very loud even on minimal player volume')
|
||
parser.add_argument('path')
|
||
result = parser.parse_args()
|
||
|
||
if result.rename_unicode:
|
||
check_unicode(result.path)
|
||
|
||
if not result.disable_voiceover:
|
||
Text2Speech.check_support()
|
||
|
||
shuffle = Shuffler(result.path, voiceover=not result.disable_voiceover, rename=result.rename_unicode, trackgain=result.track_gain)
|
||
shuffle.initialize()
|
||
shuffle.populate()
|
||
shuffle.write_database()
|