* [FFmpeg-devel] [PATCH v3 01/54] avcodec: Fix Doxygen trailing brief comments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 02/54] avdevice/avdevice: Fix mismatching argument name Marvin Scholz
` (53 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
The //< comment is not any magic comment supported by Doxygen,
instead use ///< to mark them as doc for the members.
---
libavcodec/avcodec.h | 8 ++++----
libavcodec/codec_par.h | 8 ++++----
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 7db5d1b1c5..9f79e61dc9 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -2804,10 +2804,10 @@ int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
*/
enum AVPictureStructure {
- AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
- AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
- AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
- AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
+ AV_PICTURE_STRUCTURE_UNKNOWN, ///< unknown
+ AV_PICTURE_STRUCTURE_TOP_FIELD, ///< coded as top field
+ AV_PICTURE_STRUCTURE_BOTTOM_FIELD, ///< coded as bottom field
+ AV_PICTURE_STRUCTURE_FRAME, ///< coded as frame
};
typedef struct AVCodecParserContext {
diff --git a/libavcodec/codec_par.h b/libavcodec/codec_par.h
index 7660791a12..fa132814b1 100644
--- a/libavcodec/codec_par.h
+++ b/libavcodec/codec_par.h
@@ -37,10 +37,10 @@
enum AVFieldOrder {
AV_FIELD_UNKNOWN,
AV_FIELD_PROGRESSIVE,
- AV_FIELD_TT, //< Top coded_first, top displayed first
- AV_FIELD_BB, //< Bottom coded first, bottom displayed first
- AV_FIELD_TB, //< Top coded first, bottom displayed first
- AV_FIELD_BT, //< Bottom coded first, top displayed first
+ AV_FIELD_TT, ///< Top coded_first, top displayed first
+ AV_FIELD_BB, ///< Bottom coded first, bottom displayed first
+ AV_FIELD_TB, ///< Top coded first, bottom displayed first
+ AV_FIELD_BT, ///< Bottom coded first, top displayed first
};
/**
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 02/54] avdevice/avdevice: Fix mismatching argument name
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 01/54] avcodec: Fix Doxygen trailing brief comments Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 03/54] avformat/avformat: Fix mismatching argument names Marvin Scholz
` (52 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavdevice/avdevice.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libavdevice/avdevice.h b/libavdevice/avdevice.h
index 0b32e59fed..185593053f 100644
--- a/libavdevice/avdevice.h
+++ b/libavdevice/avdevice.h
@@ -494,7 +494,7 @@ int avdevice_list_devices(struct AVFormatContext *s, AVDeviceInfoList **device_l
/**
* Convenient function to free result of avdevice_list_devices().
*
- * @param devices device list to be freed.
+ * @param device_list device list to be freed.
*/
void avdevice_free_list_devices(AVDeviceInfoList **device_list);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 03/54] avformat/avformat: Fix mismatching argument names
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 01/54] avcodec: Fix Doxygen trailing brief comments Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 02/54] avdevice/avdevice: Fix mismatching argument name Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 04/54] avutil: " Marvin Scholz
` (51 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavformat/avformat.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 9d46875cce..c695cfc6de 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -2003,7 +2003,7 @@ AVProgram *av_new_program(AVFormatContext *s, int id);
* avformat_free_context() can be used to free the context and
* everything allocated by the framework within it.
*
- * @param *ctx is set to the created format context, or to NULL in
+ * @param ctx pointee is set to the created format context, or to NULL in
* case of failure
* @param oformat format to use for allocating the context, if NULL
* format_name and filename are used instead
@@ -2656,7 +2656,7 @@ const AVIndexEntry *avformat_index_get_entry(AVStream *st, int idx);
* Get the AVIndexEntry corresponding to the given timestamp.
*
* @param st Stream containing the requested AVIndexEntry.
- * @param timestamp Timestamp to retrieve the index entry for.
+ * @param wanted_timestamp Timestamp to retrieve the index entry for.
* @param flags If AVSEEK_FLAG_BACKWARD then the returned entry will correspond
* to the timestamp which is <= the requested one, if backward
* is 0, then it will be >=
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 04/54] avutil: Fix mismatching argument names
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (2 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 03/54] avformat/avformat: Fix mismatching argument names Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 05/54] swresample/swresample: " Marvin Scholz
` (50 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/hwcontext.h | 2 +-
libavutil/mathematics.h | 6 ++++--
libavutil/mem.h | 3 ++-
libavutil/rational.h | 3 ++-
4 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/libavutil/hwcontext.h b/libavutil/hwcontext.h
index c18b7e1e8b..efca17585e 100644
--- a/libavutil/hwcontext.h
+++ b/libavutil/hwcontext.h
@@ -249,7 +249,7 @@ const char *av_hwdevice_get_type_name(enum AVHWDeviceType type);
/**
* Iterate over supported device types.
*
- * @param type AV_HWDEVICE_TYPE_NONE initially, then the previous type
+ * @param prev AV_HWDEVICE_TYPE_NONE initially, then the previous type
* returned by this function in subsequent iterations.
* @return The next usable device type from enum AVHWDeviceType, or
* AV_HWDEVICE_TYPE_NONE if there are no more.
diff --git a/libavutil/mathematics.h b/libavutil/mathematics.h
index 64d4137a60..e4aff1e973 100644
--- a/libavutil/mathematics.h
+++ b/libavutil/mathematics.h
@@ -111,7 +111,8 @@ enum AVRounding {
/**
* Compute the greatest common divisor of two integer operands.
*
- * @param a,b Operands
+ * @param a Operand
+ * @param b Operand
* @return GCD of a and b up to sign; if a >= 0 and b >= 0, return value is >= 0;
* if a == 0 and b == 0, returns 0.
*/
@@ -186,7 +187,8 @@ int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);
* av_compare_mod(0x11, 0x02, 0x20) > 0 // since 0x11 % 0x20 (0x11) > 0x02 % 0x20 (0x02)
* @endcode
*
- * @param a,b Operands
+ * @param a Operand
+ * @param b Operand
* @param mod Divisor; must be a power of 2
* @return
* - a negative value if `a % mod < b % mod`
diff --git a/libavutil/mem.h b/libavutil/mem.h
index d91174196c..c9c4fcf1ff 100644
--- a/libavutil/mem.h
+++ b/libavutil/mem.h
@@ -667,7 +667,8 @@ void *av_dynarray2_add(void **tab_ptr, int *nb_ptr, size_t elem_size,
/**
* Multiply two `size_t` values checking for overflow.
*
- * @param[in] a,b Operands of multiplication
+ * @param[in] a Operand of multiplication
+ * @param[in] b Operand of multiplication
* @param[out] r Pointer to the result of the operation
* @return 0 on success, AVERROR(EINVAL) on overflow
*/
diff --git a/libavutil/rational.h b/libavutil/rational.h
index cbb08a0baf..8cbfc8e066 100644
--- a/libavutil/rational.h
+++ b/libavutil/rational.h
@@ -179,7 +179,8 @@ AVRational av_d2q(double d, int max) av_const;
* Find which of the two rationals is closer to another rational.
*
* @param q Rational to be compared against
- * @param q1,q2 Rationals to be tested
+ * @param q1 Rational to be tested
+ * @param q2 Rational to be tested
* @return One of the following values:
* - 1 if `q1` is nearer to `q` than `q2`
* - -1 if `q2` is nearer to `q` than `q1`
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 05/54] swresample/swresample: Fix mismatching argument names
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (3 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 04/54] avutil: " Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 06/54] avformat/avformat: Improve doxy style Marvin Scholz
` (49 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libswresample/swresample.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index 980be65783..4c26468c63 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -354,8 +354,8 @@ int swr_convert(struct SwrContext *s, uint8_t **out, int out_count,
* in this case the output timestamps will match output sample numbers.
* See ffmpeg-resampler(1) for the two modes of compensation.
*
- * @param s[in] initialized Swr context
- * @param pts[in] timestamp for the next input sample, INT64_MIN if unknown
+ * @param[in] s initialized Swr context
+ * @param[in] pts timestamp for the next input sample, INT64_MIN if unknown
* @see swr_set_compensation(), swr_drop_output(), and swr_inject_silence() are
* function used internally for timestamp compensation.
* @return the output timestamp for the next output sample
@@ -636,8 +636,8 @@ int swr_convert_frame(SwrContext *swr,
* @see swr_close();
*
* @param swr audio resample context
- * @param output output AVFrame
- * @param input input AVFrame
+ * @param out output AVFrame
+ * @param in input AVFrame
* @return 0 on success, AVERROR on failure.
*/
int swr_config_frame(SwrContext *swr, const AVFrame *out, const AVFrame *in);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 06/54] avformat/avformat: Improve doxy style
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (4 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 05/54] swresample/swresample: " Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 07/54] avcodec/avcodec: Escape Doxygen reference Marvin Scholz
` (48 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Mostly re-indenting and adding some missing references.
---
libavformat/avformat.h | 180 +++++++++++++++++++++++------------------
1 file changed, 103 insertions(+), 77 deletions(-)
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index c695cfc6de..1d97d56ac5 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -1898,8 +1898,8 @@ const AVOutputFormat *av_muxer_iterate(void **opaque);
/**
* Iterate over all registered demuxers.
*
- * @param opaque a pointer where libavformat will store the iteration state. Must
- * point to NULL to start the iteration.
+ * @param opaque a pointer where libavformat will store the iteration state.
+ * Must point to NULL to start the iteration.
*
* @return the next registered demuxer or NULL when the iteration is
* finished
@@ -1957,12 +1957,13 @@ AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c);
/**
* Wrap an existing array as stream side data.
*
- * @param st stream
+ * @param st stream
* @param type side information type
* @param data the side data array. It must be allocated with the av_malloc()
* family of functions. The ownership of the data is transferred to
* st.
* @param size side information size
+ *
* @return zero on success, a negative AVERROR code on failure. On failure,
* the stream is unchanged and the data remains owned by the caller.
*/
@@ -1973,8 +1974,9 @@ int av_stream_add_side_data(AVStream *st, enum AVPacketSideDataType type,
* Allocate new information from stream.
*
* @param stream stream
- * @param type desired side information type
- * @param size side information size
+ * @param type desired side information type
+ * @param size side information size
+ *
* @return pointer to fresh allocated data or NULL otherwise
*/
uint8_t *av_stream_new_side_data(AVStream *stream,
@@ -1983,9 +1985,10 @@ uint8_t *av_stream_new_side_data(AVStream *stream,
* Get side information from stream.
*
* @param stream stream
- * @param type desired side information type
- * @param size If supplied, *size will be set to the size of the side data
- * or to zero if the desired side data is not present.
+ * @param type desired side information type
+ * @param size If supplied, *size will be set to the size of the side data
+ * or to zero if the desired side data is not present.
+ *
* @return pointer to data if present or NULL otherwise
*/
uint8_t *av_stream_get_side_data(const AVStream *stream,
@@ -2003,16 +2006,17 @@ AVProgram *av_new_program(AVFormatContext *s, int id);
* avformat_free_context() can be used to free the context and
* everything allocated by the framework within it.
*
- * @param ctx pointee is set to the created format context, or to NULL in
- * case of failure
- * @param oformat format to use for allocating the context, if NULL
- * format_name and filename are used instead
- * @param format_name the name of output format to use for allocating the
- * context, if NULL filename is used instead
- * @param filename the name of the filename to use for allocating the
- * context, may be NULL
- * @return >= 0 in case of success, a negative AVERROR code in case of
- * failure
+ * @param ctx pointee is set to the created format context,
+ * or to NULL in case of failure
+ * @param oformat format to use for allocating the context, if NULL
+ * format_name and filename are used instead
+ * @param format_name the name of output format to use for allocating the
+ * context, if NULL filename is used instead
+ * @param filename the name of the filename to use for allocating the
+ * context, may be NULL
+ *
+ * @return >= 0 in case of success, a negative AVERROR code in case of
+ * failure
*/
int avformat_alloc_output_context2(AVFormatContext **ctx, const AVOutputFormat *oformat,
const char *format_name, const char *filename);
@@ -2067,15 +2071,16 @@ const AVInputFormat *av_probe_input_format3(const AVProbeData *pd,
* attempt is made. When the maximum probe size is reached, the input format
* with the highest score is returned.
*
- * @param pb the bytestream to probe
- * @param fmt the input format is put here
- * @param url the url of the stream
- * @param logctx the log context
- * @param offset the offset within the bytestream to probe from
+ * @param pb the bytestream to probe
+ * @param fmt the input format is put here
+ * @param url the url of the stream
+ * @param logctx the log context
+ * @param offset the offset within the bytestream to probe from
* @param max_probe_size the maximum probe buffer size (zero for default)
+ *
* @return the score in case of success, a negative value corresponding to an
* the maximal score is AVPROBE_SCORE_MAX
- * AVERROR code otherwise
+ * AVERROR code otherwise
*/
int av_probe_input_buffer2(AVIOContext *pb, const AVInputFormat **fmt,
const char *url, void *logctx,
@@ -2092,16 +2097,19 @@ int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt,
* Open an input stream and read the header. The codecs are not opened.
* The stream must be closed with avformat_close_input().
*
- * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
- * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
- * function and written into ps.
- * Note that a user-supplied AVFormatContext will be freed on failure.
- * @param url URL of the stream to open.
- * @param fmt If non-NULL, this parameter forces a specific input format.
- * Otherwise the format is autodetected.
- * @param options A dictionary filled with AVFormatContext and demuxer-private options.
- * On return this parameter will be destroyed and replaced with a dict containing
- * options that were not found. May be NULL.
+ * @param ps Pointer to user-supplied AVFormatContext (allocated by
+ * avformat_alloc_context). May be a pointer to NULL, in
+ * which case an AVFormatContext is allocated by this
+ * function and written into ps.
+ * Note that a user-supplied AVFormatContext will be freed
+ * on failure.
+ * @param url URL of the stream to open.
+ * @param fmt If non-NULL, this parameter forces a specific input format.
+ * Otherwise the format is autodetected.
+ * @param options A dictionary filled with AVFormatContext and demuxer-private
+ * options.
+ * On return this parameter will be destroyed and replaced with
+ * a dict containing options that were not found. May be NULL.
*
* @return 0 on success, a negative AVERROR on failure.
*
@@ -2140,6 +2148,7 @@ int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
* @param last the last found program, the search will start after this
* program, or from the beginning if it is NULL
* @param s stream index
+ *
* @return the next program which belongs to s, NULL if no program is found or
* the last program is not among the programs of ic.
*/
@@ -2164,10 +2173,12 @@ void av_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int i
* @param decoder_ret if non-NULL, returns the decoder for the
* selected stream
* @param flags flags; none are currently defined
+ *
* @return the non-negative stream number in case of success,
* AVERROR_STREAM_NOT_FOUND if no stream with the requested type
* could be found,
* AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
+ *
* @note If av_find_best_stream returns successfully and decoder_ret is not
* NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
*/
@@ -2211,13 +2222,14 @@ 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.
- * @param timestamp Timestamp in AVStream.time_base units
- * or, if no stream is specified, in AV_TIME_BASE units.
- * @param flags flags which select direction and seeking mode
+ * @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.
+ * @param timestamp Timestamp in AVStream.time_base units or, if no stream
+ * is specified, in AV_TIME_BASE units.
+ * @param flags flags which select direction and seeking mode
+ *
* @return >= 0 on success
*/
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
@@ -2239,12 +2251,12 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
* keyframes (this may not be supported by all demuxers).
* If flags contain AVSEEK_FLAG_BACKWARD, it is ignored.
*
- * @param s media file handle
+ * @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
- * @param max_ts largest acceptable timestamp
- * @param flags flags
+ * @param min_ts smallest acceptable timestamp
+ * @param ts target timestamp
+ * @param max_ts largest acceptable timestamp
+ * @param flags flags
* @return >=0 on success, error code otherwise
*
* @note This is part of the new seek API which is still under construction.
@@ -2308,16 +2320,22 @@ void avformat_close_input(AVFormatContext **s);
* Allocate the stream private data and write the stream header to
* an output media file.
*
- * @param s Media file handle, must be allocated with avformat_alloc_context().
- * Its oformat field must be set to the desired output format;
- * Its pb field must be set to an already opened AVIOContext.
- * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
- * On return this parameter will be destroyed and replaced with a dict containing
- * options that were not found. May be NULL.
- *
- * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec had not already been fully initialized in avformat_init,
- * AVSTREAM_INIT_IN_INIT_OUTPUT on success if the codec had already been fully initialized in avformat_init,
- * negative AVERROR on failure.
+ * @param s Media file handle, must be allocated with
+ * avformat_alloc_context().
+ * Its \ref AVFormatContext.oformat "oformat" field must be set
+ * to the desired output format;
+ * Its \ref AVFormatContext.pb "pb" field must be set to an
+ * already opened ::AVIOContext.
+ * @param options An ::AVDictionary filled with AVFormatContext and
+ * muxer-private options.
+ * On return this parameter will be destroyed and replaced with
+ * a dict containing options that were not found. May be NULL.
+ *
+ * @retval AVSTREAM_INIT_IN_WRITE_HEADER On success, if the codec had not already been
+ * fully initialized in avformat_init_output().
+ * @retval AVSTREAM_INIT_IN_INIT_OUTPUT On success, if the codec had already been fully
+ * initialized in avformat_init_output().
+ * @retval AVERROR A negative AVERROR on failure.
*
* @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_init_output.
*/
@@ -2326,20 +2344,26 @@ int avformat_write_header(AVFormatContext *s, AVDictionary **options);
/**
* Allocate the stream private data and initialize the codec, but do not write the header.
- * May optionally be used before avformat_write_header to initialize stream parameters
+ * May optionally be used before avformat_write_header() to initialize stream parameters
* before actually writing the header.
- * If using this function, do not pass the same options to avformat_write_header.
- *
- * @param s Media file handle, must be allocated with avformat_alloc_context().
- * Its oformat field must be set to the desired output format;
- * Its pb field must be set to an already opened AVIOContext.
- * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
- * On return this parameter will be destroyed and replaced with a dict containing
- * options that were not found. May be NULL.
- *
- * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec requires avformat_write_header to fully initialize,
- * AVSTREAM_INIT_IN_INIT_OUTPUT on success if the codec has been fully initialized,
- * negative AVERROR on failure.
+ * If using this function, do not pass the same options to avformat_write_header().
+ *
+ * @param s Media file handle, must be allocated with
+ * avformat_alloc_context().
+ * Its \ref AVFormatContext.oformat "oformat" field must be set
+ * to the desired output format;
+ * Its \ref AVFormatContext.pb "pb" field must be set to an
+ * already opened ::AVIOContext.
+ * @param options An ::AVDictionary filled with AVFormatContext and
+ * muxer-private options.
+ * On return this parameter will be destroyed and replaced with
+ * a dict containing options that were not found. May be NULL.
+ *
+ * @retval AVSTREAM_INIT_IN_WRITE_HEADER On success, if the codec requires
+ * avformat_write_header to fully initialize.
+ * @retval AVSTREAM_INIT_IN_INIT_OUTPUT On success, if the codec has been fully
+ * initialized.
+ * @retval AVERROR Anegative AVERROR on failure.
*
* @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_write_header.
*/
@@ -2484,11 +2508,11 @@ int av_write_trailer(AVFormatContext *s);
* there is no match.
*
* @param short_name if non-NULL checks if short_name matches with the
- * names of the registered formats
- * @param filename if non-NULL checks if filename terminates with the
- * extensions of the registered formats
- * @param mime_type if non-NULL checks if mime_type matches with the
- * MIME type of the registered formats
+ * names of the registered formats
+ * @param filename if non-NULL checks if filename terminates with the
+ * extensions of the registered formats
+ * @param mime_type if non-NULL checks if mime_type matches with the
+ * MIME type of the registered formats
*/
const AVOutputFormat *av_guess_format(const char *short_name,
const char *filename,
@@ -2512,9 +2536,11 @@ enum AVCodecID av_guess_codec(const AVOutputFormat *fmt, const char *short_name,
* time_base units
* @param[out] wall absolute time when that packet whas output,
* in microsecond
- * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it
- * Note: some formats or devices may not allow to measure dts and wall
- * atomically.
+ * @retval 0 Success
+ * @retval AVERROR(ENOSYS) The format does not support it
+ *
+ * @note Some formats or devices may not allow to measure dts and wall
+ * atomically.
*/
int av_get_output_timestamp(struct AVFormatContext *s, int stream,
int64_t *dts, int64_t *wall);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 07/54] avcodec/avcodec: Escape Doxygen reference
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (5 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 06/54] avformat/avformat: Improve doxy style Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 08/54] avutil/channel_layout: Remove bogus closing group Marvin Scholz
` (47 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
The # is interpreted as explicit reference request by Doxygen
which is not desired here, use markdown inline code to avoid
that.
---
libavcodec/avcodec.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 9f79e61dc9..fb60331a31 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1518,7 +1518,7 @@ typedef struct AVCodecContext {
* libavcodec will behave as if this field was always set to 1.
* Callers that want to be forward compatible with future libavcodec
* versions should wrap access to this field in
- * #if LIBAVCODEC_VERSION_MAJOR < 60
+ * `#if LIBAVCODEC_VERSION_MAJOR < 60`
*/
attribute_deprecated
int thread_safe_callbacks;
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 08/54] avutil/channel_layout: Remove bogus closing group
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (6 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 07/54] avcodec/avcodec: Escape Doxygen reference Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 09/54] avutil/channel_layout: Move to its own group Marvin Scholz
` (46 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/channel_layout.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 9e685fab72..74fe3a8328 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -745,7 +745,6 @@ int av_channel_layout_check(const AVChannelLayout *channel_layout);
int av_channel_layout_compare(const AVChannelLayout *chl, const AVChannelLayout *chl1);
/**
- * @}
* @}
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 09/54] avutil/channel_layout: Move to its own group
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (7 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 08/54] avutil/channel_layout: Remove bogus closing group Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 10/54] avutil/channel_layout: Group deprecated functions Marvin Scholz
` (45 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Before it was cluttering the general avutil Audio group page.
---
libavutil/channel_layout.h | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 74fe3a8328..070c98072b 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -30,11 +30,17 @@
/**
* @file
- * audio channel layout utility functions
+ * @ingroup lavu_audio_channels
+ * Public libavutil channel layout APIs header.
*/
+
/**
- * @addtogroup lavu_audio
+ * @defgroup lavu_audio_channels Audio channels
+ * @ingroup lavu_audio
+ *
+ * Audio channel layout utility functions
+ *
* @{
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 10/54] avutil/channel_layout: Group deprecated functions
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (8 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 09/54] avutil/channel_layout: Move to its own group Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-10-16 13:11 ` Anton Khirnov
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 11/54] avutil/channel_layout: Group pre-defined channel layouts Marvin Scholz
` (44 subsequent siblings)
54 siblings, 1 reply; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Makes it a bit easier to spot the deprecated ones when
looking at the overview.
---
libavutil/channel_layout.h | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 070c98072b..52af52390c 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -394,6 +394,11 @@ typedef struct AVChannelLayout {
struct AVBPrint;
#if FF_API_OLD_CHANNEL_LAYOUT
+/**
+ * @name Depreacted Functins
+ * @{
+ */
+
/**
* Return a channel layout id that matches name, or 0 if no match is found.
*
@@ -520,6 +525,9 @@ const char *av_get_channel_description(uint64_t channel);
attribute_deprecated
int av_get_standard_channel_layout(unsigned index, uint64_t *layout,
const char **name);
+/**
+ * @}
+ */
#endif
/**
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* Re: [FFmpeg-devel] [PATCH v3 10/54] avutil/channel_layout: Group deprecated functions
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 10/54] avutil/channel_layout: Group deprecated functions Marvin Scholz
@ 2022-10-16 13:11 ` Anton Khirnov
0 siblings, 0 replies; 69+ messages in thread
From: Anton Khirnov @ 2022-10-16 13:11 UTC (permalink / raw)
To: FFmpeg development discussions and patches; +Cc: Marvin Scholz
Quoting Marvin Scholz (2022-09-25 02:10:37)
> Makes it a bit easier to spot the deprecated ones when
> looking at the overview.
> ---
> libavutil/channel_layout.h | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
> index 070c98072b..52af52390c 100644
> --- a/libavutil/channel_layout.h
> +++ b/libavutil/channel_layout.h
> @@ -394,6 +394,11 @@ typedef struct AVChannelLayout {
> struct AVBPrint;
>
> #if FF_API_OLD_CHANNEL_LAYOUT
> +/**
> + * @name Depreacted Functins
tpyoes
will fix myself on pushing
--
Anton Khirnov
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread
* [FFmpeg-devel] [PATCH v3 11/54] avutil/channel_layout: Group pre-defined channel layouts
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (9 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 10/54] avutil/channel_layout: Group deprecated functions Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 12/54] avutil/twofish: Fix doxy @param typo Marvin Scholz
` (43 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/channel_layout.h | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 52af52390c..6415355662 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -359,6 +359,10 @@ typedef struct AVChannelLayout {
#define AV_CHANNEL_LAYOUT_MASK(nb, m) \
{ .order = AV_CHANNEL_ORDER_NATIVE, .nb_channels = (nb), .u = { .mask = (m) }}
+/**
+ * @name Common pre-defined channel layouts
+ * @{
+ */
#define AV_CHANNEL_LAYOUT_MONO AV_CHANNEL_LAYOUT_MASK(1, AV_CH_LAYOUT_MONO)
#define AV_CHANNEL_LAYOUT_STEREO AV_CHANNEL_LAYOUT_MASK(2, AV_CH_LAYOUT_STEREO)
#define AV_CHANNEL_LAYOUT_2POINT1 AV_CHANNEL_LAYOUT_MASK(3, AV_CH_LAYOUT_2POINT1)
@@ -390,6 +394,7 @@ typedef struct AVChannelLayout {
#define AV_CHANNEL_LAYOUT_22POINT2 AV_CHANNEL_LAYOUT_MASK(24, AV_CH_LAYOUT_22POINT2)
#define AV_CHANNEL_LAYOUT_AMBISONIC_FIRST_ORDER \
{ .order = AV_CHANNEL_ORDER_AMBISONIC, .nb_channels = 4, .u = { .mask = 0 }}
+/** @} */
struct AVBPrint;
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 12/54] avutil/twofish: Fix doxy @param typo
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (10 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 11/54] avutil/channel_layout: Group pre-defined channel layouts Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 13/54] avcodec/vdpau: Fix doxy comment typo Marvin Scholz
` (42 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/twofish.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libavutil/twofish.h b/libavutil/twofish.h
index 813cfecdf8..67f359e88c 100644
--- a/libavutil/twofish.h
+++ b/libavutil/twofish.h
@@ -59,7 +59,7 @@ int av_twofish_init(struct AVTWOFISH *ctx, const uint8_t *key, int key_bits);
* @param dst destination array, can be equal to src
* @param src source array, can be equal to dst
* @param count number of 16 byte blocks
- * @paran iv initialization vector for CBC mode, NULL for ECB mode
+ * @param iv initialization vector for CBC mode, NULL for ECB mode
* @param decrypt 0 for encryption, 1 for decryption
*/
void av_twofish_crypt(struct AVTWOFISH *ctx, uint8_t *dst, const uint8_t *src, int count, uint8_t* iv, int decrypt);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 13/54] avcodec/vdpau: Fix doxy comment typo
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (11 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 12/54] avutil/twofish: Fix doxy @param typo Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 14/54] avcodec/codec_par: Add missing doxy group opening Marvin Scholz
` (41 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
This is clearly supposed to be a doxy comment and needed to properly
close the group.
---
libavcodec/vdpau.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libavcodec/vdpau.h b/libavcodec/vdpau.h
index 3010094d93..35c4b1096b 100644
--- a/libavcodec/vdpau.h
+++ b/libavcodec/vdpau.h
@@ -152,6 +152,6 @@ int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type,
*/
AVVDPAUContext *av_vdpau_alloc_context(void);
-/* @}*/
+/** @} */
#endif /* AVCODEC_VDPAU_H */
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 14/54] avcodec/codec_par: Add missing doxy group opening
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (12 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 13/54] avcodec/vdpau: Fix doxy comment typo Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 15/54] avcodec/videotoolbox: Add proper doxy group Marvin Scholz
` (40 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavcodec/codec_par.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavcodec/codec_par.h b/libavcodec/codec_par.h
index fa132814b1..f51d27c590 100644
--- a/libavcodec/codec_par.h
+++ b/libavcodec/codec_par.h
@@ -32,6 +32,7 @@
/**
* @addtogroup lavc_core
+ * @{
*/
enum AVFieldOrder {
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 15/54] avcodec/videotoolbox: Add proper doxy group
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (13 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 14/54] avcodec/codec_par: Add missing doxy group opening Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 16/54] avutil/aes_ctr: " Marvin Scholz
` (39 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Same as done for other HW decoders, that way it will be
properly listed on the relevant module page.
---
libavcodec/videotoolbox.h | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/libavcodec/videotoolbox.h b/libavcodec/videotoolbox.h
index fd8a5b7982..cc324faa52 100644
--- a/libavcodec/videotoolbox.h
+++ b/libavcodec/videotoolbox.h
@@ -29,6 +29,15 @@
* Public libavcodec Videotoolbox header.
*/
+/**
+ * @defgroup lavc_codec_hwaccel_videotoolbox VideoToolbox Decoder
+ * @ingroup lavc_codec_hwaccel
+ *
+ * Hardware accelerated decoding using VideoToolbox on Apple Platforms
+ *
+ * @{
+ */
+
#include <stdint.h>
#define Picture QuickdrawPicture
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 16/54] avutil/aes_ctr: Add proper doxy group
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (14 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 15/54] avcodec/videotoolbox: Add proper doxy group Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 17/54] avutil/display: consolidate group doxy Marvin Scholz
` (38 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
So it will be properly listed along the other crypto modules
in the documentation.
---
libavutil/aes_ctr.h | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/libavutil/aes_ctr.h b/libavutil/aes_ctr.h
index 4e9fda7aca..4d80c71326 100644
--- a/libavutil/aes_ctr.h
+++ b/libavutil/aes_ctr.h
@@ -22,6 +22,12 @@
#ifndef AVUTIL_AES_CTR_H
#define AVUTIL_AES_CTR_H
+/**
+ * @defgroup lavu_aes_ctr AES-CTR
+ * @ingroup lavu_crypto
+ * @{
+ */
+
#include <stdint.h>
#include "attributes.h"
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 17/54] avutil/display: consolidate group doxy
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (15 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 16/54] avutil/aes_ctr: " Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 18/54] avutil/display: Add file to doxy group Marvin Scholz
` (37 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Make it a bit easier to grasp the grouping when not
unnecessarily splitting comment blocks.
Additionally do not try to add lavu_video_display to itself, resolving
the following doxy warning:
warning: Refusing to add group lavu_video_display to itself
---
libavutil/display.h | 13 ++++---------
1 file changed, 4 insertions(+), 9 deletions(-)
diff --git a/libavutil/display.h b/libavutil/display.h
index 31d8bef361..2d6f335960 100644
--- a/libavutil/display.h
+++ b/libavutil/display.h
@@ -29,15 +29,9 @@
#include <stdint.h>
/**
- * @addtogroup lavu_video
- * @{
- *
* @defgroup lavu_video_display Display transformation matrix functions
- * @{
- */
-
-/**
- * @addtogroup lavu_video_display
+ * @ingroup lavu_video
+ *
* The display transformation matrix specifies an affine transformation that
* should be applied to video frames for correct presentation. It is compatible
* with the matrices stored in the ISO/IEC 14496-12 container format.
@@ -71,6 +65,8 @@
* q' = (b * p + d * q + y) / z;
* z = u * p + v * q + w
* @endcode
+ *
+ * @{
*/
/**
@@ -106,7 +102,6 @@ void av_display_rotation_set(int32_t matrix[9], double angle);
void av_display_matrix_flip(int32_t matrix[9], int hflip, int vflip);
/**
- * @}
* @}
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 18/54] avutil/display: Add file to doxy group
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (16 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 17/54] avutil/display: consolidate group doxy Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 19/54] avutil/spherical: consolidate group doxy Marvin Scholz
` (36 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
This way the related file will be properly grouped with its
corresponding group like it's done in other places in the doxy.
---
libavutil/display.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/display.h b/libavutil/display.h
index 2d6f335960..aa280c4c0c 100644
--- a/libavutil/display.h
+++ b/libavutil/display.h
@@ -20,6 +20,7 @@
/**
* @file
+ * @ingroup lavu_video_display
* Display matrix
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 19/54] avutil/spherical: consolidate group doxy
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (17 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 18/54] avutil/display: Add file to doxy group Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 20/54] avutil/spherical: Add file to doxy group Marvin Scholz
` (35 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Make it a bit easier to grasp the grouping when not
unnecessarily splitting comment blocks.
Additionally do not try to add lavu_video_spherical to itself, resolving
the following doxy warning:
warning: Refusing to add group lavu_video_spherical to itself
---
libavutil/spherical.h | 12 +++---------
1 file changed, 3 insertions(+), 9 deletions(-)
diff --git a/libavutil/spherical.h b/libavutil/spherical.h
index cef759cf27..85a76a917e 100644
--- a/libavutil/spherical.h
+++ b/libavutil/spherical.h
@@ -30,19 +30,14 @@
#include <stdint.h>
/**
- * @addtogroup lavu_video
- * @{
- *
* @defgroup lavu_video_spherical Spherical video mapping
- * @{
- */
-
-/**
- * @addtogroup lavu_video_spherical
+ * @ingroup lavu_video
+ *
* A spherical video file contains surfaces that need to be mapped onto a
* sphere. Depending on how the frame was converted, a different distortion
* transformation or surface recomposition function needs to be applied before
* the video should be mapped and displayed.
+ * @{
*/
/**
@@ -225,7 +220,6 @@ const char *av_spherical_projection_name(enum AVSphericalProjection projection);
*/
int av_spherical_from_name(const char *name);
/**
- * @}
* @}
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 20/54] avutil/spherical: Add file to doxy group
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (18 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 19/54] avutil/spherical: consolidate group doxy Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 21/54] avutil/stereo3d: consolidate group doxy Marvin Scholz
` (34 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
This way the related file will be properly grouped with its
corresponding group like it's done in other places in the doxy.
---
libavutil/spherical.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/spherical.h b/libavutil/spherical.h
index 85a76a917e..828ac836da 100644
--- a/libavutil/spherical.h
+++ b/libavutil/spherical.h
@@ -20,6 +20,7 @@
/**
* @file
+ * @ingroup lavu_video_spherical
* Spherical video
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 21/54] avutil/stereo3d: consolidate group doxy
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (19 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 20/54] avutil/spherical: Add file to doxy group Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 22/54] avutil/stereo3d: Add file to doxy group Marvin Scholz
` (33 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Make it a bit easier to grasp the grouping when not
unnecessarily splitting comment blocks.
Additionally do not try to add lavu_video_stereo3d to itself, resolving
the following doxy warning:
warning: Refusing to add group lavu_video_stereo3d to itself
---
libavutil/stereo3d.h | 15 +++++----------
1 file changed, 5 insertions(+), 10 deletions(-)
diff --git a/libavutil/stereo3d.h b/libavutil/stereo3d.h
index d421aac2a2..751d70b49a 100644
--- a/libavutil/stereo3d.h
+++ b/libavutil/stereo3d.h
@@ -31,19 +31,15 @@
#include "frame.h"
/**
- * @addtogroup lavu_video
- * @{
- *
* @defgroup lavu_video_stereo3d Stereo3D types and functions
- * @{
- */
-
-/**
- * @addtogroup lavu_video_stereo3d
+ * @ingroup lavu_video
+ *
* A stereoscopic video file consists in multiple views embedded in a single
* frame, usually describing two views of a scene. This file describes all
* possible codec-independent view arrangements.
- * */
+ *
+ * @{
+ */
/**
* List of possible 3D Types
@@ -226,7 +222,6 @@ const char *av_stereo3d_type_name(unsigned int type);
int av_stereo3d_from_name(const char *name);
/**
- * @}
* @}
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 22/54] avutil/stereo3d: Add file to doxy group
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (20 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 21/54] avutil/stereo3d: consolidate group doxy Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 23/54] avutil/csp: Fix bogus doxy filename Marvin Scholz
` (32 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
This way the related file will be properly grouped with its
corresponding group like it's done in other places in the doxy.
---
libavutil/stereo3d.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/stereo3d.h b/libavutil/stereo3d.h
index 751d70b49a..3aab959b79 100644
--- a/libavutil/stereo3d.h
+++ b/libavutil/stereo3d.h
@@ -20,6 +20,7 @@
/**
* @file
+ * @ingroup lavu_video_stereo3d
* Stereoscopic video
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 23/54] avutil/csp: Fix bogus doxy filename
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (21 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 22/54] avutil/stereo3d: Add file to doxy group Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 24/54] swscale: Fix bogus doxy comment #ifdefs Marvin Scholz
` (31 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Separate the blocks to make the grouping easier to grasp,
add the file properly to the group and fix the file description
incorrectly used as filename, fixing the following doxy warning:
warning: the name 'Colorspace' supplied as the argument in
the \file statement is not an input file
---
libavutil/csp.h | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/libavutil/csp.h b/libavutil/csp.h
index 37544449c6..18ef208adf 100644
--- a/libavutil/csp.h
+++ b/libavutil/csp.h
@@ -24,9 +24,14 @@
#include "rational.h"
/**
- * @file Colorspace value utility functions for libavutil.
+ * @file
+ * Colorspace value utility functions for libavutil.
+ * @ingroup lavu_math_csp
* @author Ronald S. Bultje <rsbultje@gmail.com>
* @author Leo Izen <leo.izen@gmail.com>
+ */
+
+/**
* @defgroup lavu_math_csp Colorspace Utility
* @ingroup lavu_math
* @{
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 24/54] swscale: Fix bogus doxy comment #ifdefs
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (22 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 23/54] avutil/csp: Fix bogus doxy filename Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 25/54] avcodec/mediacodec: use inline code for coderefs Marvin Scholz
` (30 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
The intention here was probably to document this as use of
conditionals does not make sense in a comment.
Fixes doxy warning:
warning: explicit link request to 'if' could not be resolved
---
libswscale/swscale.h | 15 +++++----------
1 file changed, 5 insertions(+), 10 deletions(-)
diff --git a/libswscale/swscale.h b/libswscale/swscale.h
index 3ebf7c698d..9794f6a258 100644
--- a/libswscale/swscale.h
+++ b/libswscale/swscale.h
@@ -324,22 +324,17 @@ unsigned int sws_receive_slice_alignment(const struct SwsContext *c);
* @param brightness 16.16 fixed point brightness correction
* @param contrast 16.16 fixed point contrast correction
* @param saturation 16.16 fixed point saturation correction
-#if LIBSWSCALE_VERSION_MAJOR > 6
- * @return negative error code on error, non negative otherwise
-#else
- * @return -1 if not supported
-#endif
+ *
+ * @return A negative error code on error, non negative otherwise.
+ * If `LIBSWSCALE_VERSION_MAJOR < 7`, returns -1 if not supported.
*/
int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
int srcRange, const int table[4], int dstRange,
int brightness, int contrast, int saturation);
/**
-#if LIBSWSCALE_VERSION_MAJOR > 6
- * @return negative error code on error, non negative otherwise
-#else
- * @return -1 if not supported
-#endif
+ * @return A negative error code on error, non negative otherwise.
+ * If `LIBSWSCALE_VERSION_MAJOR < 7`, returns -1 if not supported.
*/
int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
int *srcRange, int **table, int *dstRange,
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 25/54] avcodec/mediacodec: use inline code for coderefs
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (23 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 24/54] swscale: Fix bogus doxy comment #ifdefs Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 26/54] avcodec/mediacodec: link to related documentation Marvin Scholz
` (29 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Avoids doxy to interpret these as internal references forced by the #
character, fixing the warnings:
warning: explicit link request to 'nanoTime()' could not be resolved
warning: explicit link request to 'releaseOutputBuffer(int,long)'
could not be resolved
---
libavcodec/mediacodec.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/libavcodec/mediacodec.h b/libavcodec/mediacodec.h
index 4c8545df03..845ade26eb 100644
--- a/libavcodec/mediacodec.h
+++ b/libavcodec/mediacodec.h
@@ -88,9 +88,9 @@ int av_mediacodec_release_buffer(AVMediaCodecBuffer *buffer, int render);
/**
* Release a MediaCodec buffer and render it at the given time to the surface
* that is associated with the decoder. The timestamp must be within one second
- * of the current java/lang/System#nanoTime() (which is implemented using
- * CLOCK_MONOTONIC on Android). See the Android MediaCodec documentation
- * of android/media/MediaCodec#releaseOutputBuffer(int,long) for more details.
+ * of the current `java/lang/System#nanoTime()` (which is implemented using
+ * `CLOCK_MONOTONIC` on Android). See the Android MediaCodec documentation
+ * of `android/media/MediaCodec#releaseOutputBuffer(int,long)` for more details.
*
* @param buffer the buffer to render
* @param time timestamp in nanoseconds of when to render the buffer
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 26/54] avcodec/mediacodec: link to related documentation
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (24 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 25/54] avcodec/mediacodec: use inline code for coderefs Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 27/54] doc/Doxyfile: Add FF_PAD_STRUCTURE to PREDEFINED Marvin Scholz
` (28 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavcodec/mediacodec.h | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/libavcodec/mediacodec.h b/libavcodec/mediacodec.h
index 845ade26eb..8bd5753e9a 100644
--- a/libavcodec/mediacodec.h
+++ b/libavcodec/mediacodec.h
@@ -90,11 +90,13 @@ int av_mediacodec_release_buffer(AVMediaCodecBuffer *buffer, int render);
* that is associated with the decoder. The timestamp must be within one second
* of the current `java/lang/System#nanoTime()` (which is implemented using
* `CLOCK_MONOTONIC` on Android). See the Android MediaCodec documentation
- * of `android/media/MediaCodec#releaseOutputBuffer(int,long)` for more details.
+ * of [`android/media/MediaCodec#releaseOutputBuffer(int,long)`][0] for more details.
*
* @param buffer the buffer to render
* @param time timestamp in nanoseconds of when to render the buffer
* @return 0 on success, < 0 otherwise
+ *
+ * [0]: https://developer.android.com/reference/android/media/MediaCodec#releaseOutputBuffer(int,%20long)
*/
int av_mediacodec_render_buffer_at_time(AVMediaCodecBuffer *buffer, int64_t time);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 27/54] doc/Doxyfile: Add FF_PAD_STRUCTURE to PREDEFINED
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (25 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 26/54] avcodec/mediacodec: link to related documentation Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 28/54] avutil/bprint: Improve doxy documentation Marvin Scholz
` (27 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
The FF_PAD_STRUCTURE is too complex for doxygen to be able to
properly handle, resulting in completely broken AVBPrint documentation.
To fix that, tell Doxygen what to expand that macro to.
---
doc/Doxyfile | 1 +
1 file changed, 1 insertion(+)
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 0891899505..572c532da5 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -1980,6 +1980,7 @@ PREDEFINED = __attribute__(x)= \
av_alloc_size(...)= \
AV_GCC_VERSION_AT_LEAST(x,y)=1 \
AV_GCC_VERSION_AT_MOST(x,y)=0 \
+ "FF_PAD_STRUCTURE(name,size,...)=typedef struct name { __VA_ARGS__ } name;" \
__GNUC__
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 28/54] avutil/bprint: Improve doxy documentation
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (26 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 27/54] doc/Doxyfile: Add FF_PAD_STRUCTURE to PREDEFINED Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 29/54] swresample: Fix Doxy reference to AVOptions Marvin Scholz
` (26 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Declare proper group, add the file to that group,
group the defines and document them.
Use lists to represents lists of cases.
---
libavutil/bprint.h | 78 ++++++++++++++++++++++++++++++++--------------
1 file changed, 55 insertions(+), 23 deletions(-)
diff --git a/libavutil/bprint.h b/libavutil/bprint.h
index c09b1ac1e1..f27d30f723 100644
--- a/libavutil/bprint.h
+++ b/libavutil/bprint.h
@@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file
+ * @ingroup lavu_avbprint
+ * AVBPrint public header
+ */
+
#ifndef AVUTIL_BPRINT_H
#define AVUTIL_BPRINT_H
@@ -26,6 +32,14 @@
#include "attributes.h"
#include "avstring.h"
+/**
+ * @defgroup lavu_avbprint AVBPrint
+ * @ingroup lavu_data
+ *
+ * A buffer to print data progressively
+ * @{
+ */
+
/**
* Define a structure with extra padding to a fixed size
* This helps ensuring binary compatibility with future versions.
@@ -48,14 +62,14 @@ typedef struct name { \
* Small buffers are kept in the structure itself, and thus require no
* memory allocation at all (unless the contents of the buffer is needed
* after the structure goes out of scope). This is almost as lightweight as
- * declaring a local "char buf[512]".
+ * declaring a local `char buf[512]`.
*
* The length of the string can go beyond the allocated size: the buffer is
* then truncated, but the functions still keep account of the actual total
* length.
*
- * In other words, buf->len can be greater than buf->size and records the
- * total length of what would have been to the buffer if there had been
+ * In other words, AVBPrint.len can be greater than AVBPrint.size and records
+ * the total length of what would have been to the buffer if there had been
* enough memory.
*
* Append operations do not need to be tested for failure: if a memory
@@ -63,20 +77,17 @@ typedef struct name { \
* is still updated. This situation can be tested with
* av_bprint_is_complete().
*
- * The size_max field determines several possible behaviours:
- *
- * size_max = -1 (= UINT_MAX) or any large value will let the buffer be
- * reallocated as necessary, with an amortized linear cost.
- *
- * size_max = 0 prevents writing anything to the buffer: only the total
- * length is computed. The write operations can then possibly be repeated in
- * a buffer with exactly the necessary size
- * (using size_init = size_max = len + 1).
- *
- * size_max = 1 is automatically replaced by the exact size available in the
- * structure itself, thus ensuring no dynamic memory allocation. The
- * internal buffer is large enough to hold a reasonable paragraph of text,
- * such as the current paragraph.
+ * The AVBPrint.size_max field determines several possible behaviours:
+ * - `size_max = -1` (= `UINT_MAX`) or any large value will let the buffer be
+ * reallocated as necessary, with an amortized linear cost.
+ * - `size_max = 0` prevents writing anything to the buffer: only the total
+ * length is computed. The write operations can then possibly be repeated in
+ * a buffer with exactly the necessary size
+ * (using `size_init = size_max = len + 1`).
+ * - `size_max = 1` is automatically replaced by the exact size available in the
+ * structure itself, thus ensuring no dynamic memory allocation. The
+ * internal buffer is large enough to hold a reasonable paragraph of text,
+ * such as the current paragraph.
*/
FF_PAD_STRUCTURE(AVBPrint, 1024,
@@ -88,12 +99,31 @@ FF_PAD_STRUCTURE(AVBPrint, 1024,
)
/**
+ * @name Max size special values
* Convenience macros for special values for av_bprint_init() size_max
* parameter.
+ * @{
+ */
+
+/**
+ * Buffer will be reallocated as necessary, with an amortized linear cost.
*/
#define AV_BPRINT_SIZE_UNLIMITED ((unsigned)-1)
+/**
+ * Use the exact size available in the AVBPrint structure itself.
+ *
+ * Thus ensuring no dynamic memory allocation. The internal buffer is large
+ * enough to hold a reasonable paragraph of text, such as the current paragraph.
+ */
#define AV_BPRINT_SIZE_AUTOMATIC 1
+/**
+ * Do not write anything to the buffer, only calculate the total length.
+ *
+ * The write operations can then possibly be repeated in a buffer with
+ * exactly the necessary size (using `size_init = size_max = AVBPrint.len + 1`).
+ */
#define AV_BPRINT_SIZE_COUNT_ONLY 0
+/** @} */
/**
* Init a print buffer.
@@ -101,12 +131,12 @@ FF_PAD_STRUCTURE(AVBPrint, 1024,
* @param buf buffer to init
* @param size_init initial size (including the final 0)
* @param size_max maximum size;
- * 0 means do not write anything, just count the length;
- * 1 is replaced by the maximum value for automatic storage;
- * any large value means that the internal buffer will be
- * reallocated as needed up to that limit; -1 is converted to
- * UINT_MAX, the largest limit possible.
- * Check also AV_BPRINT_SIZE_* macros.
+ * - `0` means do not write anything, just count the length
+ * - `1` is replaced by the maximum value for automatic storage
+ * any large value means that the internal buffer will be
+ * reallocated as needed up to that limit
+ * - `-1` is converted to `UINT_MAX`, the largest limit possible.
+ * Check also `AV_BPRINT_SIZE_*` macros.
*/
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max);
@@ -216,4 +246,6 @@ int av_bprint_finalize(AVBPrint *buf, char **ret_str);
void av_bprint_escape(AVBPrint *dstbuf, const char *src, const char *special_chars,
enum AVEscapeMode mode, int flags);
+/** @} */
+
#endif /* AVUTIL_BPRINT_H */
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 29/54] swresample: Fix Doxy reference to AVOptions
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (27 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 28/54] avutil/bprint: Improve doxy documentation Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 30/54] avutil/camellia: Fix doxy @param typo Marvin Scholz
` (25 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libswresample/swresample.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index 4c26468c63..d4dcaebdcf 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -73,7 +73,7 @@
*
* Once all values have been set, it must be initialized with swr_init(). If
* you need to change the conversion parameters, you can change the parameters
- * using @ref AVOptions, as described above in the first example; or by using
+ * using @ref avoptions, as described above in the first example; or by using
* swr_alloc_set_opts2(), but with the first argument the allocated context.
* You must then call swr_init() again.
*
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 30/54] avutil/camellia: Fix doxy @param typo
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (28 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 29/54] swresample: Fix Doxy reference to AVOptions Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 31/54] avutil/channel_layout: Use inline code for Doxy Marvin Scholz
` (24 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/camellia.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libavutil/camellia.h b/libavutil/camellia.h
index e674c9b9a4..96787102e2 100644
--- a/libavutil/camellia.h
+++ b/libavutil/camellia.h
@@ -59,7 +59,7 @@ int av_camellia_init(struct AVCAMELLIA *ctx, const uint8_t *key, int key_bits);
* @param dst destination array, can be equal to src
* @param src source array, can be equal to dst
* @param count number of 16 byte blocks
- * @paran iv initialization vector for CBC mode, NULL for ECB mode
+ * @param iv initialization vector for CBC mode, NULL for ECB mode
* @param decrypt 0 for encryption, 1 for decryption
*/
void av_camellia_crypt(struct AVCAMELLIA *ctx, uint8_t *dst, const uint8_t *src, int count, uint8_t* iv, int decrypt);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 31/54] avutil/channel_layout: Use inline code for Doxy
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (29 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 30/54] avutil/camellia: Fix doxy @param typo Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 32/54] avutil/channel_layout: Document missing arguments Marvin Scholz
` (23 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
This avoids Doxygen to interpret <i> and others that look like XML tags
as those, fixing a warning about unknown tags.
---
libavutil/channel_layout.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 6415355662..ee32cc9ab9 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -90,9 +90,9 @@ enum AVChannel {
* Range of channels between AV_CHAN_AMBISONIC_BASE and
* AV_CHAN_AMBISONIC_END represent Ambisonic components using the ACN system.
*
- * Given a channel id <i> between AV_CHAN_AMBISONIC_BASE and
- * AV_CHAN_AMBISONIC_END (inclusive), the ACN index of the channel <n> is
- * <n> = <i> - AV_CHAN_AMBISONIC_BASE.
+ * Given a channel id `<i>` between AV_CHAN_AMBISONIC_BASE and
+ * AV_CHAN_AMBISONIC_END (inclusive), the ACN index of the channel `<n>` is
+ * `<n> = <i> - AV_CHAN_AMBISONIC_BASE`.
*
* @note these values are only used for AV_CHANNEL_ORDER_CUSTOM channel
* orderings, the AV_CHANNEL_ORDER_AMBISONIC ordering orders the channels
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 32/54] avutil/channel_layout: Document missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (30 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 31/54] avutil/channel_layout: Use inline code for Doxy Marvin Scholz
@ 2022-09-25 0:10 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 33/54] avfilter: Fix doxy references Marvin Scholz
` (22 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:10 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/channel_layout.h | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index ee32cc9ab9..46b501df7f 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -448,6 +448,8 @@ int av_get_extended_channel_layout(const char *name, uint64_t* channel_layout, i
*
* @param buf put here the string containing the channel layout
* @param buf_size size in bytes of the buffer
+ * @param nb_channels number of channels
+ * @param channel_layout channel layout bitset
* @deprecated use av_channel_layout_describe()
*/
attribute_deprecated
@@ -478,6 +480,7 @@ int64_t av_get_default_channel_layout(int nb_channels);
/**
* Get the index of a channel in channel_layout.
*
+ * @param channel_layout channel layout bitset
* @param channel a channel layout describing exactly one channel which must be
* present in channel_layout.
*
@@ -541,6 +544,7 @@ int av_get_standard_channel_layout(unsigned index, uint64_t *layout,
*
* @param buf pre-allocated buffer where to put the generated string
* @param buf_size size in bytes of the buffer.
+ * @param channel the AVChannel whose name to get
* @return amount of bytes needed to hold the output string, or a negative AVERROR
* on failure. If the returned value is bigger than buf_size, then the
* string was truncated.
@@ -559,6 +563,7 @@ void av_channel_name_bprint(struct AVBPrint *bp, enum AVChannel channel_id);
*
* @param buf pre-allocated buffer where to put the generated string
* @param buf_size size in bytes of the buffer.
+ * @param channel the AVChannel whose description to get
* @return amount of bytes needed to hold the output string, or a negative AVERROR
* on failure. If the returned value is bigger than buf_size, then the
* string was truncated.
@@ -615,7 +620,7 @@ int av_channel_layout_from_string(AVChannelLayout *channel_layout,
/**
* Get the default channel layout for a given number of channels.
*
- * @param channel_layout the layout structure to be initialized
+ * @param ch_layout the layout structure to be initialized
* @param nb_channels number of channels
*/
void av_channel_layout_default(AVChannelLayout *ch_layout, int nb_channels);
@@ -680,6 +685,7 @@ int av_channel_layout_describe_bprint(const AVChannelLayout *channel_layout,
* Get the channel with the given index in a channel layout.
*
* @param channel_layout input channel layout
+ * @param idx index of the channel
* @return channel with the index idx in channel_layout on success or
* AV_CHAN_NONE on failure (if idx is not valid or the channel order is
* unspecified)
@@ -692,6 +698,7 @@ av_channel_layout_channel_from_index(const AVChannelLayout *channel_layout, unsi
* channels are found, only the first match will be returned.
*
* @param channel_layout input channel layout
+ * @param channel the channel whose index to obtain
* @return index of channel in channel_layout on success or a negative number if
* channel is not present in channel_layout.
*/
@@ -706,6 +713,7 @@ int av_channel_layout_index_from_channel(const AVChannelLayout *channel_layout,
* @ref av_channel_from_string().
*
* @param channel_layout input channel layout
+ * @param name string describing the channel whose index to obtain
* @return a channel index described by the given string, or a negative AVERROR
* value.
*/
@@ -719,6 +727,7 @@ int av_channel_layout_index_from_string(const AVChannelLayout *channel_layout,
* @ref av_channel_from_string().
*
* @param channel_layout input channel layout
+ * @param name string describing the channel to obtain
* @return a channel described by the given string in channel_layout on success
* or AV_CHAN_NONE on failure (if the string is not valid or the channel
* order is unspecified)
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 33/54] avfilter: Fix doxy references
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (31 preceding siblings ...)
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 32/54] avutil/channel_layout: Document missing arguments Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 34/54] avformat/avio: Add doxy for missing argument Marvin Scholz
` (21 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Doxygen does not properly form references that span multiple levels,
so instead reword it a bit and manually add the references to what
they should point to.
---
libavfilter/avfilter.h | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index 2e8197c9a6..e43e9b38c7 100644
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -313,13 +313,20 @@ typedef struct AVFilter {
* and outputs are fixed), shortly before the format negotiation. This
* callback may be called more than once.
*
- * This callback must set AVFilterLink.outcfg.formats on every input link
- * and AVFilterLink.incfg.formats on every output link to a list of
- * pixel/sample formats that the filter supports on that link. For audio
- * links, this filter must also set @ref AVFilterLink.incfg.samplerates
- * "in_samplerates" / @ref AVFilterLink.outcfg.samplerates "out_samplerates"
- * and @ref AVFilterLink.incfg.channel_layouts "in_channel_layouts" /
- * @ref AVFilterLink.outcfg.channel_layouts "out_channel_layouts" analogously.
+ * This callback must set ::AVFilterLink's
+ * @ref AVFilterFormatsConfig.formats "outcfg.formats"
+ * on every input link and
+ * @ref AVFilterFormatsConfig.formats "incfg.formats"
+ * on every output link to a list of pixel/sample formats that the filter
+ * supports on that link.
+ * For audio links, this filter must also set
+ * @ref AVFilterFormatsConfig.samplerates "incfg.samplerates"
+ * /
+ * @ref AVFilterFormatsConfig.samplerates "outcfg.samplerates"
+ * and @ref AVFilterFormatsConfig.channel_layouts "incfg.channel_layouts"
+ * /
+ * @ref AVFilterFormatsConfig.channel_layouts "outcfg.channel_layouts"
+ * analogously.
*
* This callback must never be NULL if the union is in this state.
*
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 34/54] avformat/avio: Add doxy for missing argument
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (32 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 33/54] avfilter: Fix doxy references Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 35/54] avutil/detection_bbox: " Marvin Scholz
` (20 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavformat/avio.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavformat/avio.h b/libavformat/avio.h
index 36c3d7b430..216cc2391e 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -464,6 +464,7 @@ int avio_put_str16be(AVIOContext *s, const char *str);
*
* Zero-length ranges are omitted from the output.
*
+ * @param s the AVIOContext
* @param time the stream time the current bytestream pos corresponds to
* (in AV_TIME_BASE units), or AV_NOPTS_VALUE if unknown or not
* applicable
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 35/54] avutil/detection_bbox: Add doxy for missing argument
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (33 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 34/54] avformat/avio: Add doxy for missing argument Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 36/54] avutil/eval: Add doxy for missing arguments Marvin Scholz
` (19 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/detection_bbox.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/detection_bbox.h b/libavutil/detection_bbox.h
index c20c204a54..011988052c 100644
--- a/libavutil/detection_bbox.h
+++ b/libavutil/detection_bbox.h
@@ -93,6 +93,7 @@ av_get_detection_bbox(const AVDetectionBBoxHeader *header, unsigned int idx)
* AVDetectionBBox, and initializes the variables.
* Can be freed with a normal av_free() call.
*
+ * @param nb_bboxes number of AVDetectionBBox structures to allocate
* @param out_size if non-NULL, the size in bytes of the resulting data array is
* written here.
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 36/54] avutil/eval: Add doxy for missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (34 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 35/54] avutil/detection_bbox: " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 37/54] avutil/file: " Marvin Scholz
` (18 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/eval.h | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/libavutil/eval.h b/libavutil/eval.h
index 57afc2d562..ee8cffb057 100644
--- a/libavutil/eval.h
+++ b/libavutil/eval.h
@@ -42,6 +42,7 @@ typedef struct AVExpr AVExpr;
* @param func2_names NULL terminated array of zero terminated strings of funcs2 identifiers
* @param funcs2 NULL terminated array of function pointers for functions which take 2 arguments
* @param opaque a pointer which will be passed to all functions from funcs1 and funcs2
+ * @param log_offset log level offset, can be used to silence error messages
* @param log_ctx parent logging context
* @return >= 0 in case of success, a negative value corresponding to an
* AVERROR code otherwise
@@ -65,6 +66,7 @@ int av_expr_parse_and_eval(double *res, const char *s,
* @param funcs1 NULL terminated array of function pointers for functions which take 1 argument
* @param func2_names NULL terminated array of zero terminated strings of funcs2 identifiers
* @param funcs2 NULL terminated array of function pointers for functions which take 2 arguments
+ * @param log_offset log level offset, can be used to silence error messages
* @param log_ctx parent logging context
* @return >= 0 in case of success, a negative value corresponding to an
* AVERROR code otherwise
@@ -78,6 +80,7 @@ int av_expr_parse(AVExpr **expr, const char *s,
/**
* Evaluate a previously parsed expression.
*
+ * @param e the AVExpr to evaluate
* @param const_values a zero terminated array of values for the identifiers from av_expr_parse() const_names
* @param opaque a pointer which will be passed to all functions from funcs1 and funcs2
* @return the value of the expression
@@ -87,6 +90,7 @@ double av_expr_eval(AVExpr *e, const double *const_values, void *opaque);
/**
* Track the presence of variables and their number of occurrences in a parsed expression
*
+ * @param e the AVExpr to track variables in
* @param counter a zero-initialized array where the count of each variable will be stored
* @param size size of array
* @return 0 on success, a negative value indicates that no expression or array was passed
@@ -98,6 +102,7 @@ int av_expr_count_vars(AVExpr *e, unsigned *counter, int size);
* Track the presence of user provided functions and their number of occurrences
* in a parsed expression.
*
+ * @param e the AVExpr to track user provided functions in
* @param counter a zero-initialized array where the count of each function will be stored
* if you passed 5 functions with 2 arguments to av_expr_parse()
* then for arg=2 this will use upto 5 entries.
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 37/54] avutil/file: Add doxy for missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (35 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 36/54] avutil/eval: Add doxy for missing arguments Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 38/54] avutil/lfg: Add doxy for missing argument Marvin Scholz
` (17 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/file.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/libavutil/file.h b/libavutil/file.h
index 511c100db4..fc87a9cd6a 100644
--- a/libavutil/file.h
+++ b/libavutil/file.h
@@ -39,6 +39,9 @@
* case *bufptr will be set to NULL and *size will be set to 0.
* The returned buffer must be released with av_file_unmap().
*
+ * @param filename path to the file
+ * @param[out] bufptr pointee is set to the mapped or allocated buffer
+ * @param[out] size pointee is set to the size in bytes of the buffer
* @param log_offset loglevel offset used for logging
* @param log_ctx context used for logging
* @return a non negative number in case of success, a negative value
@@ -51,6 +54,7 @@ int av_file_map(const char *filename, uint8_t **bufptr, size_t *size,
/**
* Unmap or free the buffer bufptr created by av_file_map().
*
+ * @param bufptr the buffer previously created with av_file_map()
* @param size size in bytes of bufptr, must be the same as returned
* by av_file_map()
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 38/54] avutil/lfg: Add doxy for missing argument
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (36 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 37/54] avutil/file: " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 39/54] avutil/lfg: Minor doxy improvements Marvin Scholz
` (16 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/lfg.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/lfg.h b/libavutil/lfg.h
index 9a1e277acd..16917827c6 100644
--- a/libavutil/lfg.h
+++ b/libavutil/lfg.h
@@ -73,6 +73,7 @@ static inline unsigned int av_mlfg_get(AVLFG *c){
* Get the next two numbers generated by a Box-Muller Gaussian
* generator using the random numbers issued by lfg.
*
+ * @param lfg pointer to the contex structure
* @param out array where the two generated numbers are placed
*/
void av_bmg_get(AVLFG *lfg, double out[2]);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 39/54] avutil/lfg: Minor doxy improvements
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (37 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 38/54] avutil/lfg: Add doxy for missing argument Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 40/54] avutil/hwcontext: Add doxy for missing argument Marvin Scholz
` (15 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Use inline code for sizeof and use proper @return directive.
---
libavutil/lfg.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/libavutil/lfg.h b/libavutil/lfg.h
index 16917827c6..e75a986f12 100644
--- a/libavutil/lfg.h
+++ b/libavutil/lfg.h
@@ -27,7 +27,7 @@
/**
* Context structure for the Lagged Fibonacci PRNG.
* The exact layout, types and content of this struct may change and should
- * not be accessed directly. Only its sizeof() is guaranteed to stay the same
+ * not be accessed directly. Only its `sizeof()` is guaranteed to stay the same
* to allow easy instanciation.
*/
typedef struct AVLFG {
@@ -40,7 +40,7 @@ void av_lfg_init(AVLFG *c, unsigned int seed);
/**
* Seed the state of the ALFG using binary data.
*
- * Return value: 0 on success, negative value (AVERROR) on failure.
+ * @return 0 on success, negative value (AVERROR) on failure.
*/
int av_lfg_init_from_data(AVLFG *c, const uint8_t *data, unsigned int length);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 40/54] avutil/hwcontext: Add doxy for missing argument
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (38 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 39/54] avutil/lfg: Minor doxy improvements Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 41/54] avutil/parseutils: Add doxy for missing arguments Marvin Scholz
` (14 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/hwcontext.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/hwcontext.h b/libavutil/hwcontext.h
index efca17585e..7ff08c8608 100644
--- a/libavutil/hwcontext.h
+++ b/libavutil/hwcontext.h
@@ -591,6 +591,7 @@ int av_hwframe_map(AVFrame *dst, const AVFrame *src, int flags);
*
* @param derived_frame_ctx On success, a reference to the newly created
* AVHWFramesContext.
+ * @param format The AVPixelFormat for the derived context.
* @param derived_device_ctx A reference to the device to create the new
* AVHWFramesContext on.
* @param source_frame_ctx A reference to an existing AVHWFramesContext
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 41/54] avutil/parseutils: Add doxy for missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (39 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 40/54] avutil/hwcontext: Add doxy for missing argument Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 42/54] avutil/parseutils: Use inline code and properly escape Marvin Scholz
` (13 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/parseutils.h | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/libavutil/parseutils.h b/libavutil/parseutils.h
index e66d24b76e..2e9017cb43 100644
--- a/libavutil/parseutils.h
+++ b/libavutil/parseutils.h
@@ -79,6 +79,8 @@ int av_parse_video_rate(AVRational *rate, const char *str);
/**
* Put the RGBA values that correspond to color_string in rgba_color.
*
+ * @param rgba_color 4-elements array of uint8_t values, where the respective
+ * red, green, blue and alpha component values are written.
* @param color_string a string specifying a color. It can be the name of
* a color (case insensitive match) or a [0x|#]RRGGBB[AA] sequence,
* possibly followed by "@" and a string representing the alpha
@@ -92,6 +94,8 @@ int av_parse_video_rate(AVRational *rate, const char *str);
* @param slen length of the initial part of color_string containing the
* color. It can be set to -1 if color_string is a null terminated string
* containing nothing else than the color.
+ * @param log_ctx a pointer to an arbitrary struct of which the first field
+ * is a pointer to an AVClass struct (used for av_log()). Can be NULL.
* @return >= 0 in case of success, a negative value in case of
* failure (for example if color_string cannot be parsed).
*/
@@ -106,7 +110,7 @@ int av_parse_color(uint8_t *rgba_color, const char *color_string, int slen,
* av_parse_color().
*
* @param color_idx index of the requested color, starting from 0
- * @param rgbp if not NULL, will point to a 3-elements array with the color value in RGB
+ * @param rgb if not NULL, will point to a 3-elements array with the color value in RGB
* @return the color name string or NULL if color_idx is not in the array
*/
const char *av_get_known_color_name(int color_idx, const uint8_t **rgb);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 42/54] avutil/parseutils: Use inline code and properly escape
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (40 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 41/54] avutil/parseutils: Add doxy for missing arguments Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 43/54] avutil/uuid: Remove bogus doxy return doc Marvin Scholz
` (12 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
For some reason doxygen needs the % to be escaped here, except for the
%% in the inline code…
---
libavutil/parseutils.h | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/libavutil/parseutils.h b/libavutil/parseutils.h
index 2e9017cb43..dad5c2775b 100644
--- a/libavutil/parseutils.h
+++ b/libavutil/parseutils.h
@@ -166,19 +166,19 @@ int av_find_info_tag(char *arg, int arg_size, const char *tag1, const char *info
* by the standard strptime().
*
* The supported input field descriptors are listed below.
- * - %H: the hour as a decimal number, using a 24-hour clock, in the
+ * - `%%H`: the hour as a decimal number, using a 24-hour clock, in the
* range '00' through '23'
- * - %J: hours as a decimal number, in the range '0' through INT_MAX
- * - %M: the minute as a decimal number, using a 24-hour clock, in the
+ * - `%%J`: hours as a decimal number, in the range '0' through INT_MAX
+ * - `%%M`: the minute as a decimal number, using a 24-hour clock, in the
* range '00' through '59'
- * - %S: the second as a decimal number, using a 24-hour clock, in the
+ * - `%%S`: the second as a decimal number, using a 24-hour clock, in the
* range '00' through '59'
- * - %Y: the year as a decimal number, using the Gregorian calendar
- * - %m: the month as a decimal number, in the range '1' through '12'
- * - %d: the day of the month as a decimal number, in the range '1'
+ * - `%%Y`: the year as a decimal number, using the Gregorian calendar
+ * - `%%m`: the month as a decimal number, in the range '1' through '12'
+ * - `%%d`: the day of the month as a decimal number, in the range '1'
* through '31'
- * - %T: alias for '%H:%M:%S'
- * - %%: a literal '%'
+ * - `%%T`: alias for `%%H:%%M:%%S`
+ * - `%%`: a literal `%`
*
* @return a pointer to the first character not processed in this function
* call. In case the input string contains more characters than
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 43/54] avutil/uuid: Remove bogus doxy return doc
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (41 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 42/54] avutil/parseutils: Use inline code and properly escape Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 44/54] avutil/rc4: Add doxy for missing arguments Marvin Scholz
` (11 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
The function returns void and no error code.
---
libavutil/uuid.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/libavutil/uuid.h b/libavutil/uuid.h
index 4b5088911c..748b7ed3c9 100644
--- a/libavutil/uuid.h
+++ b/libavutil/uuid.h
@@ -106,7 +106,6 @@ int av_uuid_parse_range(const char *in_start, const char *in_end, AVUUID uu);
*
* @param[in] uu AVUUID
* @param[out] out Pointer to an array of no less than 37 characters.
- * @return A non-zero value in case of an error.
*/
void av_uuid_unparse(const AVUUID uu, char *out);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 44/54] avutil/rc4: Add doxy for missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (42 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 43/54] avutil/uuid: Remove bogus doxy return doc Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 45/54] avutil/frame: Add doxy for missing argument Marvin Scholz
` (10 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/rc4.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/libavutil/rc4.h b/libavutil/rc4.h
index 029cd2ad58..bf0ca6e942 100644
--- a/libavutil/rc4.h
+++ b/libavutil/rc4.h
@@ -42,6 +42,8 @@ AVRC4 *av_rc4_alloc(void);
/**
* @brief Initializes an AVRC4 context.
*
+ * @param d pointer to the AVRC4 context
+ * @param key buffer containig the key
* @param key_bits must be a multiple of 8
* @param decrypt 0 for encryption, 1 for decryption, currently has no effect
* @return zero on success, negative value otherwise
@@ -51,6 +53,7 @@ int av_rc4_init(struct AVRC4 *d, const uint8_t *key, int key_bits, int decrypt);
/**
* @brief Encrypts / decrypts using the RC4 algorithm.
*
+ * @param d pointer to the AVRC4 context
* @param count number of bytes
* @param dst destination array, can be equal to src
* @param src source array, can be equal to dst, may be NULL
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 45/54] avutil/frame: Add doxy for missing argument
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (43 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 44/54] avutil/rc4: Add doxy for missing arguments Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 46/54] avutil/avstring: " Marvin Scholz
` (9 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/frame.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/frame.h b/libavutil/frame.h
index 6d9563bc5d..e60a82f6c0 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -864,6 +864,7 @@ int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
/**
* Get the buffer reference a given data plane is stored in.
*
+ * @param frame the frame to get the plane's buffer from
* @param plane index of the data plane of interest in frame->extended_data.
*
* @return the buffer reference that contains the plane or NULL if the input
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 46/54] avutil/avstring: Add doxy for missing argument
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (44 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 45/54] avutil/frame: Add doxy for missing argument Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 47/54] avutil/des: Add doxy for missing arguments Marvin Scholz
` (8 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/avstring.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/avstring.h b/libavutil/avstring.h
index fae446c302..74aa4cd0e4 100644
--- a/libavutil/avstring.h
+++ b/libavutil/avstring.h
@@ -135,6 +135,7 @@ size_t av_strlcatf(char *dst, size_t size, const char *fmt, ...) av_printf_forma
/**
* Get the count of continuous non zero chars starting from the beginning.
*
+ * @param s the string whose length to count
* @param len maximum number of characters to check in the string, that
* is the maximum value which is returned by the function
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 47/54] avutil/des: Add doxy for missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (45 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 46/54] avutil/avstring: " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 48/54] avutil/crc: " Marvin Scholz
` (7 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Additionally reorder so that the arguments list matches the
order of the arguments in the function declaration.
---
libavutil/des.h | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/libavutil/des.h b/libavutil/des.h
index 4cf11f5bca..3a3e6fa47c 100644
--- a/libavutil/des.h
+++ b/libavutil/des.h
@@ -43,6 +43,8 @@ AVDES *av_des_alloc(void);
/**
* @brief Initializes an AVDES context.
*
+ * @param d pointer to a AVDES structure to initialize
+ * @param key pointer to the key to use
* @param key_bits must be 64 or 192
* @param decrypt 0 for encryption/CBC-MAC, 1 for decryption
* @return zero on success, negative value otherwise
@@ -52,9 +54,10 @@ int av_des_init(struct AVDES *d, const uint8_t *key, int key_bits, int decrypt);
/**
* @brief Encrypts / decrypts using the DES algorithm.
*
- * @param count number of 8 byte blocks
+ * @param d pointer to the AVDES structure
* @param dst destination array, can be equal to src, must be 8-byte aligned
* @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL
+ * @param count number of 8 byte blocks
* @param iv initialization vector for CBC mode, if NULL then ECB will be used,
* must be 8-byte aligned
* @param decrypt 0 for encryption, 1 for decryption
@@ -64,9 +67,10 @@ void av_des_crypt(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count,
/**
* @brief Calculates CBC-MAC using the DES algorithm.
*
- * @param count number of 8 byte blocks
+ * @param d pointer to the AVDES structure
* @param dst destination array, can be equal to src, must be 8-byte aligned
* @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL
+ * @param count number of 8 byte blocks
*/
void av_des_mac(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count);
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 48/54] avutil/crc: Add doxy for missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (46 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 47/54] avutil/des: Add doxy for missing arguments Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 49/54] avutil/imgutils: document some " Marvin Scholz
` (6 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/crc.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/libavutil/crc.h b/libavutil/crc.h
index 24a2e3caed..7f59812a18 100644
--- a/libavutil/crc.h
+++ b/libavutil/crc.h
@@ -84,7 +84,10 @@ const AVCRC *av_crc_get_table(AVCRCId crc_id);
/**
* Calculate the CRC of a block.
+ * @param ctx initialized AVCRC array (see av_crc_init())
* @param crc CRC of previous blocks if any or initial value for CRC
+ * @param buffer buffer whose CRC to calculate
+ * @param length length of the buffer
* @return CRC updated with the data from the given block
*
* @see av_crc_init() "le" parameter
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 49/54] avutil/imgutils: document some missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (47 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 48/54] avutil/crc: " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 50/54] swscale: " Marvin Scholz
` (5 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/imgutils.h | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/libavutil/imgutils.h b/libavutil/imgutils.h
index be53335568..e10ac14952 100644
--- a/libavutil/imgutils.h
+++ b/libavutil/imgutils.h
@@ -48,6 +48,7 @@
* component in the plane with the max pixel step.
* @param max_pixstep_comps an array which is filled with the component
* for each plane which has the max pixel step. May be NULL.
+ * @param pixdesc the AVPixFmtDescriptor for the image, describing its format
*/
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
const AVPixFmtDescriptor *pixdesc);
@@ -65,6 +66,8 @@ int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane);
* width width.
*
* @param linesizes array to be filled with the linesize for each plane
+ * @param pix_fmt the AVPixelFormat of the image
+ * @param width width of the image in pixels
* @return >= 0 in case of success, a negative error code otherwise
*/
int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width);
@@ -73,6 +76,8 @@ int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int wi
* Fill plane sizes for an image with pixel format pix_fmt and height height.
*
* @param size the array to be filled with the size of each image plane
+ * @param pix_fmt the AVPixelFormat of the image
+ * @param height height of the image in pixels
* @param linesizes the array containing the linesize for each
* plane, should be filled by av_image_fill_linesizes()
* @return >= 0 in case of success, a negative error code otherwise
@@ -88,6 +93,8 @@ int av_image_fill_plane_sizes(size_t size[4], enum AVPixelFormat pix_fmt,
* height height.
*
* @param data pointers array to be filled with the pointer for each image plane
+ * @param pix_fmt the AVPixelFormat of the image
+ * @param height height of the image in pixels
* @param ptr the pointer to a buffer which will contain the image
* @param linesizes the array containing the linesize for each
* plane, should be filled by av_image_fill_linesizes()
@@ -103,6 +110,11 @@ int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int hei
* The allocated image buffer has to be freed by using
* av_freep(&pointers[0]).
*
+ * @param pointers array to be filled with the pointer for each image plane
+ * @param linesizes the array filled with the linesize for each plane
+ * @param w width of the image in pixels
+ * @param h height of the image in pixels
+ * @param pix_fmt the AVPixelFormat of the image
* @param align the value to use for buffer size alignment
* @return the size in bytes required for the image buffer, a negative
* error code in case of failure
@@ -119,8 +131,11 @@ int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
* bytewidth must be contained by both absolute values of dst_linesize
* and src_linesize, otherwise the function behavior is undefined.
*
+ * @param dst destination plane to copy to
* @param dst_linesize linesize for the image plane in dst
+ * @param src source plane to copy from
* @param src_linesize linesize for the image plane in src
+ * @param height height (number of lines) of the plane
*/
void av_image_copy_plane(uint8_t *dst, int dst_linesize,
const uint8_t *src, int src_linesize,
@@ -147,8 +162,13 @@ void av_image_copy_plane_uc_from(uint8_t *dst, ptrdiff_t dst_linesize,
/**
* Copy image in src_data to dst_data.
*
+ * @param dst_data destination image data buffer to copy to
* @param dst_linesizes linesizes for the image in dst_data
+ * @param src_data source image data buffer to copy from
* @param src_linesizes linesizes for the image in src_data
+ * @param pix_fmt the AVPixelFormat of the image
+ * @param width width of the image in pixels
+ * @param height height of the image in pixels
*/
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
const uint8_t *src_data[4], const int src_linesizes[4],
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 50/54] swscale: document some missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (48 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 49/54] avutil/imgutils: document some " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 51/54] avcodec/bsf: document " Marvin Scholz
` (4 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libswscale/swscale.h | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/libswscale/swscale.h b/libswscale/swscale.h
index 9794f6a258..5410b9e0d2 100644
--- a/libswscale/swscale.h
+++ b/libswscale/swscale.h
@@ -234,6 +234,7 @@ int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[],
* - sws_receive_slice(0, dst->height)
* - sws_frame_end()
*
+ * @param c The scaling context
* @param dst The destination frame. See documentation for sws_frame_start() for
* more details.
* @param src The source frame.
@@ -249,6 +250,7 @@ int sws_scale_frame(struct SwsContext *c, AVFrame *dst, const AVFrame *src);
* This function will retain references to src and dst, so they must both use
* refcounted buffers (if allocated by the caller, in case of dst).
*
+ * @param c The scaling context
* @param dst The destination frame.
*
* The data buffers may either be already allocated by the caller or
@@ -273,6 +275,8 @@ int sws_frame_start(struct SwsContext *c, AVFrame *dst, const AVFrame *src);
* submitted with sws_frame_start(). Must be called after all sws_send_slice()
* and sws_receive_slice() calls are done, before any new sws_frame_start()
* calls.
+ *
+ * @param c The scaling context
*/
void sws_frame_end(struct SwsContext *c);
@@ -282,6 +286,7 @@ void sws_frame_end(struct SwsContext *c);
* any order, but may not overlap. For vertically subsampled pixel formats, the
* slices must be aligned according to subsampling.
*
+ * @param c The scaling context
* @param slice_start first row of the slice
* @param slice_height number of rows in the slice
*
@@ -294,6 +299,7 @@ int sws_send_slice(struct SwsContext *c, unsigned int slice_start,
* Request a horizontal slice of the output data to be written into the frame
* previously provided to sws_frame_start().
*
+ * @param c The scaling context
* @param slice_start first row of the slice; must be a multiple of
* sws_receive_slice_alignment()
* @param slice_height number of rows in the slice; must be a multiple of
@@ -310,6 +316,9 @@ int sws_receive_slice(struct SwsContext *c, unsigned int slice_start,
unsigned int slice_height);
/**
+ * Get the alignment required for slices
+ *
+ * @param c The scaling context
* @return alignment required for output slices requested with sws_receive_slice().
* Slice offsets and sizes passed to sws_receive_slice() must be
* multiples of the value returned from this function.
@@ -317,6 +326,7 @@ int sws_receive_slice(struct SwsContext *c, unsigned int slice_start,
unsigned int sws_receive_slice_alignment(const struct SwsContext *c);
/**
+ * @param c the scaling context
* @param dstRange flag indicating the while-black range of the output (1=jpeg / 0=mpeg)
* @param srcRange flag indicating the while-black range of the input (1=jpeg / 0=mpeg)
* @param table the yuv2rgb coefficients describing the output yuv space, normally ff_yuv2rgb_coeffs[x]
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 51/54] avcodec/bsf: document missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (49 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 50/54] swscale: " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 52/54] avutil/aes: document some " Marvin Scholz
` (3 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavcodec/bsf.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/libavcodec/bsf.h b/libavcodec/bsf.h
index 69d91a16ab..17fa6141ee 100644
--- a/libavcodec/bsf.h
+++ b/libavcodec/bsf.h
@@ -164,6 +164,8 @@ int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
/**
* Prepare the filter for use, after all the parameters and options have been
* set.
+ *
+ * @param ctx a AVBSFContext previously allocated with av_bsf_alloc()
*/
int av_bsf_init(AVBSFContext *ctx);
@@ -174,6 +176,7 @@ int av_bsf_init(AVBSFContext *ctx);
* av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
* AVERROR_EOF.
*
+ * @param ctx an initialized AVBSFContext
* @param pkt the packet to filter. The bitstream filter will take ownership of
* the packet and reset the contents of pkt. pkt is not touched if an error occurs.
* If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
@@ -192,6 +195,7 @@ int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
/**
* Retrieve a filtered packet.
*
+ * @param ctx an initialized AVBSFContext
* @param[out] pkt this struct will be filled with the contents of the filtered
* packet. It is owned by the caller and must be freed using
* av_packet_unref() when it is no longer needed.
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 52/54] avutil/aes: document some missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (50 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 51/54] avcodec/bsf: document " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 53/54] avutil/aes_ctr: " Marvin Scholz
` (2 subsequent siblings)
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/aes.h | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/libavutil/aes.h b/libavutil/aes.h
index d243286c86..4e73473688 100644
--- a/libavutil/aes.h
+++ b/libavutil/aes.h
@@ -42,6 +42,9 @@ struct AVAES *av_aes_alloc(void);
/**
* Initialize an AVAES context.
+ *
+ * @param a The AVAES context
+ * @param key Pointer to the key
* @param key_bits 128, 192 or 256
* @param decrypt 0 for encryption, 1 for decryption
*/
@@ -49,9 +52,11 @@ int av_aes_init(struct AVAES *a, const uint8_t *key, int key_bits, int decrypt);
/**
* Encrypt or decrypt a buffer using a previously initialized context.
- * @param count number of 16 byte blocks
+ *
+ * @param a The AVAES context
* @param dst destination array, can be equal to src
* @param src source array, can be equal to dst
+ * @param count number of 16 byte blocks
* @param iv initialization vector for CBC mode, if NULL then ECB will be used
* @param decrypt 0 for encryption, 1 for decryption
*/
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 53/54] avutil/aes_ctr: document some missing arguments
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (51 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 52/54] avutil/aes: document some " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 54/54] avutil/samplefmt: document missing argument Marvin Scholz
2022-10-17 8:48 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Anton Khirnov
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/aes_ctr.h | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/libavutil/aes_ctr.h b/libavutil/aes_ctr.h
index 4d80c71326..598926fdcf 100644
--- a/libavutil/aes_ctr.h
+++ b/libavutil/aes_ctr.h
@@ -44,17 +44,23 @@ struct AVAESCTR *av_aes_ctr_alloc(void);
/**
* Initialize an AVAESCTR context.
+ *
+ * @param a The AVAESCTR context to initialize
* @param key encryption key, must have a length of AES_CTR_KEY_SIZE
*/
int av_aes_ctr_init(struct AVAESCTR *a, const uint8_t *key);
/**
* Release an AVAESCTR context.
+ *
+ * @param a The AVAESCTR context
*/
void av_aes_ctr_free(struct AVAESCTR *a);
/**
* Process a buffer using a previously initialized context.
+ *
+ * @param a The AVAESCTR context
* @param dst destination array, can be equal to src
* @param src source array, can be equal to dst
* @param size the size of src and dst
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* [FFmpeg-devel] [PATCH v3 54/54] avutil/samplefmt: document missing argument
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (52 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 53/54] avutil/aes_ctr: " Marvin Scholz
@ 2022-09-25 0:11 ` Marvin Scholz
2022-10-17 8:48 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Anton Khirnov
54 siblings, 0 replies; 69+ messages in thread
From: Marvin Scholz @ 2022-09-25 0:11 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
---
libavutil/samplefmt.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h
index 1999c9bca6..6bad0e254a 100644
--- a/libavutil/samplefmt.h
+++ b/libavutil/samplefmt.h
@@ -213,6 +213,7 @@ int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
* @param[out] linesize aligned size for audio buffer(s), may be NULL
* @param nb_channels number of audio channels
* @param nb_samples number of samples per channel
+ * @param sample_fmt the sample format
* @param align buffer size alignment (0 = default, 1 = no alignment)
* @return >=0 on success or a negative error code on failure
* @todo return the size of the allocated buffer in case of success at the next bump
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread* Re: [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes
2022-09-25 0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
` (53 preceding siblings ...)
2022-09-25 0:11 ` [FFmpeg-devel] [PATCH v3 54/54] avutil/samplefmt: document missing argument Marvin Scholz
@ 2022-10-17 8:48 ` Anton Khirnov
54 siblings, 0 replies; 69+ messages in thread
From: Anton Khirnov @ 2022-10-17 8:48 UTC (permalink / raw)
To: FFmpeg development discussions and patches; +Cc: Marvin Scholz
Set pushed (with some trailing whitespace fixes).
--
Anton Khirnov
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 69+ messages in thread