diff mbox

[FFmpeg-devel] Documentation for sr filter

Message ID CAAeE=qr17wLB+tWOT_DqCqeSrfWr6A++aDus7R9yjxgwy78SpA@mail.gmail.com
State New
Headers show

Commit Message

Sergey Lavrushkin Aug. 11, 2018, 2:55 p.m. UTC
Sorry, I accidentally sent previous patch, here is updated version.
diff mbox


From 99afeefe4add5b932140388f48ec4111734aa593 Mon Sep 17 00:00:00 2001
From: Sergey Lavrushkin <dualfal@gmail.com>
Date: Fri, 3 Aug 2018 17:24:00 +0300
Subject: [PATCH 9/9] doc/filters.texi: Adds documentation for sr filter.

 doc/filters.texi | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

diff --git a/doc/filters.texi b/doc/filters.texi
index 0b0903e5a7..9995ca532b 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -15394,6 +15394,66 @@  option may cause flicker since the B-Frames have often larger QP. Default is
 @code{0} (not enabled).
 @end table
+@section sr
+Scale the input by applying one of the super-resolution methods based on
+convolutional neural networks.
+Training scripts as well as scripts for model generation are provided in
+the repository @url{https://github.com/HighVoltageRocknRoll/sr.git}.
+The filter accepts the following options:
+@table @option
+@item model
+Specify which super-resolution model to use. This option accepts the following values:
+@table @samp
+@item srcnn
+Super-Resolution Convolutional Neural Network model
+@item espcn
+Efficient Sub-Pixel Convolutional Neural Network model
+@end table
+Default value is @samp{srcnn}.
+@item dnn_backend
+Specify which DNN backend to use for model loading and execution. This option accepts
+the following values:
+@table @samp
+@item native
+Native implementation of DNN loading and execution.
+@item tensorflow
+TensorFlow backend @url{https://www.tensorflow.org/}. To enable this backend you
+need to install the TensorFlow for C library (see
+@url{https://www.tensorflow.org/install/install_c}) and configure FFmpeg with
+@end table
+Default value is @samp{native}.
+@item scale_factor
+Set scale factor for SRCNN model, for which custom model file was provided.
+Allowed values are @code{2}, @code{3} and @code{4}. Scale factor is necessary
+for SRCNN model, because it accepts input upscaled using bicubic upscaling with
+proper scale factor.
+Default value is @code{2}.
+@item model_filename
+Set path to model file specifying network architecture and its parameters.
+Note that different backends use different file formats. If path to model
+file is not specified, built-in models for 2x upscaling are used.
+@end table
 @section subtitles