StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
file.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#include <StormByte/safe/optional.hxx>
56#include <StormByte/safe/string.hxx>
57#include <StormByte/safe/vector.hxx>
58
59#include <chrono>
60
65namespace StormByte {
70 namespace Multimedia {
75 class File;
76
81 namespace Detail {
86 class Probe;
87 }
88
93 namespace Metadata {
99 std::chrono::nanoseconds Start{0};
100 std::chrono::nanoseconds End{0};
102 };
103 }
104 }
105}
106
108
109namespace StormByte {
110 namespace Multimedia {
111 namespace Metadata {
112
121 public:
126 File(const File& other);
127
132 File(File&& other) noexcept;
133
137 ~File() noexcept;
138
144 File& operator=(const File& other);
145
151 File& operator=(File&& other) noexcept;
152
157 const Safe::Optional<Safe::String>& Title() const noexcept;
158
163 const Safe::Optional<Safe::String>& Artist() const noexcept;
164
169 const Safe::Optional<Safe::String>& Album() const noexcept;
170
175 const Safe::Optional<Safe::String>& AlbumArtist() const noexcept;
176
181 const Safe::Optional<Safe::String>& Composer() const noexcept;
182
187 const Safe::Optional<Safe::String>& Genre() const noexcept;
188
193 const Safe::Optional<Safe::String>& Comment() const noexcept;
194
199 const Safe::Optional<Safe::String>& Copyright() const noexcept;
200
205 const Safe::Optional<Safe::String>& Encoder() const noexcept;
206
211 const Safe::Optional<Safe::String>& Date() const noexcept;
212
217 Safe::Optional<unsigned> Track() const;
218
223 Safe::Optional<unsigned> Disc() const;
224
230 Safe::Optional<Safe::String> Tag(FileTag tag) const;
231
236 const Safe::Vector<Chapter>& Chapters() const noexcept;
237
245 std::chrono::nanoseconds StartTime() const noexcept;
246
247 private:
251 friend class StormByte::Multimedia::File;
252
257
258 Safe::Optional<Safe::String> m_title;
259 Safe::Optional<Safe::String> m_artist;
260 Safe::Optional<Safe::String> m_album;
261 Safe::Optional<Safe::String> m_albumArtist;
262 Safe::Optional<Safe::String> m_composer;
263 Safe::Optional<Safe::String> m_genre;
264 Safe::Optional<Safe::String> m_comment;
265 Safe::Optional<Safe::String> m_copyright;
266 Safe::Optional<Safe::String> m_encoder;
267 Safe::Optional<Safe::String> m_date;
268 Safe::Optional<unsigned> m_track;
269 Safe::Optional<unsigned> m_disc;
270 Safe::Vector<Chapter> m_chapters;
271 std::chrono::nanoseconds m_startTime{0};
272
276 File();
277
282 void Title(Safe::String title);
283
288 void Artist(Safe::String artist);
289
294 void Album(Safe::String album);
295
300 void AlbumArtist(Safe::String albumArtist);
301
306 void Composer(Safe::String composer);
307
312 void Genre(Safe::String genre);
313
318 void Comment(Safe::String comment);
319
324 void Copyright(Safe::String copyright);
325
330 void Encoder(Safe::String encoder);
331
336 void Date(Safe::String date);
337
342 void Track(unsigned track);
343
348 void Disc(unsigned disc);
349
354 void Chapters(Safe::Vector<Chapter> chapters);
355
360 void StartTime(std::chrono::nanoseconds start) noexcept;
361 };
362 }
363 }
364}
365
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Private metadata probe.
Read-only consultation snapshot of a media source.
Definition file.hxx:135
File tags and header fields captured at Open.
Definition file.hxx:120
const Safe::Optional< Safe::String > & Artist() const noexcept
Main artist.
const Safe::Vector< Chapter > & Chapters() const noexcept
Chapter list in source order.
friend class StormByte::Multimedia::Detail::Probe
Private metadata probe.
Definition file.hxx:256
Safe::Optional< unsigned > Disc() const
Disc number.
const Safe::Optional< Safe::String > & Date() const noexcept
Date / year tag.
std::chrono::nanoseconds StartTime() const noexcept
Start of the source timeline.
Safe::Optional< Safe::String > Tag(FileTag tag) const
One file tag as text, for generic tag editors.
friend class StormByte::Multimedia::File
Public media file snapshot.
Definition file.hxx:251
const Safe::Optional< Safe::String > & Genre() const noexcept
Genre.
const Safe::Optional< Safe::String > & Encoder() const noexcept
Encoder identification.
const Safe::Optional< Safe::String > & AlbumArtist() const noexcept
Album artist if different from Artist.
File(const File &other)
Copy constructor.
const Safe::Optional< Safe::String > & Album() const noexcept
Album / set name.
const Safe::Optional< Safe::String > & Copyright() const noexcept
Copyright notice.
const Safe::Optional< Safe::String > & Title() const noexcept
Work title.
const Safe::Optional< Safe::String > & Comment() const noexcept
Comment.
File(File &&other) noexcept
Move constructor.
const Safe::Optional< Safe::String > & Composer() const noexcept
Composer.
Safe::Optional< unsigned > Track() const
Track number.
Multimedia module of the StormByte suite.
Snapshot metadata for files and streams.
@ Comment
Commentary.
Definition stream.hxx:114
FileTag
File-level tag that a job can keep, replace or remove.
Definition tag.hxx:75
@ Artist
Main artist.
Definition tag.hxx:77
@ Date
Date or year.
Definition tag.hxx:84
@ Copyright
Copyright notice.
Definition tag.hxx:83
@ Genre
Genre.
Definition tag.hxx:81
@ Track
Track number.
Definition tag.hxx:85
@ AlbumArtist
Album artist.
Definition tag.hxx:79
@ Disc
Disc number.
Definition tag.hxx:86
@ Title
Work title.
Definition tag.hxx:76
@ Composer
Composer.
Definition tag.hxx:80
@ Album
Album or set name.
Definition tag.hxx:78
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
One container chapter captured at Open.
Definition file.hxx:98
Safe::Optional< Safe::String > Title
Chapter title, or empty.
Definition file.hxx:101
std::chrono::nanoseconds Start
Chapter start on the source timeline.
Definition file.hxx:99
std::chrono::nanoseconds End
Chapter end on the source timeline.
Definition file.hxx:100
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61