summaryrefslogtreecommitdiff
path: root/doc/ffprobe.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-10-02 16:22:17 +0200
committerStefano Sabatini <stefasab@gmail.com>2013-11-22 16:51:56 +0100
commitcbba331aa02f29870581ff0b7ded7477b279ae2c (patch)
tree1116aed10d9fe8ca2b9122ba6c9603ac3200b46f /doc/ffprobe.texi
parent11cba3ba9df13dafe63698fb142a0641512cd528 (diff)
ffprobe: implement string validation setting
This should fix trac tickets #1163, #2502.
Diffstat (limited to 'doc/ffprobe.texi')
-rw-r--r--doc/ffprobe.texi33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index 777dbe7506..2e9bfee29a 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -337,6 +337,39 @@ A writer may accept one or more arguments, which specify the options
to adopt. The options are specified as a list of @var{key}=@var{value}
pairs, separated by ":".
+All writers support the following options:
+
+@table @option
+@item string_validation, sv
+Set string validation mode.
+
+The following values are accepted.
+@table @samp
+@item fail
+The writer will fail immediately in case an invalid string (UTF-8)
+sequence or code point is found in the input. This is especially
+useful to validate input metadata.
+
+@item ignore
+Any validation error will be ignored. This will result in possibly
+broken output, especially with the json or xml writer.
+
+@item replace
+The writer will substitute invalid UTF-8 sequences or code points with
+the string specified with the @option{string_validation_replacement}.
+@end table
+
+Default value is @samp{replace}.
+
+@item string_validation_replacement, svr
+Set replacement string to use in case @option{string_validation} is
+set to @samp{replace}.
+
+In case the option is not specified, the writer will assume the empty
+string, that is it will remove the invalid sequences from the input
+strings.
+@end table
+
A description of the currently available writers follows.
@section default