MediaLibraryService.swift 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587
  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. didAddVideos videos: [VLCMLMedia])
  25. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  26. didModifyVideos videos: [VLCMLMedia])
  27. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  28. didDeleteMediaWithIds ids: [NSNumber])
  29. // ShowEpisodes
  30. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  31. didAddShowEpisodes showEpisodes: [VLCMLMedia])
  32. // Tumbnail
  33. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  34. thumbnailReady media: VLCMLMedia)
  35. // Tracks
  36. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  37. didAddTracks tracks: [VLCMLMedia])
  38. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  39. didModifyTracks tracks: [VLCMLMedia])
  40. // Artists
  41. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  42. didAddArtists artists: [VLCMLArtist])
  43. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  44. didModifyArtists artists: [VLCMLArtist])
  45. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  46. didDeleteArtistsWithIds artistsIds: [NSNumber])
  47. // Albums
  48. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  49. didAddAlbums albums: [VLCMLAlbum])
  50. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  51. didModifyAlbums albums: [VLCMLAlbum])
  52. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  53. didDeleteAlbumsWithIds albumsIds: [NSNumber])
  54. // AlbumTracks
  55. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  56. didAddAlbumTracks albumTracks: [VLCMLMedia])
  57. // Genres
  58. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  59. didAddGenres genres: [VLCMLGenre])
  60. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  61. didModifyGenres genres: [VLCMLGenre])
  62. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  63. didDeleteGenresWithIds genreIds: [NSNumber])
  64. // Playlist
  65. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  66. didAddPlaylists playlists: [VLCMLPlaylist])
  67. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  68. didModifyPlaylists playlists: [VLCMLPlaylist])
  69. @objc optional func medialibrary(_ medialibrary: MediaLibraryService,
  70. didDeletePlaylistsWithIds playlistsIds: [NSNumber])
  71. }
  72. // MARK: -
  73. protocol MediaLibraryMigrationDelegate: class {
  74. func medialibraryDidStartMigration(_ medialibrary: MediaLibraryService)
  75. func medialibraryDidFinishMigration(_ medialibrary: MediaLibraryService)
  76. func medialibraryDidStopMigration(_ medialibrary: MediaLibraryService)
  77. }
  78. // MARK: -
  79. class MediaLibraryService: NSObject {
  80. private static let databaseName: String = "medialibrary.db"
  81. private static let migrationKey: String = "MigratedToVLCMediaLibraryKit"
  82. private var didMigrate = UserDefaults.standard.bool(forKey: MediaLibraryService.migrationKey)
  83. private var didFinishDiscovery = false
  84. // Using ObjectIdentifier to avoid duplication and facilitate
  85. // identification of observing object
  86. private var observers = [ObjectIdentifier: Observer]()
  87. private var medialib: VLCMediaLibrary!
  88. weak var migrationDelegate: MediaLibraryMigrationDelegate?
  89. override init() {
  90. super.init()
  91. medialib = VLCMediaLibrary()
  92. medialib.delegate = self
  93. setupMediaLibrary()
  94. NotificationCenter.default.addObserver(self, selector: #selector(reload),
  95. name: .VLCNewFileAddedNotification, object: nil)
  96. }
  97. }
  98. // MARK: - Private initializers
  99. private extension MediaLibraryService {
  100. private func setupMediaDiscovery(at path: String) {
  101. let mediaFileDiscoverer = VLCMediaFileDiscoverer.sharedInstance()
  102. mediaFileDiscoverer?.directoryPath = path
  103. mediaFileDiscoverer?.addObserver(self)
  104. mediaFileDiscoverer?.startDiscovering()
  105. }
  106. private func setupMediaLibrary() {
  107. guard let documentPath = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true).first,
  108. let libraryPath = NSSearchPathForDirectoriesInDomains(.libraryDirectory, .userDomainMask, true).first else {
  109. preconditionFailure("MediaLibraryService: Unable to init medialibrary.")
  110. }
  111. setupMediaDiscovery(at: documentPath)
  112. let databasePath = libraryPath + "/MediaLibrary/" + MediaLibraryService.databaseName
  113. let thumbnailPath = libraryPath + "/MediaLibrary/Thumbnails"
  114. do {
  115. try FileManager.default.createDirectory(atPath: thumbnailPath,
  116. withIntermediateDirectories: true)
  117. } catch let error as NSError {
  118. assertionFailure("Failed to create directory: \(error.localizedDescription)")
  119. }
  120. let medialibraryStatus = medialib.setupMediaLibrary(databasePath: databasePath,
  121. thumbnailPath: thumbnailPath)
  122. switch medialibraryStatus {
  123. case .success:
  124. guard medialib.start() else {
  125. assertionFailure("MediaLibraryService: Medialibrary failed to start.")
  126. return
  127. }
  128. medialib.reload()
  129. medialib.discover(onEntryPoint: "file://" + documentPath)
  130. case .alreadyInitialized:
  131. assertionFailure("MediaLibraryService: Medialibrary already initialized.")
  132. case .failed:
  133. preconditionFailure("MediaLibraryService: Failed to setup medialibrary.")
  134. case .dbReset:
  135. // should still start and discover but warn the user that the db has been wipped
  136. assertionFailure("MediaLibraryService: The database was resetted, please re-configure.")
  137. @unknown default:
  138. assertionFailure("MediaLibraryService: unhandled case")
  139. }
  140. }
  141. }
  142. // MARK: - Migration
  143. private extension MediaLibraryService {
  144. func startMigrationIfNeeded() {
  145. guard !didMigrate else {
  146. return
  147. }
  148. migrationDelegate?.medialibraryDidStartMigration(self)
  149. guard migrateToNewMediaLibrary() else {
  150. migrationDelegate?.medialibraryDidStopMigration(self)
  151. return
  152. }
  153. migrationDelegate?.medialibraryDidFinishMigration(self)
  154. }
  155. func migrateMedia(_ oldMedialibrary: MLMediaLibrary) -> Bool {
  156. guard let allFiles = MLFile.allFiles() as? [MLFile] else {
  157. assertionFailure("MediaLibraryService: Migration: Unable to retrieve all files")
  158. return false
  159. }
  160. for media in allFiles {
  161. if let newMedia = fetchMedia(with: media.url) {
  162. newMedia.updateTitle(media.title)
  163. newMedia.setPlayCount(media.playCount.uint32Value)
  164. newMedia.setMetadataOf(.progress, intValue: media.lastPosition.int64Value)
  165. newMedia.setMetadataOf(.seen, intValue: media.unread.int64Value)
  166. // Only delete files that are not in playlist
  167. if media.labels.isEmpty {
  168. oldMedialibrary.remove(media)
  169. }
  170. }
  171. }
  172. oldMedialibrary.save()
  173. return true
  174. }
  175. // This private method migrates old playlist and removes file and playlist
  176. // from the old medialibrary.
  177. // Note: This removes **only** files that are in a playlist
  178. func migratePlaylists(_ oldMedialibrary: MLMediaLibrary) -> Bool {
  179. guard let allLabels = MLLabel.allLabels() as? [MLLabel] else {
  180. assertionFailure("MediaLibraryService: Migration: Unable to retrieve all labels")
  181. return false
  182. }
  183. for label in allLabels {
  184. guard let newPlaylist = createPlaylist(with: label.name) else {
  185. assertionFailure("MediaLibraryService: Migration: Unable to create playlist.")
  186. continue
  187. }
  188. guard let files = label.files as? Set<MLFile> else {
  189. assertionFailure("MediaLibraryService: Migration: Unable to retrieve files from label")
  190. oldMedialibrary.remove(label)
  191. continue
  192. }
  193. for file in files {
  194. if let newMedia = fetchMedia(with: file.url) {
  195. if newPlaylist.appendMedia(withIdentifier: newMedia.identifier()) {
  196. oldMedialibrary.remove(file)
  197. }
  198. }
  199. }
  200. oldMedialibrary.remove(label)
  201. }
  202. oldMedialibrary.save()
  203. return true
  204. }
  205. func migrateToNewMediaLibrary() -> Bool {
  206. guard let oldMedialibrary = MLMediaLibrary.sharedMediaLibrary() as? MLMediaLibrary else {
  207. assertionFailure("MediaLibraryService: Migration: Unable to retrieve old medialibrary")
  208. return false
  209. }
  210. if migrateMedia(oldMedialibrary) && migratePlaylists(oldMedialibrary) {
  211. UserDefaults.standard.set(true, forKey: MediaLibraryService.migrationKey)
  212. didMigrate = true
  213. return true
  214. }
  215. return false
  216. }
  217. }
  218. // MARK: - Observer
  219. private extension MediaLibraryService {
  220. struct Observer {
  221. weak var observer: MediaLibraryObserver?
  222. }
  223. }
  224. extension MediaLibraryService {
  225. func addObserver(_ observer: MediaLibraryObserver) {
  226. let identifier = ObjectIdentifier(observer)
  227. observers[identifier] = Observer(observer: observer)
  228. }
  229. func removeObserver(_ observer: MediaLibraryObserver) {
  230. let identifier = ObjectIdentifier(observer)
  231. observers.removeValue(forKey: identifier)
  232. }
  233. }
  234. // MARK: - Helpers
  235. @objc extension MediaLibraryService {
  236. @objc func reload() {
  237. medialib.reload()
  238. }
  239. /// Returns number of *ALL* files(audio and video) present in the medialibrary database
  240. func numberOfFiles() -> Int {
  241. return (medialib.audioFiles()?.count ?? 0) + (medialib.videoFiles()?.count ?? 0)
  242. }
  243. /// Returns *ALL* file found for a specified VLCMLMediaType
  244. ///
  245. /// - Parameter type: Type of the media
  246. /// - Returns: Array of VLCMLMedia
  247. func media(ofType type: VLCMLMediaType,
  248. sortingCriteria sort: VLCMLSortingCriteria = .alpha,
  249. desc: Bool = false) -> [VLCMLMedia] {
  250. return type == .video ? medialib.videoFiles(with: sort, desc: desc) ?? []
  251. : medialib.audioFiles(with: sort, desc: desc) ?? []
  252. }
  253. @objc func fetchMedia(with mrl: URL?) -> VLCMLMedia? {
  254. guard let mrl = mrl else {
  255. return nil //Happens when we have a URL or there is no currently playing file
  256. }
  257. return medialib.media(withMrl: mrl)
  258. }
  259. @objc func media(for identifier: VLCMLIdentifier) -> VLCMLMedia? {
  260. return medialib.media(withIdentifier: identifier)
  261. }
  262. func savePlaybackState(from player: VLCPlaybackController) {
  263. let media: VLCMedia? = player.currentlyPlayingMedia
  264. guard let mlMedia = fetchMedia(with: media?.url.absoluteURL) else {
  265. // we opened a url and not a local file
  266. return
  267. }
  268. mlMedia.isNew = false
  269. mlMedia.progress = player.playbackPosition
  270. mlMedia.audioTrackIndex = Int64(player.indexOfCurrentAudioTrack)
  271. mlMedia.subtitleTrackIndex = Int64(player.indexOfCurrentSubtitleTrack)
  272. mlMedia.chapterIndex = Int64(player.indexOfCurrentChapter)
  273. mlMedia.titleIndex = Int64(player.indexOfCurrentTitle)
  274. //create a new thumbnail
  275. }
  276. }
  277. // MARK: - Audio methods
  278. @objc extension MediaLibraryService {
  279. func artists(sortingCriteria sort: VLCMLSortingCriteria = .alpha,
  280. desc: Bool = false, listAll all: Bool = false) -> [VLCMLArtist] {
  281. return medialib.artists(with: sort, desc: desc, all: all) ?? []
  282. }
  283. func albums(sortingCriteria sort: VLCMLSortingCriteria = .alpha,
  284. desc: Bool = false) -> [VLCMLAlbum] {
  285. return medialib.albums(with: sort, desc: desc) ?? []
  286. }
  287. }
  288. // MARK: - Video methods
  289. extension MediaLibraryService {
  290. func requestThumbnail(for media: [VLCMLMedia]) {
  291. media.forEach() {
  292. guard !$0.isThumbnailGenerated() else { return }
  293. if !$0.requestThumbnail(of: .thumbnail, desiredWidth: 320, desiredHeight: 200, atPosition: 0.3) {
  294. assertionFailure("MediaLibraryService: Failed to generate thumbnail for: \($0.identifier())")
  295. }
  296. }
  297. }
  298. }
  299. // MARK: - Playlist methods
  300. @objc extension MediaLibraryService {
  301. func createPlaylist(with name: String) -> VLCMLPlaylist? {
  302. return medialib.createPlaylist(withName: name)
  303. }
  304. func deletePlaylist(with identifier: VLCMLIdentifier) -> Bool {
  305. return medialib.deletePlaylist(withIdentifier: identifier)
  306. }
  307. func playlists(sortingCriteria sort: VLCMLSortingCriteria = .default,
  308. desc: Bool = false) -> [VLCMLPlaylist] {
  309. return medialib.playlists(with: sort, desc: desc) ?? []
  310. }
  311. }
  312. // MARK: - Genre methods
  313. extension MediaLibraryService {
  314. func genres(sortingCriteria sort: VLCMLSortingCriteria = .alpha,
  315. desc: Bool = false) -> [VLCMLGenre] {
  316. return medialib.genres(with: sort, desc: desc) ?? []
  317. }
  318. }
  319. // MARK: - VLCMediaFileDiscovererDelegate
  320. extension MediaLibraryService: VLCMediaFileDiscovererDelegate {
  321. func mediaFileAdded(_ filePath: String!, loading isLoading: Bool) {
  322. guard !isLoading else {
  323. return
  324. }
  325. /* exclude media files from backup (QA1719) */
  326. var excludeURL = URL(fileURLWithPath: filePath)
  327. var resourceValue = URLResourceValues()
  328. resourceValue.isExcludedFromBackup = true
  329. do {
  330. try excludeURL.setResourceValues(resourceValue)
  331. } catch let error {
  332. assertionFailure("MediaLibraryService: VLCMediaFileDiscovererDelegate: \(error.localizedDescription)")
  333. }
  334. reload()
  335. }
  336. func mediaFileDeleted(_ filePath: String!) {
  337. reload()
  338. }
  339. }
  340. // MARK: - VLCMediaLibraryDelegate - Media
  341. extension MediaLibraryService: VLCMediaLibraryDelegate {
  342. func medialibrary(_ medialibrary: VLCMediaLibrary, didAddMedia media: [VLCMLMedia]) {
  343. media.forEach { $0.updateCoreSpotlightEntry() }
  344. let videos = media.filter {( $0.type() == .video )}
  345. let tracks = media.filter {( $0.type() == .audio )}
  346. // thumbnails only for videos
  347. requestThumbnail(for: videos)
  348. for observer in observers {
  349. observer.value.observer?.medialibrary?(self, didAddVideos: videos)
  350. observer.value.observer?.medialibrary?(self, didAddTracks: tracks)
  351. }
  352. }
  353. func medialibrary(_ medialibrary: VLCMediaLibrary, didModifyMedia media: [VLCMLMedia]) {
  354. media.forEach { $0.updateCoreSpotlightEntry() }
  355. let showEpisodes = media.filter {( $0.subtype() == .showEpisode )}
  356. let albumTrack = media.filter {( $0.subtype() == .albumTrack )}
  357. let videos = media.filter {( $0.type() == .video)}
  358. let tracks = media.filter {( $0.type() == .audio)}
  359. // Shows and albumtracks are known only after when the medialibrary calls didModifyMedia
  360. for observer in observers {
  361. observer.value.observer?.medialibrary?(self, didAddShowEpisodes: showEpisodes)
  362. observer.value.observer?.medialibrary?(self, didAddAlbumTracks: albumTrack)
  363. observer.value.observer?.medialibrary?(self, didModifyVideos: videos)
  364. observer.value.observer?.medialibrary?(self, didModifyTracks: tracks)
  365. }
  366. }
  367. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeleteMediaWithIds mediaIds: [NSNumber]) {
  368. var stringIds = [String]()
  369. mediaIds.forEach { stringIds.append("\($0)") }
  370. CSSearchableIndex.default().deleteSearchableItems(withIdentifiers: stringIds, completionHandler: nil)
  371. for observer in observers {
  372. observer.value.observer?.medialibrary?(self, didDeleteMediaWithIds: mediaIds)
  373. }
  374. }
  375. func medialibrary(_ medialibrary: VLCMediaLibrary, thumbnailReadyFor media: VLCMLMedia, withSuccess success: Bool) {
  376. for observer in observers {
  377. observer.value.observer?.medialibrary?(self, thumbnailReady: media)
  378. }
  379. }
  380. }
  381. // MARK: - VLCMediaLibraryDelegate - Artists
  382. extension MediaLibraryService {
  383. func medialibrary(_ medialibrary: VLCMediaLibrary, didAdd artists: [VLCMLArtist]) {
  384. for observer in observers {
  385. observer.value.observer?.medialibrary?(self, didAddArtists: artists)
  386. }
  387. }
  388. func medialibrary(_ medialibrary: VLCMediaLibrary, didModifyArtists artists: [VLCMLArtist]) {
  389. for observer in observers {
  390. observer.value.observer?.medialibrary?(self, didModifyArtists: artists)
  391. }
  392. }
  393. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeleteArtistsWithIds artistsIds: [NSNumber]) {
  394. for observer in observers {
  395. observer.value.observer?.medialibrary?(self, didDeleteArtistsWithIds: artistsIds)
  396. }
  397. }
  398. }
  399. // MARK: - VLCMediaLibraryDelegate - Albums
  400. extension MediaLibraryService {
  401. func medialibrary(_ medialibrary: VLCMediaLibrary, didAdd albums: [VLCMLAlbum]) {
  402. for observer in observers {
  403. observer.value.observer?.medialibrary?(self, didAddAlbums: albums)
  404. }
  405. }
  406. func medialibrary(_ medialibrary: VLCMediaLibrary, didModify albums: [VLCMLAlbum]) {
  407. for observer in observers {
  408. observer.value.observer?.medialibrary?(self, didAddAlbums: albums)
  409. }
  410. }
  411. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeleteAlbumsWithIds albumsIds: [NSNumber]) {
  412. for observer in observers {
  413. observer.value.observer?.medialibrary?(self, didDeleteAlbumsWithIds: albumsIds)
  414. }
  415. }
  416. }
  417. // MARK: - VLCMediaLibraryDelegate - Genres
  418. extension MediaLibraryService {
  419. func medialibrary(_ medialibrary: VLCMediaLibrary, didAdd genres: [VLCMLGenre]) {
  420. for observer in observers {
  421. observer.value.observer?.medialibrary?(self, didAddGenres: genres)
  422. }
  423. }
  424. func medialibrary(_ medialibrary: VLCMediaLibrary, didModifyGenres genres: [VLCMLGenre]) {
  425. for observer in observers {
  426. observer.value.observer?.medialibrary?(self, didModifyGenres: genres)
  427. }
  428. }
  429. func medialibrary(_ medialibrary: VLCMediaLibrary,
  430. didDeleteGenresWithIds genresIds: [NSNumber]) {
  431. for observer in observers {
  432. observer.value.observer?.medialibrary?(self, didDeleteGenresWithIds: genresIds)
  433. }
  434. }
  435. }
  436. // MARK: - VLCMediaLibraryDelegate - Playlists
  437. extension MediaLibraryService {
  438. func medialibrary(_ medialibrary: VLCMediaLibrary, didAdd playlists: [VLCMLPlaylist]) {
  439. for observer in observers {
  440. observer.value.observer?.medialibrary?(self, didAddPlaylists: playlists)
  441. }
  442. }
  443. func medialibrary(_ medialibrary: VLCMediaLibrary, didModifyPlaylists playlists: [VLCMLPlaylist]) {
  444. for observer in observers {
  445. observer.value.observer?.medialibrary?(self, didModifyPlaylists: playlists)
  446. }
  447. }
  448. func medialibrary(_ medialibrary: VLCMediaLibrary, didDeletePlaylistsWithIds playlistsIds: [NSNumber]) {
  449. for observer in observers {
  450. observer.value.observer?.medialibrary?(self, didDeletePlaylistsWithIds: playlistsIds)
  451. }
  452. }
  453. }
  454. // MARK: - VLCMediaLibraryDelegate - Discovery
  455. extension MediaLibraryService {
  456. func medialibrary(_ medialibrary: VLCMediaLibrary, didStartDiscovery entryPoint: String) {
  457. }
  458. func medialibrary(_ medialibrary: VLCMediaLibrary, didCompleteDiscovery entryPoint: String) {
  459. didFinishDiscovery = true
  460. }
  461. func medialibrary(_ medialibrary: VLCMediaLibrary, didProgressDiscovery entryPoint: String) {
  462. }
  463. func medialibrary(_ medialibrary: VLCMediaLibrary, didUpdateParsingStatsWithPercent percent: UInt32) {
  464. if didFinishDiscovery && percent == 100 {
  465. startMigrationIfNeeded()
  466. }
  467. }
  468. }