diff mbox series

[FFmpeg-devel,1/2] avutil/samplefmt: remove outdated comment

Message ID 20210607034216.2862-1-jamrial@gmail.com
State Accepted
Commit 7916c1471318f17332ff4c7ee7e330696a7afcbf
Headers show
Series [FFmpeg-devel,1/2] avutil/samplefmt: remove outdated comment
Related show

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

James Almer June 7, 2021, 3:42 a.m. UTC
av_samples_fill_arrays() has been returning the minimum required buffer size
for a while now.

Signed-off-by: James Almer <jamrial@gmail.com>
---
 libavutil/samplefmt.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

James Almer June 13, 2021, 2:53 p.m. UTC | #1
On 6/7/2021 12:42 AM, James Almer wrote:
> av_samples_fill_arrays() has been returning the minimum required buffer size
> for a while now.
> 
> Signed-off-by: James Almer <jamrial@gmail.com>
> ---
>   libavutil/samplefmt.h | 5 ++---
>   1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h
> index 8cd43ae856..f270199195 100644
> --- a/libavutil/samplefmt.h
> +++ b/libavutil/samplefmt.h
> @@ -195,9 +195,8 @@ int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
>    * @param nb_samples       the number of samples in a single 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 minimum size in bytes required for the buffer in case
> - * of success at the next bump
> + * @return                 minimum size in bytes required for the buffer on success,
> + *                         or a negative error code on failure
>    */
>   int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
>                              const uint8_t *buf,

Will apply set.
diff mbox series

Patch

diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h
index 8cd43ae856..f270199195 100644
--- a/libavutil/samplefmt.h
+++ b/libavutil/samplefmt.h
@@ -195,9 +195,8 @@  int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
  * @param nb_samples       the number of samples in a single 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 minimum size in bytes required for the buffer in case
- * of success at the next bump
+ * @return                 minimum size in bytes required for the buffer on success,
+ *                         or a negative error code on failure
  */
 int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
                            const uint8_t *buf,