1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
// =============================================================================
// Copyright (c) 2026 Haixing Hu.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0.
// =============================================================================
use core::num::NonZeroUsize;
use super::TranscodeStatus;
/// Counts how much work a [`crate::Transcoder`] completed before
/// returning.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct TranscodeProgress {
/// Stop reason reported by the transcoder.
status: TranscodeStatus,
/// Number of input units consumed from the requested input index.
read: usize,
/// Number of output units written from the requested output index.
written: usize,
}
impl TranscodeProgress {
/// Creates a progress value.
///
/// # Parameters
///
/// - `status`: The reason conversion stopped.
/// - `read`: Number of input units consumed from the call's input index.
/// - `written`: Number of output units written from the call's output
/// index.
///
/// # Returns
///
/// Returns a progress value carrying the supplied counters.
#[must_use]
#[inline(always)]
pub const fn new(
status: TranscodeStatus,
read: usize,
written: usize,
) -> Self {
Self {
status,
read,
written,
}
}
/// Creates a completed progress value.
///
/// # Parameters
///
/// - `read`: Number of consumed input units.
/// - `written`: Number of produced output units.
///
/// # Returns
///
/// Returns a progress value whose status is [`TranscodeStatus::Complete`].
#[must_use]
#[inline(always)]
pub const fn complete(read: usize, written: usize) -> Self {
Self::new(TranscodeStatus::Complete, read, written)
}
/// Creates progress that stopped because more input is needed.
///
/// # Parameters
///
/// - `input_index`: Absolute input boundary where conversion stopped.
/// - `additional`: Additional input units required to continue.
/// - `available`: Input units currently available at the boundary.
/// - `read`: Number of consumed input units.
/// - `written`: Number of produced output units.
///
/// # Returns
///
/// Returns a progress value with [`TranscodeStatus::NeedInput`].
#[must_use]
#[inline(always)]
pub const fn need_input(
input_index: usize,
additional: NonZeroUsize,
available: usize,
read: usize,
written: usize,
) -> Self {
Self::new(
TranscodeStatus::need_input(input_index, additional, available),
read,
written,
)
}
/// Creates progress that stopped because more output capacity is needed.
///
/// # Parameters
///
/// - `output_index`: Absolute output boundary where conversion stopped.
/// - `additional`: Additional output units required to continue.
/// - `available`: Output units currently available at the boundary.
/// - `read`: Number of consumed input units.
/// - `written`: Number of produced output units.
///
/// # Returns
///
/// Returns a progress value with [`TranscodeStatus::NeedOutput`].
#[must_use]
#[inline(always)]
pub const fn need_output(
output_index: usize,
additional: NonZeroUsize,
available: usize,
read: usize,
written: usize,
) -> Self {
Self::new(
TranscodeStatus::need_output(output_index, additional, available),
read,
written,
)
}
/// Returns the status that stopped conversion.
///
/// # Returns
///
/// Returns the stored [`TranscodeStatus`].
#[must_use]
#[inline(always)]
pub const fn status(self) -> TranscodeStatus {
self.status
}
/// Returns whether conversion consumed all currently supplied input.
///
/// # Returns
///
/// Returns `true` when the stored status is
/// [`TranscodeStatus::Complete`].
#[must_use]
#[inline(always)]
pub const fn is_complete(self) -> bool {
matches!(self.status, TranscodeStatus::Complete)
}
/// Returns whether conversion stopped because more input is needed.
///
/// # Returns
///
/// Returns `true` when the stored status is
/// [`TranscodeStatus::NeedInput`].
#[must_use]
#[inline(always)]
pub const fn is_need_input(self) -> bool {
matches!(self.status, TranscodeStatus::NeedInput { .. })
}
/// Returns whether conversion stopped because more output capacity is
/// needed.
///
/// # Returns
///
/// Returns `true` when the stored status is
/// [`TranscodeStatus::NeedOutput`].
#[must_use]
#[inline(always)]
pub const fn is_need_output(self) -> bool {
matches!(self.status, TranscodeStatus::NeedOutput { .. })
}
/// Returns the number of input units consumed by the call.
///
/// # Returns
///
/// Returns a count relative to the input index passed to the conversion
/// call.
#[must_use]
#[inline(always)]
pub const fn read(self) -> usize {
self.read
}
/// Returns the number of output units written by the call.
///
/// # Returns
///
/// Returns a count relative to the output index passed to the conversion
/// call.
#[must_use]
#[inline(always)]
pub const fn written(self) -> usize {
self.written
}
}