Add document

.gitignore

@@ -0,0 +1,5 @@
+build/
+*.o
+.vscode
+.vs
+*~

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Xinyue Lu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,49 @@
+# Neo Temporal Median
+
+Neo Temporal Median Copyright(C) 2020 Xinyue Lu
+
+Temporal Median is a temporal denoising filter. It replaces every pixel with the median of its temporal neighbourhood.
+
+SSE4.1 is required to run optimized routine up to radius=6. AVX2 and AVX512BW routine is also available. AVX512BW is untested due to lack of hardware.
+
+## Usage
+
+```python
+# AviSynth+
+LoadPlugin("neo-tmedian.dll")
+neo_tmedian(clip, radius=1, y=3, u=3, v=3, ...)
+# VapourSynth
+core.neo_tmedian.TemporalMedian(clip, radius=1, planes=[0,1,2], ...)
+```
+
+Parameters:
+
+- *clip*
+
+    Input clip. Currently supporting 8..16 bit integer and 32 bit float format.
+
+- *radius*
+
+    Neighbor frames radius. SIMD optimization supports up to 6.
+
+    Default: 1.
+
+- *y*, *u*, *v* (AviSynth+ only)
+
+    Whether a plane is to be filtered.
+
+        1 - Do not touch, leaving garbage data
+        2 - Copy from origin
+        3 - Process
+
+    Default: 3.
+
+- *planes* (VapourSynth only)
+
+    Planes to be filtered.
+
+    Default: [0,1,2].
+
+## License
+
+* MIT.