mirror of
https://github.com/FFmpeg/FFmpeg.git
synced 2024-11-26 19:01:44 +02:00
doxygen: Add a number of missing function parameter descriptions
This commit is contained in:
parent
614b9e4db8
commit
4d7ab5cfeb
@ -4108,7 +4108,9 @@ void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
|
||||
/**
|
||||
* Put a string representing the codec tag codec_tag in buf.
|
||||
*
|
||||
* @param buf buffer to place codec tag in
|
||||
* @param buf_size size in bytes of buf
|
||||
* @param codec_tag codec tag to assign
|
||||
* @return the length of the string that would have been generated if
|
||||
* enough space had been available, excluding the trailing null
|
||||
*/
|
||||
|
@ -99,9 +99,11 @@ enum DCTTransformType {
|
||||
|
||||
/**
|
||||
* Set up DCT.
|
||||
*
|
||||
* @param nbits size of the input array:
|
||||
* (1 << nbits) for DCT-II, DCT-III and DST-I
|
||||
* (1 << nbits) + 1 for DCT-I
|
||||
* @param type the type of transform
|
||||
*
|
||||
* @note the first element of the input of DST-I is ignored
|
||||
*/
|
||||
|
@ -342,6 +342,7 @@ struct AVFormatContext;
|
||||
* Allocate and read the payload of a packet and initialize its
|
||||
* fields with default values.
|
||||
*
|
||||
* @param s associated IO context
|
||||
* @param pkt packet
|
||||
* @param size desired payload size
|
||||
* @return >0 (read size) if OK, AVERROR_xxx otherwise
|
||||
@ -357,6 +358,7 @@ int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
|
||||
* when there is no reasonable way to know (an upper bound of)
|
||||
* the final size.
|
||||
*
|
||||
* @param s associated IO context
|
||||
* @param pkt packet
|
||||
* @param size amount of data to read
|
||||
* @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
|
||||
@ -1269,6 +1271,7 @@ const AVClass *avformat_get_class(void);
|
||||
*
|
||||
* When muxing, should be called by the user before avformat_write_header().
|
||||
*
|
||||
* @param s media file handle
|
||||
* @param c If non-NULL, the AVCodecContext corresponding to the new stream
|
||||
* will be initialized to use this codec. This is needed for e.g. codec-specific
|
||||
* defaults to be set, so codec should be provided if it is known.
|
||||
@ -1297,6 +1300,7 @@ AVInputFormat *av_find_input_format(const char *short_name);
|
||||
/**
|
||||
* Guess the file format.
|
||||
*
|
||||
* @param pd data to be probed
|
||||
* @param is_opened Whether the file is already opened; determines whether
|
||||
* demuxers with or without AVFMT_NOFILE are probed.
|
||||
*/
|
||||
@ -1305,6 +1309,7 @@ AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
|
||||
/**
|
||||
* Guess the file format.
|
||||
*
|
||||
* @param pd data to be probed
|
||||
* @param is_opened Whether the file is already opened; determines whether
|
||||
* demuxers with or without AVFMT_NOFILE are probed.
|
||||
* @param score_max A probe score larger that this is required to accept a
|
||||
@ -1438,6 +1443,8 @@ int av_read_frame(AVFormatContext *s, AVPacket *pkt);
|
||||
/**
|
||||
* Seek to the keyframe at timestamp.
|
||||
* 'timestamp' in 'stream_index'.
|
||||
*
|
||||
* @param s media file handle
|
||||
* @param stream_index If stream_index is (-1), a default
|
||||
* stream is selected, and timestamp is automatically converted
|
||||
* from AV_TIME_BASE units to the stream specific time_base.
|
||||
@ -1464,6 +1471,7 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
|
||||
* If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
|
||||
* keyframes (this may not be supported by all demuxers).
|
||||
*
|
||||
* @param s media file handle
|
||||
* @param stream_index index of the stream which is used as time base reference
|
||||
* @param min_ts smallest acceptable timestamp
|
||||
* @param ts target timestamp
|
||||
@ -1700,6 +1708,7 @@ void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
|
||||
*
|
||||
* @param tags list of supported codec_id-codec_tag pairs, as stored
|
||||
* in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
|
||||
* @param tag codec tag to match to a codec ID
|
||||
*/
|
||||
enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
|
||||
|
||||
@ -1709,6 +1718,7 @@ enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned i
|
||||
*
|
||||
* @param tags list of supported codec_id-codec_tag pairs, as stored
|
||||
* in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
|
||||
* @param id codec ID to match to a codec tag
|
||||
*/
|
||||
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
|
||||
|
||||
@ -1716,6 +1726,9 @@ int av_find_default_stream_index(AVFormatContext *s);
|
||||
|
||||
/**
|
||||
* Get the index for a specific timestamp.
|
||||
*
|
||||
* @param st stream that the timestamp belongs to
|
||||
* @param timestamp timestamp to retrieve the index for
|
||||
* @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
|
||||
* to the timestamp which is <= the requested one, if backward
|
||||
* is 0, then it will be >=
|
||||
@ -1812,6 +1825,7 @@ int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
|
||||
* Return a positive value if the given filename has one of the given
|
||||
* extensions, 0 otherwise.
|
||||
*
|
||||
* @param filename file name to check against the given extensions
|
||||
* @param extensions a comma-separated list of filename extensions
|
||||
*/
|
||||
int av_match_ext(const char *filename, const char *extensions);
|
||||
@ -1819,6 +1833,8 @@ int av_match_ext(const char *filename, const char *extensions);
|
||||
/**
|
||||
* Test if the given container can store a codec.
|
||||
*
|
||||
* @param ofmt container to check for compatibility
|
||||
* @param codec_id codec to potentially store in container
|
||||
* @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
|
||||
*
|
||||
* @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
|
||||
|
@ -318,6 +318,7 @@ int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
|
||||
*
|
||||
* @param s Used to return the pointer to the created AVIOContext.
|
||||
* In case of failure the pointed to value is set to NULL.
|
||||
* @param url resource to access
|
||||
* @param flags flags which control how the resource indicated by url
|
||||
* is to be opened
|
||||
* @return 0 in case of success, a negative value corresponding to an
|
||||
@ -333,6 +334,7 @@ int avio_open(AVIOContext **s, const char *url, int flags);
|
||||
*
|
||||
* @param s Used to return the pointer to the created AVIOContext.
|
||||
* In case of failure the pointed to value is set to NULL.
|
||||
* @param url resource to access
|
||||
* @param flags flags which control how the resource indicated by url
|
||||
* is to be opened
|
||||
* @param int_cb an interrupt callback to be used at the protocols level
|
||||
@ -406,6 +408,8 @@ const char *avio_enum_protocols(void **opaque, int output);
|
||||
/**
|
||||
* Pause and resume playing - only meaningful if using a network streaming
|
||||
* protocol (e.g. MMS).
|
||||
*
|
||||
* @param h IO context from which to call the read_pause function pointer
|
||||
* @param pause 1 for pause, 0 for resume
|
||||
*/
|
||||
int avio_pause(AVIOContext *h, int pause);
|
||||
@ -413,6 +417,8 @@ int avio_pause(AVIOContext *h, int pause);
|
||||
/**
|
||||
* Seek to a given timestamp relative to some component stream.
|
||||
* Only meaningful if using a network streaming protocol (e.g. MMS.).
|
||||
*
|
||||
* @param h IO context from which to call the seek function pointers
|
||||
* @param stream_index The stream index that the timestamp is relative to.
|
||||
* If stream_index is (-1) the timestamp should be in AV_TIME_BASE
|
||||
* units from the beginning of the presentation.
|
||||
|
Loading…
Reference in New Issue
Block a user