aboutsummaryrefslogtreecommitdiff
path: root/samples/common/include/CVUtils/IFrameReader.hpp
blob: e171b3bb942a3e1da50333680a3a521dd31252f6 (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
//
// Copyright © 2020 Arm Ltd and Contributors. All rights reserved.
// SPDX-License-Identifier: MIT
//

#pragma once

#include <cstddef>
#include <memory>

namespace common
{
/**
 * @brief Frame source reader interface
 *
 * @tparam FrameDataT frame container data type
 */
template<typename FrameDataT> class IFrameReader
{

public:
    /**
     * @brief Reads the next frame from the source
     *
     * @return pointer to the frame container
     */
    virtual std::shared_ptr <FrameDataT> ReadFrame() = 0;

    /**
     * @brief Checks if the frame source has more frames to read.
     *
     * @param[in] frame the pointer to the last frame captured with the ReadFrame method could be used in
     *                  implementation specific logic to check frames source state.
     * @return True if frame source was exhausted, False otherwise
     */
    virtual bool IsExhausted(const std::shared_ptr <FrameDataT>& frame) const = 0;

    /**
     * @brief Default destructor
     */
    virtual ~IFrameReader() = default;

};

}// namespace common