Merge pull request #1824 from CastagnaIT/stream_selection_fixes

Fix regressions and improvements to stream selection

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/Session.cpp

@@ -304,8 +304,12 @@ void SESSION::CSession::InitializePeriod()
     else
       isManualStreamSelection = streamSelectionMode == CHOOSER::StreamSelection::MANUAL;
 
+    const bool isDefaultAdpSet{adp == defVideoAdpSet};
+
     // Get the default initial stream repr. based on "adaptive repr. chooser"
     CRepresentation* defaultRepr{m_reprChooser->GetRepresentation(adp)};
+    if (isDefaultAdpSet)
+      m_reprChooser->LogDetails(defaultRepr);
 
     if (isManualStreamSelection)
     {
@@ -320,9 +324,9 @@ void SESSION::CSession::InitializePeriod()
         if (!currentRepr->isPlayable)
           continue;
 
-        const bool isDefaultRepr{adp == defVideoAdpSet && currentRepr == defaultRepr}; // meant for video only
+        const bool isDefaultVideoRepr{isDefaultAdpSet && currentRepr == defaultRepr};
 
-        AddStream(adp, currentRepr, isDefaultRepr, uniqueId, audioLanguageOrig);
+        AddStream(adp, currentRepr, isDefaultVideoRepr, uniqueId, audioLanguageOrig);
       }
     }
     else
@@ -335,16 +339,14 @@ void SESSION::CSession::InitializePeriod()
       uint32_t uniqueId{adpIndex};
       uniqueId |= reprIndex << 16;
 
-      const bool isDefaultRepr{adp == defVideoAdpSet}; // meant for video only
-
-      AddStream(adp, defaultRepr, isDefaultRepr, uniqueId, audioLanguageOrig);
+      AddStream(adp, defaultRepr, isDefaultAdpSet, uniqueId, audioLanguageOrig);
     }
   }
 }
 
 void SESSION::CSession::AddStream(PLAYLIST::CAdaptationSet* adp,
                                   PLAYLIST::CRepresentation* initialRepr,
-                                  bool isDefaultRepr,
+                                  bool isDefaultVideoRepr,
                                   uint32_t uniqueId,
                                   std::string_view audioLanguageOrig)
 {
@@ -360,7 +362,7 @@ void SESSION::CSession::AddStream(PLAYLIST::CAdaptationSet* adp,
     case StreamType::VIDEO:
     {
       stream.m_info.SetStreamType(INPUTSTREAM_TYPE_VIDEO);
-      if (isDefaultRepr)
+      if (isDefaultVideoRepr)
         flags |= INPUTSTREAM_FLAG_DEFAULT;
       break;
     }
@@ -1180,6 +1182,8 @@ PLAYLIST::CAdaptationSet* SESSION::CSession::DetermineDefaultAdpSet()
       CODEC::FOURCC_HEVC, CODEC::FOURCC_AV01, CODEC::NAME_AV1,    CODEC::FOURCC_VP09,
       CODEC::NAME_VP9,    CODEC::FOURCC_AVC_, CODEC::FOURCC_H264};
 
+  CAdaptationSet* defaultAdp{nullptr}; // Default determined by codec order
+
   for (auto& codecCC : videoCodecOrder)
   {
     CAdaptationSet* currAdp{nullptr};
@@ -1189,10 +1193,16 @@ PLAYLIST::CAdaptationSet* SESSION::CSession::DetermineDefaultAdpSet()
       if (currAdp->GetRepresentations().empty() || currAdp->GetStreamType() != StreamType::VIDEO)
         continue;
 
-      if (CODEC::Contains(currAdp->GetCodecs(), codecCC))
+      if (currAdp->IsDefault()) // Override by manifest custom parameter
+      {
         return currAdp;
+      }
+      else if (CODEC::Contains(currAdp->GetCodecs(), codecCC) && !defaultAdp)
+      {
+        defaultAdp = currAdp;
+      }
     }
   }
 
-  return nullptr;
+  return defaultAdp;
 }

src/Session.h

@@ -57,12 +57,12 @@ class ATTR_DLL_LOCAL CSession : public adaptive::AdaptiveStreamObserver
   /*! \brief Create and push back a new Stream object
    *  \param adp The AdaptationSet of the stream
    *  \param repr The Representation of the stream
-   *  \param isDefaultRepr Whether this Representation is the default
+   *  \param isDefaultVideoRepr Whether this video Representation is the default
    *  \param uniqueId A unique identifier for the Representation
    */
   void AddStream(PLAYLIST::CAdaptationSet* adp,
                  PLAYLIST::CRepresentation* repr,
-                 bool isDefaultRepr,
+                 bool isDefaultVideoRepr,
                  uint32_t uniqueId,
                  std::string_view audioLanguageOrig);
 

src/common/Chooser.cpp

@@ -114,8 +114,13 @@ void CHOOSER::IRepresentationChooser::OnUpdateScreenRes()
   }
 }
 
-void CHOOSER::IRepresentationChooser::LogDetails(PLAYLIST::CRepresentation* currentRep,
-                                                 PLAYLIST::CRepresentation* nextRep)
+void CHOOSER::IRepresentationChooser::LogDetails(const PLAYLIST::CRepresentation* rep)
+{
+  LogDetails(nullptr, rep);
+}
+
+void CHOOSER::IRepresentationChooser::LogDetails(const PLAYLIST::CRepresentation* currentRep,
+                                                 const PLAYLIST::CRepresentation* nextRep)
 {
   if (!nextRep)
     return;

src/common/Chooser.h

@@ -121,12 +121,17 @@ class ATTR_DLL_LOCAL IRepresentationChooser
       PLAYLIST::CAdaptationSet* adp,
       PLAYLIST::CRepresentation* currentRep) = 0;
 
+  /*!
+   * \brief Prints details of the specified representation in the log
+   */
+  void LogDetails(const PLAYLIST::CRepresentation* rep);
+
 protected:
   /*!
    * \brief Prints details of the selected or changed representation in the log
    */
-  void LogDetails(PLAYLIST::CRepresentation* currentRep,
-                  PLAYLIST::CRepresentation* nextRep);
+  void LogDetails(const PLAYLIST::CRepresentation* currentRep,
+                  const PLAYLIST::CRepresentation* nextRep);
 
   bool m_isSecureSession{false};