Merge pull request #80 from ospr/image-rendering

Add support for rendering waveform images outside of the view [WIP]

Author: fulldecent

CHANGELOG.md

@@ -6,6 +6,30 @@ All notable changes to this project will be documented in this file.
 
 ## [Master](https://github.com/fulldecent/FDWaveformView/compare/2.1.0...master)
 
+#### Added
+- Improved accuracy of waveform rendering
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Added support for rendering waveform images outside of a view (See `FDWaveformRenderOperation`)
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Added support for rendering linear waveforms
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Added support for changing `wavesColor` and `progressColor` after waveform was rendered
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Added support for updating waveform type and color to iOS Example app.
+  - Added by [Kip Nicol](https://github.com/ospr)
+
+#### Fixed
+- Fixed waveform rendering for large audio files
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Fixed bug which could prevent waveform from fitting new view size if rendering was in progress during a view resize
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Fixed bug which caused `waveformViewDidLoad()` to not be called after the audio file was loaded
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Fixed bug which caused subsequent waveform renderings for new audioURLs to never complete if there was an error with a previous render
+  - Added by [Kip Nicol](https://github.com/ospr)
+- Fixed bug which could cause a crash (divide by zero error) if the view's width was 0
+  - Added by [Kip Nicol](https://github.com/ospr)
+
 ---
 
 ## [2.1.0](https://github.com/fulldecent/FDWaveformView/releases/tag/2.1.0)

Example/Source/Base.lproj/Main.storyboard

@@ -12,6 +12,8 @@ import FDWaveformView
 
 class ViewController: UIViewController {
     @IBOutlet weak var waveform: FDWaveformView!
+    @IBOutlet weak var logarithmicButton: UIButton!
+    @IBOutlet weak var linearButton: UIButton!
 
     fileprivate var startRendering = Date()
     fileprivate var endRendering = Date()
@@ -105,6 +107,30 @@ class ViewController: UIViewController {
         waveform.doesAllowScroll = sender.isOn
     }
 
+    @IBAction func doLinear() {
+        /* TODO: Make this public and then use it here
+        waveform.waveformType = .linear
+        updateWaveformTypeButtons()
+         */
+    }
+    
+    @IBAction func doLogarithmic() {
+        /* TODO: Make this public and then use it here
+        waveform.waveformType = .logarithmic
+        updateWaveformTypeButtons()
+        */
+    }
+    
+    @IBAction func doChangeColors() {
+        let randomColor: () -> (UIColor) = {
+            return UIColor(red: CGFloat(drand48()), green: CGFloat(drand48()), blue: CGFloat(drand48()), alpha: 1)
+        }
+        
+        UIView.animate(withDuration: 0.3, animations: {
+            self.waveform.wavesColor = randomColor()
+            self.waveform.progressColor = randomColor()
+        })
+    }
     override func viewDidLoad() {
         super.viewDidLoad()
         let thisBundle = Bundle(for: type(of: self))
@@ -117,30 +143,45 @@ class ViewController: UIViewController {
         waveform.doesAllowScrubbing = true
         waveform.doesAllowStretch = true
         waveform.doesAllowScroll = true
+        updateWaveformTypeButtons()
+    }
+    
+    func updateWaveformTypeButtons() {
+        /* TODO: Make this public and then use it here
+        let (selectedButton, nonSelectedButton): (UIButton, UIButton) = {
+            switch waveform.waveformType {
+            case .linear: return (linearButton, logarithmicButton)
+            case .logarithmic: return (logarithmicButton, linearButton)
+            }
+        }()
+        selectedButton.layer.borderColor = #colorLiteral(red: 0, green: 0, blue: 0, alpha: 0.25).cgColor
+        selectedButton.layer.borderWidth = 2
+        nonSelectedButton.layer.borderWidth = 0
+        */
     }
 }
 
 extension ViewController: FDWaveformViewDelegate {
     func waveformViewWillRender(_ waveformView: FDWaveformView) {
-        self.startRendering = Date()
+        startRendering = Date()
     }
 
     func waveformViewDidRender(_ waveformView: FDWaveformView) {
-        self.endRendering = Date()
-        NSLog("FDWaveformView rendering done, took %0.3f seconds", self.endRendering.timeIntervalSince(self.startRendering))
-        self.profileResult.append(String(format: " render %0.3f ", self.endRendering.timeIntervalSince(self.startRendering)))
+        endRendering = Date()
+        NSLog("FDWaveformView rendering done, took %0.3f seconds", endRendering.timeIntervalSince(startRendering))
+        profileResult.append(String(format: " render %0.3f ", endRendering.timeIntervalSince(startRendering)))
         UIView.animate(withDuration: 0.25, animations: {() -> Void in
             waveformView.alpha = 1.0
         })
     }
 
     func waveformViewWillLoad(_ waveformView: FDWaveformView) {
-        self.startLoading = Date()
+        startLoading = Date()
     }
 
     func waveformViewDidLoad(_ waveformView: FDWaveformView) {
-        self.endLoading = Date()
-        NSLog("FDWaveformView loading done, took %f seconds", self.endLoading.timeIntervalSince(self.startLoading))
-        self.profileResult.append(" load \(self.endLoading.timeIntervalSince(self.startLoading))")
+        endLoading = Date()
+        NSLog("FDWaveformView loading done, took %0.3f seconds", endLoading.timeIntervalSince(startLoading))
+        profileResult.append(String(format: " load %0.3f ", endLoading.timeIntervalSince(startLoading)))
     }
 }

Example/Source/ViewController.swift

@@ -8,6 +8,8 @@
 
 /* Begin PBXBuildFile section */
 		D94BE1CF1CCEBFD80042282A /* FDWaveformView.swift in Sources */ = {isa = PBXBuildFile; fileRef = D94BE1CE1CCEBFD80042282A /* FDWaveformView.swift */; };
+		D993BD581EBA3D110022A881 /* FDAudioContext.swift in Sources */ = {isa = PBXBuildFile; fileRef = D993BD571EBA3D110022A881 /* FDAudioContext.swift */; };
+		D993BD5A1EBA3F570022A881 /* FDWaveformRenderOperation.swift in Sources */ = {isa = PBXBuildFile; fileRef = D993BD591EBA3F570022A881 /* FDWaveformRenderOperation.swift */; };
 		D9FEF4BF1CCEBC0F0013FBDD /* FDWaveformView.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = D9FEF4B41CCEBC0D0013FBDD /* FDWaveformView.framework */; };
 		D9FEF4C41CCEBC100013FBDD /* FDWaveformViewTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D9FEF4C31CCEBC100013FBDD /* FDWaveformViewTests.swift */; };
 /* End PBXBuildFile section */
@@ -24,6 +26,8 @@
 
 /* Begin PBXFileReference section */
 		D94BE1CE1CCEBFD80042282A /* FDWaveformView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FDWaveformView.swift; sourceTree = "<group>"; };
+		D993BD571EBA3D110022A881 /* FDAudioContext.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FDAudioContext.swift; sourceTree = "<group>"; };
+		D993BD591EBA3F570022A881 /* FDWaveformRenderOperation.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FDWaveformRenderOperation.swift; sourceTree = "<group>"; };
 		D9FEF4B41CCEBC0D0013FBDD /* FDWaveformView.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = FDWaveformView.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		D9FEF4B91CCEBC0D0013FBDD /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Source/Info.plist; sourceTree = "<group>"; };
 		D9FEF4BE1CCEBC0F0013FBDD /* FDWaveformViewTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = FDWaveformViewTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -81,6 +85,8 @@
 			isa = PBXGroup;
 			children = (
 				D94BE1CE1CCEBFD80042282A /* FDWaveformView.swift */,
+				D993BD571EBA3D110022A881 /* FDAudioContext.swift */,
+				D993BD591EBA3F570022A881 /* FDWaveformRenderOperation.swift */,
 			);
 			path = Source;
 			sourceTree = "<group>";
@@ -203,6 +209,8 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				D993BD581EBA3D110022A881 /* FDAudioContext.swift in Sources */,
+				D993BD5A1EBA3F570022A881 /* FDWaveformRenderOperation.swift in Sources */,
 				D94BE1CF1CCEBFD80042282A /* FDWaveformView.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

FDWaveformView.xcodeproj/project.pbxproj

@@ -0,0 +1,60 @@
+//
+// Copyright 2013 - 2017, William Entriken and the FDWaveformView contributors.
+//
+import UIKit
+import AVFoundation
+
+/// Holds audio information used for building waveforms
+final class FDAudioContext {
+    
+    /// The audio asset URL used to load the context
+    public let audioURL: URL
+    
+    /// Total number of samples in loaded asset
+    public let totalSamples: Int
+    
+    /// Loaded asset
+    public let asset: AVAsset
+    
+    // Loaded assetTrack
+    public let assetTrack: AVAssetTrack
+    
+    private init(audioURL: URL, totalSamples: Int, asset: AVAsset, assetTrack: AVAssetTrack) {
+        self.audioURL = audioURL
+        self.totalSamples = totalSamples
+        self.asset = asset
+        self.assetTrack = assetTrack
+    }
+    
+    public static func load(fromAudioURL audioURL: URL, completionHandler: @escaping (_ audioContext: FDAudioContext?) -> ()) {
+        let asset = AVURLAsset(url: audioURL, options: [AVURLAssetPreferPreciseDurationAndTimingKey: NSNumber(value: true as Bool)])
+        
+        guard let assetTrack = asset.tracks(withMediaType: AVMediaTypeAudio).first else {
+            NSLog("FDWaveformView failed to load AVAssetTrack")
+            completionHandler(nil)
+            return
+        }
+        
+        asset.loadValuesAsynchronously(forKeys: ["duration"]) {
+            var error: NSError?
+            let status = asset.statusOfValue(forKey: "duration", error: &error)
+            switch status {
+            case .loaded:
+                guard
+                    let audioFormatDesc = assetTrack.formatDescriptions.first,
+                    let asbd = CMAudioFormatDescriptionGetStreamBasicDescription(audioFormatDesc as! CMAudioFormatDescription) // TODO: Can this be safer?
+                    else { break }
+                
+                let totalSamples = Int((asbd.pointee.mSampleRate) * Float64(asset.duration.value) / Float64(asset.duration.timescale))
+                let audioContext = FDAudioContext(audioURL: audioURL, totalSamples: totalSamples, asset: asset, assetTrack: assetTrack)
+                completionHandler(audioContext)
+                return
+                
+            case .failed, .cancelled, .loading, .unknown:
+                print("FDWaveformView could not load asset: \(error?.localizedDescription ?? "Unknown error")")
+            }
+            
+            completionHandler(nil)
+        }
+    }
+}