com.tsgrp.opencontent.universal.video

Class FFmpegVideoUtil

java.lang.Object

com.tsgrp.opencontent.universal.video.FFmpegVideoUtil

public class FFmpegVideoUtil
extends java.lang.Object

Utility class for FFmpeg video manipulation

Constructor Summary

Constructors

Constructor and Description
FFmpegVideoUtil()

Method Summary

Modifier and Type	Method and Description
static void	changeVideoCodecs(java.util.List<FFmpegVideo> videos) Public function to change video codecs if they are not "h264" which would be .mp4 codec
static java.lang.String	checkCodec(java.lang.String videoPath) Public function that will check the codec of a video path that is given by using ffprobe
static java.util.List<java.lang.String>	cleanLocation(java.lang.String local) Clean location once it is found
static java.lang.String	combineVideosToCollage(java.util.List<EnhancedObjectContent> ecos, java.util.List<java.util.List<Annotation>> allVideoAnnotations, java.lang.Integer minStartTime, java.lang.Integer maxEndTime) Public function that creates a video collage of the four passed-in video inputStreams and sets it on the response
static java.io.File	createFinalCollage(java.lang.String finalCollageFileFullPath, java.util.List<FFmpegVideo> videos, java.util.List<java.lang.String> mergedVideos) Merges together all of the video collages to create final video
static void	createUniformLengthVideoClips(java.lang.Integer start, java.lang.Integer duration, java.util.List<FFmpegVideo> videos) Calls clip_video on all videos to create clips at given start time for given duration
static void	createVideoClip(java.lang.String videoPath, java.lang.String start, java.lang.String duration, java.lang.String outputPath) Creates a clip of video at given start and end times
static java.io.File	createVideoCollageByAnnotations(java.util.List<java.util.List<Annotation>> allVideoAnnotations, java.util.List<EnhancedObjectContent> ecos, java.lang.Integer minStartTime, java.lang.Integer maxEndTime, java.util.List<FFmpegVideo> videos) Public function that creates collages of the selected videos based on their annotations.
static void	deleteVideoClipsByName(java.util.List<java.lang.String> videoNames) Deletes all of the video clips in the working directory
static void	executeMergeVideoCommands(java.lang.String outputFile, java.util.List<FFmpegVideo> videos) Creates a video collage out of the clips that have been created.
static java.io.File	getTempFile(java.io.InputStream content, java.lang.String name) public function that creates a temporary mp4 file with the passed-in name and content
static java.util.List<java.lang.String>	getVideoData(java.lang.String videoFileName, java.lang.String query) Gets the video data from a video file using FFprobe
static void	prioritize(java.lang.String videoName, java.util.List<FFmpegVideo> videos) Sets the priority of all videos.
static void	runCommand(java.util.List<java.lang.String> command) runs list of string commands on system command line
static java.util.List<java.lang.String>	searchMetadata(org.json.JSONObject obj, java.lang.String query) Recursively iterate through whole json obj and check if query can be pulled If it can, the items that it found will be returned

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FFmpegVideoUtil

public FFmpegVideoUtil()

Method Detail

combineVideosToCollage

public static java.lang.String combineVideosToCollage(java.util.List<EnhancedObjectContent> ecos,
                                                      java.util.List<java.util.List<Annotation>> allVideoAnnotations,
                                                      java.lang.Integer minStartTime,
                                                      java.lang.Integer maxEndTime)

Public function that creates a video collage of the four passed-in video inputStreams and sets it on the response

Parameters:

{List} - ecos list of the enhanced object contents that will be merged

{List} - allVideoAnnotations list of all video annotations

{Integer} - minStartTime the min start time for the selected videos (start time of first annotation)

{Integer} - maxEndTime the max end time for the selected videos (end time of the last annotation)

Returns:

{String} the path where the merged video will temporarily be before uploaded

getTempFile

public static java.io.File getTempFile(java.io.InputStream content,
                                       java.lang.String name)

public function that creates a temporary mp4 file with the passed-in name and content

Parameters:

content - - the content of the temporary file

name - - the name of the temporary file

Returns:

File - the temporary file that has been created

createVideoCollageByAnnotations

public static java.io.File createVideoCollageByAnnotations(java.util.List<java.util.List<Annotation>> allVideoAnnotations,
                                                           java.util.List<EnhancedObjectContent> ecos,
                                                           java.lang.Integer minStartTime,
                                                           java.lang.Integer maxEndTime,
                                                           java.util.List<FFmpegVideo> videos)
                                                    throws java.lang.InterruptedException,
                                                           java.io.IOException

Public function that creates collages of the selected videos based on their annotations. Able to merge between 2 and 4 videos.

Parameters:

{List>} - allVideoAnnotations: a master list of all the annotations for the videos that will be merged together.

{List} - ecos: list of the enhanced object contents that will be merged

{String} - finalCollageFileFullPath: the filepath where the final merged video will live

{Integer} - minStartTime: the min start time for the selected videos (start time of first annotation)

{Integer} - maxEndTime: the max end time for the selected videos (end time of the last annotation)

{List} - videos: list of the FFmpegvideo objects for the videos that will be merged

Throws:

IOException, - InterruptedException

java.lang.InterruptedException

java.io.IOException

changeVideoCodecs

public static void changeVideoCodecs(java.util.List<FFmpegVideo> videos)
                              throws java.lang.InterruptedException

Public function to change video codecs if they are not "h264" which would be .mp4 codec

Parameters:

{List} - videos: list of video files to be processed

Throws:

java.lang.InterruptedException

checkCodec

public static java.lang.String checkCodec(java.lang.String videoPath)

Public function that will check the codec of a video path that is given by using ffprobe

Parameters:

{String} - videoPath: path to the video file that is about to be checked

Throws:

java.io.IOException

java.lang.InterruptedException

createFinalCollage

public static java.io.File createFinalCollage(java.lang.String finalCollageFileFullPath,
                                              java.util.List<FFmpegVideo> videos,
                                              java.util.List<java.lang.String> mergedVideos)
                                       throws java.io.IOException,
                                              java.lang.InterruptedException

Merges together all of the video collages to create final video

Parameters:

{String} - finalCollageFileFullPath: the filepath where the final merged video will live

{List} - videos: list of the FFmpegvideo objects for the videos that will be merged

{List} - mergedVideos: master list of all of the video collages that have been made

Throws:

java.io.IOException

java.lang.InterruptedException

createUniformLengthVideoClips

public static void createUniformLengthVideoClips(java.lang.Integer start,
                                                 java.lang.Integer duration,
                                                 java.util.List<FFmpegVideo> videos)
                                          throws java.lang.InterruptedException

Calls clip_video on all videos to create clips at given start time for given duration

Parameters:

{Integer} - start: time that the clip will start at

{Integer} - duration: how long the clip will be

{List} - videos: list of the FFmpegvideo objects for the videos that will be merged

Throws:

java.lang.InterruptedException

prioritize

public static void prioritize(java.lang.String videoName,
                              java.util.List<FFmpegVideo> videos)

Sets the priority of all videos. The video that the annotation belongs to will be set to 1. All others will be set to 0.

Parameters:

{String} - videoName: name of the video that needs to be marked as video in priority

{List} - videos: list of the FFmpegvideo objects for the videos that will be merged

executeMergeVideoCommands

public static void executeMergeVideoCommands(java.lang.String outputFile,
                                             java.util.List<FFmpegVideo> videos)
                                      throws java.lang.InterruptedException

Creates a video collage out of the clips that have been created. A different filter will be used based on the videos array size and the video that is currently in priority.

Parameters:

{String} - outputFile : path to the output file - the new merged video

{List} - videos: list of the FFmpegvideo objects for the videos that will be merged

Throws:

java.lang.InterruptedException

deleteVideoClipsByName

public static void deleteVideoClipsByName(java.util.List<java.lang.String> videoNames)
                                   throws java.lang.InterruptedException

Deletes all of the video clips in the working directory

Parameters:

{List} - videoNames: list of all of the videos that need to be deleted from working directory

Throws:

java.lang.InterruptedException

getVideoData

public static java.util.List<java.lang.String> getVideoData(java.lang.String videoFileName,
                                                            java.lang.String query)
                                                     throws org.json.JSONException,
                                                            java.lang.InterruptedException

Gets the video data from a video file using FFprobe

Parameters:

{String} - videoFileName the path to the video that the metadata is being pulled from

{String} - query: param that the we are searching metadata for (i.e. setting query to "duration" will search the video metadata for the duration tag)

Returns:

{List} itemsFounds: returns an array list of the items that the search brought back (i.e. querying for "duration" might bring back "60")

Throws:

org.json.JSONException

java.lang.InterruptedException

searchMetadata

public static java.util.List<java.lang.String> searchMetadata(org.json.JSONObject obj,
                                                              java.lang.String query)
                                                       throws org.json.JSONException

Recursively iterate through whole json obj and check if query can be pulled If it can, the items that it found will be returned

Parameters:

{JSONObject} - obj the json object that is pull from the video by ffprobe

Returns:

{ArrayList} returns what was found by the search

Throws:

org.json.JSONException

cleanLocation

public static java.util.List<java.lang.String> cleanLocation(java.lang.String local)

Clean location once it is found

Parameters:

{String} - local the GPS coordinates of where the video was created

createVideoClip

public static void createVideoClip(java.lang.String videoPath,
                                   java.lang.String start,
                                   java.lang.String duration,
                                   java.lang.String outputPath)
                            throws java.lang.InterruptedException

Creates a clip of video at given start and end times

Parameters:

: - String videoPath : absolute path to video file

: - String start : starting second of video clip

: - String duration : ending second of video clip

: - String outputPath : absolute path and name of output video

Throws:

java.lang.InterruptedException

runCommand

public static void runCommand(java.util.List<java.lang.String> command)
                       throws java.lang.InterruptedException

runs list of string commands on system command line

Parameters:

{List} - command

Throws:

java.lang.InterruptedException