From 406050c3820e2380e84c14db0a3c47d37fb850c2 Mon Sep 17 00:00:00 2001
From: NicoHood <nicohood@users.noreply.github.com>
Date: Sat, 27 Aug 2016 15:34:20 +0200
Subject: [PATCH 01/17] Inlined inverting of header bytes

---
 ipod-shuffle-4g.py | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 0f0b773..54a15cc 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -207,8 +207,6 @@ class Record(object):
         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
 
@@ -265,7 +263,7 @@ class TunesSD(Record):
         self.track_header = TrackHeader(self)
         self.play_header = PlaylistHeader(self)
         self._struct = collections.OrderedDict([
-                           ("header_id", ("4s", "shdb")),
+                           ("header_id", ("4s", "bdhs")), # shdb
                            ("unknown1", ("I", 0x02000003)),
                            ("total_length", ("I", 64)),
                            ("total_number_of_tracks", ("I", 0)),
@@ -302,7 +300,7 @@ class TrackHeader(Record):
         self.base_offset = 0
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                           ("header_id", ("4s", "shth")),
+                           ("header_id", ("4s", "hths")), # shth
                            ("total_length", ("I", 0)),
                            ("number_of_tracks", ("I", 0)),
                            ("unknown1", ("Q", 0)),
@@ -328,7 +326,7 @@ class Track(Record):
     def __init__(self, parent):
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                           ("header_id", ("4s", "shtr")),
+                           ("header_id", ("4s", "rths")), # shtr
                            ("header_length", ("I", 0x174)),
                            ("start_at_pos_ms", ("I", 0)),
                            ("stop_at_pos_ms", ("I", 0)),
@@ -399,7 +397,7 @@ class PlaylistHeader(Record):
         self.base_offset = 0
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                          ("header_id", ("4s", "shph")),
+                          ("header_id", ("4s", "hphs")), #shph
                           ("total_length", ("I", 0)),
                           ("number_of_playlists", ("I", 0)),
                           ("number_of_non_podcast_lists", ("2s", "\xFF\xFF")),
@@ -446,7 +444,7 @@ class Playlist(Record):
         self.listtracks = []
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                          ("header_id", ("4s", "shpl")),
+                          ("header_id", ("4s", "lphs")), # shpl
                           ("total_length", ("I", 0)),
                           ("number_of_songs", ("I", 0)),
                           ("number_of_nonaudio", ("I", 0)),

From bfb4d11027f66bbbc596943ef0b73b1c8eb84442 Mon Sep 17 00:00:00 2001
From: NicoHood <nicohood@users.noreply.github.com>
Date: Sat, 27 Aug 2016 17:42:01 +0200
Subject: [PATCH 02/17] 2to3 autoconvert

---
 ipod-shuffle-4g.py | 82 +++++++++++++++++++++++-----------------------
 1 file changed, 41 insertions(+), 41 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 54a15cc..895cae8 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 import sys
 import struct
-import urllib
+import urllib.request, urllib.parse, urllib.error
 import os
 import hashlib
 import mutagen
@@ -39,7 +39,7 @@ def hash_error_unicode(item):
 def validate_unicode(path):
     path_list = path.split('/')
     last_raise = False
-    for i in xrange(len(path_list)):
+    for i in range(len(path_list)):
         if raises_unicode_error(path_list[i]):
             path_list[i] = hash_error_unicode(path_list[i])
             last_raise = True
@@ -61,11 +61,11 @@ def splitpath(path):
     return path.split(os.sep)
 
 def get_relpath(path, basepath):
-    commonprefix = os.sep.join(os.path.commonprefix(map(splitpath, [path, basepath])))
+    commonprefix = os.sep.join(os.path.commonprefix(list(map(splitpath, [path, basepath]))))
     return os.path.relpath(path, commonprefix)
 
 def is_path_prefix(prefix, path):
-    return prefix == os.sep.join(os.path.commonprefix(map(splitpath, [prefix, path])))
+    return prefix == os.sep.join(os.path.commonprefix(list(map(splitpath, [prefix, path]))))
 
 def group_tracks_by_id3_template(tracks, template):
     grouped_tracks_dict = {}
@@ -101,21 +101,21 @@ class Text2Speech(object):
         # Check for pico2wave voiceover
         if not exec_exists_in_path("pico2wave"):
             Text2Speech.valid_tts['pico2wave'] = False
-            print "Warning: pico2wave not found, voicever won't be generated using it."
+            print("Warning: pico2wave not found, voicever won't be generated using it.")
         else:
             voiceoverAvailable = True
 
         # Check for espeak voiceover
         if not exec_exists_in_path("espeak"):
             Text2Speech.valid_tts['espeak'] = False
-            print "Warning: espeak not found, voicever won't be generated using it."
+            print("Warning: espeak not found, voicever won't be generated using it.")
         else:
             voiceoverAvailable = True
 
         # Check for Russian RHVoice voiceover
         if not exec_exists_in_path("RHVoice"):
             Text2Speech.valid_tts['RHVoice'] = False
-            print "Warning: RHVoice not found, Russian voicever won't be generated."
+            print("Warning: RHVoice not found, Russian voicever won't be generated.")
         else:
             voiceoverAvailable = True
 
@@ -132,8 +132,8 @@ class Text2Speech(object):
             return True
 
         # ensure we deal with unicode later
-        if not isinstance(text, unicode):
-            text = unicode(text, 'utf-8')
+        if not isinstance(text, str):
+            text = str(text, 'utf-8')
         lang = Text2Speech.guess_lang(text)
         if lang == "ru-RU":
             return Text2Speech.rhvoice(out_wav_path, text)
@@ -149,7 +149,7 @@ class Text2Speech(object):
     @staticmethod
     def guess_lang(unicodetext):
         lang = 'en-GB'
-        if re.search(u"[А-Яа-я]", unicodetext) is not None:
+        if re.search("[А-Яа-я]", unicodetext) is not None:
             lang = 'ru-RU'
         return lang
 
@@ -196,7 +196,7 @@ class Record(object):
         self.trackgain = parent.trackgain
 
     def __getitem__(self, item):
-        if item not in self._struct.keys():
+        if item not in list(self._struct.keys()):
             raise KeyError
         return self._fields.get(item, self._struct[item][1])
 
@@ -205,7 +205,7 @@ class Record(object):
 
     def construct(self):
         output = ""
-        for i in self._struct.keys():
+        for i in list(self._struct.keys()):
             (fmt, default) = self._struct[i]
             output += struct.pack("<" + fmt, self._fields.get(i, default))
         return output
@@ -364,19 +364,19 @@ class Track(Record):
         try:
             audio = mutagen.File(filename, easy = True)
         except:
-            print "Error calling mutagen. Possible invalid filename/ID3Tags (hyphen in filename?)"
+            print("Error calling mutagen. Possible invalid filename/ID3Tags (hyphen in filename?)")
         if audio:
             # Note: Rythmbox IPod plugin sets this value always 0.
             self["stop_at_pos_ms"] = int(audio.info.length * 1000)
 
-            artist = audio.get("artist", [u"Unknown"])[0]
+            artist = audio.get("artist", ["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]
+            album = audio.get("album", ["Unknown"])[0]
             if album in self.albums:
                 self["albumid"] = self.albums.index(album)
             else:
@@ -384,10 +384,10 @@ class Track(Record):
                 self.albums.append(album)
 
             if audio.get("title", "") and audio.get("artist", ""):
-                text = u" - ".join(audio.get("title", u"") + audio.get("artist", u""))
+                text = " - ".join(audio.get("title", "") + audio.get("artist", ""))
 
         # Handle the VoiceOverData
-        if isinstance(text, unicode):
+        if isinstance(text, str):
             text = text.encode('utf-8', 'ignore')
         self["dbid"] = hashlib.md5(text).digest()[:8] #pylint: disable-msg=E1101
         self.text_to_speech(text, self["dbid"])
@@ -424,7 +424,7 @@ class PlaylistHeader(Record):
                 playlistcount += 1
                 chunks += [construction]
             else:
-                print "Error: Playlist does not contain a single track. Skipping playlist."
+                print("Error: Playlist does not contain a single track. Skipping playlist.")
 
         self["number_of_playlists"] = playlistcount
         self["total_length"] = 0x14 + (self["number_of_playlists"] * 4)
@@ -478,7 +478,7 @@ class Playlist(Record):
             dataarr = i.strip().split("=", 1)
             if dataarr[0].lower().startswith("file"):
                 num = int(dataarr[0][4:])
-                filename = urllib.unquote(dataarr[1]).strip()
+                filename = urllib.parse.unquote(dataarr[1]).strip()
                 if filename.lower().startswith('file://'):
                     filename = filename[7:]
                 if self.rename:
@@ -559,8 +559,8 @@ class Playlist(Record):
             except:
                 # Print an error if no track was found.
                 # Empty playlists are handeled in the PlaylistHeader class.
-                print "Error: Could not find track \"" + path + "\"."
-                print "Maybe its an invalid FAT filesystem name. Please fix your playlist. Skipping track."
+                print("Error: Could not find track \"" + path + "\".")
+                print("Maybe its an invalid FAT filesystem name. Please fix your playlist. Skipping track.")
             if position > -1:
                 chunks += struct.pack("I", position)
                 self["number_of_songs"] += 1
@@ -592,11 +592,11 @@ class Shuffler(object):
           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
+        print("Shuffle DB state")
+        print("Tracks", self.tracks)
+        print("Albums", self.albums)
+        print("Artists", self.artists)
+        print("Playlists", self.lists)
 
     def populate(self):
         self.tunessd = TunesSD(self)
@@ -631,14 +631,14 @@ class Shuffler(object):
             try:
                 f.write(self.tunessd.construct())
             except IOError as e:
-                print "I/O error({0}): {1}".format(e.errno, e.strerror)
-                print "Error: Writing iPod database failed."
+                print("I/O error({0}): {1}".format(e.errno, e.strerror))
+                print("Error: Writing iPod database failed.")
                 sys.exit(1)
-        print "Database written successfully:"
-        print "Tracks", len(self.tracks)
-        print "Albums", len(self.albums)
-        print "Artists", len(self.artists)
-        print "Playlists", len(self.lists)
+        print("Database written successfully:")
+        print("Tracks", len(self.tracks))
+        print("Albums", len(self.albums))
+        print("Artists", len(self.artists))
+        print("Playlists", len(self.lists))
 
 #
 # Read all files from the directory
@@ -657,7 +657,7 @@ def check_unicode(path):
                 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)
+                    print('Renaming %s -> %s' % (src, dest))
                     os.rename(src, dest)
         else:
             ret_flag = (check_unicode(os.path.join(path, item)) or ret_flag)
@@ -665,7 +665,7 @@ def check_unicode(path):
                 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)
+                print('Renaming %s -> %s' % (src, dest))
                 os.rename(src, dest)
     return ret_flag
 
@@ -681,15 +681,15 @@ def nonnegative_int(string):
 
 def checkPathValidity(path):
     if not os.path.isdir(result.path):
-        print "Error finding IPod directory. Maybe it is not connected or mounted?"
+        print("Error finding IPod directory. Maybe it is not connected or mounted?")
         sys.exit(1)
 
     if not os.access(result.path, os.W_OK):
-        print 'Unable to get write permissions in the IPod directory'
+        print('Unable to get write permissions in the IPod directory')
         sys.exit(1)
 
 def handle_interrupt(signal, frame):
-    print "Interrupt detected, exiting..."
+    print("Interrupt detected, exiting...")
     sys.exit(1)
 
 if __name__ == '__main__':
@@ -741,8 +741,8 @@ if __name__ == '__main__':
             # Print each argument separately so caller doesn't need to
             # stuff everything to be printed into a single string
             for arg in args:
-               print arg,
-            print
+               print(arg, end=' ')
+            print()
     else:
         verboseprint = lambda *a: None      # do-nothing function
 
@@ -755,7 +755,7 @@ if __name__ == '__main__':
     verboseprint("Track voiceover requested:", result.track_voiceover)
     if (result.track_voiceover or result.playlist_voiceover):
         if not Text2Speech.check_support():
-            print "Error: Did not find any voiceover program. Voiceover disabled."
+            print("Error: Did not find any voiceover program. Voiceover disabled.")
             result.track_voiceover = False
             result.playlist_voiceover = False
         else:

From a21b0a2fe1868c19dbd0b7bee018d5161ceb8cf7 Mon Sep 17 00:00:00 2001
From: NicoHood <nicohood@users.noreply.github.com>
Date: Sat, 27 Aug 2016 18:08:16 +0200
Subject: [PATCH 03/17] Fixed 2to3 conversion errors

---
 ipod-shuffle-4g.py | 59 +++++++++++++++++++---------------------------
 1 file changed, 24 insertions(+), 35 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 895cae8..0c9f6c9 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -1,5 +1,4 @@
-#!/usr/bin/env python2.7
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python3
 import sys
 import struct
 import urllib.request, urllib.parse, urllib.error
@@ -204,7 +203,7 @@ class Record(object):
         self._fields[item] = value
 
     def construct(self):
-        output = ""
+        output = bytes()
         for i in list(self._struct.keys()):
             (fmt, default) = self._struct[i]
             output += struct.pack("<" + fmt, self._fields.get(i, default))
@@ -213,7 +212,7 @@ class Record(object):
     def text_to_speech(self, text, dbid, playlist = False):
         if self.track_voiceover and not playlist or self.playlist_voiceover and playlist:
             # Create the voiceover wav file
-            fn = "".join(["{0:02X}".format(ord(x)) for x in reversed(dbid)])
+            fn = ''.join(format(x, '02x') for x in reversed(dbid))
             path = os.path.join(self.base, "iPod_Control", "Speakable", "Tracks" if not playlist else "Playlists", fn + ".wav")
             return Text2Speech.text2speech(path, text)
         return False
@@ -263,7 +262,7 @@ class TunesSD(Record):
         self.track_header = TrackHeader(self)
         self.play_header = PlaylistHeader(self)
         self._struct = collections.OrderedDict([
-                           ("header_id", ("4s", "bdhs")), # shdb
+                           ("header_id", ("4s", b"bdhs")), # shdb
                            ("unknown1", ("I", 0x02000003)),
                            ("total_length", ("I", 64)),
                            ("total_number_of_tracks", ("I", 0)),
@@ -275,7 +274,7 @@ class TunesSD(Record):
                            ("total_tracks_without_podcasts", ("I", 0)),
                            ("track_header_offset", ("I", 64)),
                            ("playlist_header_offset", ("I", 0)),
-                           ("unknown4", ("20s", "\x00" * 20)),
+                           ("unknown4", ("20s", b"\x00" * 20)),
                                                ])
 
     def construct(self):
@@ -300,7 +299,7 @@ class TrackHeader(Record):
         self.base_offset = 0
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                           ("header_id", ("4s", "hths")), # shth
+                           ("header_id", ("4s", b"hths")), # shth
                            ("total_length", ("I", 0)),
                            ("number_of_tracks", ("I", 0)),
                            ("unknown1", ("Q", 0)),
@@ -312,7 +311,7 @@ class TrackHeader(Record):
         output = Record.construct(self)
 
         # Construct the underlying tracks
-        track_chunk = ""
+        track_chunk = bytes()
         for i in self.tracks:
             track = Track(self)
             verboseprint("[*] Adding track", i)
@@ -326,13 +325,13 @@ class Track(Record):
     def __init__(self, parent):
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                           ("header_id", ("4s", "rths")), # shtr
+                           ("header_id", ("4s", b"rths")), # 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)),
+                           ("filename", ("256s", b"\x00" * 256)),
                            ("bookmark", ("I", 0)),
                            ("dontskip", ("B", 1)),
                            ("remember", ("B", 0)),
@@ -350,11 +349,11 @@ class Track(Record):
                            ("unknown4", ("Q", 0)),
                            ("dbid", ("8s", 0)),
                            ("artistid", ("I", 0)),
-                           ("unknown5", ("32s", "\x00" * 32)),
+                           ("unknown5", ("32s", b"\x00" * 32)),
                            ])
 
     def populate(self, filename):
-        self["filename"] = self.path_to_ipod(filename)
+        self["filename"] = self.path_to_ipod(filename).encode('utf-8')
 
         if os.path.splitext(filename)[1].lower() in (".m4a", ".m4b", ".m4p", ".aa"):
             self["filetype"] = 2
@@ -397,13 +396,13 @@ class PlaylistHeader(Record):
         self.base_offset = 0
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                          ("header_id", ("4s", "hphs")), #shph
+                          ("header_id", ("4s", b"hphs")), #shph
                           ("total_length", ("I", 0)),
                           ("number_of_playlists", ("I", 0)),
-                          ("number_of_non_podcast_lists", ("2s", "\xFF\xFF")),
-                          ("number_of_master_lists", ("2s", "\x01\x00")),
-                          ("number_of_non_audiobook_lists", ("2s", "\xFF\xFF")),
-                          ("unknown2", ("2s", "\x00" * 2)),
+                          ("number_of_non_podcast_lists", ("2s", b"\xFF\xFF")),
+                          ("number_of_master_lists", ("2s", b"\x01\x00")),
+                          ("number_of_non_audiobook_lists", ("2s", b"\xFF\xFF")),
+                          ("unknown2", ("2s", b"\x00" * 2)),
                                               ])
 
     def construct(self, tracks): #pylint: disable-msg=W0221
@@ -437,27 +436,27 @@ class PlaylistHeader(Record):
             output += struct.pack("I", offset)
             offset += len(chunks[i])
 
-        return output + "".join(chunks)
+        return output + b"".join(chunks)
 
 class Playlist(Record):
     def __init__(self, parent):
         self.listtracks = []
         Record.__init__(self, parent)
         self._struct = collections.OrderedDict([
-                          ("header_id", ("4s", "lphs")), # shpl
+                          ("header_id", ("4s", b"lphs")), # shpl
                           ("total_length", ("I", 0)),
                           ("number_of_songs", ("I", 0)),
                           ("number_of_nonaudio", ("I", 0)),
-                          ("dbid", ("8s", "\x00" * 8)),
+                          ("dbid", ("8s", b"\x00" * 8)),
                           ("listtype", ("I", 2)),
-                          ("unknown1", ("16s", "\x00" * 16))
+                          ("unknown1", ("16s", b"\x00" * 16))
                                               ])
 
     def set_master(self, tracks):
         # By default use "All Songs" builtin voiceover (dbid all zero)
         # Else generate alternative "All Songs" to fit the speaker voice of other playlists
         if self.playlist_voiceover and (Text2Speech.valid_tts['pico2wave'] or Text2Speech.valid_tts['espeak']):
-            self["dbid"] = hashlib.md5("masterlist").digest()[:8] #pylint: disable-msg=E1101
+            self["dbid"] = hashlib.md5(b"masterlist").digest()[:8] #pylint: disable-msg=E1101
             self.text_to_speech("All songs", self["dbid"], True)
         self["listtype"] = 1
         self.listtracks = tracks
@@ -543,14 +542,14 @@ class Playlist(Record):
                 text = os.path.splitext(os.path.basename(filename))[0]
 
         # Handle the VoiceOverData
-        self["dbid"] = hashlib.md5(text).digest()[:8] #pylint: disable-msg=E1101
+        self["dbid"] = hashlib.md5(text.encode('utf-8')).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 = ""
+        chunks = bytes()
         for i in self.listtracks:
             path = self.ipod_to_path(i)
             position = -1
@@ -734,17 +733,7 @@ if __name__ == '__main__':
     result = parser.parse_args()
 
     # Enable verbose printing if desired
-    # Smaller version for python3 available.
-    # See https://stackoverflow.com/questions/5980042/how-to-implement-the-verbose-or-v-option-into-a-script
-    if result.verbose:
-        def verboseprint(*args):
-            # Print each argument separately so caller doesn't need to
-            # stuff everything to be printed into a single string
-            for arg in args:
-               print(arg, end=' ')
-            print()
-    else:
-        verboseprint = lambda *a: None      # do-nothing function
+    verboseprint = print if result.verbose else lambda *a, **k: None
 
     checkPathValidity(result.path)
 

From 3ff22a49504df9158ce085718781616421fa974f Mon Sep 17 00:00:00 2001
From: NicoHood <nicohood@users.noreply.github.com>
Date: Sat, 27 Aug 2016 21:02:59 +0200
Subject: [PATCH 04/17] Made mutagen import optional

---
 ipod-shuffle-4g.py | 70 +++++++++++++++++++++++++++++-----------------
 1 file changed, 44 insertions(+), 26 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 0c9f6c9..e61f642 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -1,11 +1,11 @@
 #!/usr/bin/env python3
+
+# Builtin libraries
 import sys
 import struct
 import urllib.request, urllib.parse, urllib.error
 import os
 import hashlib
-import mutagen
-import binascii
 import subprocess
 import collections
 import errno
@@ -15,6 +15,12 @@ import re
 import tempfile
 import signal
 
+# External libraries
+try:
+    import mutagen
+except ImportError:
+    mutagen = None
+
 audio_ext = (".mp3", ".m4a", ".m4b", ".m4p", ".aa", ".wav")
 list_ext = (".pls", ".m3u")
 def make_dir_if_absent(path):
@@ -359,31 +365,34 @@ class Track(Record):
             self["filetype"] = 2
 
         text = os.path.splitext(os.path.basename(filename))[0]
-        audio = None
-        try:
-            audio = mutagen.File(filename, easy = True)
-        except:
-            print("Error calling mutagen. Possible invalid filename/ID3Tags (hyphen in filename?)")
-        if audio:
-            # Note: Rythmbox IPod plugin sets this value always 0.
-            self["stop_at_pos_ms"] = int(audio.info.length * 1000)
 
-            artist = audio.get("artist", ["Unknown"])[0]
-            if artist in self.artists:
-                self["artistid"] = self.artists.index(artist)
-            else:
-                self["artistid"] = len(self.artists)
-                self.artists.append(artist)
+        # Try to get album and artist information with mutagen
+        if mutagen:
+            audio = None
+            try:
+                audio = mutagen.File(filename, easy = True)
+            except:
+                print("Error calling mutagen. Possible invalid filename/ID3Tags (hyphen in filename?)")
+            if audio:
+                # Note: Rythmbox IPod plugin sets this value always 0.
+                self["stop_at_pos_ms"] = int(audio.info.length * 1000)
 
-            album = audio.get("album", ["Unknown"])[0]
-            if album in self.albums:
-                self["albumid"] = self.albums.index(album)
-            else:
-                self["albumid"] = len(self.albums)
-                self.albums.append(album)
+                artist = audio.get("artist", ["Unknown"])[0]
+                if artist in self.artists:
+                    self["artistid"] = self.artists.index(artist)
+                else:
+                    self["artistid"] = len(self.artists)
+                    self.artists.append(artist)
 
-            if audio.get("title", "") and audio.get("artist", ""):
-                text = " - ".join(audio.get("title", "") + audio.get("artist", ""))
+                album = audio.get("album", ["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 = " - ".join(audio.get("title", "") + audio.get("artist", ""))
 
         # Handle the VoiceOverData
         if isinstance(text, str):
@@ -622,10 +631,15 @@ class Shuffler(object):
                     self.lists.append(os.path.abspath(dirpath))
 
         if self.auto_id3_playlists != None:
-            for grouped_list in group_tracks_by_id3_template(self.tracks, self.auto_id3_playlists):
-                self.lists.append(grouped_list)
+            if mutagen:
+                for grouped_list in group_tracks_by_id3_template(self.tracks, self.auto_id3_playlists):
+                    self.lists.append(grouped_list)
+            else:
+                print("Error: No mutagen found. Cannot generate auto-id3-playlists.")
+                sys.exit(1)
 
     def write_database(self):
+        print("Writing database. This may take a while...")
         with open(os.path.join(self.path, "iPod_Control", "iTunes", "iTunesSD"), "wb") as f:
             try:
                 f.write(self.tunessd.construct())
@@ -633,6 +647,7 @@ class Shuffler(object):
                 print("I/O error({0}): {1}".format(e.errno, e.strerror))
                 print("Error: Writing iPod database failed.")
                 sys.exit(1)
+
         print("Database written successfully:")
         print("Tracks", len(self.tracks))
         print("Albums", len(self.albums))
@@ -740,6 +755,9 @@ if __name__ == '__main__':
     if result.rename_unicode:
         check_unicode(result.path)
 
+    if not mutagen:
+        print("Warning: No mutagen found. Database will not contain any album nor artist information.")
+
     verboseprint("Playlist voiceover requested:", result.playlist_voiceover)
     verboseprint("Track voiceover requested:", result.track_voiceover)
     if (result.track_voiceover or result.playlist_voiceover):

From c22837ba40a22082ea7adb33764df30b0acee5e7 Mon Sep 17 00:00:00 2001
From: NicoHood <nicohood@users.noreply.github.com>
Date: Sat, 27 Aug 2016 21:03:25 +0200
Subject: [PATCH 05/17] Some style cleanup

---
 ipod-shuffle-4g.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index e61f642..210b07b 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -768,7 +768,13 @@ if __name__ == '__main__':
         else:
             verboseprint("Voiceover available.")
 
-    shuffle = Shuffler(result.path, track_voiceover=result.track_voiceover, playlist_voiceover=result.playlist_voiceover, rename=result.rename_unicode, trackgain=result.track_gain, auto_dir_playlists=result.auto_dir_playlists, auto_id3_playlists=result.auto_id3_playlists)
+    shuffle = Shuffler(result.path,
+                       track_voiceover=result.track_voiceover,
+                       playlist_voiceover=result.playlist_voiceover,
+                       rename=result.rename_unicode,
+                       trackgain=result.track_gain,
+                       auto_dir_playlists=result.auto_dir_playlists,
+                       auto_id3_playlists=result.auto_id3_playlists)
     shuffle.initialize()
     shuffle.populate()
     shuffle.write_database()

From 8bfea0be3fc5327bc37b85d36f99d2829dd3ffbc Mon Sep 17 00:00:00 2001
From: NicoHood <nicohood@users.noreply.github.com>
Date: Sat, 27 Aug 2016 21:16:14 +0200
Subject: [PATCH 06/17] removed pylint comments

---
 ipod-shuffle-4g.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 210b07b..62e6052 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -397,7 +397,7 @@ class Track(Record):
         # Handle the VoiceOverData
         if isinstance(text, str):
             text = text.encode('utf-8', 'ignore')
-        self["dbid"] = hashlib.md5(text).digest()[:8] #pylint: disable-msg=E1101
+        self["dbid"] = hashlib.md5(text).digest()[:8]
         self.text_to_speech(text, self["dbid"])
 
 class PlaylistHeader(Record):
@@ -414,7 +414,7 @@ class PlaylistHeader(Record):
                           ("unknown2", ("2s", b"\x00" * 2)),
                                               ])
 
-    def construct(self, tracks): #pylint: disable-msg=W0221
+    def construct(self, tracks):
         # Build the master list
         masterlist = Playlist(self)
         verboseprint("[+] Adding master playlist")
@@ -465,7 +465,7 @@ class Playlist(Record):
         # By default use "All Songs" builtin voiceover (dbid all zero)
         # Else generate alternative "All Songs" to fit the speaker voice of other playlists
         if self.playlist_voiceover and (Text2Speech.valid_tts['pico2wave'] or Text2Speech.valid_tts['espeak']):
-            self["dbid"] = hashlib.md5(b"masterlist").digest()[:8] #pylint: disable-msg=E1101
+            self["dbid"] = hashlib.md5(b"masterlist").digest()[:8]
             self.text_to_speech("All songs", self["dbid"], True)
         self["listtype"] = 1
         self.listtracks = tracks
@@ -551,10 +551,10 @@ class Playlist(Record):
                 text = os.path.splitext(os.path.basename(filename))[0]
 
         # Handle the VoiceOverData
-        self["dbid"] = hashlib.md5(text.encode('utf-8')).digest()[:8] #pylint: disable-msg=E1101
+        self["dbid"] = hashlib.md5(text.encode('utf-8')).digest()[:8]
         self.text_to_speech(text, self["dbid"], True)
 
-    def construct(self, tracks): #pylint: disable-msg=W0221
+    def construct(self, tracks):
         self["total_length"] = 44 + (4 * len(self.listtracks))
         self["number_of_songs"] = 0
 

From acf53b5c8f445477a4e112c324fd8562f04e2ad0 Mon Sep 17 00:00:00 2001
From: NicoHood <nicohood@users.noreply.github.com>
Date: Sat, 27 Aug 2016 21:17:37 +0200
Subject: [PATCH 07/17] Updated readme instructions

---
 README.md | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 567feaa..7e5335a 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@
 
 Python script for building the Track and Playlist database for the newer gen IPod Shuffle.
 Forked from the [shuffle-db-ng project](https://code.google.com/p/shuffle-db-ng/)
+and improved my nims11 and NicoHood.
 
 Just put your audio files into the mass storage of your IPod and shuffle.py will do the rest.
 ```
@@ -50,7 +51,9 @@ optional arguments:
 #### Dependencies
 
 This script requires:
-* [Python 2.7](http://www.python.org/download/releases/2.7/)
+* [Python 3](https://www.python.org/download/releases/3.0/)
+
+Optional album/artist and auto-id3-playlists support:
 * [Mutagen](https://code.google.com/p/mutagen/)
 
 Optional Voiceover support
@@ -61,18 +64,18 @@ Optional Voiceover support
 
 ##### Ubuntu
 
-`apt-get install python-mutagen libttspico*`
+`apt-get install python3 python-mutagen libttspico*`
 
 ##### Arch Linux
 
-From the **Extra** repository: `pacman -S python2 mutagen` and optional `pacman -S espeak` or from the AUR: `svox-pico-bin` ([link](https://aur.archlinux.org/packages/svox-pico-bin/))
+From the **Extra** repository: `pacman -S python` and optional `pacman -S mutagen espeak` or from the AUR: `svox-pico-bin` ([link](https://aur.archlinux.org/packages/svox-pico-bin/))
 
 You can also [install the script from AUR](https://aur.archlinux.org/packages/ipod-shuffle-4g/).
 
 ##### Gentoo Linux
 
 ```bash
-PYTHON_TARGETS="python2_7" emerge -av media-libs/mutagen
+PYTHON_TARGETS="python3" emerge -av media-libs/mutagen
 layman --add=ikelos
 layman --overlays="https://raw.githubusercontent.com/ahippo/rhvoice-gentoo-overlay/master/repositories.xml" --fetch --add=ahippo-rhvoice-overlay
 ACCEPT_KEYWORDS="~amd64" emerge -av app-accessibility/svox app-accessibility/rhvoice

From fa6e3f15d72665c6dcba96edf626cc07e4d83493 Mon Sep 17 00:00:00 2001
From: Nico <NicoHood@users.noreply.github.com>
Date: Tue, 7 Feb 2017 22:08:14 +0100
Subject: [PATCH 08/17] Add #41 to Tips and Tricks Readme section

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 8af7eee..8aff1c6 100644
--- a/README.md
+++ b/README.md
@@ -116,6 +116,17 @@ In all cases you can try to update Rythmbox to the latest version, sync again or
 If you want to use this script on different computers it makes sense
 to simply copy the script into the IPod's root directory.
 
+#### Format/Restore/Recover IPod
+([#41](https://github.com/nims11/IPod-Shuffle-4g/issues/41)) If you formatted your IPod wrong and lost all data you can still recover it.
+It is important to **not use MBR/GPT**. You need to directly create a **Fat16 Filesystem**:
+
+```bash
+mkfs.vfat -F 16 /dev/sdX
+```
+
+Run this script to generate the new database. All missing sound files should be regenrated by the IPod on next use.
+Your IPod should work and play music again now.
+
 ## TODO
 * Last.fm Scrobbler
 * Qt frontend

From 84a3dbf6e61bed469329112016f9952e4e068272 Mon Sep 17 00:00:00 2001
From: Nico <NicoHood@users.noreply.github.com>
Date: Tue, 7 Feb 2017 22:11:25 +0100
Subject: [PATCH 09/17] Better mkfs command

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8aff1c6..bcf1c80 100644
--- a/README.md
+++ b/README.md
@@ -121,7 +121,7 @@ to simply copy the script into the IPod's root directory.
 It is important to **not use MBR/GPT**. You need to directly create a **Fat16 Filesystem**:
 
 ```bash
-mkfs.vfat -F 16 /dev/sdX
+sudo mkfs.vfat -I -F 16 -n IPOD /dev/sdX
 ```
 
 Run this script to generate the new database. All missing sound files should be regenrated by the IPod on next use.

From 052979949580c1063ae6ae74b6b7c6b512739142 Mon Sep 17 00:00:00 2001
From: NicoHood <git@nicohood.de>
Date: Tue, 9 Jun 2020 23:20:56 +0200
Subject: [PATCH 10/17] Update Readme for 1.5

---
 README.md | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index a1c3bf0..b3df597 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ usage: ipod-shuffle-4g.py [-h] [-t] [-p] [-u] [-g TRACK_GAIN]
                           path
 
 Python script for building the Track and Playlist database for the newer gen
-IPod Shuffle. Version 1.4
+IPod Shuffle. Version 1.5
 
 positional arguments:
   path                  Path to the IPod's root directory
@@ -68,7 +68,7 @@ Optional Voiceover support
 
 ##### Arch Linux
 
-From the **Extra** repository: `pacman -S python` and optional `pacman -S mutagen espeak` or from the AUR: `svox-pico-bin` ([link](https://aur.archlinux.org/packages/svox-pico-bin/))
+From the **Extra** repository: `pacman -S python` and optional `pacman -S python-mutagen espeak` or from the AUR: `svox-pico-bin` ([link](https://aur.archlinux.org/packages/svox-pico-bin/))
 
 You can also [install the script from AUR](https://aur.archlinux.org/packages/ipod-shuffle-4g/).
 
@@ -82,7 +82,7 @@ ACCEPT_KEYWORDS="~amd64" emerge -av app-accessibility/svox app-accessibility/rhv
 ```
 References to the overlays above: [ikelos](http://git.overlays.gentoo.org/gitweb/?p=dev/ikelos.git;a=summary), [ahippo-rhvoice-overlay](https://github.com/ahippo/rhvoice-gentoo-overlay)
 
-##Tips and Tricks
+## Tips and Tricks
 
 #### Disable trash for IPod
 To avoid that linux moves deleted files into trash you can create an empty file `.Trash-1000`.
@@ -137,6 +137,10 @@ Original data can be found via [wayback machine](https://web.archive.org/web/201
 # Version History
 
 ```
+1.5 Release (09.06.2020)
+* Port Script to Python3
+* Mutagen support is now optional
+
 1.4 Release (27.08.2016)
 * Catch "no space left" error #30
 * Renamed --voiceover to --track-voiceover

From ddf4f5be777632906457643ebf8017a078f6535c Mon Sep 17 00:00:00 2001
From: NicoHood <git@nicohood.de>
Date: Tue, 9 Jun 2020 23:21:38 +0200
Subject: [PATCH 11/17] Apply fixed suggested by @nims11 review

---
 ipod-shuffle-4g.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 62e6052..f3aca4d 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -32,14 +32,14 @@ def make_dir_if_absent(path):
 
 def raises_unicode_error(str):
     try:
-        str.decode('utf-8').encode('latin-1')
+        str.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
+    item_bytes = item.encode('utf-8')
+    return "".join(["{0:02X}".format(ord(x)) for x in reversed(hashlib.md5(item_bytes).hexdigest()[:8])])
 
 def validate_unicode(path):
     path_list = path.split('/')
@@ -711,7 +711,7 @@ if __name__ == '__main__':
 
     parser = argparse.ArgumentParser(description=
     'Python script for building the Track and Playlist database '
-    'for the newer gen IPod Shuffle. Version 1.4')
+    'for the newer gen IPod Shuffle. Version 1.5')
 
     parser.add_argument('-t', '--track-voiceover', action='store_true',
     help='Enable track voiceover feature')

From 64414b61588c22d1d6861335adaeac68d708632c Mon Sep 17 00:00:00 2001
From: HarJIT <harjit@harjit.moe>
Date: Sat, 13 Mar 2021 13:03:19 +0000
Subject: [PATCH 12/17] Fix TypeError when reading playlist files.

---
 ipod-shuffle-4g.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index f3aca4d..12d1860 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -534,7 +534,7 @@ class Playlist(Record):
                 text = os.path.splitext(os.path.basename(filename))[0]
             else:
                 # Read the playlist file
-                with open(filename, 'rb') as f:
+                with open(filename, 'r', errors="replace") as f:
                     data = f.readlines()
 
                 extension = os.path.splitext(filename)[1].lower()

From 4fd26bf51c5196c4aa00216ecd29f4496aa07280 Mon Sep 17 00:00:00 2001
From: NicoHood <git@nicohood.de>
Date: Sat, 5 Jun 2021 08:51:57 +0200
Subject: [PATCH 13/17] Moved Changelog to a separate file with KeepAChangelog
 format

---
 CHANGELOG.md | 111 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    |  54 -------------------------
 2 files changed, 111 insertions(+), 54 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..0665084
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,111 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+This changlog uses the [ISO 8601 date format](https://www.iso.org/iso-8601-date-and-time-format.html) of (YYYY-MM-DD).
+
+## [Unreleased]
+
+## [1.5.1] - 2021-06-05
+
+### Changed
+
+* Moved Changelog from Readme to Changelog.md file
+
+### Fixed
+
+* Fix TypeError when reading playlist files [#50](https://github.com/nims11/IPod-Shuffle-4g/pull/50)
+
+## [1.5.0] - 2020-06-10
+
+### Changed
+
+* Port Script to Python3
+* Mutagen support is now optional
+
+## [1.4.0] - 2016-08-28
+
+### Added
+
+* Added optional `--verbose` output
+* Added files to `extras` folder
+* Added shortcut parameters (`-p`, `-t`, `-d`, etc.)
+
+### Changed
+
+* Renamed `--voiceover` to `--track-voiceover`
+* Renamed script from `shuffle.py` to `ipod-shuffle-4g.py`
+* Ignore hidden filenames
+* Do not force playlist voiceover with auto playlists
+
+### Fixed
+
+* Catch "no space left" error [#30](https://github.com/nims11/IPod-Shuffle-4g/issues/30)
+* Fix UnicodeEncodeError for non-ascii playlist names [#35](https://github.com/nims11/IPod-Shuffle-4g/issues/35)
+
+## [1.3.0] - 2016-06-08
+
+### Added
+
+* Directory based auto playlist building (`--auto-dir-playlists`) [#13](https://github.com/nims11/IPod-Shuffle-4g/issues/13)
+* ID3 tags based auto playlist building (`--auto-id3-playlists`)
+* Added short program description
+* Differentiate track and playlist voiceover [#26](https://github.com/nims11/IPod-Shuffle-4g/issues/26)
+
+### Changed
+
+* Voiceover disabled by default [#26](https://github.com/nims11/IPod-Shuffle-4g/issues/26) (Playlist voiceover enabled with auto playlist generation)
+
+
+### Fixed
+
+* Fix hyphen in filename [#4](https://github.com/nims11/IPod-Shuffle-4g/issues/4)
+* Fixed mutagen bug [#5](https://github.com/nims11/IPod-Shuffle-4g/issues/5)
+
+## [1.2.0] - 2016-02-04
+
+### Added
+
+* Added Path help entry
+* Added MIT License
+* Added this changelog
+
+### Changed
+
+* Skip existing voiceover files with the same name (e.g. "Track 1.mp3")
+* Made help message lower case
+* Improved Readme
+* Improved docs
+
+### Fixed
+
+* Additional fixes from NicoHood
+* Fixed "All Songs" and "Playlist N" sounds when voiceover is disabled [#17](https://github.com/nims11/IPod-Shuffle-4g/issues/17)
+* Better handle broken playlist paths [#16](https://github.com/nims11/IPod-Shuffle-4g/issues/16)
+* Only use voiceover if dependencies are installed
+
+## [1.1.0] - 2016-01-23
+
+### Added
+
+* Fixes from nims11 fork
+* Option to disable voiceover
+* Initialize the IPod Directory tree
+* Using the `--rename-unicode` flag filenames with strange characters and different language are renamed which avoids the script to crash with a Unicode Error
+* Other small fixes
+
+## [1.0.0] - 2012-10-17
+
+### Added
+
+* Original release by ikelos
+
+[Unreleased]: https://github.com/nims11/IPod-Shuffle-4g/compare/1.5.1...HEAD
+[1.5.1]: https://github.com/nims11/IPod-Shuffle-4g/compare/v1.5...1.5.1
+[1.5.0]: https://github.com/nims11/IPod-Shuffle-4g/compare/v1.4...v1.5
+[1.4.0]: https://github.com/nims11/IPod-Shuffle-4g/compare/v1.3...v1.4
+[1.3.0]: https://github.com/nims11/IPod-Shuffle-4g/compare/v1.2...v1.3
+[1.2.0]: https://github.com/nims11/IPod-Shuffle-4g/compare/v1.1...v1.2
+[1.1.0]: https://github.com/nims11/IPod-Shuffle-4g/compare/646b7def4c498c59b063e535a5b64695d8d87e6b...v1.1
+[1.0.0]: https://github.com/nims11/IPod-Shuffle-4g/commit/646b7def4c498c59b063e535a5b64695d8d87e6b
diff --git a/README.md b/README.md
index 89ad287..c0445db 100644
--- a/README.md
+++ b/README.md
@@ -143,57 +143,3 @@ Your IPod should work and play music again now.
 
 The original shuffle3db website went offline. This repository contains a copy of the information inside the `docs` folder.
 Original data can be found via [wayback machine](https://web.archive.org/web/20131016014401/http://shuffle3db.wikispaces.com/iTunesSD3gen).
-
-
-# Version History
-
-```
-1.5 Release (09.06.2020)
-* Port Script to Python3
-* Mutagen support is now optional
-
-1.4 Release (27.08.2016)
-* Catch "no space left" error #30
-* Renamed --voiceover to --track-voiceover
-* Added optional --verbose output
-* Renamed script from shuffle.py to ipod-shuffle-4g.py
-* Added files to `extras` folder
-* Ignore hidden filenames
-* Do not force playlist voiceover with auto playlists
-* Added shortcut parameters (-p, -t, -d, etc.)
-* Fix UnicodeEncodeError for non-ascii playlist names (#35)
-
-1.3 Release (08.06.2016)
-* Directory based auto playlist building (--auto-dir-playlists) (#13)
-* ID3 tags based auto playlist building (--auto-id3-playlists)
-* Added short program description
-* Fix hyphen in filename #4
-* Fixed mutagen bug #5
-* Voiceover disabled by default #26 (Playlist voiceover enabled with auto playlist generation)
-* Differentiate track and playlist voiceover #26
-
-1.2 Release (04.02.2016)
-* Additional fixes from NicoHood
-* Fixed "All Songs" and "Playlist N" sounds when voiceover is disabled #17
-* Better handle broken playlist paths #16
-* Skip existing voiceover files with the same name (e.g. "Track 1.mp3")
-* Only use voiceover if dependencies are installed
-* Added Path help entry
-* Made help message lower case
-* Improved Readme
-* Improved docs
-* Added MIT License
-* Added this changelog
-
-1.1 Release (11.10.2013 - 23.01.2016)
-* Fixes from nims11 fork
-* Option to disable voiceover
-* Initialize the IPod Directory tree
-* Using the --rename-unicode flag
-  filenames with strange characters and different language are renamed
-  which avoids the script to crash with a Unicode Error
-* Other small fixes
-
-1.0 Release (15.08.2012 - 17.10.2012)
-* Original release by ikelos
-```

From 8863026157235630fd023a2a2e02ab7fdbbbeac6 Mon Sep 17 00:00:00 2001
From: Arno Hautala <arno@fracas.net>
Date: Tue, 24 Aug 2021 22:46:05 -0400
Subject: [PATCH 14/17] support for using "say" to generate voiceover files

---
 ipod-shuffle-4g.py | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 12d1860..9fb69ee 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -97,12 +97,19 @@ def group_tracks_by_id3_template(tracks, template):
     return sorted(grouped_tracks_dict.items())
 
 class Text2Speech(object):
-    valid_tts = {'pico2wave': True, 'RHVoice': True, 'espeak': True}
+    valid_tts = {'pico2wave': True, 'RHVoice': True, 'espeak': True, 'say': True}
 
     @staticmethod
     def check_support():
         voiceoverAvailable = False
 
+        # Check for say voiceover
+        if not exec_exists_in_path("say"):
+            Text2Speech.valid_tts['say'] = False
+            print("Warning: say not found, voicever won't be generated using it.")
+        else:
+            voiceoverAvailable = True
+
         # Check for pico2wave voiceover
         if not exec_exists_in_path("pico2wave"):
             Text2Speech.valid_tts['pico2wave'] = False
@@ -147,6 +154,8 @@ class Text2Speech(object):
                 return True
             elif Text2Speech.espeak(out_wav_path, text):
                 return True
+            elif Text2Speech.say(out_wav_path, text):
+                return True
             else:
                 return False
 
@@ -165,6 +174,13 @@ class Text2Speech(object):
         subprocess.call(["pico2wave", "-l", "en-GB", "-w", out_wav_path, unicodetext])
         return True
 
+    @staticmethod
+    def say(out_wav_path, unicodetext):
+        if not Text2Speech.valid_tts['say']:
+            return False
+        subprocess.call(["say", "-o", out_wav_path, '--data-format=LEI16', '--file-format=WAVE', unicodetext])
+        return True
+
     @staticmethod
     def espeak(out_wav_path, unicodetext):
         if not Text2Speech.valid_tts['espeak']:
@@ -464,7 +480,7 @@ class Playlist(Record):
     def set_master(self, tracks):
         # By default use "All Songs" builtin voiceover (dbid all zero)
         # Else generate alternative "All Songs" to fit the speaker voice of other playlists
-        if self.playlist_voiceover and (Text2Speech.valid_tts['pico2wave'] or Text2Speech.valid_tts['espeak']):
+        if self.playlist_voiceover and (Text2Speech.valid_tts['pico2wave'] or Text2Speech.valid_tts['espeak'] or Text2Speech.valid_tts['say']):
             self["dbid"] = hashlib.md5(b"masterlist").digest()[:8]
             self.text_to_speech("All songs", self["dbid"], True)
         self["listtype"] = 1

From 6186600e4cbea520becdda2e7856a2761622234e Mon Sep 17 00:00:00 2001
From: Arno Hautala <arno@fracas.net>
Date: Wed, 25 Aug 2021 17:05:11 -0400
Subject: [PATCH 15/17] use double dash (--) to indicate start of voiceover
 text parameter

---
 ipod-shuffle-4g.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 9fb69ee..70f3687 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -171,21 +171,21 @@ class Text2Speech(object):
     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])
+        subprocess.call(["pico2wave", "-l", "en-GB", "-w", out_wav_path, '--', unicodetext])
         return True
 
     @staticmethod
     def say(out_wav_path, unicodetext):
         if not Text2Speech.valid_tts['say']:
             return False
-        subprocess.call(["say", "-o", out_wav_path, '--data-format=LEI16', '--file-format=WAVE', unicodetext])
+        subprocess.call(["say", "-o", out_wav_path, '--data-format=LEI16', '--file-format=WAVE', '--', unicodetext])
         return True
 
     @staticmethod
     def espeak(out_wav_path, unicodetext):
         if not Text2Speech.valid_tts['espeak']:
             return False
-        subprocess.call(["espeak", "-v", "english_rp", "-s", "150", "-w", out_wav_path, unicodetext])
+        subprocess.call(["espeak", "-v", "english_rp", "-s", "150", "-w", out_wav_path, '--', unicodetext])
         return True
 
     @staticmethod

From 37ba988b737910fcace3f836277b0c8fd6c5255d Mon Sep 17 00:00:00 2001
From: Arno Hautala <arno@fracas.net>
Date: Sat, 28 Aug 2021 10:13:03 -0400
Subject: [PATCH 16/17] clarify macOS say provenance

---
 ipod-shuffle-4g.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/ipod-shuffle-4g.py b/ipod-shuffle-4g.py
index 70f3687..8225a56 100755
--- a/ipod-shuffle-4g.py
+++ b/ipod-shuffle-4g.py
@@ -103,10 +103,10 @@ class Text2Speech(object):
     def check_support():
         voiceoverAvailable = False
 
-        # Check for say voiceover
+        # Check for macOS say voiceover
         if not exec_exists_in_path("say"):
             Text2Speech.valid_tts['say'] = False
-            print("Warning: say not found, voicever won't be generated using it.")
+            print("Warning: macOS say not found, voicever won't be generated using it.")
         else:
             voiceoverAvailable = True
 

From 4a2031a821635eaa335e2440f180a4bc24c2774e Mon Sep 17 00:00:00 2001
From: Arno Hautala <arno@fracas.net>
Date: Sun, 29 Aug 2021 10:13:24 -0400
Subject: [PATCH 17/17] mentions macOS say in readme

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 89ad287..6d96eb5 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,7 @@ Optional Voiceover support
 * [PicoSpeaker](http://picospeaker.tk/readme.php)
 * [RHVoice (master branch, 3e31edced402a08771d2c48c73213982cbe9333e)](https://github.com/Olga-Yakovleva/RHVoice) -- (Russian files only)
 * [SoX](http://sox.sourceforge.net) -- (Russian files)
+* say (macOS)
 
 ##### Ubuntu