merge Feature/algorithms

.github/workflows/build.yml

@@ -70,7 +70,7 @@ jobs:
             - run: source $VENV
 
             - name: Build Backend
-              run: poetry run pyinstaller --noconfirm ETVR.spec TrackingBackend/main.py
+              run: poetry run pyinstaller --noconfirm ETVR.spec eyetrackvr_backend/main.py
 
             - name: Rename Linux Binary
               if: ${{ matrix.os == 'ubuntu-latest' }}

.github/workflows/lint.yml

@@ -1,14 +1,24 @@
 name: Lint
-on: [push, workflow_dispatch]
+on: [push, workflow_dispatch, pull_request]
 jobs:
     ruff:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v3
-            - name: Lint with Ruff
-              uses: chartboost/ruff-action@v1
+            - name: Setup Python
+              uses: actions/setup-python@v4
+              with:
+                  python-version: 3.11
+            - name: Setup Poetry
+              uses: snok/install-poetry@v1
               with:
-                  args: --select E,F --ignore E501,F401,F541
+                  virtualenvs-create: true
+                  virtualenvs-in-project: true
+                  installer-parallel: true
+            - name: Install dependencies
+              run: poetry install
+            - name: Lint with ruff
+              run: poetry run ruff check eyetrackvr_backend/
 
     pytest:
         runs-on: ubuntu-latest
@@ -49,4 +59,4 @@ jobs:
               run: poetry install
             - name: Lint with Mypy
               # Wish we could warn instead of erroring
-              run: poetry run mypy --ignore-missing-imports --check-untyped-defs --show-error-context --implicit-optional --disable-error-code union-attr TrackingBackend/
+              run: poetry run mypy --ignore-missing-imports --check-untyped-defs --show-error-context --implicit-optional --disable-error-code union-attr eyetrackvr_backend/

.gitignore

@@ -10,4 +10,8 @@ dist/
 build/
 tracker-config.json
 TrackingBackend/tracker-config.json
-**/.DS_Store
+**/.DS_Store
+# Nix
+result
+.envrc
+.direnv/

ETVR.spec

@@ -5,14 +5,11 @@ block_cipher = None
 
 
 a = Analysis(
-    ['TrackingBackend/main.py'],
+    ["eyetrackvr_backend/__main__.py"],
     pathex=[],
     binaries=[],
-    # WTF, wildcard doesnt apply to sub folders???
     datas=[
-        ("TrackingBackend/assets/*", "assets/"),
-        ("TrackingBackend/assets/models/*", "assets/models/"),
-        ("TrackingBackend/assets/images/*", "assets/images/")
+      ("eyetrackvr_backend/assets", "eyetrackvr_backend/assets")
     ],
     hiddenimports=["cv2", "numpy"],
     hookspath=[],
@@ -46,5 +43,5 @@ exe = EXE(
     target_arch=None,
     codesign_identity=None,
     entitlements_file=None,
-    icon="TrackingBackend/assets/images/logo.ico"
+    icon="eyetrackvr_backend/assets/images/logo.ico"
 )

LICENSE-APACHE

@@ -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] [EyeTrackVR]
+
+   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.

LICENSE → LICENSE-MIT

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 [Assassin]
+Copyright (c) 2025 [EyeTrackVR]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -2,35 +2,35 @@
 .DEFAULT_GOAL := run
 
 stream1:
-	ffmpeg -stream_loop "-1" -i TrackingBackend/assets/ETVR_SAMPLE.mp4 -attempt_recovery 1 -http_persistent 1 -http_seekable 0 -listen 1 -f mp4 -movflags frag_keyframe+empty_moov http://localhost:8080
+	ffmpeg -stream_loop "-1" -i eyetrackvr_backend/assets/ETVR_SAMPLE.mp4 -attempt_recovery 1 -http_persistent 1 -http_seekable 0 -listen 1 -f mp4 -movflags frag_keyframe+empty_moov http://localhost:8080
 
 stream2:
-	ffmpeg -stream_loop "-1" -i TrackingBackend/assets/ETVR_SAMPLE.mp4 -attempt_recovery 1 -http_persistent 1 -http_seekable 0 -listen 1 -f mp4 -movflags frag_keyframe+empty_moov http://localhost:8081
+	ffmpeg -stream_loop "-1" -i eyetrackvr_backend/assets/ETVR_SAMPLE.mp4 -attempt_recovery 1 -http_persistent 1 -http_seekable 0 -listen 1 -f mp4 -movflags frag_keyframe+empty_moov http://localhost:8081
 
 install:
 	poetry install
 
 run:
-	cd TrackingBackend/ && poetry run uvicorn --factory main:setup_app --reload --port 8000
+	poetry run uvicorn --factory eyetrackvr_backend:setup_app --reload --port 8000
 
 black:
-	poetry run black TrackingBackend/
+	poetry run black eyetrackvr_backend/
 
 ruff:
-	poetry run ruff TrackingBackend/
+	poetry run ruff eyetrackvr_backend/
 
 mypy:
-	poetry run mypy --ignore-missing-imports --check-untyped-defs TrackingBackend/
+	poetry run mypy --ignore-missing-imports --check-untyped-defs eyetrackvr_backend/
 
 pyinstaller:
-	poetry run pyinstaller ETVR.spec TrackingBackend/main.py
+	poetry run pyinstaller ETVR.spec
 
 nuitka:
-	poetry run python -m nuitka --standalone --include-module=cv2 TrackingBackend/main.py
+	poetry run python -m nuitka --standalone --include-module=cv2 eyetrackvr_backend/__main__.py
 
 clean:
-	rm -rf TrackingBackend/__pycache__/
-	rm -rf TrackingBackend/app/__pycache__/
-	rm -rf TrackingBackend/app/algorithms/__pycache__/
+	rm -rf eyetrackvr_backend/__pycache__/
+	rm -rf eyetrackvr_backend/app/__pycache__/
+	rm -rf eyetrackvr_backend/app/algorithms/__pycache__/
 	rm -rf build/
-	rm -rf dist/
+	rm -rf dist/

README.md

@@ -87,7 +87,7 @@ To start the local development server run either of the following commands.
 python build.py run
 ```
 ```bash
-cd TrackingBackend/ && poetry run uvicorn --factory main:setup_app --reload --port 8000
+poetry run uvicorn --factory eyetrackvr_backend:setup_app --reload --port 8000
 ```
 
 ### The build script
@@ -115,7 +115,7 @@ python build.py build
 ```
 If you want to build the backend manually you can do so with the following command.
 ```bash
-poetry run pyinstaller ETVR.spec TrackingBackend/main.py
+poetry run pyinstaller ETVR.spec
 ```
 
 ### Profiling
@@ -124,9 +124,9 @@ To start profiling run the following command, this will start the backend and ge
 If you dont like viztracer you can use almost any other profiler (multi-processing and multi-threading support is required)\
 *currently using the build script to start profiling is broken!*
 ```bash
-cd TrackingBackend/ && poetry run viztracer main.py
+poetry run viztracer -m eyetrackvr_backend:main
 ```
 
 
 ## License
-Unless explicitly stated otherwise all code contained within this repository is under the [MIT License](./LICENSE)
+Unless explicitly stated otherwise all code contained within this repository is under the [MIT License](./LICENSE-MIT)