Package: video-kf
Quick guideInstallationpip install video-kfUsageOpen a command line, or a terminal, from the same directory where your video is located and run:video-kf "My_video.mp4"If the command line was open in a different directory from where the video is located, then the full path would be
needed.Extended documentationVideo-kf is a Python package that can be run either from the command line, or from inside Python, by importing it.
It extracts the most relevant keyframes of a video, based on different methods.At the moment, there are 3 methods available:iframes: it extracts theiframesof the video,
calculated by ffmpeg. This is the default option.Use in the command line:video-kf "My_video.mp4"orvideo-kf "My_video.mp4" -m "iframes"Use inside Python:importvideokfasvfvf.extract_keyframes("My_video.mp4")orimportvideokfasvfvf.extract_keyframes("My_video.mp4",method="iframes")color: it returns the average frame, based on color, of every shot sequence. Shot sequences are group of frames
that start with an iframe.Use in the command line:video-kf "My_video.mp4" -m "color"Use inside Python:importvideokfasvfvf.extract_keyframes("My_video.mp4",method="color")flow: it returns the most still frame with respect of the previous frame of every shot sequence. Shot sequences
are group of frames that start with an iframe.Use in the command line:video-kf "My_video.mp4" -m "flow"Use inside Python:importvideokfasvfvf.extract_keyframes("My_video.mp4",method="flow")CautionThe methodscolorandflowwill download all the framesof the video. Keep in mind that if the video is long,
this will take time, as well as space to save the frames.This is not the case for the methodiframesthat will only download the iframes.Use of Ffmpeg and FfprobeVideo-kf automatically downloads the executable files offfmpegandffprobeand saves them, by default, in a
folder called "Ffmpeg" located in yourhomedirectory. You can choose to save the executable files in a different
location by running:video-kf "My_video.mp4" -dir "PATH_RO_A_DIFFERENT_LOCATION"If you already haveffmpegorffprobeinstalled, you can also use your own executable files. There are various ways
of doing this, all of them equivalent. Choose the one that best suits you:Using the command line optionsffmpegandffprobe(you can choose to use just one of the two):video-kf "My_video.mp4" -ffmpeg "PATH_TO_FFMPEG" -ffprobe "PATH_TO_FFPROBE"Savingffmpegandffprobeas environmental variables named respectively FFMPEG and FFPROBE.Saving manuallyffmpegandffprobein the folder called "Ffmpeg", which by default is located in yourhomedirectory, and running the program normally (either in the command line or inside python). You can also choose a
different directory through the command line with the-diroptionCommand line optionspositional arguments:
  video_file            Path to the video file to extract the keyframes from.

optional arguments:
  -h, --help            show this help message and exit
  -m METHOD, --method METHOD
                        Method to extract the keyframes
  -o OUTPUT_DIR_KEYFRAMES, --output_dir_keyframes OUTPUT_DIR_KEYFRAMES
                        Directory where to extract keyframes. If it is a
                        string instead of a directory, keyframes will be saved
                        in a folder named as this string, located in the same
                        directory of the video
  -ffmpeg FFMPEG, --ffmpeg FFMPEG
                        Path to the Ffmpeg executable
  -ffprobe FFPROBE, --ffprobe FFPROBE
                        Path to the Ffprobe executable
  -dir DIR_FFMPEG_FFPROBE, --dir_ffmpeg_ffprobe DIR_FFMPEG_FFPROBE
                        Path to the directory containing both Ffmpeg and
                        Ffprobe executables
  --no-frames-rm        If present, this option will NOT remove the directory
                        with the extracted frames, if they were extracted
                        (only for 'color' and 'flow' methods)ReferencesFFmpeg Developers. (2016). Ffmpeg tool [Software].
Available fromhttp://ffmpeg.org/Binaries obtained from:https://ffbinaries.com/readme