diff mbox

[FFmpeg-devel,1/2] doc/filters.texi: Adds documentation for sr filter.

Message ID 20180815163510.29123-1-dualfal@gmail.com
State New
Headers show

Commit Message

Sergey Lavrushkin Aug. 15, 2018, 4:35 p.m. UTC
Resending patch with documentation for sr filter.

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

Comments

Gyan Aug. 15, 2018, 4:59 p.m. UTC | #1
On 15-08-2018 10:05 PM, Sergey Lavrushkin wrote:
> Resending patch with documentation for sr filter.

LGTM. Will apply with some small changes.

I've merged the docs entry in the 2nd part, so remove it from there.

Thanks,
Gyan
Sergey Lavrushkin Aug. 15, 2018, 5:58 p.m. UTC | #2
2018-08-15 19:59 GMT+03:00 Gyan Doshi <gyandoshi@gmail.com>:

>
>
> On 15-08-2018 10:05 PM, Sergey Lavrushkin wrote:
>
>> Resending patch with documentation for sr filter.
>>
>
> LGTM. Will apply with some small changes.
>
> I've merged the docs entry in the 2nd part, so remove it from there.
>

This entry corresponds to changes made in the second patch.
Without these changes it is not true.
James Almer Aug. 15, 2018, 6:07 p.m. UTC | #3
On 8/15/2018 2:58 PM, Sergey Lavrushkin wrote:
> 2018-08-15 19:59 GMT+03:00 Gyan Doshi <gyandoshi@gmail.com>:
> 
>>
>>
>> On 15-08-2018 10:05 PM, Sergey Lavrushkin wrote:
>>
>>> Resending patch with documentation for sr filter.
>>>
>>
>> LGTM. Will apply with some small changes.
>>
>> I've merged the docs entry in the 2nd part, so remove it from there.
>>
> 
> This entry corresponds to changes made in the second patch.
> Without these changes it is not true.

Should have been the second patch in the set, in that case. If a change
is split into two patches, one for code and one for documentation, then
the former goes first.
Gyan should have paid more attention to it as well, to be fair.

It's not a problem, in any case. The second patch should be applied as
well sooner or later.
Gyan Aug. 15, 2018, 6:12 p.m. UTC | #4
On 15-08-2018 11:28 PM, Sergey Lavrushkin wrote:
> 2018-08-15 19:59 GMT+03:00 Gyan Doshi <gyandoshi@gmail.com>:
> 
>>
>> LGTM. Will apply with some small changes.
>>
>> I've merged the docs entry in the 2nd part, so remove it from there.
>>
> 
> This entry corresponds to changes made in the second patch.
> Without these changes it is not true.

Ok. So,

"TensorFlow backend can load files for both formats"

is currently inaccurate.

I think some devs are insistent on removing the tables, so it's a matter 
of a few days. I'll leave it in there.

Gyan
Gyan Aug. 15, 2018, 6:19 p.m. UTC | #5
On 15-08-2018 11:37 PM, James Almer wrote:

> Should have been the second patch in the set, in that case. If a change
> is split into two patches, one for code and one for documentation, then
> the former goes first.
> Gyan should have paid more attention to it as well, to be fair.

I assumed he made a mistake and decided to rewrite and included it in 
patch 2. Did not expect an accompanying patch to override changes 
proposed in another one from the same set.

Gyan
diff mbox

Patch

diff --git a/doc/filters.texi b/doc/filters.texi
index 267bd04a43..b2a74cb1ce 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -15403,6 +15403,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
+@url{https://arxiv.org/abs/1501.00092}.
+
+@item espcn
+Efficient Sub-Pixel Convolutional Neural Network model
+@url{https://arxiv.org/abs/1609.05158}.
+
+@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
+@code{--enable-libtensorflow}
+
+@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
+
 @anchor{subtitles}
 @section subtitles