1# Overview 2 3WebVfx is a video effects library that allows effects to be implemented using [WebKit HTML](http://trac.webkit.org/wiki/QtWebKit) or [Qt QML](http://doc.qt.io/qt-5/qmlapplications.html). 4 5## Prerequisites 6 7You will need [Qt](http://qt-project.org/downloads/) installed (5.2 or later recommended). Qt includes QtWebKit and QML, but since v5.6, you need to [build QtWebKit](http://trac.webkit.org/wiki/QtWebKit#BuildInstructions) yourself. 8You may also want to build [Qt3D](http://doc.qt.io/qt-5/qt3d-index.html) - 3D extensions to QML. WebVfx includes support for Qt3D, and Qt include Qt3D as of v5.6. 9 10WebVfx includes an MLT service that exposes producers, filters and transitions implemented in WebVfx. Install [MLT Framework](https://www.mltframework.org/) 0.7.2 or greater to build the plugin. 11 12## Building 13 14In the webvfx directory run `qmake -r PREFIX=/usr/local` and then `make install`. `PREFIX` determines where WebVfx will be installed. If MLT is installed in a non-standard location, you may need to set the `PKG_CONFIG_PATH` environment variable to where its pkgconfig file lives, e.g. `PKG_CONFIG_PATH=/usr/local/lib/pkgconfig`. 15 16The [MLT melt](https://www.mltframework.org/twiki/bin/view/MLT/MltMelt) command will not work with WebVfx on Windows or OS X because the Qt event loop must run on the main thread. If you set `MLT_SOURCE` to the root of your MLT source code directory, then a `qmelt` executable will be installed which behaves the same as `melt` but works with WebVfx on Windows or OS X. e.g. `qmake -r PREFIX=/usr/local MLT_SOURCE=~/Projects/mlt`. 17 18`make doxydoc` to generate the documentation using Doxygen. 19You can also `make uninstall`, `make clean` and `make distclean`. 20 21## Demos 22 23See the [documentation](https://www.mltframework.org/doxygen/webvfx/) for examples. 24 25## License 26 27Copyright (c) 2011 Hewlett-Packard Development Company, L.P. All rights reserved. 28Use of this source code is governed by a BSD-style license that can be 29found in the LICENSE file. 30