summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Niedermayer <michael@niedermayer.cc>2016-01-23 00:35:46 +0100
committerMichael Niedermayer <michael@niedermayer.cc>2016-01-31 00:24:28 +0100
commite4b4f9e2dc30701386b32a33cc83c17dedeef041 (patch)
treea2f91a0218f0afbb446bc0d72005ef6b0aaeca00
parent3bb83fd0336908faee1799a1ee29d6c5a9980566 (diff)
downloadffmpeg-e4b4f9e2dc30701386b32a33cc83c17dedeef041.tar.gz
avformat: Document urls a bit
Spell-checked-by: Moritz Barsnick <barsnick@gmx.net> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc> (cherry picked from commit 3130556c0eb09f3da3c9de6473a97937a4648d62) Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
-rw-r--r--libavformat/avformat.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 1654f54953..dc4aaad6a3 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -78,6 +78,18 @@
* if its AVClass is non-NULL, and the protocols layer. See the discussion on
* nesting in @ref avoptions documentation to learn how to access those.
*
+ * @section urls
+ * URL strings in libavformat are made of a scheme/protocol, a ':', and a
+ * scheme specific string. URLs without a scheme and ':' used for local files
+ * are supported but deprecated. "file:" should be used for local files.
+ *
+ * It is important that the scheme string is not taken from untrusted
+ * sources without checks.
+ *
+ * Note that some schemes/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.
+ *
* @defgroup lavf_decoding Demuxing
* @{
* Demuxers read a media file and split it into chunks of data (@em packets). A