View source for DeDot

{{FilterCat5|External_filters|Plugins|Plugins_x64|Restoration_filters|Rainbow & Dot Crawl Removal}}
{{Filter3
|1={{Author/thejam79}}, {{Author/minamina}}, {{Author/dubhater}}, {{Author/Asd-g}}
|2= v1.2.1
|3=[https://github.com/Asd-g/AviSynth-DeDot/releases DeDot]
|4=Rainbow & Dot Crawl Removal
|5=[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=}}

== Description ==
Spatial and temporal plugin to reduce cross-luminance (dot crawl) and cross-color (rainbows).

The luma and the chroma are filtered completely independently from each other. It doesn't filter moving objects.
<br>
<br>
== Requirements ==
* [x86] [[AviSynth+]] or [http://sourceforge.net/projects/avisynth2/ AviSynth 2.60]
* [x64] [[AviSynth+]]
* Supported color formats: [[Y8]], [[YV12]], [[YV16]], [[YV24]]
**AviSynth+: all [[planar]] Y, YUV, formats (8/10/12/14/16-bit) are supported.
<br>
* [https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads Microsoft Visual C++ 2019 Redistributable Package (x86 / x64)]
:<span style="color:red">***</span> <tt>vc_redist.x86.exe</tt> is required for <tt>DeDot-x86</tt>
:<span style="color:red">***</span> <tt>vc_redist.x64.exe</tt> is required for <tt>DeDot-x64</tt>
<br>
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|DeDot (''clip'', ''int'' "luma2d", ''int'' "lumaT", ''int'' "chromaT1", ''int'' "chromaT2", ''int'' "opt")}}
<br>
::{{Par2| |clip| }}
:::Input clip. It must have constant format and dimensions and it must be 8 bit Gray or YUV.
<br>
::{{Par2|luma2d|int|20}}
:::Spatial luma threshold. Must be between 0 and 510.
:::Lower values consider more pixels as cross-luminance.
:::If <code>luma_2d=510</code>, the luma is returned without any processing.
<br>
::{{Par2|lumaT|int|20}}
:::Tolerance for temporal variation in the luma channel (Y). Must be between 0 and 255.
:::Higher values consider more pixels as cross-luminance.
:::If <code>luma_t=0</code>, the luma is returned without any processing.
<br>
::{{Par2|chromaT1|int|15}}
:::Tolerance for temporal variation in the chroma channels (U,V). Must be between 0 and 255.
:::Higher values consider more pixels as cross-color.
<br>
::{{Par2|chromaT2|int|5}}
:::Temporal chroma threshold. Must be between 0 and 255.
:::Lower values consider more pixels as cross-color.
:::If <code>chroma_t2=255</code>, the chroma is returned without any processing.
<br>
::{{Par2|opt|int|-1}}
:::Sets which cpu optimizations to use.
:::-1 : Auto-detect.
:::0 : Use C++ code.
:::1 : Use SSE2 code.
:::2 : Use AVX2 code.
<br>

== Examples ==
'''DeDot with all default values:'''
 MPEG2Source("DotCrawl.d2v")
 DeDot(luma2d=20, lumaT=20, chromaT1=15, chromaT2=5)
<br>
'''Reduce dot crawl only:'''
*Adjust luma2d and lumaT accordingly.
 MPEG2Source("DotCrawl.d2v")
 DeDot(luma2d=20, lumaT=20, chromaT1=0, chromaT2=255)
<br>
'''Reduce rainbows only:'''<br>
*Adjust chromaT1 and chromaT2 accordingly.
 MPEG2Source("Rainbows.d2v")
 DeDot(luma2d=510, lumaT=0, chromaT1=15, chromaT2=5)
<br>
== How it works ==
Written by [http://forum.doom9.org/showpost.php?p=695072&postcount=10 tritical]
<br>
<br>
I'll give a quick explanation of how the parameters are used in relation to pixel values (this is all taken simply from reading the source code).<br>
Its operation is quite simple, which is why it is very fast and is able to be written completely in [[MMX]].
<br>
<br>
<br>
For filtering luma (dot crawl) it uses luma2d and lumaT...
Consider 'e' to be the current pixel and a,b,c,d,f,g,h,i to be its spatial neighbors in the current frame:

:{| class="wikitable" style="text-align: center; width: 75px; height: 75px;"
|-
| a
| b
| c
|-
| d
| <span style="color:red">e</span>
| f
|-
| g
| h
| i
|}

DeDot first uses the following two tests:

:abs(b+h-2*e) > luma2d
:abs(d+f-2*e) > luma2d

If either of those conditions is met it goes on and tests the following conditions else it drops out w/o doing any filtering on that luma pixel.<br>
For the next tests consider pixel 'c' to be the pixel in the current frame and a,b,d,e to be its temporal neighbors in adjacent frames:

:{| class="wikitable" style="text-align: center; width: 100px; height: 25px;"
| a
| b
| <span style="color:red">c</span>
| d
| e
|}

:abs(c-a) <= lumaT
:abs(c-e) <= lumaT
:abs(b-d) <= lumaT

If all three of those conditions are met it decides that the pixel needs to be filtered and it either averages the current pixel 'c' with 'b' or 'd' based on whichever one is closer to the value of 'c'.
<br>
<br>
<br>
Chroma filtering (rainbow removal) works in the following way. First it tests the following conditions... Again assume 'c' is from the current frame and a,b,d,e are the temporal neighbors:

:{| class="wikitable" style="text-align: center; width: 100px; height: 25px;"
| a
| b
| <span style="color:red">c</span>
| d
| e
|}

:abs(c-a) <= chromaT1
:abs(c-e) <= chromaT1
:abs(b-d) <= chromaT1
:abs(c-b) > chromaT2
:abs(c-d) > chromaT2

If all five of those conditions are met then it does filtering on the pixel. For the filtering it either averages the current pixel 'c' with 'b' or 'd' based on whichever one is closer to the value of 'c'.

Hope that helps explain the parameters a little bit better.
<br>
<br>

== Changelog ==
  2021/09/07 v1.2.1
      - Improved luma spatial and temporal check (SIMD) resulting to a bit faster code.<br>
  2021/09/05 v1.2.0
      - Throw error for non-planar formats.
      - Added support for 10..16-bit clips.
      - Separated SSE2 code.
      - Added AVX2 code.
      - Added parameter <code>opt</code>.<br>
  2020/05/15 v1.1.0
      - Move project to GitHub<br>
  2019/06/07
      - Backport DeDot from VapourSynth port by Dubhater
      - Add Y8, YV16, YV24 and drop YUY2 support
      - x64 version
      - Compiled with Microsoft Visual Studio C++ 2017
      - Author: Asd<br>
  2003/11/22 v0.0.02
      - Fixed an issue where garbage was generated vertically when used after Crop<br>
  2003/05/18 v0.0.01:
      - Initial release by minamina
      - AviSynth 2.5 support and add YV12 colorpace
      - The official name of this plugin is DeDot_YV12 and is based on DeDot v0.3 by thejam79
<br>
== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v0.0.02
|[http://nullinfo.s21.xrea.com/data/DeDot_YV12_0002.zip DeDot_YV12_0002.zip]
|[https://web.archive.org/web/20160314015603/http://nullinfo.s21.xrea.com/data/DeDot_YV12_0002.zip DeDot_YV12_0002.zip]
|-
!v0.0.01
|[http://nullinfo.s21.xrea.com/data/DeDot_YV12_0001.zip DeDot_YV12_0001.zip]
|[https://web.archive.org/web/20200520170447/http://nullinfo.s21.xrea.com/data/DeDot_YV12_0001.zip DeDot_YV12_0001.zip]
|}
<br>
==External Links ==
*[http://forum.doom9.org/showthread.php?t=98219 Doom9 Forum] - DeDot discussion and English translation by niiyan.
*[http://forum.doom9.org/showthread.php?t=84967 Doom9 Forum] - DeDot discussion and English translation by helix. In the last post, tritical explains how DeDot works.
*[http://forum.doom9.org/showthread.php?p=962514#post962514 Doom9 Forum] - DeDot discussion about correct usage, English translation, and some history of DeDot by niiyan.
*[http://www.aquilinestudios.org/avsfilters/dotcrawl.html#dedot Scintilla's Guide] - English documentation by Scintilla.
*[https://github.com/Asd-g/AviSynth-DeDot GitHub] - Source code repository.
*[https://github.com/dubhater/vapoursynth-dedot GitHub] - Source code repository (VapourSynth version).
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Rainbow_.26_Dot_Crawl_Removal|External Filters]] &larr;'''