feat: Add commit status

in03 · in03 · commit 6715c3cb626d · 2022-11-28T16:47:36.000+10:00
diff --git a/src/dpg.ini b/src/dpg.ini
@@ -5,12 +5,12 @@ Collapsed=0
 
 [Window][###90]
 Pos=3,3
-Size=290,495
+Size=226,181
 Collapsed=0
 
 [Window][###23]
-Pos=151,225
-Size=153,100
+Pos=152,225
+Size=458,100
 Collapsed=0
 
 [Window][###93]
@@ -23,3 +23,8 @@ Pos=3,3
 Size=100,100
 Collapsed=0
 
+[Window][###96]
+Pos=3,3
+Size=290,495
+Collapsed=0
+
diff --git a/src/patchwork/app.py b/src/patchwork/app.py
@@ -1,3 +1,5 @@
+
+import copy
 from datetime import datetime, timedelta
 import logging
 from pathlib import Path
@@ -12,6 +14,7 @@
 
 import dearpygui.dearpygui as dpg
 
+# Logging
 logging.basicConfig(
     level="NOTSET",
     format="%(message)s",
@@ -20,20 +23,32 @@
 )
 logger = logging.getLogger(__name__)
 
+# GLOBAL VARS
+
+app_file_path = Path(__file__)
+src_folder = app_file_path.parent.absolute()
+root_folder = src_folder.parent.absolute()
+
+# Flags
+start_timecode_check_dismissed = False
+
+# Counters
+in_3_sec = datetime.now() + timedelta(seconds=3)
+in_half_sec = datetime.now() + timedelta(seconds=0.5)
+
+
+# DearPyGUI Init
 dpg.create_context()
 dpg.set_global_font_scale(1.5)
 
 def save_init():
     dpg.save_init_file("dpg.ini")
 
-app_file_path = Path(__file__)
-src_folder = app_file_path.parent.absolute()
-root_folder = src_folder.parent.absolute()
-
 width, height, channels, data = dpg.load_image(os.path.join(src_folder, "logo.png"))
 with dpg.texture_registry(show=False):
     dpg.add_static_texture(width=width, height=height, default_value=data, tag="texture_tag")
     
+import routines
 from widgets import dialog_box
 
 # RESOLVE INIT
@@ -233,9 +248,8 @@ def toggle_always_on_top():
     else:
         dpg.set_viewport_always_top(False)
 
-# Commands
 def create_marker():
-    
+
     timeline = resolve.active_timeline
     framerate = resolve.active_timeline.settings.frame_rate
     min_duration = int(framerate) * 2
@@ -250,8 +264,8 @@ def create_marker():
         name=f"Change - {get_next_free_marker_num()}", 
         customdata="patchwork_marker"
     ):
-    
-        dialog_box.prompt("Looks like there's already a marker there!")
+        return False
+    return True
 
 def clear_markers():
     """
@@ -260,11 +274,27 @@ def clear_markers():
     timeline = resolve.active_timeline
     markers = timeline.markers.find_all("patchwork_marker")
     
-    if markers:
-        
-        [x.delete() for x in markers]
-        
+    if not markers:
+        return False
+    
+    [x.delete() for x in markers]
+    return True
+
+# Commands
+def add_change():
+      
+    if not create_marker():
+        dialog_box.prompt("Looks like there's already a marker there!")
+        return
+
+def clear_changes():
+    
+    if not clear_markers():
+        dialog_box.prompt("Oops, no changes to clear.")
+        return
+
 def commit_changes():
+    
     project = resolve.project
     timeline = resolve.active_timeline
     framerate = timeline.settings.frame_rate
@@ -299,6 +329,7 @@ def commit_changes():
         job_id = project.add_renderjob()
         job_ids.append(job_id)
         print(job_ids)
+        
 
 def push_changes():
     ...
@@ -349,10 +380,10 @@ def open_documentation():
                 with dpg.group(tag="add_group", horizontal=True):
                     
                     # ADD BUTTON
-                    dpg.add_button(label="Add", tag="Add", callback=create_marker)
+                    dpg.add_button(label="Add", tag="Add", callback=add_change)
                     
                     # CLEAR BUTTON
-                    dpg.add_button(label="Clear Changes", tag="clear_changes", callback=clear_markers)
+                    dpg.add_button(label="Clear Changes", tag="clear_changes", callback=clear_changes)
                     with dpg.tooltip("clear_changes"):
                         dpg.add_text("Clear all of Patchwork's ranged-markers\nfrom the active timeline")
                         
@@ -363,7 +394,9 @@ def open_documentation():
                             
                 # COMMIT BUTTON
                 dpg.add_text("Commit changes and create render jobs", wrap=500)
-                dpg.add_button(label="Commit", tag="Commit", callback=commit_changes)
+                with dpg.group(tag="commit_group"):
+                    dpg.add_text("No changes to commit", tag="commit_status", color=[255, 100, 100], wrap=500)
+                    dpg.add_button(label="Commit", tag="Commit", callback=commit_changes)
                     
                 dpg.add_separator()
                 dpg.add_spacer(height=20) 
@@ -407,77 +440,30 @@ def open_documentation():
 dpg.setup_dearpygui()
 dpg.show_viewport()
 
-# Flags
-start_timecode_check_dismissed = False
-
-# Counters
-in_3_sec = datetime.now() + timedelta(seconds=3)
-in_half_sec = datetime.now() + timedelta(seconds=0.5)
 while dpg.is_dearpygui_running():
-    
-    if datetime.now() > in_half_sec:
-        
-        # TODO: Check Resolve is open, lock up whole interface with warning otherwise
-        # No option to dismiss dialog box. Automatically dismiss box when Resolve is opened
         
-        # TODO: Check timeline is open, lock up whole interface with warning otherwise
-        # No option to dismiss dialog box. Automatically dismiss box when timeline is opened
-        
-        # TODO: Check timeline is same as tracked timeline, disable changes page
-        # On each timeline change, ensure custom settings are enabled. Make it so.        
-        
-        # TODO: Check timeline timecode start is 00:00:00, since it causes markers to be in the wrong place
-        # Lock up interface with dialog with options to set timecode to 00:00:00 or close the app: "Set" "Exit"
-        frame_rate = resolve.active_timeline.settings.frame_rate
-        current_timecode = resolve.active_timeline.timecode
-
-        if not start_timecode_check_dismissed:
-            if Timecode(frame_rate, current_timecode).hrs >= 1:
-                if not dpg.is_item_shown("dialog_box"):
-                    
-                    dialog_box.prompt(
-                        "Hey! Does your timeline timecode start at 01:00:00? If so, please set it to 00:00:00. "
-                        "Resolve's API has a glitch that causes markers to appear an hour later on the timeline. "
-                        "If not, nevermind."
-                    )
-                    start_timecode_check_dismissed = True
+    # REACTIVE VARIABLES
+    markers = copy.copy(resolve.active_timeline.markers)
+    frame_rate = copy.copy(resolve.active_timeline.settings.frame_rate)
+    current_timecode = copy.copy(resolve.active_timeline.timecode)
+    
+    # SIMPLE
+    resolve.active_timeline.custom_settings(True)
 
     
-    # Refresh current timecode
-        
-        current_timecode = resolve.active_timeline.timecode
-        resolve.active_timeline.custom_settings(True)
-        framerate = resolve.active_timeline.settings.frame_rate
-        
-        current_marker = None
-        current_frame = Timecode(framerate, resolve.active_timeline.timecode).frames
-        
-        if current_frame:
-            
-            current_frame -=1 
-            current_marker = [x for x in resolve.active_timeline.markers if current_frame >= x.frameid and current_frame < (x.frameid + x.duration)]
+    # TODO: Check Resolve is open, lock up whole interface with warning otherwise
+    # No option to dismiss dialog box. Automatically dismiss box when Resolve is opened
+    
+    # TODO: Check timeline is open, lock up whole interface with warning otherwise
+    # No option to dismiss dialog box. Automatically dismiss box when timeline is opened
+    
+    # TODO: Check timeline is same as tracked timeline, disable changes page
+    # On each timeline change, ensure custom settings are enabled. Make it so.
         
-        if current_marker:
-            
-            assert len(current_marker) == 1
-            current_marker = current_marker[0]
-            
-            #TODO: Set flag to allow prompting "overwrite"
-            
-            if not current_marker.customdata == "patchwork_marker":
-                
-                dpg.set_value("current_timecode_display", f"On unsupported marker")
-                dpg.configure_item("current_timecode_display", color=[250, 0, 0])  
-                
-            else:
-                dpg.set_value("current_timecode_display", f"On marker: '{current_marker.name}'")
-                dpg.configure_item("current_timecode_display", color=[0, 255, 0])
-            
-        else:
-            dpg.set_value("current_timecode_display", f"{current_timecode} | {current_frame}")
-            dpg.configure_item("current_timecode_display", color=[50, 150, 255])
+    routines.check_timecode_starts_at_zero(current_timecode, frame_rate)
+    routines.refresh_add_status(markers, current_timecode, frame_rate)
+    routines.refresh_commit_status(markers)
         
-        in_half_sec = datetime.now() + timedelta(seconds=0.5)
     dpg.render_dearpygui_frame()
 
 # TODO: Fix save init file
diff --git a/src/patchwork/routines.py b/src/patchwork/routines.py
@@ -0,0 +1,137 @@
+from datetime import datetime, timedelta
+from timecode import Timecode
+from dearpygui import dearpygui as dpg
+from pydavinci.wrappers.marker import MarkerCollection
+from widgets import dialog_box
+
+# TODO: Fix this! 
+# While it does block functions from running every half second
+# It also allows multiple function calls at dpg's refresh rate for the next half second...
+def is_refreshable(refresh_rate:float) -> bool:
+
+    current_time = datetime.now()
+    last_run = dpg.get_value(f"{refresh_rate}_lastrun")
+    
+    if last_run == None:
+        with dpg.value_registry():
+            dpg.add_string_value(tag=f"{refresh_rate}_lastrun", default_value=str(current_time.strftime('%y%m%d%H%M%S')))
+            last_run = dpg.get_value(f"{refresh_rate}_lastrun")
+    
+    last_run = datetime.strptime(last_run, '%y%m%d%H%M%S')
+    if current_time - last_run < timedelta(seconds=refresh_rate):
+        return False
+    
+    dpg.set_value(f"{refresh_rate}_lastrun", str(current_time.strftime('%y%m%d%H%M%S')))
+    return True
+
+def refresh_add_status(markers:MarkerCollection, current_timecode:str, frame_rate:float, refresh_rate:float=0.5):
+    
+    if not is_refreshable(refresh_rate):
+        return
+
+    current_frame = Timecode(frame_rate, current_timecode).frames
+    current_marker = None
+    
+    if current_frame:
+        
+        current_frame -=1 # Single frame offset for some reason
+        current_marker = [x for x in markers if current_frame >= x.frameid and current_frame < (x.frameid + x.duration)]
+    
+    if current_marker:
+        
+        assert len(current_marker) == 1
+        current_marker = current_marker[0]
+        
+        #TODO: Set flag to allow prompting "overwrite"
+        
+        if not current_marker.customdata == "patchwork_marker":
+            
+            dpg.set_value("current_timecode_display", f"On unsupported marker")
+            dpg.configure_item("current_timecode_display", color=[250, 0, 0])  
+            
+        else:
+            dpg.set_value("current_timecode_display", f"On marker: '{current_marker.name}'")
+            dpg.configure_item("current_timecode_display", color=[0, 255, 0])
+        
+    else:
+        dpg.set_value("current_timecode_display", f"{current_timecode} | {current_frame}")
+        dpg.configure_item("current_timecode_display", color=[50, 150, 255])
+
+def check_timecode_starts_at_zero(current_timecode:str, frame_rate:float, refresh_rate:float=0.5):
+    """
+    Check that the Resolve timeline timecode starts at 00:00:00
+    
+    If it doesn't weird things happen with the markers (Resolve's fault).
+    Prompt the user once per session. Unfortunately, running this once outside of the
+    render loop doesn't seem to work. So we set a flag, but run it each time. 
+
+    Args:
+        current_timecode (str): The current timecode at playhead position
+        frame_rate (float): The timeline framerate
+        start_timecode_check_dismissed (bool): The flag to check for dialog box dismissal
+    """
+    
+    if not is_refreshable(refresh_rate):
+        return
+    
+    dismissed = dpg.get_value("zero_timecode_warning_dismissed")
+    if dismissed is None:
+        with dpg.value_registry():
+            dpg.add_bool_value(tag="zero_timecode_warning_dismissed", default_value=False)
+        
+    if not dismissed:  
+        
+        if Timecode(frame_rate, current_timecode).hrs >= 1:  
+            dialog_box.prompt(
+                "Hey! Does your timeline timecode start at 01:00:00? If so, please set it to 00:00:00. "
+                "Resolve's API has a glitch that causes markers to appear an hour later on the timeline. "
+                "If not, nevermind."
+            )
+            dpg.set_value("zero_timecode_warning_dismissed", True)
+
+def refresh_commit_status(markers:MarkerCollection, refresh_rate:float=0.5):
+    
+    if not is_refreshable(refresh_rate):
+        return
+    else:
+        print("hey")
+    
+    committed_changes = []
+    uncommitted_changes = []
+    invalid_changes = []
+
+    for x in markers:
+        if x.customdata != "patchwork_marker":
+            continue
+        if x.color == "Green":
+            committed_changes.append(x)
+        elif x.color == "Purple":
+            uncommitted_changes.append(x)
+        else:
+            invalid_changes.append(x)
+
+    assert not invalid_changes 
+            
+    if committed_changes and not uncommitted_changes:
+        dpg.configure_item("commit_status", color=[0, 255, 0]) 
+        dpg.set_value("commit_status", f"All changes committed")
+        
+    elif uncommitted_changes and not committed_changes:
+        dpg.configure_item("commit_status", color=[255, 150, 0]) 
+        dpg.set_value("commit_status", f"{len(uncommitted_changes)} uncommitted")
+
+    elif uncommitted_changes:
+        dpg.configure_item("commit_status", color=[255, 150, 0]) 
+        dpg.set_value(
+            "commit_status", 
+            f"{len(uncommitted_changes)} uncommitted | "
+            f"{len(committed_changes)} committed"
+        )
+
+    elif not committed_changes and not uncommitted_changes:
+        dpg.configure_item("commit_status", color=[50, 150, 255])
+        dpg.set_value("commit_status", "No changes")
+        
+    else:
+        dpg.configure_item("commit_status", color=[255, 150, 0])
+        dpg.set_value("commit_status", "N/A")
diff --git a/src/patchwork/widgets/__init__.py b/src/patchwork/widgets/__init__.py
