From: Michael Niedermayer <michael@niedermayer.cc>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Subject: Re: [FFmpeg-devel] [PATCH v5 0/4] Explain what "context" means
Date: Fri, 24 May 2024 03:50:52 +0200
Message-ID: <20240524015052.GX2821752@pb2> (raw)
In-Reply-To: <20240523200116.740461-1-ffmpeg-devel@pileofstuff.org>
[-- Attachment #1.1: Type: text/plain, Size: 2153 bytes --]
On Thu, May 23, 2024 at 09:00:39PM +0100, Andrew Sayers wrote:
> NOTE: this patchset depends on [1], and should not be applied before that.
>
> I think it's important to guide readers between parts of FFmpeg, because
> learning how the pieces of the puzzle fit together is a big part of the
> newbie experience. So this patchset replaces the "@ref Context for foo"
> statements in public structs with "@see" blocks, giving us a hook we can
> hang more links on in future.
>
> That said, there's a rule against internal links from private structs,
> so I've removed the @ref's from them. By the way, is this rule written
> somewhere? If not, where would be a good place to write it?
> And either way, it would be good to link to this as part of [2].
>
> Previous patches had to change the language for many structs, but "@see" blocks
> avoid the need to include those changes in this patchset. Rather than waste
> that work, I've temporarily moved those changes to the final patch in this set.
> My feelings about that last patch aren't strong, but I guess I'll propose them
> in a separate thread unless anyone wants them here or chucked altogether.
>
>
> I've rewritten AVOptions and AVClass based on feedback. The new version
> reflects a hypothetical that's been going round my head all week...
>
> Imagine you wanted to write a system that nudged people to try new codecs.
> It might say e.g. "you seem to be using H.264, would you like to try H.265?"
> Implementing that would probably involve a struct like:
>
> struct AVOldNew {
> AVClass* old;
> AVClass* new;
> };
AVClass would describe the internal decoder structures. This would not be
correct at all in this example.
Thats like handing a man 2 CAD documents about 2 engines of 2 cars
If you wanted to suggest to get a tesla instead of a ford. One would have to
describe the 2 cars and their differences
thats 2 AVCodecDescriptor maybe
thx
[...]
--
Michael GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB
It is a danger to trust the dream we wish for rather than
the science we have, -- Dr. Kenneth Brown
[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]
[-- Attachment #2: Type: text/plain, Size: 251 bytes --]
_______________________________________________
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".
next prev parent reply other threads:[~2024-05-24 1:51 UTC|newest]
Thread overview: 84+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-18 15:06 [FFmpeg-devel] [PATCH 1/3] doc: " Andrew Sayers
2024-04-18 15:06 ` [FFmpeg-devel] [PATCH 2/3] lavu: Clarify relationship between AVClass, AVOption and context Andrew Sayers
2024-04-18 15:06 ` [FFmpeg-devel] [PATCH 3/3] all: Link to "context" from all contexts with documentation Andrew Sayers
2024-04-20 7:25 ` [FFmpeg-devel] [PATCH 1/3] doc: Explain what "context" means Stefano Sabatini
2024-04-20 12:18 ` Andrew Sayers
2024-04-20 16:13 ` Stefano Sabatini
2024-04-20 12:19 ` [FFmpeg-devel] [PATCH v2 " Andrew Sayers
2024-04-20 12:19 ` [FFmpeg-devel] [PATCH v2 2/3] lavu: Clarify relationship between AVClass, AVOption and context Andrew Sayers
2024-04-20 12:19 ` [FFmpeg-devel] [PATCH v2 3/3] all: Link to "context" from all contexts with documentation Andrew Sayers
2024-04-20 16:48 ` [FFmpeg-devel] [PATCH v2 1/3] doc: Explain what "context" means Stefano Sabatini
2024-04-20 22:17 ` Andrew Sayers
2024-04-22 8:02 ` Stefano Sabatini
2024-04-22 15:56 ` [FFmpeg-devel] [PATCH v3 0/3] all: Link to "context" from all contexts with documentation Andrew Sayers
2024-04-22 15:56 ` [FFmpeg-devel] [PATCH v3 1/3] doc: Explain what "context" means Andrew Sayers
2024-04-22 17:05 ` Stefano Sabatini
2024-04-29 9:10 ` Andrew Sayers
2024-05-02 10:03 ` Andrew Sayers
2024-05-05 7:29 ` Stefano Sabatini
2024-05-05 21:04 ` Andrew Sayers
2024-05-22 10:37 ` Stefano Sabatini
2024-05-22 12:47 ` Andrew Sayers
2024-05-25 9:00 ` Stefano Sabatini
2024-04-29 9:24 ` [FFmpeg-devel] [PATCH v4 1/4] " Andrew Sayers
2024-04-29 9:24 ` [FFmpeg-devel] [PATCH v4 2/4] lavu: Clarify relationship between AVClass, AVOption and context Andrew Sayers
2024-04-29 9:24 ` [FFmpeg-devel] [PATCH v4 3/4] all: Link to "context" from all contexts with documentation Andrew Sayers
2024-05-02 11:01 ` Lynne
2024-05-02 11:14 ` Andrew Sayers
2024-05-02 13:00 ` Zhao Zhili
2024-05-02 13:27 ` Andrew Sayers
2024-05-02 13:39 ` Zhao Zhili
2024-04-29 9:24 ` [FFmpeg-devel] [PATCH v4 4/4] lavf: Add documentation for private "Context" classes Andrew Sayers
2024-05-05 8:31 ` [FFmpeg-devel] [PATCH v4 1/4] doc: Explain what "context" means Andreas Rheinhardt
2024-05-05 10:34 ` Andrew Sayers
2024-04-22 15:56 ` [FFmpeg-devel] [PATCH v3 2/3] lavu: Clarify relationship between AVClass, AVOption and context Andrew Sayers
2024-04-22 15:56 ` [FFmpeg-devel] [PATCH v3 3/3] all: Link to "context" from all contexts with documentation Andrew Sayers
2024-05-15 15:54 ` [FFmpeg-devel] [PATCH v4 0/4] Explain what "context" means Andrew Sayers
2024-05-15 15:54 ` [FFmpeg-devel] [PATCH v4 1/4] doc: " Andrew Sayers
2024-05-22 9:31 ` Stefano Sabatini
2024-05-22 16:07 ` Andrew Sayers
2024-05-25 9:49 ` Stefano Sabatini
2024-05-26 12:06 ` Andrew Sayers
2024-05-28 17:24 ` Stefano Sabatini
2024-05-29 10:10 ` Andrew Sayers
2024-05-29 10:50 ` Andrew Sayers
2024-05-29 11:06 ` Paul B Mahol
2024-05-29 14:18 ` Andrew Sayers
2024-05-29 16:06 ` Stefano Sabatini
2024-05-23 20:00 ` [FFmpeg-devel] [PATCH v5 0/4] " Andrew Sayers
2024-05-23 20:00 ` [FFmpeg-devel] [PATCH v5 1/4] doc: " Andrew Sayers
2024-05-25 11:00 ` Stefano Sabatini
2024-05-23 20:00 ` [FFmpeg-devel] [PATCH v5 2/4] lavu: Clarify relationship between AVClass, AVOption and context Andrew Sayers
2024-05-25 9:57 ` Stefano Sabatini
2024-05-23 20:00 ` [FFmpeg-devel] [PATCH v5 3/4] all: Link to "context" from all public contexts with documentation Andrew Sayers
2024-05-23 20:00 ` [FFmpeg-devel] [PATCH v5 4/4] all: Rewrite documentation for contexts Andrew Sayers
2024-05-24 1:50 ` Michael Niedermayer [this message]
2024-05-24 9:43 ` [FFmpeg-devel] [PATCH v5 0/4] Explain what "context" means Andrew Sayers
2024-05-15 15:54 ` [FFmpeg-devel] [PATCH v4 2/4] lavu: Clarify relationship between AVClass, AVOption and context Andrew Sayers
2024-05-22 10:04 ` Stefano Sabatini
2024-05-15 15:54 ` [FFmpeg-devel] [PATCH v4 3/4] all: Link to "context" from all contexts with documentation Andrew Sayers
2024-05-15 16:46 ` Lynne via ffmpeg-devel
2024-05-16 11:25 ` Andrew Sayers
2024-05-15 15:54 ` [FFmpeg-devel] [PATCH v4 4/4] lavf: Add documentation for private "Context" classes Andrew Sayers
2024-05-22 10:08 ` Stefano Sabatini
2024-05-22 14:47 ` Andrew Sayers
2024-05-22 15:24 ` Andreas Rheinhardt
2024-05-22 16:54 ` Andrew Sayers
2024-06-04 14:47 ` [FFmpeg-devel] [PATCH v6 0/4] doc: Explain what "context" means Andrew Sayers
2024-06-04 14:47 ` [FFmpeg-devel] [PATCH v6 1/4] " Andrew Sayers
2024-06-05 8:15 ` Anton Khirnov
2024-06-12 20:52 ` Stefano Sabatini
2024-06-13 14:20 ` Andrew Sayers
2024-06-15 9:17 ` Stefano Sabatini
2024-06-16 18:02 ` [FFmpeg-devel] Development process for explaining contexts (was Re: [PATCH v6 1/4] doc: Explain what "context" means) Andrew Sayers
2024-06-16 21:20 ` Paul B Mahol
2024-07-01 22:16 ` Stefano Sabatini
2024-07-02 9:56 ` Andrew Sayers
2024-07-06 11:33 ` Stefano Sabatini
2024-06-04 14:47 ` [FFmpeg-devel] [PATCH v6 2/4] lavu: Clarify relationship between AVClass, AVOption and context Andrew Sayers
2024-06-05 10:34 ` Stefano Sabatini
2024-06-05 12:46 ` Andrew Sayers
2024-06-04 14:47 ` [FFmpeg-devel] [PATCH v6 3/4] all: Link to "context" from all public contexts with documentation Andrew Sayers
2024-06-05 8:12 ` Anton Khirnov
2024-06-05 12:51 ` Andrew Sayers
2024-06-04 14:47 ` [FFmpeg-devel] [PATCH v6 4/4] all: Rewrite documentation for contexts Andrew Sayers
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240524015052.GX2821752@pb2 \
--to=michael@niedermayer.cc \
--cc=ffmpeg-devel@ffmpeg.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
This inbox may be cloned and mirrored by anyone:
git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git
# If you have public-inbox 1.1+ installed, you may
# initialize and index your mirror using the following commands:
public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
ffmpegdev@gitmailbox.com
public-inbox-index ffmpegdev
Example config snippet for mirrors.
AGPL code for this site: git clone https://public-inbox.org/public-inbox.git