Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qplatformmediaplayer_p.h
Go to the documentation of this file.
1// Copyright (C) 2021 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4//
5// W A R N I N G
6// -------------
7//
8// This file is not part of the Qt API. It exists purely as an
9// implementation detail. This header file may change from version to
10// version without notice, or even be removed.
11//
12// We mean it.
13//
14
15#ifndef QMEDIAPLAYERCONTROL_H
16#define QMEDIAPLAYERCONTROL_H
17
18#include <QtMultimedia/qaudiodevice.h>
19#include <QtMultimedia/qmediametadata.h>
20#include <QtMultimedia/qmediaplayer.h>
21#include <QtMultimedia/qmediatimerange.h>
22#include <QtMultimedia/private/qmultimediautils_p.h>
23#include <QtCore/private/qglobal_p.h>
24#include <QtCore/qobject.h>
25
26QT_BEGIN_NAMESPACE
27
28class QMediaStreamsControl;
29class QPlatformAudioOutput;
30
31class Q_MULTIMEDIA_EXPORT QPlatformMediaPlayer
32{
33public:
34 virtual ~QPlatformMediaPlayer();
35 QMediaPlayer::PlaybackState state() const { return m_state; }
36 QMediaPlayer::MediaStatus mediaStatus() const { return m_status; }
37
38 virtual qint64 duration() const = 0;
39
40 virtual qint64 position() const { return m_position; }
41 virtual void setPosition(qint64 position) = 0;
42
43 virtual float bufferProgress() const = 0;
44
45 virtual bool isAudioAvailable() const { return m_audioAvailable; }
46 virtual bool isVideoAvailable() const { return m_videoAvailable; }
47
48 virtual bool isSeekable() const { return m_seekable; }
49
50 virtual QMediaTimeRange availablePlaybackRanges() const = 0;
51
52 virtual qreal playbackRate() const = 0;
53 virtual void setPlaybackRate(qreal rate) = 0;
54
55 virtual QUrl media() const = 0;
56 virtual const QIODevice *mediaStream() const = 0;
57 virtual void setMedia(const QUrl &media, QIODevice *stream) = 0;
58
59 virtual void play() = 0;
60 virtual void pause() = 0;
61 virtual void stop() = 0;
62
63 virtual bool streamPlaybackSupported() const { return false; }
64
65 virtual void setAudioOutput(QPlatformAudioOutput *) {}
66
67 virtual void setAudioBufferOutput(QAudioBufferOutput *) { }
68
69 virtual QMediaMetaData metaData() const { return {}; }
70
71 virtual void setVideoSink(QVideoSink * /*sink*/) = 0;
72
73 virtual bool canPlayQrc() const { return false; }
74
75 // media streams
76 enum class TrackType : uint8_t {
77 VideoStream,
78 AudioStream,
79 SubtitleStream,
80 };
81 static constexpr size_t NTrackTypes = qToUnderlying(TrackType::SubtitleStream) + 1;
82
83 template <typename T>
84 using TrackTypeMap = QtMultimediaPrivate::EnumMap<TrackType, T, NTrackTypes>;
85
86 virtual int trackCount(TrackType) { return 0; }
87 virtual QMediaMetaData trackMetaData(TrackType /*type*/, int /*streamNumber*/) { return QMediaMetaData(); }
88 virtual int activeTrack(TrackType) { return -1; }
89 virtual void setActiveTrack(TrackType, int /*streamNumber*/) {}
90
91 void durationChanged(std::chrono::milliseconds ms) { durationChanged(ms.count()); }
92 void durationChanged(qint64 duration) { Q_EMIT player->durationChanged(duration); }
93 void positionChanged(std::chrono::milliseconds ms) { positionChanged(ms.count()); }
94 void positionChanged(qint64 position) {
95 if (m_position == position)
96 return;
97 m_position = position;
98 Q_EMIT player->positionChanged(position);
99 }
100 void audioAvailableChanged(bool audioAvailable) {
101 if (m_audioAvailable == audioAvailable)
102 return;
103 m_audioAvailable = audioAvailable;
104 Q_EMIT player->hasAudioChanged(audioAvailable);
105 }
106 void videoAvailableChanged(bool videoAvailable) {
107 if (m_videoAvailable == videoAvailable)
108 return;
109 m_videoAvailable = videoAvailable;
110 Q_EMIT player->hasVideoChanged(videoAvailable);
111 }
112 void seekableChanged(bool seekable) {
113 if (m_seekable == seekable)
114 return;
115 m_seekable = seekable;
116 Q_EMIT player->seekableChanged(seekable);
117 }
118 void playbackRateChanged(qreal rate) { Q_EMIT player->playbackRateChanged(rate); }
119 void bufferProgressChanged(float progress) { Q_EMIT player->bufferProgressChanged(progress); }
120 void metaDataChanged() { Q_EMIT player->metaDataChanged(); }
121 void tracksChanged() { Q_EMIT player->tracksChanged(); }
122 void activeTracksChanged() { Q_EMIT player->activeTracksChanged(); }
123
124 void stateChanged(QMediaPlayer::PlaybackState newState);
125 void mediaStatusChanged(QMediaPlayer::MediaStatus status);
126 void error(QMediaPlayer::Error, const QString &errorString);
127 void setInvalidMediaWithError(QMediaPlayer::Error, const QString &errString);
128
129 void resetCurrentLoop() { m_currentLoop = 0; }
130 bool doLoop() {
131 return isSeekable() && (m_loops < 0 || ++m_currentLoop < m_loops);
132 }
133 int loops() const { return m_loops; }
134 virtual void setLoops(int loops)
135 {
136 if (m_loops == loops)
137 return;
138 m_loops = loops;
139 Q_EMIT player->loopsChanged();
140 }
141
142 using PitchCompensationAvailability = QMediaPlayer::PitchCompensationAvailability;
143
144 virtual PitchCompensationAvailability pitchCompensationAvailability() const;
145 virtual void setPitchCompensation(bool enabled);
146 virtual bool pitchCompensation() const;
147 void pitchCompensationChanged(bool enabled) const;
148
149 QPlaybackOptions playbackOptions() const;
150
151 bool qmediaplayerDestructorCalled = false;
152
153protected:
154 explicit QPlatformMediaPlayer(QMediaPlayer *parent = nullptr);
155
156private:
157 QMediaPlayer *player = nullptr;
158 QMediaPlayer::MediaStatus m_status = QMediaPlayer::NoMedia;
159 QMediaPlayer::PlaybackState m_state = QMediaPlayer::StoppedState;
160 bool m_seekable = false;
161 bool m_videoAvailable = false;
162 bool m_audioAvailable = false;
163 int m_loops = 1;
164 int m_currentLoop = 0;
165 qint64 m_position = 0;
166};
167
168#ifndef QT_NO_DEBUG_STREAM
169inline QDebug operator<<(QDebug dbg, QPlatformMediaPlayer::TrackType type)
170{
171 QDebugStateSaver save(dbg);
172 dbg.nospace();
173
174 switch (type) {
175 case QPlatformMediaPlayer::TrackType::AudioStream:
176 return dbg << "AudioStream";
177 case QPlatformMediaPlayer::TrackType::VideoStream:
178 return dbg << "VideoStream";
179 case QPlatformMediaPlayer::TrackType::SubtitleStream:
180 return dbg << "SubtitleStream";
181 default:
182 Q_UNREACHABLE_RETURN(dbg);
183 }
184}
185#endif
186
187QT_END_NAMESPACE
188
189
190#endif // QMEDIAPLAYERCONTROL_H
QMediaRecorder
\inmodule QtMultimedia
Definition qmediarecorder.h:21
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qsequentialanimationgroup.cpp:47
operator<<
QDebug operator<<(QDebug debug, QDir::Filters filters)
Definition qdir.cpp:2620