From df912533abca0ebda5b12959362e8c521fc1ee40 Mon Sep 17 00:00:00 2001
From: Cynthia Lin <cyntlin@amazon.com>
Date: Fri, 11 Jun 2021 15:11:42 -0700
Subject: [PATCH] [ATOM-15781] Add Python script for calculating avg/max frame
 render time of a sample.

---
 .../timestamp_aggregator.py                   | 62 +++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 Gems/Atom/Feature/Common/Assets/Scripts/performance_metrics/timestamp_aggregator.py

diff --git a/Gems/Atom/Feature/Common/Assets/Scripts/performance_metrics/timestamp_aggregator.py b/Gems/Atom/Feature/Common/Assets/Scripts/performance_metrics/timestamp_aggregator.py
new file mode 100644
index 0000000000..0508395275
--- /dev/null
+++ b/Gems/Atom/Feature/Common/Assets/Scripts/performance_metrics/timestamp_aggregator.py
@@ -0,0 +1,62 @@
+#!/usr/bin/env python
+"""
+All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+its licensors.
+
+For complete copyright and license terms please see the LICENSE at the root of this
+distribution (the "License"). All use of this software is governed by the License,
+or, if provided, by the license below or the license accompanying this file. Do not
+remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+"""
+
+from genericpath import isdir
+from argparse import ArgumentParser
+import json
+from pathlib import Path
+import os
+
+# this allows us to add additional data if necessary, e.g. frame_test_timestamps.json
+is_timestamp_file = lambda file: file.name.startswith('frame') and file.name.endswith('_timestamps.json')
+ns_to_ms = lambda time: time / 1e6
+
+def main(logs_dir):
+    count = 0
+    total = 0
+    maximum = 0
+
+    print(f'Analyzing frame timestamp logs in {logs_dir}')
+
+    # go through files in alphabetical order (remove sorted() if not necessary)
+    for file in sorted(logs_dir.iterdir(), key=lambda file: len(file.name)):
+        if file.is_dir() or not is_timestamp_file(file):
+            continue
+
+        data = json.loads(file.read_text())
+        entries = data['ClassData']['timestampEntries']
+        timestamps = [entry['timestampResultInNanoseconds'] for entry in entries]
+
+        frame_time = sum(timestamps)
+        frame_name = file.name.split('_')[0]
+        print(f'- Total time for frame {frame_name}: {ns_to_ms(frame_time)}ms')
+
+        maximum = max(maximum, frame_time)
+        total += frame_time
+        count += 1
+
+    if count < 1:
+        print(f'No logs were found in {base_dir}')
+        exit(1)
+
+    print(f'Avg. time across {count} frames: {ns_to_ms(total / count)}ms')
+    print(f'Max frame time: {ns_to_ms(maximum)}ms')
+
+if __name__ == '__main__':
+    parser = ArgumentParser(description='Gathers statistics from a group of pass timestamp logs')
+    parser.add_argument('path', help='Path to the directory containing the pass timestamp logs')
+    args = parser.parse_args()
+
+    base_dir = Path(args.path)
+    if not base_dir.exists():
+        raise FileNotFoundError('Invalid path provided')
+    main(base_dir)