StormByte C++ Library: Multimedia module 0.0.9999
StormByte-Multimedia is a StormByte library module for parsing configuration files
Loading...
Searching...
No Matches
typedefs.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 * Neither license grants any patent rights. Any patent licenses required
24 * to use this software or third-party components must be obtained separately
25 * from the patent holders.
26 *
27 * StormByte-Multimedia is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU Lesser General Public License for more details.
31 *
32 * You should have received a copy of the GNU Lesser General Public License
33 * version 3 along with StormByte-Multimedia. If not, see
34 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
35 *
36 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
37 */
38
39#pragma once
40
41#include <StormByte/expected.hxx>
43
44#include <functional>
45#include <memory>
46#include <vector>
47
52namespace StormByte::Multimedia {
53 class Codec;
54 class Container;
55 class File;
56 class Stream;
57
64 namespace Pipeline {
65 class Transcoder;
66 }
67
68 using ExpectedCodec = StormByte::Expected<const Codec&, CodecNotFoundException>;
69 using ExpectedContainer = StormByte::Expected<const Container&, ContainerNotFoundException>;
70 using ExpectedFile = StormByte::Expected<File, FileOpenException>;
71 using ExpectedTranscoder = StormByte::Expected<std::unique_ptr<Pipeline::Transcoder>, TranscodeException>;
72 using CodecRefs = std::vector<std::reference_wrapper<const Codec>>;
73 using ContainerRefs = std::vector<std::reference_wrapper<const Container>>;
74 using Streams = std::vector<Stream>;
75}
Thrown when Transcode::Open or a configuration call fails.
Definition exception.hxx:177
Public multimedia types: codecs, containers, streams and files.
StormByte::Expected< std::unique_ptr< Pipeline::Transcoder >, TranscodeException > ExpectedTranscoder
Result of Transcoder::Open.
Definition typedefs.hxx:71
std::vector< std::reference_wrapper< const Container > > ContainerRefs
List of container references.
Definition typedefs.hxx:73
StormByte::Expected< const Codec &, CodecNotFoundException > ExpectedCodec
Result of FindCodec.
Definition typedefs.hxx:68
std::vector< Stream > Streams
Ordered streams.
Definition typedefs.hxx:74
StormByte::Expected< const Container &, ContainerNotFoundException > ExpectedContainer
Result of FindContainer.
Definition typedefs.hxx:69
std::vector< std::reference_wrapper< const Codec > > CodecRefs
List of codec references.
Definition typedefs.hxx:72
StormByte::Expected< File, FileOpenException > ExpectedFile
Result of OpenFile.
Definition typedefs.hxx:70