View source for SSIM

{{FilterCat5|External_filters|Plugins|Plugins_x64|Other_filters|Debugging/Diagnostic_filters}}
{{Filter3
| [http://web.archive.org/web/20060507012947/http://perso.wanadoo.fr/reservoir/ Lefungus], 
| v0.25.1.0
| 3=[http://www.wilbertdijkhof.com/SSIM0.25.1.0.rar SSIM0.25.1.0.rar]
| 4=Debug filter
| 5=
| 6=[http://forum.doom9.org/showthread.php?t=61128 Doom9 Thread]}}

== Description ==
A filter that compute an objective video quality metric between two videos. Based on SSIM work from [http://www.cns.nyu.edu/~zwang/files/research/ssim/index.html Zhou Wang].  
<br>
<br>
== Requirements ==
* AviSynth 2.6 or [http://sourceforge.net/projects/avisynth2/ greater] | [[AviSynth+]]
* x64 requires x64 AviSynth+
* Supported color formats: [[YV12]]
<br>
== [[Script variables|Syntax and Parameters]] ==
:{{Template:FuncDef|SSIM (clip, clip, string, string, int "lumimask", int "scaled")}}
:{{Template:FuncDef|SSIM_FRAME (clip, clip)}}
:{{Template:FuncDef|SSIM_Y_FRAME (clip, clip)}}
:{{Template:FuncDef|SSIM_U_FRAME (clip, clip)}}
:{{Template:FuncDef|SSIM_V_FRAME (clip, clip)}}
<br>
::{{Par2| |clip| }}
:::clip1 and clip2 are the reference clip and the compressed clip.
<br>
::{{Par2| |string|"results.csv"}}
:::The file where obtained SSIM values will be written (this can be easily read in excel or notepad for those unfamiliar with the comma separated variables format)
<br>
::{{Par2| |string|"globalSSIM.txt"}}
:::The file where global SSIM values will be written.
<br>
::{{Par2|lumimask|int|1}}
:::This filter is designed to compute an SSIM value by three methods, the original one, and a "enhanced" one that weight these results by lumimasking.
:::0 : lumamasking disabled
:::1 : lumamasking enabled (original method)
:::2 : lumamasking enabled (new method as proposed by On2Tech) - see discussion [https://forum.doom9.org/showthread.php?t=92532 here] and [https://forum.doom9.org/showthread.php?p=626354#post626354 here] for more info.
<br>
::{{Par2|scaled|int|1}}
:::The global score is scaled from 0 to 100 instead of 0 to 1. Set to false if you prefer it non-scaled.
:::0 : false
:::1 : true
<br>

==Examples==
[[TODO]]

<br>
== Changelog ==
 Version      Date            Changes<br>
 v0.25.1.0    ????/??/??      - Modifications by On2Tech, see [https://forum.doom9.org/showthread.php?t=92532 discussion]
                              - add "SSIM_FRAME", "SSIM_Y_FRAME", "SSIM_U_FRAME", "SSIM_V_FRAME" functions
 v0.24a       2005/04/05      - change "lumimask" and "scaled" from bool to integer
                              - add "lumimask=2" mode
 v0.24        2004/06/06      - various bugfixes
 v0.23                        - minor memory leak removed
 v0.22                        - added "scaled" parameter
 v0.21                        - flag for globalSSIM added
                              - some checks added
 v0.20        2003/09/10      - Updated. It is somewhat faster, and include lumimasking.   
<br>

== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v0.25.1.0
|[http://www.wilbertdijkhof.com/SSIM0.25.1.0.rar SSIM0.25.1.0.rar]
|[https://web.archive.org/web/20200320062551if_/http://www.wilbertdijkhof.com/SSIM0.25.1.0.rar SSIM0.25.1.0.rar]
|-
!v0.24a
|[http://www.wilbertdijkhof.com/ssim-0.24a.zip ssim-0.24a.zip]
|[https://web.archive.org/web/20200320062257/http://www.wilbertdijkhof.com/ssim-0.24a.zip ssim-0.24a.zip]
|-
!v0.24
|Binary: [https://web.archive.org/web/20040725013150if_/http://perso.wanadoo.fr:80/reservoir/dl/SSIM-0.24.rar SSIM-0.24.rar] /// Source: [https://web.archive.org/web/20040609231638if_/http://perso.wanadoo.fr:80/reservoir/dl/SSIMSrc-0.24.rar SSIMSrc-0.24.rar]
|
|-
!v0.23
|Binary: [https://web.archive.org/web/20040406100420if_/http://perso.wanadoo.fr:80/reservoir/dl/SSIM-0.23.rar SSIM-0.23.rar] /// Source: [https://web.archive.org/web/20040406104135if_/http://perso.wanadoo.fr:80/reservoir/dl/SSIMSrc-0.23.rar SSIMSrc-0.23.rar]
|
|}

<br>
<br>
==External Links ==
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Debugging.2FDiagnostic_Filters|External Filters]] &larr;'''