MediaLibraryService.swift 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477
  1. /*****************************************************************************
  2. * MediaLibraryService.swift
  3. * VLC for iOS
  4. *****************************************************************************
  5. * Copyright © 2018 VideoLAN. All rights reserved.
  6. * Copyright © 2018 Videolabs
  7. *
  8. * Authors: Soomin Lee <bubu # mikan.io>
  9. *
  10. * Refer to the COPYING file of the official project for license.
  11. *****************************************************************************/
  12. // MARK: - Notification names
  13. extension Notification.Name {
  14. static let VLCNewFileAddedNotification = Notification.Name("NewFileAddedNotification")
  15. }
  16. // For objc
  17. extension NSNotification {
  18. @objc static let VLCNewFileAddedNotification = Notification.Name.VLCNewFileAddedNotification
  19. }
  20. // MARK: -
  21. @objc protocol MediaLibraryObserver: class {
  22. // Video
  23. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  24. didModifyVideo video: [VLCMLMedia])
  25. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  26. didDeleteMediaWithIds ids: [NSNumber])
  27. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  28. didAddVideos videos: [VLCMLMedia])
  29. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  30. didAddShowEpisodes showEpisodes: [VLCMLMedia])
  31. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  32. thumbnailReady media: VLCMLMedia)
  33. // Audio
  34. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  35. didAddAudios audios: [VLCMLMedia])
  36. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  37. didAddArtists artists: [VLCMLArtist])
  38. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  39. didDeleteArtistsWithIds artistsIds: [NSNumber])
  40. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  41. didAddAlbums albums: [VLCMLAlbum])
  42. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  43. didDeleteAlbumsWithIds albumsIds: [NSNumber])
  44. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  45. didAddAlbumTracks albumTracks: [VLCMLMedia])
  46. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  47. didAddGenres genres: [VLCMLGenre])
  48. // Playlist
  49. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  50. didAddPlaylists playlists: [VLCMLPlaylist])
  51. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  52. didDeletePlaylistsWithIds playlistsIds: [NSNumber])
  53. }
  54. // MARK: -
  55. protocol MediaLibraryMigrationDelegate: class {
  56. func medialibraryDidStartMigration(_ medialibrary: MediaLibraryService)
  57. func medialibraryDidFinishMigration(_ medialibrary: MediaLibraryService)
  58. func medialibraryDidStopMigration(_ medialibrary: MediaLibraryService)
  59. }
  60. // MARK: -
  61. class MediaLibraryService: NSObject {
  62. private static let databaseName: String = "medialibrary.db"
  63. private static let migrationKey: String = "MigratedToVLCMediaLibraryKit"
  64. private var didMigrate = UserDefaults.standard.bool(forKey: MediaLibraryService.migrationKey)
  65. private var didFinishDiscovery = false
  66. // Using ObjectIdentifier to avoid duplication and facilitate
  67. // identification of observing object
  68. private var observers = [ObjectIdentifier: Observer]()
  69. private var medialib: VLCMediaLibrary!
  70. weak var migrationDelegate: MediaLibraryMigrationDelegate?
  71. override init() {
  72. super.init()
  73. medialib = VLCMediaLibrary()
  74. medialib.delegate = self
  75. setupMediaLibrary()
  76. NotificationCenter.default.addObserver(self, selector: #selector(reload),
  77. name: .VLCNewFileAddedNotification, object: nil)
  78. }
  79. }
  80. // MARK: - Private initializers
  81. private extension MediaLibraryService {
  82. private func setupMediaDiscovery(at path: String) {
  83. let mediaFileDiscoverer = VLCMediaFileDiscoverer.sharedInstance()
  84. mediaFileDiscoverer?.directoryPath = path
  85. mediaFileDiscoverer?.addObserver(self)
  86. mediaFileDiscoverer?.startDiscovering()
  87. }
  88. private func setupMediaLibrary() {
  89. guard let documentPath = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true).first,
  90. let libraryPath = NSSearchPathForDirectoriesInDomains(.libraryDirectory, .userDomainMask, true).first else {
  91. preconditionFailure("MediaLibraryService: Unable to init medialibrary.")
  92. }
  93. setupMediaDiscovery(at: documentPath)
  94. let databasePath = libraryPath + "/MediaLibrary/" + MediaLibraryService.databaseName
  95. let thumbnailPath = libraryPath + "/MediaLibrary/Thumbnails"
  96. do {
  97. try FileManager.default.createDirectory(atPath: thumbnailPath,
  98. withIntermediateDirectories: true)
  99. } catch let error as NSError {
  100. assertionFailure("Failed to create directory: \(error.localizedDescription)")
  101. }
  102. let medialibraryStatus = medialib.setupMediaLibrary(databasePath: databasePath,
  103. thumbnailPath: thumbnailPath)
  104. switch medialibraryStatus {
  105. case .success:
  106. guard medialib.start() else {
  107. assertionFailure("MediaLibraryService: Medialibrary failed to start.")
  108. return
  109. }
  110. medialib.reload()
  111. medialib.discover(onEntryPoint: "file://" + documentPath)
  112. case .alreadyInitialized:
  113. assertionFailure("MediaLibraryService: Medialibrary already initialized.")
  114. case .failed:
  115. preconditionFailure("MediaLibraryService: Failed to setup medialibrary.")
  116. case .dbReset:
  117. // should still start and discover but warn the user that the db has been wipped
  118. assertionFailure("MediaLibraryService: The database was resetted, please re-configure.")
  119. }
  120. }
  121. }
  122. // MARK: - Migration
  123. private extension MediaLibraryService {
  124. func startMigrationIfNeeded() {
  125. guard !didMigrate else {
  126. return
  127. }
  128. migrationDelegate?.medialibraryDidStartMigration(self)
  129. guard migrateToNewMediaLibrary() else {
  130. migrationDelegate?.medialibraryDidStopMigration(self)
  131. return
  132. }
  133. migrationDelegate?.medialibraryDidFinishMigration(self)
  134. }
  135. func migrateMedia(_ oldMedialibrary: MLMediaLibrary) -> Bool {
  136. guard let allFiles = MLFile.allFiles() as? [MLFile] else {
  137. assertionFailure("MediaLibraryService: Migration: Unable to retreive all files")
  138. return false
  139. }
  140. for media in allFiles {
  141. if let newMedia = fetchMedia(with: media.url) {
  142. newMedia.updateTitle(media.title)
  143. newMedia.setPlayCount(media.playCount.uint32Value)
  144. newMedia.setMetadataOf(.progress, intValue: media.lastPosition.int64Value)
  145. newMedia.setMetadataOf(.seen, intValue: media.unread.int64Value)
  146. // Only delete files that are not in playlist
  147. if media.labels.isEmpty {
  148. oldMedialibrary.remove(media)
  149. }
  150. }
  151. }
  152. oldMedialibrary.save()
  153. return true
  154. }
  155. // This private method migrates old playlist and removes file and playlist
  156. // from the old medialibrary.
  157. // Note: This removes **only** files that are in a playlist
  158. func migratePlaylists(_ oldMedialibrary: MLMediaLibrary) -> Bool {
  159. guard let allLabels = MLLabel.allLabels() as? [MLLabel] else {
  160. assertionFailure("MediaLibraryService: Migration: Unable to retreive all labels")
  161. return false
  162. }
  163. for label in allLabels {
  164. let newPlaylist = createPlaylist(with: label.name)
  165. guard let files = label.files as? Set<MLFile> else {
  166. assertionFailure("MediaLibraryService: Migration: Unable to retreive files from label")
  167. oldMedialibrary.remove(label)
  168. continue
  169. }
  170. for file in files {
  171. if let newMedia = fetchMedia(with: file.url) {
  172. if newPlaylist.appendMedia(withIdentifier: newMedia.identifier()) {
  173. oldMedialibrary.remove(file)
  174. }
  175. }
  176. }
  177. oldMedialibrary.remove(label)
  178. }
  179. oldMedialibrary.save()
  180. return true
  181. }
  182. func migrateToNewMediaLibrary() -> Bool {
  183. guard let oldMedialibrary = MLMediaLibrary.sharedMediaLibrary() as? MLMediaLibrary else {
  184. assertionFailure("MediaLibraryService: Migration: Unable to retreive old medialibrary")
  185. return false
  186. }
  187. if migrateMedia(oldMedialibrary) && migratePlaylists(oldMedialibrary) {
  188. UserDefaults.standard.set(true, forKey: MediaLibraryService.migrationKey)
  189. didMigrate = true
  190. return true
  191. }
  192. return false
  193. }
  194. }
  195. // MARK: - Observer
  196. private extension MediaLibraryService {
  197. struct Observer {
  198. weak var observer: MediaLibraryObserver?
  199. }
  200. }
  201. extension MediaLibraryService {
  202. func addObserver(_ observer: MediaLibraryObserver) {
  203. let identifier = ObjectIdentifier(observer)
  204. observers[identifier] = Observer(observer: observer)
  205. }
  206. func removeObserver(_ observer: MediaLibraryObserver) {
  207. let identifier = ObjectIdentifier(observer)
  208. observers.removeValue(forKey: identifier)
  209. }
  210. }
  211. // MARK: - Helpers
  212. extension MediaLibraryService {
  213. @objc func reload() {
  214. medialib.reload()
  215. }
  216. /// Returns number of *ALL* files(audio and video) present in the medialibrary database
  217. func numberOfFiles() -> Int {
  218. var media = medialib.audioFiles(with: .filename, desc: false)
  219. media += medialib.videoFiles(with: .filename, desc: false)
  220. return media.count
  221. }
  222. /// Returns *ALL* file found for a specified VLCMLMediaType
  223. ///
  224. /// - Parameter type: Type of the media
  225. /// - Returns: Array of VLCMLMedia
  226. func media(ofType type: VLCMLMediaType, sortingCriteria sort: VLCMLSortingCriteria = .filename, desc: Bool = false) -> [VLCMLMedia] {
  227. return type == .video ? medialib.videoFiles(with: sort, desc: desc) : medialib.audioFiles(with: sort, desc: desc)
  228. }
  229. func fetchMedia(with mrl: URL?) -> VLCMLMedia? {
  230. guard let mrl = mrl else {
  231. return nil
  232. }
  233. return medialib.media(withMrl: mrl)
  234. }
  235. }
  236. // MARK: - Audio methods
  237. extension MediaLibraryService {
  238. func artists(sortingCriteria sort: VLCMLSortingCriteria = .artist, desc: Bool = false) -> [VLCMLArtist] {
  239. return medialib.artists(with: sort, desc: desc, all: true)
  240. }
  241. func albums(sortingCriteria sort: VLCMLSortingCriteria = .album, desc: Bool = false) -> [VLCMLAlbum] {
  242. return medialib.albums(with: sort, desc: desc)
  243. }
  244. }
  245. // MARK: - Video methods
  246. extension MediaLibraryService {
  247. func requestThumbnail(for media: [VLCMLMedia]) {
  248. media.forEach() {
  249. guard !$0.isThumbnailGenerated() else { return }
  250. if !medialib.requestThumbnail(for: $0) {
  251. assertionFailure("MediaLibraryService: Failed to generate thumbnail for: \($0.identifier())")
  252. }
  253. }
  254. }
  255. }
  256. // MARK: - Playlist methods
  257. extension MediaLibraryService {
  258. func createPlaylist(with name: String) -> VLCMLPlaylist {
  259. return medialib.createPlaylist(withName: name)
  260. }
  261. func deletePlaylist(with identifier: VLCMLIdentifier) -> Bool {
  262. return medialib.deletePlaylist(withIdentifier: identifier)
  263. }
  264. func playlists(sortingCriteria sort: VLCMLSortingCriteria = .default, desc: Bool = false) -> [VLCMLPlaylist] {
  265. return medialib.playlists(with: sort, desc: desc)
  266. }
  267. }
  268. // MARK: - Genre methods
  269. extension MediaLibraryService {
  270. func genres(sortingCriteria sort: VLCMLSortingCriteria = .default, desc: Bool = false) -> [VLCMLGenre] {
  271. return medialib.genres(with: sort, desc: desc)
  272. }
  273. }
  274. // MARK: - VLCMediaFileDiscovererDelegate
  275. extension MediaLibraryService: VLCMediaFileDiscovererDelegate {
  276. func mediaFileAdded(_ filePath: String!, loading isLoading: Bool) {
  277. guard !isLoading else {
  278. return
  279. }
  280. /* exclude media files from backup (QA1719) */
  281. var excludeURL = URL(fileURLWithPath: filePath)
  282. var resourceValue = URLResourceValues()
  283. resourceValue.isExcludedFromBackup = true
  284. do {
  285. try excludeURL.setResourceValues(resourceValue)
  286. } catch let error {
  287. assertionFailure("MediaLibraryService: VLCMediaFileDiscovererDelegate: \(error.localizedDescription)")
  288. }
  289. reload()
  290. }
  291. func mediaFileDeleted(_ filePath: String!) {
  292. reload()
  293. }
  294. }
  295. // MARK: - VLCMediaLibraryDelegate - Media
  296. extension MediaLibraryService: VLCMediaLibraryDelegate {
  297. func medialibrary(_ medialibrary: VLCMediaLibrary, didAddMedia media: [VLCMLMedia]) {
  298. let videos = media.filter {( $0.type() == .video )}
  299. let audio = media.filter {( $0.type() == .audio )}
  300. // thumbnails only for videos
  301. requestThumbnail(for: videos)
  302. for observer in observers {
  303. observer.value.observer?.medialibrary?(self, didAddVideos: videos)
  304. observer.value.observer?.medialibrary?(self, didAddAudios: audio)
  305. }
  306. }
  307. func medialibrary(_ medialibrary: VLCMediaLibrary, didModifyMedia media: [VLCMLMedia]) {
  308. let showEpisodes = media.filter {( $0.subtype() == .showEpisode )}
  309. let albumTrack = media.filter {( $0.subtype() == .albumTrack )}
  310. for observer in observers {
  311. observer.value.observer?.medialibrary?(self, didAddShowEpisodes: showEpisodes)
  312. observer.value.observer?.medialibrary?(self, didAddAlbumTracks: albumTrack)
  313. }
  314. }
  315. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeleteMediaWithIds mediaIds: [NSNumber]) {
  316. for observer in observers {
  317. observer.value.observer?.medialibrary?(self, didDeleteMediaWithIds: mediaIds)
  318. }
  319. }
  320. func medialibrary(_ medialibrary: VLCMediaLibrary, thumbnailReadyFor media: VLCMLMedia, withSuccess success: Bool) {
  321. for observer in observers {
  322. observer.value.observer?.medialibrary?(self, thumbnailReady: media)
  323. }
  324. }
  325. }
  326. // MARK: - VLCMediaLibraryDelegate - Artists
  327. extension MediaLibraryService {
  328. func medialibrary(_ medialibrary: VLCMediaLibrary, didAdd artists: [VLCMLArtist]) {
  329. for observer in observers {
  330. observer.value.observer?.medialibrary?(self, didAddArtists: artists)
  331. }
  332. }
  333. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeleteArtistsWithIds artistsIds: [NSNumber]) {
  334. for observer in observers {
  335. observer.value.observer?.medialibrary?(self, didDeleteArtistsWithIds: artistsIds)
  336. }
  337. }
  338. }
  339. // MARK: - VLCMediaLibraryDelegate - Albums
  340. extension MediaLibraryService {
  341. func medialibrary(_ medialibrary: VLCMediaLibrary, didAdd albums: [VLCMLAlbum]) {
  342. for observer in observers {
  343. observer.value.observer?.medialibrary?(self, didAddAlbums: albums)
  344. }
  345. }
  346. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeleteAlbumsWithIds albumsIds: [NSNumber]) {
  347. for observer in observers {
  348. observer.value.observer?.medialibrary?(self, didDeleteAlbumsWithIds: albumsIds)
  349. }
  350. }
  351. }
  352. // MARK: - VLCMediaLibraryDelegate - Playlists
  353. extension MediaLibraryService {
  354. func medialibrary(_ medialibrary: VLCMediaLibrary, didAdd playlists: [VLCMLPlaylist]) {
  355. for observer in observers {
  356. observer.value.observer?.medialibrary?(self, didAddPlaylists: playlists)
  357. }
  358. }
  359. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeletePlaylistsWithIds playlistsIds: [NSNumber]) {
  360. for observer in observers {
  361. observer.value.observer?.medialibrary?(self, didDeletePlaylistsWithIds: playlistsIds)
  362. }
  363. }
  364. }
  365. // MARK: - VLCMediaLibraryDelegate - Discovery
  366. extension MediaLibraryService {
  367. func medialibrary(_ medialibrary: VLCMediaLibrary, didStartDiscovery entryPoint: String) {
  368. }
  369. func medialibrary(_ medialibrary: VLCMediaLibrary, didCompleteDiscovery entryPoint: String) {
  370. didFinishDiscovery = true
  371. }
  372. func medialibrary(_ medialibrary: VLCMediaLibrary, didProgressDiscovery entryPoint: String) {
  373. }
  374. func medialibrary(_ medialibrary: VLCMediaLibrary, didUpdateParsingStatsWithPercent percent: UInt32) {
  375. if didFinishDiscovery && percent == 100 {
  376. startMigrationIfNeeded()
  377. }
  378. }
  379. }