Time-of-Flight-SDK
frame_handler.h
1 /*
2  * BSD 3-Clause License
3  *
4  * Copyright (c) 2019, Analog Devices, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from
19  * this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 #ifndef FRAME_HANDLER_H
33 #define FRAME_HANDLER_H
34 
35 #include <aditof/frame.h>
36 #include <aditof/status_definitions.h>
37 
38 #include <chrono>
39 #include <fstream>
40 #include <functional>
41 #include <iostream>
42 #include <mutex>
43 #include <queue>
44 #include <string>
45 #include <thread>
46 
47 #define METADATA_SIZE 128
48 
49 class FrameHandlerImpl;
50 
51 namespace aditof {
52 
57 class FrameHandler {
58  public:
59  SDK_API FrameHandler();
60  SDK_API ~FrameHandler();
61 
65  SDK_API FrameHandler(FrameHandler &&) noexcept;
69  SDK_API FrameHandler &operator=(FrameHandler &&) noexcept;
70 
76  SDK_API aditof::Status setOutputFilePath(const std::string &filePath);
77 
83  SDK_API aditof::Status setInputFileName(const std::string &fullFileName);
84 
93  const std::string &fileName = "");
94 
102  SDK_API aditof::Status
104  const std::string &fileName = "");
105 
114  const std::string &fullFileName = "");
115 
121  SDK_API aditof::Status setCustomFormat(const std::string &format);
122 
129  SDK_API aditof::Status storeFramesToSingleFile(bool enable);
135  SDK_API aditof::Status setFrameContent(const std::string &frameContent);
136 
137  private:
138  std::unique_ptr<FrameHandlerImpl> m_impl;
139 };
140 } // namespace aditof
141 #endif // FRAME_HANDLER_H
Namespace aditof.
Definition: frame.h:44
SDK_API aditof::Status saveFrameToFile(aditof::Frame &frame, const std::string &fileName="")
Store frame to file.
SDK_API aditof::Status setCustomFormat(const std::string &format)
A custom format in which the frames will be stored/read.
SDK_API aditof::Status setOutputFilePath(const std::string &filePath)
Set the output path/output folder for the frames.
Handles operations on a frame such as saving it to file and creating a new frame with content read fr...
Definition: frame_handler.h:57
SDK_API aditof::Status storeFramesToSingleFile(bool enable)
Enable/disable if single file is intended to use for storing data.
Frame of a camera.
Definition: frame.h:50
SDK_API aditof::Status readNextFrame(aditof::Frame &frame, const std::string &fullFileName="")
Reads frame from a file. If same file is provided it will continue to read from the last position.
Status
Status of any operation that the TOF sdk performs.
SDK_API aditof::Status setInputFileName(const std::string &fullFileName)
Set the input file for the frames.
SDK_API aditof::Status saveFrameToFileMultithread(aditof::Frame &frame, const std::string &fileName="")
Store frame to file using a separate thread.
SDK_API aditof::Status setFrameContent(const std::string &frameContent)
Set which frame element you want to store/read (depth/ab/conf)
SDK_API FrameHandler & operator=(FrameHandler &&) noexcept
Move assignment.