From ad98c1a88af34cce1f8a2f5a5922478be12aabc2 Mon Sep 17 00:00:00 2001
From: Laura <mail@laura.fm>
Date: Wed, 22 Mar 2023 22:29:29 +0100
Subject: [PATCH] Batch annotations per tool for increased performance

---
 .idea/remarks.iml             | 20 ++++++++++++++++++++
 remarks/conversion/drawing.py | 33 ++++++++++++++++++++++++---------
 2 files changed, 44 insertions(+), 9 deletions(-)
 create mode 100644 .idea/remarks.iml

diff --git a/.idea/remarks.iml b/.idea/remarks.iml
new file mode 100644
index 0000000..8567454
--- /dev/null
+++ b/.idea/remarks.iml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/remarks" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/venv" />
+      <excludeFolder url="file://$MODULE_DIR$/.pytest_cache" />
+      <excludeFolder url="file://$MODULE_DIR$/.venv" />
+      <excludeFolder url="file://$MODULE_DIR$/tests/in" />
+      <excludeFolder url="file://$MODULE_DIR$/tests" />
+      <excludeFolder url="file://$MODULE_DIR$/demo" />
+    </content>
+    <orderEntry type="jdk" jdkName="Poetry (remarks) (3)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PyDocumentationSettings">
+    <option name="format" value="PLAIN" />
+    <option name="myDocStringFormat" value="Plain" />
+  </component>
+</module>
\ No newline at end of file
diff --git a/remarks/conversion/drawing.py b/remarks/conversion/drawing.py
index ec5e4f0..cb39b1d 100644
--- a/remarks/conversion/drawing.py
+++ b/remarks/conversion/drawing.py
@@ -113,6 +113,9 @@ def prepare_segments(data):
 def draw_annotations_on_pdf(data, page, inplace=False):
     segments = prepare_segments(data)
 
+    # annot.update() calls have a lot of overhead.
+    # We can batch tools with equal settings to reduce the amount of calls drastically
+    batched_lines_per_tool = {}
     for seg_name, seg_data in segments.items():
         seg_type = seg_name.split("_")[0]
 
@@ -164,18 +167,30 @@ def draw_annotations_on_pdf(data, page, inplace=False):
 
         # Scribbles
         else:
+            # add all lines with the same tool-configuration to the same batch
+            batch_key = (seg_data['stroke-width'], seg_data['opacity'], seg_data['color-code'])
+
+            if batch_key in batched_lines_per_tool:
+                batch_points = batched_lines_per_tool[batch_key]
+            else:
+                batch_points = []
+                batched_lines_per_tool[batch_key] = batch_points
+
             for seg_points in seg_data["points"]:
-                # https://pymupdf.readthedocs.io/en/latest/recipes-annotations.html#how-to-use-ink-annotations
-                annot = page.add_ink_annot([seg_points])
-                annot.set_border(width=seg_data["stroke-width"])
-                annot.set_opacity(seg_data["opacity"])
+                batch_points.append(seg_points)
 
-                color_array = fitz.utils.getColor(
-                    SC_COLOR_CODES[seg_data["color-code"]]
-                )
-                annot.set_colors(stroke=color_array)
+    # draw the batched lines
+    for (stroke_width, opacity, color_code), points in batched_lines_per_tool.items():
+        annot = page.add_ink_annot(points)
+        annot.set_border(width=stroke_width)
+        annot.set_opacity(opacity)
 
-                annot.update()
+        color_array = fitz.utils.getColor(
+            SC_COLOR_CODES[color_code]
+        )
+        annot.set_colors(stroke=color_array)
+
+        annot.update()
 
     if not inplace:
         return page