summaryrefslogtreecommitdiff
path: root/src/ipa/raspberrypi/controller/algorithm.h
blob: ce3ca95f65f6a0cfaef254eff97661a295eba668 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/* SPDX-License-Identifier: BSD-2-Clause */
/*
 * Copyright (C) 2019, Raspberry Pi (Trading) Limited
 *
 * algorithm.h - ISP control algorithm interface
 */
#pragma once

/*
 * All algorithms should be derived from this class and made available to the
 * Controller.
 */

#include <string>
#include <memory>
#include <map>

#include "controller.h"

#include <boost/property_tree/ptree.hpp>

namespace RPiController {

/* This defines the basic interface for all control algorithms. */

class Algorithm
{
public:
	Algorithm(Controller *controller)
		: controller_(controller), paused_(false)
	{
	}
	virtual ~Algorithm() = default;
	virtual char const *name() const = 0;
	virtual bool isPaused() const { return paused_; }
	virtual void pause() { paused_ = true; }
	virtual void resume() { paused_ = false; }
	virtual void read(boost::property_tree::ptree const &params);
	virtual void initialise();
	virtual void switchMode(CameraMode const &cameraMode, Metadata *metadata);
	virtual void prepare(Metadata *imageMetadata);
	virtual void process(StatisticsPtr &stats, Metadata *imageMetadata);
	Metadata &getGlobalMetadata() const
	{
		return controller_->getGlobalMetadata();
	}

private:
	Controller *controller_;
	bool paused_;
};

/*
 * This code is for automatic registration of Front End algorithms with the
 * system.
 */

typedef Algorithm *(*AlgoCreateFunc)(Controller *controller);
struct RegisterAlgorithm {
	RegisterAlgorithm(char const *name, AlgoCreateFunc createFunc);
};
std::map<std::string, AlgoCreateFunc> const &getAlgorithms();

} /* namespace RPiController */