AVInput COM-RPC Support: Moved getInputDevices out of IAVInput

Author: pahearn73

AVInput/AVInput.cpp

@@ -18,11 +18,25 @@
  **/
 
 #include "AVInput.h"
+#include "dsMgr.h"
+#include "hdmiIn.hpp"
+#include "compositeIn.hpp"
+
+#include "UtilsJsonRpc.h"
 
 #define API_VERSION_NUMBER_MAJOR 1
 #define API_VERSION_NUMBER_MINOR 7
 #define API_VERSION_NUMBER_PATCH 1
 
+// <pca>
+// Explicitly implementing getInputDevices method instead of autogenerating via IAVInput.h
+// because it requires optional parameters which are not supported in Thunder 4.x. This can 
+// be refactored after migrating to 5.x.
+#define AVINPUT_METHOD_GET_INPUT_DEVICES "getInputDevices"
+#define HDMI 0
+#define COMPOSITE 1
+// </pca>
+
 namespace WPEFramework {
 namespace {
 
@@ -47,11 +61,13 @@ namespace Plugin {
         , _avInput(nullptr)
         , _avInputNotification(this)
     {
+        Register<JsonObject, JsonObject>(_T(AVINPUT_METHOD_GET_INPUT_DEVICES), &AVInput::getInputDevicesWrapper, this);
         SYSLOG(Logging::Startup, (_T("AVInput Constructor")));
     }
 
     AVInput::~AVInput()
     {
+        Unregister(_T(AVINPUT_METHOD_GET_INPUT_DEVICES));
         SYSLOG(Logging::Shutdown, (string(_T("AVInput Destructor"))));
     }
 
@@ -147,6 +163,87 @@ namespace Plugin {
         SYSLOG(Logging::Shutdown, (string(_T("AVInput de-initialised"))));
     }
 
+    // <pca>
+    JsonArray AVInput::getInputDevices(int iType)
+    {
+        JsonArray list;
+        try
+        {
+            int num = 0;
+            if (iType == HDMI) {
+                num = device::HdmiInput::getInstance().getNumberOfInputs();
+            }
+            else if (iType == COMPOSITE) {
+                num = device::CompositeInput::getInstance().getNumberOfInputs();
+            }
+            if (num > 0) {
+                int i = 0;
+                for (i = 0; i < num; i++) {
+                    //Input ID is aleays 0-indexed, continuous number starting 0
+                    JsonObject hash;
+                    hash["id"] = i;
+                    std::stringstream locator;
+                    if (iType == HDMI) {
+                        locator << "hdmiin://localhost/deviceid/" << i;
+                        hash["connected"] = device::HdmiInput::getInstance().isPortConnected(i);
+                    }
+                    else if (iType == COMPOSITE) {
+                        locator << "cvbsin://localhost/deviceid/" << i;
+                        hash["connected"] = device::CompositeInput::getInstance().isPortConnected(i);
+                    }
+                    hash["locator"] = locator.str();
+                    LOGWARN("AVInputService::getInputDevices id %d, locator=[%s], connected=[%d]", i, hash["locator"].String().c_str(), hash["connected"].Boolean());
+                    list.Add(hash);
+                }
+            }
+        }
+        catch (const std::exception &e) {
+            LOGWARN("AVInputService::getInputDevices Failed");
+        }
+        return list;
+    }
+
+    // <pca>
+    int getTypeOfInput(string sType)
+    {
+        int iType = -1;
+        if (strcmp(sType.c_str(), "HDMI") == 0)
+            iType = HDMI;
+        else if (strcmp(sType.c_str(), "COMPOSITE") == 0)
+            iType = COMPOSITE;
+        else
+            throw "Invalide type of INPUT, please specify HDMI/COMPOSITE";
+        return iType;
+    }
+    // </pca>
+
+    uint32_t AVInput::getInputDevicesWrapper(const JsonObject& parameters, JsonObject& response)
+    {
+        LOGINFOMETHOD();
+
+        if (parameters.HasLabel("typeOfInput")) {
+            string sType = parameters["typeOfInput"].String();
+            int iType = 0;
+            try {
+                iType = getTypeOfInput (sType);
+            }catch (...) {
+                LOGWARN("Invalid Arguments");
+                returnResponse(false);
+            }
+            response["devices"] = getInputDevices(iType);
+        }
+        else {
+            JsonArray listHdmi = getInputDevices(HDMI);
+            JsonArray listComposite = getInputDevices(COMPOSITE);
+            for (int i = 0; i < listComposite.Length(); i++) {
+                listHdmi.Add(listComposite.Get(i));
+            }
+            response["devices"] = listHdmi;
+        }
+        returnResponse(true);
+    }
+    // </pca>
+
     string AVInput::Information() const
     {
         return (string());

AVInput/AVInput.h

@@ -20,6 +20,7 @@
 #pragma once
 
 #include "Module.h"
+
 #include <core/JSON.h>
 #include <interfaces/IAVInput.h>
 #include <interfaces/json/JAVInput.h>
@@ -157,6 +158,11 @@ namespace Plugin {
 
         void Deactivated(RPC::IRemoteConnection* connection);
 
+        // <pca>
+        JsonArray getInputDevices(int iType);
+        uint32_t getInputDevicesWrapper(const JsonObject& parameters, JsonObject& response);
+        // </pca>
+
     }; // AVInput
 } // namespace Plugin
 } // namespace WPEFramework

AVInput/AVInputImplementation.cpp

@@ -38,18 +38,6 @@ static int planeType = 0;
 
 using namespace std;
 
-int getTypeOfInput(string sType)
-{
-    int iType = -1;
-    if (strcmp(sType.c_str(), "HDMI") == 0)
-        iType = HDMI;
-    else if (strcmp(sType.c_str(), "COMPOSITE") == 0)
-        iType = COMPOSITE;
-    else
-        throw "Invalide type of INPUT, please specify HDMI/COMPOSITE";
-    return iType;
-}
-
 namespace WPEFramework {
 namespace Plugin {
     SERVICE_REGISTRATION(AVInputImplementation, 1, 0);

AVInput/AVInputImplementation.h

@@ -150,7 +150,7 @@ namespace Plugin {
         virtual Core::hresult Unregister(Exchange::IAVInput::IHdmiContentTypeUpdateNotification* notification) override;
 
         Core::hresult NumberOfInputs(uint32_t& numberOfInputs, bool& success) override;
-        Core::hresult GetInputDevices(const int typeOfInput, Exchange::IAVInput::IInputDeviceIterator*& devices, bool& success) override;
+        Core::hresult GetInputDevices(const int typeOfInput, Exchange::IAVInput::IInputDeviceIterator*& devices, bool& success);
         Core::hresult WriteEDID(const int portId, const string& message, SuccessResult& successResult) override;
         Core::hresult ReadEDID(const int portId, string& EDID, bool& success) override;
         Core::hresult GetRawSPD(const int portId, string& HDMISPD, bool& success) override;

AVInput/CMakeLists.txt

@@ -41,6 +41,9 @@ set_target_properties(${MODULE_NAME} PROPERTIES
 
 target_compile_definitions(${MODULE_NAME} PRIVATE MODULE_NAME=Plugin_${PLUGIN_NAME})
 
+find_package(DS)
+find_package(IARMBus)
+
 target_include_directories(${MODULE_NAME} PRIVATE ../helpers)
 target_include_directories(${MODULE_NAME} PRIVATE ${DS_INCLUDE_DIRS})
 target_include_directories(${MODULE_NAME} PRIVATE ${IARMBUS_INCLUDE_DIRS})
@@ -78,15 +81,14 @@ if (RDK_SERVICE_L2_TEST)
    endif (TESTMOCKLIB_LIBRARIES)
 endif (RDK_SERVICES_L2_TEST)
 
-find_package(DS)
-find_package(IARMBus)
-
 target_include_directories(${PLUGIN_IMPLEMENTATION} PRIVATE ${DS_INCLUDE_DIRS})
 target_include_directories(${PLUGIN_IMPLEMENTATION} PRIVATE ${IARMBUS_INCLUDE_DIRS})
 target_include_directories(${PLUGIN_IMPLEMENTATION} PRIVATE ../helpers)
 
 target_link_libraries(${PLUGIN_IMPLEMENTATION} PUBLIC ${NAMESPACE}Plugins::${NAMESPACE}Plugins ${IARMBUS_LIBRARIES} ${DS_LIBRARIES} )
 
+target_link_libraries(${MODULE_NAME} PUBLIC ${IARMBUS_LIBRARIES} ${DS_LIBRARIES} )
+
 install(TARGETS ${PLUGIN_IMPLEMENTATION}
         DESTINATION lib/${STORAGE_DIRECTORY}/plugins)
 

Tests/L1Tests/tests/test_AVInput.cpp

@@ -363,17 +363,14 @@ TEST_F(AVInputInit, getInputDevices)
     TEST_LOG("*** _DEBUG: TEST_F(AVInputInit, getInputDevices): entry");
     EXPECT_CALL(*p_hdmiInputImplMock, getNumberOfInputs())
         .WillOnce(::testing::Return(1));
-    TEST_LOG("*** _DEBUG: TEST_F(AVInputInit, getInputDevices): Mark 1");
     EXPECT_CALL(*p_compositeInputImplMock, getNumberOfInputs())
         .WillOnce(::testing::Return(1));
-    TEST_LOG("*** _DEBUG: TEST_F(AVInputInit, getInputDevices): Mark 2");
     EXPECT_EQ(Core::ERROR_NONE, handler.Invoke(connection, _T("getInputDevices"), _T("{}"), response));
     TEST_LOG("*** _DEBUG: TEST_F(AVInputInit, getInputDevices): response=%s", response.c_str());
     // <pca>
-    //EXPECT_EQ(response, string("{\"devices\":[{\"id\":0,\"connected\":false,\"locator\":\"hdmiin:\\/\\/localhost\\/deviceid\\/0\"},{\"id\":0,\"connected\":false,\"locator\":\"cvbsin:\\/\\/localhost\\/deviceid\\/0\"}],\"success\":true}"));
-    EXPECT_EQ(response, string("{\"devices\":[{\"id\":0,\"locator\":\"hdmiin:\\/\\/localhost\\/deviceid\\/0\",\"connected\":false}],\"success\":true}"));
+    EXPECT_EQ(response, string("{\"devices\":[{\"id\":0,\"connected\":false,\"locator\":\"hdmiin:\\/\\/localhost\\/deviceid\\/0\"},{\"id\":0,\"connected\":false,\"locator\":\"cvbsin:\\/\\/localhost\\/deviceid\\/0\"}],\"success\":true}"));
+    //EXPECT_EQ(response, string("{\"devices\":[{\"id\":0,\"locator\":\"hdmiin:\\/\\/localhost\\/deviceid\\/0\",\"connected\":false}],\"success\":true}"));
     // </pca>
-    TEST_LOG("*** _DEBUG: TEST_F(AVInputInit, getInputDevices): exit");
 }
 
 TEST_F(AVInputInit, getInputDevices_HDMI)