The Library
●Algorithms
 ●API Wrappers
 ●Bayesian Nets
 ●Compression
 ●Containers
 ●Graph Tools
 ●Image Processing
 ●Linear Algebra
 ●Machine Learning
 ●Metaprogramming
 ●Miscellaneous
 ●Networking
 ●Optimization
 ●Parsing
Help/Info
●Dlib Blog
 Examples: C++
  • Assignment Learning
  • Base64 Encoder
  • Bayesian Network From Disk
  • Bayesian Network GUI
  • Bayesian Network
  • Bridge
  • BSP
  • C-Support Vector Machine
  • Cmd Line Parser
  • Compress Stream
  • Config File Reader
  • Custom Trainers
  • Deep Face Recognition
  • Deep Learning DCGAN
  • Deep Learning Dog Hipsterizer
  • Deep Learning Face Detection
  • Deep Learning Imagenet Classifier
  • Deep Learning Imagenet Trainer
  • Deep Learning Inception
  • Deep Learning Instance Segmentation Trainer
  • Deep Learning Instance Segmentation
  • Deep Learning Introduction Part 1
  • Deep Learning Introduction Part 2
  • Deep Learning Introduction Part 3
  • Deep Learning Max-Margin Object Detection
  • Deep Learning Multi-Class Vehicle Detection
  • Deep Learning Semantic Segmentation Trainer
  • Deep Learning Semantic Segmentation
  • Deep Learning Vehicle Detection Trainer
  • Deep Learning Vehicle Detection
  • Deep Metric Learning Introduction
  • Deep Metric Learning on Images
  • Directory Navigation
  • Empirical Kernel Map
  • Face Detection
  • Face Landmark Detection
  • FHOG Feature Extraction
  • FHOG Object Detection
  • Graph Labeling
  • GUI
  • Hough Transform
  • HTTP Server
  • Image
  • IO Socket Streams
  • IO Streams Server
  • Kernel Centroid
  • Kernel K-Means Clustering
  • Kernel Ridge Regression
  • Kernel RLS Filtering
  • Kernel RLS Regression
  • KRR Classification
  • Learning to Track
  • Linear Assignment Problems
  • Linear Manifold Regularizer
  • Linear Model Predictive Control
  • Logger Advanced
  • Logger Custom Output
  • Logger
  • Matrix Expressions
  • Matrix
  • Member Function Pointer
  • Model Selection
  • Multiclass Classification
  • Multithreaded Object
  • Neural Network
  • Non-Linear Least Squares
  • Nu-Support Vector Machine
  • Numerical Integration
  • Object Detector Advanced
  • Object Detector
  • One Class Classifiers
  • Online SVM
  • Optimization
  • Parallel For Loops
  • Pipe 2
  • Pipe
  • Quantum Computing
  • Queue
  • Random Cropper
  • Rank Features
  • Relevance Vector Classification
  • Relevance Vector Regression
  • Running Stats
  • Self-supervised deep feature learning
  • Sequence Labeling
  • Sequence Segmentation
  • Sockets
  • Sockstreambuf
  • Sparse Vectors
  • SQLite
  • Std C++ Allocator
  • Structural Support Vector Machines
  • Support Vector Regression
  • SURF
  • SVM-Rank
  • Thread Function
  • Thread Pool
  • Threaded Object
  • Threads
  • Timer
  • Train Object Detector
  • Train Shape Predictor
  • Training a YOLO object detector
  • Using Custom Kernels
  • Video Object Tracking
  • Webcam Face Pose Estimation
  • XML Parser
    • Examples: Python
  • CNN Face Detector
  • Face Alignment
  • Face Clustering
  • Face Detector
  • Face Jittering/Augmentation
  • Face Landmark Detection
  • Face Recognition
  • Find Candidate Object Locations
  • Global Optimization
  • Linear Assignment Problems
  • Sequence Segmenter
  • Structural Support Vector Machines
  • SVM-Rank
  • Train Object Detector
  • Train Shape Predictor
  • Video Object Tracking
    • ●FAQ
     ●Home
     ●How to compile
     ●How to contribute
     ●Index
     ●Introduction
     ●License
     ●Python API
     ●Suggested Books
     ●Who uses dlib?
    Current Release
    ●Change Log
     ●Release Notes

    Download dlib
     ver.19.24
      Last Modified:
    Mar 14, 2019

    Using dlib from Python

     Either run pip install dlib --verbose or grab the latest sources  from github, go to the base folder of the dlib repository,  and run python setup.py install. Once either of these commands  finishes running you are ready to use dlib from Python. Note  that you need to have CMake and a working C++ compiler  installed for this to work. 
    Also note that various optional features like GUI support (e.g.  dlib.image_window) and CUDA acceleration will be automatically  enabled or disabled based on what is available on your computer.  When you run the install command it will print messages telling  you what it is using. Read those messages and take appropriate  action if you don't like the results. For example, Linux and  OSX users may have to install libX11 to use the GUI tools. If  you care about this then read the messages since they tell you  how to get these optional features installed.  
     Alternatively, if you want to add more python bindings to dlib's  python interface then you probably want to avoid the setup.py file  and work directly using CMake. In particular, dlib's python API is  built by the CMake project in the tools/python folder. You build  this project using the usual CMake commands and when compiled it  outputs the dlib shared library that defines the python API for dlib.  

    Using dlib from C++

     The best way to compile a program that uses dlib is to use CMake. For  example, the following commands will compile the example programs on any operating  system: 
    cd examples
mkdir build
cd build
cmake ..
cmake --build . --config Release
    Note that you need to have a C+    +11 compiler installed on your system. There are free C++11 compilers for most operating systems. For example, Visual Studio is free on Windows and GCC is free and works well on Mac OS X and Linux systems. If you have multiple compilers/IDEs installed then you can tell CMake which one you want it to use via the -G option.
     The examples/CMakeLists.txt file tells CMake how to build  the examples. You can create your own projects by starting with this file and editing it however you like.  You can also perform additional configuration of a cmake project using the cmake-gui or ccmake tool. For example,  if you are using dlib's face detector then you should turn on either SSE4 or AVX instructions since this  makes it run much faster (also see this FAQ). 
    Finally, note that when using Visual Studio, CMake will by default generate a 32bit executable.  This means the programs you compile will only be able to use 2GB of RAM. To avoid this, you need  to tell CMake to generate a 64bit executable. You do this by using a command like  
    cmake -G "Visual Studio 14 2015 Win64" -T host=x64 ..
    instead of 
    cmake ..
    Yo    u can see the list of valid arguments to -G by running cmake with no options. Note also the -T host=x64  option, which tells Visual Studio to let the compiler use more than 2GB of RAM. That is important if you don't want the compiler to  crash from running out of RAM in some situations.

    Compiling C++ Examples Without CMake

     In most cases, to use this library all you have to do is extract it somewhere, make  sure the folder containing the dlib folder is in your include path, and  finally add dlib/all/source.cpp to your  project. 
    Again, note that you should not add the dlib folder itself to your compiler's include path.  Doing so will cause the  build to fail because of name collisions (e.g. dlib/string.h with string.h from the standard library).  Instead you should add the folder that contains the dlib folder to your include search path and then use  include statements of the form #include <dlib/queue.h>. This will ensure that everything  builds correctly.  
     Note also that if you want to work with jpeg/png/gif files using dlib then you will  need to link your program with libjpeg, libpng, and/or libgif. You also need to tell dlib  about this by defining the DLIB_JPEG_SUPPORT, DLIB_PNG_SUPPORT, and DLIB_GIF_SUPPORT preprocessor directives.  How you "link to libjpeg/libpng/libgif" varies from platform to platform. On UNIX machines you  usually just add a -ljpeg, -lpng, or -lgif switch to your compiler (after installing the libraries).  On windows it's less well defined. So dlib comes with a copy of libjpeg and libpng in the dlib/external  folder so you can statically compile them into your application if no system wide version  is available on your machine. If all this talk about linking is confusing to you then  just use CMake. It will set this all up for you.  
     Dlib is also capable of using any optimized BLAS or LAPACK libraries that are  installed on your system. Linking to these libraries will make many things run  faster. To do this you define the DLIB_USE_BLAS and/or DLIB_USE_LAPACK preprocessor  directives and then link your program with whatever BLAS or LAPACK libraries you  have. If you use CMake it will set this up automatically.  

    Compiling on Linux From Command Line

     From within the examples folder, you can compile nearly all of the examples with a single command like so: 
    g++ -std=c++11 -O3 -I.. ../dlib/all/source.cpp -lpthread -lX11 example_program_name.cpp
    On non-Linux systems l    ike Solaris, you might have to link to other libraries. For example, I have seen systems where it was also necessary to supply -lnsl or -lsocket options to g++. Additionally, the X11 development library isn't installed on Ubuntu by default. So if you require it and are using Ubuntu you can install it by typing: 
    sudo apt-get install libx11-dev

    Compiling on Windows Using GCC

     The commands for gcc on windows are the same as above but you may also have to link  (via the -l option) to the following libraries: gdi32, comctl32, user32, winmm, ws2_32, or imm32.  

    Compiling on Windows Using Visual Studio 2015 or Newer

     All you need to do is create an empty console project. Then add dlib/all/source.cpp to it and add the  folder containing the dlib folder to the #include search path. Then you can compile any example program  by adding it to your project. 
    Again, note that dlib will only be able to work with jpeg and png files if you link  in libjpeg and libpng. In Visual Studio, the easiest way to do this is to add all the  libjpeg, libpng, and zlib source files in the dlib/external folder into your project and also define the  DLIB_PNG_SUPPORT and DLIB_JPEG_SUPPORT preprocessor directives. If you don't know  how to configure Visual Studio then you should use CMake as shown above since it will  take care of everything automatically.  

    Installing dlib as a precompiled library

     Dlib's cmake scripts contain the standard install target. So you  can use CMake to install dlib system wide as a precompiled static or  shared library just like you would any other C++ library.  However, most users should use CMake as described at the top of this  page (specifically as shown in the examples project) since  that's the simplest method. In particular, it allows you to turn  dlib's debugging modes on and off whenever you want, which is  something you really should use since dlib's debugging modes are one  of its strongest features. 
    We should also make a special note of the problems associated with  using precompiled C++ libraries with Visual Studio. The TLDR is  that you should not use precompiled libraries (i.e. .lib files)  with Visual Studio unless you really know what you are doing.  This is not a dlib limitation. It has nothing to do with dlib.  It's just how Visual Studio works. Please do not ask me about it.  If you want to understand this you should read the Visual Studio  documentation and this excellent overview in particular. 
    However, for the lazy, I'll summarize the issue with Visual Studio here.  The problem is that Visual Studio has multiple incompatible  runtimes and it is illegal to mix object code compiled with  different runtimes in a single application. For example, if you  compile a C++ library in Visual Studio's "Release" mode then it is  illegal to use in an application compiled in Visual Studio's  "Debug" mode. 
    This is made especially bad since each version of  Visual Studio contains its own set of runtimes, at least  8 different runtimes per each version of Visual Studio, and all of  them are incompatible with each other. Most Visual Studio users  seem to be completely unaware of this, many who contact me demonstrably  do not even understand what the words "runtime" or "object code" even  refer to. So the issue of ensuring that all object code (and  precompiled libraries) in an application use the same runtimes  is made extremely difficult when using precompiled libraries.  However, if you just use CMake as described at the top of this  page then it will never be an issue, which is one of the reasons I recommend it.  
     To summarize, if you don't understand what the above paragraphs are talking  about then you absolutely should not be installing dlib as a precompiled library  in Visual Studio. Instead, go to the top of this page and read the instructions  there. Follow those instructions, it's super easy and will Just Work. 

    Miscellaneous Preprocessor Directives

     In addition to the preprocessor directives mentioned above, there  are a few more you can supply during the build process to cause the  library to build in various optional ways. By default, the library  will always do something reasonable, but they are listed here in  the event that you need to use them.  

    #define ENABLE_ASSERTS

     Defining this directive causes all the DLIB_ASSERT macros to  be active. If you are using Visual Studio or CMake then ENABLE_ASSERTS will be automatically enabled  for you when you compile in debug mode. However, if you are using a different build system then you  might have to manually enable it if you want to turn the asserts on.  

    #define DLIB_ISO_CPP_ONLY

     This is a #define directive that you can set to cause the library to exclude all non ISO C++ code (The things in the API wrappers section and any objects that depend on those wrappers).  This is useful if you are trying to build on a system that isn't fully supported by the library or if you  just decide you don't want any of that stuff compiled into your program for your own reasons.  

    #define DLIB_NO_GUI_SUPPORT

     This is just like the DLIB_ISO_CPP_ONLY option except that it excludes only the GUI part of the library.  An example of when you might want to use this would be if you don't need GUI support and you are building  on a UNIX platform that doesn't have the X11 headers installed.  

    #define DLIB_THREAD_POOL_TIMEOUT <time-in-milliseconds>

     If you use dlib to create your threads then you receive the benefit of the dlib dynamic thread pool (Note that the  dlib::thread_pool object is something else unrelated to this so don't confuse  the two). This pool  enables dlib to spawn new threads very rapidly since it draws threads back out of its thread pool when  the pool isn't empty. 
    Thus, when a thread that was created by dlib ends it actually goes back into the dlib thread pool  and waits DLIB_THREAD_POOL_TIMEOUT milliseconds before totally terminating and releasing its resources back  to the operating system. The default timeout used by this library is 30,000 milliseconds (30 seconds). You  may however change this to whatever you like by defining DLIB_THREAD_POOL_TIMEOUT to some new value.