live-keys / livekeys

Livekeys - Automation Platform with support for live scripting.

---

• Version: 1.9.1
• License: LGPL
• Website: livekeys.io
• Demo: www.youtube.com/watch?v=ZPt5KSy1wh0
• Documentation: livekeys.io/docs
• Build Requirements:
  • Qt 5.12 or higher
  • Open CV 4.1 or higher

Livekeys is a platform that automates content creation in real time by combining visual scripting with live coding. Components are used to create pipelines for familiarized tasks (file reading, video editing, computer vision modules, etc), providing configuration via their user interfaces. To extend this pipeline, users can build their own components via live coding. Main features include:

• Image and Video Processing: Load image/video files and applying various filters

• Node Editor : Connect and configure components via nodes in a graph

• Timeline Editor: Schedule animations and organize video segments

• Code editor: Syntax highlighting, code completion, live coding, and seamless switching between UI configuration and code

• Interactive learning module: Provides tutorials with interactions that guide you through the process of learning Livekeys.

• Plugin support: Components are wrapped in plugins, then packages, which are installable through a package manager.

Installation and getting started

To get started, simply download the application from Livekeys's website, extract the archive, and you're ready to go. Step by step instructions are also found in the download section.

Compiling

To compile Livekeys, you need to have Qt and Open CV installed. You can then use qmake to generate the makefile, and run make or nmake to build:

cd <livekeys_path>/build
qmake -r ..
make (or nmake)

The executable and plugins will be found in the bin directory.

Contributing

There's an organization on github created for Livekeys plugins and projects, so anyone looking to contribute is always welcome. This section offers a quick overview on contributing, and there are simple quickstart issues available for anyone looking to start. Most of them deal with wrapping an Open CV functions and adding a sample. There are issues marked with easy which are similar, but may have a few more displayable parameters or require a bit more processing.

There's a chat room available on gitter and also a forum.

Changes

For changes and compatibility information between versions, see the CHANGELOG.

Roadmap

Livekeys's goal is to provide an environment where people can experiment with different libraries or algorithms and can also share their own as easily as possible. To do this, it needs to be scalable, plugin-based, have a simple and easy to use build system, and a place to access and share plugins. Our goal is to reach this in version 2.0 of the application.

• Version 1.10 - MultiThreading Module
  • Async execution
• Version 2.0 - Package Manager Details
  • Plugin and sample showroom on Live Keys's website
  • Support for fetching plugins and samples from within the application

livekeys's Issues

Configure Log window to scroll automatically to last entry.

[lcvimgproc] Add histogram view for images.

RGB, HSV, Greyscale histogram.

ColorHistogram{
    type : RGB/HSV //default : RGB
    image: input image
    fill : true / false // histogram draw type, default : false
    channel : 0 // optional, default -1
}

Iterate each channel or selected channel from the image and calculate histogram. Display all channels overlapped if no channel is selected.

Define command line arguments interface.

To not clutter the main script section, I would create a CommandLineArguments object, then use it as:

Arguments.qml

CommandLineArguments{
    CommandLineOption{
        key : ['r', 'read']
        type : 'required'
        description/help: 'Input file.'
    }
}

main.qml

Script{
    args: Arguments{}
}

Add preview mode.

Preview mode allows Live CV to open files without the editor. (Suggested command line argument flag '--preview')

Create a qml parser in c++, or see how to access an existing one.

This is needed for the code completion model.

Fix local directory import error messages.

Integrate keypoint matcher into keypoint selection module and sample.

Add DropDown element.

[lcvstitching] Add Stitcher{}

http://docs.opencv.org/2.4/modules/stitching/doc/high_level.html#stitcher

provide the calling graph of the processing in the log window

It would be very useful if I tested the processing procedure and it works, now i want to add the processing procedure (API calls) to my application source code, i can just open the log window, copy and paste to my source code editor, followed by minor modifications to fit into the code context.
that will save a lot of time for developing.

i would also suggest to include both python and/or c++ calls

[lcvphoto] Add Levels auto adjustment.

Add support to determine auto-adjustment levels for an image.

[lcvcontrols] Add LevelsBox

LevelsBox{} adds sliders, and histograms to an image levels adjustment.

[lcvphoto] Add HueSaturationValue box.

Compile files in a separate thread.

On scripts that require heavy computation, the GUI blocks for writing.

Need to switch from main.qml:

newItem = Qt.createQmlObject(
                                    "import QtQuick 2.3\n" + tester.program,
                                    tester,
                                    codeDocument.file.toString() !== '' ? codeDocument.file : 'untitled.qml');

With a separate implementation, info found at Qts sources, in Qt/Src/qtquick1/src/declarative/qml/qdeclarativeengine.cpp

Allow separate editors, monitor files for changes.

Environment variable issues in linux.

External modules fail to load in certain scenarios. Check cause.

[lcvvideo] Add BackgroundSubtractor{}

http://docs.opencv.org/2.4/modules/video/doc/motion_analysis_and_object_tracking.html#backgroundsubtractor

Add editor quick-file navigation.

Add object detection sample.

[lcvphoto] Add Tonemapping for hdr Images. [Requires #44].

MatchList - Add support for adding list objects programatically.

[lcvphoto] Add HueSaturationValues{}

Add HueSaturationValue{} component.

Add editor search/search & replace box.

Add comand line argument parsing.

This requires a custom parser to be implemented, since the scripts need access to command line arguments as well:

livecv.exe [--option value --option2 value] script.qml [args]

ObjectMatch plugin : Keypoints are not drawn after a change has been registered

Add support for line-based parsing for qml (Line state)[Requires #30]

I will detail this later on.

[lcvcontrols] Add Slider{}

Slider{
    from: 0
    to : 255
    value : output
}

[lcvvideo] Add BackgroundSubtractorMog{}

http://docs.opencv.org/2.4/modules/video/doc/motion_analysis_and_object_tracking.html#backgroundsubtractormog

StateId fix in feature comparison sample.

[lcvphoto] Add Levels{}

Set global levels, and on a per channel basis:

Levels{
    white : 253 // from 0 to image max color, default : imageMaxColor
    black : 20 // from 0 to image max color, default : 0
    contrast : 155 // from 0 to image max color, default imageMaxColor / 2
    channel : { 0: [0, 255, 124], 1: [0, 255, 124]}
}

Add command line argument test. [Requires #23]

Add file tree-view for project root.

A Live CV project will be a directory containing one or more qml files. Project directories can be opened, and specific files can be set as the startup files.

We need a file-tree view in the GUI. A toggle on/off option. A 'set as startup' option. And an "Open Project" button.

Longer error messages are not visible in the error panel.

[lcvcontrols] Add MultiSlider{}

A multi slider lets you have an unlimited number of slideable elements in the same box. When a user
double clicks, a new slidable element is added. The dynamic property disables adding of new slider elements.

MultiSlider{
    id : ds
    elements : [0, 100, 255] // number of elements and their position
    dynamic : false // default: true
}

Add feauture detectors to drop down panel.

Define main script interface.

The main script interface defines the main project file. Currently, it's function would be to configure command line arguments and set up the version:

Main{
    args : [ 
        {key: ['r', 'read'], type: required, describe: 'input file'},
        {key: ['w', 'write'], type: required, describe: 'output file'}
    ]
}

Suggested names : Main, CVMain, MainScript, Script

[lcvvideo] Add CalcOpticalFlowFarneback{}

http://docs.opencv.org/2.4/modules/video/doc/motion_analysis_and_object_tracking.html#calcopticalflowfarneback

Add descriptor extractors to drop-down panel.

Add editable value panel.

[lcvcontrol] Add ColorHistogramControl. [Requires #35, #39]

Add HistogramControl, adding a dropbox to select image channel

ColorHistogramControl{
DropDown{...}
ColorHistogram{...}
}

Add compile signals. [Requires #22]

Compile started and compile ended signals from the engine should be available for the application in order to start specific behaviors during each one.

Add state samples.

Add support for LK Optical flow tracker and MOG2 background extractor.

FeatureCompare Sample does not keep state on windows compilations.

Build QStateContainer.

[lcvphoto] Add Hdr{} component.

Merge a set of hdr photos.

Add qml parser tests.

Add code completion GUI box. [Requires #32]

[lcvphoto] Add ExposureAndContrast{}

ExposureAndContrast{
    exposure : 1.5 // from -5 to +5
    contrast : -1.5 // from -5 to +5
}

[lcvvideo] Add BackgroundSubtractorMog2{}

Add code completion model [Requires #30, #31]