From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 8930A45CCE for ; Wed, 3 May 2023 18:01:17 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 5EEDF68BD03; Wed, 3 May 2023 21:01:13 +0300 (EEST) Received: from nef.ens.fr (nef2.ens.fr [129.199.96.40]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 1FC2F68A906 for ; Wed, 3 May 2023 21:01:07 +0300 (EEST) X-ENS-nef-client: 129.199.129.80 ( name = phare.normalesup.org ) Received: from phare.normalesup.org (phare.normalesup.org [129.199.129.80]) by nef.ens.fr (8.14.4/1.01.28121999) with ESMTP id 343I16ZK007631 for ; Wed, 3 May 2023 20:01:06 +0200 Received: by phare.normalesup.org (Postfix, from userid 1001) id 66007EB5BF; Wed, 3 May 2023 20:01:06 +0200 (CEST) Date: Wed, 3 May 2023 20:01:06 +0200 From: Nicolas George To: FFmpeg development discussions and patches Message-ID: References: <56ab5d9c-662c-83f6-a86c-50163b095c18@rothenpieler.org> MIME-Version: 1.0 In-Reply-To: <56ab5d9c-662c-83f6-a86c-50163b095c18@rothenpieler.org> X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3 (nef.ens.fr [129.199.96.32]); Wed, 03 May 2023 20:01:06 +0200 (CEST) Subject: Re: [FFmpeg-devel] Embedded 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 Content-Type: multipart/mixed; boundary="===============2125007249765541193==" Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: --===============2125007249765541193== Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="O7bTK+PNRKnz6hKo" Content-Disposition: inline --O7bTK+PNRKnz6hKo Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Timo Rothenpieler (12023-05-01): > Somewhat loosely related to this: >=20 > A frequent issue is that it's entirely non-obvious which global libavcodec > options a codec might make use of. > Having a way to self-document that would be amazing, so those options show > up in the --help output, ideally with their codec-specific default. Interesting remark. I also thought in the past that knowing if a certain component uses or ignore a particular common option would be useful, but I had not pushed the reflexion to that point. > The obvious idea I had for this was to utilize the FFCodecDefault struct > which already exists, maybe expanding it a tiny bit to allow the second > value to be NULL, indicating "This codec uses that option, but does not > change the default". >=20 > Main issue with this is that FFCodecDefault is a private struct. > It could just be made public and user-queryable, while making every curre= nt > user of it aware of possible NULL-values, which they can then just ignore. I can imagine a few other solutions. Note that the way we store the information in the library does not have to be the same as the way we give that information to the user. For example, internally we could store an array of used or unused options and to the user we can include only the used options in AVDocExcerpt. The most annoying task for this will be to look at the code component by component. Regards, --=20 Nicolas George --O7bTK+PNRKnz6hKo Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEE6ooRQGBoNzw0KnwPcZVLI8pNxgwFAmRSoWAACgkQcZVLI8pN xgxP5xAAhc47PnS+7Va/Ew3D8cdkpb+xcktujfsWRJ/HNRMLuYBb2S+LCakWpgVB Tl3zb592Q/PNWB5YJlaoJsTXaTskQvxGPuqmTB0pdxCfQgW/Ngs4vzL1WqU2j1CF ABk3OAoljvWCBIAjfh0lOHYuBo++lA0ChmhfpKGik5ch3yeDIfSM3oaejcVYUYGE 3rtFmfgX8DycUcGLrjhXXmNOoI9YuBs6oz0Ba8L57CA49y3ibgf+IrGavOE91xQx mgrGdr7itDeutR0TlLe6gQTFcQi8Tjp+70ePQ/iZ4JaDal+GQ4uqHTyBqVwBbh9g 07yz61iIqIFp78SLd7uNycr5wPdBGS/HOe/EMi9ZMoFH/Ls3AAassXzFFpN8aMna 6nJBAKyucPFWNhfJ0hTwX5c2+IMwm1yWrA9MtGA7aiv6xQEhr+qiVr95qTStv3UY +08wZNfDC1u2TYqUwNN9+70msWjWGWOJuh9024BCedXeLv5wl1VQdqO11tdN3fHj /O3vM09RYQT9Xj/gnLUKakh0A7swJxy1bwX1YRDi57VkBe9I8KNEqXZKzwBKdDNu mYiGkPALfrGOb+kGCKGOFoFLqtXPF/mmWi/pbdb5XX1xdfWMuXraZ+4XiMKxYj8J GdXZtzxR3nobEzgCl03qvlVZ4KJOh8Kt7xWy1OizaCg3uTSfvh0= =r1Mn -----END PGP SIGNATURE----- --O7bTK+PNRKnz6hKo-- --===============2125007249765541193== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe". --===============2125007249765541193==--