geopic-tag-reader 1.0.6__py3-none-any.whl → 1.1.1__py3-none-any.whl

geopic_tag_reader/__init__.py

@@ -2,4 +2,4 @@
 GeoPicTagReader
 """
 
-__version__ = "1.0.6"
+__version__ = "1.1.1"

geopic_tag_reader/main.py

@@ -22,13 +22,15 @@ def read(
 
         print("Latitude:", metadata.lat)
         print("Longitude:", metadata.lon)
-        print("Timestamp:", metadata.ts)
+        print("Timestamp:", metadata.ts.isoformat())
         print("Heading:", metadata.heading)
         print("Type:", metadata.type)
         print("Make:", metadata.make)
         print("Model:", metadata.model)
         print("Focal length:", metadata.focal_length)
         print("Crop parameters:", metadata.crop)
+        print("Pitch:", metadata.pitch)
+        print("Roll:", metadata.roll)
 
         if len(metadata.tagreader_warnings) > 0:
             print("Warnings raised by reader:")

geopic_tag_reader/reader.py

@@ -7,11 +7,15 @@ import re
 import json
 from fractions import Fraction
 from geopic_tag_reader import camera
+import timezonefinder  # type: ignore
+import pytz
 
 # This is a fix for invalid MakerNotes leading to picture not read at all
 # https://github.com/LeoHsiao1/pyexiv2/issues/58
 pyexiv2.set_log_level(4)
 
+tz_finder = timezonefinder.TimezoneFinder()
+
 
 @dataclass
 class CropValues:
@@ -41,8 +45,8 @@ class GeoPicTags:
     Attributes:
         lat (float): GPS Latitude (in WGS84)
         lon (float): GPS Longitude (in WGS84)
-        ts (float): The capture date (as POSIX timestamp)
-        heading (int): Picture heading (in degrees, North = 0°, East = 90°, South = 180°, West = 270°)
+        ts (datetime): The capture date (date & time with timezone)
+        heading (int): Picture heading/yaw (in degrees, North = 0°, East = 90°, South = 180°, West = 270°)
         type (str): The kind of picture (flat, equirectangular)
         make (str): The camera manufacturer name
         model (str): The camera model name
@@ -51,6 +55,8 @@ class GeoPicTags:
         exif (dict[str, str]): Raw EXIF tags from picture (following Exiv2 naming scheme, see https://exiv2.org/metadata.html)
         tagreader_warnings (list[str]): List of thrown warnings during metadata reading
         altitude (float): altitude (in m) (optional)
+        pitch (float): Picture pitch angle, compared to horizon (in degrees, bottom = -90°, horizon = 0°, top = 90°)
+        roll (float): Picture roll angle, on a right/left axis (in degrees, left-arm down = -90°, flat = 0°, right-arm down = 90°)
 
 
     Implementation note: this needs to be sync with the PartialGeoPicTags structure
@@ -58,7 +64,7 @@ class GeoPicTags:
 
     lat: float
     lon: float
-    ts: float
+    ts: datetime.datetime
     heading: Optional[int]
     type: str
     make: Optional[str]
@@ -68,6 +74,8 @@ class GeoPicTags:
     exif: Dict[str, str] = field(default_factory=lambda: {})
     tagreader_warnings: List[str] = field(default_factory=lambda: [])
     altitude: Optional[float] = None
+    pitch: Optional[float] = None
+    roll: Optional[float] = None
 
 
 class InvalidExifException(Exception):
@@ -86,7 +94,7 @@ class PartialGeoPicTags:
 
     lat: Optional[float] = None
     lon: Optional[float] = None
-    ts: Optional[float] = None
+    ts: Optional[datetime.datetime] = None
     heading: Optional[int] = None
     type: Optional[str] = None
     make: Optional[str] = None
@@ -96,6 +104,8 @@ class PartialGeoPicTags:
     exif: Dict[str, str] = field(default_factory=lambda: {})
     tagreader_warnings: List[str] = field(default_factory=lambda: [])
     altitude: Optional[float] = None
+    pitch: Optional[float] = None
+    roll: Optional[float] = None
 
 
 class PartialExifException(Exception):
@@ -142,6 +152,11 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
         except:
             pass
 
+    # Sanitize charset information
+    for k, v in data.items():
+        if isinstance(v, str):
+            data[k] = re.sub(r"charset=[^\s]+", "", v).strip()
+
     # Parse latitude/longitude
     lat, lon, llw = decodeLatLon(data, "Exif.GPSInfo")
     if len(llw) > 0:
@@ -163,13 +178,13 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
         raise InvalidExifException("Read longitude is out of WGS84 bounds (should be in [-180, 180])")
 
     # Parse date/time
-    d, llw = decodeGPSDateTime(data, "Exif.GPSInfo")
+    d, llw = decodeGPSDateTime(data, "Exif.GPSInfo", lat, lon)
 
     if len(llw) > 0:
         warnings.extend(llw)
 
     if d is None:
-        d, llw = decodeGPSDateTime(data, "Xmp.exif")
+        d, llw = decodeGPSDateTime(data, "Xmp.exif", lat, lon)
         if len(llw) > 0:
             warnings.extend(llw)
 
@@ -180,7 +195,7 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
         "Xmp.GPano.SourceImageCreateTime",
     ]:
         if d is None:
-            d, llw = decodeDateTimeOriginal(data, exifField)
+            d, llw = decodeDateTimeOriginal(data, exifField, lat, lon)
             if len(llw) > 0:
                 warnings.extend(llw)
 
@@ -204,7 +219,7 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
         except Exception as e:
             warnings.append("Skipping Mapillary date/time as it was not recognized:\n\t" + str(e))
 
-    # Heading
+    # Heading/Yaw
     heading = None
     if isExifTagUsable(data, "Xmp.GPano.PoseHeadingDegrees", float) and isExifTagUsable(data, "Exif.GPSInfo.GPSImgDirection", Fraction):
         gpsDir = int(round(float(Fraction(data["Exif.GPSInfo.GPSImgDirection"]))))
@@ -227,6 +242,35 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
     elif "MAPCompassHeading" in data and isExifTagUsable(data["MAPCompassHeading"], "TrueHeading", float):
         heading = int(round(float(data["MAPCompassHeading"]["TrueHeading"])))
 
+    # Pitch & roll
+    pitch = None
+    roll = None
+    exifPRFields = ["Xmp.Camera.$$", "Exif.GPSInfo.GPS$$", "Xmp.GPano.Pose$$Degrees", "Xmp.GPano.InitialView$$Degrees"]
+    # For each potential EXIF field
+    for exifField in exifPRFields:
+        # Try out both Pitch & Roll variants
+        for checkField in ["Pitch", "Roll"]:
+            exifCheckField = exifField.replace("$$", checkField)
+            foundValue = None
+            # Look for float or fraction
+            if isExifTagUsable(data, exifCheckField, float):
+                foundValue = float(data[exifCheckField])
+            elif isExifTagUsable(data, exifCheckField, Fraction):
+                foundValue = float(Fraction(data[exifCheckField]))
+
+            # Save to correct variable (if not already set)
+            if foundValue is not None:
+                if checkField == "Pitch":
+                    if pitch is None:
+                        pitch = foundValue
+                    else:
+                        continue
+                elif checkField == "Roll":
+                    if roll is None:
+                        roll = foundValue
+                    else:
+                        continue
+
     # Make and model
     make = data.get("Exif.Image.Make") or data.get("MAPDeviceMake")
     model = data.get("Exif.Image.Model") or data.get("MAPDeviceModel")
@@ -313,7 +357,7 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
             PartialGeoPicTags(
                 lat,
                 lon,
-                d.timestamp() if d else None,
+                d,
                 heading,
                 pic_type,
                 make,
@@ -323,6 +367,8 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
                 exif=data,
                 tagreader_warnings=warnings,
                 altitude=altitude,
+                pitch=pitch,
+                roll=roll,
             ),
         )
 
@@ -330,7 +376,7 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
     return GeoPicTags(
         lat,
         lon,
-        d.timestamp(),
+        d,
         heading,
         pic_type,
         make,
@@ -340,6 +386,8 @@ def readPictureMetadata(picture: bytes) -> GeoPicTags:
         exif=data,
         tagreader_warnings=warnings,
         altitude=altitude,
+        pitch=pitch,
+        roll=roll,
     )
 
 
@@ -429,7 +477,9 @@ def decodeLatLon(data: dict, group: str) -> Tuple[Optional[float], Optional[floa
     return (lat, lon, warnings)
 
 
-def decodeDateTimeOriginal(data: dict, datetimeField: str) -> Tuple[Optional[datetime.datetime], List[str]]:
+def decodeDateTimeOriginal(
+    data: dict, datetimeField: str, lat: Optional[float] = None, lon: Optional[float] = None
+) -> Tuple[Optional[datetime.datetime], List[str]]:
     d = None
     warnings = []
 
@@ -442,7 +492,6 @@ def decodeDateTimeOriginal(data: dict, datetimeField: str) -> Tuple[Optional[dat
             secondsRaw, microsecondsRaw, msw = decodeSecondsAndMicroSeconds(
                 timeRaw[2], data["Exif.Photo.SubSecTimeOriginal"] if isExifTagUsable(data, "Exif.Photo.SubSecTimeOriginal", float) else "0"
             )
-            tz = decodeTimeOffset(data, f"Exif.Photo.OffsetTime{'Original' if 'DateTimeOriginal' in datetimeField else ''}")
             warnings += msw
 
             d = datetime.datetime.combine(
@@ -452,9 +501,30 @@ def decodeDateTimeOriginal(data: dict, datetimeField: str) -> Tuple[Optional[dat
                     minutesRaw,
                     secondsRaw,
                     microsecondsRaw,
-                    tzinfo=tz or datetime.timezone.utc,
                 ),
             )
+
+            # Timezone handling
+            # Try to read from EXIF
+            tz = decodeTimeOffset(data, f"Exif.Photo.OffsetTime{'Original' if 'DateTimeOriginal' in datetimeField else ''}")
+            if tz is not None:
+                d = d.replace(tzinfo=tz)
+
+            # Otherwise, try to deduct from coordinates
+            elif lon is not None and lat is not None:
+                tz_name = tz_finder.timezone_at(lng=lon, lat=lat)
+                if tz_name is not None:
+                    d = pytz.timezone(tz_name).localize(d)
+                # Otherwise, default to UTC + warning
+                else:
+                    d = d.replace(tzinfo=datetime.timezone.utc)
+                    warnings.append("Precise timezone information not found, fallback to UTC")
+
+            # Otherwise, default to UTC + warning
+            else:
+                d = d.replace(tzinfo=datetime.timezone.utc)
+                warnings.append("Precise timezone information not found (and no GPS coordinates to help), fallback to UTC")
+
         except ValueError as e:
             warnings.append("Skipping original date/time (from " + datetimeField + ") as it was not recognized:\n\t" + str(e))
 
@@ -467,7 +537,9 @@ def decodeTimeOffset(data: dict, offsetTimeField: str) -> Optional[datetime.tzin
     return None
 
 
-def decodeGPSDateTime(data: dict, group: str) -> Tuple[Optional[datetime.datetime], List[str]]:
+def decodeGPSDateTime(
+    data: dict, group: str, lat: Optional[float] = None, lon: Optional[float] = None
+) -> Tuple[Optional[datetime.datetime], List[str]]:
     d = None
     warnings = []
 
@@ -504,6 +576,12 @@ def decodeGPSDateTime(data: dict, group: str) -> Tuple[Optional[datetime.datetim
                     ),
                 )
 
+                # Set timezone from coordinates
+                if lon is not None and lat is not None:
+                    tz_name = tz_finder.timezone_at(lng=lon, lat=lat)
+                    if tz_name is not None:
+                        d = d.astimezone(pytz.timezone(tz_name))
+
         except ValueError as e:
             warnings.append(f"Skipping GPS date/time ({group} group) as it was not recognized:\n\t{str(e)}")
 

geopic_tag_reader/writer.py

@@ -3,11 +3,11 @@ from datetime import datetime, timedelta
 from dataclasses import dataclass
 from geopic_tag_reader.model import PictureType
 from enum import Enum
+import timezonefinder  # type: ignore
+import pytz
 
 try:
     import pyexiv2  # type: ignore
-    import timezonefinder  # type: ignore
-    import pytz
 except ImportError:
     raise Exception(
         """Impossible to write the exif tags without the '[write-exif]' dependency (that will need to install libexiv2).

{geopic_tag_reader-1.0.6.dist-info → geopic_tag_reader-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: geopic-tag-reader
-Version: 1.0.6
+Version: 1.1.1
 Summary: GeoPicTagReader
 Author-email: Adrien PAVIE <panieravide@riseup.net>
 Requires-Python: >=3.8
@@ -9,6 +9,9 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Dist: typer ~= 0.12
 Requires-Dist: xmltodict ~= 0.13
 Requires-Dist: pyexiv2 == 2.8.3
+Requires-Dist: timezonefinder == 6.2.0
+Requires-Dist: pytz ~= 2023.3
+Requires-Dist: types-pytz ~= 2023.3.0.1
 Requires-Dist: flit ~= 3.8.0 ; extra == "build"
 Requires-Dist: black ~= 24.3 ; extra == "dev"
 Requires-Dist: mypy ~= 1.9 ; extra == "dev"
@@ -17,9 +20,6 @@ Requires-Dist: pytest-datafiles ~= 3.0 ; extra == "dev"
 Requires-Dist: lazydocs ~= 0.4.8 ; extra == "dev"
 Requires-Dist: types-xmltodict ~= 0.13 ; extra == "dev"
 Requires-Dist: pre-commit ~= 3.3.3 ; extra == "dev"
-Requires-Dist: timezonefinder == 6.2.0 ; extra == "write-exif"
-Requires-Dist: pytz ~= 2023.3 ; extra == "write-exif"
-Requires-Dist: types-pytz ~= 2023.3.0.1 ; extra == "write-exif"
 Requires-Dist: python-dateutil ~= 2.8.2 ; extra == "write-exif"
 Project-URL: Home, https://gitlab.com/geovisio/geo-picture-tag-reader
 Provides-Extra: build

geopic_tag_reader-1.1.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+geopic_tag_reader/__init__.py,sha256=7hT1At7Ce4FtNeMuBZa7cDah_cJoIhJrnQWbEAF0BE8,47
+geopic_tag_reader/camera.py,sha256=2Sr0jAt3RXUWazYMnkwF6J6lVnKvSp7Ac8g7yOHehVA,1643
+geopic_tag_reader/main.py,sha256=ZEZaZEeaDxRjrVMwhR5lUYJWKkUcjd8avjqm7JxJdhM,3219
+geopic_tag_reader/model.py,sha256=rsWVE3T1kpNsKXX8iv6xb_3PCVY6Ea7iU9WOqUgXklU,129
+geopic_tag_reader/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geopic_tag_reader/reader.py,sha256=4yoQU-ljOgLmaH_hc1m4o1YkSNgaPfM38NVmiM7rpbE,24543
+geopic_tag_reader/writer.py,sha256=QmQqQpWgb6AL3Y0Kuzy7PF1asUsTVDq9buwJXfFSRq8,8672
+geopic_tag_reader-1.1.1.dist-info/entry_points.txt,sha256=c9YwjCNhxveDf-61_aSRlzcpoutvM6KQCerlzaVt_JU,64
+geopic_tag_reader-1.1.1.dist-info/LICENSE,sha256=oHWDwXkJJb9zJzThMN3F9Li4yFhz1qxOUByouY7L3bI,1070
+geopic_tag_reader-1.1.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+geopic_tag_reader-1.1.1.dist-info/METADATA,sha256=iMhClAI5r1h2jpB_o-dwcSP3QVz4PuBPf4jWmZ_10Ks,6303
+geopic_tag_reader-1.1.1.dist-info/RECORD,,

geopic_tag_reader-1.0.6.dist-info/RECORD

@@ -1,12 +0,0 @@
-geopic_tag_reader/__init__.py,sha256=AB9t1irfcb0A7j8MHsCnqxKwAll8VkwJKfgEAPE4Jw4,47
-geopic_tag_reader/camera.py,sha256=2Sr0jAt3RXUWazYMnkwF6J6lVnKvSp7Ac8g7yOHehVA,1643
-geopic_tag_reader/main.py,sha256=LohJW0xX0A8DAbcUR_BnJ2UvN4qo6yydzOGtq3zIArA,3129
-geopic_tag_reader/model.py,sha256=rsWVE3T1kpNsKXX8iv6xb_3PCVY6Ea7iU9WOqUgXklU,129
-geopic_tag_reader/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-geopic_tag_reader/reader.py,sha256=PK1mN7TFFC8V70-pU_EM6cTESNcAed1GydHWUkqkT3A,21325
-geopic_tag_reader/writer.py,sha256=L13ewadZhZic13k66FsQvqGQ_s512nssKvvSwZp4Ggg,8680
-geopic_tag_reader-1.0.6.dist-info/entry_points.txt,sha256=c9YwjCNhxveDf-61_aSRlzcpoutvM6KQCerlzaVt_JU,64
-geopic_tag_reader-1.0.6.dist-info/LICENSE,sha256=oHWDwXkJJb9zJzThMN3F9Li4yFhz1qxOUByouY7L3bI,1070
-geopic_tag_reader-1.0.6.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-geopic_tag_reader-1.0.6.dist-info/METADATA,sha256=US7A6UqzLzwlLvtCiHWPQszwLTNtNt_Pzka6DLJBbmg,6375
-geopic_tag_reader-1.0.6.dist-info/RECORD,,