Merge pull request #1828 from CastagnaIT/gui_feedback

Implemented GUI feedback for playback errors

Author: CastagnaIT

inputstream.adaptive/resources/language/resource.language.en_gb/strings.po

@@ -352,3 +352,17 @@ msgstr ""
 msgctxt "#30243"
 msgid "Verbose debugging can be useful for debugging components, but in some cases it may expose sensitive information in the log."
 msgstr ""
+
+#empty strings reserved for settings from id 30244 to 30299
+
+#. A GUI window title, "InputStream Adaptive" its the add-on name, not to be translated
+msgctxt "#30300"
+msgid "InputStream Adaptive error"
+msgstr ""
+
+#. A GUI message that is displayed when there is a problem playing a stream
+#. Do not translate placeholders: {error-details}
+#. Use of double graphes e.g. {whatyouwant{error-details}whatyouwant} allows you to add additional text printed only when a value is present
+msgctxt "#30301"
+msgid "Unable to play the stream.{[CR]Error: {error-details}}"
+msgstr ""

lib/cdm/cdm/debug.h

@@ -20,7 +20,6 @@ enum class LogLevel
 };
 
 void Log(const LogLevel level, const char* format, ...);
-#define LogF(level, format, ...) Log((level), ("%s: " format), __FUNCTION__, ##__VA_ARGS__)
 
 void SetDBGMsgCallback(void (*msgcb)(const LogLevel level, const char* msg));
 

lib/cdm/cdm/media/cdm/cdm_adapter.cc

@@ -193,88 +193,60 @@ CdmAdapter::CdmAdapter(
   const std::string& base_path,
   const CdmConfig& cdm_config,
   CdmAdapterClient *client)
-: library_(0)
-, cdm_path_(cdm_path)
+: cdm_path_(cdm_path)
 , cdm_base_path_(base_path)
 , client_(client)
 , key_system_(key_system)
 , cdm_config_(cdm_config)
-, active_buffer_(0)
-, cdm9_(0), cdm10_(0), cdm11_(0)
 {
   //DCHECK(!key_system_.empty());
-  Initialize();
 }
 
 CdmAdapter::~CdmAdapter()
 {
-  if (cdm9_)
-    cdm9_->Destroy(), cdm9_ = nullptr;
-  else if (cdm10_)
-    cdm10_->Destroy(), cdm10_ = nullptr;
-  else if (cdm11_)
-    cdm11_->Destroy(), cdm11_ = nullptr;
-  else
-    return;
-
-  deinit_cdm_func();
-
-  base::UnloadNativeLibrary(library_);
+  UnloadCDM();
 }
 
-void CdmAdapter::Initialize()
+bool CdmAdapter::LoadCDM()
 {
-  m_isClosingSession = false;
-  if (cdm9_ || cdm10_ || cdm11_)
-  {
-    if (cdm9_)
-      cdm9_->Destroy(), cdm9_ = nullptr;
-    else if (cdm10_)
-      cdm10_->Destroy(), cdm10_ = nullptr;
-    else if (cdm11_)
-      cdm11_->Destroy(), cdm11_ = nullptr;
-    base::UnloadNativeLibrary(library_);
-    library_ = 0;
-  }
+  UnloadCDM();
 
   base::NativeLibraryLoadError error;
   library_ = base::LoadNativeLibrary(cdm_path_, &error);
 
   if (!library_)
   {
-    LogF(LogLevel::ERROR, "Failed to load library: %s", error.ToString().c_str());
-    return;
+    Log(LogLevel::ERROR, "Failed to load library: %s", error.ToString().c_str());
+    return false;
   }
 
-  init_cdm_func = reinterpret_cast<InitializeCdmModuleFunc>(base::GetFunctionPointerFromNativeLibrary(library_, MAKE_STRING(INITIALIZE_CDM_MODULE)));
-  deinit_cdm_func = reinterpret_cast<DeinitializeCdmModuleFunc>(base::GetFunctionPointerFromNativeLibrary(library_, "DeinitializeCdmModule"));
-  create_cdm_func = reinterpret_cast<CreateCdmFunc>(base::GetFunctionPointerFromNativeLibrary(library_, "CreateCdmInstance"));
-  get_cdm_verion_func = reinterpret_cast<GetCdmVersionFunc>(base::GetFunctionPointerFromNativeLibrary(library_, "GetCdmVersion"));
+  init_cdm_func = reinterpret_cast<InitializeCdmModuleFunc>(
+      base::GetFunctionPointerFromNativeLibrary(library_, MAKE_STRING(INITIALIZE_CDM_MODULE)));
+  deinit_cdm_func = reinterpret_cast<DeinitializeCdmModuleFunc>(
+      base::GetFunctionPointerFromNativeLibrary(library_, "DeinitializeCdmModule"));
+  create_cdm_func = reinterpret_cast<CreateCdmFunc>(
+      base::GetFunctionPointerFromNativeLibrary(library_, "CreateCdmInstance"));
+  get_cdm_verion_func = reinterpret_cast<GetCdmVersionFunc>(
+      base::GetFunctionPointerFromNativeLibrary(library_, "GetCdmVersion"));
 
   if (!init_cdm_func || !create_cdm_func || !get_cdm_verion_func || !deinit_cdm_func)
   {
-    base::UnloadNativeLibrary(library_);
-    library_ = 0;
-    return;
+    Log(LogLevel::ERROR, "Failed to binding CDM library functions");
+    return false;
   }
+  return true;
+}
 
-  std::string version{get_cdm_verion_func()};
-
-  if (version == "4.10.2891.0")
-  {
-    // This version have unclear problems
-    // such as crashes on OnStorageId() method calls and others video decoding crashes
-    Log(LogLevel::ERROR,
-        "THE CDM VERSION \"4.10.2891.0\" IS NOT SUPPORTED DUE TO UNCLEAR LIBRARY ISSUES.\n"
-        "------------------------------> PLEASE INSTALL AN OLDER VERSION OF WIDEVINE CDM!");
-    return;
-  }
+bool CdmAdapter::Initialize()
+{
+  m_isClosingSession = false;
 
-  Log(LogLevel::DEBUG, "CDM version: %s", version.c_str());
+  Log(LogLevel::DEBUG, "CDM version: %s", GetVersion().c_str());
 
 #if defined(OS_WIN)
   // Load DXVA before sandbox lockdown to give CDM access to Output Protection
   // Manager (OPM).
+  base::NativeLibraryLoadError error;
   base::LoadNativeLibrary("dxva2.dll", &error);
 #endif  // defined(OS_WIN)
 
@@ -301,11 +273,45 @@ void CdmAdapter::Initialize()
     else if (cdm11_)
       cdm11_->Initialize(cdm_config_.allow_distinctive_identifier,
         cdm_config_.allow_persistent_state, false);
+
+    return true;
   }
-  else
+
+  Log(LogLevel::ERROR, "Cannot get the ContentDecryptionModule interface");
+  return false;
+}
+
+std::string CdmAdapter::GetVersion() const
+{
+  if (get_cdm_verion_func)
+    return get_cdm_verion_func();
+
+  return "";
+}
+
+void CdmAdapter::UnloadCDM()
+{
+  if (cdm9_)
+    cdm9_->Destroy(), cdm9_ = nullptr;
+  else if (cdm10_)
+    cdm10_->Destroy(), cdm10_ = nullptr;
+  else if (cdm11_)
+    cdm11_->Destroy(), cdm11_ = nullptr;
+
+  init_cdm_func = nullptr;
+  create_cdm_func = nullptr;
+  get_cdm_verion_func = nullptr;
+
+  if (deinit_cdm_func)
+  {
+    deinit_cdm_func();
+    deinit_cdm_func = nullptr;
+  }
+
+  if (library_)
   {
     base::UnloadNativeLibrary(library_);
-    library_ = 0;
+    library_ = nullptr;
   }
 }
 
@@ -770,7 +776,7 @@ void CdmFileIoImpl::Write(const uint8_t* data, uint32_t data_size)
 {
   if (!ExistsDir(base_path_.c_str()) && !CreateDirs(base_path_.c_str()))
   {
-    LogF(LogLevel::ERROR, "Cannot create directory: %s", base_path_.c_str());
+    Log(LogLevel::ERROR, "Cannot create directory: %s", base_path_.c_str());
     client_->OnWriteComplete(cdm::FileIOClient::Status::kError);
     return;
   }

lib/cdm/cdm/media/cdm/cdm_adapter.h

@@ -210,10 +210,14 @@ class CdmAdapter : public std::enable_shared_from_this<CdmAdapter>
   void OnInitialized(bool success) override;
 
 
-public: //Misc
-	~CdmAdapter();
-	bool valid(){ return library_ != 0; };
+  //Misc
+  ~CdmAdapter();
+  bool LoadCDM();
+  bool Initialize();
+  std::string GetVersion() const;
+
 private:
+  void UnloadCDM();
   using InitializeCdmModuleFunc = void(*)();
   using DeinitializeCdmModuleFunc = void(*)();
   using GetCdmVersionFunc = char* (*)();
@@ -223,20 +227,19 @@ class CdmAdapter : public std::enable_shared_from_this<CdmAdapter>
     GetCdmHostFunc get_cdm_host_func,
     void* user_data);
 
-  InitializeCdmModuleFunc init_cdm_func;
-  CreateCdmFunc create_cdm_func;
-  GetCdmVersionFunc get_cdm_verion_func;
-  DeinitializeCdmModuleFunc deinit_cdm_func;
+  InitializeCdmModuleFunc init_cdm_func{nullptr};
+  CreateCdmFunc create_cdm_func{nullptr};
+  GetCdmVersionFunc get_cdm_verion_func{nullptr};
+  DeinitializeCdmModuleFunc deinit_cdm_func{nullptr};
 
-  void Initialize();
   void SendClientMessage(const char* session, uint32_t session_size, CdmAdapterClient::CDMADPMSG msg, const uint8_t *data, size_t data_size, uint32_t status);
 
   // Keep a reference to the CDM.
-  base::NativeLibrary library_;
+  base::NativeLibrary library_{nullptr};
 
   std::string cdm_path_;
   std::string cdm_base_path_;
-  CdmAdapterClient *client_;
+  CdmAdapterClient* client_{nullptr};
   std::mutex client_mutex_;
   std::mutex decrypt_mutex_;
   std::mutex m_closeSessionMutex;
@@ -247,12 +250,11 @@ class CdmAdapter : public std::enable_shared_from_this<CdmAdapter>
   std::string key_system_;
   CdmConfig cdm_config_;
 
-  cdm::MessageType message_type_;
-  cdm::Buffer *active_buffer_;
+  cdm::Buffer* active_buffer_{nullptr};
 
-  cdm::ContentDecryptionModule_9 *cdm9_;
-  cdm::ContentDecryptionModule_10 *cdm10_;
-  cdm::ContentDecryptionModule_11 *cdm11_;
+  cdm::ContentDecryptionModule_9* cdm9_{nullptr};
+  cdm::ContentDecryptionModule_10* cdm10_{nullptr};
+  cdm::ContentDecryptionModule_11* cdm11_{nullptr};
 
   DISALLOW_COPY_AND_ASSIGN(CdmAdapter);
 };

src/Session.cpp

@@ -21,6 +21,7 @@
 #include "samplereader/SampleReaderFactory.h"
 #include "utils/Base64Utils.h"
 #include "utils/CurlUtils.h"
+#include "utils/GUIUtils.h"
 #include "utils/StringUtils.h"
 #include "utils/UrlUtils.h"
 #include "utils/Utils.h"
@@ -59,7 +60,7 @@ void SESSION::CSession::DeleteStreams()
 |   initialize
 +---------------------------------------------------------------------*/
 
-bool SESSION::CSession::Initialize(std::string manifestUrl)
+SResult SESSION::CSession::Initialize(std::string manifestUrl)
 {
   m_reprChooser = CHOOSER::CreateRepresentationChooser();
 
@@ -100,7 +101,7 @@ bool SESSION::CSession::Initialize(std::string manifestUrl)
 
   CURL::HTTPResponse manifestResp;
   if (!CURL::DownloadFile(manifestUrl, manifestHeaders, {"etag", "last-modified"}, manifestResp))
-    return false;
+    return SResult::Error("Cannot download the manifest file.");
 
   // The download speed with small file sizes is not accurate, we should download at least 512Kb
   // to have a sufficient acceptable value to calculate the bandwidth,
@@ -115,15 +116,12 @@ bool SESSION::CSession::Initialize(std::string manifestUrl)
 
   m_adaptiveTree = PLAYLIST_FACTORY::CreateAdaptiveTree(manifestResp);
   if (!m_adaptiveTree)
-    return false;
+    return SResult::Error("Unable to determine type of manifest file.");
 
   m_adaptiveTree->Configure(m_reprChooser, kodiProps.GetManifestUpdParams());
 
   if (!m_adaptiveTree->Open(manifestResp.effectiveUrl, manifestResp.headers, manifestResp.data))
-  {
-    LOG::Log(LOGERROR, "Cannot parse the manifest (%s)", manifestUrl.c_str());
-    return false;
-  }
+    return SResult::Error("Cannot parse the manifest file.");
 
   m_adaptiveTree->PostOpen();
   m_reprChooser->PostInit();
@@ -132,7 +130,7 @@ bool SESSION::CSession::Initialize(std::string manifestUrl)
 
   InitializePeriod();
 
-  return true;
+  return SResultCode::OK;
 }
 
 bool SESSION::CSession::CheckPlayableStreams(PLAYLIST::CPeriod* period)
@@ -347,6 +345,13 @@ void SESSION::CSession::InitializePeriod()
       AddStream(adp.get(), defaultRepr, isDefaultAdpSet, uniqueId, audioLanguageOrig);
     }
   }
+
+  if (m_streams.empty())
+  {
+    LOG::LogF(LOGERROR,
+              "No stream can be played, common causes: resolution limits or HDCP problem");
+    GUI::ErrorDialog("No stream can be played");
+  }
 }
 
 void SESSION::CSession::AddStream(PLAYLIST::CAdaptationSet* adp,

src/Session.h

@@ -13,6 +13,7 @@
 #include "common/AdaptiveTree.h"
 #include "decrypters/DrmEngine.h"
 #include "decrypters/IDecrypter.h"
+#include "utils/ResultType.h"
 
 #if defined(ANDROID)
 #include <kodi/platform/android/System.h>
@@ -36,7 +37,7 @@ class ATTR_DLL_LOCAL CSession : public adaptive::AdaptiveStreamObserver
    *  \param manifestUrl The manifest URL
    *  \return True if has success, false otherwise
    */
-  bool Initialize(std::string manifestUrl);
+  SResult Initialize(std::string manifestUrl);
 
   bool CheckPlayableStreams(PLAYLIST::CPeriod* period);