├── .htmlnanorc ├── .gitignore ├── .npmignore ├── .babelrc ├── demo ├── index.js ├── styles.css ├── index.html └── sample.js ├── package.json ├── README.md ├── dist ├── styles.8986bff4.css ├── styles.8986bff4.css.map └── index.html ├── index.js └── LICENSE /.htmlnanorc: -------------------------------------------------------------------------------- 1 | { 2 | "minifySvg": false 3 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | .DS_store 3 | .cache/ 4 | package-lock.json -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | .cache/ 3 | demo/ 4 | dist/demo.* 5 | dist/styles.* 6 | dist/index.html 7 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | [ 4 | "env", 5 | { 6 | "esmodules": false, 7 | "targets": { 8 | "browsers": ["> 3%"] 9 | } 10 | } 11 | ] 12 | ], 13 | "plugins": ["@babel/plugin-transform-runtime"] 14 | } 15 | -------------------------------------------------------------------------------- /demo/index.js: -------------------------------------------------------------------------------- 1 | import blink from '../index.js'; 2 | 3 | const updateModelStatus = () => { 4 | const status = document.querySelector('.model-status'); 5 | if (status) { 6 | status.innerHTML = 'Model loaded! You can start!'; 7 | status.classList.add('fade-out'); 8 | status.classList.remove('model-status'); 9 | } 10 | }; 11 | 12 | const videoElement = document.querySelector('video'); 13 | 14 | function toggleMode() { 15 | let style = document.getElementById('dark-mode-style'); 16 | let currentMode = document.getElementById('current-mode'); 17 | if (style) { 18 | style.remove(); 19 | currentMode.textContent = 'Light'; 20 | } else { 21 | style = document.createElement('STYLE'); 22 | currentMode.textContent = 'Dark'; 23 | style.setAttribute('id', 'dark-mode-style'), (style.type = 'text/css'); 24 | style.appendChild( 25 | document.createTextNode( 26 | 'html { filter: invert(1) hue-rotate(180deg); color-scheme: dark;}' 27 | ) 28 | ); 29 | document.getElementsByTagName('html')[0].appendChild(style); 30 | } 31 | } 32 | 33 | var raf; 34 | const init = async () => { 35 | await blink.loadModel(); 36 | await blink.setUpCamera(videoElement); 37 | 38 | // let blinkIndicator = document.getElementById('blink-indicator'); 39 | let body = document.getElementsByTagName('body'); 40 | const predict = async () => { 41 | let result = await blink.getBlinkPrediction(); 42 | updateModelStatus(); 43 | 44 | if (result) { 45 | // if (result.blink) { 46 | // blinkIndicator.style.color = 'red'; 47 | // } else { 48 | // blinkIndicator.style.color = 'green'; 49 | // } 50 | if (result.longBlink) { 51 | toggleMode(); 52 | } 53 | } 54 | raf = requestAnimationFrame(predict); 55 | }; 56 | predict(); 57 | }; 58 | 59 | init(); 60 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "blink-detection", 3 | "version": "1.2.1", 4 | "description": "Detect the user's blink and wink using machine learning", 5 | "main": "dist/index.js", 6 | "author": "Ankur Kedia (https://ankurkedia.com)", 7 | "engines": { 8 | "node": ">=8.9.0" 9 | }, 10 | "dependencies": { 11 | "@tensorflow-models/face-landmarks-detection": "^0.0.3", 12 | "@tensorflow/tfjs-backend-webgl": "^3.9.0", 13 | "@tensorflow/tfjs-converter": "^3.9.0", 14 | "@tensorflow/tfjs-core": "^3.9.0" 15 | }, 16 | "scripts": { 17 | "watch": "cross-env NODE_ENV=development parcel index.html --no-hmr --target browser", 18 | "watch:demo": "cross-env NODE_ENV=development parcel demo/index.html --no-hmr --target browser", 19 | "build": "cross-env NODE_ENV=production parcel build index.js --global blink-detection", 20 | "build-demo": "cross-env NODE_ENV=production parcel build demo/index.html --public-url ./" 21 | }, 22 | "browser": { 23 | "crypto": false 24 | }, 25 | "keywords": [ 26 | "javascript", 27 | "tfjs", 28 | "machine learning", 29 | "tensorflow.js", 30 | "tensorflow" 31 | ], 32 | "devDependencies": { 33 | "@babel/core": "7.12.0", 34 | "@babel/plugin-transform-runtime": "^7.7.6", 35 | "@babel/preset-env": "^7.7.6", 36 | "babel-plugin-external-helpers": "^6.22.0", 37 | "babel-preset-env": "^1.7.0", 38 | "clang-format": "~1.2.2", 39 | "cross-env": "^5.2.0", 40 | "eslint": "^4.19.1", 41 | "parcel-bundler": "^1.12.4" 42 | }, 43 | "repository": { 44 | "type": "git", 45 | "url": "git+https://github.com/theankurkedia/blink-detection.git" 46 | }, 47 | "eslintConfig": { 48 | "env": { 49 | "es6": true 50 | }, 51 | "parserOptions": { 52 | "ecmaVersion": 8, 53 | "sourceType": "module" 54 | } 55 | }, 56 | "type": "module", 57 | "eslintIgnore": [ 58 | "dist/", 59 | "node_modules/" 60 | ], 61 | "bugs": { 62 | "url": "https://github.com/theankurkedia/blink-detection/issues" 63 | }, 64 | "homepage": "https://github.com/theankurkedia/blink-detection#readme", 65 | "license": "GPL-3.0" 66 | } 67 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Blink Detection 2 | 3 | Use machine learning in JavaScript to detect a blink and build blink-controlled experiences! 4 | 5 | ## Demo 6 | 7 | Visit [https://blink-detection.vercel.app](https://blink-detection.vercel.app) _(Works on mobile too!!)_ 8 | 9 | 10 | 11 | Uses Tensorflow.js's [face landmark detection model](https://www.npmjs.com/package/@tensorflow-models/face-landmarks-detection). 12 | 13 | ## Detection 14 | 15 | This tool detects when the user blinks. It can also detect a wink and separate eye blinks as well. 16 | 17 | ## Installation 18 | 19 | Via npm: 20 | 21 | Using `yarn`: 22 | 23 | $ yarn add blink-detection 24 | 25 | ## How to use 26 | 27 | ### Code sample 28 | 29 | Start by importing it: 30 | 31 | ```js 32 | import blink from 'blink-detection'; 33 | ``` 34 | 35 | Load the machine learning model: 36 | 37 | ```js 38 | await blink.loadModel(); 39 | ``` 40 | 41 | Then, set up the camera feed needed for the detection. The `setUpCamera` method needs a `video` HTML element and, optionally, a camera device ID if you are using more than the default webcam. 42 | 43 | ```js 44 | const videoElement = document.querySelector('video'); 45 | 46 | const init = async () => { 47 | // Using the default webcam 48 | await gaze.setUpCamera(videoElement); 49 | 50 | // Or, using more camera input devices 51 | const mediaDevices = await navigator.mediaDevices.enumerateDevices(); 52 | const camera = mediaDevices.find( 53 | (device) => 54 | device.kind === 'videoinput' && 55 | device.label.includes(/* The label from the list of available devices*/) 56 | ); 57 | 58 | await gaze.setUpCamera(videoElement, camera.deviceId); 59 | }; 60 | ``` 61 | 62 | Run the predictions: 63 | 64 | ```js 65 | const predict = async () => { 66 | const blinkPrediction = await blink.getBlinkPrediction(); 67 | console.log('Blink: ', blinkPrediction); // will return an object indicating the booleans for different states 68 | // expect blinkPrediction to be { 69 | // blink: boolean, 70 | // wink: boolean, 71 | // longBlink: boolean, 72 | // left: boolean, 73 | // right: boolean, 74 | // rate: number 75 | // } 76 | if (blinkPrediction.blink) { 77 | // do something when the user blinks 78 | } 79 | let raf = requestAnimationFrame(predict); 80 | }; 81 | predict(); 82 | ``` 83 | 84 | Stop the detection: 85 | 86 | ```js 87 | cancelAnimationFrame(raf); 88 | ``` 89 | -------------------------------------------------------------------------------- /demo/styles.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | background: #f3f3f3; 4 | font-family: 'Roboto', sans-serif; 5 | } 6 | 7 | /* mobile-first styles */ 8 | h1 { 9 | width: 85%; 10 | margin: 0.5em auto; 11 | padding: 0; 12 | color: #000000; 13 | font-weight: 400; 14 | text-align: center; 15 | } 16 | 17 | main { 18 | display: flex; 19 | height: 55%; 20 | align-items: center; 21 | justify-content: center; 22 | } 23 | 24 | #main { 25 | max-width: 95%; 26 | width: 95%; 27 | } 28 | 29 | .info { 30 | text-align: center; 31 | } 32 | 33 | .info { 34 | font-size: 18px; 35 | color: #00b5d8; 36 | font-weight: 300; 37 | } 38 | .info a { 39 | color: #00b5d8; 40 | } 41 | 42 | .instruction { 43 | margin-top: 2em; 44 | } 45 | 46 | .output::placeholder { 47 | color: white; 48 | font-size: 15px; 49 | font-weight: lighter; 50 | } 51 | 52 | .credit { 53 | font-size: 15px; 54 | } 55 | 56 | .model-status { 57 | color: #2d3748; 58 | animation: blink 1.5s ease-in-out infinite; 59 | margin: 0; 60 | } 61 | 62 | video { 63 | -webkit-transform: scaleX(-1); 64 | transform: scaleX(-1); 65 | visibility: hidden; 66 | width: auto; 67 | height: auto; 68 | display: none; 69 | } 70 | 71 | .rate-container { 72 | display: flex; 73 | justify-content: center; 74 | font-size: 1.5rem; 75 | margin-top: -10%; 76 | color: #0bc5ea; 77 | } 78 | 79 | @keyframes blink { 80 | 0% { 81 | opacity: 1; 82 | } 83 | 50% { 84 | opacity: 0; 85 | } 86 | 100% { 87 | opacity: 1; 88 | } 89 | } 90 | 91 | .fade-out { 92 | animation: fadeOut 1s ease-in-out forwards; 93 | color: lightgray; 94 | margin: 0; 95 | } 96 | 97 | @keyframes fadeOut { 98 | from { 99 | opacity: 1; 100 | display: block; 101 | } 102 | to { 103 | opacity: 0; 104 | display: none; 105 | } 106 | } 107 | 108 | /* Tablet Landscape */ 109 | @media only screen and (min-device-width: 768px) and (max-device-width: 1024px) and (orientation: landscape) { 110 | #main { 111 | max-width: 65%; 112 | } 113 | 114 | main { 115 | display: flex; 116 | max-height: 100%; 117 | height: 70%; 118 | align-items: center; 119 | justify-content: center; 120 | margin-top: 0; 121 | } 122 | } 123 | 124 | @media (min-device-width: 1025px) { 125 | h1 { 126 | padding-top: 1em; 127 | } 128 | 129 | main { 130 | display: flex; 131 | min-height: 80%; 132 | max-height: 100%; 133 | height: 80%; 134 | align-items: center; 135 | justify-content: center; 136 | margin-top: 0; 137 | } 138 | 139 | #main { 140 | max-width: 900px; 141 | } 142 | } 143 | 144 | /* Github corner - Thanks to @tholman! https://github.com/tholman/github-corners */ 145 | .github-corner:hover .octo-arm { 146 | animation: octocat-wave 560ms ease-in-out; 147 | } 148 | @keyframes octocat-wave { 149 | 0%, 150 | 100% { 151 | transform: rotate(0); 152 | } 153 | 20%, 154 | 60% { 155 | transform: rotate(-25deg); 156 | } 157 | 40%, 158 | 80% { 159 | transform: rotate(10deg); 160 | } 161 | } 162 | @media (max-width: 500px) { 163 | .github-corner:hover .octo-arm { 164 | animation: none; 165 | } 166 | .github-corner .octo-arm { 167 | animation: octocat-wave 560ms ease-in-out; 168 | } 169 | } 170 | -------------------------------------------------------------------------------- /dist/styles.8986bff4.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | background: #f3f3f3; 4 | font-family: 'Roboto', sans-serif; 5 | } 6 | 7 | /* mobile-first styles */ 8 | h1 { 9 | width: 85%; 10 | margin: 0.5em auto; 11 | padding: 0; 12 | color: #000000; 13 | font-weight: 400; 14 | text-align: center; 15 | } 16 | 17 | main { 18 | display: flex; 19 | height: 55%; 20 | align-items: center; 21 | justify-content: center; 22 | } 23 | 24 | #main { 25 | max-width: 95%; 26 | width: 95%; 27 | } 28 | 29 | .info { 30 | text-align: center; 31 | } 32 | 33 | .info { 34 | font-size: 18px; 35 | color: #00b5d8; 36 | font-weight: 300; 37 | } 38 | .info a { 39 | color: #00b5d8; 40 | } 41 | 42 | .instruction { 43 | margin-top: 2em; 44 | } 45 | 46 | .output::placeholder { 47 | color: white; 48 | font-size: 15px; 49 | font-weight: lighter; 50 | } 51 | 52 | .credit { 53 | font-size: 15px; 54 | } 55 | 56 | .model-status { 57 | color: #2d3748; 58 | animation: blink 1.5s ease-in-out infinite; 59 | margin: 0; 60 | } 61 | 62 | video { 63 | -webkit-transform: scaleX(-1); 64 | transform: scaleX(-1); 65 | visibility: hidden; 66 | width: auto; 67 | height: auto; 68 | display: none; 69 | } 70 | 71 | .rate-container { 72 | display: flex; 73 | justify-content: center; 74 | font-size: 1.5rem; 75 | margin-top: -10%; 76 | color: #0bc5ea; 77 | } 78 | 79 | @keyframes blink { 80 | 0% { 81 | opacity: 1; 82 | } 83 | 50% { 84 | opacity: 0; 85 | } 86 | 100% { 87 | opacity: 1; 88 | } 89 | } 90 | 91 | .fade-out { 92 | animation: fadeOut 1s ease-in-out forwards; 93 | color: lightgray; 94 | margin: 0; 95 | } 96 | 97 | @keyframes fadeOut { 98 | from { 99 | opacity: 1; 100 | display: block; 101 | } 102 | to { 103 | opacity: 0; 104 | display: none; 105 | } 106 | } 107 | 108 | /* Tablet Landscape */ 109 | @media only screen and (min-device-width: 768px) and (max-device-width: 1024px) and (orientation: landscape) { 110 | #main { 111 | max-width: 65%; 112 | } 113 | 114 | main { 115 | display: flex; 116 | max-height: 100%; 117 | height: 70%; 118 | align-items: center; 119 | justify-content: center; 120 | margin-top: 0; 121 | } 122 | } 123 | 124 | @media (min-device-width: 1025px) { 125 | h1 { 126 | padding-top: 1em; 127 | } 128 | 129 | main { 130 | display: flex; 131 | min-height: 80%; 132 | max-height: 100%; 133 | height: 80%; 134 | align-items: center; 135 | justify-content: center; 136 | margin-top: 0; 137 | } 138 | 139 | #main { 140 | max-width: 900px; 141 | } 142 | } 143 | 144 | /* Github corner - Thanks to @tholman! https://github.com/tholman/github-corners */ 145 | .github-corner:hover .octo-arm { 146 | animation: octocat-wave 560ms ease-in-out; 147 | } 148 | @keyframes octocat-wave { 149 | 0%, 150 | 100% { 151 | transform: rotate(0); 152 | } 153 | 20%, 154 | 60% { 155 | transform: rotate(-25deg); 156 | } 157 | 40%, 158 | 80% { 159 | transform: rotate(10deg); 160 | } 161 | } 162 | @media (max-width: 500px) { 163 | .github-corner:hover .octo-arm { 164 | animation: none; 165 | } 166 | .github-corner .octo-arm { 167 | animation: octocat-wave 560ms ease-in-out; 168 | } 169 | } 170 | 171 | 172 | /*# sourceMappingURL=/styles.8986bff4.css.map */ -------------------------------------------------------------------------------- /dist/styles.8986bff4.css.map: -------------------------------------------------------------------------------- 1 | {"version":3,"sources":["styles.css"],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","file":"styles.8986bff4.css","sourceRoot":"../demo","sourcesContent":["body {\n margin: 0;\n background: #f3f3f3;\n font-family: 'Roboto', sans-serif;\n}\n\n/* mobile-first styles */\nh1 {\n width: 85%;\n margin: 0.5em auto;\n padding: 0;\n color: #000000;\n font-weight: 400;\n text-align: center;\n}\n\nmain {\n display: flex;\n height: 55%;\n align-items: center;\n justify-content: center;\n}\n\n#main {\n max-width: 95%;\n width: 95%;\n}\n\n.info {\n text-align: center;\n}\n\n.info {\n font-size: 18px;\n color: #00b5d8;\n font-weight: 300;\n}\n.info a {\n color: #00b5d8;\n}\n\n.instruction {\n margin-top: 2em;\n}\n\n.output::placeholder {\n color: white;\n font-size: 15px;\n font-weight: lighter;\n}\n\n.credit {\n font-size: 15px;\n}\n\n.model-status {\n color: #2d3748;\n animation: blink 1.5s ease-in-out infinite;\n margin: 0;\n}\n\nvideo {\n -webkit-transform: scaleX(-1);\n transform: scaleX(-1);\n visibility: hidden;\n width: auto;\n height: auto;\n display: none;\n}\n\n.rate-container {\n display: flex;\n justify-content: center;\n font-size: 1.5rem;\n margin-top: -10%;\n color: #0bc5ea;\n}\n\n@keyframes blink {\n 0% {\n opacity: 1;\n }\n 50% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n}\n\n.fade-out {\n animation: fadeOut 1s ease-in-out forwards;\n color: lightgray;\n margin: 0;\n}\n\n@keyframes fadeOut {\n from {\n opacity: 1;\n display: block;\n }\n to {\n opacity: 0;\n display: none;\n }\n}\n\n/* Tablet Landscape */\n@media only screen and (min-device-width: 768px) and (max-device-width: 1024px) and (orientation: landscape) {\n #main {\n max-width: 65%;\n }\n\n main {\n display: flex;\n max-height: 100%;\n height: 70%;\n align-items: center;\n justify-content: center;\n margin-top: 0;\n }\n}\n\n@media (min-device-width: 1025px) {\n h1 {\n padding-top: 1em;\n }\n\n main {\n display: flex;\n min-height: 80%;\n max-height: 100%;\n height: 80%;\n align-items: center;\n justify-content: center;\n margin-top: 0;\n }\n\n #main {\n max-width: 900px;\n }\n}\n\n/* Github corner - Thanks to @tholman! https://github.com/tholman/github-corners */\n.github-corner:hover .octo-arm {\n animation: octocat-wave 560ms ease-in-out;\n}\n@keyframes octocat-wave {\n 0%,\n 100% {\n transform: rotate(0);\n }\n 20%,\n 60% {\n transform: rotate(-25deg);\n }\n 40%,\n 80% {\n transform: rotate(10deg);\n }\n}\n@media (max-width: 500px) {\n .github-corner:hover .octo-arm {\n animation: none;\n }\n .github-corner .octo-arm {\n animation: octocat-wave 560ms ease-in-out;\n }\n}\n"]} -------------------------------------------------------------------------------- /dist/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | Blink Detection 13 | 14 | 15 | 16 | 17 | 18 | 19 | 31 | 32 | 33 |

Blink Detection

34 |
35 |

36 | Built by 37 | Ankur Kedia 38 | - 39 | @theankurkedia 40 |

41 |

42 | Blink intentionally to change the current color mode. 43 |

44 |

Machine learning model loading...

45 |
46 | 47 |
48 |
49 | 50 | 56 |
57 |
58 | Color mode: 59 | Light 60 |
61 |
62 |
63 |
64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /demo/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 9 | 13 | 17 | 21 | 22 | 23 | 24 | Blink Detection 25 | 26 | 30 | 31 | 32 | 33 | 40 | 67 | 68 | 69 |

Blink Detection

70 |
71 |

72 | Built by 73 | Ankur Kedia 79 | - 80 | @theankurkedia 86 |

87 |

88 | Blink intentionally to change the current color mode. 89 |

90 |

Machine learning model loading...

91 |
92 | 93 |
94 |
95 | 96 |
97 |
98 | Color mode: 99 | Light 100 |
101 |
102 |
103 |
104 | 105 | 106 | 107 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import * as faceLandmarksDetection from '@tensorflow-models/face-landmarks-detection'; 2 | import * as tf from '@tensorflow/tfjs-core'; 3 | import '@tensorflow/tfjs-backend-webgl'; 4 | 5 | let model, video, event, blinkRate; 6 | const VIDEO_SIZE = 500; 7 | let blinkCount = 0; 8 | let tempBlinkRate = 0; 9 | let rendering = true; 10 | let rateInterval; 11 | const EAR_THRESHOLD = 0.27; 12 | 13 | function initBlinkRateCalculator() { 14 | rateInterval = setInterval(() => { 15 | blinkRate = tempBlinkRate * 6; 16 | tempBlinkRate = 0; 17 | }, 10000); 18 | } 19 | 20 | const loadModel = async () => { 21 | await tf.setBackend('webgl'); 22 | 23 | model = await faceLandmarksDetection.load( 24 | faceLandmarksDetection.SupportedPackages.mediapipeFacemesh, 25 | { maxFaces: 1 } 26 | ); 27 | }; 28 | 29 | const setUpCamera = async (videoElement) => { 30 | video = videoElement; 31 | const mediaDevices = await navigator.mediaDevices.enumerateDevices(); 32 | 33 | const defaultWebcam = mediaDevices.find( 34 | (device) => 35 | device.kind === 'videoinput' && device.label.includes('Built-in') 36 | ); 37 | 38 | const cameraId = defaultWebcam ? defaultWebcam?.deviceId : undefined; 39 | 40 | const stream = await navigator.mediaDevices.getUserMedia({ 41 | audio: false, 42 | video: { 43 | facingMode: 'user', 44 | deviceId: cameraId, 45 | width: VIDEO_SIZE, 46 | height: VIDEO_SIZE, 47 | }, 48 | }); 49 | 50 | video.srcObject = stream; 51 | video.play(); 52 | video.width = VIDEO_SIZE; 53 | video.height = VIDEO_SIZE; 54 | 55 | // Change it, since it does not expect anything to return 56 | return new Promise((resolve) => { 57 | video.onloadedmetadata = () => { 58 | resolve(video); 59 | initBlinkRateCalculator(); 60 | }; 61 | }); 62 | }; 63 | 64 | function stopPrediction() { 65 | rendering = false; 66 | clearInterval(rateInterval); 67 | } 68 | function updateBlinkRate() { 69 | tempBlinkRate++; 70 | } 71 | 72 | function getEucledianDistance(x1, y1, x2, y2) { 73 | return Math.sqrt((x2 - x1) * (x2 - x1) + (y2 - y1) * (y2 - y1)); 74 | } 75 | 76 | function getEAR(upper, lower) { 77 | return ( 78 | (getEucledianDistance(upper[5][0], upper[5][1], lower[4][0], lower[4][1]) + 79 | getEucledianDistance( 80 | upper[3][0], 81 | upper[3][1], 82 | lower[2][0], 83 | lower[2][1] 84 | )) / 85 | (2 * 86 | getEucledianDistance(upper[0][0], upper[0][1], upper[8][0], upper[8][1])) 87 | ); 88 | } 89 | 90 | function isVoluntaryBlink(blinkDetected) { 91 | // NOTE: checking if blink is detected in atleast 5 consecutive cycles, values lesser than that can be considered a normal blink. 92 | // NOTE: adding this to distinguish intentional blinks 93 | if (blinkDetected) { 94 | blinkCount++; 95 | if (blinkCount > 4) { 96 | blinkCount = 0; 97 | return true; 98 | } 99 | } else { 100 | blinkCount = 0; 101 | } 102 | return false; 103 | } 104 | 105 | async function renderPrediction() { 106 | if (rendering) { 107 | const predictions = await model.estimateFaces({ 108 | input: video, 109 | returnTensors: false, 110 | flipHorizontal: false, 111 | predictIrises: true, 112 | }); 113 | 114 | if (predictions.length > 0) { 115 | predictions.forEach((prediction) => { 116 | // NOTE: Error in docs, rightEyeLower0 is mapped to rightEyeUpper0 and vice-versa 117 | let lowerRight = prediction.annotations.rightEyeUpper0; 118 | let upperRight = prediction.annotations.rightEyeLower0; 119 | const rightEAR = getEAR(upperRight, lowerRight); 120 | // TODO: log this prediction 121 | let lowerLeft = prediction.annotations.leftEyeUpper0; 122 | let upperLeft = prediction.annotations.leftEyeLower0; 123 | const leftEAR = getEAR(upperLeft, lowerLeft); 124 | 125 | let blinked = leftEAR <= EAR_THRESHOLD && rightEAR <= EAR_THRESHOLD; 126 | if (blinked) { 127 | updateBlinkRate(); 128 | } 129 | event = { 130 | left: leftEAR <= EAR_THRESHOLD, 131 | right: rightEAR <= EAR_THRESHOLD, 132 | wink: leftEAR <= EAR_THRESHOLD || rightEAR <= EAR_THRESHOLD, 133 | blink: blinked, 134 | longBlink: isVoluntaryBlink(blinked), 135 | rate: blinkRate, 136 | }; 137 | }); 138 | } 139 | } 140 | return event; 141 | } 142 | 143 | const blink = { 144 | loadModel: loadModel, 145 | setUpCamera: setUpCamera, 146 | stopPrediction: stopPrediction, 147 | getBlinkPrediction: renderPrediction, 148 | }; 149 | 150 | export default blink; 151 | -------------------------------------------------------------------------------- /demo/sample.js: -------------------------------------------------------------------------------- 1 | let closedRight; 2 | 3 | // const rightEAR = ((u5- l4) + (u3-l2) )/(2 * (l0 - l8)) 4 | 5 | // const leftEAR = (u3-l2 + u5-l4) / (u0-u8) 6 | // const leftLower = [ 7 | // [215.9, 231.1], 8 | // [217.9, 229.9], 9 | // [221.3, 228.4], 10 | // [226.8, 227.5], 11 | // [232.2, 227.9], 12 | // [237.6, 229.2], 13 | // [241.4, 231.1] 14 | // ]; 15 | // const leftUpper= [ 16 | // [214.6, 231.9], 17 | // [217.1, 233.8], 18 | // [219.9, 235.0], 19 | // [223.7, 235.8], 20 | // [229.2, 236.0], 21 | // [234.4, 235.4], 22 | // [239.0, 234.1], 23 | // [241.8, 233.0], 24 | // [243.2, 232.4], 25 | // ], 26 | // const sample1 = { 27 | // faceInViewConfidence: 0.9997509121894836, 28 | // annotations: { 29 | // rightEyeUpper0: [ 30 | // [316.4558563232422, 228.73590087890625, 10.984639167785645], 31 | // [314.5319519042969, 227.43081665039062, 9.325787544250488], 32 | // [311.28375244140625, 225.91615295410156, 7.701682090759277], 33 | // [306.3000793457031, 225.15606689453125, 6.2624192237854], 34 | // [301.43316650390625, 225.646728515625, 5.65355920791626], 35 | // [296.4994354248047, 227.06993103027344, 5.9732890129089355], 36 | // [293.1246643066406, 229.00021362304688, 6.609309673309326], 37 | // ], 38 | // rightEyeLower0: [ 39 | // [317.8633575439453, 229.66139221191406, 13.16678237915039], 40 | // [315.72381591796875, 231.53204345703125, 11.261553764343262], 41 | // [313.39598083496094, 232.6637420654297, 9.628640174865723], 42 | // [310.13990783691406, 233.69775390625, 7.713962554931641], 43 | // [305.22315979003906, 234.35833740234375, 6.114638805389404], 44 | // [300.3984069824219, 234.09439086914062, 5.5672831535339355], 45 | // [295.80845642089844, 232.6842041015625, 5.996964454650879], 46 | // [293.0185852050781, 231.45159912109375, 6.947413921356201], 47 | // [291.5740966796875, 230.5567626953125, 6.939347267150879], 48 | // ], 49 | // rightEyeUpper1: [ 50 | // [319.9203186035156, 225.85910034179688, 11.55571460723877], 51 | // [317.19065856933594, 222.57937622070312, 8.808296203613281], 52 | // [313.2731628417969, 219.79055786132812, 6.742804050445557], 53 | // [307.4088592529297, 218.58193969726562, 4.823305130004883], 54 | // [301.0321807861328, 219.22732543945312, 4.458434104919434], 55 | // [295.4365997314453, 221.7000274658203, 5.22852087020874], 56 | // [290.6459655761719, 226.63099670410156, 5.828087329864502], 57 | // ], 58 | // rightEyeLower1: [ 59 | // [320.3075408935547, 230.12823486328125, 14.18520736694336], 60 | // [318.44789123535156, 233.99671936035156, 11.76822566986084], 61 | // [315.9236145019531, 236.45370483398438, 9.455986022949219], 62 | // [311.4869079589844, 237.7508087158203, 6.9202141761779785], 63 | // [305.9769592285156, 238.1464385986328, 5.07948112487793], 64 | // [300.1329803466797, 237.54702758789062, 4.261294364929199], 65 | // [295.16998291015625, 235.51625061035156, 4.497573375701904], 66 | // [291.8407440185547, 233.08523559570312, 5.216071128845215], 67 | // [289.6629943847656, 230.65866088867188, 5.870261192321777], 68 | // ], 69 | // rightEyeUpper2: [ 70 | // [323.2840270996094, 225.48838806152344, 13.474348068237305], 71 | // [320.78643798828125, 219.85902404785156, 9.769828796386719], 72 | // [316.0009765625, 216.19680786132812, 6.567578315734863], 73 | // [309.2125549316406, 214.5472412109375, 4.139621734619141], 74 | // [300.9591979980469, 215.24827575683594, 3.2132115364074707], 75 | // [291.6093292236328, 219.4542236328125, 3.080608367919922], 76 | // [287.33851623535156, 225.88404846191406, 3.489706039428711], 77 | // ], 78 | // rightEyeLower2: [ 79 | // [324.29063415527344, 232.1839599609375, 16.303287506103516], 80 | // [323.4114227294922, 238.55734252929688, 13.953198432922363], 81 | // [320.6928253173828, 241.17697143554688, 10.850263595581055], 82 | // [315.36981201171875, 243.08766174316406, 7.187951564788818], 83 | // [307.89776611328125, 243.11354064941406, 4.532236099243164], 84 | // [300.39073181152344, 241.5896759033203, 3.164551258087158], 85 | // [294.4740905761719, 239.07383728027344, 2.894444227218628], 86 | // [290.4168243408203, 236.5804901123047, 2.523927927017212], 87 | // [287.1132354736328, 232.64488220214844, 2.3499860763549805], 88 | // ], 89 | // rightEyeLower3: [ 90 | // [334.0215606689453, 235.82766723632812, 25.50864601135254], 91 | // [329.84657287597656, 243.15464782714844, 16.628986358642578], 92 | // [326.6418151855469, 247.3538360595703, 11.186138153076172], 93 | // [319.9693145751953, 249.6035919189453, 5.633381366729736], 94 | // [309.2664794921875, 248.69569396972656, 2.701173782348633], 95 | // [300.9960021972656, 245.91311645507812, 1.2698984146118164], 96 | // [294.57835388183594, 242.70277404785156, -0.08383488655090332], 97 | // [289.7573699951172, 238.85769653320312, -0.5831782817840576], 98 | // [285.9342956542969, 233.53407287597656, -1.5760375261306763], 99 | // ], 100 | // rightEyeIris: [ 101 | // [303.7965850830078, 234.3605499267578, 6.188529014587402], 102 | // [297.7848663330078, 234.06031799316406, 6.188529014587402], 103 | // [303.8927307128906, 228.9445037841797, 6.2624192237854], 104 | // [309.8382263183594, 234.55706787109375, 6.188529014587402], 105 | // [303.7152404785156, 239.58145141601562, 6.114638805389404], 106 | // ], 107 | // leftEyeUpper0: [ 108 | // [215.9903564453125, 231.18653869628906, 5.233613014221191], 109 | // [217.9547119140625, 229.97251892089844, 3.785628318786621], 110 | // [221.33346557617188, 228.42742919921875, 2.451026678085327], 111 | // [226.82156372070312, 227.59530639648438, 1.5464396476745605], 112 | // [232.2386474609375, 227.9449005126953, 1.4993122816085815], 113 | // [237.6002197265625, 229.23487854003906, 2.403029203414917], 114 | // [241.40203857421875, 231.12045288085938, 3.444145917892456], 115 | // ], 116 | // leftEyeLower0: [ 117 | // [214.63455200195312, 231.96717834472656, 7.229278564453125], 118 | // [217.14193725585938, 233.88253784179688, 5.62473201751709], 119 | // [219.95367431640625, 235.03619384765625, 4.295414924621582], 120 | // [223.78143310546875, 235.85801696777344, 2.8165273666381836], 121 | // [229.296630859375, 236.09677124023438, 1.808180809020996], 122 | // [234.46676635742188, 235.49078369140625, 1.8542532920837402], 123 | // [239.0870361328125, 234.13877868652344, 2.748312473297119], 124 | // [241.89163208007812, 233.09112548828125, 3.956031322479248], 125 | // [243.25741577148438, 232.49777221679688, 4.122570514678955], 126 | // ], 127 | // leftEyeUpper1: [ 128 | // [212.52468872070312, 227.61874389648438, 5.418386936187744], 129 | // [215.25897216796875, 224.38719177246094, 2.9381256103515625], 130 | // [219.34292602539062, 221.732666015625, 1.1824309825897217], 131 | // [225.5960693359375, 220.65667724609375, -0.08640122413635254], 132 | // [232.30386352539062, 221.2853240966797, 0.39621150493621826], 133 | // [238.41015625, 223.66815185546875, 1.8391668796539307], 134 | // [244.1087646484375, 228.52841186523438, 2.98101544380188], 135 | // ], 136 | // leftEyeLower1: [ 137 | // [212.27337646484375, 232.0154266357422, 7.979268550872803], 138 | // [214.7415771484375, 236.093017578125, 5.989004135131836], 139 | // [217.98971557617188, 238.72625732421875, 4.069088459014893], 140 | // [223.22048950195312, 240.10702514648438, 2.1103646755218506], 141 | // [229.34323120117188, 240.2465057373047, 0.9384834170341492], 142 | // [235.47369384765625, 239.3803253173828, 0.8332018852233887], 143 | // [240.5206298828125, 237.3475799560547, 1.7199287414550781], 144 | // [243.52633666992188, 235.12762451171875, 2.6444480419158936], 145 | // [245.50750732421875, 232.74314880371094, 3.482106924057007], 146 | // ], 147 | // leftEyeUpper2: [ 148 | // [209.37750244140625, 226.84034729003906, 6.780000686645508], 149 | // [211.60671997070312, 221.326904296875, 3.3226895332336426], 150 | // [216.58053588867188, 217.97293090820312, 0.7052052021026611], 151 | // [223.73272705078125, 216.38754272460938, -0.864924430847168], 152 | // [232.31329345703125, 217.05271911621094, -0.78946852684021], 153 | // [242.49652099609375, 221.20587158203125, 0.13675737380981445], 154 | // [247.8274688720703, 227.6739044189453, 1.3716703653335571], 155 | // ], 156 | // leftEyeLower2: [ 157 | // [208.89306640625, 233.50180053710938, 9.704765319824219], 158 | // [210.45693969726562, 240.3459930419922, 7.894819736480713], 159 | // [213.6229248046875, 243.47152709960938, 5.281005382537842], 160 | // [219.822509765625, 245.7073974609375, 2.452056884765625], 161 | // [228.08822631835938, 245.82656860351562, 0.7408129572868347], 162 | // [235.96109008789062, 244.07437133789062, 0.21630769968032837], 163 | // [241.87655639648438, 241.48309326171875, 0.5917224884033203], 164 | // [245.84820556640625, 239.09725952148438, 0.5720595121383667], 165 | // [248.84242248535156, 235.0342254638672, 0.5704395771026611], 166 | // ], 167 | // leftEyeLower3: [ 168 | // [199.65225219726562, 236.0408172607422, 17.6357364654541], 169 | // [204.4935302734375, 244.87132263183594, 10.033550262451172], 170 | // [208.1915283203125, 249.82798767089844, 5.285192489624023], 171 | // [215.61148071289062, 252.74908447265625, 0.9032927751541138], 172 | // [227.22940063476562, 252.04397583007812, -0.8352845311164856], 173 | // [235.90457153320312, 249.185791015625, -1.3485082387924194], 174 | // [242.38827514648438, 245.9823760986328, -2.079688310623169], 175 | // [247.05165100097656, 242.25833129882812, -2.251185178756714], 176 | // [250.49386596679688, 236.73406982421875, -2.9601540565490723], 177 | // ], 178 | // leftEyeIris: [ 179 | // [227.33206176757812, 235.81146240234375, 1.6773102283477783], 180 | // [233.149169921875, 235.31809997558594, 1.6773102283477783], 181 | // [226.52880859375, 230.4038848876953, 1.5464396476745605], 182 | // [221.37783813476562, 236.25758361816406, 1.6773102283477783], 183 | // [228.09347534179688, 241.0303497314453, 1.808180809020996], 184 | // ], 185 | // midwayBetweenEyes: [ 186 | // [269.6813201904297, 218.88470458984375, -1.7089649438858032], 187 | // ], 188 | // }, 189 | // }; 190 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------