Add HLS quality support (#134)

IvanStepanok · web-flow · commit ab942a406415 · 2023-11-06T12:55:01.000+02:00
* add HLS quality support

* update default localization

* Update VideoPlayerViewModelTests.swift

* change 360 quality localizations

* fix resolution changing logic

* rename the getVideoResolution function
diff --git a/Core/Core/Data/CoreStorage.swift b/Core/Core/Data/CoreStorage.swift
@@ -15,3 +15,14 @@ public protocol CoreStorage {
     var userSettings: UserSettings? {get set}
     func clear()
 }
+
+public struct CoreStorageMock: CoreStorage {
+    public var accessToken: String? = nil
+    public var refreshToken: String? = nil
+    public var cookiesDate: String? = nil
+    public var user: DataLayer.User? = nil
+    public var userSettings: UserSettings?  = nil
+    public func clear() {}
+    
+    public init() {}
+}
diff --git a/Core/Core/Data/Model/UserSettings.swift b/Core/Core/Data/Model/UserSettings.swift
@@ -9,15 +9,15 @@ import Foundation
 
 public struct UserSettings: Codable {
     public var wifiOnly: Bool
-    public var downloadQuality: VideoQuality
+    public var streamingQuality: StreamingQuality
     
-    public init(wifiOnly: Bool, downloadQuality: VideoQuality) {
+    public init(wifiOnly: Bool, streamingQuality: StreamingQuality) {
         self.wifiOnly = wifiOnly
-        self.downloadQuality = downloadQuality
+        self.streamingQuality = streamingQuality
     }
 }
 
-public enum VideoQuality: Codable {
+public enum StreamingQuality: Codable {
     case auto
     case low
     case medium
diff --git a/Course/Course/Presentation/Video/EncodedVideoPlayer.swift b/Course/Course/Presentation/Video/EncodedVideoPlayer.swift
@@ -60,6 +60,7 @@ public struct EncodedVideoPlayer: View {
                             PlayerViewController(
                                 videoURL: viewModel.url,
                                 controller: viewModel.controller,
+                                bitrate: viewModel.getVideoResolution(),
                                 progress: { progress in
                                     if progress >= 0.8 {
                                         if !isViewedOnce {
@@ -141,7 +142,8 @@ struct EncodedVideoPlayer_Previews: PreviewProvider {
                 languages: [],
                 playerStateSubject: CurrentValueSubject<VideoPlayerState?, Never>(nil),
                 interactor: CourseInteractor(repository: CourseRepositoryMock()),
-                router: CourseRouterMock(),
+                router: CourseRouterMock(), 
+                appStorage: CoreStorageMock(),
                 connectivity: Connectivity()
             ),
             isOnScreen: true
diff --git a/Course/Course/Presentation/Video/EncodedVideoPlayerViewModel.swift b/Course/Course/Presentation/Video/EncodedVideoPlayerViewModel.swift
@@ -24,6 +24,7 @@ public class EncodedVideoPlayerViewModel: VideoPlayerViewModel {
         playerStateSubject: CurrentValueSubject<VideoPlayerState?, Never>,
         interactor: CourseInteractorProtocol,
         router: CourseRouter,
+        appStorage: CoreStorage,
         connectivity: ConnectivityProtocol
     ) {
         self.url = url
@@ -32,7 +33,8 @@ public class EncodedVideoPlayerViewModel: VideoPlayerViewModel {
                    courseID: courseID,
                    languages: languages,
                    interactor: interactor,
-                   router: router,
+                   router: router, 
+                   appStorage: appStorage,
                    connectivity: connectivity)
         
         playerStateSubject.sink(receiveValue: { [weak self] state in
@@ -46,4 +48,19 @@ public class EncodedVideoPlayerViewModel: VideoPlayerViewModel {
             }
         }).store(in: &subscription)
     }
+    
+    func getVideoResolution() -> CGSize {
+        switch appStorage.userSettings?.streamingQuality {
+        case .auto:
+            return CGSize(width: 1280, height: 720)
+        case .low:
+            return CGSize(width: 640, height: 360)
+        case .medium:
+            return CGSize(width: 854, height: 480)
+        case .high:
+            return CGSize(width: 1280, height: 720)
+        case .none:
+            return CGSize(width: 1280, height: 720)
+        }
+    }
 }
diff --git a/Course/Course/Presentation/Video/PlayerViewController.swift b/Course/Course/Presentation/Video/PlayerViewController.swift
@@ -11,17 +11,21 @@ import _AVKit_SwiftUI
 struct PlayerViewController: UIViewControllerRepresentable {
     
     var videoURL: URL?
+    var videoResolution: CGSize
     var controller: AVPlayerViewController
     var progress: ((Float) -> Void)
     var seconds: ((Double) -> Void)
     
     init(
-        videoURL: URL?, controller: AVPlayerViewController,
+        videoURL: URL?, 
+        controller: AVPlayerViewController,
+        bitrate: CGSize,
         progress: @escaping ((Float) -> Void),
         seconds: @escaping ((Double) -> Void)
     ) {
         self.videoURL = videoURL
         self.controller = controller
+        self.videoResolution = bitrate
         self.progress = progress
         self.seconds = seconds
     }
@@ -76,6 +80,7 @@ struct PlayerViewController: UIViewControllerRepresentable {
                     playerController.player?.allowsExternalPlayback = true
                 }
                 playerController.player?.replaceCurrentItem(with: AVPlayerItem(url: videoURL!))
+                playerController.player?.currentItem?.preferredMaximumResolution = videoResolution
                 addPeriodicTimeObserver(playerController, currentProgress: { progress, seconds in
                     self.progress(progress)
                     self.seconds(seconds)
diff --git a/Course/Course/Presentation/Video/SubtittlesView.swift b/Course/Course/Presentation/Video/SubtittlesView.swift
@@ -120,7 +120,8 @@ struct SubtittlesView_Previews: PreviewProvider {
                 blockID: "", courseID: "",
                 languages: [],
                 interactor: CourseInteractor(repository: CourseRepositoryMock()),
-                router: CourseRouterMock(),
+                router: CourseRouterMock(), 
+                appStorage: CoreStorageMock(),
                 connectivity: Connectivity()
             ), scrollTo: {_ in }
         )
diff --git a/Course/Course/Presentation/Video/VideoPlayerViewModel.swift b/Course/Course/Presentation/Video/VideoPlayerViewModel.swift
@@ -17,6 +17,7 @@ public class VideoPlayerViewModel: ObservableObject {
     private let interactor: CourseInteractorProtocol
     public let connectivity: ConnectivityProtocol
     public let router: CourseRouter
+    public let appStorage: CoreStorage
     
     private var subtitlesDownloaded: Bool = false
     @Published var subtitles: [Subtitle] = []
@@ -37,13 +38,15 @@ public class VideoPlayerViewModel: ObservableObject {
         languages: [SubtitleUrl],
         interactor: CourseInteractorProtocol,
         router: CourseRouter,
+        appStorage: CoreStorage,
         connectivity: ConnectivityProtocol
     ) {
         self.blockID = blockID
         self.courseID = courseID
         self.languages = languages
         self.interactor = interactor
         self.router = router
+        self.appStorage = appStorage
         self.connectivity = connectivity
         self.prepareLanguages()
     }
diff --git a/Course/Course/Presentation/Video/YouTubeVideoPlayer.swift b/Course/Course/Presentation/Video/YouTubeVideoPlayer.swift
@@ -88,7 +88,8 @@ struct YouTubeVideoPlayer_Previews: PreviewProvider {
                 languages: [],
                 playerStateSubject: CurrentValueSubject<VideoPlayerState?, Never>(nil),
                 interactor: CourseInteractor(repository: CourseRepositoryMock()),
-                router: CourseRouterMock(),
+                router: CourseRouterMock(), 
+                appStorage: CoreStorageMock(),
                 connectivity: Connectivity()),
             isOnScreen: true)
     }
diff --git a/Course/Course/Presentation/Video/YouTubeVideoPlayerViewModel.swift b/Course/Course/Presentation/Video/YouTubeVideoPlayerViewModel.swift
@@ -32,6 +32,7 @@ public class YouTubeVideoPlayerViewModel: VideoPlayerViewModel {
         playerStateSubject: CurrentValueSubject<VideoPlayerState?, Never>,
         interactor: CourseInteractorProtocol,
         router: CourseRouter,
+        appStorage: CoreStorage,
         connectivity: ConnectivityProtocol
     ) {
         self.url = url
@@ -61,6 +62,7 @@ public class YouTubeVideoPlayerViewModel: VideoPlayerViewModel {
             languages: languages,
             interactor: interactor,
             router: router,
+            appStorage: appStorage,
             connectivity: connectivity
         )
         
diff --git a/Course/CourseTests/Presentation/Unit/VideoPlayerViewModelTests.swift b/Course/CourseTests/Presentation/Unit/VideoPlayerViewModelTests.swift
@@ -37,7 +37,8 @@ final class VideoPlayerViewModelTests: XCTestCase {
                                              courseID: "",
                                              languages: [],
                                              interactor: interactor,
-                                             router: router,
+                                             router: router, 
+                                             appStorage: CoreStorageMock(),
                                              connectivity: connectivity)
         
         await viewModel.getSubtitles(subtitlesUrl: "url")
@@ -64,6 +65,7 @@ final class VideoPlayerViewModelTests: XCTestCase {
                                              languages: [],
                                              interactor: interactor,
                                              router: router,
+                                             appStorage: CoreStorageMock(),
                                              connectivity: connectivity)
         
         await viewModel.getSubtitles(subtitlesUrl: "url")
@@ -85,6 +87,7 @@ final class VideoPlayerViewModelTests: XCTestCase {
                                              languages: [],
                                              interactor: interactor,
                                              router: router,
+                                             appStorage: CoreStorageMock(),
                                              connectivity: connectivity)
         
         viewModel.languages = [
@@ -112,6 +115,7 @@ final class VideoPlayerViewModelTests: XCTestCase {
                                              languages: [],
                                              interactor: interactor,
                                              router: router,
+                                             appStorage: CoreStorageMock(),
                                              connectivity: connectivity)
         
         Given(interactor, .blockCompletionRequest(courseID: .any, blockID: .any, willProduce: {_ in}))
@@ -131,6 +135,7 @@ final class VideoPlayerViewModelTests: XCTestCase {
                                              languages: [],
                                              interactor: interactor,
                                              router: router,
+                                             appStorage: CoreStorageMock(),
                                              connectivity: connectivity)
         
         Given(interactor, .blockCompletionRequest(courseID: .any, blockID: .any, willThrow: NSError()))
@@ -155,6 +160,7 @@ final class VideoPlayerViewModelTests: XCTestCase {
                                              languages: [],
                                              interactor: interactor,
                                              router: router,
+                                             appStorage: CoreStorageMock(),
                                              connectivity: connectivity)
         
         Given(interactor, .blockCompletionRequest(courseID: .any, blockID: .any, willThrow: noInternetError))
diff --git a/OpenEdX/DI/ScreenAssembly.swift b/OpenEdX/DI/ScreenAssembly.swift
@@ -281,6 +281,7 @@ class ScreenAssembly: Assembly {
                 playerStateSubject: playerStateSubject,
                 interactor: r.resolve(CourseInteractorProtocol.self)!,
                 router: r.resolve(CourseRouter.self)!,
+                appStorage: r.resolve(CoreStorage.self)!,
                 connectivity: r.resolve(ConnectivityProtocol.self)!
             )
         }
@@ -295,7 +296,8 @@ class ScreenAssembly: Assembly {
                 languages: languages,
                 playerStateSubject: playerStateSubject,
                 interactor: r.resolve(CourseInteractorProtocol.self)!,
-                router: r.resolve(CourseRouter.self)!,
+                router: r.resolve(CourseRouter.self)!, 
+                appStorage: r.resolve(CoreStorage.self)!,
                 connectivity: r.resolve(ConnectivityProtocol.self)!
             )
         }
diff --git a/OpenEdX/Data/AppStorage.swift b/OpenEdX/Data/AppStorage.swift
@@ -95,7 +95,7 @@ public class AppStorage: CoreStorage, ProfileStorage, WhatsNewStorage {
     public var userSettings: UserSettings? {
         get {
             guard let userSettings = userDefaults.data(forKey: KEY_SETTINGS) else {
-                let defaultSettings = UserSettings(wifiOnly: true, downloadQuality: .auto)
+                let defaultSettings = UserSettings(wifiOnly: true, streamingQuality: .auto)
                 let encoder = JSONEncoder()
                 if let encoded = try? encoder.encode(defaultSettings) {
                     userDefaults.set(encoded, forKey: KEY_SETTINGS)
diff --git a/Profile/Profile/Data/ProfileRepository.swift b/Profile/Profile/Data/ProfileRepository.swift
@@ -144,7 +144,7 @@ public class ProfileRepository: ProfileRepositoryProtocol {
         if let userSettings = storage.userSettings {
             return userSettings
         } else {
-            return UserSettings(wifiOnly: true, downloadQuality: VideoQuality.auto)
+            return UserSettings(wifiOnly: true, streamingQuality: StreamingQuality.auto)
         }
     }
     
@@ -233,7 +233,7 @@ class ProfileRepositoryMock: ProfileRepositoryProtocol {
     public func deleteAccount(password: String) async throws -> Bool { return false }
     
     public func getSettings() -> UserSettings {
-        return UserSettings(wifiOnly: true, downloadQuality: .auto)
+        return UserSettings(wifiOnly: true, streamingQuality: .auto)
     }
     public func saveSettings(_ settings: UserSettings) {}
 }
diff --git a/Profile/Profile/Presentation/Settings/SettingsViewModel.swift b/Profile/Profile/Presentation/Settings/SettingsViewModel.swift
@@ -22,15 +22,15 @@ public class SettingsViewModel: ObservableObject {
         }
     }
     
-    @Published var selectedQuality: VideoQuality {
+    @Published var selectedQuality: StreamingQuality {
         willSet {
             if newValue != selectedQuality {
-                userSettings.downloadQuality = newValue
+                userSettings.streamingQuality = newValue
                 interactor.saveSettings(userSettings)
             }
         }
     }
-    let quality = Array([VideoQuality.auto, VideoQuality.low, VideoQuality.medium, VideoQuality.high].enumerated())
+    let quality = Array([StreamingQuality.auto, StreamingQuality.low, StreamingQuality.medium, StreamingQuality.high].enumerated())
     
     var errorMessage: String? {
         didSet {
@@ -51,11 +51,11 @@ public class SettingsViewModel: ObservableObject {
         
         self.userSettings = interactor.getSettings()
         self.wifiOnly = userSettings.wifiOnly
-        self.selectedQuality = userSettings.downloadQuality
+        self.selectedQuality = userSettings.streamingQuality
     }
 }
 
-extension VideoQuality {
+extension StreamingQuality {
     
     func title() -> String {
         switch self {
diff --git a/Profile/Profile/SwiftGen/Strings.swift b/Profile/Profile/SwiftGen/Strings.swift
@@ -104,8 +104,8 @@ public enum ProfileLocalization {
     public static let title = ProfileLocalization.tr("Localizable", "LOGOUT_ALERT.TITLE", fallback: "Comfirm log out")
   }
   public enum Settings {
-    /// Smallest video quality
-    public static let quality360Description = ProfileLocalization.tr("Localizable", "SETTINGS.QUALITY_360_DESCRIPTION", fallback: "Smallest video quality")
+    /// Lower data usage
+    public static let quality360Description = ProfileLocalization.tr("Localizable", "SETTINGS.QUALITY_360_DESCRIPTION", fallback: "Lower data usage")
     /// 360p
     public static let quality360Title = ProfileLocalization.tr("Localizable", "SETTINGS.QUALITY_360_TITLE", fallback: "360p")
     /// 540p
@@ -128,8 +128,8 @@ public enum ProfileLocalization {
     public static let version = ProfileLocalization.tr("Localizable", "SETTINGS.VERSION", fallback: "Version:")
     /// Auto (Recommended)
     public static let videoQualityDescription = ProfileLocalization.tr("Localizable", "SETTINGS.VIDEO_QUALITY_DESCRIPTION", fallback: "Auto (Recommended)")
-    /// Video download quality
-    public static let videoQualityTitle = ProfileLocalization.tr("Localizable", "SETTINGS.VIDEO_QUALITY_TITLE", fallback: "Video download quality")
+    /// Video streaming quality
+    public static let videoQualityTitle = ProfileLocalization.tr("Localizable", "SETTINGS.VIDEO_QUALITY_TITLE", fallback: "Video streaming quality")
     /// Video settings
     public static let videoSettingsTitle = ProfileLocalization.tr("Localizable", "SETTINGS.VIDEO_SETTINGS_TITLE", fallback: "Video settings")
     /// Only download content when wi-fi is turned on
diff --git a/Profile/Profile/en.lproj/Localizable.strings b/Profile/Profile/en.lproj/Localizable.strings
@@ -58,13 +58,13 @@
 "SETTINGS.VIDEO_SETTINGS_TITLE" = "Video settings";
 "SETTINGS.WIFI_TITLE" = "Wi-fi only download";
 "SETTINGS.WIFI_DESCRIPTION" = "Only download content when wi-fi is turned on";
-"SETTINGS.VIDEO_QUALITY_TITLE" = "Video download quality";
+"SETTINGS.VIDEO_QUALITY_TITLE" = "Video streaming quality";
 "SETTINGS.VIDEO_QUALITY_DESCRIPTION" = "Auto (Recommended)";
 
 "SETTINGS.QUALITY_AUTO_TITLE" = "Auto";
 "SETTINGS.QUALITY_AUTO_DESCRIPTION" = "Recommended";
 "SETTINGS.QUALITY_360_TITLE" = "360p";
-"SETTINGS.QUALITY_360_DESCRIPTION" = "Smallest video quality";
+"SETTINGS.QUALITY_360_DESCRIPTION" = "Lower data usage";
 "SETTINGS.QUALITY_540_TITLE" = "540p";
 "SETTINGS.QUALITY_720_TITLE" = "720p";
 "SETTINGS.QUALITY_720_DESCRIPTION" = "Best quality";
diff --git a/Profile/Profile/uk.lproj/Localizable.strings b/Profile/Profile/uk.lproj/Localizable.strings
@@ -58,13 +58,13 @@
 "SETTINGS.VIDEO_SETTINGS_TITLE" = "Налаштування відео";
 "SETTINGS.WIFI_TITLE" = "Тільки Wi-fi";
 "SETTINGS.WIFI_DESCRIPTION" = "Завантажувати відео, лише коли Wi-Fi увімкнено";
-"SETTINGS.VIDEO_QUALITY_TITLE" = "Якість відео";
+"SETTINGS.VIDEO_QUALITY_TITLE" = "Якість потокового відео";
 "SETTINGS.VIDEO_QUALITY_DESCRIPTION" = "Авто (Рекомендовано)";
 
 "SETTINGS.QUALITY_AUTO_TITLE" = "Авто";
 "SETTINGS.QUALITY_AUTO_DESCRIPTION" = "Рекомендовано";
 "SETTINGS.QUALITY_360_TITLE" = "360p";
-"SETTINGS.QUALITY_360_DESCRIPTION" = "Найменша якість відео";
+"SETTINGS.QUALITY_360_DESCRIPTION" = "економія трафіку";
 "SETTINGS.QUALITY_540_TITLE" = "540p";
 "SETTINGS.QUALITY_720_TITLE" = "720p";
 "SETTINGS.QUALITY_AUTO_DESCRIPTION" = "Найкраща якість";

Original file line number	Diff line number	Diff line change
`@@ -281,6 +281,7 @@ class ScreenAssembly: Assembly {`
`281`	`281`	`playerStateSubject: playerStateSubject,`
`282`	`282`	`interactor: r.resolve(CourseInteractorProtocol.self)!,`
`283`	`283`	`router: r.resolve(CourseRouter.self)!,`
	`284`	`+ appStorage: r.resolve(CoreStorage.self)!,`
`284`	`285`	`connectivity: r.resolve(ConnectivityProtocol.self)!`
`285`	`286`	`)`
`286`	`287`	`}`
`@@ -295,7 +296,8 @@ class ScreenAssembly: Assembly {`
`295`	`296`	`languages: languages,`
`296`	`297`	`playerStateSubject: playerStateSubject,`
`297`	`298`	`interactor: r.resolve(CourseInteractorProtocol.self)!,`
`298`		`- router: r.resolve(CourseRouter.self)!,`
	`299`	`+ router: r.resolve(CourseRouter.self)!,`
	`300`	`+ appStorage: r.resolve(CoreStorage.self)!,`
`299`	`301`	`connectivity: r.resolve(ConnectivityProtocol.self)!`
`300`	`302`	`)`
`301`	`303`	`}`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ public class ProfileRepository: ProfileRepositoryProtocol {`
`144`	`144`	`if let userSettings = storage.userSettings {`
`145`	`145`	`return userSettings`
`146`	`146`	`} else {`
`147`		`- return UserSettings(wifiOnly: true, downloadQuality: VideoQuality.auto)`
	`147`	`+ return UserSettings(wifiOnly: true, streamingQuality: StreamingQuality.auto)`
`148`	`148`	`}`
`149`	`149`	`}`
`150`	`150`
`@@ -233,7 +233,7 @@ class ProfileRepositoryMock: ProfileRepositoryProtocol {`
`233`	`233`	`public func deleteAccount(password: String) async throws -> Bool { return false }`
`234`	`234`
`235`	`235`	`public func getSettings() -> UserSettings {`
`236`		`- return UserSettings(wifiOnly: true, downloadQuality: .auto)`
	`236`	`+ return UserSettings(wifiOnly: true, streamingQuality: .auto)`
`237`	`237`	`}`
`238`	`238`	`public func saveSettings(_ settings: UserSettings) {}`
`239`	`239`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,15 +22,15 @@ public class SettingsViewModel: ObservableObject {`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`
`25`		`- @Published var selectedQuality: VideoQuality {`
	`25`	`+ @Published var selectedQuality: StreamingQuality {`
`26`	`26`	`willSet {`
`27`	`27`	`if newValue != selectedQuality {`
`28`		`- userSettings.downloadQuality = newValue`
	`28`	`+ userSettings.streamingQuality = newValue`
`29`	`29`	`interactor.saveSettings(userSettings)`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`	`}`
`33`		`- let quality = Array([VideoQuality.auto, VideoQuality.low, VideoQuality.medium, VideoQuality.high].enumerated())`
	`33`	`+ let quality = Array([StreamingQuality.auto, StreamingQuality.low, StreamingQuality.medium, StreamingQuality.high].enumerated())`
`34`	`34`
`35`	`35`	`var errorMessage: String? {`
`36`	`36`	`didSet {`
`@@ -51,11 +51,11 @@ public class SettingsViewModel: ObservableObject {`
`51`	`51`
`52`	`52`	`self.userSettings = interactor.getSettings()`
`53`	`53`	`self.wifiOnly = userSettings.wifiOnly`
`54`		`- self.selectedQuality = userSettings.downloadQuality`
	`54`	`+ self.selectedQuality = userSettings.streamingQuality`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`
`58`		`-extension VideoQuality {`
	`58`	`+extension StreamingQuality {`
`59`	`59`
`60`	`60`	`func title() -> String {`
`61`	`61`	`switch self {`