StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
activity.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/mutex.hxx>
55#include <StormByte/safe/vector.hxx>
56
57#include <chrono>
58#include <cstdint>
59
64namespace StormByte {
69 namespace Multimedia {
74 namespace Pipeline {
90
94 enum class ActivityRole: std::uint8_t {
97 };
98
111 std::uint64_t Id = 0;
112 std::uint64_t Generation = 0;
114 int Track = -1;
115 bool Available = false;
117 std::chrono::nanoseconds StartedAt{};
118 std::chrono::nanoseconds SampledAt{};
119 std::chrono::nanoseconds FinishedAt{};
120 std::chrono::nanoseconds Unknown{};
121 std::chrono::nanoseconds Preparing{};
122 std::chrono::nanoseconds Processing{};
123 std::chrono::nanoseconds WaitingInput{};
124 std::chrono::nanoseconds WaitingOutput{};
125 std::chrono::nanoseconds WaitingBudget{};
126 std::chrono::nanoseconds Paused{};
127
132 std::chrono::nanoseconds Elapsed() const noexcept { return SampledAt - StartedAt; }
133
139 bool operator==(const WorkerActivitySnapshot& other) const noexcept = default;
140 };
141 }
142 }
143}
144
146
147namespace StormByte {
148 namespace Multimedia {
149 namespace Pipeline {
166
180 public:
186 explicit WorkerActivity(ActivityRole role = ActivityRole::Main, int track = -1);
187
189
190 WorkerActivity(WorkerActivity&&) noexcept = delete;
191
195 ~WorkerActivity() noexcept;
196
197 WorkerActivity& operator=(const WorkerActivity&) = delete;
198
199 WorkerActivity& operator=(WorkerActivity&&) noexcept = delete;
200
204 void Start() noexcept;
205
212
217 void Finish(bool failed = false) noexcept;
218
224
225 private:
226 mutable StormByte::Safe::Mutex m_mutex;
227 WorkerActivitySnapshot m_value;
228 std::chrono::nanoseconds m_changed{};
229 };
230 }
231 }
232}
233
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Provider-owned clock for one execution thread.
Definition activity.hxx:179
WorkerActivity(const WorkerActivity &)=delete
void Finish(bool failed=false) noexcept
Freeze this generation once; subsequent transitions have no effect.
void Start() noexcept
Begin a generation in Preparing, or leave a running generation unchanged.
ActivityState Exchange(ActivityState state) noexcept
Close the current interval and open a nonterminal category.
WorkerActivitySnapshot Snapshot() const noexcept
Copy state, totals and reference tick under the same short lock.
WorkerActivity(WorkerActivity &&) noexcept=delete
WorkerActivity(ActivityRole role=ActivityRole::Main, int track=-1)
Construct an unstarted worker clock.
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Demux / decode / filter / encode / mux types.
ActivityState
Exclusive wall-clock activity of one instrumented worker, not CPU use.
Definition activity.hxx:79
@ WaitingBudget
Waiting for admission to the shared byte budget.
Definition activity.hxx:85
@ Processing
Executing Process, excluding instrumented waits.
Definition activity.hxx:82
@ Unknown
Unclassified worker administration or unsupported wait.
Definition activity.hxx:80
@ Finished
Execution ended, including cancellation.
Definition activity.hxx:87
@ WaitingInput
Waiting for upstream data or readiness.
Definition activity.hxx:83
@ Preparing
Executing Setup, excluding instrumented waits.
Definition activity.hxx:81
@ WaitingOutput
Waiting for downstream local capacity or pending output to drain.
Definition activity.hxx:84
@ Failed
Execution ended with a stage failure.
Definition activity.hxx:88
@ Paused
Actually blocked by a cooperative pause.
Definition activity.hxx:86
ActivityRole
Concurrent execution domains; codec-internal threads are not observed.
Definition activity.hxx:94
@ Main
Stage's pumper thread.
Definition activity.hxx:95
@ DemuxFeeder
Independent per-track demux output thread.
Definition activity.hxx:96
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
Activity coverage and independent workers of a stage.
Definition activity.hxx:159
bool Complete
False when a worker registration was lost.
Definition activity.hxx:161
bool InternalWorkersObserved
Codec, filter-helper and I/O service threads are outside coverage.
Definition activity.hxx:163
StormByte::Safe::Vector< WorkerActivitySnapshot > Workers
Separate domains, never an exclusive aggregate.
Definition activity.hxx:164
bool Available
At least one instrumented execution started.
Definition activity.hxx:160
bool WaitReasons
Local capacity and shared budget waits are distinguished.
Definition activity.hxx:162
Coherent, allocation-free value for one worker execution.
Definition activity.hxx:110
std::uint64_t Generation
Increments on each new execution.
Definition activity.hxx:112
std::chrono::nanoseconds Paused
Cooperative pause waits.
Definition activity.hxx:126
ActivityRole Role
Execution domain.
Definition activity.hxx:113
ActivityState State
State at SampledAt.
Definition activity.hxx:116
std::chrono::nanoseconds WaitingInput
Upstream waits.
Definition activity.hxx:123
int Track
Source track for a demux feeder; -1 for the main worker.
Definition activity.hxx:114
std::chrono::nanoseconds FinishedAt
Termination tick; zero while live.
Definition activity.hxx:119
bool Available
False until this execution starts.
Definition activity.hxx:115
std::chrono::nanoseconds StartedAt
Beginning of this generation.
Definition activity.hxx:117
std::uint64_t Id
Process-unique worker identity.
Definition activity.hxx:111
std::chrono::nanoseconds WaitingOutput
Local downstream waits.
Definition activity.hxx:124
std::chrono::nanoseconds SampledAt
Coherent reference tick, frozen at termination.
Definition activity.hxx:118
std::chrono::nanoseconds Elapsed() const noexcept
Observed lifetime of this execution, frozen on termination.
Definition activity.hxx:132
std::chrono::nanoseconds Preparing
Setup wall time.
Definition activity.hxx:121
std::chrono::nanoseconds WaitingBudget
Aggregate budget waits.
Definition activity.hxx:125
std::chrono::nanoseconds Processing
Process wall time minus instrumented waits.
Definition activity.hxx:122
bool operator==(const WorkerActivitySnapshot &other) const noexcept=default
Compare complete samples, including identities and reference ticks.
std::chrono::nanoseconds Unknown
Unclassified wall time.
Definition activity.hxx:120
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61