StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
report.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Multimedia.
5 *
6 * StormByte-Multimedia original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Multimedia source in this
20 * file. Third-party components — including FFmpeg and embedded trained data —
21 * remain under their own licenses and are not covered by the commercial grant.
22 *
23 * A written StormByte commercial agreement may license this original source
24 * on terms other than the LGPL, including specific use, distribution or
25 * linking arrangements such as static linking, as stated in that agreement.
26 * It does not grant rights to dependencies or waive their license conditions.
27 * Enabling WITH_GPL or WITH_NONFREE may include components with separate
28 * obligations for modification, linking (static or dynamic), redistribution
29 * or works that incorporate them. The person modifying, linking, packaging or
30 * distributing the resulting work is responsible for determining and meeting
31 * all applicable requirements, including any needed patent permissions.
32 * A StormByte commercial agreement does not provide those rights for GPL or
33 * nonfree components.
34 *
35 * Neither license grants any patent rights. Any patent licenses required
36 * to use this software or third-party components must be obtained separately
37 * from the patent holders.
38 *
39 * StormByte-Multimedia is distributed in the hope that it will be useful,
40 * but WITHOUT ANY WARRANTY; without even the implied warranty of
41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
42 * GNU Lesser General Public License for more details.
43 *
44 * You should have received a copy of the GNU Lesser General Public License
45 * version 3 along with StormByte-Multimedia. If not, see
46 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
47 *
48 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
49 */
50
51#pragma once
52
54#include <StormByte/safe/map.hxx>
55#include <StormByte/safe/string.hxx>
56
75 public:
80 enum class Status {
82 Ok,
84 };
85
90
97
102 Report(const Report& other);
103
108 Report(Report&& other);
109
113 ~Report() noexcept;
114
120 Report& operator=(const Report& other);
121
127 Report& operator=(Report&& other) noexcept;
128
133 Status Kind() const noexcept;
134
139 const StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String>& Data() const noexcept;
140
145 StormByte::Safe::String operator()() const;
146
147 private:
148 Status m_status;
149 StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String> m_data;
150 };
151}
152
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Report(Report &&other)
Move constructor.
const StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > & Data() const noexcept
Dictionary payload.
Report(Status status, StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > data)
Report with a status and a dictionary.
Status
Whether this node produced usable data.
Definition report.hxx:80
Status Kind() const noexcept
Measurement status.
Report(const Report &other)
Copy constructor.
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Frame and packet steps attached to a job or a raw pipeline.
@ Failed
Execution ended with a stage failure.
Definition activity.hxx:88
@ None
No flags.
Definition feature.hxx:83
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61