libqtappfw: Add radio binding support

Add initial support for the radio binding.  At the moment, everything
required for the current demo radio application is in place.  Further
development will be required to fill in support for changing bands
and the stereo mode.

Change-Id: I1b1866856ce8388b34624c14c692102c344a7a62
Signed-off-by: Scott Murray <scott.murray@konsulko.com>

5 files changed, 421 insertions, 0 deletions

diff --git a/radio/CMakeLists.txt b/radio/CMakeLists.txt
new file mode 100644
index 0000000..46ac12b
--- /dev/null
+++ b/radio/CMakeLists.txt
@@ -0,0 +1,2 @@
+add_headers(radio.h radiomessage.h)
+add_sources(radio.cpp radiomessage.cpp)
diff --git a/radio/radio.cpp b/radio/radio.cpp
new file mode 100644
index 0000000..2367b20
--- /dev/null
+++ b/radio/radio.cpp
@@ -0,0 +1,245 @@
+/*
+ * Copyright (C) 2018 Konsulko Group
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "message.h"
+#include "messageengine.h"
+#include "radio.h"
+#include "radiomessage.h"
+#include "responsemessage.h"
+
+Radio::Radio (QUrl &url, QQmlContext *context, QObject * parent) :
+    QObject(parent),
+    m_mloop(nullptr),
+    m_band(1),
+    m_frequency(0),
+    m_playing(false),
+    m_scanning(false)
+{
+    m_mloop = new MessageEngine(url);
+    m_context = context;
+
+    QObject::connect(m_mloop, &MessageEngine::connected, this, &Radio::onConnected);
+    QObject::connect(m_mloop, &MessageEngine::disconnected, this, &Radio::onDisconnected);
+    QObject::connect(m_mloop, &MessageEngine::messageReceived, this, &Radio::onMessageReceived);
+}
+
+Radio::~Radio()
+{
+    delete m_mloop;
+}
+
+void Radio::setBand(int band)
+{
+    RadioMessage *rmsg = new RadioMessage();
+    QJsonObject parameter;
+
+    parameter.insert("band", band ? "FM": "AM");
+    rmsg->createRequest("band", parameter);
+    m_mloop->sendMessage(rmsg);
+    delete rmsg;
+}
+
+void Radio::setFrequency(int frequency)
+{
+    RadioMessage *rmsg = new RadioMessage();
+    QJsonObject parameter;
+
+    if (m_scanning)
+        scanStop();
+
+    if (frequency == m_frequency)
+        return;
+
+    parameter.insert("value", QString::number(frequency));
+    rmsg->createRequest("frequency", parameter);
+    m_mloop->sendMessage(rmsg);
+    delete rmsg;
+
+    // To improve UI responsiveness, signal the change here immediately
+    // This fixes visual glitchiness in the slider caused by the frequency
+    // update event taking long enough that the QML engine gets a chance
+    // to update the slider with the current value before the event with
+    // the new value comes.
+    m_frequency = frequency;
+    emit frequencyChanged(m_frequency);
+}
+
+// control related methods
+
+void Radio::start()
+{
+    RadioMessage *rmsg = new RadioMessage();
+    QJsonObject parameter;
+
+    rmsg->createRequest("start", parameter);
+    m_mloop->sendMessage(rmsg);
+    delete rmsg;
+}
+
+void Radio::stop()
+{
+    RadioMessage *rmsg = new RadioMessage();
+
+    QJsonObject parameter;
+    rmsg->createRequest("stop", parameter);
+    m_mloop->sendMessage(rmsg);
+    delete rmsg;
+}
+
+void Radio::scanForward()
+{
+    if (m_scanning)
+        return;
+
+    RadioMessage *rmsg = new RadioMessage();
+    QJsonObject parameter;
+    parameter.insert("direction", "forward");
+    rmsg->createRequest("scan_start", parameter);
+    m_mloop->sendMessage(rmsg);
+
+    m_scanning = true;
+    emit scanningChanged(m_scanning);
+
+    delete rmsg;
+}
+
+void Radio::scanBackward()
+{
+    if (m_scanning)
+        return;
+
+    RadioMessage *rmsg = new RadioMessage();
+    QJsonObject parameter;
+    parameter.insert("direction", "backward");
+    rmsg->createRequest("scan_start", parameter);
+    m_mloop->sendMessage(rmsg);
+
+    m_scanning = true;
+    emit scanningChanged(m_scanning);
+
+    delete rmsg;
+}
+
+void Radio::scanStop()
+{
+    RadioMessage *rmsg = new RadioMessage();
+
+    QJsonObject parameter;
+    rmsg->createRequest("scan_stop", parameter);
+    m_mloop->sendMessage(rmsg);
+
+    m_scanning = false;
+    emit scanningChanged(m_scanning);
+
+    delete rmsg;
+}
+
+void Radio::updateFrequencyBandParameters()
+{
+    RadioMessage *rmsg = new RadioMessage();
+
+    QJsonObject parameter;
+    parameter.insert("band", m_band ? "FM" : "AM");
+    rmsg->createRequest("frequency_range", parameter);
+    m_mloop->sendMessage(rmsg);
+    delete rmsg;
+
+    rmsg = new RadioMessage();
+    rmsg->createRequest("frequency_step", parameter);
+    m_mloop->sendMessage(rmsg);
+    delete rmsg;
+}
+
+void Radio::onConnected()
+{
+    QStringListIterator eventIterator(events);
+    RadioMessage *rmsg;
+
+    while (eventIterator.hasNext()) {
+        rmsg = new RadioMessage();
+        QJsonObject parameter;
+        parameter.insert("value", eventIterator.next());
+        rmsg->createRequest("subscribe", parameter);
+        m_mloop->sendMessage(rmsg);
+        delete rmsg;
+    }
+
+    // Trigger initial update of frequency band parameters (min/max/step)
+    updateFrequencyBandParameters();
+}
+
+void Radio::onDisconnected()
+{
+    QStringListIterator eventIterator(events);
+    RadioMessage *rmsg;
+
+    while (eventIterator.hasNext()) {
+        rmsg = new RadioMessage();
+        QJsonObject parameter;
+        parameter.insert("value", eventIterator.next());
+        rmsg->createRequest("unsubscribe", parameter);
+        m_mloop->sendMessage(rmsg);
+        delete rmsg;
+    }
+}
+
+void Radio::onMessageReceived(MessageType type, Message *msg)
+{
+    if (msg->isEvent() && type == RadioEventMessage) {
+        RadioMessage *rmsg = qobject_cast<RadioMessage*>(msg);
+
+        if (rmsg->isFrequencyEvent()) {
+            unsigned int frequency = rmsg->eventData().value("value").toInt();
+            m_frequency = frequency;
+            if (!m_scanning && (m_frequency != frequency)) {
+                emit frequencyChanged(m_frequency);
+            }
+        } else if (rmsg->isStationFoundEvent()) {
+            m_scanning = false;
+            emit scanningChanged(m_scanning);
+
+            m_frequency = rmsg->eventData().value("value").toInt();
+            emit frequencyChanged(m_frequency);
+        } else if (rmsg->isStatusEvent()) {
+            if (rmsg->eventData().value("value") == QString("playing")) {
+                m_playing = true;
+                emit playingChanged(m_playing);
+            } else if (rmsg->eventData().value("value") == QString("stopped")) {
+                m_playing = false;
+                emit playingChanged(m_playing);
+            }
+        }
+    } else if (msg->isReply() && type == ResponseRequestMessage) {
+        ResponseMessage *rmsg = qobject_cast<ResponseMessage*>(msg);
+
+        if (rmsg->requestVerb() == "frequency_range") {
+            m_minFrequency = rmsg->replyData().value("min").toInt();
+            emit minFrequencyChanged(m_minFrequency);
+            m_maxFrequency = rmsg->replyData().value("max").toInt();
+            emit maxFrequencyChanged(m_maxFrequency);
+
+            // Handle start up
+            if (!m_frequency) {
+                m_frequency = m_minFrequency;
+                emit frequencyChanged(m_frequency);
+            }
+        } else if (rmsg->requestVerb() == "frequency_step") {
+            m_frequencyStep = rmsg->replyData().value("step").toInt();
+            emit frequencyStepChanged(m_frequencyStep);
+        }
+    }
+    msg->deleteLater();
+}
diff --git a/radio/radio.h b/radio/radio.h
new file mode 100644
index 0000000..642c58f
--- /dev/null
+++ b/radio/radio.h
@@ -0,0 +1,100 @@
+/*
+ * Copyright (C) 2018 Konsulko Group
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef RADIO_H
+#define RADIO_H
+
+#include <QDebug>
+#include <QObject>
+
+#include <QtQml/QQmlContext>
+#include "messageengine.h"
+
+class Radio : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY(unsigned int band READ band WRITE setBand NOTIFY bandChanged)
+    Q_PROPERTY(unsigned int amBand READ amBand CONSTANT)
+    Q_PROPERTY(unsigned int fmBand READ fmBand CONSTANT)
+    Q_PROPERTY(unsigned int frequency READ frequency WRITE setFrequency NOTIFY frequencyChanged)
+    Q_PROPERTY(bool playing READ playing NOTIFY playingChanged)
+    Q_PROPERTY(bool scanning READ scanning NOTIFY scanningChanged)
+    Q_PROPERTY(unsigned int minFrequency READ minFrequency NOTIFY minFrequencyChanged)
+    Q_PROPERTY(unsigned int maxFrequency READ maxFrequency NOTIFY maxFrequencyChanged)
+    Q_PROPERTY(unsigned int frequencyStep READ frequencyStep NOTIFY frequencyStepChanged)
+
+    public:
+        explicit Radio(QUrl &url, QQmlContext *context, QObject * parent = Q_NULLPTR);
+        virtual ~Radio();
+
+        unsigned int band() const { return m_band; }
+        void setBand(int band);
+
+        unsigned int amBand() const { return 0; }
+        unsigned int fmBand() const { return 1; }
+
+        unsigned int frequency() const { return m_frequency; }
+        void setFrequency(int frequency);
+
+        unsigned int minFrequency() const { return m_minFrequency; }
+        unsigned int maxFrequency() const { return m_maxFrequency; }
+        unsigned int frequencyStep() const { return m_frequencyStep; }
+
+        bool playing() const { return m_playing; }
+
+        bool scanning() const { return m_scanning; }
+
+	// controls
+        Q_INVOKABLE void start();
+        Q_INVOKABLE void stop();
+        Q_INVOKABLE void scanForward();
+        Q_INVOKABLE void scanBackward();
+        Q_INVOKABLE void scanStop();
+
+    signals:
+	void bandChanged(int band);
+	void frequencyChanged(int frequency);
+	void playingChanged(bool status);
+	void scanningChanged(bool scanning);
+	void minFrequencyChanged(int minFrequency);
+	void maxFrequencyChanged(int maxFrequency);
+	void frequencyStepChanged(int frequencyStep);
+
+    private:
+        MessageEngine *m_mloop;
+        QQmlContext *m_context;
+
+	unsigned int m_band;
+	unsigned int m_frequency;
+	unsigned int m_minFrequency;
+	unsigned int m_maxFrequency;
+	unsigned int m_frequencyStep;
+        bool m_playing;
+	bool m_scanning;
+
+        void updateFrequencyBandParameters();
+        void onConnected();
+        void onDisconnected();
+        void onMessageReceived(MessageType type, Message *msg);
+
+        const QStringList events {
+            "frequency",
+            "station_found",
+            "status",
+        };
+};
+
+#endif // RADIO_H
diff --git a/radio/radiomessage.cpp b/radio/radiomessage.cpp
new file mode 100644
index 0000000..2a96a80
--- /dev/null
+++ b/radio/radiomessage.cpp
@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2018 Konsulko Group
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <QDebug>
+#include <QJsonArray>
+#include <QJsonDocument>
+#include <QJsonObject>
+
+#include "radiomessage.h"
+
+bool RadioMessage::createRequest(QString verb, QJsonObject parameter)
+{
+	QStringList verbs {"frequency",
+			   "band",
+			   "band_supported",
+			   "frequency_range",
+			   "frequency_step",
+			   "start",
+			   "stop",
+			   "scan_start",
+			   "scan_stop",
+			   "stereo_mode",
+			   "subscribe",
+			   "unsubscribe" };
+	if (!verbs.contains(verb))
+		return false;
+
+	return Message::createRequest("radio", verb, parameter);
+}
diff --git a/radio/radiomessage.h b/radio/radiomessage.h
new file mode 100644
index 0000000..dc6e563
--- /dev/null
+++ b/radio/radiomessage.h
@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2018 Konsulko Group
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef RADIO_MESSAGE_H
+#define RADIO_MESSAGE_H
+
+#include "message.h"
+
+class RadioMessage : public Message
+{
+    Q_OBJECT
+    public:
+        bool isFrequencyEvent() { return (this->eventName() == "frequency"); };
+        bool isStationFoundEvent() { return (this->eventName() == "station_found"); };
+        bool isStatusEvent() { return (this->eventName() == "status"); };
+        bool createRequest(QString verb, QJsonObject parameter);
+};
+
+#endif // RADIO_MESSAGE_H