lipi-toolkit/plugin/lipisharedrecognizer.cpp

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "lipisharedrecognizer_p.h"
#include <QLoggingCategory>
#include "lipiworker_p.h"

#include "LTKMacros.h"
#include "LTKInc.h"
#include "LTKTypes.h"
#include "LTKOSUtil.h"
#include "LTKOSUtilFactory.h"
#include "LTKErrorsList.h"
#include "LTKErrors.h"
#include "LTKLogger.h"
#include "LTKConfigFileReader.h"
#include "LTKException.h"
#include "LTKLipiEngineInterface.h"

#include <QDir>
#include <QtCore/QLibraryInfo>

QT_BEGIN_NAMESPACE
namespace QtVirtualKeyboard {

Q_DECLARE_LOGGING_CATEGORY(lcLipi)

int LipiSharedRecognizer::s_lipiEngineRefCount = 0;
QString LipiSharedRecognizer::s_lipiRoot;
QString LipiSharedRecognizer::s_lipiLib;
void *LipiSharedRecognizer::s_lipiEngineHandle = nullptr;
LipiSharedRecognizer::FN_PTR_CREATELTKLIPIENGINE LipiSharedRecognizer::s_createLTKLipiEngine = nullptr;
LipiSharedRecognizer::FN_PTR_DELETELTKLIPIENGINE LipiSharedRecognizer::s_deleteLTKLipiEngine = nullptr;
LTKLipiEngineInterface *LipiSharedRecognizer::s_lipiEngine = nullptr;
LTKShapeRecognizer *LipiSharedRecognizer::s_shapeRecognizer = nullptr;
LipiWorker *LipiSharedRecognizer::s_lipiWorker = nullptr;
QMap<int, QChar> LipiSharedRecognizer::s_unicodeMap;
QString LipiSharedRecognizer::s_activeModel;
stringStringMap LipiSharedRecognizer::s_lipiEngineConfigEntries;
int LipiSharedRecognizer::s_recognitionCount = 0;

/*!
    \class QtVirtualKeyboard::LipiSharedRecognizer
    \internal
*/

LipiSharedRecognizer::LipiSharedRecognizer()
{
    loadLipiInterface();
}

LipiSharedRecognizer::~LipiSharedRecognizer()
{
    unloadLipiInterface();
}

QString LipiSharedRecognizer::model() const
{
    return s_activeModel;
}

bool LipiSharedRecognizer::setModel(const QString &modelName)
{
    qCDebug(lcLipi) << "LipiSharedRecognizer::setModel():" << modelName;

    if (!s_lipiEngine) {
        qCWarning(lcLipi) << "Engine not initialized";
        return false;
    }

    if (modelName.isEmpty())
        return false;

    if (modelName == s_activeModel)
        return true;

    unloadModelData();

    return loadModelData(modelName) == SUCCESS;
}

void LipiSharedRecognizer::subsetOfClasses(const QString &charset, vector<int> &outSubsetOfClasses) const
{
    outSubsetOfClasses.clear();
    outSubsetOfClasses.reserve(charset.length());
    QString notFound;
    for (int i = 0; i < charset.length(); i++) {
        int classId = s_unicodeMap.key(charset.at(i), -1);
        if (classId != -1)
            outSubsetOfClasses.push_back(classId);
        else if (lcLipi().isDebugEnabled())
            notFound.append(charset.at(i));
    }
    if (!notFound.isEmpty())
        qCDebug(lcLipi) << "LipiSharedRecognizer::subsetOfClasses(): unrecognized characters" << notFound;
}

QSharedPointer<LipiRecognitionTask> LipiSharedRecognizer::newRecognition(const LTKCaptureDevice& deviceInfo,
                                                                         const LTKScreenContext& screenContext,
                                                                         const vector<int>& inSubsetOfClasses,
                                                                         float confThreshold,
                                                                         int numChoices)
{
    if (!s_lipiEngine || !s_shapeRecognizer || !s_lipiWorker)
        return QSharedPointer<LipiRecognitionTask>();

    QSharedPointer<LipiRecognitionTask> task(new LipiRecognitionTask(deviceInfo,
                                                                     screenContext,
                                                                     inSubsetOfClasses,
                                                                     confThreshold,
                                                                     numChoices,
                                                                     s_recognitionCount));

    ++s_recognitionCount;

    return task;
}

QSharedPointer<LipiRecognitionResultsTask> LipiSharedRecognizer::startRecognition(QSharedPointer<LipiRecognitionTask> &recognitionTask)
{
    if (!s_lipiEngine || !s_shapeRecognizer || !s_lipiWorker)
        return QSharedPointer<LipiRecognitionResultsTask>();

    QSharedPointer<LipiRecognitionResultsTask> resultsTask(new LipiRecognitionResultsTask(recognitionTask->resultVector,
                                                                                          s_unicodeMap,
                                                                                          recognitionTask->resultId()));

    s_lipiWorker->addTask(recognitionTask);
    s_lipiWorker->addTask(resultsTask);

    return resultsTask;
}

bool LipiSharedRecognizer::cancelRecognition()
{
    if (!s_lipiEngine || !s_shapeRecognizer || !s_lipiWorker)
        return false;

    return s_lipiWorker->removeAllTasks() > 0;
}

bool LipiSharedRecognizer::cancelRecognitionTask(QSharedPointer<LipiRecognitionTask> &recognitionTask)
{
    if (!s_lipiEngine || !s_shapeRecognizer || !s_lipiWorker || !recognitionTask)
        return false;

    return recognitionTask->cancelRecognition() || s_lipiWorker->removeTask(recognitionTask) > 0;
}

int LipiSharedRecognizer::loadLipiInterface()
{
    qCDebug(lcLipi) << "LipiSharedRecognizer::loadLipiInterface():" << s_lipiEngineRefCount;

    if (++s_lipiEngineRefCount == 1) {
        if (s_lipiRoot.isEmpty()) {
            /*  LIPI_ROOT defines the root directory for lipi-toolkit project.
                LIPI_LIB is an extension implemented for QtVirtualKeyboard and
                allows using different location for lipi-toolkit plugins.

                LIPI_LIB defaults to LIPI_ROOT + "/lib".
            */
            bool lipiRootVarIsEmpty = qEnvironmentVariableIsEmpty("LIPI_ROOT");
            s_lipiRoot = lipiRootVarIsEmpty ?
                        QDir(QLibraryInfo::location(QLibraryInfo::DataPath) + QLatin1String("/qtvirtualkeyboard/lipi_toolkit")).absolutePath() :
                        qEnvironmentVariable("LIPI_ROOT");

            bool lipiLibVarIsEmpty = qEnvironmentVariableIsEmpty("LIPI_LIB");
            if (!lipiLibVarIsEmpty)
                s_lipiLib = qEnvironmentVariable("LIPI_LIB");
            else if (!lipiRootVarIsEmpty)
                s_lipiLib = s_lipiRoot + QLatin1String("/lib");
            else
                s_lipiLib = QDir(QLibraryInfo::location(QLibraryInfo::PluginsPath) + QLatin1String("/lipi_toolkit")).absolutePath();
        }

        QScopedPointer<LTKOSUtil> osUtil(LTKOSUtilFactory::getInstance());
        const string lipiRootPath(QDir::toNativeSeparators(s_lipiRoot).toStdString());
        const string lipiLibPath(QDir::toNativeSeparators(s_lipiLib).toStdString());

        int result = osUtil->loadSharedLib(lipiLibPath, LIPIENGINE_MODULE_STR, &s_lipiEngineHandle);
        if (result != SUCCESS) {
            qCWarning(lcLipi) << QStringLiteral("Error %1: Could not open shared library for module '%2'").arg(result).arg(QLatin1String(LIPIENGINE_MODULE_STR));
            return result;
        }

        result = loadLipiEngineConfig();
        if (result != SUCCESS)
            return result;

        result = osUtil->getFunctionAddress(s_lipiEngineHandle, "createLTKLipiEngine", (void **)&s_createLTKLipiEngine);
        if (result != SUCCESS) {
            qCWarning(lcLipi) << QStringLiteral("Error %1: %2").arg(result).arg(QLatin1String(getErrorMessage(result).c_str()));
            return result;
        }

        result = osUtil->getFunctionAddress(s_lipiEngineHandle, "deleteLTKLipiEngine", (void **)&s_deleteLTKLipiEngine);
        if (result != SUCCESS) {
            qCWarning(lcLipi) << QStringLiteral("Error %1: %2").arg(result).arg(QLatin1String(getErrorMessage(result).c_str()));
            return result;
        }

        s_lipiEngine = s_createLTKLipiEngine();
        s_lipiEngine->setLipiRootPath(lipiRootPath);
        s_lipiEngine->setLipiLibPath(lipiLibPath);
#if 0
        s_lipiEngine->setLipiLogFileName(QDir::toNativeSeparators(QString("%1/lipi.log").arg(s_lipiRoot)).toStdString());
        s_lipiEngine->setLipiLogLevel("DEBUG");
#endif

        result = s_lipiEngine->initializeLipiEngine();
        if (result != SUCCESS) {
            qCWarning(lcLipi) << QStringLiteral("Error %1: %2").arg(result).arg(QLatin1String(getErrorMessage(result).c_str()));
            return result;
        }
    }

    return SUCCESS;
}

void LipiSharedRecognizer::unloadLipiInterface()
{
    qCDebug(lcLipi) << "LipiSharedRecognizer::unloadLipiInterface():" << s_lipiEngineRefCount;

    Q_ASSERT(s_lipiEngineRefCount > 0);
    if (--s_lipiEngineRefCount == 0) {
        unloadModelData();
        if (s_lipiEngine) {
            s_deleteLTKLipiEngine();
            s_lipiEngine = nullptr;
        }
        s_createLTKLipiEngine = nullptr;
        s_deleteLTKLipiEngine = nullptr;
        QScopedPointer<LTKOSUtil> osUtil(LTKOSUtilFactory::getInstance());
        osUtil->unloadSharedLib(s_lipiEngineHandle);
        s_lipiEngineHandle = nullptr;
    }
}

int LipiSharedRecognizer::loadLipiEngineConfig()
{
    s_lipiEngineConfigEntries.clear();

    const QString &lipiEngineConfigFile(QDir::toNativeSeparators(QStringLiteral("%1/projects/lipiengine.cfg").arg(s_lipiRoot)));
    if (!QFileInfo::exists(lipiEngineConfigFile)) {
        qCWarning(lcLipi) << "File not found" << lipiEngineConfigFile;
        return FAILURE;
    }

    try {
        LTKConfigFileReader configReader(lipiEngineConfigFile.toStdString());
        s_lipiEngineConfigEntries = configReader.getCfgFileMap();
    } catch (LTKException e) {
        return e.getErrorCode();
    }

    return SUCCESS;
}

int LipiSharedRecognizer::resolveLogicalNameToProjectProfile(const QString &logicalName, QString &outProjectName, QString &outProfileName)
{
    outProjectName.clear();
    outProfileName.clear();

    stringStringMap::const_iterator configEntry = s_lipiEngineConfigEntries.find(logicalName.toStdString());
    if (configEntry == s_lipiEngineConfigEntries.end())
        return FAILURE;

    QStringList parts = QString::fromStdString(configEntry->second).split(QLatin1Char('('), Qt::SkipEmptyParts);
    if (parts.length() != 2)
        return FAILURE;

    parts[1].replace(QLatin1Char(')'), QString());

    outProjectName = parts[0].trimmed();
    outProfileName = parts[1].trimmed();

    return SUCCESS;
}

int LipiSharedRecognizer::loadModelData(const QString &logicalName)
{
    qCDebug(lcLipi) << "LipiSharedRecognizer::loadModelData():" << logicalName;

    Q_ASSERT(s_shapeRecognizer == nullptr);
    Q_ASSERT(s_lipiWorker == nullptr);

    QTime perf;
    perf.start();

    s_activeModel = logicalName;

    QString project;
    QString profile;
    int result = resolveLogicalNameToProjectProfile(logicalName, project, profile);
    if (result == SUCCESS) {
        string strProject = project.toStdString();
        string strProfile = profile.toStdString();
        int result = s_lipiEngine->createShapeRecognizer(strProject, strProfile, &s_shapeRecognizer);
        if (result == SUCCESS) {
            result = loadMapping(QDir::toNativeSeparators(QStringLiteral("%1/projects/%2/config/unicodeMapfile_%2.ini").arg(s_lipiRoot).arg(project)));
            if (result == SUCCESS) {
                s_lipiWorker = new LipiWorker(s_shapeRecognizer);
                QSharedPointer<LipiLoadModelDataTask> loadModelDataTask(new LipiLoadModelDataTask());
                s_lipiWorker->addTask(loadModelDataTask);
                s_lipiWorker->start();
            }
        }
    }

    if (result == SUCCESS)
        qCDebug(lcLipi) << "LipiSharedRecognizer::loadModelData(): time:" << perf.elapsed() << "ms";

    if (result != SUCCESS) {
        qCWarning(lcLipi) << QStringLiteral("Error %1: %2").arg(result).arg(QLatin1String(getErrorMessage(result).c_str()));
        unloadModelData();
    }

    return result;
}

void LipiSharedRecognizer::unloadModelData()
{
    if (!s_shapeRecognizer)
        return;

    qCDebug(lcLipi) << "LipiSharedRecognizer::unloadModelData():" << s_activeModel;

    QTime perf;
    perf.start();

    if (s_lipiWorker) {
        delete s_lipiWorker;
        s_lipiWorker = nullptr;
    }

    s_lipiEngine->deleteShapeRecognizer(s_shapeRecognizer);
    s_shapeRecognizer = nullptr;
    s_unicodeMap.clear();
    s_activeModel.clear();

    qCDebug(lcLipi) << "LipiSharedRecognizer::unloadModelData(): time:" << perf.elapsed() << "ms";
}

int LipiSharedRecognizer::loadMapping(const QString &mapFile)
{
    if (!QFileInfo(mapFile).exists()) {
        qCWarning(lcLipi) << "File not found" << mapFile;
        return FAILURE;
    }

    try {
        LTKConfigFileReader configfilereader(mapFile.toStdString());
        const stringStringMap &cfgFileMap = configfilereader.getCfgFileMap();

        for (stringStringMap::const_iterator i = cfgFileMap.begin(); i != cfgFileMap.end(); i++) {
            if (i->first.empty())
                continue;
            if (!QChar::fromLatin1(i->first.at(0)).isDigit())
                continue;

            bool ok;
            int id = QString::fromLatin1(i->first.c_str()).toInt(&ok, 10);
            if (!ok)
                continue;

            QChar ch = QChar(QString::fromLatin1(i->second.c_str()).toInt(&ok, 16));
            if (!ok)
                continue;

            s_unicodeMap[id] = ch;
        }
    } catch (LTKException) {
        return FAILURE;
    }

    qCDebug(lcLipi) << s_unicodeMap;

    return SUCCESS;
}

} // namespace QtVirtualKeyboard
QT_END_NAMESPACE