uvgVPCCenc 1.2.0
uvgVPCCenc is an open-source real-time V-PCC encoder library written in C++ from scratch.
Loading...
Searching...
No Matches
uvgvpccenc.hpp
Go to the documentation of this file.
1/*****************************************************************************
2 * This file is part of uvgVPCCenc V-PCC encoder.
3 *
4 * Copyright (c) 2024, Tampere University, ITU/ISO/IEC, project contributors
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without modification,
8 * are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
9 *
10 * * Redistributions of source code must retain the above copyright notice, this
11 * list of conditions and the following disclaimer.
12 *
13 * * Redistributions in binary form must reproduce the above copyright notice, this
14 * list of conditions and the following disclaimer in the documentation and/or
15 * other materials provided with the distribution.
16 *
17 * * Neither the name of Tampere University, ITU/ISO/IEC 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 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
26 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND ON
29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS
32 ****************************************************************************/
33
35
36#pragma once
37
38#include <cstddef>
39#include <memory>
40#include <mutex>
41#include <queue>
42#include <semaphore>
43#include <string>
44#include <vector>
45
47#include "v3cbitstream.hpp"
48
49namespace uvgvpcc_enc {
50
52namespace API {
53
58
60void setParameter(const std::string& parameterName, const std::string& parameterValue);
61void encodeFrame(std::shared_ptr<uvgformat::uvgFrame> frame, v3c_unit_stream* output);
62void emptyFrameQueue();
63void stopEncoder();
64
65} // namespace API
66
67}; // namespace uvgvpcc_enc
VUT
Definition const_defs.h:175
void stopEncoder()
Insure a proper end of the encoder execution.
Definition uvgvpccenc.cpp:736
void initializeEncoder()
Create the context of the uvgVPCCenc encoder. Parse the input parameters and verify if the given conf...
Definition uvgvpccenc.cpp:601
void setParameter(const std::string &parameterName, const std::string &parameterValue)
The only way to modify the exposed uvgVPCCenc parameters is by calling this function.
Definition uvgvpccenc.cpp:622
void encodeFrame(std::shared_ptr< uvgformat::uvgFrame > frame, v3c_unit_stream *output)
Entry point of the uvgVPCCenc library. Take as input a uvgFrame. Create all the jobs for processing t...
Definition uvgvpccenc.cpp:641
void emptyFrameQueue()
This function is called when all frames to be processed have been sent to the encoder....
Definition uvgvpccenc.cpp:725
Definition uvgvpccenc.hpp:49
One GOF-worth of ordered V3C units emitted by the encoder.
Definition v3cbitstream.hpp:67
Definition v3cbitstream.hpp:71
One complete V3C unit, including the V3C unit header.
Definition v3cbitstream.hpp:57