Added the ability to define a custom compression ratio for PSA export

io_scene_psk_psa/psa/export/operators.py

@@ -137,6 +137,17 @@ def get_sequence_fps(context: Context, fps_source: str, fps_custom: float, actio
             raise RuntimeError(f'Invalid FPS source "{fps_source}"')
 
 
+def get_sequence_compression_ratio(compression_ratio_source: str, compression_ratio_custom: float, actions: Iterable[Action]) -> float:
+    match compression_ratio_source:
+        case 'ACTION_METADATA':
+            # Get the minimum value of action metadata compression ratio values.
+            return min([action.psa_export.compression_ratio for action in actions])
+        case 'CUSTOM':
+            return compression_ratio_custom
+        case _:
+            raise RuntimeError(f'Invalid compression ratio source "{compression_ratio_source}"')
+
+
 def get_animation_data_object(context: Context) -> Object:
     pg: PSA_PG_export = getattr(context.scene, 'psa_export')
 
@@ -285,7 +296,10 @@ class PSA_OT_export(Operator, ExportHelper):
             sequences_panel.template_list(PSA_UL_export_sequences.bl_idname, '', pg, propname, pg, active_propname,
                                           rows=max(3, min(len(getattr(pg, propname)), 10)))
 
-            flow = sequences_panel.grid_flow()
+            name_header, name_panel = layout.panel('Name', default_closed=False)
+            name_header.label(text='Name')
+            if name_panel:
+                flow = name_panel.grid_flow()
                 flow.use_property_split = True
                 flow.use_property_decorate = False
                 flow.prop(pg, 'sequence_name_prefix', text='Name Prefix')
@@ -300,10 +314,24 @@ class PSA_OT_export(Operator, ExportHelper):
                         layout.label(text=f'Duplicate action: {action_name}', icon='ERROR')
                         break
 
+            data_source_header, data_source_panel = layout.panel('Data Source', default_closed=False)
+            data_source_header.label(text='Data Sources')
+            if data_source_panel:
+                flow = data_source_panel.grid_flow()
+                flow.use_property_split = True
+                flow.use_property_decorate = False
+
                 # FPS
-            flow.prop(pg, 'fps_source')
+                col = flow.row(align=True)
+                col.prop(pg, 'fps_source', text='FPS')
                 if pg.fps_source == 'CUSTOM':
-                flow.prop(pg, 'fps_custom', text='Custom')
+                    col.prop(pg, 'fps_custom', text='')
+
+                # COMPRESSION RATIO
+                col = flow.row(align=True)
+                col.prop(pg, 'compression_ratio_source', text='Compression Ratio')
+                if pg.compression_ratio_source == 'CUSTOM':
+                    col.prop(pg, 'compression_ratio_custom', text='')
 
         # BONES
         bones_header, bones_panel = layout.panel('Bones', default_closed=False)
@@ -406,7 +434,7 @@ class PSA_OT_export(Operator, ExportHelper):
                     export_sequence.nla_state.frame_start = action_item.frame_start
                     export_sequence.nla_state.frame_end = action_item.frame_end
                     export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, [action_item.action])
-                    export_sequence.compression_ratio = action_item.action.psa_export.compression_ratio
+                    export_sequence.compression_ratio = get_sequence_compression_ratio(pg.compression_ratio_source, pg.compression_ratio_custom, [action_item.action])
                     export_sequence.key_quota = action_item.action.psa_export.key_quota
                     export_sequences.append(export_sequence)
             case 'TIMELINE_MARKERS':
@@ -418,6 +446,7 @@ class PSA_OT_export(Operator, ExportHelper):
                     nla_strips_actions = set(
                         map(lambda x: x.action, get_nla_strips_in_frame_range(animation_data, marker_item.frame_start, marker_item.frame_end)))
                     export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, nla_strips_actions)
+                    export_sequence.compression_ratio = get_sequence_compression_ratio(pg.compression_ratio_source, pg.compression_ratio_custom, nla_strips_actions)
                     export_sequences.append(export_sequence)
             case 'NLA_TRACK_STRIPS':
                 for nla_strip_item in filter(lambda x: x.is_selected, pg.nla_strip_list):
@@ -426,7 +455,7 @@ class PSA_OT_export(Operator, ExportHelper):
                     export_sequence.nla_state.frame_start = nla_strip_item.frame_start
                     export_sequence.nla_state.frame_end = nla_strip_item.frame_end
                     export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, [nla_strip_item.action])
-                    export_sequence.compression_ratio = nla_strip_item.action.psa_export.compression_ratio
+                    export_sequence.compression_ratio = get_sequence_compression_ratio(pg.compression_ratio_source, pg.compression_ratio_custom, [nla_strip_item.action])
                     export_sequence.key_quota = nla_strip_item.action.psa_export.key_quota
                     export_sequences.append(export_sequence)
             case 'ACTIVE_ACTION':
@@ -438,7 +467,7 @@ class PSA_OT_export(Operator, ExportHelper):
                     export_sequence.nla_state.frame_start = int(action.frame_range[0])
                     export_sequence.nla_state.frame_end = int(action.frame_range[1])
                     export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, [action])
-                    export_sequence.compression_ratio = action.psa_export.compression_ratio
+                    export_sequence.compression_ratio = get_sequence_compression_ratio(pg.compression_ratio_source, pg.compression_ratio_custom, [action])
                     export_sequence.key_quota = action.psa_export.key_quota
                     export_sequences.append(export_sequence)
             case _:

io_scene_psk_psa/psa/export/properties.py

@@ -156,6 +156,16 @@ class PSA_PG_export(PropertyGroup):
     )
     fps_custom: FloatProperty(default=30.0, min=sys.float_info.epsilon, soft_min=1.0, options=empty_set, step=100,
                               soft_max=60.0)
+    compression_ratio_source: EnumProperty(
+        name='Compression Ratio Source',
+        options=empty_set,
+        description='',
+        items=(
+            ('ACTION_METADATA', 'Action Metadata', 'The compression ratio will be determined by action\'s Compression Ratio property found in the PSA Export panel.\n\nIf the Sequence Source is Timeline Markers, the lowest value of all contributing actions will be used', 'ACTION', 1),
+            ('CUSTOM', 'Custom', '', 2)
+        )
+    )
+    compression_ratio_custom: FloatProperty(default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames')
     action_list: CollectionProperty(type=PSA_PG_export_action_list_item)
     action_list_index: IntProperty(default=0)
     marker_list: CollectionProperty(type=PSA_PG_export_timeline_markers)