From patchwork Fri Jan 12 23:47:02 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marth64 X-Patchwork-Id: 45588 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a21:8199:b0:199:de12:6fa6 with SMTP id pd25csp176476pzb; Fri, 12 Jan 2024 15:47:27 -0800 (PST) X-Google-Smtp-Source: AGHT+IGSeZpsJtRCnXY6o52B2ugJN2qSX9/xRhaOMMIosyLWNw6MMF76ZEkHLwg7TyraNTRQIEC6 X-Received: by 2002:a05:6402:1d9c:b0:558:252c:21fc with SMTP id dk28-20020a0564021d9c00b00558252c21fcmr1969069edb.43.1705103246958; Fri, 12 Jan 2024 15:47:26 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1705103246; cv=none; d=google.com; s=arc-20160816; b=YCW+eIFNWlhm7p7dMekJ3xQu5Pjx56jg9hS7YIKHzR0T9bUk+sMJQwfl3OCNBDTtuJ UumjkX8CbjfFyaEg2itLQwKs73IqC4ewNje+13Ljcqo2fWKCyi/N0/X0J+hKgQidN13q GEu6aMxgcBZSDRUycCfU+vdtOOvDLRgx9vBtPn1qQrFQc2w0BYqmJBAjgtGH6LlNXv5e EVHBHcjWhw4dEfCbspYQRqzACOUZNAggVinIYKsPZL3fUGL+qIQKOq+FG9EEtv0eyTCN DCiiXymxdE78WureXFwO/kHFYoccMCd+BOaDJ/eEzuJo6XuRklkRkxty+wYf+gZmMEDQ 9enQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:cc:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:mime-version:message-id:date:to:from :dkim-signature:delivered-to; bh=QKx8edkHbqkSw3aYlcxuyXQ4SAz9L0xkgYS+SuVI0qE=; fh=PlWMzmI9LD2qGS7ipLrQl8z0iaQTLQLHzoGuXcBzpCg=; b=PD5qA8TOh3e8wKyiCAwIldh3tW1i00GLCaXeCoxILyNqOSWCRwB1smNTUiDiNYPd0c nH4FYnZ6vQifTndgSt37RuuIRJTFgUfvJuhaBb5ZliQ46bPGXPi1coi8+zr6zBh4i607 Venct7+zgAJDgAGpN/IK2Cf5XEFl52e04M9MCqjtuJG4EcX+F7I6YGvHMcrGgqmDLwBU HJLmsdoxNVy2aWM8YosiYzbR8B1kWR/VmjM8XZ8JhZ4tYyaA4wQu4KnudXU2uf851QT4 PRfsLWkIavuQUh02E+lg28T00aoUdBNLQcjtTSdscNffW05woSmjdzMQpPE+KBTtqJzY QAfQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@proxyid.net header.s=google header.b=iH+62dvy; 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 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id x99-20020a50baec000000b00554bcef1809si1735089ede.380.2024.01.12.15.47.26; Fri, 12 Jan 2024 15:47:26 -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=@proxyid.net header.s=google header.b=iH+62dvy; 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 Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 8D87068CE09; Sat, 13 Jan 2024 01:47:22 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-io1-f100.google.com (mail-io1-f100.google.com [209.85.166.100]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 96C4B68CB56 for ; Sat, 13 Jan 2024 01:47:16 +0200 (EET) Received: by mail-io1-f100.google.com with SMTP id ca18e2360f4ac-7bed9fb159fso138321339f.1 for ; Fri, 12 Jan 2024 15:47:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=proxyid.net; s=google; t=1705103235; x=1705708035; darn=ffmpeg.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=mmxAg1IUjMt+Fh0/iBsfjrkh2J9ZKEQRlWp8z873QXs=; b=iH+62dvy5Ip0tfFVjmbZZldWj6s2lWG62gPM0uKuEVXB9YP8pMUeUcYL7XVQu9mebx kHFm2sb/UhWQRLv1AsJPFSizQlBXDj+lDuwXLqZCYDMoINbZHjL3v5HreWiydAcOLNAu NCs9zrw+T2D4OSJPvxZ+v+WMmkNIoLQgD4s79zidoOk0UiIXOf5/olXBQHwtzO2gZNHC yJ23RBzxPxJXX5xt/MtsZcPqU0FOgC8RMTGEXj+dy2adQzS5RD/uktUqj2mRlZSGOR/P JOxl825t66uRJv+Dgf99aHguiF8A6sPhVvoWtwIaRKPb/+X2g5QQACmVkX/7qoDpxCyP bIQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705103235; x=1705708035; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=mmxAg1IUjMt+Fh0/iBsfjrkh2J9ZKEQRlWp8z873QXs=; b=Q3AE5C3UaDRfYpEiE5cDv0/k/MRlhjH+KBlTB/9TSq3BotbBAz4NpQPSt6QPDsDiXt 5JFGBLa8KimZGN/E8INV/JXvV54nmvE7MjF29QjlqD26VNohm4S+dI0BXVWEBvK2hvC/ jpPUMgS4WDVUAQ/E6TEtbjULztms0wLtNG+u3fNlGtNC5BpG/jm6DqRbaqlhBkQqjq1y Dki5Xdn0Rm8Jbior3OSoV7v3oGkVMWnfh2c4yCWYnpTXPlG6ZyQgAL2REVqhC8wSBnp0 bX/TzhjMjAcDGDp+cj713o/6DQTlTNbPk/6zB8zfn9ybEBsYfmGHZpnVkM0S6Mf5cfQm YYIg== X-Gm-Message-State: AOJu0YwGDYWxiqQUUmE66LxuVrmNdcHLOcVhktfA/l4V8+KzoukWo8Mu bt0LdTZIZoN7RjD9RAFd4s5rFXTlQXMUttV8y1xgrdDDt2FFu958ncvxZXwuctw0OA== X-Received: by 2002:a5e:c242:0:b0:7be:ea3e:a261 with SMTP id w2-20020a5ec242000000b007beea3ea261mr2349934iop.32.1705103234747; Fri, 12 Jan 2024 15:47:14 -0800 (PST) Received: from wsx-cc1-001.. (104-179-117-51.lightspeed.cicril.sbcglobal.net. [104.179.117.51]) by smtp-relay.gmail.com with ESMTPS id a21-20020a029995000000b0046ce8d5d493sm119285jal.23.2024.01.12.15.47.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Jan 2024 15:47:14 -0800 (PST) X-Relaying-Domain: proxyid.net From: Marth64 To: ffmpeg-devel@ffmpeg.org Date: Fri, 12 Jan 2024 17:47:02 -0600 Message-Id: <20240112234701.2711503-1-marth64@proxyid.net> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH] libavutil/timecode: fix parameter order in documentation X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 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 Cc: Marth64 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: GzVO9Y5QgqJL Signed-off-by: Marth64 --- libavutil/timecode.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/libavutil/timecode.h b/libavutil/timecode.h index 060574a172..fe0fc83576 100644 --- a/libavutil/timecode.h +++ b/libavutil/timecode.h @@ -98,8 +98,8 @@ uint32_t av_timecode_get_smpte(AVRational rate, int drop, int hh, int mm, int ss /** * Load timecode string in buf. * - * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long * @param tc timecode data correctly initialized + * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long * @param framenum frame number * @return the buf parameter * @@ -149,13 +149,13 @@ char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit); /** * Init a timecode struct with the passed parameters. * - * @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) * @param tc pointer to an allocated AVTimecode * @param rate frame rate in rational form * @param flags miscellaneous flags such as drop frame, +24 hours, ... * (see AVTimecodeFlag) * @param frame_start the first frame number + * @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) * @return 0 on success, AVERROR otherwise */ int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx); @@ -163,8 +163,6 @@ int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start /** * Init a timecode struct from the passed timecode components. * - * @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) * @param tc pointer to an allocated AVTimecode * @param rate frame rate in rational form * @param flags miscellaneous flags such as drop frame, +24 hours, ... @@ -173,6 +171,8 @@ int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start * @param mm minutes * @param ss seconds * @param ff frames + * @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) * @return 0 on success, AVERROR otherwise */ int av_timecode_init_from_components(AVTimecode *tc, AVRational rate, int flags, int hh, int mm, int ss, int ff, void *log_ctx); @@ -180,11 +180,11 @@ int av_timecode_init_from_components(AVTimecode *tc, AVRational rate, int flags, /** * Parse timecode representation (hh:mm:ss[:;.]ff). * - * @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). * @param tc pointer to an allocated AVTimecode * @param rate frame rate in rational form * @param str timecode string which will determine the frame start + * @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). * @return 0 on success, AVERROR otherwise */ int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx);