Extract Video Frames To Images (Image Analyst Tools)

Summary

Extracts video frame images and associated metadata from a metadata compliant video stream. The extracted images can be added to a mosaic dataset or other tools and functions for further analysis.

Usage

This tool works with archived video data only. Live stream videos are not supported.
Images from a metadata compliant video stream will be extracted and stored in a directory in TIFF, NITF, PNG, or JPEG format.
Metadata associated with the video imagery will be written to a comma-separated values file (.csv) in the same directory.

Label	Explanation	Data type
Input Video File	The input video file in any of the following supported video file formats: `.avi`, `.m2ts`, `.mkv`, `.mov`, `.mp2`, `.mp4`, `.mpeg`, `.mpeg2`, `.mpeg4`, `.mpg`, `.mpg2`, `.mpg4`, `.ps`, `.ts`, `.vob`, and `.wmv`.	File
Output Folder	The file directory where the output images and metadata will be saved.	Folder
Image Type (Optional)	Specifies the output image format. JPEG—The output will be in JPEG image format. TIFF—The output will be in TIFF image format. This is the default. NITF—The output will be in NITF image format. PNG—The output will be in PNG image format.	String
Maximum Overlap Percentage (Optional)	The maximum overlap percentage between two images. If the overlap between a candidate image and the last image written to disk is greater than this value, the candidate image will be ignored. The default percentage is 100 percent, which writes all images to disk.	Double
Require Fresh Metadata (Optional)	Specifies whether only video frames with associated metadata will be extracted and saved. Checked—Only video frames with associated metadata will be saved. Unchecked—All video frames will be saved. This is the default.	Boolean
Minimum Time Between Features (Optional)	The minimum time interval between video frames that will be saved. If no value is provided, all video frames will be saved as images.	Time Unit

ExtractVideoFramesToImages(in_video, out_folder, {image_type}, {image_overlap}, {require_fresh_metadata}, {min_time})

Name	Explanation	Data type
in_video	The input video file in any of the following supported video file formats: `.avi`, `.m2ts`, `.mkv`, `.mov`, `.mp2`, `.mp4`, `.mpeg`, `.mpeg2`, `.mpeg4`, `.mpg`, `.mpg2`, `.mpg4`, `.ps`, `.ts`, `.vob`, and `.wmv`.	File
out_folder	The file directory where the output images and metadata will be saved.	Folder
image_type (Optional)	Specifies the output image format. `JPEG`—The output will be in JPEG image format. `TIFF`—The output will be in TIFF image format. This is the default. `NITF`—The output will be in NITF image format. `PNG`—The output will be in PNG image format.	String
image_overlap (Optional)	The maximum overlap percentage between two images. If the overlap between a candidate image and the last image written to disk is greater than this value, the candidate image will be ignored. The default percentage is 100 percent, which writes all images to disk.	Double
require_fresh_metadata (Optional)	Specifies whether only video frames with associated metadata will be extracted and saved. `REQUIRE_FRESH_METADATA`—Only video frames with associated metadata will be saved. `NO_REQUIRE_FRESH_METADATA`—All video frames will be saved. This is the default.	Boolean
min_time (Optional)	The minimum time interval between video frames that will be saved. If no value is provided, all video frames will be saved as images.	Time Unit

Code sample

ExtractVideoFramesToImages example 1 (Python window)

This example extracts video frame images and associated metadata from a video stream and saves the data to a directory.

arcpy.ia.ExtractVideoFramesToImages(r"c:\test\video.ts", r"C:\temp2\outimages",
"TIFF", 100, "", "20 Seconds")

ExtractVideoFramesToImages example 2 (stand-alone script)

This example extracts video frame images and associated metadata from a video stream and saves the data to a directory.

import arcpy
from arcpy.ia import *

in_video = "c:\\test\\drone_vid.ts"
out_folder = "c:\\output"
outformat = "NITF"
maxoverlap = 100
requirefreshmeta = "REQUIRE_FRESH_METADATA"
mintimebetween = "1 minute"

arcpy.ia.ExtractVideoFramesToImages(in_video, out_folder, outformat, maxoverlap,
requirefreshmeta, mintimebetween)

Environments

This tool does not use any geoprocessing environments.

Licensing information