Initial commit

.gitattributes

@@ -0,0 +1 @@
+gaze_tracking/trained_models/* filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,104 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Antoine Lamé
+
+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.

README.md

@@ -0,0 +1,160 @@
+# Gaze Tracking
+
+![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)
+![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)
+![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
+
+This is a Python (2 and 3) library that provides a **webcam-based eye tracking system**. It gives you the exact position of the pupils and the gaze's direction, in real time.
+
+[![Demo](https://i.imgur.com/WNqgQkO.gif)](https://youtu.be/YEZMk1P0-yw)
+
+## Installation
+
+Clone this project:
+
+```
+git clone https://github.com/antoinelame/GazeTracking.git
+```
+
+GazeTracking requires these dependencies:
+
+* NumPy
+* OpenCV 3.4
+* Dlib
+
+To install them:
+
+```
+pip install -r requirements.txt
+```
+
+> The Dlib library has four primary prerequisites: Boost, Boost.Python, CMake and X11/XQuartx. If you doesn't have them, you can [read this article](https://www.pyimagesearch.com/2017/03/27/how-to-install-dlib/) to know how to easily install them.
+
+> OpenCV 4 is not supported yet, make sure to install version 3.4
+
+Run the demo:
+
+```
+python example.py
+```
+
+## Simple Demo
+
+```python
+import cv2
+from gaze_tracking import GazeTracking
+
+
+gaze = GazeTracking()
+
+while True:
+    gaze.refresh()
+
+    frame = gaze.main_frame(True)
+    text = ""
+
+    if gaze.is_right():
+        text = "Looking right"
+    elif gaze.is_left():
+        text = "Looking left"
+    elif gaze.is_center():
+        text = "Looking center"
+
+    cv2.putText(frame, text, (60, 60), cv2.FONT_HERSHEY_DUPLEX, 2, (255, 0, 0), 2)
+    cv2.imshow("Demo", frame)
+
+    if cv2.waitKey(1) == 27:
+        break
+```
+
+## Documentation
+
+In the following examples, ```gaze``` refers to an instance of the ```GazeTracking``` class.
+
+### Refresh the frame
+
+```python
+gaze.refresh()
+```
+
+Captures a new frame with the webcam and analyzes it.
+
+### Position of the left pupil
+
+```python
+gaze.pupil_left_coords()
+```
+
+Returns the coordinates (x,y) of the left pupil.
+
+### Position of the right pupil
+
+```python
+gaze.pupil_right_coords()
+```
+
+Returns the coordinates (x,y) of the right pupil.
+
+### Looking to the left
+
+```python
+gaze.is_left()
+```
+
+Returns `True` if the user is looking to the left.
+
+### Looking to the right
+
+```python
+gaze.is_right()
+```
+
+Returns `True` if the user is looking to the right.
+
+### Looking at the center
+
+```python
+gaze.is_center()
+```
+
+Returns `True` if the user is looking at the center.
+
+### Horizontal direction of the gaze
+
+```python
+ratio = gaze.horizontal_ratio()
+```
+
+Returns a number between 0.0 and 1.0 that indicates the horizontal direction of the gaze. The extreme right is 0.0, the center is 0.5 and the extreme left is 1.0.
+
+### Vertical direction of the gaze
+
+```python
+ratio = gaze.vertical_ratio()
+```
+
+Returns a number between 0.0 and 1.0 that indicates the vertical direction of the gaze. The extreme top is 0.0, the center is 0.5 and the extreme bottom is 1.0.
+
+### Blinking
+
+```python
+gaze.is_blinking()
+```
+
+Returns `True` is the user's eyes are closed.
+
+### Webcam frame
+
+```python
+# Without pupils highlighting
+frame = gaze.main_frame(False)
+
+# With pupils highlighting
+frame = gaze.main_frame(True)
+```
+
+Returns the main frame from the webcam.
+
+## Licensing
+
+This project is released by Antoine Lamé under the terms of the MIT Open Source License. View LICENSE for more information.

example.py

@@ -0,0 +1,36 @@
+"""
+Demonstration of the GazeTracking library.
+Check the README.md for complete documentation.
+"""
+
+import cv2
+from gaze_tracking import GazeTracking
+
+gaze = GazeTracking()
+
+while True:
+    gaze.refresh()
+
+    frame = gaze.main_frame(True)
+    text = ""
+
+    if gaze.is_blinking():
+        text = "Blinking"
+    elif gaze.is_right():
+        text = "Looking right"
+    elif gaze.is_left():
+        text = "Looking left"
+    elif gaze.is_center():
+        text = "Looking center"
+
+    cv2.putText(frame, text, (90, 60), cv2.FONT_HERSHEY_DUPLEX, 1.6, (147, 58, 31), 2)
+
+    left_pupil = gaze.pupil_left_coords()
+    right_pupil = gaze.pupil_right_coords()
+    cv2.putText(frame, "Left pupil:  " + str(left_pupil), (90, 130), cv2.FONT_HERSHEY_DUPLEX, 0.9, (147, 58, 31), 1)
+    cv2.putText(frame, "Right pupil: " + str(right_pupil), (90, 165), cv2.FONT_HERSHEY_DUPLEX, 0.9, (147, 58, 31), 1)
+
+    cv2.imshow("Demo", frame)
+
+    if cv2.waitKey(1) == 27:
+        break

gaze_tracking/__init__.py

@@ -0,0 +1 @@
+from .gaze_tracking import GazeTracking