Configuration

Variable	Default	Tunable	Description
frame_time	0.03333333	NO	Inter frame time in seconds. If the input video stream does not supply frame times, this value is used to create a default timestamp. If the video stream has frame times, then those are used.
video_filename	(no default value)	NO	Name of video file.
video_reader	(no default value)	NO	Name of video input algorithm. Name of the video reader algorithm plugin is specified as video_reader:type = <algo-name>

Input Ports

There are no input ports for this process.

Output Ports

Port name	Data Type	Flags	Description
image	kwiver:image	(none)	Single frame image.
timestamp	kwiver:timestamp	(none)	Timestamp for input image.
video_metadata	kwiver:video_metadata	(none)	Video metadata vector for a frame.

Pipefile Usage

The following sections describe the blocks needed to use this process in a pipe file.

Pipefile block

# ================================================================
process <this-proc>
  :: video_input
# Inter frame time in seconds. If the input video stream does not supply frame
# times, this value is used to create a default timestamp. If the video stream
# has frame times, then those are used.
  frame_time = 0.03333333
# Name of video file.
  video_filename = <value>
# Name of video input algorithm.  Name of the video reader algorithm plugin is
# specified as video_reader:type = <algo-name>
  video_reader = <value>
# ================================================================

Process connections

The following Input ports will need to be set

# There are no input port's for this process

The following Output ports will need to be set

# This process will produce the following output ports
connect from <this-proc>.image
         to   <downstream-proc>.image
connect from <this-proc>.timestamp
         to   <downstream-proc>.timestamp
connect from <this-proc>.video_metadata
         to   <downstream-proc>.video_metadata

Class Description

class video_input_process : public sprokit::process

Reads a video file and passes the images as output.

\oports \oport{image}

\oport{frame} \oport{time} \oport{metadata}

class priv