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