PNGParallelRecordingStrategy.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * ArmarX is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * ArmarX is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * @package visionx::imrec
17  * @author Christian R. G. Dreher <christian.dreher@student.kit.edu>
18  * @date 2018
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 
24 #pragma once
25 
26 
27 // STD/STL
28 #include <atomic>
29 #include <condition_variable>
30 #include <mutex>
31 #include <string>
32 
33 // ArmarX
36 
37 
38 namespace visionx::imrec::strats
39 {
40 
41  /**
42  * Concrete strategy for a PNG image recording
43  */
46  {
47 
48  protected:
49 
50  unsigned int m_png_compression;
51 
53  std::mutex m_pool_mutex;
54  std::condition_variable m_pool_cv;
55  unsigned int m_pool_max_size;
56  std::atomic<unsigned int> m_pool_current_size;
57 
58  public:
59 
61  PNGParallelRecordingStrategy(const std::filesystem::path& filePath, const std::string& file_name, unsigned int png_compression = 9, unsigned int thread_pool_size = 1);
63 
64  static void recordSnapshot(const cv::Mat& image, const std::filesystem::path& path);
65  static void recordSnapshot(const CByteImage& image, const std::filesystem::path& path);
66 
67  void startRecording() override;
68  void stopRecording() override;
69  void recordFrame(const cv::Mat& frame, std::chrono::microseconds timestamp) override;
70  void recordFrameAsync(std::filesystem::path path, const cv::Mat& frame);
71 
72  };
73 
74 }
visionx::imrec::strats::PNGParallelRecordingStrategy
Concrete strategy for a PNG image recording.
Definition: PNGParallelRecordingStrategy.h:44
visionx::imrec::strats::PNGParallelRecordingStrategy::m_pool_mutex
std::mutex m_pool_mutex
Definition: PNGParallelRecordingStrategy.h:53
visionx::imrec::strats::PNGParallelRecordingStrategy::startRecording
void startRecording() override
Starts the recording manually if constructed empty.
Definition: PNGParallelRecordingStrategy.cpp:94
AbstractSequencedRecordingStrategy.h
visionx::imrec::strats::PNGParallelRecordingStrategy::recordSnapshot
static void recordSnapshot(const cv::Mat &image, const std::filesystem::path &path)
Definition: PNGParallelRecordingStrategy.cpp:64
visionx::imrec::strats::PNGParallelRecordingStrategy::PNGParallelRecordingStrategy
PNGParallelRecordingStrategy()
Definition: PNGParallelRecordingStrategy.cpp:40
visionx::imrec::strats::PNGParallelRecordingStrategy::m_record_frame_mutex
std::mutex m_record_frame_mutex
Definition: PNGParallelRecordingStrategy.h:52
visionx::imrec::AbstractSequencedRecordingStrategy
An object of this class behaves likee a normal recording, but is in fact a sequence of images.
Definition: AbstractSequencedRecordingStrategy.h:41
visionx::imrec::strats::PNGParallelRecordingStrategy::m_pool_max_size
unsigned int m_pool_max_size
Definition: PNGParallelRecordingStrategy.h:55
visionx::imrec::strats::PNGParallelRecordingStrategy::~PNGParallelRecordingStrategy
~PNGParallelRecordingStrategy() override
Definition: PNGParallelRecordingStrategy.cpp:57
visionx::imrec::strats::PNGParallelRecordingStrategy::recordFrame
void recordFrame(const cv::Mat &frame, std::chrono::microseconds timestamp) override
Adds the given frame to the recording.
Definition: PNGParallelRecordingStrategy.cpp:113
visionx::imrec::strats::PNGParallelRecordingStrategy::m_pool_current_size
std::atomic< unsigned int > m_pool_current_size
Definition: PNGParallelRecordingStrategy.h:56
visionx::imrec::strats::PNGParallelRecordingStrategy::stopRecording
void stopRecording() override
Stops the recording.
Definition: PNGParallelRecordingStrategy.cpp:103
visionx::imrec::strats::PNGParallelRecordingStrategy::m_pool_cv
std::condition_variable m_pool_cv
Definition: PNGParallelRecordingStrategy.h:54
visionx::imrec::strats::PNGParallelRecordingStrategy::m_png_compression
unsigned int m_png_compression
Definition: PNGParallelRecordingStrategy.h:50
visionx::imrec::strats
Definition: ChunkedImageSequencePlaybackStrategy.h:38
Logging.h
visionx::imrec::strats::PNGParallelRecordingStrategy::recordFrameAsync
void recordFrameAsync(std::filesystem::path path, const cv::Mat &frame)
Definition: PNGParallelRecordingStrategy.cpp:133