[FFmpeg-devel] [PATCH 2/4] Document "crypto" protocol

Stefano Sabatini stefasab at gmail.com
Mon Jun 17 13:40:17 CEST 2013


On date Saturday 2013-06-15 23:03:39 +0300, Andrey Utkin encoded:
> ---
>  doc/protocols.texi | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
> 
> diff --git a/doc/protocols.texi b/doc/protocols.texi
> index 911e555..3bfb75a 100644
> --- a/doc/protocols.texi
> +++ b/doc/protocols.texi
> @@ -85,6 +85,28 @@ ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
>  Note that you may need to escape the character "|" which is special for
>  many shells.
>  
> + at section crypto
> +
> +AES-encrypted stream reading protocol.
> +

> +The accepted options are:
> + at table @option

> + at item key
> +AES decryption key, in hexadecimal representation of binary block

Set the AES ... binary block.

> +
> + at item iv
> +AES decryption initialization vector, in hexadecimal representation of binary block
> + at end table

Set the AES ...

> +Options are passed not as URL parameters.
> +In case of command line usage, they are passed as command line arguments.
> +In case of avio_open2() usage, they are passed as last parameter, AVDictionary **options.

This should probably be defined in a dedicated section, since applies
to all the protocols as far as I know.

The avio_open2() note is a bit confusing, I suggest:

In case of programmatic usage through @code{avio_open2()}, the options
should be specified with the @code{AVDictionary **options} parameter.

> +
> +Accepted URL formats:
> + at example
> +crypto:@var{URL}
> +crypto+ at var{URL}
> + at end example
> +

LGTM otherwise, thanks.


More information about the ffmpeg-devel mailing list