From patchwork Fri Jan 18 11:38:20 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Carl Eugen Hoyos X-Patchwork-Id: 11794 Return-Path: X-Original-To: patchwork@ffaux-bg.ffmpeg.org Delivered-To: patchwork@ffaux-bg.ffmpeg.org Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by ffaux.localdomain (Postfix) with ESMTP id 3351444EC04 for ; Fri, 18 Jan 2019 13:45:44 +0200 (EET) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 4BA3868AC85; Fri, 18 Jan 2019 13:45:32 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-it1-f172.google.com (mail-it1-f172.google.com [209.85.166.172]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id D1ABE68AC85 for ; Fri, 18 Jan 2019 13:45:25 +0200 (EET) Received: by mail-it1-f172.google.com with SMTP id i145so6271217ita.4 for ; Fri, 18 Jan 2019 03:45:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=AdOVFSQJI8nLVnvdyeMyHnHPvbwNLNF0tkqNLcJ1h2w=; b=BKfmH8AuvbgNC+CYm1vRi/VhmDNRlAjSkmF1ppAOLxt3KC23jY+uBQjFnm3tLuDrID 2w1FAfW7fuCYnvrZ7Ngx5C9E6Rf+aclbbms0qSpzdSWHaJf9eUcXrwKf8aoTmiEyMFS4 dmpPw2OUnmCY+tjhhPmPuDbRo4nPuSZH5yEvUBRIwQSJ/QpGMTf+ovL60VVuNqhAeOO4 OsTn+J7MBFhXyqr31IdIhuNH73lmo9EitObtQ+8w4C8C9g7C5Q9qsQ/5iI5DMYggZvXF P+IFnyiXiAnrXvjuI9ErdSumVFswArEaW4hjD6YFh6Y4zGAlv8n/+B37pIY86Z0dTf65 tVBg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=AdOVFSQJI8nLVnvdyeMyHnHPvbwNLNF0tkqNLcJ1h2w=; b=tPRYu2X8b2La5rBqDqpCGc1xRpunNXt36NSzwn8z3bAZ3DG9P6nZcKfvWav1vNrDPB 5z1ab+nzIT2qViW86aCsHKqViys5YHKay29YjeJ6fvpNi6ka50urgZp4FkKHI9BYRWAY SiTRXpD8SGEbbiJ2Kps7tFE7RybgubbSWJTkTLH+jJqQKLOuFokSZOmWYnSosktKrkWi RGiJn4YJAVgLq0/l75oZL2Ydlv2jslrY/ELlB3lM7iB3o7RVqlfCgmlltLVqWzlvG7+4 xH1svPYT6KWy+HiuZBAsDh3EpwxihE6wKe+yhENyaXIoX0dM5NzIXmow8rj/MDTM3Qe2 yjrA== X-Gm-Message-State: AJcUukffKwfvHwCreAh/Z+5SKnw4if2TN3E72dWij+P7I3Vnwwoe4Fi/ 9D7L8DezcUhUDWAXHD+toRqXDEbfTt8FG1M7cGJnog== X-Google-Smtp-Source: ALg8bN50OzrLUkQU1R1+aoANDT0Mk6FKL73JlBQ2uHyqiwOrNK8mJlYIJHwCa3twZNHB8hk0mjcqFUTf9LpSbfekOgI= X-Received: by 2002:a02:48c6:: with SMTP id p189mr9604326jaa.89.1547811500885; Fri, 18 Jan 2019 03:38:20 -0800 (PST) MIME-Version: 1.0 Received: by 2002:a02:5f11:0:0:0:0:0 with HTTP; Fri, 18 Jan 2019 03:38:20 -0800 (PST) From: Carl Eugen Hoyos Date: Fri, 18 Jan 2019 12:38:20 +0100 Message-ID: To: FFmpeg development discussions and patches Subject: [FFmpeg-devel] [PATCH]lavu/frame: Try to improve the documentation wording 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 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Hi! Attached patch tries to improve the ROI documentation wording, C structs cannot return errors. Please comment, Carl Eugen From 4abd545e7ab463c97bf816b270544eee25c4755b Mon Sep 17 00:00:00 2001 From: Carl Eugen Hoyos Date: Fri, 18 Jan 2019 12:35:44 +0100 Subject: [PATCH] lavu/frame: Try to improve the documentation wording. C structs cannot return errors. --- libavutil/frame.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libavutil/frame.h b/libavutil/frame.h index 8aa3e88..1990320 100644 --- a/libavutil/frame.h +++ b/libavutil/frame.h @@ -218,8 +218,8 @@ typedef struct AVFrameSideData { * if the codec requires an alignment. * If the regions overlap, the last value in the list will be used. * - * qoffset is quant offset, and base rule here: - * returns EINVAL if AVRational.den is zero. + * qoffset is quantization offset: + * Encoders will return EINVAL if qoffset.den is zero. * the value (num/den) range is [-1.0, 1.0], clamp to +-1.0 if out of range. * 0 means no picture quality change, * negative offset asks for better quality (and the best with value -1.0), -- 1.7.10.4