diff --git a/.cz.toml b/.cz.toml index e0587c9..bf15647 100644 --- a/.cz.toml +++ b/.cz.toml @@ -2,6 +2,6 @@ name = "cz_conventional_commits" tag_format = "$version" version_scheme = "semver2" -version = "0.1.1" +version = "0.5.1" update_changelog_on_bump = true major_version_zero = true diff --git a/.forgejo/workflows/build-release.yml b/.forgejo/workflows/build-release.yml index 7f7e489..d669e3d 100644 --- a/.forgejo/workflows/build-release.yml +++ b/.forgejo/workflows/build-release.yml @@ -21,21 +21,26 @@ jobs: with: go-version: '1.21' - - name: Install UPX + - name: Install gox and UPX run: | + go install github.com/mitchellh/gox@latest wget -O upx.tar.xz https://github.com/upx/upx/releases/download/v5.0.1/upx-5.0.1-amd64_linux.tar.xz tar -xf upx.tar.xz cp upx-5.0.1-amd64_linux/upx /usr/local/bin/ cp upx-5.0.1-amd64_linux/upx.1 /usr/local/share/man/man1/ || true chmod +x /usr/local/bin/upx - - name: Build normal binary + - name: Build cross-platform binaries run: | - go build -o fps-go-brr . + gox -os="darwin" -os="linux" -os="windows" -arch="amd64" -arch="arm64" -osarch="linux/386" -osarch="windows/386" -output="build/{{.Dir}}-{{.OS}}-{{.Arch}}" - - name: Build compact binary + - name: Compress Linux binaries with UPX run: | - ./build-compact.sh + for file in build/*linux*; do + if [ -f "$file" ]; then + upx --brute "$file" + fi + done - name: Get version id: version @@ -46,23 +51,56 @@ jobs: echo "version=dev-$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT fi - - name: Create release directory + - name: Create platform bundles run: | mkdir -p release - cp fps-go-brr release/fps-go-brr-${{ steps.version.outputs.version }} - cp fps-go-brr-compact release/fps-go-brr-compact-${{ steps.version.outputs.version }} - - name: Upload normal binary + # Create Darwin (macOS) bundle + mkdir -p bundle-darwin + cp build/fps-go-brr-darwin-amd64 bundle-darwin/ 2>/dev/null || true + cp build/fps-go-brr-darwin-arm64 bundle-darwin/ 2>/dev/null || true + if [ "$(ls -A bundle-darwin 2>/dev/null)" ]; then + tar -czf release/fps-go-brr-darwin-${{ steps.version.outputs.version }}.tar.gz -C bundle-darwin . + fi + + # Create Linux bundle + mkdir -p bundle-linux + cp build/fps-go-brr-linux-amd64 bundle-linux/ 2>/dev/null || true + cp build/fps-go-brr-linux-arm64 bundle-linux/ 2>/dev/null || true + cp build/fps-go-brr-linux-386 bundle-linux/ 2>/dev/null || true + if [ "$(ls -A bundle-linux 2>/dev/null)" ]; then + tar -czf release/fps-go-brr-linux-${{ steps.version.outputs.version }}.tar.gz -C bundle-linux . + fi + + # Create Windows bundle + mkdir -p bundle-windows + cp build/fps-go-brr-windows-amd64.exe bundle-windows/ 2>/dev/null || true + cp build/fps-go-brr-windows-arm64.exe bundle-windows/ 2>/dev/null || true + cp build/fps-go-brr-windows-386.exe bundle-windows/ 2>/dev/null || true + if [ "$(ls -A bundle-windows 2>/dev/null)" ]; then + tar -czf release/fps-go-brr-windows-${{ steps.version.outputs.version }}.tar.gz -C bundle-windows . + fi + + - name: Upload Darwin bundle uses: forgejo/upload-artifact@v4 with: - name: fps-go-brr-normal-${{ steps.version.outputs.version }} - path: release/fps-go-brr-${{ steps.version.outputs.version }} + name: fps-go-brr-darwin-${{ steps.version.outputs.version }} + path: release/fps-go-brr-darwin-${{ steps.version.outputs.version }}.tar.gz + if-no-files-found: ignore - - name: Upload compact binary + - name: Upload Linux bundle uses: forgejo/upload-artifact@v4 with: - name: fps-go-brr-compact-${{ steps.version.outputs.version }} - path: release/fps-go-brr-compact-${{ steps.version.outputs.version }} + name: fps-go-brr-linux-${{ steps.version.outputs.version }} + path: release/fps-go-brr-linux-${{ steps.version.outputs.version }}.tar.gz + if-no-files-found: ignore + + - name: Upload Windows bundle + uses: forgejo/upload-artifact@v4 + with: + name: fps-go-brr-windows-${{ steps.version.outputs.version }} + path: release/fps-go-brr-windows-${{ steps.version.outputs.version }}.tar.gz + if-no-files-found: ignore - name: Create Release if: startsWith(github.ref, 'refs/tags/') @@ -75,7 +113,8 @@ jobs: ## fps-go-brr ${{ steps.version.outputs.version }} ### Downloads - - `fps-go-brr-${{ steps.version.outputs.version }}` - Normal build - - `fps-go-brr-compact-${{ steps.version.outputs.version }}` - Compact build (optimized with UPX compression) + - `fps-go-brr-darwin-${{ steps.version.outputs.version }}.tar.gz` - macOS builds (amd64, arm64) + - `fps-go-brr-linux-${{ steps.version.outputs.version }}.tar.gz` - Linux builds (amd64, arm64, 386) - compressed with UPX + - `fps-go-brr-windows-${{ steps.version.outputs.version }}.tar.gz` - Windows builds (amd64, arm64, 386) - The compact build is smaller but may have slightly slower startup time due to decompression. \ No newline at end of file + Linux binaries are compressed with UPX for smaller size but may have slightly slower startup time due to decompression. \ No newline at end of file diff --git a/.gitignore b/.gitignore index 8c2fbb0..8b75846 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ fps-go-brr +fps-go-brr-compact +.vscode/settings.json diff --git a/CHANGELOG.md b/CHANGELOG.md index e7b3606..479a1ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,38 @@ +## 0.5.1 (2025-06-17) + +### Fix + +- **csv output**: add missing frame width and height headers + +## 0.5.0 (2025-06-16) + +### Feat + +- **main**: add a ton of features - progress bar - frame res measurements - verbosity flag +- add gox build script + +### Refactor + +- **README**: add resdet info +- **README**: add new lines before lists to fit markdown standard + +## 0.4.0 (2025-06-15) + +## 0.3.0 (2025-06-15) + +### Refactor + +- change variable and function names to fit with golang conventions +- remove pointless else statments +- add package string +- **gitignore**: ignore compact build binary + +## 0.2.0 (2025-06-14) + +### Feat + +- **LICENSE**: add dual licenses + ## 0.1.1 (2025-06-14) ### Feat diff --git a/CLAUDE.md b/CLAUDE.md index 3610f7f..cdc3578 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -43,6 +43,10 @@ go build -o fps-go-brr . # Optimized compact build (requires UPX) ./build-compact.sh ./fps-go-brr-compact [args] + +# Cross-platform build (requires gox) +go install github.com/mitchellh/gox@latest +gox -os="darwin" -os="linux" -os="windows" -arch="amd64" -arch="arm64" -osarch="linux/386" -osarch="windows/386" ``` ### Testing @@ -57,14 +61,32 @@ go mod download ``` ### Release Builds -- Forgejo Actions automatically build and release both normal and compact binaries on tag pushes +- Forgejo Actions automatically build and release cross-platform binaries on tag pushes - Uses custom runner: `9950x` -- Normal and compact builds are uploaded as separate artifacts -- UPX compression applied to compact builds for size optimization +- Cross-compilation via `gox` for Darwin (macOS), Linux, and Windows +- Multiple architectures: amd64, arm64, and 386 (Linux/Windows only) +- UPX compression applied to Linux builds only using `--brute` flag +- Platform-specific `.tar.gz` bundles for distribution + +## Repository Information + +- **Main Repository**: https://git.aria.coffee/aria/fps-go-brr (Personal Forgejo instance) +- **Mirror**: https://github.com/BuyMyMojo/fps-go-brr (GitHub - accepts PRs and issues) +- **Dual Licensed**: MIT OR Apache-2.0 (SPDX-License-Identifier: MIT OR Apache-2.0) +- **Copyright**: 2025 Aria, Wicket + +### Inspirations + +This project draws inspiration from: +- Digital Foundry (YouTube) - Professional video game performance analysis +- Brazil Pixel (YouTube) - Technical video analysis and frame rate studies +- TRDrop (GitHub) - Raw video analysis program for framerate estimation +- Original Python implementation - Early proof-of-concept for frame persistence analysis ## Memories - The forgejo workflow runner is executed as root so it does not need to use root +- Updated workflow to use `gox` for cross-compilation and create platform-specific `.tar.gz` bundles ## CLI Usage diff --git a/LICENSE.Apache-2.0 b/LICENSE.Apache-2.0 new file mode 100644 index 0000000..f8ecd81 --- /dev/null +++ b/LICENSE.Apache-2.0 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2025 Aria, Wicket + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE.MIT b/LICENSE.MIT new file mode 100644 index 0000000..ab98e1e --- /dev/null +++ b/LICENSE.MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Aria, Wicket + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..eab8096 --- /dev/null +++ b/README.md @@ -0,0 +1,148 @@ +# fps-go-brr + +> **⚠️ Work in Progress**: This project is actively under development and not yet feature-complete! + +A Go CLI tool for video frame analysis and comparison. Analyze frame persistence, detect dropped frames, and export data for visualization tools like those used by Digital Foundry. + +## Features + +- **Frame Persistence Analysis**: Detect consecutive duplicate frames and measure persistence duration +- **CSV Export**: Generate data compatible with video analysis visualization tools +- **Multi-format Support**: Works with any video format supported by FFmpeg +- **Configurable Tolerance**: Adjust pixel difference sensitivity for noisy videos +- **Real-time Analysis**: Stream processing for efficient memory usage +- **Two-pass Architecture**: Accurate frame timing calculations for smooth visualizations +- **Resolution Measurements**: Using the [resdet](https://github.com/0x09/resdet) cli to log dynamic resolutions (Requires resdet to be installed seperately) + +## Quick Start + +### Installation + +Download the latest release from the [releases page](https://git.aria.coffee/aria/fps-go-brr/releases) or build from source: + +```bash +# Clone the repository +git clone https://git.aria.coffee/aria/fps-go-brr.git +cd fps-go-brr + +# Build normally +go build -o fps-go-brr . + +# Or build compact version (requires UPX) +./build-compact.sh +``` + +### Basic Usage + +```bash +# Analyze frame persistence with CSV export +./fps-go-brr analyze-frame-persistence video.mp4 --csv-output analysis.csv + +# With tolerance for noisy videos +./fps-go-brr analyze-frame-persistence video.mp4 --tolerance 10 --csv-output analysis.csv + +# Count total frames in a video +./fps-go-brr count-frames video.mp4 + +# Compare two individual frames +./fps-go-brr compare-frames frame1.png frame2.png +``` + +## CSV Output Format + +The `analyze-frame-persistence` command generates CSV files with the following columns: + +| Column | Description | +|--------|-------------| +| `frame` | Frame number (starts on 1) | +| `average_fps` | Running effective FPS calculation | +| `frame_time` | Current frame persistence duration (ms) | +| `unique_frame_count` | Cumulative unique frame count | +| `real_frame_time` | Total persistence time for smooth visualization | + +## Use Cases + +- **Game Performance Analysis**: Detect frame drops and stuttering in gameplay footage +- **Technical Reviews**: Generate data for Digital Foundry-style analysis + +## Development Status + +This project is under active development. Current feature wish list: + +- [ ] Enhanced frame comparison algorithms +- [ ] Performance optimizations for large videos +- [ ] Additional export formats +- [ ] Cross-platform testing and compatibility +- [ ] Documentation improvements +- [ ] Graph generation from CSV + +## Building + +### Prerequisites + +- Go 1.21 or later +- UPX (optional, for compact builds) + +### Commands + +```bash +# Standard build +go build -o fps-go-brr . + +# Compact build with UPX compression +./build-compact.sh +``` + +## Repository + +**Main Repository**: [https://git.aria.coffee/aria/fps-go-brr](https://git.aria.coffee/aria/fps-go-brr) +**Mirror (GitHub)**: [https://github.com/BuyMyMojo/fps-go-brr](https://github.com/BuyMyMojo/fps-go-brr) + +The main development happens on the personal Forgejo instance. The GitHub mirror also accepts pull requests and bug reports for convenience. + +## Contributing + +This is an early-stage project. Contributions, bug reports, and feature requests are welcome on either the main repository or the GitHub mirror! + +## Technical Details + +Built with: + +- **CLI Framework**: [urfave/cli/v3](https://github.com/urfave/cli) +- **Video Processing**: [AlexEidt/Vidio](https://github.com/AlexEidt/Vidio) +- **Image Processing**: Go standard library + + + + +## Inspirations + +This project draws inspiration from: + +- **[Digital Foundry](https://www.youtube.com/@DigitalFoundry)** - Professional video game performance analysis and technical reviews +- **[Brazil Pixel](https://www.youtube.com/@brazilpixel)** - Technical video analysis and frame rate studies +- **[TRDrop](https://github.com/cirquit/trdrop)** - Raw video analysis program for framerate estimation and tear detection +- **[Original Python implementation](https://web.archive.org/web/20250613174657/https://snippets.aria.coffee/snippets/2)** - Early proof-of-concept for frame persistence analysis + +The goal is to provide similar professional-grade video analysis capabilities for the open-source community. + +## Note on AI use + +The use of AI in this project is minor and just an experiment, all major design decisions and functionality are heavily worked on by humans! + +I do hope for future AI tools with ethical models to be avaliable and verifiable in the future! + +The testing phase for Claude's coding agent in this repo is finished and it shall not contribute more to the code at the current time. + +## License + +SPDX-License-Identifier: MIT OR Apache-2.0 + +This project is dual-licensed under your choice of: + +- MIT License - see [LICENSE.MIT](LICENSE.MIT) file for details +- Apache License 2.0 - see [LICENSE.Apache-2.0](LICENSE.Apache-2.0) file for details + +Copyright (c) 2025 Aria, Wicket + +--- diff --git a/build-all.sh b/build-all.sh new file mode 100755 index 0000000..bdb6fe6 --- /dev/null +++ b/build-all.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +gox -os="darwin" -os="linux" -os="windows" -arch="amd64" -arch="arm64" -osarch="linux/386" -osarch="windows/386" diff --git a/go.mod b/go.mod index 65f4038..c27d3ff 100644 --- a/go.mod +++ b/go.mod @@ -4,7 +4,16 @@ go 1.24.3 require ( github.com/AlexEidt/Vidio v1.5.1 // indirect + github.com/VividCortex/ewma v1.2.0 // indirect + github.com/cheggaaa/pb v1.0.29 // indirect + github.com/cheggaaa/pb/v3 v3.1.7 // indirect + github.com/fatih/color v1.18.0 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/mattn/go-runewidth v0.0.16 // indirect + github.com/rivo/uniseg v0.4.7 // indirect github.com/urfave/cli/v3 v3.3.3 // indirect github.com/zmb3/gogetdoc v0.0.0-20190228002656-b37376c5da6a // indirect + golang.org/x/sys v0.30.0 // indirect golang.org/x/tools v0.0.0-20181207195948-8634b1ecd393 // indirect ) diff --git a/go.sum b/go.sum index 46ec524..b1bef7b 100644 --- a/go.sum +++ b/go.sum @@ -1,8 +1,35 @@ github.com/AlexEidt/Vidio v1.5.1 h1:tovwvtgQagUz1vifiL9OeWkg1fP/XUzFazFKh7tFtaE= github.com/AlexEidt/Vidio v1.5.1/go.mod h1:djhIMnWMqPrC3X6nB6ymGX6uWWlgw+VayYGKE1bNwmI= +github.com/VividCortex/ewma v1.2.0 h1:f58SaIzcDXrSy3kWaHNvuJgJ3Nmz59Zji6XoJR/q1ow= +github.com/VividCortex/ewma v1.2.0/go.mod h1:nz4BbCtbLyFDeC9SUHbtcT5644juEuWfUAUnGx7j5l4= +github.com/cheggaaa/pb v1.0.29 h1:FckUN5ngEk2LpvuG0fw1GEFx6LtyY2pWI/Z2QgCnEYo= +github.com/cheggaaa/pb v1.0.29/go.mod h1:W40334L7FMC5JKWldsTWbdGjLo0RxUKK73K+TuPxX30= +github.com/cheggaaa/pb/v3 v3.1.7 h1:2FsIW307kt7A/rz/ZI2lvPO+v3wKazzE4K/0LtTWsOI= +github.com/cheggaaa/pb/v3 v3.1.7/go.mod h1:/Ji89zfVPeC/u5j8ukD0MBPHt2bzTYp74lQ7KlgFWTQ= +github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU= +github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM= +github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU= +github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= +github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= +github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= +github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/urfave/cli/v3 v3.3.3 h1:byCBaVdIXuLPIDm5CYZRVG6NvT7tv1ECqdU4YzlEa3I= github.com/urfave/cli/v3 v3.3.3/go.mod h1:FJSKtM/9AiiTOJL4fJ6TbMUkxBXn7GO9guZqoZtpYpo= github.com/zmb3/gogetdoc v0.0.0-20190228002656-b37376c5da6a h1:00UFliGZl2UciXe8o/2iuEsRQ9u7z0rzDTVzuj6EYY0= github.com/zmb3/gogetdoc v0.0.0-20190228002656-b37376c5da6a/go.mod h1:ofmGw6LrMypycsiWcyug6516EXpIxSbZ+uI9ppGypfY= +golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= +golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/tools v0.0.0-20181207195948-8634b1ecd393 h1:0P8IF6+RwCumULxvjp9EtJryUs46MgLIgeHbCt7NU4Q= golang.org/x/tools v0.0.0-20181207195948-8634b1ecd393/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= diff --git a/main.go b/main.go index bec3afb..fa1d4b3 100644 --- a/main.go +++ b/main.go @@ -1,16 +1,23 @@ +// A Go CLI tool for video frame analysis and comparison. Analyze frame persistence, detect dropped frames, and export data for visualization tools like those used by Digital Foundry. package main import ( + "cmp" "context" "encoding/csv" + "errors" "fmt" "image" "image/draw" + "image/png" "log" "os" + "os/exec" "strconv" + "strings" vidio "github.com/AlexEidt/Vidio" + "github.com/cheggaaa/pb" "github.com/urfave/cli/v3" ) @@ -22,7 +29,7 @@ func main() { Usage: "Count frames", Action: func(ctx context.Context, cmd *cli.Command) error { - return count_video_frames(cmd.Args().First()) + return countVideoFrames(cmd.Args().First()) }, }, { @@ -39,12 +46,12 @@ func main() { Action: func(ctx context.Context, cmd *cli.Command) error { - first_frame, _ := getImageFromFilePath(cmd.StringArg("frame1")) - second_frame, _ := getImageFromFilePath(cmd.StringArg("frame2")) + firstFrame, _ := getImageFromFilePath(cmd.StringArg("frame1")) + secondFrame, _ := getImageFromFilePath(cmd.StringArg("frame2")) - first_rgba := imageToRGBA(first_frame) - second_rgba := imageToRGBA(second_frame) - return compare_frames(first_rgba, second_rgba) + firstRGBA := imageToRGBA(firstFrame) + secondRGBA := imageToRGBA(secondFrame) + return compareFrames(firstRGBA, secondRGBA) }, }, { @@ -61,12 +68,12 @@ func main() { Action: func(ctx context.Context, cmd *cli.Command) error { - first_frame, _ := getImageFromFilePath(cmd.StringArg("frame1")) - second_frame, _ := getImageFromFilePath(cmd.StringArg("frame2")) + firstFrame, _ := getImageFromFilePath(cmd.StringArg("frame1")) + secondFrame, _ := getImageFromFilePath(cmd.StringArg("frame2")) - first_rgba := imageToRGBA(first_frame) - second_rgba := imageToRGBA(second_frame) - return compare_frames_alt(first_rgba, second_rgba) + firstRGBA := imageToRGBA(firstFrame) + secondRGBA := imageToRGBA(secondFrame) + return compareFramesAlt(firstRGBA, secondRGBA) }, }, { @@ -94,9 +101,9 @@ func main() { }, }, Flags: []cli.Flag{ - &cli.Float64Flag{ + &cli.Uint64Flag{ Name: "tolerance", - Usage: "Pixel difference tolerance (0-255)", + Usage: "Pixel difference tolerance (0-255?)", Value: 0, }, &cli.StringFlag{ @@ -104,11 +111,46 @@ func main() { Usage: "Path to CSV file for frame data output", Value: "", }, + &cli.BoolFlag{ + Name: "resdet", + Usage: "use the resdet cli to measure each frame's resoltion\nWARNING: This will slow the process down by a LOT", + Value: false, + }, + + &cli.BoolFlag{ + Name: "verbose", + Usage: "print out total unique frames for every second of measurements", + Value: false, + }, + + &cli.BoolFlag{ + Name: "testing-log", + Usage: "make a seperate output csv in the same folder that live updates", + Value: false, + }, + + &cli.IntFlag{ + Name: "resdet-minimum-height", + Usage: "minimum possible height of detected image", + Value: 0, + }, + + &cli.IntFlag{ + Name: "resdet-minimum-width", + Usage: "minimum possible width of detected image", + Value: 0, + }, }, Action: func(ctx context.Context, cmd *cli.Command) error { - tolerance := uint64(cmd.Float64("tolerance")) + videoPath := cmd.StringArg("video") + + if videoPath == "" { + return fmt.Errorf("Must provide video path") + } + + tolerance := cmd.Uint64("tolerance") csvOutput := cmd.String("csv-output") - return analyzeFramePersistence(cmd.StringArg("video"), tolerance, csvOutput) + return analyzeFramePersistence(cmd.StringArg("video"), tolerance, csvOutput, cmd.Bool("resdet"), cmd.Bool("verbose"), cmd.Int("resdet-minimum-height"), cmd.Int("resdet-minimum-width"), cmd.Bool("testing-log")) }, }, }, @@ -119,7 +161,7 @@ func main() { } } -// count_video_frames +// countVideoFrames // Prints out the total ammount of frames within `video` // // Parameters: @@ -127,18 +169,18 @@ func main() { // // Returns: // - error -func count_video_frames(video string) error { +func countVideoFrames(video string) error { log.Default().Print("Trying to open video at: " + video) - video_file, _ := vidio.NewVideo(video) + videoFile, _ := vidio.NewVideo(video) count := 0 - for video_file.Read() { + for videoFile.Read() { count++ } log.Default().Println("Video total frames: " + strconv.Itoa(count)) return nil } -func compare_frames(frame1 *image.RGBA, frame2 *image.RGBA) error { +func compareFrames(frame1 *image.RGBA, frame2 *image.RGBA) error { accumError := int64(0) for i := 0; i < len(frame1.Pix); i++ { @@ -150,7 +192,7 @@ func compare_frames(frame1 *image.RGBA, frame2 *image.RGBA) error { return nil } -func compare_frames_alt(frame1 *image.RGBA, frame2 *image.RGBA) error { +func compareFramesAlt(frame1 *image.RGBA, frame2 *image.RGBA) error { // diff_frame := image.NewRGBA(frame1.Rect) accumError := int64(0) for i := 0; i < len(frame1.Pix); i++ { @@ -172,9 +214,10 @@ func isDiffUInt8(x, y uint8) bool { sq := d * d if sq > 0 { return true - } else { - return false } + + return false + } func isDiffUInt8WithTolerance(x, y uint8, tolerance uint64) bool { @@ -182,45 +225,46 @@ func isDiffUInt8WithTolerance(x, y uint8, tolerance uint64) bool { sq := d * d if sq > tolerance { return true - } else { - return false } + + return false + } -func countUniqueVideoFrames(video_path1 string, video_path2 string, min_diff uint64, use_sq_diff bool) error { - video1, _ := vidio.NewVideo(video_path1) - video2, _ := vidio.NewVideo(video_path2) - video1_frame := image.NewRGBA(image.Rect(0, 0, video1.Width(), video1.Height())) - video2_frame := image.NewRGBA(image.Rect(0, 0, video2.Width(), video2.Height())) - video1.SetFrameBuffer(video1_frame.Pix) - video2.SetFrameBuffer(video2_frame.Pix) - total_frames := 0 - unique_frames := 0 +func countUniqueVideoFrames(videoPath1 string, videoPath2 string, minDiff uint64, useSqDiff bool) error { + video1, _ := vidio.NewVideo(videoPath1) + video2, _ := vidio.NewVideo(videoPath2) + video1Frame := image.NewRGBA(image.Rect(0, 0, video1.Width(), video1.Height())) + video2Frame := image.NewRGBA(image.Rect(0, 0, video2.Width(), video2.Height())) + video1.SetFrameBuffer(video1Frame.Pix) + video2.SetFrameBuffer(video2Frame.Pix) + totalFrames := 0 + uniqueFrames := 0 for video1.Read() { - total_frames++ + totalFrames++ video2.Read() accumError := uint64(0) - for i := 0; i < len(video1_frame.Pix); i++ { - if use_sq_diff { - if isDiffUInt8WithTolerance(video1_frame.Pix[i], video2_frame.Pix[i], min_diff) { + for i := 0; i < len(video1Frame.Pix); i++ { + if useSqDiff { + if isDiffUInt8WithTolerance(video1Frame.Pix[i], video2Frame.Pix[i], minDiff) { accumError++ } } else { - if isDiffUInt8(video1_frame.Pix[i], video2_frame.Pix[i]) { + if isDiffUInt8(video1Frame.Pix[i], video2Frame.Pix[i]) { accumError++ } } } - if min_diff <= accumError { - unique_frames++ - log.Default().Println("[" + strconv.Itoa(total_frames) + "]Unique frame") + if minDiff <= accumError { + uniqueFrames++ + log.Default().Println("[" + strconv.Itoa(totalFrames) + "]Unique frame") } else { - log.Default().Println("[" + strconv.Itoa(total_frames) + "]Non-unique frame") + log.Default().Println("[" + strconv.Itoa(totalFrames) + "]Non-unique frame") } } video1.Close() video2.Close() - log.Default().Println(strconv.Itoa(unique_frames) + "/" + strconv.Itoa(total_frames) + " are unique!") + log.Default().Println(strconv.Itoa(uniqueFrames) + "/" + strconv.Itoa(totalFrames) + " are unique!") return nil } @@ -248,7 +292,7 @@ func getImageFromFilePath(filePath string) (image.Image, error) { return image, err } -func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput string) error { +func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput string, toggleResdet bool, verbose bool, minResdetHeight int, minResdetWidth int, liveCSV bool) error { video, err := vidio.NewVideo(videoPath) if err != nil { return err @@ -268,11 +312,11 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin return fmt.Errorf("failed to create CSV file: %v", err) } defer csvFile.Close() - + csvWriter = csv.NewWriter(csvFile) defer csvWriter.Flush() - - err = csvWriter.Write([]string{"frame", "average_fps", "frame_time", "unique_frame_count", "real_frame_time"}) + + err = csvWriter.Write([]string{"frame", "average_fps", "frame_time", "unique_frame_count", "real_frame_time", "frame_width", "frame_height"}) if err != nil { return fmt.Errorf("failed to write CSV header: %v", err) } @@ -285,11 +329,13 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin effectiveFPS float64 currentFrameTime float64 realFrameTime float64 + frameWidth int + frameHeight int } - + var frameAnalysisData []FrameData var uniqueFrameDurations []int // Duration of each unique frame - + currentFrame := image.NewRGBA(image.Rect(0, 0, video.Width(), video.Height())) previousFrame := image.NewRGBA(image.Rect(0, 0, video.Width(), video.Height())) video.SetFrameBuffer(currentFrame.Pix) @@ -298,6 +344,8 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin var frameNumber int var uniqueFramesPerSecond []int var framePersistenceDurations []float64 + var frameWidthMeasurements []int + var frameHeightMeasurements []int currentSecond := 0 uniqueFramesInCurrentSecond := 0 @@ -307,16 +355,40 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin hasFirstFrame := false + bar := pb.StartNew(video.Frames()) + for video.Read() { frameNumber++ + // frame colum will be full of 0s normally, not the worst compromise + frameWidth := 0 + frameHeight := 0 + + // mesure resoltion + if toggleResdet { + var lastFrameWidth int + var lastFrameHeight int + + if len(frameWidthMeasurements) != 0 { + lastFrameWidth = frameWidthMeasurements[len(frameWidthMeasurements)-1] + lastFrameHeight = frameHeightMeasurements[len(frameHeightMeasurements)-1] + } else { + lastFrameWidth = currentFrame.Bounds().Max.X + lastFrameHeight = currentFrame.Bounds().Max.X + } + frameWidth, frameHeight = resdet(verbose, currentFrame, frameWidth, frameHeight, minResdetHeight, minResdetHeight, lastFrameWidth, lastFrameHeight) + } + + frameWidthMeasurements = append(frameWidthMeasurements, frameWidth) + frameHeightMeasurements = append(frameHeightMeasurements, frameHeight) + if !hasFirstFrame { copy(previousFrame.Pix, currentFrame.Pix) hasFirstFrame = true uniqueFramesInCurrentSecond = 1 totalUniqueFrames = 1 currentUniqueFrameDuration = 1 - + // Store data for first frame currentTime := float64(frameNumber) / fps effectiveFPS := float64(totalUniqueFrames) / currentTime @@ -327,6 +399,8 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin effectiveFPS: effectiveFPS, currentFrameTime: actualFrameTimeMs, realFrameTime: 0, // Will be calculated in second pass + frameWidth: frameWidth, + frameHeight: frameHeight, }) continue } @@ -356,7 +430,7 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin uniqueFrameDurations[totalUniqueFrames-1] = currentUniqueFrameDuration } } - + if consecutiveDuplicateCount > 1 { persistenceMs := float64(consecutiveDuplicateCount+1) * frameTimeMs framePersistenceDurations = append(framePersistenceDurations, persistenceMs) @@ -367,7 +441,7 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin uniqueFramesInCurrentSecond++ totalUniqueFrames++ copy(previousFrame.Pix, currentFrame.Pix) - + // Start tracking new unique frame currentUniqueFrameDuration = 1 } @@ -382,17 +456,52 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin effectiveFPS: effectiveFPS, currentFrameTime: actualFrameTimeMs, realFrameTime: 0, // Will be calculated in second pass + frameWidth: frameWidth, + frameHeight: frameHeight, }) - newSecond := int(float64(frameNumber-1) / fps) - if newSecond > currentSecond { - uniqueFramesPerSecond = append(uniqueFramesPerSecond, uniqueFramesInCurrentSecond) - log.Default().Printf("Second %d: %d unique frames", currentSecond+1, uniqueFramesInCurrentSecond) - currentSecond = newSecond - uniqueFramesInCurrentSecond = 0 + if verbose { + newSecond := int(float64(frameNumber-1) / fps) + if newSecond > currentSecond { + uniqueFramesPerSecond = append(uniqueFramesPerSecond, uniqueFramesInCurrentSecond) + log.Default().Printf("Second %d: %d unique frames", currentSecond+1, uniqueFramesInCurrentSecond) + currentSecond = newSecond + uniqueFramesInCurrentSecond = 0 + } } + + if liveCSV { + if _, err := os.Stat("live.csv"); errors.Is(err, os.ErrNotExist) { + f, err := os.Create("live.csv") + if err != nil { + return err + } + + _, err = f.WriteString("frame, average_fps, frame_time, unique_frame_count, real_frame_time, frame_width, frame_height\n") + if err != nil { + return err + } + + f.Close() + } + + f, err := os.OpenFile("live.csv", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) + if err != nil { + return err + } + + currentFrameData := frameAnalysisData[len(frameAnalysisData)-1] + + fmt.Fprintf(f, "%v, %.2f, %.2f, %v, %.2f, %v, %v\n", currentFrameData.frameNumber, currentFrameData.effectiveFPS, currentFrameData.currentFrameTime, currentFrameData.uniqueFrameCount, currentFrameData.realFrameTime, currentFrameData.frameWidth, currentFrameData.frameHeight) + + f.Close() + } + + bar.Increment() } + bar.Finish() + // Record the final unique frame duration if totalUniqueFrames > 0 { if len(uniqueFrameDurations) < totalUniqueFrames { @@ -412,6 +521,8 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin fmt.Sprintf("%.2f", frameData.currentFrameTime), strconv.Itoa(frameData.uniqueFrameCount), fmt.Sprintf("%.2f", realFrameTimeMs), + strconv.Itoa(frameData.frameWidth), + strconv.Itoa(frameData.frameHeight), }) if err != nil { log.Default().Printf("Warning: failed to write CSV row %d: %v", i+1, err) @@ -458,5 +569,62 @@ func analyzeFramePersistence(videoPath string, tolerance uint64, csvOutput strin log.Default().Printf("No frame persistence detected (all frames are unique)") } + if len(frameWidthMeasurements) > 0 && len(frameHeightMeasurements) > 0 { + sumWidth := 0 + sumHeight := 0 + + for _, width := range frameWidthMeasurements { + sumWidth += width + } + + if sumWidth != 0 { + + for _, height := range frameHeightMeasurements { + sumHeight += height + } + + avgWidth := float64(sumWidth) / float64(len(frameWidthMeasurements)) + avgHeight := float64(sumHeight) / float64(len(frameHeightMeasurements)) + log.Default().Printf("Average Width: %.2f", avgWidth) + log.Default().Printf("Average Height: %.2f", avgHeight) + } + } + return nil } + +func resdet(verbose bool, currentFrame *image.RGBA, frameWidth int, frameHeight int, minHeight int, minWidth int, prevFrameWidth int, prevFrameHeight int) (int, int) { + frameFile, err0 := os.Create("/tmp/frame.png") + + err1 := png.Encode(frameFile, currentFrame) + + out, err2 := exec.Command("resdet", "-v", "1", frameFile.Name()).Output() + + err3 := frameFile.Close() + + err4 := os.Remove(frameFile.Name()) + + formattedOutput := strings.Split(string(out), " ") + + frameWidthOut, err5 := strconv.Atoi(formattedOutput[0]) + + frameHeightOut, err6 := strconv.Atoi(strings.TrimSuffix(formattedOutput[1], "\n")) + + if err := cmp.Or(err0, err1, err2, err3, err4, err5, err6); err != nil { + log.Fatal(err) + } + + if frameHeightOut > minHeight { + frameHeight = frameHeightOut + } else { + frameHeight = prevFrameHeight + } + + if frameWidthOut > minWidth { + frameWidth = frameWidthOut + } else { + frameWidth = prevFrameWidth + } + + return frameWidth, frameHeight +}