StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
AVPacket.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
55
56#include <cstdint>
57
66 class FFmpeg;
67}
68
77 class Packet;
78}
79
84namespace StormByte {
89 namespace Multimedia {
94 namespace FFmpeg {
98 class AVBSF;
99
103 class AVDecoder;
104
108 class AVEncoder;
109
113 class AVFormatContext;
114
127 public:
131 AVPacket() noexcept;
132
139 AVPacket(const AVPacket& other) noexcept;
140
145 AVPacket(AVPacket&& other) noexcept = default;
146
150 ~AVPacket() noexcept override;
151
157 AVPacket& operator=(const AVPacket& other) noexcept;
158
164 AVPacket& operator=(AVPacket&& other) noexcept = default;
165
172 FFmpeg::AVPacket Ref() const noexcept;
173
177 void Unref() noexcept;
178
187 bool Load(const std::uint8_t* data, int size, int stream_index, bool key_frame) noexcept;
188
195 void Timestamps(std::int64_t pts, std::int64_t dts, std::int64_t duration) noexcept;
196
201 int StreamIndex() const noexcept;
202
207 std::int64_t Pts() const noexcept;
208
213 std::int64_t Dts() const noexcept;
214
219 std::int64_t Duration() const noexcept;
220
225 int Flags() const noexcept;
226
231 const std::uint8_t* Data() const noexcept;
232
237 int Size() const noexcept;
238
243 std::int64_t Position() const noexcept;
244
249 explicit operator bool() const noexcept;
250
255 int SideDataCount() const noexcept;
256
262 int SideDataType(int index) const noexcept;
263
270 const std::uint8_t* SideData(int index, int& size) const noexcept;
271
276 void Reset(::AVPacket* raw) noexcept;
277
278 private:
282 friend class AVBSF;
283
287 friend class AVDecoder;
288
292 friend class AVEncoder;
293
297 friend class AVFormatContext;
298
303
307 friend class StormByte::Multimedia::Pipeline::Filter::FFmpeg;
308
313 ::AVPacket* Detach() noexcept;
314
318 void Free() noexcept override;
319
323 using AVPointer<::AVPacket>::Get;
324
328 using AVPointer<::AVPacket>::Detach;
329 };
330
332
335 extern template class STORMBYTE_MULTIMEDIA_PUBLIC AVPointer<::AVPacket>;
337 }
338 }
339}
340
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
int Size() const noexcept
Compressed payload size in bytes.
std::int64_t Duration() const noexcept
Packet duration in stream time base.
const std::uint8_t * SideData(int index, int &size) const noexcept
Side-data payload at index.
void Reset(::AVPacket *raw) noexcept
Adopts raw.
std::int64_t Pts() const noexcept
Presentation timestamp in stream time base.
const std::uint8_t * Data() const noexcept
Compressed payload pointer.
friend class AVBSF
Allows bitstream filters to access the raw packet.
Definition AVPacket.hxx:282
int StreamIndex() const noexcept
Packet stream index.
friend class AVFormatContext
Allows the format context to access the raw packet.
Definition AVPacket.hxx:297
int Flags() const noexcept
Packet flags (AV_PKT_FLAG_*).
void Timestamps(std::int64_t pts, std::int64_t dts, std::int64_t duration) noexcept
Sets timestamps in stream time base.
friend class AVEncoder
Allows the encoder to access the raw packet.
Definition AVPacket.hxx:292
std::int64_t Dts() const noexcept
Decode timestamp in stream time base.
bool Load(const std::uint8_t *data, int size, int stream_index, bool key_frame) noexcept
Replaces payload for avcodec_send_packet.
int SideDataType(int index) const noexcept
Side-data type at index.
friend class StormByte::Multimedia::Backend::Pipeline::Packet
Allows the backend packet holder to access the raw packet.
Definition AVPacket.hxx:302
friend class AVDecoder
Allows the decoder to access the raw packet.
Definition AVPacket.hxx:287
friend class StormByte::Multimedia::Pipeline::Filter::FFmpeg
Allows the filter base to access the raw packet.
Definition AVPacket.hxx:307
FFmpeg::AVPacket Ref() const noexcept
New packet referencing the same data (av_packet_ref).
AVPacket() noexcept
Allocates an empty packet.
void Unref() noexcept
Unreferences packet data (av_packet_unref).
std::int64_t Position() const noexcept
Byte position of this packet in its input source.
int SideDataCount() const noexcept
Number of side-data entries.
constexpr const std::decay_t< ::AVPacket > * Get() const noexcept
Definition AVPointer.hxx:151
Abstract base for every StormByte Multimedia filter.
Definition ffmpeg.hxx:261
Incomplete FFmpeg types for RAII headers.
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Multimedia-owned pipeline stages and unit holders.
Private RAII wrappers over libav*.
Frame and packet steps attached to a job or a raw pipeline.
@ Packet
Packet filter (Filter::Packet and derived).
Definition telemetry.hxx:409
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61