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