browsertime 24.9.0 → 25.1.0

package/visualmetrics/visualmetrics.py

@@ -1,2645 +0,0 @@
-#!/usr/bin/env python
-"""
-Copyright (c) 2014, Google Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-    * Neither the name of the company nor the names of its contributors may be
-      used to endorse or promote products derived from this software without
-      specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."""
-#
-# The original script from Google was heavily modified for the Browsertime
-# project.
-#
-import gc
-import glob
-import gzip
-import json
-import logging
-import math
-import os
-import platform
-import re
-import sys
-import shutil
-import subprocess
-import tempfile
-
-if sys.version_info > (3, 0):
-    GZIP_TEXT = "wt"
-    GZIP_READ_TEXT = "rt"
-else:
-    GZIP_TEXT = "w"
-    GZIP_READ_TEXT = "r"
-
-# Globals
-options = None
-client_viewport = None
-image_magick = {"convert": "convert", "compare": "compare", "mogrify": "mogrify"}
-frame_cache = {}
-
-# #################################################################################################
-# Frame Extraction and de-duplication
-# #################################################################################################
-
-
-def video_to_frames(
-    video,
-    directory,
-    force,
-    orange_file,
-    white_file,
-    gray_file,
-    multiple,
-    find_viewport,
-    viewport_time,
-    viewport_retries,
-    viewport_min_height,
-    viewport_min_width,
-    full_resolution,
-    timeline_file,
-    trim_end,
-):
-    """ Extract the video frames"""
-    global client_viewport
-    first_frame = os.path.join(directory, "ms_000000")
-    if (
-        not os.path.isfile(first_frame + ".png")
-        and not os.path.isfile(first_frame + ".jpg")
-    ) or force:
-        if os.path.isfile(video):
-            video = os.path.realpath(video)
-            logging.info("Processing frames from video " + video + " to " + directory)
-            is_mobile = find_recording_platform(video)
-            if os.path.isdir(directory):
-                shutil.rmtree(directory, True)
-            if not os.path.isdir(directory):
-                os.mkdir(directory, 0o755)
-            if os.path.isdir(directory):
-                directory = os.path.realpath(directory)
-                viewport, cropped = find_video_viewport(
-                    video,
-                    directory,
-                    find_viewport,
-                    viewport_time,
-                    viewport_retries,
-                    viewport_min_height,
-                    viewport_min_width,
-                    is_mobile,
-                )
-                gc.collect()
-                if extract_frames(video, directory, full_resolution, viewport):
-                    client_viewport = None
-                    if find_viewport and options.notification:
-                        client_viewport = find_image_viewport(
-                            os.path.join(directory, "video-000000.png"),
-                            is_mobile
-                        )
-                    if multiple and orange_file is not None:
-                        directories = split_videos(directory, orange_file)
-                    else:
-                        directories = [directory]
-                    for dir in directories:
-                        trim_video_end(dir, trim_end)
-                        if orange_file is not None:
-                            remove_frames_before_orange(dir, orange_file)
-                            remove_orange_frames(dir, orange_file)
-                        find_first_frame(dir, white_file)
-                        blank_first_frame(dir)
-                        find_render_start(dir, orange_file, gray_file, cropped, is_mobile)
-                        find_last_frame(dir, white_file)
-                        adjust_frame_times(dir)
-                        if timeline_file is not None and not multiple:
-                            synchronize_to_timeline(dir, timeline_file)
-                        eliminate_duplicate_frames(dir, cropped, is_mobile)
-                        eliminate_similar_frames(dir)
-                        # See if we are limiting the number of frames to keep
-                        # (before processing them to save processing time)
-                        if options.maxframes > 0:
-                            cap_frame_count(dir, options.maxframes)
-                        crop_viewport(dir)
-                        gc.collect()
-                else:
-                    logging.critical("Error extracting the video frames from %s", video)
-            else:
-                logging.critical("Error creating output directory: %s", directory)
-        else:
-            logging.critical("Input video file %s does not exist", video)
-    else:
-        logging.info("Extracted video already exists in %s", directory)
-
-
-def extract_frames(video, directory, full_resolution, viewport):
-    """Extract and number the video frames"""
-    ret = False
-    logging.info("Extracting frames from " + video + " to " + directory)
-    decimate = get_decimate_filter()
-    if decimate is not None:
-        crop = ""
-        if viewport is not None:
-            crop = "crop={0}:{1}:{2}:{3},".format(
-                viewport["width"], viewport["height"], viewport["x"], viewport["y"]
-            )
-        scale = "scale=iw*min({0:d}/iw\\,{0:d}/ih):ih*min({0:d}/iw\\,{0:d}/ih),".format(
-            options.thumbsize
-        )
-        if full_resolution:
-            scale = ""
-        # escape directory name
-        # see https://en.wikibooks.org/wiki/FFMPEG_An_Intermediate_Guide/image_sequence#Percent_in_filename
-        dir_escaped = directory.replace("%", "%%")
-        command = [
-            "ffmpeg",
-            "-v",
-            "debug",
-            "-i",
-            video,
-            "-vsync",
-            "0",
-            "-vf",
-            crop + scale + decimate + "=0:64:640:0.001",
-            os.path.join(dir_escaped, "img-%d.png"),
-        ]
-        logging.debug(" ".join(command))
-        lines = []
-        if sys.version_info > (3, 0):
-            proc = subprocess.Popen(command, stderr=subprocess.PIPE, encoding="UTF-8")
-        else:
-            proc = subprocess.Popen(command, stderr=subprocess.PIPE)
-        while proc.poll() is None:
-            lines.extend(iter(proc.stderr.readline, ""))
-
-        pattern = re.compile(r"keep pts:[0-9]+ pts_time:(?P<timecode>[0-9\.]+)")
-        frame_count = 0
-        for line in lines:
-            match = re.search(pattern, line)
-            if match:
-                frame_count += 1
-                frame_time = int(
-                    math.floor(float(match.groupdict().get("timecode")) * 1000)
-                )
-                src = os.path.join(directory, "img-{0:d}.png".format(frame_count))
-                dest = os.path.join(directory, "video-{0:06d}.png".format(frame_time))
-                logging.debug("Renaming " + src + " to " + dest)
-                os.rename(src, dest)
-                ret = True
-    return ret
-
-
-def find_recording_platform(video):
-    """Find the platform that this video was recorded on.
-
-    We can make use of a field called `com.android.version` to
-    determine if we've recorded on mobile or not.
-    """
-    command = ["ffprobe", video]
-    logging.debug(command)
-
-    lines = []
-    if sys.version_info > (3, 0):
-        proc = subprocess.Popen(command, stderr=subprocess.PIPE, encoding="UTF-8")
-    else:
-        proc = subprocess.Popen(command, stderr=subprocess.PIPE)
-
-    while proc.poll() is None:
-        lines.extend(iter(proc.stderr.readline, ""))
-
-    is_mobile = False
-    matcher = re.compile(".*com\.android\.version.*")
-    for line in lines:
-        if matcher.search(line):
-            is_mobile = True
-
-    return is_mobile
-
-
-def split_videos(directory, orange_file):
-    """Split multiple videos on orange frame separators"""
-    logging.debug("Splitting video on orange frames (this may take a while)...")
-    directories = []
-    current = 0
-    found_orange = False
-    video_dir = None
-    frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-    if len(frames):
-        for frame in frames:
-            if is_color_frame(frame, orange_file):
-                if not found_orange:
-                    found_orange = True
-                    # Make a copy of the orange frame for the end of the
-                    # current video
-                    if video_dir is not None:
-                        dest = os.path.join(video_dir, os.path.basename(frame))
-                        shutil.copyfile(frame, dest)
-                    current += 1
-                    video_dir = os.path.join(directory, str(current))
-                    logging.debug(
-                        "Orange frame found: %s, starting video directory %s",
-                        frame,
-                        video_dir,
-                    )
-                    if not os.path.isdir(video_dir):
-                        os.mkdir(video_dir, 0o755)
-                    if os.path.isdir(video_dir):
-                        video_dir = os.path.realpath(video_dir)
-                        clean_directory(video_dir)
-                        directories.append(video_dir)
-                    else:
-                        video_dir = None
-            else:
-                found_orange = False
-            if video_dir is not None:
-                dest = os.path.join(video_dir, os.path.basename(frame))
-                os.rename(frame, dest)
-            else:
-                logging.debug("Removing spurious frame %s at the beginning", frame)
-                os.remove(frame)
-    return directories
-
-
-def remove_frames_before_orange(directory, orange_file):
-    """Remove stray frames from the start of the video"""
-    frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-    if len(frames):
-        # go through the first 20 frames and remove any that come before the first orange frame.
-        # iOS video capture starts with a blank white frame and then flips to
-        # orange before starting.
-        logging.debug("Scanning for non-orange frames...")
-        found_orange = False
-        remove_frames = []
-        frame_count = 0
-        for frame in frames:
-            frame_count += 1
-            if is_color_frame(frame, orange_file):
-                found_orange = True
-                break
-            if frame_count > 20:
-                break
-            remove_frames.append(frame)
-
-        if found_orange and len(remove_frames):
-            for frame in remove_frames:
-                logging.debug("Removing pre-orange frame %s", frame)
-                os.remove(frame)
-
-
-def remove_orange_frames(directory, orange_file):
-    """Remove orange frames from the beginning of the video"""
-    frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-    if len(frames):
-        logging.debug("Scanning for orange frames...")
-        for frame in frames:
-            if is_color_frame(frame, orange_file):
-                logging.debug("Removing Orange frame: %s", frame)
-                os.remove(frame)
-            else:
-                break
-        for frame in reversed(frames):
-            if is_color_frame(frame, orange_file):
-                logging.debug("Removing orange frame %s from the end", frame)
-                os.remove(frame)
-            else:
-                break
-
-
-def find_image_viewport(file, is_mobile):
-    logging.debug("Finding the viewport for %s", file)
-    try:
-        from PIL import Image
-
-        im = Image.open(file)
-        width, height = im.size
-        x = int(math.floor(width / 2))
-        y = int(math.floor(height / 2))
-        pixels = im.load()
-        background = pixels[x, y]
-
-        # Find the left edge
-        left = None
-        while left is None and x >= 0:
-            if not colors_are_similar(background, pixels[x, y]):
-                left = x + 1
-            else:
-                x -= 1
-        if left is None:
-            left = 0
-        logging.debug("Viewport left edge is %d", left)
-
-        # Find the right edge
-        x = int(math.floor(width / 2))
-        right = None
-        while right is None and x < width:
-            if not colors_are_similar(background, pixels[x, y]):
-                right = x - 1
-            else:
-                x += 1
-        if right is None:
-            right = width
-        logging.debug("Viewport right edge is {0:d}".format(right))
-
-        # Find the top edge
-        x = int(math.floor(width / 2))
-        top = None
-        while top is None and y >= 0:
-            if not colors_are_similar(background, pixels[x, y]):
-                top = y + 1
-            else:
-                y -= 1
-        if top is None:
-            top = 0
-        logging.debug("Viewport top edge is {0:d}".format(top))
-
-        # Find the bottom edge
-        y = int(math.floor(height / 2))
-        bottom = None
-        while bottom is None and y < height:
-            if not colors_are_similar(background, pixels[x, y]):
-                bottom = y - 1
-            else:
-                y += 1
-        if bottom is None:
-            bottom = height
-        logging.debug("Viewport bottom edge is {0:d}".format(bottom))
-
-        viewport = {
-            "x": left,
-            "y": top,
-            "width": (right - left),
-            "height": (bottom - top),
-        }
-
-        if is_mobile:
-            # On mobile we need to ignore the top ~10 pixels because
-            # there is a visible progress bar there on some browsers.
-            viewport["y"] += 10
-            viewport["height"] -= 10
-
-    except Exception:
-        viewport = None
-
-    return viewport
-
-
-def find_video_viewport(
-    video,
-    directory,
-    find_viewport,
-    viewport_time,
-    viewport_retries,
-    viewport_min_height,
-    viewport_min_width,
-    is_mobile,
-):
-    logging.debug("Finding Video Viewport...")
-    viewport = None
-
-    # cropped will be True if the viewport setting changes
-    # the original frame
-    cropped = False
-
-    try:
-        from PIL import Image
-
-        retries = -1
-
-        while (
-            viewport is None
-            or viewport["height"] <= viewport_min_height
-            or viewport["width"] <= viewport_min_width
-        ):
-            retries += 1
-            if retries >= 1:
-                # In some cases, the first frame is not an orange screen or a screen
-                # with a solid color. In this case, we need to try finding the viewport
-                # using the next frame. The `viewport_retries` dictates the maximum number
-                # of frames to check.
-                if retries >= viewport_retries:
-                    logging.exception(
-                        "Could not calculate a viewport after %s tries.",
-                        viewport_retries,
-                    )
-                    break
-                logging.info("Failed to find a good viewport. Retrying...")
-
-            logging.debug("Using frame " + str(retries))
-
-            frame = os.path.join(directory, "viewport.png")
-            if os.path.isfile(frame):
-                os.remove(frame)
-
-            command = ["ffmpeg", "-i", video]
-            if viewport_time:
-                command.extend(["-ss", viewport_time])
-
-            # Pull one frame from the video starting with the frame at
-            # the `retries` index
-            command.extend(["-vf", "select=gte(n\\,%s)" % retries])
-            command.extend(["-frames:v", "1", frame])
-            subprocess.check_output(command)
-
-            if os.path.isfile(frame):
-                with Image.open(frame) as im:
-                    width, height = im.size
-                    logging.debug("%s is %dx%d", frame, width, height)
-                if options.notification:
-                    im = Image.open(frame)
-                    pixels = im.load()
-                    middle = int(math.floor(height / 2))
-                    # Find the top edge (at ~40% in to deal with browsers that
-                    # color the notification area)
-                    x = int(width * 0.4)
-                    y = 0
-                    background = pixels[x, y]
-                    top = None
-                    while top is None and y < middle:
-                        if not colors_are_similar(background, pixels[x, y]):
-                            top = y
-                        else:
-                            y += 1
-                    if top is None:
-                        top = 0
-                    logging.debug("Window top edge is {0:d}".format(top))
-
-                    # Find the bottom edge
-                    x = 0
-                    y = height - 1
-                    bottom = None
-                    while bottom is None and y > middle:
-                        if not colors_are_similar(background, pixels[x, y]):
-                            bottom = y
-                        else:
-                            y -= 1
-                    if bottom is None:
-                        bottom = height - 1
-                    logging.debug("Window bottom edge is {0:d}".format(bottom))
-
-                    viewport = {
-                        "x": 0,
-                        "y": top,
-                        "width": width,
-                        "height": (bottom - top),
-                    }
-
-                elif find_viewport:
-                    viewport = find_image_viewport(frame, is_mobile)
-                else:
-                    viewport = {"x": 0, "y": 0, "width": width, "height": height}
-
-                os.remove(frame)
-
-        if viewport is not None and viewport != {
-            "x": 0,
-            "y": 0,
-            "width": width,
-            "height": height,
-        }:
-            cropped = True
-
-    except Exception as e:
-        viewport = None
-
-    return viewport, cropped
-
-
-def trim_video_end(directory, trim_time):
-    if trim_time > 0:
-        logging.debug(
-            "Trimming "
-            + str(trim_time)
-            + "ms from the end of the video in "
-            + directory
-        )
-        frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-        if len(frames):
-            match = re.compile(r"video-(?P<ms>[0-9]+)\.png")
-            m = re.search(match, frames[-1])
-            if m is not None:
-                frame_time = int(m.groupdict().get("ms"))
-                end_time = frame_time - trim_time
-                logging.debug("Trimming frames before " + str(end_time) + "ms")
-                for frame in frames:
-                    m = re.search(match, frame)
-                    if m is not None:
-                        frame_time = int(m.groupdict().get("ms"))
-                        if frame_time > end_time:
-                            logging.debug("Trimming frame " + frame)
-                            os.remove(frame)
-
-
-def adjust_frame_times(directory):
-    offset = None
-    frames = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-    # Special hack to the the video start
-    # Let us tune this in the future to skip using a global
-    global videoRecordingStart
-    match = re.compile(r"video-(?P<ms>[0-9]+)\.png")
-    if len(frames):
-        for frame in frames:
-            m = re.search(match, frame)
-            if m is not None:
-                frame_time = int(m.groupdict().get("ms"))
-                if offset is None:
-                    # This is the first frame.
-                    videoRecordingStart = frame_time
-                    offset = frame_time
-                new_time = frame_time - offset
-                dest = os.path.join(directory, "ms_{0:06d}.png".format(new_time))
-                os.rename(frame, dest)
-
-
-def find_first_frame(directory, white_file):
-    logging.debug("Finding First Frame...")
-    try:
-        if options.startwhite:
-            files = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-            count = len(files)
-            if count > 1:
-                from PIL import Image
-
-                for i in range(count):
-                    if is_white_frame(files[i], white_file):
-                        break
-                    else:
-                        logging.debug(
-                            "Removing non-white frame {0} from the beginning".format(
-                                files[i]
-                            )
-                        )
-                        os.remove(files[i])
-        elif options.findstart > 0 and options.findstart <= 100:
-            files = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-            count = len(files)
-            if count > 1:
-                from PIL import Image
-
-                blank = files[0]
-                with Image.open(blank) as im:
-                    width, height = im.size
-                match_height = int(math.ceil(height * options.findstart / 100.0))
-                crop = "{0:d}x{1:d}+{2:d}+{3:d}".format(width, match_height, 0, 0)
-                found_first_change = False
-                found_white_frame = False
-                found_non_white_frame = False
-                first_frame = None
-                if white_file is None:
-                    found_white_frame = True
-                for i in range(count):
-                    if not found_first_change:
-                        different = not frames_match(
-                            files[i], files[i + 1], 5, 100, crop, None
-                        )
-                        logging.debug(
-                            "Removing early frame %s from the beginning", files[i]
-                        )
-                        os.remove(files[i])
-                        if different:
-                            first_frame = files[i + 1]
-                            found_first_change = True
-                    elif not found_white_frame:
-                        if files[i] != first_frame:
-                            if found_non_white_frame:
-                                found_white_frame = is_white_frame(files[i], white_file)
-                                if not found_white_frame:
-                                    logging.debug(
-                                        "Removing early non-white frame {0} from the beginning".format(
-                                            files[i]
-                                        )
-                                    )
-                                    os.remove(files[i])
-                            else:
-                                found_non_white_frame = not is_white_frame(
-                                    files[i], white_file
-                                )
-                                logging.debug(
-                                    "Removing early pre-non-white frame {0} from the beginning".format(
-                                        files[i]
-                                    )
-                                )
-                                os.remove(files[i])
-                    if found_first_change and found_white_frame:
-                        break
-    except BaseException:
-        logging.exception("Error finding first frame")
-
-
-def find_last_frame(directory, white_file):
-    logging.debug("Finding Last Frame...")
-    try:
-        if options.endwhite:
-            files = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-            count = len(files)
-            if count > 2:
-                found_end = False
-
-                for i in range(2, count):
-                    if found_end:
-                        logging.debug(
-                            "Removing frame {0} from the end".format(files[i])
-                        )
-                        os.remove(files[i])
-                    if is_white_frame(files[i], white_file):
-                        found_end = True
-                        logging.debug(
-                            "Removing ending white frame {0}".format(files[i])
-                        )
-                        os.remove(files[i])
-    except BaseException:
-        logging.exception("Error finding last frame")
-
-
-def find_render_start(directory, orange_file, gray_file, cropped, is_mobile):
-    logging.debug("Finding Render Start...")
-    try:
-        if (
-            client_viewport is not None
-            or options.viewport is not None
-            or (options.renderignore > 0 and options.renderignore <= 100)
-        ):
-            files = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-            count = len(files)
-            if count > 1:
-                from PIL import Image
-
-                first = files[0]
-                with Image.open(first) as im:
-                    width, height = im.size
-                if options.renderignore > 0 and options.renderignore <= 100:
-                    mask = {}
-                    mask["width"] = int(math.floor(width * options.renderignore / 100))
-                    mask["height"] = int(
-                        math.floor(height * options.renderignore / 100)
-                    )
-                    mask["x"] = int(math.floor(width / 2 - mask["width"] / 2))
-                    mask["y"] = int(math.floor(height / 2 - mask["height"] / 2))
-                else:
-                    mask = None
-
-                im_width = width
-                im_height = height
-
-                top = 10
-                right_margin = 10
-                bottom_margin = 24
-                if height > 400 or width > 400:
-                    top = max(top, int(math.ceil(float(height) * 0.03)))
-                    right_margin = max(
-                        right_margin, int(math.ceil(float(width) * 0.04))
-                    )
-                    bottom_margin = max(
-                        bottom_margin, int(math.ceil(float(width) * 0.04))
-                    )
-                height = max(height - top - bottom_margin, 1)
-                left = 0
-                width = max(width - right_margin, 1)
-                if client_viewport is not None:
-                    height = max(client_viewport["height"] - top - bottom_margin, 1)
-                    width = max(client_viewport["width"] - right_margin, 1)
-                    left += client_viewport["x"]
-                    top += client_viewport["y"]
-                elif cropped:
-                    # The image was already cropped, so only cutout the bottom
-                    # to get rid of the network request/etc. information for
-                    # desktop videos, and nothing extra on mobile.
-                    top = 0
-                    left = 0
-                    width = im_width
-
-                    if is_mobile:
-                        height = im_height
-                    else:
-                        height = im_height - bottom_margin
-
-                crop = "{0:d}x{1:d}+{2:d}+{3:d}".format(width, height, left, top)
-
-                for i in range(1, count):
-                    if frames_match(first, files[i], 10, 0, crop, mask):
-                        logging.debug("Removing pre-render frame %s", files[i])
-                        os.remove(files[i])
-                    elif orange_file is not None and is_color_frame(
-                        files[i], orange_file
-                    ):
-                        logging.debug("Removing orange frame %s", files[i])
-                        os.remove(files[i])
-                    elif gray_file is not None and is_color_frame(files[i], gray_file):
-                        logging.debug("Removing gray frame %s", files[i])
-                        os.remove(files[i])
-                    else:
-                        break
-    except BaseException:
-        logging.exception("Error getting render start")
-
-
-def eliminate_duplicate_frames(directory, cropped, is_mobile):
-    logging.debug("Eliminating Duplicate Frames...")
-    global client_viewport
-    try:
-        files = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-        if len(files) > 1:
-            from PIL import Image
-
-            blank = files[0]
-            with Image.open(blank) as im:
-                width, height = im.size
-            if options.viewport and options.notification:
-                if (
-                    client_viewport["width"] == width
-                    and client_viewport["height"] == height
-                ):
-                    client_viewport = None
-
-            im_width = width
-            im_height = height
-
-            # Figure out the region of the image that we care about
-            top = 40
-            right_margin = 10
-            bottom_margin = 10
-            if height > 400 or width > 400:
-                top = int(math.ceil(float(height) * 0.04))
-                right_margin = int(math.ceil(float(width) * 0.04))
-                bottom_margin = int(math.ceil(float(width) * 0.06))
-            height = max(height - top - bottom_margin, 1)
-            left = 0
-            width = max(width - right_margin, 1)
-
-            if client_viewport is not None:
-                height = max(client_viewport["height"] - top - bottom_margin, 1)
-                width = max(client_viewport["width"] - right_margin, 1)
-                left += client_viewport["x"]
-                top += client_viewport["y"]
-            elif cropped:
-                # The image was already cropped, so only cutout the bottom
-                # to get rid of the network request/etc. information for
-                # desktop videos, and nothing extra on mobile.
-                top = 0
-                left = 0
-                width = im_width
-
-                if is_mobile:
-                    height = im_height
-                else:
-                    height = im_height - bottom_margin
-
-            crop = "{0:d}x{1:d}+{2:d}+{3:d}".format(width, height, left, top)
-            logging.debug("Viewport cropping set to " + crop)
-
-            # Do a pass looking for the first non-blank frame with an allowance
-            # for up to a 10% per-pixel difference for noise in the white
-            # field.
-            count = len(files)
-            for i in range(1, count):
-                if frames_match(blank, files[i], 10, 0, crop, None):
-                    logging.debug(
-                        "Removing duplicate frame {0} from the beginning".format(
-                            files[i]
-                        )
-                    )
-                    os.remove(files[i])
-                else:
-                    break
-
-            # Do another pass looking for the last frame but with an allowance for up
-            # to a 15% difference in individual pixels to deal with noise
-            # around text.
-            files = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-            count = len(files)
-            duplicates = []
-            if count > 2:
-                files.reverse()
-                baseline = files[0]
-                previous_frame = baseline
-                for i in range(1, count):
-                    if frames_match(baseline, files[i], 15, 0, crop, None):
-                        if previous_frame is baseline:
-                            duplicates.append(previous_frame)
-                        else:
-                            logging.debug(
-                                "Removing duplicate frame {0} from the end".format(
-                                    previous_frame
-                                )
-                            )
-                            os.remove(previous_frame)
-                        previous_frame = files[i]
-                    else:
-                        break
-            for duplicate in duplicates:
-                logging.debug(
-                    "Removing duplicate frame {0} from the end".format(duplicate)
-                )
-                os.remove(duplicate)
-
-    except BaseException:
-        logging.exception("Error processing frames for duplicates")
-
-
-def eliminate_similar_frames(directory):
-    logging.debug("Removing Similar Frames...")
-    try:
-        # only do this when decimate couldn't be used to eliminate similar
-        # frames
-        if options.notification:
-            files = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-            count = len(files)
-            if count > 3:
-                crop = None
-                if client_viewport is not None:
-                    crop = "{0:d}x{1:d}+{2:d}+{3:d}".format(
-                        client_viewport["width"],
-                        client_viewport["height"],
-                        client_viewport["x"],
-                        client_viewport["y"],
-                    )
-                baseline = files[1]
-                for i in range(2, count - 1):
-                    if frames_match(baseline, files[i], 1, 0, crop, None):
-                        logging.debug("Removing similar frame {0}".format(files[i]))
-                        os.remove(files[i])
-                    else:
-                        baseline = files[i]
-    except BaseException:
-        logging.exception("Error removing similar frames")
-
-
-def blank_first_frame(directory):
-    try:
-        if options.forceblank:
-            files = sorted(glob.glob(os.path.join(directory, "video-*.png")))
-            count = len(files)
-            if count > 1:
-                from PIL import Image
-
-                with Image.open(files[0]) as im:
-                    width, height = im.size
-                command = '{0} -size {1}x{2} xc:white PNG24:"{3}"'.format(
-                    image_magick["convert"], width, height, files[0]
-                )
-                subprocess.call(command, shell=True)
-    except BaseException:
-        logging.exception("Error blanking first frame")
-
-
-def crop_viewport(directory):
-    if client_viewport is not None:
-        try:
-            files = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-            count = len(files)
-            if count > 0:
-                crop = "{0:d}x{1:d}+{2:d}+{3:d}".format(
-                    client_viewport["width"],
-                    client_viewport["height"],
-                    client_viewport["x"],
-                    client_viewport["y"],
-                )
-                for i in range(count):
-                    command = '{0} "{1}" -crop {2} "{1}"'.format(
-                        image_magick["convert"], files[i], crop
-                    )
-                    subprocess.call(command, shell=True)
-
-        except BaseException:
-            logging.exception("Error cropping to viewport")
-
-
-def get_decimate_filter():
-    decimate = None
-    try:
-        if sys.version_info > (3, 0):
-            filters = subprocess.check_output(
-                ["ffmpeg", "-filters"], stderr=subprocess.STDOUT, encoding="UTF-8"
-            )
-        else:
-            filters = subprocess.check_output(
-                ["ffmpeg", "-filters"], stderr=subprocess.STDOUT
-            )
-        lines = filters.split("\n")
-        match = re.compile(
-            r"(?P<filter>[\w]*decimate).*V->V.*Remove near-duplicate frames"
-        )
-        for line in lines:
-            m = re.search(match, line)
-            if m is not None:
-                decimate = m.groupdict().get("filter")
-                break
-    except BaseException:
-        logging.critical("Error checking ffmpeg filters for decimate")
-        decimate = None
-    return decimate
-
-
-def clean_directory(directory):
-    files = glob.glob(os.path.join(directory, "*.png"))
-    for file in files:
-        os.remove(file)
-    files = glob.glob(os.path.join(directory, "*.jpg"))
-    for file in files:
-        os.remove(file)
-    files = glob.glob(os.path.join(directory, "*.json"))
-    for file in files:
-        os.remove(file)
-
-
-def is_color_frame(file, color_file):
-    """Check a section from the middle, top and bottom of the viewport to see if it matches"""
-    global frame_cache
-    if file in frame_cache and color_file in frame_cache[file]:
-        return bool(frame_cache[file][color_file])
-    match = False
-    if os.path.isfile(color_file):
-        try:
-            from PIL import Image
-
-            with Image.open(file) as img:
-                width, height = img.size
-            crops = []
-            # Middle
-            crops.append(
-                "{0:d}x{1:d}+{2:d}+{3:d}".format(
-                    int(width / 2), int(height / 3), int(width / 4), int(height / 3)
-                )
-            )
-            # Top
-            crops.append(
-                "{0:d}x{1:d}+{2:d}+{3:d}".format(
-                    int(width / 2), int(height / 5), int(width / 4), 50
-                )
-            )
-            # Bottom
-            crops.append(
-                "{0:d}x{1:d}+{2:d}+{3:d}".format(
-                    int(width / 2),
-                    int(height / 5),
-                    int(width / 4),
-                    height - int(height / 5),
-                )
-            )
-            for crop in crops:
-                command = (
-                    '{0} "{1}" "(" "{2}" -crop {3} -resize 200x200! ")"'
-                    " miff:- | {4} -metric AE - -fuzz 15% null:"
-                ).format(
-                    image_magick["convert"],
-                    color_file,
-                    file,
-                    crop,
-                    image_magick["compare"],
-                )
-
-                if sys.version_info > (3, 0):
-                    compare = subprocess.Popen(
-                        command, stderr=subprocess.PIPE, shell=True, encoding="UTF-8"
-                    )
-                else:
-                    compare = subprocess.Popen(
-                        command, stderr=subprocess.PIPE, shell=True
-                    )
-                out, err = compare.communicate()
-                if re.match("^[0-9]+$", err):
-                    different_pixels = int(err)
-                    if different_pixels < 10000:
-                        match = True
-                        break
-        except Exception:
-            pass
-    if file not in frame_cache:
-        frame_cache[file] = {}
-    frame_cache[file][color_file] = bool(match)
-    return match
-
-
-def is_white_frame(file, white_file):
-    white = False
-    if os.path.isfile(white_file):
-        if options.viewport:
-            command = (
-                '{0} "{1}" "(" "{2}" -resize 200x200! ")" miff:- | '
-                "{3} -metric AE - -fuzz 10% null:"
-            ).format(image_magick["convert"], white_file, file, image_magick["compare"])
-        else:
-            command = (
-                '{0} "{1}" "(" "{2}" -gravity Center -crop 50%x33%+0+0 -resize 200x200! ")" miff:- | '
-                "{3} -metric AE - -fuzz 10% null:"
-            ).format(image_magick["convert"], white_file, file, image_magick["compare"])
-        if client_viewport is not None:
-            crop = "{0:d}x{1:d}+{2:d}+{3:d}".format(
-                client_viewport["width"],
-                client_viewport["height"],
-                client_viewport["x"],
-                client_viewport["y"],
-            )
-            command = (
-                '{0} "{1}" "(" "{2}" -crop {3} -resize 200x200! ")" miff:- | '
-                "{4} -metric AE - -fuzz 10% null:"
-            ).format(
-                image_magick["convert"], white_file, file, crop, image_magick["compare"]
-            )
-        if sys.version_info > (3, 0):
-            compare = subprocess.Popen(
-                command, stderr=subprocess.PIPE, shell=True, encoding="UTF-8"
-            )
-        else:
-            compare = subprocess.Popen(command, stderr=subprocess.PIPE, shell=True)
-        out, err = compare.communicate()
-        if re.match("^[0-9]+$", err):
-            different_pixels = int(err)
-            if different_pixels < 500:
-                white = True
-
-    return white
-
-
-def colors_are_similar(a, b, threshold=15):
-    similar = True
-    sum = 0
-    for x in range(3):
-        delta = abs(a[x] - b[x])
-        sum += delta
-        if delta > threshold:
-            similar = False
-    if sum > threshold:
-        similar = False
-
-    return similar
-
-
-def frames_match(image1, image2, fuzz_percent, max_differences, crop_region, mask_rect):
-    match = False
-    fuzz = ""
-    if fuzz_percent > 0:
-        fuzz = "-fuzz {0:d}% ".format(fuzz_percent)
-    crop = ""
-    if crop_region is not None:
-        crop = "-crop {0} ".format(crop_region)
-    if mask_rect is None:
-        img1 = '"{0}"'.format(image1)
-        img2 = '"{0}"'.format(image2)
-    else:
-        img1 = '( "{0}" -size {1}x{2} xc:white -geometry +{3}+{4} -compose over -composite )'.format(
-            image1,
-            mask_rect["width"],
-            mask_rect["height"],
-            mask_rect["x"],
-            mask_rect["y"],
-        )
-        img2 = '( "{0}" -size {1}x{2} xc:white -geometry +{3}+{4} -compose over -composite )'.format(
-            image2,
-            mask_rect["width"],
-            mask_rect["height"],
-            mask_rect["x"],
-            mask_rect["y"],
-        )
-    command = "{0} {1} {2} {3}miff:- | {4} -metric AE - {5}null:".format(
-        image_magick["convert"], img1, img2, crop, image_magick["compare"], fuzz
-    )
-    if platform.system() != "Windows":
-        command = command.replace("(", "\\(").replace(")", "\\)")
-    if sys.version_info > (3, 0):
-        compare = subprocess.Popen(
-            command, stderr=subprocess.PIPE, shell=True, encoding="UTF-8"
-        )
-    else:
-        compare = subprocess.Popen(command, stderr=subprocess.PIPE, shell=True)
-    out, err = compare.communicate()
-    if re.match("^[0-9]+$", err):
-        different_pixels = int(err)
-        if different_pixels <= max_differences:
-            match = True
-    else:
-        logging.debug(
-            'Unexpected compare result: out: "{0}", err: "{1}"'.format(out, err)
-        )
-
-    return match
-
-
-def generate_orange_png(orange_file):
-    try:
-        from PIL import Image, ImageDraw
-
-        im = Image.new("RGB", (200, 200))
-        draw = ImageDraw.Draw(im)
-        draw.rectangle([0, 0, 200, 200], fill=(222, 100, 13))
-        del draw
-        im.save(orange_file, "PNG")
-    except BaseException:
-        logging.exception("Error generating orange png " + orange_file)
-
-
-def generate_gray_png(gray_file):
-    try:
-        from PIL import Image, ImageDraw
-
-        im = Image.new("RGB", (200, 200))
-        draw = ImageDraw.Draw(im)
-        draw.rectangle([0, 0, 200, 200], fill=(128, 128, 128))
-        del draw
-        im.save(gray_file, "PNG")
-    except BaseException:
-        logging.exception("Error generating gray png " + gray_file)
-
-
-def generate_white_png(white_file):
-    try:
-        from PIL import Image, ImageDraw
-
-        im = Image.new("RGB", (200, 200))
-        draw = ImageDraw.Draw(im)
-        draw.rectangle([0, 0, 200, 200], fill=(255, 255, 255))
-        del draw
-        im.save(white_file, "PNG")
-    except BaseException:
-        logging.exception("Error generating white png " + white_file)
-
-
-def synchronize_to_timeline(directory, timeline_file):
-    offset = get_timeline_offset(timeline_file)
-    if offset > 0:
-        frames = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-        match = re.compile(r"ms_(?P<ms>[0-9]+)\.png")
-        for frame in frames:
-            m = re.search(match, frame)
-            if m is not None:
-                frame_time = int(m.groupdict().get("ms"))
-                new_time = max(frame_time - offset, 0)
-                dest = os.path.join(directory, "ms_{0:06d}.png".format(new_time))
-                if frame != dest:
-                    if os.path.isfile(dest):
-                        os.remove(dest)
-                    os.rename(frame, dest)
-
-
-def get_timeline_offset(timeline_file):
-    offset = 0
-    try:
-        file_name, ext = os.path.splitext(timeline_file)
-        if ext.lower() == ".gz":
-            f = gzip.open(timeline_file, GZIP_READ_TEXT)
-        else:
-            f = open(timeline_file, "r")
-        timeline = json.load(f)
-        f.close()
-        last_paint = None
-        first_navigate = None
-
-        # In the case of a trace instead of a timeline we want the list of
-        # events
-        if "traceEvents" in timeline:
-            timeline = timeline["traceEvents"]
-
-        for timeline_event in timeline:
-            paint_time = get_timeline_event_paint_time(timeline_event)
-            if paint_time is not None:
-                last_paint = paint_time
-            first_navigate = get_timeline_event_navigate_time(timeline_event)
-            if first_navigate is not None:
-                break
-
-        if (
-            last_paint is not None
-            and first_navigate is not None
-            and first_navigate > last_paint
-        ):
-            offset = int(round(first_navigate - last_paint))
-            logging.info(
-                "Trimming {0:d}ms from the start of the video based on timeline synchronization".format(
-                    offset
-                )
-            )
-    except BaseException:
-        logging.critical("Error processing timeline file " + timeline_file)
-
-    return offset
-
-
-def get_timeline_event_paint_time(timeline_event):
-    paint_time = None
-    if "cat" in timeline_event:
-        if (
-            timeline_event["cat"].find("devtools.timeline") >= 0
-            and "ts" in timeline_event
-            and "name" in timeline_event
-            and (
-                timeline_event["name"].find("Paint") >= 0
-                or timeline_event["name"].find("CompositeLayers") >= 0
-            )
-        ):
-            paint_time = float(timeline_event["ts"]) / 1000.0
-            if "dur" in timeline_event:
-                paint_time += float(timeline_event["dur"]) / 1000.0
-    elif "method" in timeline_event:
-        if (
-            timeline_event["method"] == "Timeline.eventRecorded"
-            and "params" in timeline_event
-            and "record" in timeline_event["params"]
-        ):
-            paint_time = get_timeline_event_paint_time(
-                timeline_event["params"]["record"]
-            )
-    else:
-        if "type" in timeline_event and (
-            timeline_event["type"] == "Rasterize"
-            or timeline_event["type"] == "CompositeLayers"
-            or timeline_event["type"] == "Paint"
-        ):
-            if "endTime" in timeline_event:
-                paint_time = timeline_event["endTime"]
-            elif "startTime" in timeline_event:
-                paint_time = timeline_event["startTime"]
-
-        # Check for any child paint events
-        if "children" in timeline_event:
-            for child in timeline_event["children"]:
-                child_paint_time = get_timeline_event_paint_time(child)
-                if child_paint_time is not None and (
-                    paint_time is None or child_paint_time > paint_time
-                ):
-                    paint_time = child_paint_time
-
-    return paint_time
-
-
-def get_timeline_event_navigate_time(timeline_event):
-    navigate_time = None
-    if "cat" in timeline_event:
-        if (
-            timeline_event["cat"].find("devtools.timeline") >= 0
-            and "ts" in timeline_event
-            and "name" in timeline_event
-            and timeline_event["name"] == "ResourceSendRequest"
-        ):
-            navigate_time = float(timeline_event["ts"]) / 1000.0
-    elif "method" in timeline_event:
-        if (
-            timeline_event["method"] == "Timeline.eventRecorded"
-            and "params" in timeline_event
-            and "record" in timeline_event["params"]
-        ):
-            navigate_time = get_timeline_event_navigate_time(
-                timeline_event["params"]["record"]
-            )
-    else:
-        if (
-            "type" in timeline_event
-            and timeline_event["type"] == "ResourceSendRequest"
-            and "startTime" in timeline_event
-        ):
-            navigate_time = timeline_event["startTime"]
-
-        # Check for any child paint events
-        if "children" in timeline_event:
-            for child in timeline_event["children"]:
-                child_navigate_time = get_timeline_event_navigate_time(child)
-                if child_navigate_time is not None and (
-                    navigate_time is None or child_navigate_time < navigate_time
-                ):
-                    navigate_time = child_navigate_time
-
-    return navigate_time
-
-
-##########################################################################
-#   Histogram calculations
-##########################################################################
-
-
-def calculate_histograms(directory, histograms_file, force):
-    logging.debug("Calculating image histograms")
-    if not os.path.isfile(histograms_file) or force:
-        try:
-            extension = None
-            directory = os.path.realpath(directory)
-            first_frame = os.path.join(directory, "ms_000000")
-            if os.path.isfile(first_frame + ".png"):
-                extension = ".png"
-            elif os.path.isfile(first_frame + ".jpg"):
-                extension = ".jpg"
-            if extension is not None:
-                histograms = []
-                frames = sorted(glob.glob(os.path.join(directory, "ms_*" + extension)))
-                match = re.compile(r"ms_(?P<ms>[0-9]+)\.")
-                for frame in frames:
-                    m = re.search(match, frame)
-                    if m is not None:
-                        frame_time = int(m.groupdict().get("ms"))
-                        histogram, total, dropped = calculate_image_histogram(frame)
-                        gc.collect()
-                        if histogram is not None:
-                            histograms.append(
-                                {
-                                    "time": frame_time,
-                                    "file": os.path.basename(frame),
-                                    "histogram": histogram,
-                                    "total_pixels": total,
-                                    "dropped_pixels": dropped,
-                                }
-                            )
-                if os.path.isfile(histograms_file):
-                    os.remove(histograms_file)
-                f = gzip.open(histograms_file, GZIP_TEXT)
-                json.dump(histograms, f)
-                f.close()
-            else:
-                logging.critical("No video frames found in " + directory)
-        except BaseException:
-            logging.exception("Error calculating histograms")
-    else:
-        logging.debug("Histograms file {0} already exists".format(histograms_file))
-    logging.debug("Done calculating histograms")
-
-
-def calculate_image_histogram(file):
-    logging.debug("Calculating histogram for " + file)
-    dropped = 0
-    try:
-        from PIL import Image
-
-        im = Image.open(file)
-        width, height = im.size
-        total = width * height
-        colors = im.getcolors(total)
-        histogram = {
-            "r": [0 for i in range(256)],
-            "g": [0 for i in range(256)],
-            "b": [0 for i in range(256)],
-        }
-        for entry in colors:
-            try:
-                count = entry[0]
-                pixel = entry[1]
-                # Don't include White pixels (with a tiny bit of slop for
-                # compression artifacts)
-                if pixel[0] < 250 or pixel[1] < 250 or pixel[2] < 250:
-                    histogram["r"][pixel[0]] += count
-                    histogram["g"][pixel[1]] += count
-                    histogram["b"][pixel[2]] += count
-                else:
-                    dropped += 1
-            except Exception:
-                pass
-        colors = None
-    except Exception:
-        total = 0
-        histogram = None
-        logging.exception("Error calculating histogram for " + file)
-    return histogram, total, dropped
-
-
-##########################################################################
-#   Screen Shots
-##########################################################################
-
-
-def save_screenshot(directory, dest, quality):
-    directory = os.path.realpath(directory)
-    files = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-    if files is not None and len(files) >= 1:
-        src = files[-1]
-        if dest[-4:] == ".jpg":
-            command = '{0} "{1}" -set colorspace sRGB -quality {2:d} "{3}"'.format(
-                image_magick["convert"], src, quality, dest
-            )
-            subprocess.call(command, shell=True)
-        else:
-            shutil.copy(src, dest)
-
-
-##########################################################################
-#   JPEG conversion
-##########################################################################
-
-
-def convert_to_jpeg(directory, quality):
-    logging.debug("Converting video frames to JPEG")
-    directory = os.path.realpath(directory)
-    pattern = os.path.join(directory, "ms_*.png")
-    command = '{0} -format jpg -set colorspace sRGB -quality {1:d} "{2}"'.format(
-        image_magick["mogrify"], quality, pattern
-    )
-    logging.debug(command)
-    subprocess.call(command, shell=True)
-    files = sorted(glob.glob(pattern))
-    match = re.compile(r"(?P<base>ms_[0-9]+\.)")
-    for file in files:
-        m = re.search(match, file)
-        if m is not None:
-            dest = os.path.join(directory, m.groupdict().get("base") + "jpg")
-            if os.path.isfile(dest):
-                os.remove(file)
-    logging.debug("Done Converting video frames to JPEG")
-
-
-##########################################################################
-#   Video rendering
-##########################################################################
-
-
-def render_video(directory, video_file):
-    """Render the frames to the given mp4 file"""
-    directory = os.path.realpath(directory)
-    files = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-    if len(files) > 1:
-        current_image = None
-        with open(os.path.join(directory, files[0]), "rb") as f_in:
-            current_image = f_in.read()
-        if current_image is not None:
-            command = [
-                "ffmpeg",
-                "-f",
-                "image2pipe",
-                "-vcodec",
-                "png",
-                "-r",
-                "30",
-                "-i",
-                "-",
-                "-vcodec",
-                "libx264",
-                "-r",
-                "30",
-                "-crf",
-                "24",
-                "-g",
-                "15",
-                "-preset",
-                "superfast",
-                "-y",
-                video_file,
-            ]
-            try:
-                proc = subprocess.Popen(command, stdin=subprocess.PIPE)
-                if proc:
-                    match = re.compile(r"ms_([0-9]+)\.")
-                    m = re.search(match, files[1])
-                    file_index = 0
-                    last_index = len(files) - 1
-                    if m is not None:
-                        next_image_time = int(m.group(1))
-                    done = False
-                    current_frame = 0
-                    while not done:
-                        current_frame_time = int(
-                            round(float(current_frame) * 1000.0 / 30.0)
-                        )
-                        if current_frame_time >= next_image_time:
-                            file_index += 1
-                            with open(
-                                os.path.join(directory, files[file_index]), "rb"
-                            ) as f_in:
-                                current_image = f_in.read()
-                            if file_index < last_index:
-                                m = re.search(match, files[file_index + 1])
-                                if m:
-                                    next_image_time = int(m.group(1))
-                            else:
-                                done = True
-                        proc.stdin.write(current_image)
-                        current_frame += 1
-                    # hold the end frame for one second so it's actually
-                    # visible
-                    for i in range(30):
-                        proc.stdin.write(current_image)
-                    proc.stdin.close()
-                    proc.communicate()
-            except Exception:
-                pass
-
-
-##########################################################################
-#   Reduce the number of saved video frames if necessary
-##########################################################################
-def cap_frame_count(directory, maxframes):
-    directory = os.path.realpath(directory)
-    frames = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-    frame_count = len(frames)
-    if frame_count > maxframes:
-        # First pass, sample all video frames at 10fps instead of 60fps,
-        # keeping the first 20% of the target
-        logging.debug(
-            "Sampling 10fps: Reducing {0:d} frames to target of {1:d}...".format(
-                frame_count, maxframes
-            )
-        )
-        skip_frames = int(maxframes * 0.2)
-        sample_frames(frames, 100, 0, skip_frames)
-
-        frames = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-        frame_count = len(frames)
-        if frame_count > maxframes:
-            # Second pass, sample all video frames after the first 5 seconds at
-            # 2fps, keeping the first 40% of the target
-            logging.debug(
-                "Sampling 2fps: Reducing {0:d} frames to target of {1:d}...".format(
-                    frame_count, maxframes
-                )
-            )
-            skip_frames = int(maxframes * 0.4)
-            sample_frames(frames, 500, 5000, skip_frames)
-
-            frames = sorted(glob.glob(os.path.join(directory, "ms_*.png")))
-            frame_count = len(frames)
-            if frame_count > maxframes:
-                # Third pass, sample all video frames after the first 10
-                # seconds at 1fps, keeping the first 60% of the target
-                logging.debug(
-                    "Sampling 1fps: Reducing {0:d} frames to target of {1:d}...".format(
-                        frame_count, maxframes
-                    )
-                )
-                skip_frames = int(maxframes * 0.6)
-                sample_frames(frames, 1000, 10000, skip_frames)
-
-    logging.debug(
-        "{0:d} frames final count with a target max of {1:d} frames...".format(
-            frame_count, maxframes
-        )
-    )
-
-
-def sample_frames(frames, interval, start_ms, skip_frames):
-    frame_count = len(frames)
-    if frame_count > 3:
-        # Always keep the first and last frames, only sample in the middle
-        first_frame = frames[0]
-        first_change = frames[1]
-        last_frame = frames[-1]
-        match = re.compile(r"ms_(?P<ms>[0-9]+)\.")
-        m = re.search(match, first_change)
-        first_change_time = 0
-        if m is not None:
-            first_change_time = int(m.groupdict().get("ms"))
-        last_bucket = None
-        logging.debug(
-            "Sapling frames in {0:d}ms intervals after {1:d} ms, skipping {2:d} frames...".format(
-                interval, first_change_time + start_ms, skip_frames
-            )
-        )
-        frame_count = 0
-        for frame in frames:
-            m = re.search(match, frame)
-            if m is not None:
-                frame_count += 1
-                frame_time = int(m.groupdict().get("ms"))
-                frame_bucket = int(math.floor(frame_time / interval))
-                if (
-                    frame_time > first_change_time + start_ms
-                    and frame_bucket == last_bucket
-                    and frame != first_frame
-                    and frame != first_change
-                    and frame != last_frame
-                    and frame_count > skip_frames
-                ):
-                    logging.debug("Removing sampled frame " + frame)
-                    os.remove(frame)
-                last_bucket = frame_bucket
-
-
-##########################################################################
-#   Visual Metrics
-##########################################################################
-
-
-def calculate_visual_metrics(
-    histograms_file,
-    start,
-    end,
-    perceptual,
-    contentful,
-    dirs,
-    progress_file,
-    hero_elements_file,
-    key_colors,
-):
-    metrics = None
-    histograms = load_histograms(histograms_file, start, end)
-    if histograms is not None and len(histograms) > 0:
-        progress = calculate_visual_progress(histograms)
-        if progress and progress_file is not None:
-            file_name, ext = os.path.splitext(progress_file)
-            if ext.lower() == ".gz":
-                f = gzip.open(progress_file, GZIP_TEXT, 7)
-            else:
-                f = open(progress_file, "w")
-            json.dump(progress, f)
-            f.close()
-        key_color_frames = calculate_key_color_frames(histograms, key_colors)
-        if len(histograms) > 1:
-            metrics = [
-                {"name": "First Visual Change", "value": histograms[1]["time"]},
-                {"name": "Last Visual Change", "value": histograms[-1]["time"]},
-                {"name": "Speed Index", "value": calculate_speed_index(progress)},
-            ]
-            if perceptual:
-                value, value_progress = calculate_perceptual_speed_index(progress, dirs)
-                metrics.extend(
-                    (
-                        {"name": "Perceptual Speed Index", "value": value},
-                        {
-                            "name": "Perceptual Speed Index Progress",
-                            "value": value_progress,
-                        },
-                    )
-                )
-            if contentful:
-                value, value_progress = calculate_contentful_speed_index(progress, dirs)
-
-                metrics.extend(
-                    (
-                        {"name": "Contentful Speed Index", "value": value},
-                        {
-                            "name": "Contentful Speed Index Progress",
-                            "value": value_progress,
-                        },
-                    )
-                )
-            if hero_elements_file is not None and os.path.isfile(hero_elements_file):
-                logging.debug("Calculating hero element times")
-                hero_data = None
-                hero_f_in = gzip.open(hero_elements_file, GZIP_READ_TEXT)
-                try:
-                    hero_data = json.load(hero_f_in)
-                except Exception as e:
-                    logging.exception("Could not load hero elements data")
-                    logging.exception(e)
-                hero_f_in.close()
-
-                if (
-                    hero_data is not None
-                    and hero_data["heroes"] is not None
-                    and hero_data["viewport"] is not None
-                    and len(hero_data["heroes"]) > 0
-                ):
-                    viewport = hero_data["viewport"]
-                    hero_timings = []
-                    for hero in hero_data["heroes"]:
-                        hero_timings.append(
-                            {
-                                "name": hero["name"],
-                                "value": calculate_hero_time(
-                                    progress, dirs, hero, viewport
-                                ),
-                            }
-                        )
-                    hero_timings_sorted = sorted(
-                        hero_timings, key=lambda timing: timing["value"]
-                    )
-                    # hero_timings.append({'name': 'FirstPaintedHero',
-                    #                     'value': hero_timings_sorted[0]['value']})
-                    hero_timings.append(
-                        {
-                            "name": "LastMeaningfulPaint",
-                            "value": hero_timings_sorted[-1]["value"],
-                        }
-                    )
-                    hero_data["timings"] = hero_timings
-                    metrics += hero_timings
-
-                    hero_f_out = gzip.open(hero_elements_file, GZIP_TEXT, 7)
-                    json.dump(hero_data, hero_f_out)
-                    hero_f_out.close()
-            else:
-                logging.warning(
-                    "Hero elements file is not valid: " + str(hero_elements_file)
-                )
-        else:
-            metrics = [
-                {"name": "First Visual Change", "value": histograms[0]["time"]},
-                {"name": "Last Visual Change", "value": histograms[0]["time"]},
-                {"name": "Visually Complete", "value": histograms[0]["time"]},
-                {"name": "Speed Index", "value": 0},
-            ]
-            if perceptual:
-                metrics.append({"name": "Perceptual Speed Index", "value": 0})
-            if contentful:
-                metrics.append({"name": "Contentful Speed Index", "value": 0})
-        if key_color_frames:
-            keysum = ""
-            for key in key_color_frames:
-                if len(keysum):
-                    keysum += ", "
-                framesum = ""
-                for frame in key_color_frames[key]:
-                    if len(framesum):
-                        framesum += " "
-                    framesum += "{0:d}-{1:d}".format(
-                        frame["start_time"], frame["end_time"]
-                    )
-                keysum += "{0}=[{1}]".format(key, framesum)
-            metrics.append({"name": "Key Color Frames", "value": keysum})
-        prog = ""
-        for p in progress:
-            if len(prog):
-                prog += ", "
-            prog += "{0:d}={1:d}".format(p["time"], int(p["progress"]))
-        metrics.append({"name": "Visual Progress", "value": prog})
-
-    return metrics
-
-
-def load_histograms(histograms_file, start, end):
-    histograms = None
-    if os.path.isfile(histograms_file):
-        f = gzip.open(histograms_file)
-        original = json.load(f)
-        f.close()
-        if start != 0 or end != 0:
-            histograms = []
-            for histogram in original:
-                if histogram["time"] <= start:
-                    histogram["time"] = start
-                    histograms = [histogram]
-                elif histogram["time"] <= end:
-                    histograms.append(histogram)
-                else:
-                    break
-        else:
-            histograms = original
-    return histograms
-
-
-def is_key_color_frame(histogram, key_color):
-    # The fraction is measured against the entire image, not just the sampled
-    # pixels. This helps avoid matching frames with only a few pixels that
-    # happen to be in the acceptable range.
-    total_fraction = histogram["total_pixels"] * key_color["fraction"]
-    if total_fraction < histogram["total_pixels"] - histogram["dropped_pixels"]:
-        for channel in ["r", "g", "b"]:
-            # Find the acceptable range around the target channel value
-            max_channel = len(histogram["histogram"][channel])
-            low = min(max_channel - 1, max(0, key_color[channel + "_low"]))
-            high = min(max_channel, max(1, key_color[channel + "_high"] + 1))
-            target_total = 0
-            for i in histogram["histogram"][channel][low:high]:
-                target_total += i
-            if target_total < total_fraction:
-                return False
-    return True
-
-
-def calculate_key_color_frames(histograms, key_colors):
-    if not key_colors:
-        return {}
-
-    key_color_frames = {}
-    for key in key_colors:
-        key_color_frames[key] = []
-
-    current = None
-    current_key = None
-    total = 0
-    matched = 0
-    buckets = 256
-    channels = ["r", "g", "b"]
-    histograms = histograms.copy()
-
-    while len(histograms) > 0:
-        histogram = histograms.pop(0)
-        matching_key = None
-        for key in key_colors:
-            if is_key_color_frame(histogram, key_colors[key]):
-                matching_key = key
-                break
-
-        if matching_key is None:
-            continue
-
-        last_histogram = histogram
-        frame_count = 1
-        while len(histograms) > 0:
-            last_histogram = histograms[0]
-            if is_key_color_frame(last_histogram, key_colors[matching_key]):
-                frame_count += 1
-                histograms.pop(0)
-            else:
-                break
-
-        logging.debug(
-            "{0:d}ms to {1:d}ms - Matched key color frame {2}".format(
-                histogram["time"], last_histogram["time"], matching_key
-            )
-        )
-
-        key_color_frames[matching_key].append(
-            {
-                "frame_count": frame_count,
-                "start_time": histogram["time"],
-                "end_time": last_histogram["time"],
-            }
-        )
-
-    return key_color_frames
-
-
-def calculate_visual_progress(histograms):
-    progress = []
-    first = histograms[0]["histogram"]
-    last = histograms[-1]["histogram"]
-    for index, histogram in enumerate(histograms):
-        p = calculate_frame_progress(histogram["histogram"], first, last)
-        file_name, ext = os.path.splitext(histogram["file"])
-        progress.append({"time": histogram["time"], "file": file_name, "progress": p})
-        logging.debug("{0:d}ms - {1:d}% Complete".format(histogram["time"], int(p)))
-    return progress
-
-
-def calculate_frame_progress(histogram, start, final):
-    total = 0
-    matched = 0
-    slop = 5  # allow for matching slight color variations
-    channels = ["r", "g", "b"]
-    for channel in channels:
-        channel_total = 0
-        channel_matched = 0
-        buckets = 256
-        available = [0 for i in range(buckets)]
-        for i in range(buckets):
-            available[i] = abs(histogram[channel][i] - start[channel][i])
-        for i in range(buckets):
-            target = abs(final[channel][i] - start[channel][i])
-            if target:
-                channel_total += target
-                low = max(0, i - slop)
-                high = min(buckets, i + slop)
-                for j in range(low, high):
-                    this_match = min(target, available[j])
-                    available[j] -= this_match
-                    channel_matched += this_match
-                    target -= this_match
-        total += channel_total
-        matched += channel_matched
-    progress = (float(matched) / float(total)) if total else 1
-    return math.floor(progress * 100)
-
-
-def find_visually_complete(progress):
-    time = 0
-    for p in progress:
-        if int(p["progress"]) == 100:
-            time = p["time"]
-            break
-        elif time == 0:
-            time = p["time"]
-    return time
-
-
-def calculate_speed_index(progress):
-    si = 0
-    last_ms = progress[0]["time"]
-    last_progress = progress[0]["progress"]
-    for p in progress:
-        elapsed = p["time"] - last_ms
-        si += elapsed * (1.0 - last_progress)
-        last_ms = p["time"]
-        last_progress = p["progress"] / 100.0
-    return int(si)
-
-
-def calculate_contentful_speed_index(progress, directory):
-    # convert output comes out with lines that have this format:
-    # <pixel count>: <rgb color> #<hex color> <gray color>
-    # This is CLI dependant and very fragile
-    matcher = re.compile(r"(\d+?):")
-
-    try:
-        dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), directory)
-        content = []
-        maxContent = 0
-        for p in progress[1:]:
-            # Full Path of the Current Frame
-            current_frame = os.path.join(dir, "ms_{0:06d}.png".format(p["time"]))
-            logging.debug("contentfulSpeedIndex: Current Image is %s" % current_frame)
-            # Takes full path of PNG frames to compute contentfulness value
-            command = "{0} {1} -canny 2x2+8%+8% -define histogram:unique-colors=true -format %c histogram:info:-".format(
-                image_magick["convert"], current_frame
-            )
-            output = subprocess.check_output(command, shell=True).decode("utf-8")
-            logging.debug("Output %s" % output)
-
-            # Take the last matching pixel count, which is the pixel count from the last
-            # line
-            pixel_count = matcher.findall(output)[-1]
-            if not pixel_count:
-                logging.debug("Could not find the contentfulness value")
-                return None, None
-
-            value = int(pixel_count)
-            if value > maxContent:
-                maxContent = value
-            content.append(value)
-
-        for i, value in enumerate(content):
-            content[i] = (
-                maxContent == 0 and 0.0 or float(content[i]) / float(maxContent)
-            )
-
-        # Assume 0 content for first frame
-        cont_si = 1 * (progress[1]["time"] - progress[0]["time"])
-        completeness_value = [(progress[1]["time"], int(cont_si))]
-        for i in range(1, len(progress) - 1):
-            elapsed = progress[i + 1]["time"] - progress[i]["time"]
-            # print i,' time =',p['time'],'elapsed =',elapsed,'content = ',content[i]
-            cont_si += elapsed * (1.0 - content[i])
-            completeness_value.append((progress[i + 1]["time"], int(cont_si)))
-
-        cont_si = int(cont_si)
-        raw_progress_value = ["0=0"]
-        for timestamp, percent in completeness_value:
-            p = int(100 * float(percent) / float(cont_si))
-            raw_progress_value.append("%d=%d" % (timestamp, p))
-
-        return cont_si, ", ".join(raw_progress_value)
-    except Exception as e:
-        logging.exception(e)
-        return None, None
-
-
-def calculate_perceptual_speed_index(progress, directory):
-    from ssim import compute_ssim
-
-    x = len(progress)
-    dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), directory)
-    first_paint_frame = os.path.join(dir, "ms_{0:06d}.png".format(progress[1]["time"]))
-    target_frame = os.path.join(dir, "ms_{0:06d}.png".format(progress[x - 1]["time"]))
-    ssim_1 = compute_ssim(first_paint_frame, target_frame)
-    per_si = float(progress[1]["time"])
-    last_ms = progress[1]["time"]
-    # Full Path of the Target Frame
-    logging.debug("Target image for perSI is %s" % target_frame)
-    ssim = ssim_1
-    completeness_value = []
-    for p in progress[1:]:
-        elapsed = p["time"] - last_ms
-        # print '*******elapsed %f'%elapsed
-        # Full Path of the Current Frame
-        current_frame = os.path.join(dir, "ms_{0:06d}.png".format(p["time"]))
-        logging.debug("Current Image is %s" % current_frame)
-        # Takes full path of PNG frames to compute SSIM value
-        per_si += elapsed * (1.0 - ssim)
-        ssim = compute_ssim(current_frame, target_frame)
-        gc.collect()
-        last_ms = p["time"]
-        completeness_value.append((p["time"], int(per_si)))
-
-    per_si = int(per_si)
-    raw_progress_value = ["0=0"]
-    for timestamp, percent in completeness_value:
-        p = int(100 * float(percent) / float(per_si))
-        raw_progress_value.append("%d=%d" % (timestamp, p))
-
-    return per_si, ", ".join(raw_progress_value)
-
-
-def calculate_hero_time(progress, directory, hero, viewport):
-    try:
-        dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), directory)
-        n = len(progress)
-        target_frame = os.path.join(dir, "ms_{0:06d}".format(progress[n - 1]["time"]))
-
-        extension = None
-        if os.path.isfile(target_frame + ".png"):
-            extension = ".png"
-        elif os.path.isfile(target_frame + ".jpg"):
-            extension = ".jpg"
-        if extension is not None:
-            hero_width = int(hero["width"])
-            hero_height = int(hero["height"])
-            hero_x = int(hero["x"])
-            hero_y = int(hero["y"])
-            target_frame = target_frame + extension
-            logging.debug(
-                "Target image for hero %s is %s" % (hero["name"], target_frame)
-            )
-
-            from PIL import Image
-
-            with Image.open(target_frame) as im:
-                width, height = im.size
-            if width != viewport["width"]:
-                scale = float(width) / float(viewport["width"])
-                logging.debug(
-                    "Frames are %dpx wide but viewport was %dpx. Scaling by %f"
-                    % (width, viewport["width"], scale)
-                )
-                hero_width = int(hero["width"] * scale)
-                hero_height = int(hero["height"] * scale)
-                hero_x = int(hero["x"] * scale)
-                hero_y = int(hero["y"] * scale)
-
-            logging.debug(
-                'Calculating render time for hero element "%s" at position [%d, %d, %d, %d]'
-                % (hero["name"], hero["x"], hero["y"], hero["width"], hero["height"])
-            )
-
-            # Create a rectangular mask of the hero element position
-            hero_mask = os.path.join(dir, "hero_{0}_mask.png".format(hero["name"]))
-            command = '{0} -size {1}x{2} xc:black -fill white -draw "rectangle {3},{4} {5},{6}" PNG24:"{7}"'.format(
-                image_magick["convert"],
-                width,
-                height,
-                hero_x,
-                hero_y,
-                hero_x + hero_width,
-                hero_y + hero_height,
-                hero_mask,
-            )
-            subprocess.call(command, shell=True)
-
-            # Apply the mask to the target frame to create the reference frame
-            target_mask = os.path.join(
-                dir,
-                "hero_{0}_ms_{1:06d}.png".format(hero["name"], progress[n - 1]["time"]),
-            )
-            command = "{0} {1} {2} -alpha Off -compose CopyOpacity -composite {3}".format(
-                image_magick["convert"], target_frame, hero_mask, target_mask
-            )
-            subprocess.call(command, shell=True)
-
-            def cleanup():
-                os.remove(hero_mask)
-                if os.path.isfile(target_mask):
-                    os.remove(target_mask)
-
-            # Allow for small differences like scrollbars and overlaid UI elements
-            # by applying a 10% fuzz and allowing for up to 2% of the pixels to be
-            # different.
-            fuzz = 10
-            max_pixel_diff = math.ceil(hero_width * hero_height * 0.02)
-
-            for p in progress:
-                current_frame = os.path.join(dir, "ms_{0:06d}".format(p["time"]))
-                extension = None
-                if os.path.isfile(current_frame + ".png"):
-                    extension = ".png"
-                elif os.path.isfile(current_frame + ".jpg"):
-                    extension = ".jpg"
-                if extension is not None:
-                    current_mask = os.path.join(
-                        dir, "hero_{0}_ms_{1:06d}.png".format(hero["name"], p["time"])
-                    )
-                    # Apply the mask to the current frame
-                    command = "{0} {1} {2} -alpha Off -compose CopyOpacity -composite {3}".format(
-                        image_magick["convert"],
-                        current_frame + extension,
-                        hero_mask,
-                        current_mask,
-                    )
-                    logging.debug(command)
-                    subprocess.call(command, shell=True)
-                    match = frames_match(
-                        target_mask, current_mask, fuzz, max_pixel_diff, None, None
-                    )
-                    # Remove each mask after using it
-                    os.remove(current_mask)
-
-                    if match:
-                        # Clean up masks as soon as a match is found
-                        cleanup()
-                        return p["time"]
-
-            # No matches found; clean up masks
-            cleanup()
-
-        return None
-    except Exception as e:
-        logging.exception(e)
-        return None
-
-
-##########################################################################
-#   Check any dependencies
-##########################################################################
-
-
-def check_config():
-    ok = True
-
-    print("ffmpeg:  ")
-    if get_decimate_filter() is not None:
-        print("OK")
-    else:
-        print("FAIL")
-        ok = False
-
-    print("convert: ")
-    if check_process("{0} -version".format(image_magick["convert"]), "ImageMagick"):
-        print("OK")
-    else:
-        print("FAIL")
-        ok = False
-
-    print("compare: ")
-    if check_process("{0} -version".format(image_magick["compare"]), "ImageMagick"):
-        print("OK")
-    else:
-        print("FAIL")
-        ok = False
-
-    print("Pillow:  ")
-    try:
-        from PIL import Image, ImageDraw  # noqa
-
-        print("OK")
-    except BaseException:
-        print("FAIL")
-        ok = False
-
-    print("SSIM:    ")
-    try:
-        from ssim import compute_ssim  # noqa
-
-        print("OK")
-    except BaseException:
-        print("FAIL")
-        ok = False
-
-    return ok
-
-
-def check_process(command, output):
-    ok = False
-    try:
-        if sys.version_info > (3, 0):
-            out = subprocess.check_output(
-                command, stderr=subprocess.STDOUT, shell=True, encoding="UTF-8"
-            )
-        else:
-            out = subprocess.check_output(command, stderr=subprocess.STDOUT, shell=True)
-        if out.find(output) > -1:
-            ok = True
-    except BaseException:
-        ok = False
-    return ok
-
-
-##########################################################################
-#   Main Entry Point
-##########################################################################
-
-
-def main():
-    import argparse
-
-    global options
-    global image_magick
-
-    parser = argparse.ArgumentParser(
-        description="Calculate visual performance metrics from a video.",
-        prog="visualmetrics",
-    )
-    parser.add_argument("--version", action="version", version="%(prog)s 0.1")
-    parser.add_argument(
-        "-c",
-        "--check",
-        action="store_true",
-        default=False,
-        help="Check dependencies (ffmpeg, imagemagick, PIL, SSIM).",
-    )
-    parser.add_argument(
-        "-v",
-        "--verbose",
-        action="count",
-        help="Increase verbosity (specify multiple times for more).",
-    )
-    parser.add_argument(
-        "--logfile", help="Write log messages to given file instead of stdout"
-    )
-    parser.add_argument(
-        "--logformat",
-        help="Formatting for the log messages",
-        default="%(asctime)s.%(msecs)03d - %(message)s",
-    )
-    parser.add_argument("-i", "--video", help="Input video file.")
-    parser.add_argument(
-        "-d",
-        "--dir",
-        help="Directory of video frames "
-        "(as input if exists or as output if a video file is specified).",
-    )
-    parser.add_argument(
-        "--render", help="Render the video frames to the given mp4 video file."
-    )
-    parser.add_argument(
-        "--screenshot",
-        help="Save the last frame of video as an image to the path provided.",
-    )
-    parser.add_argument(
-        "-g",
-        "--histogram",
-        help="Histogram file (as input if exists or as output if "
-        "histograms need to be calculated).",
-    )
-    parser.add_argument(
-        "-m",
-        "--timeline",
-        help="Timeline capture from Chrome dev tools. Used to synchronize the video"
-        " start time and only applies when orange frames are removed "
-        "(see --orange). The timeline file can be gzipped if it ends in .gz",
-    )
-    parser.add_argument(
-        "-q",
-        "--quality",
-        type=int,
-        help="JPEG Quality " "(if specified, frames will be converted to JPEG).",
-    )
-    parser.add_argument(
-        "-l",
-        "--full",
-        action="store_true",
-        default=False,
-        help="Keep full-resolution images instead of resizing to 400x400 pixels",
-    )
-    parser.add_argument(
-        "--thumbsize", type=int, default=400, help="Thumbnail size (defaults to 400)."
-    )
-    parser.add_argument(
-        "-f",
-        "--force",
-        action="store_true",
-        default=False,
-        help="Force processing of a video file (overwrite existing directory).",
-    )
-    parser.add_argument(
-        "-o",
-        "--orange",
-        action="store_true",
-        default=False,
-        help="Remove orange-colored frames from the beginning of the video.",
-    )
-    parser.add_argument(
-        "--gray",
-        action="store_true",
-        default=False,
-        help="Remove gray-colored frames from the beginning of the video.",
-    )
-    parser.add_argument(
-        "-w",
-        "--white",
-        action="store_true",
-        default=False,
-        help="Wait for a full white frame after a non-white frame "
-        "at the beginning of the video.",
-    )
-    parser.add_argument(
-        "--keycolor",
-        action="append",
-        nargs=8,
-        metavar=(
-            "key",
-            "red_low",
-            "red_high",
-            "green_low",
-            "green_high",
-            "blue_low",
-            "blue_high",
-            "fraction",
-        ),
-        help="Identify frames that match the given channel (0-255) low and "
-        "high. Fraction is the percentage of the pixels per channel that "
-        "must be in the given range (0-1).",
-    )
-    parser.add_argument(
-        "--multiple",
-        action="store_true",
-        default=False,
-        help="Multiple videos are combined, separated by orange frames."
-        "In this mode only the extraction is done and analysis "
-        "needs to be run separately on each directory. Numbered "
-        "directories will be created for each video under the output "
-        "directory.",
-    )
-    parser.add_argument(
-        "-n",
-        "--notification",
-        action="store_true",
-        default=False,
-        help="Trim the notification and home bars from the window.",
-    )
-    parser.add_argument(
-        "-p",
-        "--viewport",
-        action="store_true",
-        default=False,
-        help="Locate and use the viewport from the first video frame.",
-    )
-    parser.add_argument(
-        "-t",
-        "--viewporttime",
-        help="Time of the video frame to use for identifying the viewport "
-        "(in HH:MM:SS.xx format).",
-    )
-    parser.add_argument(
-        "--viewportretries",
-        type=int,
-        default=5,
-        help="Number of times to attempt to obtain a viewport. Analogous to the "
-        "number of frames to try to find a viewport with. By default, up to the "
-        "first 5 frames are used.",
-    )
-    parser.add_argument(
-        "--viewportminheight",
-        type=int,
-        default=0,
-        help="The minimum possible height (in pixels) for the viewport. Used when "
-        "attempting to find the viewport size. Defaults to 0.",
-    )
-    parser.add_argument(
-        "--viewportminwidth",
-        type=int,
-        default=0,
-        help="The minimum possible width (in pixels) for the viewport. Used when "
-        "attempting to find the viewport size. Defaults to 0.",
-    )
-    parser.add_argument(
-        "-s",
-        "--start",
-        type=int,
-        default=0,
-        help="Start time (in milliseconds) for calculating visual metrics.",
-    )
-    parser.add_argument(
-        "-e",
-        "--end",
-        type=int,
-        default=0,
-        help="End time (in milliseconds) for calculating visual metrics.",
-    )
-    parser.add_argument(
-        "--findstart",
-        type=int,
-        default=0,
-        help="Find the start of activity by looking at the top X%% "
-        "of the video (like a browser address bar).",
-    )
-    parser.add_argument(
-        "--renderignore",
-        type=int,
-        default=0,
-        help="Ignore the center X%% of the frame when looking for "
-        "the first rendered frame (useful for Opera mini).",
-    )
-    parser.add_argument(
-        "--startwhite",
-        action="store_true",
-        default=False,
-        help="Find the first fully white frame as the start of the video.",
-    )
-    parser.add_argument(
-        "--endwhite",
-        action="store_true",
-        default=False,
-        help="Find the first fully white frame after render start as the "
-        "end of the video.",
-    )
-    parser.add_argument(
-        "--forceblank",
-        action="store_true",
-        default=False,
-        help="Force the first frame to be blank white.",
-    )
-    parser.add_argument(
-        "--trimend",
-        type=int,
-        default=0,
-        help="Time to trim from the end of the video (in milliseconds).",
-    )
-    parser.add_argument(
-        "--maxframes",
-        type=int,
-        default=0,
-        help="Maximum number of video frames before reducing by "
-        "sampling (to 10fps, 1fps, etc).",
-    )
-    parser.add_argument(
-        "-k",
-        "--perceptual",
-        action="store_true",
-        default=False,
-        help="Calculate perceptual Speed Index",
-    )
-    parser.add_argument(
-        "--contentful",
-        action="store_true",
-        default=False,
-        help="Calculate contentful Speed Index",
-    )
-    parser.add_argument(
-        "-j",
-        "--json",
-        action="store_true",
-        default=False,
-        help="Set output format to JSON",
-    )
-    parser.add_argument("--progress", help="Visual progress output file.")
-    parser.add_argument("--herodata", help="Hero elements data file.")
-
-    options = parser.parse_args()
-
-    if (
-        not options.check
-        and not options.dir
-        and not options.video
-        and not options.histogram
-    ):
-        parser.error(
-            "A video, Directory of images or histograms file needs to be provided.\n\n"
-            "Use -h to see available options"
-        )
-
-    if options.perceptual or options.contentful:
-        if not options.video:
-            parser.error(
-                "A video file needs to be provided.\n\n"
-                "Use -h to see available options"
-            )
-
-    temp_dir = tempfile.mkdtemp(prefix="vis-")
-    colors_temp_dir = tempfile.mkdtemp(prefix="vis-color-")
-    directory = temp_dir
-    if options.dir is not None:
-        directory = options.dir
-    if options.histogram is not None:
-        histogram_file = options.histogram
-    else:
-        histogram_file = os.path.join(temp_dir, "histograms.json.gz")
-
-    # Set up logging
-    log_level = logging.CRITICAL
-    if options.verbose == 1:
-        log_level = logging.ERROR
-    elif options.verbose == 2:
-        log_level = logging.WARNING
-    elif options.verbose == 3:
-        log_level = logging.INFO
-    elif options.verbose == 4:
-        log_level = logging.DEBUG
-    if options.logfile is not None:
-        logging.basicConfig(
-            filename=options.logfile,
-            level=log_level,
-            format=options.logformat,
-            datefmt="%H:%M:%S",
-        )
-    else:
-        logging.basicConfig(
-            level=log_level, format=options.logformat, datefmt="%H:%M:%S"
-        )
-
-    if options.multiple:
-        options.orange = True
-
-    if platform.system() == "Windows":
-        paths = [os.getenv("ProgramFiles"), os.getenv("ProgramFiles(x86)")]
-        for path in paths:
-            if path is not None and os.path.isdir(path):
-                dirs = sorted(os.listdir(path), reverse=True)
-                for subdir in dirs:
-                    if subdir.lower().startswith("imagemagick"):
-                        convert = os.path.join(path, subdir, "convert.exe")
-                        compare = os.path.join(path, subdir, "compare.exe")
-                        mogrify = os.path.join(path, subdir, "mogrify.exe")
-                        if (
-                            os.path.isfile(convert)
-                            and os.path.isfile(compare)
-                            and os.path.isfile(mogrify)
-                        ):
-                            if convert.find(" ") >= 0:
-                                convert = '"{0}"'.format(convert)
-                            if compare.find(" ") >= 0:
-                                compare = '"{0}"'.format(compare)
-                            if mogrify.find(" ") >= 0:
-                                mogrify = '"{0}"'.format(mogrify)
-                            image_magick["convert"] = convert
-                            image_magick["compare"] = compare
-                            image_magick["mogrify"] = mogrify
-                            break
-
-    ok = False
-    try:
-        if not options.check:
-            if options.video:
-                orange_file = None
-                if options.orange:
-                    orange_file = os.path.join(
-                        os.path.dirname(os.path.realpath(__file__)), "orange.png"
-                    )
-                    if not os.path.isfile(orange_file):
-                        orange_file = os.path.join(colors_temp_dir, "orange.png")
-                        generate_orange_png(orange_file)
-                white_file = None
-                if options.white or options.startwhite or options.endwhite:
-                    white_file = os.path.join(
-                        os.path.dirname(os.path.realpath(__file__)), "white.png"
-                    )
-                    if not os.path.isfile(white_file):
-                        white_file = os.path.join(colors_temp_dir, "white.png")
-                        generate_white_png(white_file)
-                gray_file = None
-                if options.gray:
-                    gray_file = os.path.join(
-                        os.path.dirname(os.path.realpath(__file__)), "gray.png"
-                    )
-                    if not os.path.isfile(gray_file):
-                        gray_file = os.path.join(colors_temp_dir, "gray.png")
-                        generate_gray_png(gray_file)
-                video_to_frames(
-                    options.video,
-                    directory,
-                    options.force,
-                    orange_file,
-                    white_file,
-                    gray_file,
-                    options.multiple,
-                    options.viewport,
-                    options.viewporttime,
-                    options.viewportretries,
-                    options.viewportminheight,
-                    options.viewportminwidth,
-                    options.full,
-                    options.timeline,
-                    options.trimend,
-                )
-            if not options.multiple:
-                if options.render is not None:
-                    render_video(directory, options.render)
-                key_colors = {}
-                if options.keycolor:
-                    for key_params in options.keycolor:
-                        key_colors[key_params[0]] = {
-                            "r_low": int(key_params[1]),
-                            "r_high": int(key_params[2]),
-                            "g_low": int(key_params[3]),
-                            "g_high": int(key_params[4]),
-                            "b_low": int(key_params[5]),
-                            "b_high": int(key_params[6]),
-                            "fraction": float(key_params[7]),
-                        }
-
-                # Calculate the histograms and visual metrics
-                calculate_histograms(directory, histogram_file, options.force)
-                metrics = calculate_visual_metrics(
-                    histogram_file,
-                    options.start,
-                    options.end,
-                    options.perceptual,
-                    options.contentful,
-                    directory,
-                    options.progress,
-                    options.herodata,
-                    key_colors,
-                )
-
-                if options.screenshot is not None:
-                    quality = 30
-                    if options.quality is not None:
-                        quality = options.quality
-                    save_screenshot(directory, options.screenshot, quality)
-                # JPEG conversion
-                if options.dir is not None and options.quality is not None:
-                    convert_to_jpeg(directory, options.quality)
-
-                if metrics is not None:
-                    ok = True
-                    if options.json:
-                        data = dict()
-                        for metric in metrics:
-                            data[metric["name"].replace(" ", "")] = metric["value"]
-                        if "videoRecordingStart" in globals():
-                            data["videoRecordingStart"] = videoRecordingStart
-                        print(json.dumps(data))
-                    else:
-                        for metric in metrics:
-                            print("{0}: {1}".format(metric["name"], metric["value"]))
-        else:
-            ok = check_config()
-    except Exception as e:
-        logging.exception(e)
-        ok = False
-
-    # Clean up
-    shutil.rmtree(temp_dir)
-    shutil.rmtree(colors_temp_dir)
-    if ok:
-        exit(0)
-    else:
-        exit(1)
-
-
-if "__main__" == __name__:
-    main()