Adding support for blurhash

api/directory_watcher.py

@@ -195,6 +195,11 @@ def handle_new_image(user, path, job_id, photo=None):
                     job_id, path, elapsed
                 )
             )
+            photo._get_blurhash()
+            elapsed = (datetime.datetime.now() - start).total_seconds()
+            util.logger.info(
+                "job {}: get blurhash: {}, elapsed: {}".format(job_id, path, elapsed)
+            )
             photo._recreate_search_captions()
             elapsed = (datetime.datetime.now() - start).total_seconds()
             util.logger.info(

api/migrations/0076_add_blurhash.py

@@ -0,0 +1,14 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("api", "0075_alter_face_cluster_person"),
+    ]
+    operations = [
+        migrations.AddField(
+            model_name="Photo",
+            name="blurhash",
+            field=models.TextField(blank=True, null=True),
+        ),
+    ]

api/models/photo.py

@@ -4,6 +4,7 @@
 from fractions import Fraction
 from io import BytesIO
 
+import blurhash
 import numpy as np
 import PIL
 import requests
@@ -73,6 +74,7 @@ class Photo(models.Model):
     captions_json = models.JSONField(blank=True, null=True, db_index=True)
 
     dominant_color = models.TextField(blank=True, null=True)
+    blurhash = models.TextField(blank=True, null=True)
 
     search_captions = models.TextField(blank=True, null=True, db_index=True)
     search_location = models.TextField(blank=True, null=True, db_index=True)
@@ -836,6 +838,19 @@ def _get_dominant_color(self, palette_size=16):
         except Exception:
             logger.info("Cannot calculate dominant color {} object".format(self))
 
+    def _get_blurhash(self, palette_size=16):
+        # Skip if it's already calculated
+        if self.blurhash:
+            return
+        try:
+            hash = blurhash.encode(
+                self.square_thumbnail_small.path, x_components=4, y_components=4
+            )
+            self.blurhash = hash
+            self.save()
+        except Exception:
+            logger.info("Cannot calculate blurhash {} object".format(self))
+
     def manual_delete(self):
         for file in self.files.all():
             if os.path.isfile(file.path):
@@ -873,7 +888,7 @@ def _set_embedded_media(self, obj):
         return obj.main_file.embedded_media
 
     def __str__(self):
-        main_file_path = self.main_file.path if self.main_file is not None else "No main file"
-        return (
-            "{} - {} - {}".format(self.image_hash, self.owner, main_file_path)
+        main_file_path = (
+            self.main_file.path if self.main_file is not None else "No main file"
         )
+        return "{} - {} - {}".format(self.image_hash, self.owner, main_file_path)

api/serializers/photos.py

@@ -11,6 +11,7 @@
 class PhotoSummarySerializer(serializers.ModelSerializer):
     id = serializers.SerializerMethodField()
     dominantColor = serializers.SerializerMethodField()
+    blurhash = serializers.SerializerMethodField()
     aspectRatio = serializers.SerializerMethodField()
     url = serializers.SerializerMethodField()
     location = serializers.SerializerMethodField()
@@ -25,6 +26,7 @@ class Meta:
         fields = (
             "id",
             "dominantColor",
+            "blurhash",
             "url",
             "location",
             "date",
@@ -84,6 +86,12 @@ def get_dominantColor(self, obj) -> str:
         else:
             return ""
 
+    def get_blurhash(self, obj) -> str:
+        if obj.blurhash:
+            return obj.blurhash
+        else:
+            return ""
+
     def get_type(self, obj) -> str:
         if obj.video:
             return "video"

api/views/albums.py

@@ -364,6 +364,7 @@ def get_queryset(self):
                 "main_file",
                 "search_location",
                 "dominant_color",
+                "blurhash",
                 "public",
                 "rating",
                 "hidden",

api/views/search.py

@@ -49,6 +49,7 @@ def list(self, request):
                     "main_file",
                     "search_location",
                     "dominant_color",
+                    "blurhash",
                     "public",
                     "rating",
                     "hidden",
@@ -82,6 +83,7 @@ def list(self, request):
                     "main_file",
                     "search_location",
                     "dominant_color",
+                    "blurhash",
                     "public",
                     "rating",
                     "hidden",

requirements.txt

@@ -50,3 +50,4 @@ timm==1.0.11
 transformers==4.46.2
 # Dependencies for mistral quantized
 llama-cpp-python==0.3.1
+blurhash-python==1.2.2