From patchwork Tue Feb 7 15:01:52 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vittorio Giovara X-Patchwork-Id: 2442 Delivered-To: ffmpegpatchwork@gmail.com Received: by 10.103.89.21 with SMTP id n21csp2305381vsb; Tue, 7 Feb 2017 07:08:32 -0800 (PST) X-Received: by 10.223.147.225 with SMTP id 88mr14325767wrp.44.1486480112531; Tue, 07 Feb 2017 07:08:32 -0800 (PST) Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id h35si5340786wrh.233.2017.02.07.07.08.22; Tue, 07 Feb 2017 07:08:32 -0800 (PST) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 1AA036899CB; Tue, 7 Feb 2017 17:08:17 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-qt0-f195.google.com (mail-qt0-f195.google.com [209.85.216.195]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 0949F6898CD for ; Tue, 7 Feb 2017 17:08:11 +0200 (EET) Received: by mail-qt0-f195.google.com with SMTP id h53so19356859qth.3 for ; Tue, 07 Feb 2017 07:08:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id; bh=QFXJtjEF9oE91cq0b2ic+m2xkGCXEni4qxHZ+8HUXa4=; b=KhZtmEmsejvigHzfWkb0reYZQbxbu40nDhwQS/WcMqwbUbm4pF3hMHTE7s/v96wEyB 6lNDCIviXJuy305zMO634OYzKmwrtZl15wijGe19a+DF43KAEv7UIGV7/m1sao/2uVXJ 5Qrsv5xQsBsf94AhnXOHxFb83wp4cEN2w6OqxveKv3CfoQJt5IfryhBiTWrSvEtFeJkc GteyxSy0tj/hWYbgmVOywrIZz4euJKjQp/kMMqH60srmJE7NRE7we+mQn0WAlvEm+mzg UeLnrr6EnLjT5kM0XFe0uOINFVaNgF27cX96QtwCZ2ttY1uyAKEr47336zVveZ+DdAVX B5TQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id; bh=QFXJtjEF9oE91cq0b2ic+m2xkGCXEni4qxHZ+8HUXa4=; b=BZOTVYE280cSdM+tlHQYyfX2PP9s0ktiOMWdKJq+LTVARib1yKQ6c1a7i/LR3F+/6Q ZMwSyWvDn6ito8IoLnNFc3KiH6XxMdI+d6wYUhDt6yAZe+V+qTZPGEr2E+f7XWsJ46Kl 1cVwQWfdHH7PKWV4BtEym9cwErdVuPVFkMT0FzRXAFnOyHkiyandZ1Ui9/YWOyZ2ilF5 vMJyr8jUvGyRIoBvcplTvvqptwnOSC+2HLjVFfWcR9TJZaYVumS1PbzdwnK36YtsxdHs 6fgtGNHod0Ok0NKJeC6brWhUeRGjHRBWxhqm7K9loH72ZLYLsf5Zl4sO7slfP34exHy5 vJaQ== X-Gm-Message-State: AMke39k52hrTolONtmGyXvqcm3jqPFLCep2+PfMYMT+0i++whSZPZIO9YJTaBIuCDgslKA== X-Received: by 10.200.43.115 with SMTP id 48mr16149617qtv.157.1486479713254; Tue, 07 Feb 2017 07:01:53 -0800 (PST) Received: from vimacbookpro.vimeows.com (nyv-exweb.iac.com. [216.112.252.10]) by smtp.gmail.com with ESMTPSA id w41sm3542192qtw.34.2017.02.07.07.01.52 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 07 Feb 2017 07:01:52 -0800 (PST) From: Vittorio Giovara To: ffmpeg-devel@ffmpeg.org Date: Tue, 7 Feb 2017 10:01:52 -0500 Message-Id: <20170207150152.19867-1-vittorio.giovara@gmail.com> X-Mailer: git-send-email 2.10.0 Subject: [FFmpeg-devel] [PATCH] imgutils: Document av_image_get_buffer_size() X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches MIME-Version: 1.0 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" --- libavutil/imgutils.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/libavutil/imgutils.h b/libavutil/imgutils.h index 67063a2..ac1bcb8 100644 --- a/libavutil/imgutils.h +++ b/libavutil/imgutils.h @@ -169,7 +169,12 @@ int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4], * Return the size in bytes of the amount of data required to store an * image with the given parameters. * - * @param[in] align the assumed linesize alignment + * @param pix_fmt the pixel format of the image + * @param width the width of the image in pixels + * @param height the height of the image in pixels + * @param align the assumed linesize alignment + * @return the size in bytes required for src, a negative error code + * in case of failure */ int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align);