From patchwork Fri Feb 9 22:08:02 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marth64 X-Patchwork-Id: 46144 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a21:a586:b0:19e:8a94:b663 with SMTP id gd6csp1229771pzc; Fri, 9 Feb 2024 14:08:28 -0800 (PST) X-Google-Smtp-Source: AGHT+IHRAVBsT39ww+UZnMNB9osZEFROMTnNzut5BuXnOxLnTyUsaSreOFcMcQWcWPBbEebTrc3v X-Received: by 2002:a17:906:c201:b0:a3b:f8e0:10ed with SMTP id d1-20020a170906c20100b00a3bf8e010edmr230270ejz.44.1707516508435; Fri, 09 Feb 2024 14:08:28 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1707516508; cv=none; d=google.com; s=arc-20160816; b=WH0d3s3LWgtsCCYg22uOE/xobHWLHwjsJ8UlkXJqzXa8DqlaU3RQsYyqfI+WzO5M8+ 8O42XVLTpYlokkT+1kWCvjjWbrZkb6wIL1QD1gHyZcggK1nJJUUO3QSTvvFFoPJwq2j6 3z95FP1YrOH4y+TlTtnEtDNA+Kp0CORq/k1Zl5zQFAPPQ/9vKSeI6SfWwPfGtiXKExtl YD5ze2pDgNxInCpxuTy9Fu2JO/XSZQvyq4y1x38dwNA8VPyJxuVU8IigUwMQyO5TRvxA yhdngPkMGBR6o2bpFp/HP4ts8NRzpkjrAJygZppqDFOcHmmUk4H5Ovir/DBPo8yvan2i M6bw== 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=AR42R8EpclFUikMAetgJhZ2rrlkvclBho01LrCRx9Ws=; fh=mpmB+jisjNDl71IBBqNuOX90GUngGIVz7Qa0Z3M7na0=; b=K4WmQGVlR6Fanb83tzsX8OBRCmkJn0m7270Uy8MDtxcVLhYCGD9nxCj/KFjb1p5DH5 8vFmM1QIqzS5htO/nxUBIRt/EXgB/EkoKes/chaD8T1hlSkEmhecUG3pAd21nn0uqVoN E7wg+gyVg4uCTILtxeYLFk9Pcf0jOqDiQZMydlcwE3G2QTd+9aAPG9enLYvqTgftnuoG UzXQmKg0dqJUk7FlPLk2ANKFET/z5xtptR/TRj//eZRvL14WF3lQI5bDMNr0TkimGG70 cVbkP1mCgznDeVAlbVMMGehBR/g6Xno/znW/wXKVSMVoyBJ5Umiukkt5Q5/ZfspRmyGd eBuw==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@proxyid.net header.s=google header.b=XFMciZ55; 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 X-Forwarded-Encrypted: i=1; AJvYcCXpASfJD99CfOPH/qnxPxrmkF3S92GZ+X82/mj0mXhejVIbWV9ixtxdswCJtCki30HuxoR8/muuApQIS5plfmBe7yGFGMEukrMiv63Gb22XiWtQArfnPw459A5DFnGTxonM2/+txRipJbqZbhu8RnC8aAI2oxpUyBHF4a9POwL8EV3u+U5blccwEdgmsaZ32R8XU428bVfIpHzytfqJQ7Vu5uzUkjG9RYzSIzicGt0Qzlibc4l3tbm/rxD0K2op7hHB+WTOPSJfs2+MjCNykTr1EcqCX0B8+6nlINAJOo2QgNpDfjWdXIPQfoIah+rCrPT6hEqqJjSu95ZUl3QqcqHJI2NgwUKtaAkoLCrtX3IguDCB2Eo3oVp6EXUP17CLhYGG20MgKSicuTODO8c3a+L82PeURlP6Mh+TE28sCdb083vVsXY7gQjMFT1SxfBNaJxRul7qajPMqlrKC8v3+pzlbGcsDBAZ4ghZKbfCtqm3/Ipw2MZ+uMUojEoBiLtISHOPKWenXXmtSU3+XultA49nf2Y174Dzw1pnarg6Yfn6VF0u0QbQJ13ZQCmiDUxdtO6OXx+OIx4ff47AczJu8OLfvTFqDySAS0V+d2mgQUnaRFsqtjtPEMia4qs3EFZYHakX5mlLrJW47gS3ZhWBeuI0pnpFilCHcAO4z7zEhwsna9SufGMlSEwACUEuIXUxIY++HK4KEE0GUFpUpQWKyJXnU9luHfWiOTwpPM/qz7rpD01+xhj9zAPa6Dmx06NtlHBEzkySVuGXSH6e4wEO7UsAR3vJhxT1dTsVg1vyt1DJqdNANOJ6oss5ZF0CkpprqCaJQ+G0JJ0shHAyiWHJ3VrecaEDZvScEk94LgvHnttEvojtqn0DTtcVZbBSdz/6ZJifIpIvfm03RxopUumkPQ4nnJryeZx5ZmoOvwk2/BMhNJmsDABtEgGU0SybX6A58DAwZu NJtGS4qxM0g2qNoVHYg/q0IqJmf6tEPIsEsMJnuC2CLmU860SfHM++I+uUsx5SiVd+ESc6zPmJeqzc7V6z9xZiehO5/8QT3YhkfGnYuvUiTTLiLNTaG7kFP8xty6AvT6IMf6LZdy8hPa+uE80QJKQxU+z4lPWnSKgnuud5KIYthckJNaKWHgFdnfyr21uKWAm9muHOYa/xX7Vs9PcnnQ2pT8EornusptAFI2CxKcmFJ/G9OCEP7vjVlO8wN6uhtN+dP3b9ZrhwyJBP7y3Lkr0i7asc5ja8Ze/Mwx9qJIuyVeJBG8ujRytxhbi7IHjLBnbbzt4BzZKz2qoBXBqNqogFD7r7xC7BpJ3Iq5sUX5XBjSmj3uXhxbcuUWrnL1n97n7+g87H/igXnvs1TplTftIug6XD61XtWES/WCua4N8EZjyy6w2XWpM+ryEDoBSrJT1qfA6HXoqasOgdTxLRwgpQfyzfZv5eTSon4tYcP7eF/hwetEtigHhr5T7blQGV6rxKACGH5lJcf6KiWBr/bc91Ly64vFnLBK/XhsjV2O3Pvgsayrkvp8Giyahq+QjRjMB4WKSwNB0UDLcTiVuG7j+VEVIOvpNuSNfEHQAbhL+6y0qUT5jcVAegmRMFYZ7i Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id a15-20020a17090640cf00b00a3c10deb3adsi381900ejk.289.2024.02.09.14.08.28; Fri, 09 Feb 2024 14:08:28 -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=XFMciZ55; 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 2311668D0D3; Sat, 10 Feb 2024 00:08:26 +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 0ABA668CEC8 for ; Sat, 10 Feb 2024 00:08:20 +0200 (EET) Received: by mail-io1-f100.google.com with SMTP id ca18e2360f4ac-7bc32b04dc9so49606439f.2 for ; Fri, 09 Feb 2024 14:08:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=proxyid.net; s=google; t=1707516498; x=1708121298; 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=dABfZRz6H9EvQ9N68n1IGpfJNRZDQtF8p5QV6MU7QUQ=; b=XFMciZ55Cbeiiy7D6To5FxbJjNOteebF7g3APLyhV8YEOwygzJiwVvA9ZykJwWDggt piFR9MPl2eRDypiIub7EP6Swe6nOSQ2QdyTpE8oQ+q9NZrb15Mh9RKYVKoiyW5JRJc7D 3UleNJl3rZaS6W0rtQ3iDMIBD+U685zHwgSMpBIWuWWniCYw4dhpvqfmd7jAaN6/2ODo RelGvd39zrAKje1DHMpIEAxDWoGy9Dor7CouLxQHbGmU4u+craZEHTFRJ0Yad9mC/wch RHH1NYn4KCCJL6zP7P3wcvUsYC0llLRX90xYR137U+PWrcAkY+T03Qf9fJOvJWYb2I6a UgJQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707516498; x=1708121298; 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=dABfZRz6H9EvQ9N68n1IGpfJNRZDQtF8p5QV6MU7QUQ=; b=aEKmwnswHKAjZSQR1gDOJpmHsGIzmRuo8BWn3Mnnmyc4xR7LpSFQ8j3xaAbYxKM5PU gkNPJde+vMwGDVibuQvTjRcW82uX8LaZK/BnB+8oMImPT1CuHJC/Zgg5sbFZczG0drX3 FjqPjOj7ngQDgCwdUYvgXEIFDndcRc+1aEc4gtz6QAmTaFKsx/fZJ/7K4VZBM55ZQykS +DCySP5g5EklYHdAOvR0B0RHOfwAudT9m4SaEdluxP2LHh7watIK7aJmRtH31fseTc4a s2vwQ3d+aHcHC6g/UU8TjX2tfCUajVL4PBkNTw0ZSJjHoK28W19xQeQlxEf8KO7bGtrp GOgA== X-Gm-Message-State: AOJu0YwTa6XIpCFxgwrQzrP3gjnRrS0vBxrVkrdqdMLD+eDKsq1hTDi5 3J0RBv6PKUM+3eK1oXa8vhQNzElxwKg+7kpU4L6JB2Ewkvh5w0zFqCDTqdHOKXEn6NnzwdqKqoE UnGdq2mA+1OrBOd3OJA1uLM+jOVjki7ma+1SIQEbq X-Received: by 2002:a05:6e02:1ba4:b0:363:b5b6:30d6 with SMTP id n4-20020a056e021ba400b00363b5b630d6mr776461ili.18.1707516498080; Fri, 09 Feb 2024 14:08:18 -0800 (PST) Received: from wsx-cc1-001.. (c-76-141-249-38.hsd1.il.comcast.net. [76.141.249.38]) by smtp-relay.gmail.com with ESMTPS id p12-20020a056e02144c00b00363d09a1729sm70099ilo.30.2024.02.09.14.08.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 09 Feb 2024 14:08:18 -0800 (PST) X-Relaying-Domain: proxyid.net From: Marth64 To: ffmpeg-devel@ffmpeg.org Date: Fri, 9 Feb 2024 16:08:02 -0600 Message-Id: <20240209220801.1583974-1-marth64@proxyid.net> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH] avformat/avformat.h: elaborate documentation for avformat_open_input() on error condition 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: d4h+5AB4tpD2 Signed-off-by: Marth64 --- libavformat/avformat.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 5d0fe82250..070ed7023d 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -2175,7 +2175,7 @@ int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt, * which case an AVFormatContext is allocated by this * function and written into ps. * Note that a user-supplied AVFormatContext will be freed - * on failure. + * on failure and its pointer set to NULL. * @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. @@ -2184,7 +2184,8 @@ int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt, * 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. + * @return 0 on success; on failure: frees ps, sets its pointer to NULL, + * and returns a negative AVERROR. * * @note If you want to use custom IO, preallocate the format context and set its pb field. */