[FFmpeg-devel] [PATCH] avformat: Document urls a bit

[Moritz Barsnick]

On Sat, Jan 23, 2016 at 00:36:51 +0100, Michael Niedermayer wrote:
>  libavformat/avformat.h |    9 +++++++++
>  1 file changed, 9 insertions(+)

This will at least need some spelling fixes and commas. ;-)

> + * @section urls
> + * URLs in libavformat are made of a protocol a ':' and a protocol specific string
> + * urls without a protocol and ':' used for local files are supported but
> + * deprecated. "file:" should be used for local files.
> + * It is important that the protocol string is not taken from untrusted soucres
> + * without checks.
> + * some protocols are quite powerfull, allowing access to local and remote files,
> + * parts of them, concatenations of them, local audio and video devices and so on.

Such as:

  URL strings in libavformat are made of a protocol, a ':', and a protocol
  specific string. URLs without a protocol and ':' used for local files
  are supported but deprecated. "file:" should be used for local files.

  It is important that the protocol string is not taken from untrusted
  sources without checks.

  Note that some protocols are quite powerful, allowing access to both
  local and remote files, parts of them, concatenations of them, local
  audio and video devices and so on.


Moritz