MMM-Facial-Recognition-OCV3

This module is a facial recognition module (detection + recognition) for MagicMirror². This module is mainly inspired by the one developped by paviro : MMM-Facial-Recognition. [TOC]

Introduction

This module uses the OpenCV library and is only compatible with the v3 (only tested with the version 3.3 and the rest of the description is based on this version. Some adaptions will probably be needed to support other version). It has been adapted to :

Be able to support the v3.3.0 OpenCV version (the paviro one did not)
Merge the 2 projects MMM-Facial-Recognition (MagicMirror module) and MMM-Facial-Recognition-Tools (tools to capture and train the model) into one project
Mutualize some code and move some of into Classes
Explain the way to build and install OpenCV 3.3.0 (required, the version is not available into a repository)
Remove the Fisher and Eigen Algorithm that did not work well for Raspberry. Only LBPH Algorithm is usable.

Get this module with the command line :

cd ~/MagicMirror/modules/
git clone https://github.com/normyx/MMM-Facial-Recognition-OCV3.git

Prepare the module

This section explain the way to prepare the module, by installing the dependencies and train the model.

Building OpenCV

This is the most time consuming part, because the OpenCV library need to be build by the raspberry (it may take 2 hours). This section is a mix of 2 great articles found[^first][^second].

Configuring the Raspberry

First, install and update all the elements before compiling :

sudo apt-get update
sudo apt-get upgrade
sudo rpi-update
sudo reboot
sudo apt-get install build-essential git cmake pkg-config
sudo apt-get install libjpeg-dev libtiff5-dev libjasper-dev libpng12-dev
sudo apt-get install libavcodec-dev libavformat-dev libswscale-dev libv4l-dev
sudo apt-get install libxvidcore-dev libx264-dev
sudo apt-get install libgtk2.0-dev
sudo apt-get install libatlas-base-dev gfortran
cd ~
git clone https://github.com/Itseez/opencv.git
cd opencv
git checkout 3.3.0
cd ~
git clone https://github.com/Itseez/opencv_contrib.git
cd opencv_contrib
git checkout 3.3.0

Build OpenCV

This section may take long ... First get pip cross version :

wget https://bootstrap.pypa.io/get-pip.py

Two Python alternatives to build OpenCV : v2.7 or v3.0

If using Python v2.7 :
sudo apt-get install python2.7-dev
sudo python get-pip.py
If using Python v3.0 :
sudo apt-get install python3-dev
sudo python3 get-pip.py
Before you start the compile process, you should increase your swap space size. This enables OpenCV to compile with all four cores of the Raspberry PI without the compile hanging due to memory problems. Open your /etc/dphys-swapfile and then edit the CONF_SWAPSIZE variable:
# set size to absolute value, leaving empty (default) then uses computed value
# you most likely don't want this, unless you have an special disk situation
# CONF_SWAPSIZE=100
CONF_SWAPSIZE=1024
To activate the new swap space, restart the swap service:
sudo /etc/init.d/dphys-swapfile stop
sudo /etc/init.d/dphys-swapfile start
It is possible to burn out the Raspberry Pi microSD card because flash memory has a limited number of writes until the card won’t work. It is highly recommended that you change this setting back to the default when you are done compiling and testing the install.

And then, build OpenCV :

pip install numpy
cd ~/opencv
mkdir build
cd build
cmake -D CMAKE_BUILD_TYPE=RELEASE \
    -D CMAKE_INSTALL_PREFIX=/usr/local \
    -D INSTALL_C_EXAMPLES=OFF \
    -D INSTALL_PYTHON_EXAMPLES=ON \
    -D OPENCV_EXTRA_MODULES_PATH=~/opencv_contrib/modules \
    -D BUILD_EXAMPLES=ON ..
make -j4
sudo make install
sudo ldconfig

After a long time, OpenCV is built and installed

Install the dependencies

Go back to the MMM-Facial-Recognition-OCV3 modules directory :

cd ~/MagicMirror/modules/MMM-Facial-Recognition-OCV3

Install the need dependencies by running the command :

npm install

If you will run the different tools with Python 2.7, install the cross-compatible features with :

pip install future

Capture and Train the model

Capturing training images

Run python tools.capture.py.
Decide whether you want to capture images from your picam or convert existing .jpg images.
Enter the name of the person you are about to capture. Images will be stored in a folder named after the captured person in training_data/.
Follow screen instructions.
Training model
Make sure you have captured all your images.
Run python tools.train.py. The script will automatically scan the directory training_data/ for your images.
Wait. You will end up with a training.xml file in the current directory.
Copy down the ['name1', 'name2','name3'] part because you will later need it for setting up your mirror's face recognition and to test your face recognition model.
Test your trained model
Make sure your training.xml from running train.py is in this directory
Specify your user labels in the environment with
```
export FACE_USERS=name1,name2,name3
```
Run python tools.facerecognition.py to test your trained model.

Setup the module

To setup the module in MagicMirror², add the following script int the config.js file in the config/ MagicMirror² directory (Modify the script regarding the Algorithm, file location, ...).

{
    module: 'MMM-Facial-Recognition-OCV3',
    config: {
        // Threshold for the confidence of a recognized face before it's considered a
        // positive match.  Confidence values below this threshold will be considered
        // a positive match because the lower the confidence value, or distance, the
        // more confident the algorithm is that the face was correctly detected.
        threshold: 80,
        // force the use of a usb webcam on raspberry pi (on other platforms this is always true automatically)
        useUSBCam: false,
        // Path to your training xml
        trainingFile: '/home/pi/MagicMirror/modules/MMM-Facial-Recognition-OCV3/training.xml',
        // recognition intervall in seconds (smaller number = faster but CPU intens!)
        interval: 2,
        // Logout delay after last recognition so that a user does not get instantly logged out if he turns away from the mirror for a few seconds
        logoutDelay: 15,
        // Array with usernames (copy and paste from training script)
        users: [],
        //Module set used for strangers and if no user is detected
        defaultClass: "default",
        //Set of modules which should be shown for every user
        everyoneClass: "everyone",
        // Boolean to toggle welcomeMessage
        welcomeMessage: true
    }
}

In order for this module to do anything useful you have to assign custom classes to your modules. The class default (if you don't change it) is shown if no user is detected or a stranger. The class everyone (if you don't change it) is shown for all users. To specify modules for a certain user, use their name as classname.

{
    module: 'example_module',
    position: 'top_left',
    //Set your classes here seperated by a space.
    //Shown for all users
    classes: 'default everyone'
},
{
    module: 'example_module2',
    position: 'top_left',
    //Only shown for name1
    classes: 'name1'
}

TODO

Test with WebCam [^first]: Raspbian Stretch: Install OpenCV 3 + Python on your Raspberry Pi give a complete and very detailed explaination to build OpenCV 3, but based on python work environment. The choice here is to build and install the library deeply in the raspberry system. [^second]: How to easily install OpenCV 3+ on Raspberry Pi 2/3 in Raspbian ? (without using virtual environments) More synthetic but is adapted to be able to manage memory issues during compilation.

normyx / MMM-Facial-Recognition-OCV3

readme