add keyframe detector files

video_keyframe_detector/KeyFrameDetector/__init__.py

@@ -0,0 +1 @@
+from video_keyframe_detector.KeyFrameDetector import key_frame_detector

video_keyframe_detector/KeyFrameDetector/key_frame_detector.py

@@ -0,0 +1,72 @@
+import os
+import cv2
+import csv
+import numpy as np
+import time
+import peakutils
+from video_keyframe_detector.KeyFrameDetector.utils import convert_frame_to_grayscale, prepare_dirs, plot_metrics
+
+def keyframeDetection(source, dest, Thres, plotMetrics=False, verbose=False):
+    
+    keyframePath = dest+'/keyFrames'
+    imageGridsPath = dest+'/imageGrids'
+    csvPath = dest+'/csvFile'
+    path2file = csvPath + '/output.csv'
+    prepare_dirs(keyframePath, imageGridsPath, csvPath)
+
+    cap = cv2.VideoCapture(source)
+    length = int(cap.get(cv2.CAP_PROP_FRAME_COUNT))
+  
+    if (cap.isOpened()== False):
+        print("Error opening video file")
+
+    lstfrm = []
+    lstdiffMag = []
+    timeSpans = []
+    images = []
+    full_color = []
+    lastFrame = None
+    Start_time = time.process_time()
+    
+    # Read until video is completed
+    for i in range(length):
+        ret, frame = cap.read()
+        grayframe, blur_gray = convert_frame_to_grayscale(frame)
+
+        frame_number = cap.get(cv2.CAP_PROP_POS_FRAMES) - 1
+        lstfrm.append(frame_number)
+        images.append(grayframe)
+        full_color.append(frame)
+        if frame_number == 0:
+            lastFrame = blur_gray
+
+        diff = cv2.subtract(blur_gray, lastFrame)
+        diffMag = cv2.countNonZero(diff)
+        lstdiffMag.append(diffMag)
+        stop_time = time.process_time()
+        time_Span = stop_time-Start_time
+        timeSpans.append(time_Span)
+        lastFrame = blur_gray
+
+    cap.release()
+    y = np.array(lstdiffMag)
+    base = peakutils.baseline(y, 2)
+    indices = peakutils.indexes(y-base, Thres, min_dist=1)
+    
+    ##plot to monitor the selected keyframe
+    if (plotMetrics):
+        plot_metrics(indices, lstfrm, lstdiffMag)
+
+    cnt = 1
+    for x in indices:
+        cv2.imwrite(os.path.join(keyframePath , 'keyframe'+ str(cnt) +'.jpg'), full_color[x])
+        cnt +=1
+        log_message = 'keyframe ' + str(cnt) + ' happened at ' + str(timeSpans[x]) + ' sec.'
+        if(verbose):
+            print(log_message)
+        with open(path2file, 'w') as csvFile:
+            writer = csv.writer(csvFile)
+            writer.writerows(log_message)
+            csvFile.close()
+
+    cv2.destroyAllWindows()

video_keyframe_detector/KeyFrameDetector/utils.py

@@ -0,0 +1,60 @@
+import os
+import cv2
+import matplotlib.pyplot as plt
+from PIL import Image
+
+def scale(img, xScale, yScale):
+    res = cv2.resize(img, None, fx=xScale, fy=yScale, interpolation=cv2.INTER_AREA)
+    return res
+
+
+def crop(infile, height, width):
+    im = Image.open(infile)
+    imgwidth, imgheight = im.size
+    for i in range(imgheight // height):
+        for j in range(imgwidth // width):
+            box = (j * width, i * height, (j + 1) * width, (i + 1) * height)
+            yield im.crop(box)
+
+
+def averagePixels(path):
+    r, g, b = 0, 0, 0
+    count = 0
+    pic = Image.open(path)
+    for x in range(pic.size[0]):
+        for y in range(pic.size[1]):
+            imgData = pic.load()
+            tempr, tempg, tempb = imgData[x, y]
+            r += tempr
+            g += tempg
+            b += tempb
+            count += 1
+    return (r / count), (g / count), (b / count), count
+
+def convert_frame_to_grayscale(frame):
+    grayframe = None
+    gray = None
+    if frame is not None:
+        cv2.cvtColor(frame, cv2.COLOR_BGR2GRAY)
+        gray = cv2.cvtColor(frame, cv2.COLOR_BGR2GRAY)
+        gray = scale(gray, 1, 1)
+        grayframe = scale(gray, 1, 1)
+        gray = cv2.GaussianBlur(gray, (9, 9), 0.0)
+    return grayframe, gray
+
+def prepare_dirs(keyframePath, imageGridsPath, csvPath):
+    if not os.path.exists(keyframePath):
+        os.makedirs(keyframePath)
+    if not os.path.exists(imageGridsPath):
+        os.makedirs(imageGridsPath)
+    if not os.path.exists(csvPath):
+        os.makedirs(csvPath)
+
+
+def plot_metrics(indices, lstfrm, lstdiffMag):
+    plt.plot(indices, y[indices], "x")
+    l = plt.plot(lstfrm, lstdiffMag, 'r-')
+    plt.xlabel('frames')
+    plt.ylabel('pixel difference')
+    plt.title("Pixel value differences from frame to frame and the peak values")
+    plt.show()

video_keyframe_detector/cli.py

@@ -0,0 +1,19 @@
+import argparse
+
+from video_keyframe_detector.KeyFrameDetector.key_frame_detector import keyframeDetection
+
+def main():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument('-s','--source', help='source file', required=True)
+    parser.add_argument('-d', '--dest', help='destination folder', required=True)
+    parser.add_argument('-t','--Thres', help='Threshold of the image difference', default=0.3)
+
+    args = parser.parse_args()
+
+
+    keyframeDetection(args.source, args.dest, float(args.Thres))
+    
+
+if __name__ == '__main__':
+    main()

video_keyframe_detector/download_video.py

@@ -0,0 +1,17 @@
+import argparse
+from pytube import YouTube
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--video-url", type=str)
+    parser.add_argument("--save-file", type=str)
+    args = parser.parse_args()
+
+    youtube = YouTube(args.video_url)
+    youtube.streams.filter(file_extension='mp4')
+    youtube.streams.get_by_itag(18).download(filename=args.save_file)
+
+
+if __name__ == '__main__':
+    main()

video_keyframe_detector/setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="key-frame-detector",
+    version="1.0.0",
+    author="Joel Ibaceta",
+    author_email="mail@joelibaceta.com",
+    license='MIT',
+    description="It is a simple python tool to extract key frame images from a video file",
+    long_description="A simple tool to detect and extract key frame images from a video file",
+    url="https://github.com/joelibaceta/video-keyframe-extractor",
+    project_urls={
+        'Source': 'https://github.com/joelibaceta/video-keyframe-extractor',
+        'Tracker': 'https://github.com/joelibaceta/video-keyframe-extractor/issues'
+    },
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=['opencv-python', 'numpy', 'peakutils'],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    keywords='video key-frame terminal opencv extractor',
+    entry_points={
+        "console_scripts": [
+            'key-frames-detector=cli:main'
+        ]
+    }
+)