View source for EEDI3CL

{{FilterCat6|External_filters|Plugins|Plugins_x64|Restoration_filters|Deinterlacers|Deep_color_tools}}
{{Filter3
|1={{Author/Asd-g}}
|2=v1.0.0
|3=[https://github.com/Asd-g/AviSynthPlus-EEDI3CL/releases EEDI3CL-1.0.0.7z ]
|4=Deinterlacing 
|5=[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=
}}

== Description ==
[[EEDI3CL]] is an [https://en.wikipedia.org/wiki/OpenCL OpenCL] implementation of [[eedi3]]. It works by finding the best non-decreasing (non-crossing) warping between two lines by minimizing a cost functional. The cost is based on neighborhood similarity (favor connecting regions that look similar), the vertical difference created by the interpolated values (favor small differences), the interpolation directions (favor short connections vs long), and the change in interpolation direction from pixel to pixel (favor small changes).<br>

This is [https://github.com/HomeOfVapourSynthEvolution/VapourSynth-EEDI3 a port of the VapourSynth plugin EEDI3CL].
<br>
<br>
== Requirements ==
* [x64]: [[AviSynth+]]
* Supported color formats: all [[planar]] formats (8/10/12/14/16/32bit, Y/YUV/RGB with or without alpha) are supported.
<br>

== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef| EEDI3CL (clip input, int "field", bool "dh", int_array "planes", float "alpha", float "beta", float "gamma", int "nrad", int "mdis", bool "hp", bool "ucubic", bool "cost3", int "vcheck", float "vthresh0", float "vthresh1", float "vthresh2", clip "sclip", int "opt", int "device", bool "list_device", bool "info")}}
<br>
::{{Par2| |clip| }}
:::A clip to process.
:::It must be in 8..32-bit planar format.
<br>
::{{Par2|field|int|}}
:::Controls the mode of operation (double vs same rate) and which field is kept.
:::*-2: = Double rate (alternates each frame), <code>_FieldBased</code> frame property order or if <code>_FieldBased</code> is 0, or missing - AviSynth internal order.
:::*-1: Same rate, <code>_FieldBased</code> frame property order or if <code>_FieldBased</code> is 0, or missing - AviSynth internal order.
:::*0 = same rate, keep bottom field
:::*1 = same rate, keep top field
:::*2 = double rate (alternates each frame), starts with bottom
:::*3 = double rate (alternates each frame), starts with top
:::Default: -1
<br>
::{{Par2|dh|bool|false}}
:::Doubles the height of the input. Each line of the input is copied to every other line of the output and the missing lines are interpolated. 
:::If {{Template:FuncDef|field}}=0, the input is copied to the odd lines of the output. If {{Template:FuncDef|field}}=1, the input is copied to the even lines of the output. 
:::{{Template:FuncDef|field}} must be set to either 0 or 1 when using {{Template:FuncDef|dh}}=true.
:::Default: False
<br>
::{{Par2|planes|int_array|[0,1,2,3]}}
:::Sets which planes will be processed.
:::Planes that are not processed will contain uninitialized memory.
:::Default: [0,1,2,3]
<br>
::{{Par2|alpha|float|0.2}}
::{{Par2|beta|float|0.25}}
::{{Par2|gamma|float|20.0}}
:::These trade off line/edge connection vs artifacts created.
:::<code>alpha</code> and <code>beta</code> must be in the range [0,1], and the sum alpha+beta must be in the range [0,1].
:::<code>alpha</code> is the weight given to connecting similar neighborhoods. The larger <code>alpha</code> is the more lines/edges should be connected.
:::<code>beta</code> is the weight given to vertical difference created by the interpolation. The larger <code>beta</code> is the less edges/lines will be connected (at 1.0 you get no edge directedness at all).
:::The remaining weight (1.0-alpha-beta) is given to interpolation direction (large directions (away from vertical) cost more). So the more weight you have here the more shorter connections will be favored.
:::Finally, <code>gamma</code> penalizes changes in interpolation direction, the larger <code>gamma</code> is the smoother the interpolation field between two lines (range is [0,inf].
:::If lines aren't getting connected then increase alpha and maybe decrease <code>beta/gamma</code>. Go the other way if you are getting unwanted artifacts.
:::Default: alpha = 0.2, beta = 0.25, gamma = 20.0.
<br>
::{{Par2|nrad|int|2}}
::{{Par2|mdis|int|20}}
:::<code>nrad</code> sets the radius used for computing neighborhood similarity. Valid range is [0,3].
:::<code>mdis</code> sets the maximum connection radius. Valid range is [1,40].
:::If <code>mdis=20</code>, then when interpolating pixel (50,10) (x,y), the farthest connections allowed would be between (30,9)/(70,11) and (70,9)/(30,11).
:::Larger <code>mdis</code> will allow connecting lines of smaller slope, but also increases the chance of artifacts.
:::Larger <code>mdis</code> will be slower.
:::Larger <code>nrad</code> will be slower.
:::Default: nrad = 2, mdis = 20.
<br>
::{{Par2|hp|bool|False}}
::{{Par2|ucubic|bool|True}}
::{{Par2|cost3|bool|True}}
:::These are speed vs quality options.
:::<code>hp=True</code> - use half pel steps, hp=False - use full pel steps. Currently only full pel is implemented and this parameter has no effect.
:::<code>ucubic=True</code> - use cubic 4 point interpolation, <code>ucubic=False</code> - use 2 point linear interpolation.
:::<code>cost3=True</code> - use 3 neighborhood cost function to define similarity, <code>cost3=False</code> - use 1 neighborhood cost function.
:::Default: hp = False, ucubic = True, cost3 = True.
<br>
::{{Par2|vcheck|int|2}}
::{{Par2|vthresh0|float|32.0}}
::{{Par2|vthresh1|float|64.0}}
::{{Par2|vthresh2|float|4.0}}
::{{Par2|sclip|clip|undefined}}
<div style="margin-left: 6em; max-width: 67em">
<pre>
  vcheck settings:

      0 - no reliability check
      1 - weak reliability check
      2 - med reliability check
      3 - strong reliability check

  If vcheck is greater than 0, then the resulting interpolation is checked for reliability/consistency. Assume
  we interpolated pixel 'fh' below using dir=4 (i.e. averaging pixels bl and cd).

       aa ab ac ad ae af ag ah ai aj ak al am an ao ap
                            eh          el
       ba bb bc bd be bf bg bh bi bj bk bl bm bn bo bp
                fd          fh          fl
       ca cb cc cd ce cf cg ch ci cj ck cl cm cn co cp
                gd          gh
       da db dc dd de df dg dh di dj dk dl dm dn do dp

  When checking pixel 'fh' the following is computed:

        d0 = abs((el+fd)/2 - bh)
        d1 = abs((fl+gd)/2 - ch)

        q2 = abs(bh-fh)+abs(ch-fh)
        q3 = abs(el-bl)+abs(fl-bl)
        q4 = abs(fd-cd)+abs(gd-cd)

        d2 = abs(q2-q3)
        d3 = abs(q2-q4)

        mdiff0 = vcheck == 1 ? min(d0,d1) : vcheck == 2 ? ((d0+d1+1)>>1) : max(d0,d1)
        mdiff1 = vcheck == 1 ? min(d2,d3) : vcheck == 2 ? ((d2+d3+1)>>1) : max(d2,d3)

        a0 = mdiff0/vthresh0;
        a1 = mdiff1/vthresh1;
        a2 = max((vthresh2-abs(dir))/vthresh2,0.0f)

        a = min(max(max(a0,a1),a2),1.0f)

        final_value = (1.0-a)*fh + a*cint


    ** If sclip is supplied, cint is the corresponding value from sclip. If sclip isn't supplied,
       then vertical cubic interpolation is used to create it.
</pre>
</div>
:::Default: vcheck = 2, vthresh0 = 32.0, vthresh1 = 64.0, vthresh2 = 4.0, sclip = not specified.
<br>
::{{Par2|opt|int|-1}}
:::Sets which cpu optimizations to use.
:::*-1: Auto-detect.
:::*0: Use C++ code.
:::*1: Use SSE2 code.
:::Default: -1.
<br>
::{{Par2|device|int|}}
:::Sets target OpenCL device.
:::Use list_device to get the index of the available devices.
:::By default the default device is selected
<br>
::{{Par2|list_device|bool|false}}
::: Whether to draw the devices list on the frame.
<br>
::{{Par2|info|bool|false}}
:::Whether to draw the OpenCL-related info on the frame.
<br>

==Examples==
Deinterlace:
 [[AviSource]]("Blah.avi")
 EEDI3CL(field=1) # single rate TFF
 #EEDI3CL(field=3) # double rate TFF

Enlarge by 2x and correct for center shift using Spline36Resize:
 [[AviSource]]("Blah.avi")
 TurnLeft().EEDI3CL(field=1, dh=true).TurnRight().EEDI3CL(field=1, dh=true)
 Spline36Resize(Width(), Height(), src_left=-0.5, src_top=-0.5)

<br>
== Changelog ==
 Version      Date            Changes<br>
 v1.0.0       2022/11/28      - Initial release
<br>

== External Links ==
*[https://github.com/Asd-g/AviSynthPlus-EEDI3CL GitHub] - Source code repository.
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Deinterlacing|External Filters]] &larr;'''