Katana_mirror/kdelibs
1
0
Fork 0
mirror of https://bitbucket.org/smil3y/kdelibs.git synced 2025-02-23 18:32:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

kutils: fix API clashes and improve error handling of media classes

Browse source 
Signed-off-by: Ivailo Monev <xakepa10@laimg.moc>
This commit is contained in:
Ivailo Monev 2019-05-23 17:12:53 +00:00
parent a371d6e674
commit 6f03b92281
3 changed files with 60 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CMakeLists.txt
View file

@ -119,7 +119,7 @@ set_package_properties(Strigi PROPERTIES
PURPOSE "Required by some critical kioslaves"
)
macro_optional_find_package(MPV)
macro_optional_find_package(MPV 0.23.0)
set_package_properties(MPV PROPERTIES
DESCRIPTION "A fork of mplayer2 and MPlayer"
URL "https://mpv.io/"

121
kutils/kmediaplayer/kmediaplayer.cpp
View file

@ -59,23 +59,23 @@ typedef quintptr WIdType;
void KAbstractPlayer::load(const QString &path)
{
command(QStringList() << "loadfile" << path);
command(QVariantList() << "loadfile" << path);
}
void KAbstractPlayer::load(const QByteArray &data)
{
// SECURITY: this is dangerous but some applications/libraries (like KHTML) require it
command(QStringList() << "loadfile" << QString("memory://%1").arg(data.data()));
command(QVariantList() << "loadfile" << QString("memory://%1").arg(data.data()));
}
void KAbstractPlayer::play()
{
setProperty("pause", false);
setOption("pause", false);
}
void KAbstractPlayer::pause()
{
setProperty("pause", true);
setOption("pause", true);
}
void KAbstractPlayer::seek(const float position)
@ -95,56 +95,56 @@ void KAbstractPlayer::stop()
QString KAbstractPlayer::path() const
{
return property("path").toString();
return option("path").toString();
}
QString KAbstractPlayer::title() const
{
return property("media-title").toString();
return option("media-title").toString();
}
float KAbstractPlayer::currentTime() const
{
return property("time-pos").toFloat();
return option("time-pos").toFloat();
}
float KAbstractPlayer::remainingTime() const
{
return property("time-remaining").toFloat();
return option("time-remaining").toFloat();
}
float KAbstractPlayer::totalTime() const
{
return property("duration").toFloat();
return option("duration").toFloat();
}
float KAbstractPlayer::volume() const
{
return property("volume").toFloat();
return option("volume").toFloat();
}
bool KAbstractPlayer::mute() const
{
return property("mute").toBool();
return option("mute").toBool();
}
QStringList KAbstractPlayer::protocols() const
{
static QStringList s_protocols;
if (s_protocols.isEmpty()) {
s_protocols = property("protocol-list").toStringList();
s_protocols = option("protocol-list").toStringList();
}
return s_protocols;
}
QString KAbstractPlayer::audiooutput() const
{
return property("audio-device").toString();
return option("audio-device").toString();
}
QStringList KAbstractPlayer::audiooutputs() const
{
const QVariantList value = property("audio-device-list").toList();
const QVariantList value = option("audio-device-list").toList();
QStringList stringlist;
foreach (const QVariant variant, value) {
QMapIterator<QString,QVariant> iter(variant.toMap());
@ -160,23 +160,23 @@ QStringList KAbstractPlayer::audiooutputs() const
bool KAbstractPlayer::isPlaying() const
{
return !property("pause").toBool() && !property("path").isNull();
return !option("pause").toBool() && !option("path").isNull();
}
bool KAbstractPlayer::isBuffering() const
{
return property("paused-for-cache").toBool();
return option("paused-for-cache").toBool();
}
bool KAbstractPlayer::isSeekable() const
{
return property("seekable").toBool() || property("partially-seekable").toBool();
return option("seekable").toBool() || option("partially-seekable").toBool();
}
bool KAbstractPlayer::isFullscreen() const
{
#if defined(HAVE_MPV)
return property("fullscreen").toBool();
return option("fullscreen").toBool();
#else
return s_fullscreen;
#endif // HAVE_MPV
@ -203,28 +203,28 @@ bool KAbstractPlayer::isPathSupported(const QString &path) const
void KAbstractPlayer::setVolume(const float volume)
{
setProperty("volume", volume);
setOption("volume", volume);
}
void KAbstractPlayer::setVolume(const int volume)
{
setProperty("volume", volume);
setOption("volume", volume);
}
void KAbstractPlayer::setMute(const bool mute)
{
setProperty("mute", mute);
setOption("mute", mute);
}
void KAbstractPlayer::setAudioOutput(const QString &output)
{
setProperty("audio-device", output);
setOption("audio-device", output);
}
void KAbstractPlayer::setFullscreen(const bool fullscreen)
{
#if defined(HAVE_MPV)
setProperty("fullscreen", fullscreen);
setOption("fullscreen", fullscreen);
#else
s_fullscreen = fullscreen;
#endif // HAVE_MPV
@ -270,33 +270,34 @@ void KAbstractPlayer::setFullscreen(const bool fullscreen)
#define COMMMON_COMMAND_SENDER \
kDebug() << i18n("sending command") << command; \
if (d->m_handle) { \
const QVariant error = mpv::qt::command_variant(d->m_handle, command); \
if (!error.isNull()) { \
kWarning() << error; \
const QVariant result = mpv::qt::command(d->m_handle, command); \
if (mpv::qt::is_error(result)) { \
kWarning() << mpv_error_string(mpv::qt::get_error(result)); \
} \
}
#define COMMON_PROPERTY_SETTER \
kDebug() << i18n("setting property") << name << value; \
#define COMMON_OPTION_GETTER \
kDebug() << i18n("getting option") << name; \
if (d->m_handle) { \
mpv::qt::set_property_variant(d->m_handle, name, value); \
}
#define COMMON_PROPERTY_GETTER \
kDebug() << i18n("getting property") << name; \
if (d->m_handle) { \
return mpv::qt::get_property_variant(d->m_handle, name); \
const QVariant result = mpv::qt::get_property(d->m_handle, name); \
if (mpv::qt::is_error(result)) { \
kWarning() << mpv_error_string(mpv::qt::get_error(result)); \
return QVariant(); \
} \
return result; \
} \
return QVariant();
#define COMMON_OPTION_SETTER \
kDebug() << i18n("setting option") << name << value; \
if (d->m_handle) { \
mpv::qt::set_option_variant(d->m_handle, name, value); \
const QVariant result = mpv::qt::set_property(d->m_handle, name, value); \
if (mpv::qt::is_error(result)) { \
kWarning() << mpv_error_string(mpv::qt::get_error(result)); \
} \
}
#define COMMMON_EVENT_HANDLER \
kDebug() << i18n("processing events"); \
while (!d->m_stopprocessing) { \
mpv_event *event = mpv_wait_event(d->m_handle, 0); \
if (event->event_id == MPV_EVENT_NONE) { \
@ -321,14 +322,14 @@ void KAbstractPlayer::setFullscreen(const bool fullscreen)
case MPV_EVENT_END_FILE: { \
mpv_event_end_file *prop = static_cast<mpv_event_end_file *>(event->data); \
if (prop->reason == MPV_END_FILE_REASON_ERROR) { \
QString mpverror = QString(mpv_error_string(prop->error)); \
QString mpverror = QString::fromLatin1(mpv_error_string(prop->error)); \
kDebug() << i18n("playback finished with error") << mpverror; \
emit finished(); \
emit error(mpverror); \
} else if (prop->reason == MPV_END_FILE_REASON_EOF \
|| prop->reason == MPV_END_FILE_REASON_STOP \
|| prop->reason == MPV_END_FILE_REASON_QUIT) { \
if (property("path").isNull()) { \
if (option("path").isNull()) { \
kDebug() << i18n("playback finished"); \
emit finished(); \
} \
@ -336,8 +337,8 @@ void KAbstractPlayer::setFullscreen(const bool fullscreen)
break; \
} \
case MPV_EVENT_PROPERTY_CHANGE: { \
kDebug() << i18n("property changed"); \
mpv_event_property *prop = static_cast<mpv_event_property *>(event->data); \
kDebug() << i18n("property changed") << QString::fromLatin1(prop->name); \
if (strcmp(prop->name, "time-pos") == 0) { \
double value = 0; \
if (prop->format == MPV_FORMAT_DOUBLE) { \
@ -355,7 +356,7 @@ void KAbstractPlayer::setFullscreen(const bool fullscreen)
} \
emit seekable(value); \
} else if (strcmp(prop->name, "partially-seekable") == 0) { \
if (property("seekable").toBool() == false) { \
if (option("seekable").toBool() == false) { \
bool value = false; \
if (prop->format == MPV_FORMAT_FLAG) { \
value = *(bool *)prop->data; \
@ -407,8 +408,8 @@ KAudioPlayer::KAudioPlayer(QObject *parent)
mpv_set_wakeup_callback(d->m_handle, wakeup_audio, this);
// NOTE: newer releases use vid, video is compat! the change is pre-2014 but yeah..
setProperty("vid", "no");
setProperty("video", "no");
setOption("vid", "no");
setOption("video", "no");
const QString globalaudio = d->m_settings->value("global/audiooutput", "auto").toString();
const int globalvolume = d->m_settings->value("global/volume", 90).toInt();
@ -440,14 +441,9 @@ void KAudioPlayer::command(const QVariant &command) const
COMMMON_COMMAND_SENDER
}
void KAudioPlayer::setProperty(const QString &name, const QVariant &value) const
QVariant KAudioPlayer::option(const QString &name) const
{
COMMON_PROPERTY_SETTER
}
QVariant KAudioPlayer::property(const QString &name) const
{
COMMON_PROPERTY_GETTER
COMMON_OPTION_GETTER
}
void KAudioPlayer::setOption(const QString &name, const QVariant &value) const
@ -524,14 +520,9 @@ void KMediaPlayer::command(const QVariant &command) const
COMMMON_COMMAND_SENDER
}
void KMediaPlayer::setProperty(const QString &name, const QVariant &value) const
QVariant KMediaPlayer::option(const QString &name) const
{
COMMON_PROPERTY_SETTER
}
QVariant KMediaPlayer::property(const QString &name) const
{
COMMON_PROPERTY_GETTER
COMMON_OPTION_GETTER
}
void KMediaPlayer::setOption(const QString &name, const QVariant &value) const
@ -567,13 +558,7 @@ void KAudioPlayer::command(const QVariant &command) const
Q_UNUSED(command);
}
void KAudioPlayer::setProperty(const QString &name, const QVariant &value) const
{
Q_UNUSED(name);
Q_UNUSED(value);
}
QVariant KAudioPlayer::property(const QString &name) const
QVariant KAudioPlayer::option(const QString &name) const
{
Q_UNUSED(name);
return QVariant();
@ -611,13 +596,7 @@ void KMediaPlayer::command(const QVariant &command) const
Q_UNUSED(command);
}
void KMediaPlayer::setProperty(const QString &name, const QVariant &value) const
{
Q_UNUSED(name);
Q_UNUSED(value);
}
QVariant KMediaPlayer::property(const QString &name) const
QVariant KMediaPlayer::option(const QString &name) const
{
Q_UNUSED(name);
return QVariant();

17
kutils/kmediaplayer/kmediaplayer.h
View file

@ -45,14 +45,17 @@ public:
convenience methods bellow those are not enough for your use case, but it is better to let
us know your requirements instead of using them. They may serve you as temporary solution,
for testing purposes, etc. but beware there be dragons!
@note Because @p QObject and @p QWidget have property system the methods are named option
but in fact they set and get properties of the underlaying player, not options. There is
a difference between them in MPV so make sure you are using the methods for properties if
you rely on @p option and @p setOption.
**/
//! @brief A low-level player command sender
virtual void command(const QVariant &params) const = 0;
//! @brief A low-level player property setter
virtual void setProperty(const QString &name, const QVariant &value) const = 0;
//! @brief A low-level player property getter
virtual QVariant property(const QString &name) const = 0;
//! @brief A low-level player option setter
virtual QVariant option(const QString &name) const = 0;
//! @brief A low-level player property setter
virtual void setOption(const QString &name, const QVariant &value) const = 0;
//@}
@ -236,8 +239,7 @@ public:
~KAudioPlayer();
void command(const QVariant &command) const;
void setProperty(const QString &name, const QVariant& value) const;
QVariant property(const QString &name) const;
QVariant option(const QString &name) const;
void setOption(const QString &name, const QVariant& value) const;
bool isMimeSupported(const QString &mime) const;
@ -301,8 +303,7 @@ public:
~KMediaPlayer();
void command(const QVariant &command) const;
void setProperty(const QString &name, const QVariant &value) const;
QVariant property(const QString &name) const;
QVariant option(const QString &name) const;
void setOption(const QString &name, const QVariant &value) const;
bool isMimeSupported(const QString &mime) const;