summaryrefslogtreecommitdiffstats
path: root/src/multimedia/qmediaformat.cpp
blob: 0a5e9a27f754b9c09e0bf4b5d2cc1d3729c2f690 (plain)
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmediaformat.h"
#include "private/qmediaplatformintegration_p.h"
#include "private/qmediaplatformformatinfo_p.h"

QT_BEGIN_NAMESPACE

namespace {

// info from https://en.wikipedia.org/wiki/Comparison_of_video_container_formats
constexpr bool audioSupportMatrix[QMediaFormat::FileFormat::LastFileFormat + 1][(int)QMediaFormat::AudioCodec::LastAudioCodec + 1] =
{
    //  MP3,   AAC,   AC3, EAC3,   FLAC,  DTHD,  Opus,Vorbis,  Wave, WMA
        // Container formats (Audio and Video)
    {  true,  true,  true,  true,  true, false,  true, false, false, true }, // ASF
    {  true,  true,  true, false,  true, false,  true, false, false,  true }, // AVI,
    {  true,  true,  true,  true,  true,  true,  true,  true, false,  true }, // Matroska,
    {  true,  true,  true,  true,  true,  true,  true, false, false,  true }, // MPEG4,
    { false, false, false, false,  true, false,  true,  true, false, false }, // Ogg,
    {  true,  true,  true,  true, false, false, false, false, false, false }, // QuickTime,
    { false, false, false, false,  true, false,  true,  true, false, false }, // WebM,
        // Audio Formats
    { false,  true, false, false, false, false, false, false, false, false }, // AAC,
    { false, false, false, false,  true, false, false, false, false, false }, // FLAC,
    {  true, false, false, false, false, false, false, false, false, false }, // Mpeg3,
    {  true,  true,  true,  true,  true,  true,  true, false, false,  true }, // Mpeg4Audio,
    { false, false, false, false, false, false,  true, false, false, false }, // Opus,
    { false, false, false, false, false, false, false, false,  true, false }, // Wave,
    { false, false, false, false, false, false, false, false, false,  true }, // WindowsMediaAudio
};

inline bool formatSupportsCodec(QMediaFormat::FileFormat format, QMediaFormat::AudioCodec codec)
{
    return audioSupportMatrix[format][(int)codec];
}

// info from https://en.wikipedia.org/wiki/Comparison_of_video_container_formats
constexpr bool videoSupportMatrix[QMediaFormat::FileFormat::LastFileFormat + 1][(int)QMediaFormat::VideoCodec::LastVideoCodec + 1] =
{
    //MPEG1, MPEG2, MPEG4,  H264,  H265,   VP8,   VP9,   AV1,Theora, MotionJPEG,
        // Container formats (Audio and Video)
    {  true,  true,  true,  true,  true, false, false, false, false,false }, // ASF
    {  true,  true,  true,  true,  true,  true,  true, false,  true,  true }, // AVI,
    {  true,  true,  true,  true,  true,  true,  true,  true,  true, false }, // Matroska,
    {  true,  true,  true,  true,  true,  true,  true,  true,  true,  true }, // MPEG4,
    { false,  true,  true,  true,  true, false, false, false, false,  true }, // Ogg,
    { false, false, false, false, false, false, false, false,  true, false }, // QuickTime,
    { false, false, false, false, false,  true,  true,  true, false, false }, // WebM,
        // Audio Formats
    { false, false, false, false, false, false, false, false, false, false }, // AAC,
    { false, false, false, false, false, false, false, false, false, false }, // FLAC,
    { false, false, false, false, false, false, false, false, false, false }, // Mpeg3,
    { false, false, false, false, false, false, false, false, false, false }, // Mpeg4Audio,
    { false, false, false, false, false, false, false, false, false, false }, // Opus,
    { false, false, false, false, false, false, false, false, false, false }, // Wave,
    { false, false, false, false, false, false, false, false, false, false }, // WindowsMediaAudio
};

inline bool formatSupportsCodec(QMediaFormat::FileFormat format, QMediaFormat::VideoCodec codec)
{
    return videoSupportMatrix[format][(int)codec];
}


constexpr QMediaFormat::FileFormat videoFormatPriorityList[] =
{
    QMediaFormat::MPEG4,
    QMediaFormat::QuickTime,
    QMediaFormat::AVI,
    QMediaFormat::WebM,
    QMediaFormat::ASF,
    QMediaFormat::Matroska,
    QMediaFormat::Ogg,
    QMediaFormat::UnspecifiedFormat
};

constexpr QMediaFormat::FileFormat audioFormatPriorityList[] =
{
    QMediaFormat::AAC,
    QMediaFormat::MP3,
    QMediaFormat::Mpeg4Audio,
    QMediaFormat::Opus,
    QMediaFormat::FLAC,
    QMediaFormat::WindowsMediaAudio,
    QMediaFormat::Wave,
    QMediaFormat::UnspecifiedFormat
};

constexpr QMediaFormat::AudioCodec audioPriorityList[] =
{
    QMediaFormat::AudioCodec::AAC,
    QMediaFormat::AudioCodec::MP3,
    QMediaFormat::AudioCodec::AC3,
    QMediaFormat::AudioCodec::Opus,
    QMediaFormat::AudioCodec::EAC3,
    QMediaFormat::AudioCodec::DolbyTrueHD,
    QMediaFormat::AudioCodec::WindowsMediaAudio,
    QMediaFormat::AudioCodec::FLAC,
    QMediaFormat::AudioCodec::Vorbis,
    QMediaFormat::AudioCodec::Wave,
    QMediaFormat::AudioCodec::Unspecified
};

constexpr QMediaFormat::VideoCodec videoPriorityList[] =
{
    QMediaFormat::VideoCodec::H265,
    QMediaFormat::VideoCodec::VP9,
    QMediaFormat::VideoCodec::H264,
    QMediaFormat::VideoCodec::AV1,
    QMediaFormat::VideoCodec::VP8,
    QMediaFormat::VideoCodec::Theora,
    QMediaFormat::VideoCodec::MPEG4,
    QMediaFormat::VideoCodec::MPEG2,
    QMediaFormat::VideoCodec::MPEG1,
    QMediaFormat::VideoCodec::MotionJPEG,
};

}

void QMediaFormatPrivate::resolveForEncoding(QMediaFormat *f, bool audioOnly)
{
    auto supportedFormats = QMediaEncoderInfo::supportedFileFormats();
    auto supportedAudioCodecs = QMediaEncoderInfo::supportedAudioCodecs();
    auto supportedVideoCodecs = QMediaEncoderInfo::supportedVideoCodecs();

    auto bestSupportedFileFormat = [&](QMediaFormat::AudioCodec audio = QMediaFormat::AudioCodec::Unspecified,
                                       QMediaFormat::VideoCodec video = QMediaFormat::VideoCodec::Unspecified)
    {
        auto *list = audioOnly ? audioFormatPriorityList : videoFormatPriorityList;
        while (*list != QMediaFormat::UnspecifiedFormat) {
            if (supportedFormats.contains(*list)) {
                if ((audio == QMediaFormat::AudioCodec::Unspecified || formatSupportsCodec(f->fmt, audio)) &&
                    (video == QMediaFormat::VideoCodec::Unspecified || formatSupportsCodec(f->fmt, video)))
                    break;
            }
            ++list;
        }
        return *list;
    };

    // reset non supported formats and codecs
    if (!supportedFormats.contains(f->fmt))
        f->fmt = QMediaFormat::UnspecifiedFormat;
    if (!supportedAudioCodecs.contains(f->audio))
        f->audio = QMediaFormat::AudioCodec::Unspecified;
    if (audioOnly || !supportedVideoCodecs.contains(f->video))
        f->video = QMediaFormat::VideoCodec::Unspecified;

    // try finding a file format that is supported
    if (f->fmt == QMediaFormat::UnspecifiedFormat)
        f->fmt = bestSupportedFileFormat(f->audio, f->video);
    // try without the audio codec
    if (f->fmt == QMediaFormat::UnspecifiedFormat)
        f->fmt = bestSupportedFileFormat(QMediaFormat::AudioCodec::Unspecified, f->video);
    // try without the video codec
    if (f->fmt == QMediaFormat::UnspecifiedFormat)
        f->fmt = bestSupportedFileFormat(f->audio);
    // give me a format that's supported
    if (f->fmt == QMediaFormat::UnspecifiedFormat)
        f->fmt = bestSupportedFileFormat();
    // still nothing? Give up
    if (f->fmt == QMediaFormat::UnspecifiedFormat)
        return;

    // now that we have a format, reset codecs that won't work
    if (f->audio != QMediaFormat::AudioCodec::Unspecified) {
        if (!formatSupportsCodec(f->fmt, f->audio) || !supportedAudioCodecs.contains(f->audio))
            f->audio = QMediaFormat::AudioCodec::Unspecified;
    }
    if (f->video != QMediaFormat::VideoCodec::Unspecified) {
        if (!formatSupportsCodec(f->fmt, f->video) || !supportedVideoCodecs.contains(f->video))
            f->video = QMediaFormat::VideoCodec::Unspecified;
    }

    // find a matching audio format
    if (f->audio == QMediaFormat::AudioCodec::Unspecified) {
        auto *list = audioPriorityList;
        while (*list != QMediaFormat::AudioCodec::Unspecified) {
            if (supportedAudioCodecs.contains(*list) && formatSupportsCodec(f->fmt, *list))
                break;
            ++list;
        }
        f->audio = *list;
    }

    // find a matching video format
    if (!audioOnly && f->video == QMediaFormat::VideoCodec::Unspecified) {
        auto *list = videoPriorityList;
        while (*list != QMediaFormat::VideoCodec::Unspecified) {
            if (supportedVideoCodecs.contains(*list) && formatSupportsCodec(f->fmt, *list))
                break;
            ++list;
        }
        f->video = *list;
    }
}

/*! \enum QMediaFormat::FileFormat

    Describes the container format used in a multimedia file or stream.
*/

/*! \enum QMediaFormat::AudioCodec

    Describes the audio coded used in multimedia file or stream.
*/

/*! \enum QMediaFormat::AudioCodec

    Describes the video coded used in multimedia file or stream.
*/

/*! \class QMediaFormat

    Describes an encoding format for a multimedia file or stream.

    You can check whether a certain QMediaFormat can be used for encoding
    or decoding using QMediaDecoderInfo or QMediaEncoderInfo.
*/

// these are non inline to make a possible future addition of a d pointer binary compatible
QMediaFormat::QMediaFormat(FileFormat format)
    : fmt(format)
{
    Q_UNUSED(d);
}

QMediaFormat::~QMediaFormat() = default;
QMediaFormat::QMediaFormat(const QMediaFormat &other) = default;
QMediaFormat &QMediaFormat::operator=(const QMediaFormat &other) = default;


/*! \fn void QMediaFormat::setMediaContainer(QMediaFormat::FileFormat container)

    Sets the container to \a container.

    \sa mediaContainer(), QMediaFormat::FileFormat
*/

/*! \fn QMediaFormat::FileFormat QMediaFormat::mediaContainer() const

    Returns the container used in this format.

    \sa setMediaContainer(), QMediaFormat::FileFormat
*/

/*! \fn void QMediaFormat::setVideoCodec(VideoCodec codec)

    Sets the video codec to \a codec.

    \sa videoCodec(), QMediaFormat::VideoCodec
*/
bool QMediaFormat::setVideoCodec(VideoCodec codec)
{
    if (!videoSupportMatrix[fmt][(int)codec])
        return false;
    video = codec;
    return true;
}

/*! \fn QMediaFormat::VideoCodec QMediaFormat::videoCodec() const

    Returns the video codec used in this format.

    \sa setVideoCodec(), QMediaFormat::VideoCodec
*/

/*! \fn void QMediaFormat::setAudioCodec(AudioCodec codec)

    Sets the audio codec to \a codec.

    \sa audioCodec(), QMediaFormat::AudioCodec
*/
bool QMediaFormat::setAudioCodec(QMediaFormat::AudioCodec codec)
{
    if (!audioSupportMatrix[fmt][(int)codec])
        return false;
    audio = codec;
    return true;
}

/*! \fn QMediaFormat::AudioCodec QMediaFormat::audioCodec() const

    Returns the audio codec used in this format.

    \sa setAudioCodec(), QMediaFormat::AudioCodec
*/

/*! \fn bool QMediaFormat::isValid() const

    Returns true if the format is valid.
*/

/*!
    Returns true if Qt Multimedia can decode this format.

    \sa QMediaDecoderInfo
 */
bool QMediaFormat::canDecode() const
{
    if (!QMediaDecoderInfo::supportedFileFormats().contains(fmt))
        return false;
    if (audio == QMediaFormat::AudioCodec::Unspecified && video == QMediaFormat::VideoCodec::Unspecified)
        return false;
    if (audio != QMediaFormat::AudioCodec::Unspecified) {
        if (!QMediaDecoderInfo::supportedAudioCodecs().contains(audio))
            return false;
    }
    if (video != QMediaFormat::VideoCodec::Unspecified) {
        if (!QMediaDecoderInfo::supportedVideoCodecs().contains(video))
            return false;
    }
    return true;
}

/*!
    Returns true if Qt Multimedia can encode this format.

    \sa QMediaEncoderInfo
*/
bool QMediaFormat::canEncode() const
{
    if (!QMediaEncoderInfo::supportedFileFormats().contains(fmt))
        return false;
    if (audio == QMediaFormat::AudioCodec::Unspecified && video == QMediaFormat::VideoCodec::Unspecified)
        return false;
    if (audio != QMediaFormat::AudioCodec::Unspecified) {
        if (!QMediaEncoderInfo::supportedAudioCodecs().contains(audio))
            return false;
    }
    if (video != QMediaFormat::VideoCodec::Unspecified) {
        if (!QMediaEncoderInfo::supportedVideoCodecs().contains(video))
            return false;
    }
    return true;
}

/*!
    Returns true if is is an audio-only file format.
 */
bool QMediaFormat::isAudioFormat() const
{
    return fmt >= AAC;
}

QString QMediaFormat::fileFormatName(QMediaFormat::FileFormat c)
{
    constexpr const char *descriptions[] = {
        "ASF",
        "AVI",
        "Matroska",
        "MPEG-4",
        "Ogg",
        "QuickTime",
        "WebM",
        // Audio Formats
        "AAC",
        "FLAC",
        "MP3",
        "MPEG-4 Audio",
        "Opus",
        "Wave",
        "Windows Media Audio",
    };
    return QString::fromUtf8(descriptions[int(c)]);
}

QString QMediaFormat::audioCodecName(QMediaFormat::AudioCodec c)
{
    constexpr const char *descriptions[] = {
        "Invalid",
        "MP3",
        "AAC",
        "AC3",
        "EAC3",
        "FLAC",
        "DolbyTrueHD",
        "Opus",
        "Vorbis",
        "Wave",
        "WindowsMediaAudio",
    };
    return QString::fromUtf8(descriptions[int(c) + 1]);
}

QString QMediaFormat::videoCodecName(QMediaFormat::VideoCodec c)
{
    constexpr const char *descriptions[] = {
        "Invalid",
        "MPEG1",
        "MPEG2",
        "MPEG4",
        "H264",
        "H265",
        "VP8",
        "VP9",
        "AV1",
        "Theora",
        "MotionJPEG"
    };
    return QString::fromUtf8(descriptions[int(c) + 1]);
}

QString QMediaFormat::fileFormatDescription(QMediaFormat::FileFormat c)
{
    constexpr const char *descriptions[] = {
        "Unspecified File Format",
        "Windows Media Format (ASF)",
        "Audio Video Interleave (AVI)",
        "Matroska Multimedia Container",
        "MPEG-4 Video Container",
        "Ogg",
        "QuickTime Container",
        "WebM",
        // Audio Formats
        "Advanced Audio Codec (AAC)",
        "Free Lossless Audio Codec (FLAC)",
        "MP3",
        "MPEG-4 Audio Container",
        "Opus Audio Encoding",
        "Wave File",
        "Windows Media Audio",
    };
    return QString::fromUtf8(descriptions[int(c) + 1]);
}

QString QMediaFormat::audioCodecDescription(QMediaFormat::AudioCodec c)
{
    constexpr const char *descriptions[] = {
        "Unspecified Audio Codec",
        "MP3",
        "Advanced Audio Codec (AAC)",
        "Dolby Digital (AC3)",
        "Dolby Digital Plus (E-AC3)",
        "Free Lossless Audio Codec (FLAC)",
        "Dolby True HD",
        "Opus",
        "Vorbis",
        "Wave",
        "Windows Media Audio",
    };
    return QString::fromUtf8(descriptions[int(c) + 1]);
}

QString QMediaFormat::videoCodecDescription(QMediaFormat::VideoCodec c)
{
    constexpr const char *descriptions[] = {
        "Unspecified Video Codec",
        "MPEG-1 Video",
        "MPEG-2 Video",
        "MPEG-4 Video",
        "H.264",
        "H.265",
        "VP8",
        "VP9",
        "AV1",
        "Theora",
        "MotionJPEG"
    };
    return QString::fromUtf8(descriptions[int(c) + 1]);
}

/*! \class QMediaDecoderInfo

    QMediaDecoderInfo describes the media formats supported for decoding
    on the current platform.

    Qt Multimedia might be able to decode formats that are not listed
    in the QMediaFormat::FileFormat, QMediaFormat::AudioCodec and QMediaFormat::VideoCodec enums.

    \sa QMediaFormat::canDecode()
*/

/*!
    Returns a list of container formats that are supported for decoding by
    Qt Multimedia.

    This does not imply that Qt can successfully decode the media file or
    stream, as the audio or video codec used within the container might not
    be supported.
 */
QList<QMediaFormat::FileFormat> QMediaDecoderInfo::supportedFileFormats()
{
    return QMediaPlatformIntegration::instance()->formatInfo()->decodableMediaContainers();
}

/*!
    Returns a list of video codecs that are supported for decoding by
    Qt Multimedia.
 */
QList<QMediaFormat::VideoCodec> QMediaDecoderInfo::supportedVideoCodecs()
{
    return QMediaPlatformIntegration::instance()->formatInfo()->decodableVideoCodecs();
}

/*!
    Returns a list of audio codecs that are supported for decoding by
    Qt Multimedia.
 */
QList<QMediaFormat::AudioCodec> QMediaDecoderInfo::supportedAudioCodecs()
{
    return QMediaPlatformIntegration::instance()->formatInfo()->decodableAudioCodecs();
}

/*! \class QMediaEncodecInfo

    QMediaEncoderInfo describes the media formats supported for
    encoding on the current platform.

    \sa QMediaFormat::canEncode()
*/

/*!
    Returns a list of container formats that are supported for encoding by
    Qt Multimedia.
 */
QList<QMediaFormat::FileFormat> QMediaEncoderInfo::supportedFileFormats()
{
    return QMediaPlatformIntegration::instance()->formatInfo()->encodableMediaContainers();
}

/*!
    Returns a list of video codecs that are supported for encoding by
    Qt Multimedia.
 */
QList<QMediaFormat::VideoCodec> QMediaEncoderInfo::supportedVideoCodecs()
{
    return QMediaPlatformIntegration::instance()->formatInfo()->encodableVideoCodecs();
}

/*!
    Returns a list of audio codecs that are supported for encoding by
    Qt Multimedia.
 */
QList<QMediaFormat::AudioCodec> QMediaEncoderInfo::supportedAudioCodecs()
{
    return QMediaPlatformIntegration::instance()->formatInfo()->encodableAudioCodecs();
}

QT_END_NAMESPACE