[ChooserAskQuality] Add new range resolution limit setting

Author: CastagnaIT

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

@@ -164,7 +164,14 @@ msgctxt "#30171"
 msgid "Defines the initial bandwidth when it cannot be automatically determined. This value can be overridden by the minimum bandwidth setting."
 msgstr ""
 
-#empty strings from id 30171 to 30173
+msgctxt "#30172"
+msgid "Resolution limit"
+msgstr ""
+
+#. Description of setting with label #30172
+msgctxt "#30173"
+msgid "If set, based on the capabilities of the video stream an attempt will be made to limit the range of resolutions to the one chosen."
+msgstr ""
 
 #. To set the stream selection type (refer to RepresentationChooser's)
 msgctxt "#30174"
@@ -228,44 +235,49 @@ msgctxt "#30204"
 msgid "Decrypter path"
 msgstr ""
 
-#empty strings from id 30205 to 30209
+#empty strings from id 30205 to 30208
+
+#. Item list value of setting with label #30172
+msgctxt "#30209"
+msgid "Disabled"
+msgstr ""
 
 #. Item list value of setting with label #30110, #30113
 msgctxt "#30210"
 msgid "Auto"
 msgstr ""
 
-#. Item list value of setting with label #30110, #30113
+#. Item list value of setting with label #30110, #30113, #30172
 msgctxt "#30211"
 msgid "480p"
 msgstr ""
 
-#. Item list value of setting with label #30110, #30113
+#. Item list value of setting with label #30110, #30113, #30172
 msgctxt "#30212"
 msgid "640p"
 msgstr ""
 
-#. Item list value of setting with label #30110, #30113
+#. Item list value of setting with label #30110, #30113, #30172
 msgctxt "#30213"
 msgid "720p"
 msgstr ""
 
-#. Item list value of setting with label #30110, #30113
+#. Item list value of setting with label #30110, #30113, #30172
 msgctxt "#30214"
 msgid "1080p"
 msgstr ""
 
-#. Item list value of setting with label #30110, #30113
+#. Item list value of setting with label #30110, #30113, #30172
 msgctxt "#30215"
 msgid "2K"
 msgstr ""
 
-#. Item list value of setting with label #30110, #30113
+#. Item list value of setting with label #30110, #30113, #30172
 msgctxt "#30216"
 msgid "1440p"
 msgstr ""
 
-#. Item list value of setting with label #30110, #30113
+#. Item list value of setting with label #30110, #30113, #30172
 msgctxt "#30217"
 msgid "4K"
 msgstr ""

inputstream.adaptive/resources/settings.xml.in

@@ -69,6 +69,30 @@
           </dependencies>
           <control type="spinner" format="string" />
         </setting>
+        <setting parent="adaptivestream.type" id="adaptivestream.res.rangelimit" type="string" label="30172" help="30173">
+          <level>0</level>
+          <default>disabled</default>
+          <constraints>
+            <options>
+              <option label="30209">disabled</option>
+              <option label="30211">480p</option>
+              <option label="30212">640p</option>
+              <option label="30213">720p</option>
+              <option label="30214">1080p</option>
+              <option label="30215">2K</option>
+              <option label="30216">1440p</option>
+              <option label="30217">4K</option>
+            </options>
+          </constraints>
+          <dependencies>
+            <dependency type="visible">
+              <or>
+                <condition setting="adaptivestream.type">ask-quality</condition>
+              </or>
+            </dependency>
+          </dependencies>
+          <control type="spinner" format="string" />
+        </setting>
         <setting parent="adaptivestream.type" id="adaptivestream.bandwidth.init.auto" type="boolean" label="30168" help="30169">
           <level>0</level>
           <default>true</default>

src/CompSettings.cpp

@@ -55,6 +55,16 @@ std::pair<int, int> ADP::SETTINGS::CCompSettings::GetResSecureMax() const
   return val;
 }
 
+std::pair<int, int> ADP::SETTINGS::CCompSettings::GetResRangeLimit() const
+{
+  std::pair<int, int> val;
+  if (!STRING::GetMapValue(RES_CONV_LIST,
+                           kodi::addon::GetSettingString("adaptivestream.res.rangelimit"), val))
+    LOG::Log(LOGERROR, "Unknown value for \"adaptivestream.res.rangelimit\" setting");
+
+  return val;
+}
+
 bool ADP::SETTINGS::CCompSettings::IsBandwidthInitAuto() const
 {
   return kodi::addon::GetSettingBoolean("adaptivestream.bandwidth.init.auto");

src/CompSettings.h

@@ -26,8 +26,9 @@ namespace SETTINGS
 // Generic conversion map from family of resolutions to a common pixel format.
 // If modified, the changes should reflect XML settings and Kodi properties related to resolutions.
 const std::map<std::string, std::pair<int, int>> RES_CONV_LIST{
-    {"auto", {0, 0}},        {"480p", {640, 480}}, {"640p", {960, 640}},    {"720p", {1280, 720}},
-    {"1080p", {1920, 1080}}, {"2K", {2048, 1080}}, {"1440p", {2560, 1440}}, {"4K", {3840, 2160}}};
+    {"disabled", {0, 0}}, {"auto", {0, 0}},        {"480p", {640, 480}},
+    {"640p", {960, 640}}, {"720p", {1280, 720}},   {"1080p", {1920, 1080}},
+    {"2K", {2048, 1080}}, {"1440p", {2560, 1440}}, {"4K", {3840, 2160}}};
 
 enum class StreamSelMode
 {
@@ -50,6 +51,7 @@ class ATTR_DLL_LOCAL CCompSettings
 
   std::pair<int, int> GetResMax() const;
   std::pair<int, int> GetResSecureMax() const;
+  std::pair<int, int> GetResRangeLimit() const;
 
   bool IsBandwidthInitAuto() const;
   uint32_t GetBandwidthInit() const;

src/common/ChooserAskQuality.cpp

@@ -9,6 +9,7 @@
 #include "ChooserAskQuality.h"
 
 #include "AdaptationSet.h"
+#include "CompSettings.h"
 #include "CompKodiProps.h"
 #include "ReprSelector.h"
 #include "Representation.h"
@@ -44,6 +45,27 @@ std::string CovertFpsToString(float value)
 
   return str;
 }
+
+std::string CreateStreamName(const CRepresentation* repr)
+{
+  std::string streamName{kodi::addon::GetLocalizedString(30232)};
+  STRING::ReplaceFirst(streamName, "{codec}", CODEC::GetVideoDesc(repr->GetCodecs()));
+
+  float fps{static_cast<float>(repr->GetFrameRate())};
+  if (fps > 0 && repr->GetFrameRateScale() > 0)
+    fps /= repr->GetFrameRateScale();
+
+  std::string quality = "(";
+  if (repr->GetWidth() > 0 && repr->GetHeight() > 0)
+    quality += StringUtils::Format("%ix%i, ", repr->GetWidth(), repr->GetHeight());
+  if (fps > 0)
+    quality += StringUtils::Format("%s fps, ", CovertFpsToString(fps).c_str());
+
+  quality += StringUtils::Format("%u Kbps)", repr->GetBandwidth() / 1000);
+  STRING::ReplaceFirst(streamName, "{quality}", quality);
+
+  return streamName;
+}
 } // unnamed namespace
 
 CRepresentationChooserAskQuality::CRepresentationChooserAskQuality()
@@ -53,6 +75,13 @@ CRepresentationChooserAskQuality::CRepresentationChooserAskQuality()
 
 void CRepresentationChooserAskQuality::Initialize(const ADP::KODI_PROPS::ChooserProps& props)
 {
+  auto& settings = CSrvBroker::GetSettings();
+  m_resRangeLimit = settings.GetResRangeLimit();
+
+  LOG::Log(LOGDEBUG,
+           "[Repr. chooser] Configuration\n"
+           "Resolution range limit: %ix%i",
+           m_resRangeLimit.first, m_resRangeLimit.second);
 }
 
 void CRepresentationChooserAskQuality::PostInit()
@@ -94,40 +123,41 @@ PLAYLIST::CAdaptationSet* CHOOSER::CRepresentationChooserAskQuality::GetPreferre
       if (adpSet->GetStreamType() != StreamType::VIDEO || adpSet->GetRepresentations().size() == 0)
         continue;
 
-      CRepresentation* bestRep{nullptr};
-
-      // preferred adaptation set, in order to have a preferred codec for multi-codec manifests
-      if (adpSetPreferred == adpSet.get())
+      if (m_resRangeLimit.first != 0) // Show only the nearest resolution to the preference
       {
-        bestRep = selector.Highest(adpSetPreferred);
-      }
+        CRepresentationSelector selector{m_resRangeLimit.first, m_resRangeLimit.second};
+        CRepresentation* nearestRep = selector.Nearest(adpSet.get());
 
-      for (auto& repr : adpSet->GetRepresentations())
-      {
-        if (!repr->isPlayable)
-          continue;
+        if (nearestRep)
+        {
+          entries.emplace_back(CreateStreamName(nearestRep));
+          entriesOjb.emplace_back(adpSet.get(), nearestRep);
 
-        std::string entryName{kodi::addon::GetLocalizedString(30232)};
-        STRING::ReplaceFirst(entryName, "{codec}", CODEC::GetVideoDesc(repr->GetCodecs()));
-
-        float fps{static_cast<float>(repr->GetFrameRate())};
-        if (fps > 0 && repr->GetFrameRateScale() > 0)
-          fps /= repr->GetFrameRateScale();
+          if (adpSet.get() == adpSetPreferred)
+            preselIndex = static_cast<int>(entries.size()) - 1;
+        }
+      }
+      else // Show all resolutions
+      {
+        CRepresentation* bestRep{nullptr};
 
-        std::string quality = "(";
-        if (repr->GetWidth() > 0 && repr->GetHeight() > 0)
-          quality += StringUtils::Format("%ix%i, ", repr->GetWidth(), repr->GetHeight());
-        if (fps > 0)
-          quality += StringUtils::Format("%s fps, ", CovertFpsToString(fps).c_str());
+        // preferred adaptation set, in order to have a preferred codec for multi-codec manifests
+        if (adpSetPreferred == adpSet.get())
+        {
+          bestRep = selector.Highest(adpSetPreferred);
+        }
 
-        quality += StringUtils::Format("%u Kbps)", repr->GetBandwidth() / 1000);
-        STRING::ReplaceFirst(entryName, "{quality}", quality);
+        for (auto& repr : adpSet->GetRepresentations())
+        {
+          if (!repr->isPlayable)
+            continue;
 
-        entries.emplace_back(entryName);
+        entries.emplace_back(CreateStreamName(repr.get()));
         entriesOjb.emplace_back(adpSet.get(), repr.get());
 
         if (repr.get() == bestRep)
           preselIndex = static_cast<int>(entries.size()) - 1;
+        }
       }
     }
 

src/common/ChooserAskQuality.h

@@ -33,6 +33,7 @@ class ATTR_DLL_LOCAL CRepresentationChooserAskQuality : public IRepresentationCh
 
 private:
   bool m_isDialogShown{false};
+  std::pair<int, int> m_resRangeLimit;
   int m_selectedResWidth{0};
   int m_selectedResHeight{0};
   uint32_t m_selectedBandwidth{0};