AvsPmod (x86)

From BakaBT Wiki
Revision as of 22:43, 4 January 2022 by Theworm4002 (talk | contribs) (Required Components)
Jump to: navigation, search

AvsPmod

Required Components

Out Of Date

Basic requirements

Software Version
AviSynth 2.6 Download
AvsPmod 2.5.1 (+upd. library) Download
Premade Plugin folder See below Download
Old Plugin Links
Dither Avisynth Tools 1.23.0 Download
Masktools2 2.2.10 Download
xy-vsfilter 3.0.0.232 (cccp) Download
SUPTitle 2.0.8 Download
FFInfoEx r1 Download
assrender found to work better then SUPTitle in some cases Download

This tutorial also assumes you're running a fully updated Windows 7/8/10 machine with all recent VC++ distributables, .net Frameworks and whatnot. Things probably also work on Vista/XP and you might even get them to run with Wine on Linux, but you're on your own. The H265 compatible version should work as well as the old version, however if you have problems and don't need to compare H265 then use the old one. It's also recommended to use a fully up to date ffms2 version for H265, but if you're lazy the h264-10bit compatible+H265 compatible should do the job.

Now I'm keeping the old list of plugins around, but instead this time around I'll be compiling a simple plugin archive. Simply extract it into your folder and it should work.

Additional requirements for the subtitle extraction script

Software Version
MKVToolNix 19.0.0 Download

Deprecated and Complicated extraction method:

Software Version
Windows Powershell 3.0 Download (x86) / Download (x64)

Installed by default on Win 8, Win 7 SP1 users need to upgrade.
No XP/Vista support.

Microsoft .NET Framework 4.5 Download (Prerequisite for Powershell 3)
MKVToolNix 6.3.0 Download
SIL FontUtils 1.00 Download
ExRelease 0.9.6 Download
ExRelease-Export 0.7 Download

Setting up the environment

  1. Install AviSynth
  2. Open your AviSynth plugins directory in Explorer
    Unless you changed the the AviSynth install location, your plugins directory should be
    (enter these into your explorer location bar):
    • [On 64-bit Windows] %ProgramFiles(x86)%\AviSynth 2.5\plugins
    • [On 32-bit Windows] %ProgramFiles%\AviSynth 2.5\plugins
    There should be only 3 files inside the directory: colors_rgb.avsi, DirectShowSource.dll, TCPDeliver.dll
  3. Open the Dither Avisynth Tools archive (dither-1.23.0.zip) and unpack the following files to your AviSynth plugin directory:
    • avstp.dll
    • dither.avsi
    • dither.dll
    • mt_xxpand_multi.avsi
    The docs folder inside the archive contains detailed documentation on the dither tools, so you might want to extract this to your AviSynth Docs directory or anywhere else you'll find it in case you need it later
  4. Open the downloaded ffms2 archive and extract the contents into your Avisynth plugin directory
    • ffms2.dll
    • ffmsindex.exe
  5. Open the downloaded masktools archive and extract the correct masktools2.dll to your AviSynth plugin directory. If on XP use the file found in the x86_xp Folder, otherwise the x86 folder's file is correct. If you're running a 64bit setup use the x64 files.
  6. Open the downloaded SupTitle archive and extract the contents into your Avisynth plugin directory
    • msvcp100.dll
    • msvcr100.dll
    • SupCore.dll
    • SupTitle.dll
  7. Open the downloaded AvsPmod archive and extract the AvsPmod folder to:
    • On 64-bit Windows: %ProgramFiles(x86)%
    • On 32-bit Windows: %ProgramFiles%
    Create a shortcut to avspmod.exe, or pin it to the taskbar/start menu
  8. Copy the downloaded VSFilter.dll and FFInfoEx.avsi to your Avisynth plugin directory

Getting started with screenshot comparisons

  1. Start AvsPmod and open the settings dialog (Options > Program settings)
    1. On the User Sliders tab check Hide slider window by default (The slider window usually only gets in the way)
    2. If you are using more than one screen, it's usually wise to check the Seperate preview window option, so you can have one screen dedicated to the video and one to the script
    3. On the Misc tab, uncheck the Show warning for bad plugin naming at startup option
  2. Go to Options > Snippets and click on Insert. Insert the following script template as snippet and give it a tag you will remember
    (Script by Firesledge with a few additions)
  3. #############################################################################
    #######################   -Options, Settings-   #############################
    #############################################################################
    
    vidfile = "VIDEOFILE"
    subfile = "SUBFILE"
    group = "GROUPNAME"
    
    #Unless upscaling leave these as 0, else add desired values
    upscale_width = 0
    upscale_height = 0
    
    Logging = false
    display_group = true
    displayFramNum = false
    display_timecode = false
    display_subtitles =  true
    
    # Adding blank frames in front or back of the VidClp
    Front_FramePadding = 0
    Back_FramePadding = 0
    
    #############################################################################
    ##################   -Should Not Need To Change-   ##########################
    #############################################################################
    
    ## creating file and set path for future log entries:
    (Logging) ? Eval("""
    	folder = ScriptDir()
    	(RightStr(folder, 1) == "\") ?
       \     SetLogParams(folder + group + "_ScriptLog.log", LOG_INFO): SetLogParams(folder + "\" + group + "_ScriptLog.log", LOG_INFO)
    	LogMsg("Starting Logger", LOG_INFO)
    	""")
    \:nop()  
    
    c1  = FFVideoSource (vidfile, enable10bithack=false, colorspace="YV12")
    c2  = FFVideoSource (vidfile, enable10bithack=true, varprefix="c1_", colorspace="YV12")
    
    (StrLen(subfile) == 0) ? Eval("""
        F_blank1 = BlankClip(c1, length= Front_FramePadding)  
        B_blank1 = BlankClip(c1, length= Back_FramePadding)
        c1 = F_blank1+c1+B_blank1
       
        F_blank2 = BlankClip(c2, length= Front_FramePadding)  
        B_blank2 = BlankClip(c2, length= Back_FramePadding)
        c2 = F_blank2+c2+B_blank2    
        
        """):
    \nop()
    
    w   = c1.Width ()
    h   = c1.Height ()
    wm4 = (w + 3) / 4 * 4
    hm4 = (h + 3) / 4 * 4
    b10 = (c2.Height () > c1.Height ())
    
    target_width = (upscale_width > 0) ?  upscale_width : w
    target_height = (upscale_height > 0) ? upscale_height : h
    
    matrix   = (c1_FFCOLOR_SPACE == 1) ? "709"
    \        : (c1_FFCOLOR_SPACE >= 5) ? "601" : Dither_undef ()
    par      = (c1_FFSAR_NUM > 0 && c1_FFSAR_DEN > 0)
    \        ? Float (c1_FFSAR_NUM) / Float (c1_FFSAR_DEN)
    \        : Dither_undef ()
    tv_range = (c1_FFCOLOR_RANGE != 2)
    
    (b10) ? c2 : c1
    
    #Adding Subs based on the file ext
    Subs = (StrLen(subfile) > 0 && display_subtitles) ?
    \      (RightStr(LCase(subfile), 3) == "sup") ?
    \         	(b10) ? Dither_limit_dif16(DitherPost(mode=-1).SupTitle(subfile).Dither_convert_8_to_16 (), thr=1.0, elast=2.0) : SupTitle(subfile)
    \          :(RightStr(LCase(subfile), 3) == "sub") ?
    \         	(b10) ? Dither_limit_dif16(DitherPost(mode=-1).VSFilter_Vobsub(subfile).Dither_convert_8_to_16 (), thr=1.0, elast=2.0) : 
    VSFilter_Vobsub(subfile)
    \          :(b10) ? Dither_limit_dif16(DitherPost(mode=-1).TextSub(subfile).Dither_convert_8_to_16 (), thr=1.0, elast=2.0) : TextSub(subfile)
    \: nop()
    
    #Add blank frames if needed
    (StrLen(subfile) > 0 && display_subtitles) ? Eval("""
        F_blank2 = BlankClip(Subs, length= Front_FramePadding)  
        B_blank2 = BlankClip(Subs, length= Back_FramePadding)
        F_blank2+Subs+B_blank2
        """):
    \nop()
    
    (VersionNumber () >= 2.6) ? last
    \ : (b10) ? Dither_addborders16 (0, 0, wm4 - w, hm4 - h)
    \         : AddBorders (0, 0, wm4 - w, hm4 - h)
    
    (target_width != c1.Width() || target_height != c1.Height()) ? Dither_srgb_display (lsb_in=b10, matrix=matrix, par=par, tv_range=tv_range, w=target_width, 
    h=target_height)
    \ :                                                            Dither_srgb_display (lsb_in=b10, matrix=matrix, par=par, tv_range=tv_range)
    
    cmt1 = (target_width > c1.Width() || target_height > c1.Height()) ? group + "\nupscaled" : group
    cmt2 = (display_group) ? 
    \                 cmt1 : ""
    
    FFInfoEx(framenum=displayFramNum,vfrtime=display_timecode, cfrtime=false, frametype=false, x=last.width-6, y=4, cmt=cmt2, align=9, shorttime=true)
    

  4. Now that you're all set, let's load the videos to compare.
    1. Click into the empty script window and hit F7 to get a list of your snippets. Since there's only the one snipped you just created, hit TAB to insert it
    2. Replace VIDEOFILE in the first line with the full path to an episode (e.g. C:/MyCoolVideos/Oruchuban Ebichu/Oruchuban Ebichu - 01-02 [Ampeg].avi) of the first release you want to compare and GROUPNAME in the last line with the appropriate group tag
    3. Hit F5 to load (or refresh) the video. Loading a file for the first time might take a few seconds, since the file is being indexed first.
    4. Save the script
    5. Hit Ctrl+N or double click next to the current tab to open a new script tab
    6. Repeat from Step 3a
  5. Syncing up the releases (easymode)
    1. Check if the video of all releases matches up, by going through them with Alt+1, Alt+2, Alt+3, ...
      The best way to do is is to seek to the last frame before a scene change, check if it matches up across tabs, then seek to the next frame and check again
      (Seek by using the arrow keys (left/right: 1 frame; up/down: 1 second) or clicking the timeline for larger time distances)

      Note: You may find out that not all subsequent frames match up or worse, the releases running out of sync over time. If it's only single frames, just avoid using them for screenshots. In case of releases running out of sync, you're dealing with either missing sections or different frame rates. Refer to the [Advanced Tutorial TBD] on how to deal with those cases.
    2. Once all releases you want to compare are in sync, right click their tabs and add them to a single group. Make sure the Apply offsets and Offset also bookmarks options are checked.
      AvsPmod will now remember the frame offsets between tabs and automatically seek to the right frames on a shared timeline.
    1. To reasonably compare screenshots, we need all frame sizes to be of the same resolution. You should have noticed any differences already while syncing up the releases.
      If all resolutions match, skip this step. If they don't, find out the highest resolution by looking at the bottom right of the status bar.
      The information will be in the following format: FrameWidth x FrameHeight (AspectRatio) - Framerate fps - Colorspace
    2. Take the largest width and height among the releases and find the following section in the scripts for all releases that need to be resized:
      upscale_width = 0
      upscale_height = 0
      Replace the 0s with the largest FrameWidth and the largest FrameHeight
    3. Hit F5 to refresh the video preview and confirm everything works as expected.
  6. Select frames for the screenshot comparison
    1. Find a frame suitable to convey significant information about an aspect of video quality.
      Pick:
      • one or two frames of a structure that represents what is on the screen most of the episode (to give a general idea about the video quality)
      • frames from dark scenes
      • high-detail frames / frames with fine structures
      • frames with low contrast
      • frames from high-motion scenes
      • a frame or two from a fade-in/fade-out
      • frames that display video artifacts in one ore more releases (refer to this thread on how to spot and identify video artifacts)
      • at least one frame from the OP and one frame from the ED
      Try to get as many B-Frames as possible. Ideally you'd want matching frame types across the different releases.
      In practice checking this gets more of a waste of time with each additional release you have to compare. Just try to keep the number of B-to-I comparisons low and make sure you don't pick only B-Frames for one release and only P-Frames for the other.
      A very easy way to avoid this issue is to not pick frames by only looking at one release. This comes with the added benefit of you being more likely to spot video artifacts in ALL releases.
      (Check the overlay on the top right of the video frame to find the frame type of the current frame.)
    2. Once you've decided on a frame, hit Ctrl+B to bookmark it.
    3. Repeat from 6a for each additional frame
      If you want to check the frames you already bookmarked, hit F2/Shift+F2 to browse through your bookmarks
  7. Export screenshots
    1. Once you're done deciding on frames to screenshot (10-15 is a good number), it's time to export them to PNG.
      Go to Macros > Save image sequence (make sure Select frames is set to "Bookmarks" and Output format to "*.png")
    2. Pick an output directory and basename.
      I recommend using the basename format %06d_Groupname. This way your screenshots will (almost) always sort to comparison-friendly order by default. Make sure Add the frame number as suffix is checked when using %06d, otherwise it only counts up rather than inserting the current frame number.
      Example of Directory+Basename: Z:\ScreenCompare\Out\%06d_Zurako
      You may also want want to check the Use always this directory option since you need to run this macro for each release seperately.
    3. Click OK. You'll get a confirmation once the export is done.
    4. Repeat from step 7a for every open tab/release

Using MKVToolnix for subtitle extraction

  1. Run the MKVToolnix installer. If using the portable version: Extract the archive
  2. The installer will recommend downloading gMKVExtractGUI (portable users: It can be downloaded seperately, just place it in the appropriate folder) at some point. Do that if you don't know what CLI MKVExtract is and how to use it. Probably also do it if you know, I find that it simplifies the extraction.
  3. Run gMKVExtractGUI.exe
  4. Drag and Drop the file(s) that you want to extract the suptitles of.
  5. Select the tracks you wish to extract. Then click Extract
  6. That's it, the extracted files (on default settings) should be in the same folder as the source files.

Setting up the ExRelease extraction script (Deprecated and Complicated)

  1. Open Notepad or a text editor of your choice and type ;.
  2. Install MKVToolNix and copy the path to the destination folder into your notepad document.
    1. Append a ; to your notepad document. The contents should now look like this:
    2.   ;C:\Program Files (x86)\MKVToolNix;
      
  3. Install FontUtils and make sure the Add installation directory to PATH option is checked
  4. Remember your AviSynth plugin directory from the first tutorial? Copy its path to your notepad document and append another ";"
    Unless you changed the the AviSynth install location, your plugins directory should be
    (enter these into your explorer location bar to make them resolve to full paths):
    • [On 64-bit Windows] %ProgramFiles(x86)%\AviSynth 2.5\plugins
    • [On 32-bit Windows] %ProgramFiles%\AviSynth 2.5\plugins
    Make sure you append the full path to your notepad document, so it looks like this:
  5.   ;C:\Program Files (x86)\MKVToolNix;C:\Program Files (x86)\AviSynth 2.5\plugins;
    
  6. Unpack the ExRelease archive to
    • %userprofile%\Documents\WindowsPowerShell\Modules
  7. To make the tools you just installed available to the script and the script conveniently available from everywhere, we need to add their locations to your PATH environment variable
    1. Hit Win+Pause to open the System Control Panel
    2. Click on Advanced System Settings (on the left sidebar), which should open the System Properties Window
    3. Click on Environment Variables
    4. Browse the System variables until you find the Path variable. Highlight it and click on Edit...
    5. Click into the Variable value input field, and hit the End key to move the cursor behind the last entry (which should be your FontUtils path)
    6. Append the contents of your notepad document and hit Enter
    7. Click OK on the Environment Variables and System Properties to save the settings
  8. Run Windows PowerShell (you'll find it in the programs menu)
    1. Make sure you are running at least Powershell v3.0. Type
      $PSVersionTable.PSVersion
      into the command prompt and hit enter. If the number under Major says 3, you're good to go (continue with step 8)
    2. If it doesn't, install
      • [On 64-bit Windows] Windows6.1-KB2506143-x64.msu
      • [On 32-bit Windows] Windows6.1-KB2506143-x86.msu

      If the update fails with "The update is not applicable to your computer", you need to install the .NET Framework 4.5 (dotNetFx45_Full_setup.exe) first.
      You may need to restart your computer after installing Powershell 3.
      Open Windows PowerShell again and run

      $PSVersionTable.PSVersion
      to confirm you are now running version 3
  9. Next, we have to change the execution policy to allow running unsigned scripts. To do this, run
    Set-ExecutionPolicy Bypass -Scope CurrentUser
    and confirm with Y. With this preparations to run the ExRelease script are done.

Using the ExRelease script to take screenshots with subtitles/typesetting

The ExRelease script automates a number of thigs you'd otherwise have to do by hand:

  • Demuxes subtitles from .mkv files
  • Extracts attached fonts softsubbed releases (which are required to render the subtitles correctly)
  • Looks for typesetting inside extracted .ass subtiles and writes a text file, which can be imported as bookmarks in AvsPmod
  • Loads extracted fonts into memory to make them available to the subtitle renderer
  • Finds the highest resolution of the releases you want to compare
  • Writes an AviSynth script with all important parameters already set, so you can start taking screenshots right away


  1. Open PowerShell
  2. Move or copy all releases you want to compare with each other to a separate folder. The script works on whole directories, so every .mkv file in the folder is going to be processed.
  3. Run the script by typing
    ExRelease "X:\SomePath\To Love Ru Darkness"

    (Substitute for your comparison directory, of course.) You can use the Tab key to auto-complete directories or just type "ExRelease" and drag/drop the folder into PowerShell to insert its path.

    The script will now process your files and also create indexes, so it's time to go to the fridge and grab a beer.
  4. When the script is done it will ask you if you want it to load fonts now. Answer with Y for yes.
    Fonts remain loaded in memory for the duration of the session (that means until you log out or shut down the computer).
    1. In case you want to (continue) work on the screenshot comparison after a logout or reboot, run the script again with
      ExRelease "X:\SomePath\To Love Ru Darkness" -load
  5. Open the generated .avs scripts (which reside next to the .mkv files) in AvsPmod.
    If everything went right, all releases should display at the same resolution, subtitles should now be rendered on the frames, and the releases should now have the appropriate group tag next to the frame numbers.
  6. To save you the effort of finding typesetting to compare, ExRelease has already done that for you.
    1. To import the found typesetting locations as bookmarks, click on Macros > Import bookmarks from file and pick the .TSChapters.txt saved alongside the release you are comparing.
    2. Repeat this for every other release you are comparing. This is important because you not only want to compare the TS group A did, but also the TS group B did and group a didn't.
    3. Take note that the typesetting detection is very crude and timecodes are somewhat inaccurate, therefore the typesetting may appear a frame before/after the bookmark or e.g. only starts fading in at the bookmark locations. Therefore it's vital to go trough the bookmarks and move them around to get useful screenshots. To remove a bookmark, just press Ctrl+B at the bookmarked location (frame number in red)
  7. To unload fonts after you are done with your comparison, run the script with
    ExRelease "X:\SomePath\To Love Ru Darkness" -unload


Addendum: The script offers a number of advanced parameters that let you customize your workflow. Run

Get-Help ExRelease -detailed

in PowerShell to display its internal help file.