Merge pull request #5 from DalenW/GeoData

 - Write `geoData` from `.json`s to exif

Author: TheLastGimbus

google_photos_takeout_helper/__main__.py

@@ -7,6 +7,8 @@ def main():
     from datetime import datetime as _datetime
 
     import piexif as _piexif
+    from fractions import Fraction  # piexif requires some values to be stored as rationals
+    import math
 
     parser = _argparse.ArgumentParser(
         prog='Photos takeout helper',
@@ -85,12 +87,11 @@ def main():
 
     _os.makedirs(FIXED_DIR, exist_ok=True)
 
-
     def for_all_files_recursive(
-      dir,
-      file_function=lambda fo, fi: True,
-      folder_function=lambda fo: True,
-      filter_fun=lambda file: True
+            dir,
+            file_function=lambda fo, fi: True,
+            folder_function=lambda fo: True,
+            filter_fun=lambda file: True
     ):
         for file in _os.listdir(dir):
             file = dir + '/' + file
@@ -104,21 +105,18 @@ def for_all_files_recursive(
                 print('Found something weird...')
                 print(file)
 
-
     def is_photo(file):
         what = _os.path.splitext(file.lower())[1]
         if what not in photo_formats:
             return False
         return True
 
-
     def is_video(file):
         what = _os.path.splitext(file.lower())[1]
         if what not in video_formats:
             return False
         return True
 
-
     # PART 1: removing duplicates
 
     # THIS IS PARTLY COPIED FROM STACKOVERFLOW
@@ -165,15 +163,13 @@ def find_duplicates(path, filter_fun=lambda file: True):
 
         return duplicates
 
-
     # Removes all duplicates in folder
     def remove_duplicates(dir):
         duplicates = find_duplicates(dir, lambda f: (is_photo(f) or is_video(f)))
         for file in duplicates:
             _os.remove(file)
         return True
 
-
     # PART 2: Fixing metadata and date-related stuff
 
     # Returns json dict
@@ -189,7 +185,6 @@ def find_json_for_file(dir, file):
         else:
             raise FileNotFoundError('Couldnt find json for file: ' + file)
 
-
     # Returns date in 2019:01:01 23:59:59 format
     def get_date_from_folder_name(dir):
         dir = _os.path.basename(_os.path.normpath(dir))
@@ -225,7 +220,6 @@ def set_creation_date_from_str(file, str_datetime):
             print(e)
         _os.utime(file, (timestamp, timestamp))
 
-
     def set_creation_date_from_exif(file):
         exif_dict = _piexif.load(file)
         tags = [['0th', TAG_DATE_TIME], ['Exif', TAG_DATE_TIME_ORIGINAL], ['Exif', TAG_DATE_TIME_DIGITIZED]]
@@ -240,7 +234,6 @@ def set_creation_date_from_exif(file):
             raise IOError('No DateTime in given exif')
         set_creation_date_from_str(file, datetime_str)
 
-
     def set_file_exif_date(file, creation_date):
         try:
             exif_dict = _piexif.load(file)
@@ -255,15 +248,111 @@ def set_file_exif_date(file, creation_date):
         try:
             _piexif.insert(_piexif.dump(exif_dict), file)
         except Exception as e:
-            print('Couldnt insert exif!')
+            print("Couldn't insert exif!")
             print(e)
 
-
     def get_date_str_from_json(json):
         return _datetime.fromtimestamp(
             int(json['photoTakenTime']['timestamp'])
         ).strftime('%Y:%m:%d %H:%M:%S')
 
+    def change_to_rational(number):
+        """convert a number to rantional
+        Keyword arguments: number
+        return: tuple like (1, 2), (numerator, denominator)
+        """
+        f = Fraction(str(number))
+        return f.numerator, f.denominator
+
+    # got this here https://github.com/hMatoba/piexifjs/issues/1#issuecomment-260176317
+    def degToDmsRational(degFloat):
+        min_float = degFloat % 1 * 60
+        sec_float = min_float % 1 * 60
+        deg = math.floor(degFloat)
+        deg_min = math.floor(min_float)
+        sec = round(sec_float * 100)
+
+        return [(deg, 1), (deg_min, 1), (sec, 100)]
+
+    def set_file_geo_data(file, json):
+        """
+        Reads the geoData from google and saves it to the EXIF. This works assuming that the geodata looks like -100.12093, 50.213143. Something like that.
+
+        Written by DalenW.
+        :param file:
+        :param json:
+        :return:
+        """
+
+        # prevents crashes
+        try:
+            exif_dict = _piexif.load(file)
+        except (_piexif.InvalidImageDataError, ValueError):
+            exif_dict = {'0th': {}, 'Exif': {}}
+
+        # fetches geo data from the photos editor first.
+        longitude = float(json['geoData']['longitude'])
+        latitude = float(json['geoData']['latitude'])
+        altitude = float(json['geoData']['altitude'])
+
+        # fallbacks to GeoData Exif if it wasn't set in the photos editor.
+        # https://github.com/TheLastGimbus/GooglePhotosTakeoutHelper/pull/5#discussion_r531792314
+        longitude = float(json['geoData']['longitude'])
+        latitude = float(json['geoData']['latitude'])
+        altitude = json['geoData']['altitude']
+        # Prioritise geoData set from GPhotos editor
+        if longitude == 0 and latitude == 0:
+            longitude = float(json['geoDataExif']['longitude'])
+            latitude = float(json['geoDataExif']['latitude'])
+            altitude = json['geoDataExif']['altitude']
+
+        # latitude >= 0: North latitude -> "N"
+        # latitude < 0: South latitude -> "S"
+        # longitude >= 0: East longitude -> "E"
+        # longitude < 0: West longitude -> "W"
+
+        if longitude >= 0:
+            longitude_ref = 'E'
+        else:
+            longitude_ref = 'W'
+            longitude = longitude * -1
+
+        if latitude >= 0:
+            latitude_ref = 'N'
+        else:
+            latitude_ref = 'S'
+            latitude = latitude * -1
+
+        # referenced from https://gist.github.com/c060604/8a51f8999be12fc2be498e9ca56adc72
+        gps_ifd = {
+            _piexif.GPSIFD.GPSVersionID: (2, 0, 0, 0)
+        }
+
+        # skips it if it's empty
+        if latitude != 0 or longitude != 0:
+            gps_ifd.update({
+                _piexif.GPSIFD.GPSLatitudeRef: latitude_ref,
+                _piexif.GPSIFD.GPSLatitude: degToDmsRational(latitude),
+
+                _piexif.GPSIFD.GPSLongitudeRef: longitude_ref,
+                _piexif.GPSIFD.GPSLongitude: degToDmsRational(longitude)
+            })
+
+        if altitude != 0:
+            gps_ifd.update({
+                _piexif.GPSIFD.GPSAltitudeRef: 1,
+                _piexif.GPSIFD.GPSAltitude: change_to_rational(round(altitude))
+            })
+
+        gps_exif = {"GPS": gps_ifd}
+        exif_dict.update(gps_exif)
+
+        try:
+            _piexif.insert(_piexif.dump(exif_dict), file)
+        except Exception as e:
+            print("Couldn't insert geo exif!")
+            # local variable 'new_value' referenced before assignment means that one of the GPS values is incorrect
+            print(e)
 
     # Fixes ALL metadata, takes just file and dir and figures it out
     def fix_metadata(dir, file):
@@ -282,12 +371,13 @@ def fix_metadata(dir, file):
         try:
             google_json = find_json_for_file(dir, file)
             date = get_date_str_from_json(google_json)
+            set_file_geo_data(file, google_json)
             set_file_exif_date(file, date)
             set_creation_date_from_str(file, date)
             has_nice_date = True
             return
         except FileNotFoundError:
-            print('Couldnt find json for file :/')
+            print("Couldn't find json for file :/")
 
         if has_nice_date:
             return
@@ -298,7 +388,6 @@ def fix_metadata(dir, file):
         set_creation_date_from_str(file, date)
         return True
 
-
     # PART 3: Copy all photos and videos to target folder
 
     # Makes a new name like 'photo(1).jpg'
@@ -316,15 +405,13 @@ def new_name_if_exists(file_name, watch_for_duplicates=True):
                 new_name = split[0] + '(' + str(i) + ')' + split[1]
                 i += 1
 
-
     def copy_to_target(dir, file):
         if is_photo(file) or is_video(file):
             new_file = new_name_if_exists(FIXED_DIR + '/' + _os.path.basename(file),
                                           watch_for_duplicates=not args.keep_duplicates)
             _shutil.copy2(file, new_file)
         return True
 
-
     def copy_to_target_and_divide(dir, file):
         creation_date = _os.path.getmtime(file)
         date = _datetime.fromtimestamp(creation_date)
@@ -337,7 +424,6 @@ def copy_to_target_and_divide(dir, file):
         _shutil.copy2(file, new_file)
         return True
 
-
     if not args.keep_duplicates:
         print('=====================')
         print('Removing duplicates...')
@@ -383,5 +469,6 @@ def copy_to_target_and_divide(dir, file):
     print('Sooo... what now? You can see README.md for what nice G Photos alternatives I found and recommend')
     print('Have a nice day!')
 
+
 if __name__ == '__main__':
     main()