Face Redaction in Document using Swift for iOS

1
//
2
//  Copyright © 2020-2025 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
final class FaceRedactionExample: Example {
12

13
    // MARK: Lifecycle
14

15
    override init() {
16
        super.init()
17

18
        title = "Face Redaction"
19
        contentDescription = "Shows how to redact faces in documents with PSPDFProcessor."
20
        category = .documentProcessing
21
        priority = 12
22
    }
23

24
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
25
        let document = AssetLoader.document(for: "Flight Attendants.pdf")
26

27
        // If there are any existing redact annotations, remove them.
28
        for pageIndex in 0..<document.pageCount {
29
            let existingRedactAnnotations = document.annotationsForPage(at: pageIndex, type: .redaction)
30
            document.remove(annotations: existingRedactAnnotations)
31
        }
32

33
        let status = StatusHUDItem.indeterminateProgress(withText: "Detecting faces...")
34
        status.setHUDStyle(.black)
35
        status.push(animated: true, on: delegate.currentViewController?.view.window, completion: nil)
36

37
        // Prepare a face detector. As this is an expensive operation, try to reuse this instance as much as possible.
38
        #if targetEnvironment(simulator)
39
        // `CIDetectors` don't work with high accuracy in simulators for some reason.
40
        // A similar problem is described here https://developer.apple.com/forums/thread/722685,
41
        // but there's no solution aside from forcing the low accuracy on simulators for now
42
        let options = [CIDetectorAccuracy: CIDetectorAccuracyLow]
43
        #else
44
        let options = [CIDetectorAccuracy: CIDetectorAccuracyHigh]
45
        #endif
46

47
        let faceDetector = CIDetector(ofType: CIDetectorTypeFace, context: nil, options: options)!
48

49
        // Perform this expensive work on a background queue.
50
        DispatchQueue.global(qos: .background).async {
51
            var documentRedactionAnnotations: [RedactionAnnotation] = []
52
            for pageIndex in 0..<document.pageCount {
53
                // Render this page. For efficiency, we can work with a scaled page render and still get good results.
54
                let scaleFactor: CGFloat = 1 / 3.0
55
                let pageSize = document.pageInfoForPage(at: pageIndex)!.size
56
                let scaledPageSize = CGSize(width: pageSize.width * scaleFactor, height: pageSize.height * scaleFactor)
57
                let renderedPage = try! document.imageForPage(at: pageIndex, size: scaledPageSize, clippedTo: .zero, annotations: nil, options: nil)
58
                // Detect faces on the rendered page.
59
                let ciImage = CIImage(cgImage: renderedPage.cgImage!)
60
                let transform = CGAffineTransform(scaleX: 1 / (scaleFactor * renderedPage.scale), y: 1 / (scaleFactor * renderedPage.scale))
61
                let faces = faceDetector.features(in: ciImage, options: nil)
62
                // Place a redaction annotation on top of each detected face.
63
                let redactionAnnotations = faces.map { face -> RedactionAnnotation in
64
                    let faceBounds = face.bounds.applying(transform)
65
                    let redaction = RedactionAnnotation()
66
                    redaction.boundingBox = faceBounds
67
                    redaction.rects = [faceBounds]
68
                    redaction.color = .orange
69
                    redaction.fillColor = .black
70
                    redaction.outlineColor = .green
71
                    redaction.pageIndex = pageIndex
72
                    return redaction
73
                }
74
                documentRedactionAnnotations.append(contentsOf: redactionAnnotations)
75
            }
76
            // Add the detected redaction annotations on the main queue and hide the progress window.
77
            DispatchQueue.main.async {
78
                document.add(annotations: documentRedactionAnnotations)
79
                let statusDone = StatusHUDItem.success(withText: "Done")
80
                statusDone.pushAndPop(withDelay: 1, animated: true, on: delegate.currentViewController?.view.window)
81
                status.pop(animated: true)
82
            }
83
        }
84

85
        return FaceRedactionPDFViewController(document: document)
86
    }
87

88
    final class FaceRedactionPDFViewController: PDFViewController {
89
        override func commonInit(with document: Document?, configuration: PDFConfiguration) {
90
            super.commonInit(with: document, configuration: configuration)
91
            let redactButton = UIBarButtonItem(title: "Redact", style: .plain, target: self, action: #selector(applyRedactions))
92
            navigationItem.setRightBarButtonItems([annotationButtonItem, activityButtonItem, outlineButtonItem, redactButton], for: .document, animated: false)
93
        }
94

95
        @objc func applyRedactions() {
96
            let processorConfiguration = Processor.Configuration(document: document)!
97
            processorConfiguration.applyRedactions()
98

99
            let redactedDocumentURL = FileHelper.temporaryPDFFileURL(prefix: "redacted")
100
            let processor = Processor(configuration: processorConfiguration, securityOptions: nil)
101
            try! processor.write(toFileURL: redactedDocumentURL)
102

103
            self.document = Document(url: redactedDocumentURL)
104
        }
105
    }
106
}