Added EOF return codes

README.md

@@ -1,27 +1,33 @@
 # flac2pod
-Seamlessly converts your existing FLAC library to be played on an iPod Classic.
+Converts your existing FLAC library to be played on an iPod Classic.
 
-This script makes use of ffmpeg to convert your existing FLAC music library to either MP3-320 or ALAC for easy iPod Classic use. It also takes advantage of "rg2sc" (https://github.com/rwinkhart/rg2sc) to convert any existing ReplayGain tags to Apple Sound Check tags that are compatible with Apple products.
+This script makes use of ffmpeg to convert your existing FLAC music library to AAC-256 for easy iPod Classic use. It can also bake your existing ReplayGain data into the output files. SoundCheck support was removed due to this feature being very finicky on iPods. If you would like to add SoundCheck data to your output files, omit the --bake option and then use https://github.com/rwinkhart/rg2sc on your output files.
+
+In order for ReplayGain baking to work, your FLAC library must already be tagged with ReplayGain data. If you haven't already done this, flac2pod comes with a script (flac2pod-flacgain) for quickly applying these ReplayGain tags.
 
 # Usage
-
+Simply run...
 ```
-flac2pod -f --mp3  # will convert library to MP3-320 and forcefully update Sound Check tags (even if they already exist)
+flac2pod <source_dir> <destination_dir>
-
-flac2pod --alac  # will convert library to ALAC in a .m4a container - only updates missing Sound Check tags
-
-flac2pod  # will convert library to MP3-320 - only updates missing Sound Check tags
 ```
+...to convert your library, or run...
+```
+flac2pod --help
+```
+...to see additional options, or run...
+```
+flac2pod-flacgain <source_dir>
+```
+...to tag your FLAC library with ReplayGain data.
 
-In order for flac2pod to function, your library must be structured as follows:
+In order for flac2pod to function, your source_dir must be structured as follows:
-Library dir -> Artist dir -> Album dir -> FLAC files
 
-When prompted for the source directory, you want to input your library parent directory.
+source_dir -> artist dir -> album dir -> FLAC files
 
 # Installation
 
 flac2pod is available in the AUR as "flac2pod". If installing on a non-Arch-based distribution, follow the manual installation instructions:
 
-- copy the flac2pod executable from https://github.com/rwinkhart/flac2pod/blob/master/bin/flac2pod to your /usr/bin/
+- copy the contents of https://github.com/rwinkhart/flac2pod/blob/master/bin/ to your /usr/bin/
-- copy the rg2sc executable from https://github.com/rwinkhart/rg2sc/blob/master/bin/rg2sc to your /usr/bin
+- install flac, python-mutagen, ffmpeg, and screen
-- install python-mutagen, ffmpeg, and lame
+- start converting

bin/flac2pod

@@ -2,18 +2,22 @@
 
 # external modules
 
-from os import path, system, walk
+from argparse import ArgumentParser
+from mutagen.flac import FLAC
+from os import cpu_count, path, walk
 from pathlib import Path
-from sys import argv
+from subprocess import check_output, Popen
+from sys import exit as s_exit
+from time import sleep
 
 
 # utility functions
 
-def scan_source():
+def scan_source(_source):
     _artist_dirs, _album_dirs, _full_paths = [], [], []
-    for _root, _directories, _files in walk(path.expanduser(source)):
+    for _root, _directories, _files in walk(path.expanduser(_source)):
         for _dir in sorted(_directories):
-            if not _root.endswith(path.expanduser(source)):
+            if not _root.endswith(path.expanduser(_source)):
                 _artist_dirs.append(_root)
     _artist_dirs = list(set(_artist_dirs))
     for _artist in sorted(_artist_dirs):
@@ -35,50 +39,108 @@ def create_destination():
             .mkdir(0o700, parents=True, exist_ok=True)
 
 
-def scan_destination_convert_alac():
+def scan_destination_convert():
+    _i, _i_total, _total_files = 0, 0, len(source_directories[1])
     for _file in source_directories[1]:
-        if not Path(f"{_file.replace(path.expanduser(source), path.expanduser(destination))}.m4a").is_file():
+        _i_total += 1
-            system(f"ffmpeg -i '{_file}.flac' -c:v copy -c:a alac -map_metadata 0 -id3v2_version 3 "
+        _progress = round((_i_total / _total_files) * 100, 2)
-                   f"'{_file.replace(path.expanduser(source), path.expanduser(destination))}.m4a'")
+        if not Path(f"{_file.replace(path.expanduser(source), path.expanduser(destination))}.mp3").is_file() and not \
-
+                Path(f"{_file.replace(path.expanduser(source), path.expanduser(destination))}.m4a").is_file():
-
+            _file_s = _file.replace(' ', '\\ ').replace("'", "\\'").replace(')', '\\)').replace('(', '\\(')\
-def scan_destination_convert_mp3():
+                          .replace('&', '\\&').replace('`', '\\`').replace('$', '\\$') + '.flac'
-    for _file in source_directories[1]:
+            _file_d = _file.replace(path.expanduser(source), path.expanduser(destination)).replace(' ', '\\ ')\
-        print(_file)
+                          .replace("'", "\\'").replace(')', '\\)').replace('(', '\\(').replace('&', '\\&')\
-        if not Path(f"{_file.replace(path.expanduser(source), path.expanduser(destination))}.mp3").is_file():
+                          .replace('`', '\\`').replace('$', '\\$') + '.m4a'
-            system(f"ffmpeg -i '{_file}.flac' -c:v copy -ab 320k -map_metadata 0 -id3v2_version 3 "
+            _active_processes = int(check_output('ps -C ffmpeg | wc -l', shell=True)) - 1
-                   f"'{_file.replace(path.expanduser(source), path.expanduser(destination))}.mp3'")
+            if _active_processes >= cpu_count():
-
+                while _active_processes >= cpu_count():
-
+                    print(f"\nThere are already {cpu_count()} processes running...\n")
-def rg2sc():
+                    sleep(1)
-    if argument.__contains__('-f'):
+                    _active_processes = int(check_output('ps -C ffmpeg | wc -l', shell=True)) - 1
-        system(f"{rg2sc} -f {destination}")
+            _i += 1
+            print(f"\n{_progress}% | \u001b[38;5;0;48;5;15mConverting {_file_s} to {_file_d}...\u001b[0m\n")
+            # get relevant ReplayGain info
+            _audio = FLAC(f"{_file}.flac")
+            if args.albumgain:
+                if _audio.get('replaygain_album_gain'):
+                    _rggain = float(_audio.get('replaygain_album_gain')[0][:-3])
+                elif _audio.get('REPLAYGAIN_ALBUM_GAIN'):
+                    _rggain = float(_audio.get('REPLAYGAIN_ALBUM_GAIN')[0][:-3])
                 else:
-        system(f"{rg2sc} {destination}")
+                    _rggain = None
+                if _audio.get('replaygain_album_peak'):
+                    _rgpeak = float(_audio.get('replaygain_album_peak')[0])
+                elif _audio.get('REPLAYGAIN_ALBUM_PEAK'):
+                    _rgpeak = float(_audio.get('REPLAYGAIN_ALBUM_PEAK')[0])
+                else:
+                    _rgpeak = None
+            else:
+                if _audio.get('replaygain_track_gain'):
+                    _rggain = float(_audio.get('replaygain_track_gain')[0][:-3])
+                elif _audio.get('REPLAYGAIN_TRACK_GAIN'):
+                    _rggain = float(_audio.get('REPLAYGAIN_TRACK_GAIN')[0][:-3])
+                else:
+                    _rggain = None
+                if _audio.get('replaygain_track_peak'):
+                    _rgpeak = float(_audio.get('replaygain_track_peak')[0])
+                elif _audio.get('REPLAYGAIN_TRACK_PEAK'):
+                    _rgpeak = float(_audio.get('REPLAYGAIN_TRACK_PEAK')[0])
+                else:
+                    _rgpeak = None
+            # determine ffmpeg arguments
+            if args.bake and _rggain is not None:
+                _bake_args, _flac2pod_rg_tags = '-filter:a "volume=' + str(_rggain) + 'dB"', ''
+            elif _rggain is not None and _rgpeak is not None:
+                _bake_args, _flac2pod_rg_tags = '', f"-metadata comment='FLAC2PODRG#{_rggain}#{_rgpeak}#'"
+            else:
+                _bake_args, _flac2pod_rg_tags = '', ''
+            # generate the appropriate ffmpeg command
+            _cmd = f"screen -DmS flac2pod{_i} ffmpeg -i {_file_s} -c:a aac -ab 256k {_bake_args} -map_metadata 0 " \
+                   f"{_flac2pod_rg_tags} -aac_pns 0 -movflags +faststart -vn {_file_d} </dev/null"
+            if _rggain is not None:
+                print(f"\u001b[38;5;0;48;5;15mGain adjustment: {_rggain}dB\u001b[0m")
+            else:
+                print(f"\u001b[38;5;0;48;5;88mNo ReplayGain data found!\u001b[0m")
+                if args.stopifnogain:
+                    s_exit(1)
+            Popen(_cmd, shell=True)
+    _active_processes = int(check_output('ps -C ffmpeg | wc -l', shell=True)) - 1
+    while _active_processes != 0:
+        print('\nPlease wait for the remaining conversions to complete...\n')
+        sleep(1)
+        _active_processes = int(check_output('ps -C ffmpeg | wc -l', shell=True)) - 1
+    sleep(1)
+    print('\niPod conversion complete!\n')
+    s_exit(0)
 
 
-# program start sequence
+# argument parsing
+if __name__ == "__main__":
+    parser = ArgumentParser(description='Convert your existing FLAC library to be played on an iPod Classic.')
+    parser.add_argument('source_dir', nargs='+',
+                        help='directory tree containing music files - folder must contain library sorted into artists '
+                             'and albums')
+    parser.add_argument('destination_dir', nargs='+',
+                        help='destination parent directory for output - will be created if it does not already exist')
+    parser.add_argument('-b', '--bake', action='store_true',
+                        help='bake (encode) ReplayGain values into the file')
+    parser.add_argument('-a', '--albumgain', action='store_true',
+                        help='read ReplayGain album gain instead of ReplayGain track gain')
+    parser.add_argument('-x', '--stopifnogain', action='store_true',
+                        help='stop flac2pod if ReplayGain data cannot be found in a file')
+    args = parser.parse_args()
 
-# retrieve typed argument
+    if args.source_dir[0].endswith('/'):
-argument_list = argv
+        source = args.source_dir[0][:-1]
-i, argument = 0, ''
+    else:
-for _ in argument_list:
+        source = args.source_dir[0]
-    while i < len(argument_list) - 1:
+    if args.destination_dir[0].endswith('/'):
-        i += 1
+        destination = args.destination_dir[0][:-1]
-        argument += argument_list[i] + ' '
+    else:
-argument = argument[:-1]
+        destination = args.destination_dir[0]
 
-source = input('Source parent directory: ')
+    source_directories = scan_source(source)
-if source.endswith('/'):
-    source = source[:-1]
-destination = input('Destination parent directory: ')
-if destination.endswith('/'):
-    destination = destination[:-1]
-
-source_directories = scan_source()
     create_destination()
-if argument.__contains__('--alac'):
+    scan_destination_convert()
-    scan_destination_convert_alac()
+
-else:
+    s_exit(0)
-    scan_destination_convert_mp3()
-    rg2sc()

bin/flac2pod-flacgain

@@ -0,0 +1,66 @@
+#!/bin/python3
+
+from argparse import ArgumentParser
+from flac2pod import scan_source
+from mutagen.flac import FLAC
+from os import listdir, system
+from subprocess import PIPE, Popen, STDOUT
+from sys import exit as s_exit
+
+# argument parsing
+if __name__ == "__main__":
+    parser = ArgumentParser(description='Quickly tag your FLAC library with ReplayGain data using metaflac.')
+    parser.add_argument('source_dir', nargs='+',
+                        help='directory tree containing music files - folder must contain library sorted into artists '
+                             'and albums')
+    parser.add_argument('-f', '--force', action='store_true',
+                        help='overwrite existing ReplayGain data')
+    args = parser.parse_args()
+
+    if args.source_dir[0].endswith('/'):
+        source = args.source_dir[0][:-1]
+    else:
+        source = args.source_dir[0]
+
+    source_directories = scan_source(source)
+
+    gain = 1
+    for album in sorted(source_directories[0]):
+        std_album = album.replace(' ', '\\ ').replace("'", "\\'").replace(')', '\\)') \
+            .replace('(', '\\(').replace('&', '\\&').replace('`', '\\`').replace('$', '\\$')
+        for song in listdir(album):
+            audio = FLAC(f"{album}/{song}")
+            if audio.get('replaygain_track_gain') or audio.get('REPLAYGAIN_TRACK_GAIN'):
+                gain = 1
+            else:
+                gain = 0
+                break
+        if args.force or gain == 0:
+            print(f"[{album}/*] Adding ReplayGain data...")
+            system(f"metaflac --remove-replay-gain {std_album}/*")
+            command = f"metaflac --add-replay-gain {std_album}/*"
+            output = Popen(command, shell=True, stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
+            block = output.communicate()[0].strip()  # blocks the program from proceeding until stdout is given
+            if output.returncode == 1:
+                if block.decode('utf-8').__contains__('sample') or block.decode('utf-8').__contains__('resolution of'):
+                    print('Resolution/Sample Rate mismatch, scanning tracks as individuals...')
+                    for song in listdir(album):
+                        print(f"[{album}/{song}] Adding ReplayGain data...")
+                        std_song = song.replace(' ', '\\ ').replace("'", "\\'").replace(')', '\\)')\
+                            .replace('(', '\\(').replace('&', '\\&').replace('`', '\\`').replace('$', '\\$')
+                        command = f"metaflac --add-replay-gain {std_album}/{std_song}"
+                        output = Popen(command, shell=True, stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
+                        block = output.communicate()[0].strip()
+                        if output.returncode == 1:
+                            print('There was an error processing your files.')
+                            print(f"Return Code: [{str(output.returncode)}] {block.decode('utf-8')}")
+                            s_exit(1)
+                else:
+                    print('There was an error processing your files.')
+                    print(f"Return Code: [{str(output.returncode)}] {block.decode('utf-8')}")
+                    s_exit(1)
+
+        else:
+            print(f"[{album}/*] ReplayGain data is already present.")
+
+    s_exit(0)

bin/flac2pod.py

@@ -0,0 +1 @@
+/usr/bin/flac2pod

package.sh

@@ -39,7 +39,7 @@ pkgdesc='Converts your FLAC library to be iPod-ready'
 url='https://github.com/rwinkhart/flac2pod'
 arch=('any')
 license=('GPL2')
-depends=(python ffmpeg lame rg2sc)
+depends=(ffmpeg flac python python-mutagen screen)
 
 source=(\""$source"\")
 sha512sums=('"$sha512"')