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 <QtCore/private/qglobal_p.h>
23#include <QtCore/qobject.h>
24
25#include <array>
26
27QT_BEGIN_NAMESPACE
28
29class QMediaStreamsControl;
30class QPlatformAudioOutput;
31
32class Q_MULTIMEDIA_EXPORT QPlatformMediaPlayer
33{
34public:
35 virtual ~QPlatformMediaPlayer();
36 QMediaPlayer::PlaybackState state() const { return m_state; }
37 QMediaPlayer::MediaStatus mediaStatus() const { return m_status; }
38
39 virtual qint64 duration() const = 0;
40
41 virtual qint64 position() const { return m_position; }
42 virtual void setPosition(qint64 position) = 0;
43
44 virtual float bufferProgress() const = 0;
45
46 virtual bool isAudioAvailable() const { return m_audioAvailable; }
47 virtual bool isVideoAvailable() const { return m_videoAvailable; }
48
49 virtual bool isSeekable() const { return m_seekable; }
50
51 virtual QMediaTimeRange availablePlaybackRanges() const = 0;
52
53 virtual qreal playbackRate() const = 0;
54 virtual void setPlaybackRate(qreal rate) = 0;
55
56 virtual QUrl media() const = 0;
57 virtual const QIODevice *mediaStream() const = 0;
58 virtual void setMedia(const QUrl &media, QIODevice *stream) = 0;
59
60 virtual void play() = 0;
61 virtual void pause() = 0;
62 virtual void stop() = 0;
63
64 virtual bool streamPlaybackSupported() const { return false; }
65
66 virtual void setAudioOutput(QPlatformAudioOutput *) {}
67
68 virtual void setAudioBufferOutput(QAudioBufferOutput *) { }
69
70 virtual QMediaMetaData metaData() const { return {}; }
71
72 virtual void setVideoSink(QVideoSink * /*sink*/) = 0;
73
74 virtual bool canPlayQrc() const { return false; }
75
76 // media streams
77 enum class TrackType : uint8_t {
78 VideoStream,
79 AudioStream,
80 SubtitleStream,
81 };
82 static constexpr size_t NTrackTypes = qToUnderlying(TrackType::SubtitleStream) + 1;
83
84 template <typename T>
85 class TrackTypeMap : public std::array<T, NTrackTypes>
86 {
87 using Base = std::array<T, NTrackTypes>;
88
89 public:
90 using Base::operator[];
91
92 constexpr T &operator[](TrackType type) { return Base::operator[](qToUnderlying(type)); }
93 constexpr const T &operator[](TrackType type) const
94 {
95 return Base::operator[](qToUnderlying(type));
96 }
97 };
98
99 virtual int trackCount(TrackType) { return 0; }
100 virtual QMediaMetaData trackMetaData(TrackType /*type*/, int /*streamNumber*/) { return QMediaMetaData(); }
101 virtual int activeTrack(TrackType) { return -1; }
102 virtual void setActiveTrack(TrackType, int /*streamNumber*/) {}
103
104 void durationChanged(std::chrono::milliseconds ms) { durationChanged(ms.count()); }
105 void durationChanged(qint64 duration) { emit player->durationChanged(duration); }
106 void positionChanged(std::chrono::milliseconds ms) { positionChanged(ms.count()); }
107 void positionChanged(qint64 position) {
108 if (m_position == position)
109 return;
110 m_position = position;
111 emit player->positionChanged(position);
112 }
113 void audioAvailableChanged(bool audioAvailable) {
114 if (m_audioAvailable == audioAvailable)
115 return;
116 m_audioAvailable = audioAvailable;
117 emit player->hasAudioChanged(audioAvailable);
118 }
119 void videoAvailableChanged(bool videoAvailable) {
120 if (m_videoAvailable == videoAvailable)
121 return;
122 m_videoAvailable = videoAvailable;
123 emit player->hasVideoChanged(videoAvailable);
124 }
125 void seekableChanged(bool seekable) {
126 if (m_seekable == seekable)
127 return;
128 m_seekable = seekable;
129 emit player->seekableChanged(seekable);
130 }
131 void playbackRateChanged(qreal rate) { emit player->playbackRateChanged(rate); }
132 void bufferProgressChanged(float progress) { emit player->bufferProgressChanged(progress); }
133 void metaDataChanged() { emit player->metaDataChanged(); }
134 void tracksChanged() { emit player->tracksChanged(); }
135 void activeTracksChanged() { emit player->activeTracksChanged(); }
136
137 void stateChanged(QMediaPlayer::PlaybackState newState);
138 void mediaStatusChanged(QMediaPlayer::MediaStatus status);
139 void error(QMediaPlayer::Error, const QString &errorString);
140 void setInvalidMediaWithError(QMediaPlayer::Error, const QString &errString);
141
142 void resetCurrentLoop() { m_currentLoop = 0; }
143 bool doLoop() {
144 return isSeekable() && (m_loops < 0 || ++m_currentLoop < m_loops);
145 }
146 int loops() const { return m_loops; }
147 virtual void setLoops(int loops)
148 {
149 if (m_loops == loops)
150 return;
151 m_loops = loops;
152 Q_EMIT player->loopsChanged();
153 }
154
155 using PitchCompensationAvailability = QMediaPlayer::PitchCompensationAvailability;
156
157 virtual PitchCompensationAvailability pitchCompensationAvailability() const;
158 virtual void setPitchCompensation(bool enabled);
159 virtual bool pitchCompensation() const;
160 void pitchCompensationChanged(bool enabled) const;
161
162 QPlaybackOptions playbackOptions() const;
163
164 bool qmediaplayerDestructorCalled = false;
165
166protected:
167 explicit QPlatformMediaPlayer(QMediaPlayer *parent = nullptr);
168
169private:
170 QMediaPlayer *player = nullptr;
171 QMediaPlayer::MediaStatus m_status = QMediaPlayer::NoMedia;
172 QMediaPlayer::PlaybackState m_state = QMediaPlayer::StoppedState;
173 bool m_seekable = false;
174 bool m_videoAvailable = false;
175 bool m_audioAvailable = false;
176 int m_loops = 1;
177 int m_currentLoop = 0;
178 qint64 m_position = 0;
179};
180
181#ifndef QT_NO_DEBUG_STREAM
182inline QDebug operator<<(QDebug dbg, QPlatformMediaPlayer::TrackType type)
183{
184 QDebugStateSaver save(dbg);
185 dbg.nospace();
186
187 switch (type) {
188 case QPlatformMediaPlayer::TrackType::AudioStream:
189 return dbg << "AudioStream";
190 case QPlatformMediaPlayer::TrackType::VideoStream:
191 return dbg << "VideoStream";
192 case QPlatformMediaPlayer::TrackType::SubtitleStream:
193 return dbg << "SubtitleStream";
194 default:
195 Q_UNREACHABLE_RETURN(dbg);
196 }
197}
198#endif
199
200QT_END_NAMESPACE
201
202
203#endif // QMEDIAPLAYERCONTROL_H
QMediaRecorder
\inmodule QtMultimedia
Definition qmediarecorder.h:21
operator<<
QDebug operator<<(QDebug debug, QDir::Filters filters)
Definition qdir.cpp:2620