class vmaf():
"""
Video class to manage VMAF computation of video streams. This class allows:
- Upscale or downscale the MAIN or REF videos automatically according to the Vmaf model (1080, 4K, etc)
- Deinterlace automatically the MAIN and REF videos if needed
- To SYNC (in time) the MAIN and REF videos using psnr computation
- Frame rate conversion (if needed)
"""
def __init__(self, mainSrc, refSrc,output_fmt, model = "HD", phone = False, loglevel = "info", subsample = 1 ):
self.loglevel = loglevel
self.main = video(mainSrc,self.loglevel)
self.ref = video(refSrc,self.loglevel)
self.model = model
self.phone = phone
self.subsample = subsample
self.ffmpegQos = FFmpegQos(self.main.videoSrc, self.ref.videoSrc, self.loglevel)
self.target_resolution = None
self.offset = 0
self._initResolutions()
self.output_fmt = output_fmt
def _initResolutions(self):
"""
initialization of resolutions for each vmaf model
"""
if self.model == 'HD' or self.model == 'HDneg':
self.target_resolution = [1920, 1080]
elif self.model == '4K':
self.target_resolution = [3840,2160]
else:
exit("[easyVmaf] ERROR: Invalid vmaf model")
def _autoScale(self):
"""
scaling MAIN and REF if they dont match with the resolution requiered by the vmaf model (target resolution)
"""
refResolution = [self.ref.streamInfo['width'], self.ref.streamInfo['height']]
mainResolution = [self.main.streamInfo['width'], self.main.streamInfo['height']]
if refResolution != self.target_resolution:
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setScaleFilter(self.target_resolution[0], self.target_resolution[1])
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setScaleFilter(self.target_resolution[0], self.target_resolution[1])
if mainResolution != self.target_resolution:
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setScaleFilter(self.target_resolution[0], self.target_resolution[1])
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setScaleFilter(self.target_resolution[0], self.target_resolution[1])
def _deinterlaceFrame(self, factor, stream):
ref_fps = getFrameRate(self.ref.streamInfo['r_frame_rate'])
main_fps = getFrameRate(self.main.streamInfo['r_frame_rate'])
stream.setDeintFrameFilter()
if round(ref_fps,2)!=round(factor*main_fps,2):
stream.setFpsFilter(round(main_fps,5))
def _deinterlaceField(self, factor, stream):
ref_fps = getFrameRate(self.ref.streamInfo['r_frame_rate'])
main_fps = getFrameRate(self.main.streamInfo['r_frame_rate'])
stream.setDeintFieldFilter()
if round(ref_fps,2)!=round(factor*main_fps,2):
stream.setFpsFilter(round(main_fps,5))
def _autoDeinterlace(self):
"""
This functions normalizes the framerate between MAIN and REF video streams (if needed)
"""
ref_fps = getFrameRate(self.ref.streamInfo['r_frame_rate'])
main_fps = getFrameRate(self.main.streamInfo['r_frame_rate'])
if self.ref.interlaced == self.main.interlaced :
""" Not Deinterlace would be required. So this functions normalizes the fps between REF and MAIN
"""
if round(ref_fps ) < round(main_fps):
"""
frame rate conversion over MAIN video. The lowest framerate is choosed (REF fps).
"""
print("[easyVmaf] Warning: Frame rate conversion can produce bad vmaf scores", flush=True)
self.ffmpegQos.main.setFpsFilter(round(ref_fps,5))
elif round(ref_fps ) > round(main_fps):
"""
frame rate conversion over REF video. The lowest framerate is choosed (MAIN fps).
"""
print("[easyVmaf] Warning: Frame rate conversion can produce bad vmaf scores", flush=True)
self.ffmpegQos.ref.setFpsFilter(round(main_fps,5))
else:
"""
This just pass the original framerate to the ffmpeg filter (lavfi) when no frame rate
conversion is requiered. For some reason it is mandatory by lavfi in order to work properly.
"""
self.ffmpegQos.main.setFpsFilter(round(main_fps,5))
self.ffmpegQos.ref.setFpsFilter(round(ref_fps,5))
elif self.ref.interlaced and not self.main.interlaced :
"""
REF interlaced | MAIN progressive
"""
if round(ref_fps ) == round(main_fps*2):
# Examples: REF=60i, MAIN=30p
# REF=59.97i, MAIN=30p, etc
if not self.ffmpegQos.invertedSrc: self._deinterlaceFrame(2, self.ffmpegQos.ref )
else: self._deinterlaceFrame(2, self.ffmpegQos.main )
elif round(ref_fps) == round(main_fps):
# Examples: REF=30i, MAIN=30p
# REF=29.97i, MAIN=30p, etc
if not self.ffmpegQos.invertedSrc: self._deinterlaceFrame(1, self.ffmpegQos.ref )
else: self._deinterlaceFrame(1, self.ffmpegQos.main )
elif round(ref_fps) == round(main_fps/2):
# Examples: REF=30i, MAIN=60p
# REF=29.97i, MAIN=60p, etc
if not self.ffmpegQos.invertedSrc: self._deinterlaceField(0.5, self.ffmpegQos.ref )
else: self._deinterlaceField(0.5, self.ffmpegQos.main )
else:
print("[easyVmaf] ERROR: No Filters available for the given Framerates", flush=True)
elif not self.ref.interlaced and self.main.interlaced:
"""
Input Progressive (REF) | Output Interlaced (MAIN)
"""
if round(ref_fps ) == round(main_fps*2):
# Examples: REF=60p, MAIN=30i
# REF=60p, MAIN=29.97i, etc
print("[easyVmaf] Warning: Frame rate conversion can produce bad vmaf scores", flush=True)
if not self.ffmpegQos.invertedSrc: self._deinterlaceField(1, self.ffmpegQos.main)
else: self._deinterlaceField(1, self.ffmpegQos.ref)
elif round(ref_fps ) == round(main_fps):
# Examples: REF=30p, MAIN=30i
# REF=30p, MAIN=29.97i, etc
if not self.ffmpegQos.invertedSrc: self._deinterlaceFrame(1, self.ffmpegQos.main)
else: self._deinterlaceFrame(1, self.ffmpegQos.ref)
else:
print("[easyVmaf] ERROR: No Filters available for the given Framerates", flush=True)
def syncOffset(self, syncWindow = 3, start=0, reverse = False):
"""
Method to get the offset needed to sync REF and MAIN (if any).
syncWindow --> Window Size in seconds to try to sync REF and MAIN videos. i.e., if the video to sync
last 600 seconds, the sync look up will be done just within a subsample of syncWindow size.
By default, the syncWindow is applied to REF.
start --> start time in seconds from the begining of the video where the syncWindow begin.
By default, the start time applies to REF.
reverse --> If this option is set to TRUE. It is considered that MAIN is delayed in comparition to REF: 'syncWindow' and 'start' variables will be
applied to MAIN.
By default, it is supposed that the REF video is delayed in comparition with the MAIN video.
It returns the offset value to get REF and MAIN synced and the PSNR computed.
"""
print("\n\n=======================================", flush=True)
print("Syncing... Computing PSNR values... ", flush=True)
print("=======================================", flush=True)
print("Distorted:" , self.main.videoSrc , "@" , round(getFrameRate(self.main.streamInfo['r_frame_rate']),5) , "fps","|" ,self.main.streamInfo['width'], self.main.streamInfo['height'] , flush=True)
print("Reference:" , self.ref.videoSrc , "@" , round(getFrameRate(self.ref.streamInfo['r_frame_rate']),5) , "fps","|" ,self.ref.streamInfo['width'], self.ref.streamInfo['height'], flush=True)
print("=======================================", flush=True)
print("offset(s)","\t\t","psnr[dB]", flush=True)
if reverse: self.ffmpegQos.invertSrcs()
fps = getFrameRate(self.ref.streamInfo['r_frame_rate'])
frameDuration = 1/fps
startFrame = int(round(start/frameDuration))
framesInSyncWindow = int(round(syncWindow/frameDuration))
psnr ={'value':[], 'time':[]}
for i in range(0,framesInSyncWindow ):
offset = (startFrame + i) * frameDuration
self.ffmpegQos.main.clearFilters()
self.ffmpegQos.ref.clearFilters()
self.ffmpegQos.ref.setTrimFilter(offset, 0.5 )
self.ffmpegQos.main.setTrimFilter(0, 0.5 )
self._autoScale()
self._autoDeinterlace()
psnr['value'].append(self.ffmpegQos.getPsnr())
psnr['time'].append(offset)
print (psnr['time'][i], "\t", psnr['value'][i], flush= True)
maxPsnr = max(psnr['value'])
index = psnr['value'].index(maxPsnr)
offset = psnr['time'][index]
"""
The reverse variable/flag indicates if the offset (for time syncing ) was applied over the MAIN or over the REF.
It is FALSE if it was applied over REF (default) and TRUE if it was applied over the MAIN.
If it is TRUE, it means that REF and MAIN where "interchanged" (REF -> MAIN, MAIN -> REF) to compute the PSNR for sync. Once the PSNR is
computed, it is requiered to come back to the original MAIN/REF.
"""
if reverse:
self.ffmpegQos.invertSrcs()
offset = -1 * offset
self.offset = offset
return [self.offset, maxPsnr]
def setOffset(self, value=None):
"""
Apply Offset to trim Filter.
If offset > 0: Ref delayed compared to Main. Trimfilter cuts Ref
if offset < 0: Main delayed compared to Ref. Trimfilter cuts Main
"""
if value != None:
""" overrides the value in self.offset"""
self.offset = value
if self.offset > 0:
offset = self.offset
duration = min(self.main.duration, self.ref.duration-offset)
self.ffmpegQos.ref.setTrimFilter(offset, duration )
self.ffmpegQos.main.setTrimFilter(0, duration )
elif self.offset < 0:
offset = abs(self.offset)
duration = min(self.main.duration - offset, self.ref.duration)
self.ffmpegQos.main.setTrimFilter(offset, duration )
self.ffmpegQos.ref.setTrimFilter(0, duration)
def getVmaf(self, output_file_path = None, autoSync = False):
""" enable controlling the output file path, needed when distorted video path is not writable """
self.output_file_path = output_file_path
""" clean all filters first """
self.ffmpegQos.clearFilters()
self.ffmpegQos.main.clearFilters()
self.ffmpegQos.ref.clearFilters()
"""AutoScale according to vmaf model and deinterlace the source if needed """
self._autoScale()
self._autoDeinterlace()
"""Lookup for sync between Main and reference. Default: dissable
It is suggested to run syncOffset manually before getVmaf()
"""
if autoSync: self.syncOffset()
"""Apply Offset filters, if offset =0 nothing happens """
self.setOffset()
print("\n\n=======================================", flush=True)
print("Computing VMAF... ", flush=True)
print("=======================================", flush=True)
print("Distorted:" , self.main.videoSrc , "@" , round(getFrameRate(self.main.streamInfo['r_frame_rate']),5) , "fps","|" ,self.main.streamInfo['width'], self.main.streamInfo['height'] , flush=True)
print("Reference:" , self.ref.videoSrc , "@" , round(getFrameRate(self.ref.streamInfo['r_frame_rate']),5) , "fps","|" ,self.ref.streamInfo['width'], self.ref.streamInfo['height'], flush=True)
print("Offset:", self.offset, flush=True)
print("Model:", self.model, flush=True)
print("Phone:", self.phone, flush=True)
print("loglevel:", self.loglevel, flush=True)
print("subsample:", self.subsample, flush=True)
print("output_fmt:", self.output_fmt, flush=True)
if (self.output_file_path):
print("output_file_path:", self.output_file_path, flush=True)
print("=======================================", flush=True)
self.ffmpegQos.getVmaf(model = self.model, phone = self.phone, subsample= self.subsample, output_fmt=self.output_fmt, log_path=self.output_file_path)
class vmaf():
"""
Video class to manage VMAF computation of video streams by using
by _FFmpeg.FFmpegQos. This class allows:
- To upscale or downscale the MAIN or REF videos automatically according to the Vmaf model
- Deinterlace automatically the MAIN and REF videos if needed
- To SYNC the MAIN and REF videos using psnr computation
- TO DO: frame rate conversion
"""
def __init__(self,
mainSrc,
refSrc,
model="HD",
phone=False,
loglevel="info",
subsample=1):
self.main = video(mainSrc)
self.ref = video(refSrc)
self.model = model
self.phone = phone
self.loglevel = loglevel
self.subsample = subsample
self.ffmpegQos = FFmpegQos(self.main.videoSrc, self.ref.videoSrc,
self.loglevel)
self.target_resolution = None
self.offset = 0
self._initResolutions()
def _initResolutions(self):
"""
initialization of resolutions of each model
"""
if self.model == 'HD':
self.target_resolution = [1920, 1080]
elif self.model == '4K':
self.target_resolution = [3840, 2160]
def _autoScale(self):
"""
scaling MAIN and REF if they doesnt match with the resolution requiered by the vmaf model
"""
refResolution = [
self.ref.streamInfo['width'], self.ref.streamInfo['height']
]
mainResolution = [
self.main.streamInfo['width'], self.main.streamInfo['height']
]
if refResolution != self.target_resolution:
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setScaleFilter(self.target_resolution[0],
self.target_resolution[1])
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setScaleFilter(self.target_resolution[0],
self.target_resolution[1])
if mainResolution != self.target_resolution:
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setScaleFilter(self.target_resolution[0],
self.target_resolution[1])
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setScaleFilter(self.target_resolution[0],
self.target_resolution[1])
def _autoDeinterlace(self):
"""
Deinterlace MAIN and REF if it is requiered
"""
if self.ref.interlaced and self.main.interlaced:
"""
Input interlaced | Output Interlaced
"""
pass
elif self.ref.interlaced and not self.main.interlaced:
"""
Input interlaced (REF) | Output progressive (MAIN)
"""
if round(getFrameRate(
self.ref.streamInfo['avg_frame_rate'])) == round(
getFrameRate(self.main.streamInfo['avg_frame_rate']) *
2):
"""
one Frame at output per two fields at input:
i. e., 60i-> 30p
=> Deinterlace input (60i to 60p) and upscale the fps at output (30p to 60p)
"""
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setDeintFrameFilter()
self.ffmpegQos.main.setFpsFilter(
round(
getFrameRate(
self.ref.streamInfo['avg_frame_rate']), 5))
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setDeintFrameFilter()
self.ffmpegQos.ref.setFpsFilter(
round(
getFrameRate(
self.ref.streamInfo['avg_frame_rate']), 5))
elif round(getFrameRate(
self.ref.streamInfo['avg_frame_rate'])) == round(
getFrameRate(self.main.streamInfo['avg_frame_rate'])):
"""
one Frame at output per one Frame at input:
i. e., 30i -> 30p
=> Deinterlace input (30i to 30p)
"""
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setDeintFrameFilter()
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setDeintFrameFilter()
elif round(getFrameRate(
self.ref.streamInfo['avg_frame_rate'])) == round(
getFrameRate(self.main.streamInfo['avg_frame_rate']) /
2):
"""
one Frame at output pero one Field at input:
i. e., 30i -> 60p
=> Deinterlace input (30i to 60p)
"""
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setDeintFieldFilter()
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setDeintFieldFilter()
else:
print(
"Unable to find the deinterlace filter, check fps of MAIN",
flush=True)
elif not self.ref.interlaced and self.main.interlaced:
"""
Input Progressive (REF) | Output Interlaced (MAIN)
"""
if round(getFrameRate(
self.ref.streamInfo['avg_frame_rate'])) == round(
getFrameRate(self.main.streamInfo['avg_frame_rate']) *
2):
"""
i,e,.: 60p -> 30i
=> Deinterlace output (30i to 60p)
"""
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setDeintFieldFilter()
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setDeintFieldFilter()
elif round(getFrameRate(
self.ref.streamInfo['avg_frame_rate'])) == round(
getFrameRate(self.main.streamInfo['avg_frame_rate'])):
"""
i,e,. 30p -> 30i
=> Deinterlace output (30i to 30p)
"""
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setDeintFrameFilter()
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setDeintFrameFilter()
elif round(
getFrameRate(self.ref.streamInfo['avg_frame_rate']) *
2) == round(
getFrameRate(self.main.streamInfo['avg_frame_rate'])):
"""
i,e,. 30p -> 60i
=> Deinterlace output (60i to 60p) and downscale the fps (60p to 30p)
"""
if not self.ffmpegQos.invertedSrc:
self.ffmpegQos.main.setDeintFrameFilter()
self.ffmpegQos.main.setFpsFilter(
round(
getFrameRate(
self.ref.streamInfo['avg_frame_rate']), 5))
if self.ffmpegQos.invertedSrc:
self.ffmpegQos.ref.setDeintFrameFilter()
self.ffmpegQos.ref.setFpsFilter(
round(
getFrameRate(
self.ref.streamInfo['avg_frame_rate']), 5))
elif not self.main.interlaced and not self.ref.interlaced:
""" Input Progressive Output Progresive
TO DO: Frame Conversion if main_fps != ref_fps
"""
pass
def syncOffset(self, syncWindow=3, start=0, reverse=False):
"""
Method to get the offset needed to sync REF and MAIN (if any).
syncWindow --> Window Size in seconds to try to sync REF and MAIN videos. i.e., if the video to sync
last 600 seconds, the sync look up will be done just within a subsample of syncWindow size.
By default, the syncWindow is applied to REF.
start --> start time in seconds from the begining of the video where the syncWindow begin.
By default, the start time applies to REF.
reverse --> If this option is set to TRUE. It is considered that MAIN is delayed in comparition to REF: 'syncWindow' and 'start' variables will be
applied to MAIN.
By default, it is supposed that the REF video is delayed in comparition with the MAIN video.
It returns the offset value to get REF and MAIN synced and the PSNR computed.
"""
print("\n\n=======================================", flush=True)
print("Syncing... Computing PSNR values... ", flush=True)
print("=======================================", flush=True)
print("Distorted:",
self.main.videoSrc,
"@",
round(getFrameRate(self.main.streamInfo['avg_frame_rate']), 5),
"fps",
"|",
self.main.streamInfo['width'],
self.main.streamInfo['height'],
flush=True)
print("Reference:",
self.ref.videoSrc,
"@",
round(getFrameRate(self.ref.streamInfo['avg_frame_rate']), 5),
"fps",
"|",
self.ref.streamInfo['width'],
self.ref.streamInfo['height'],
flush=True)
print("=======================================", flush=True)
print("offset(s)", "\t\t", "psnr[dB]", flush=True)
if reverse: self.ffmpegQos.invertSrcs()
fps = getFrameRate(self.ref.streamInfo['avg_frame_rate'])
frameDuration = 1 / fps
startFrame = int(round(start / frameDuration))
framesInSyncWindow = int(round(syncWindow / frameDuration))
psnr = {'value': [], 'time': []}
for i in range(0, framesInSyncWindow):
offset = (startFrame + i) * frameDuration
self.ffmpegQos.main.clearFilters()
self.ffmpegQos.ref.clearFilters()
self.ffmpegQos.ref.setTrimFilter(offset, 0.5)
self.ffmpegQos.main.setTrimFilter(0, 0.5)
self._autoScale()
self._autoDeinterlace()
psnr['value'].append(self.ffmpegQos.getPsnr())
psnr['time'].append(offset)
print(psnr['time'][i], "\t", psnr['value'][i], flush=True)
maxPsnr = max(psnr['value'])
index = psnr['value'].index(maxPsnr)
offset = psnr['time'][index]
if reverse:
self.ffmpegQos.invertSrcs()
offset = -1 * offset
self.offset = offset
return [self.offset, maxPsnr]
def setOffset(self, value=None):
"""
Apply Offset to trim Filter.
If offset > 0: Ref delayed compared to Main. Trimfilter cuts Ref
if offset < 0: Main delayed compared to Ref. Trimfilter cuts Main
"""
if value != None:
""" overrides the value in self.offset"""
self.offset = value
if self.offset > 0:
offset = self.offset
duration = min(self.main.duration, self.ref.duration - offset)
self.ffmpegQos.ref.setTrimFilter(offset, duration)
self.ffmpegQos.main.setTrimFilter(0, duration)
elif self.offset < 0:
offset = abs(self.offset)
duration = min(self.main.duration - offset, self.ref.duration)
self.ffmpegQos.main.setTrimFilter(offset, duration)
self.ffmpegQos.ref.setTrimFilter(0, duration)
def getVmaf(self, autoSync=False):
""" clean all filters first """
self.ffmpegQos.clearFilters()
self.ffmpegQos.main.clearFilters()
self.ffmpegQos.ref.clearFilters()
"""AutoScale according to vmaf model and deinterlace the source if needed """
self._autoScale()
self._autoDeinterlace()
"""Lookup for sync between Main and reference. Default: dissable
It is suggested to run syncOffset manually before getVmaf()
"""
if autoSync: self.syncOffset()
"""Apply Offset filters, if offset =0 nothing happens """
self.setOffset()
print("\n\n=======================================", flush=True)
print("Computing VMAF... ", flush=True)
print("=======================================", flush=True)
print("Distorted:",
self.main.videoSrc,
"@",
round(getFrameRate(self.main.streamInfo['avg_frame_rate']), 5),
"fps",
"|",
self.main.streamInfo['width'],
self.main.streamInfo['height'],
flush=True)
print("Reference:",
self.ref.videoSrc,
"@",
round(getFrameRate(self.ref.streamInfo['avg_frame_rate']), 5),
"fps",
"|",
self.ref.streamInfo['width'],
self.ref.streamInfo['height'],
flush=True)
print("Offset:", self.offset, flush=True)
print("Model:", self.model, flush=True)
print("Phone:", self.phone, flush=True)
print("loglevel:", self.loglevel, flush=True)
print("subsample:", self.subsample, flush=True)
print("=======================================", flush=True)
self.ffmpegQos.getVmaf(model=self.model,
phone=self.phone,
subsample=self.subsample)