Update readme.

Author: RenZhu Macro

Examples/SimpleFourSquareVideo/SimpleFourSquareVideo/ViewController.swift

@@ -37,17 +37,13 @@ class ViewController: UIViewController {
         let backgroundFrame = self.renderView.frame
         let backgroundSize = CGSize(width: backgroundFrame.size.width * 1.5,
                                     height: backgroundFrame.size.height * 1.5)
-        MetalVideoProcessBackground.canvasSize = backgroundSize
-        
+        MetalVideoProcessBackground.canvasSize = backgroundSize  
 
         let transform1 = MetalVideoProcessTransformFilter()
         let transform2 = MetalVideoProcessTransformFilter()
         let transform3 = MetalVideoProcessTransformFilter()
         let transform4 = MetalVideoProcessTransformFilter()
-        
-     
-    
-        
+
         transform1.stretchType = .aspectToFit
         transform1.roi = CGRect(x: 0.1, y: 0.1,
                                 width: 0.8,
@@ -83,49 +79,37 @@ class ViewController: UIViewController {
             player.addTarget(transform4, trackID: item4.trackID, targetTrackId: item4.trackID)
 
             transform1.saveUniformSettings(forTimelineRange: item1.timeRange, trackID: item1.trackID)
-//
+
             transform2.saveUniformSettings(forTimelineRange: item2.timeRange, trackID: item2.trackID)
-//
+
             transform3.saveUniformSettings(forTimelineRange: item3.timeRange, trackID: item3.trackID)
-//
+
             transform4.saveUniformSettings(forTimelineRange: item4.timeRange, trackID: item4.trackID)
 
             let layer1 = MetalVideoProcessBlendFilter()
 
             background --> layer1
             transform1 --> layer1
-            
-//            layer1.saveUniformSettings(forTimelineRange: item1.timeRange, trackID: item1.trackID)
 
             let layer2 = MetalVideoProcessBlendFilter()
 
             layer1 --> layer2
             transform2 --> layer2
-//
-//            layer2.saveUniformSettings(forTimelineRange: item2.timeRange, trackID: item2.trackID)
-//
+
             let layer3 = MetalVideoProcessBlendFilter()
 
             layer2 --> layer3
             transform3 --> layer3
-//            layer3.saveUniformSettings(forTimelineRange: item3.timeRange, trackID: item3.trackID)
-            
+   
             let layer4 = MetalVideoProcessBlendFilter()
 
             layer3 --> layer4
             transform4 --> layer4
-//            layer4.saveUniformSettings(forTimelineRange: item4.timeRange, trackID: item4.trackID)
-//
-            
+     
             self.progress.minimumValue = 0.0
             self.progress.maximumValue = Float(playerItem.duration.seconds)
-           
 
-           
             layer4 --> renderView
-//            layer3 --> self.renderView
-//            transform1 --> self.renderView
-
             self.player = player
             self.player?.playerDelegate = self
 

Examples/SimpleVideoExport/SimpleVideoExport/ViewController.swift

@@ -68,10 +68,7 @@ class ViewController: UIViewController {
             transform1.saveUniformSettings(forTimelineRange: item1.timeRange, trackID: item1.trackID)
 
             transform2.saveUniformSettings(forTimelineRange: item2.timeRange, trackID: item2.trackID)
-            
-            
-            
-            
+
             let layer1 = MetalVideoProcessBlendFilter()
 
             videoBackground --> layer1

README.md

@@ -1,3 +1,93 @@
 # MetalVideoProcess
 MetalVideoProcess is a High-Performance video effects processing framework. It's base on GPUImage3  & Cabbage with AVFoundation, support asynchronous and multithread processing.
 
+## Technical requirements
+
+- Swift 5.0
+- Xcode 10.2 or higher on Mac or iOS
+- iOS: 11.0 or higher
+- OSX: 10.11 or higher
+
+
+
+## General architecture
+
+MetalVideoProcess is built on  GPUImage3 & Cabbage. We extend the rendering pipeline in gpuimage3 to adapt the rendering output of one to many targets, so as to realize the rendering of multiple video clips.
+
+![Layer](/Users/renzhumacro/Documents/github/MetalVideoProcess/Readme/Layer.png)
+
+
+
+Architecture design of video transition:
+
+
+
+![videoTransitionDesign](/Users/renzhumacro/Documents/github/MetalVideoProcess/Readme/videoTransitionDesign.png)
+
+
+
+## Getting Started
+
+Compile& import Framework
+
+```swift
+import MetalVideoProcess
+```
+
+
+
+## How to use
+
+```swift
+let asset1 = AVAsset(url: Bundle.main.url(forResource: "test", withExtension: "mp4")!)
+let item1 = MetalVideoEditorItem(asset: asset1)
+
+do {
+	let editor = try MetalVideoEditor(videoItems: [item1])
+	let playerItem = editor.buildPlayerItem()
+	let player = try MetalVideoProcessPlayer(playerItem: playerItem)
+            
+	let beautyFilter1 = MetalVideoProcessBeautyFilter()
+  player -- > beautyFilter1 --> renderView
+	self.player = player
+	self.player?.playerDelegate = self
+          
+} catch {
+	debugPrint("init error")
+}
+```
+
+
+
+## Sample
+
+**SimpleFourSquareVideo**
+
+iOS/Examples/SimpleFourSquareVideo 
+
+
+
+**SimpleRealtimeFilterPlayback**
+
+iOS/Examples/SimpleRealtimeFilterPlayback
+
+
+
+**SimpleVideoExport**
+
+iOS/Examples/SimpleVideoExport 
+
+
+
+**SimpleVideoEditor** 
+
+iOS/Examples/SimpleVideoEditor
+
+
+
+**SimpleVideoTransition**
+
+iOS/Examples/SimpleVideoTransition
+
+
+