[vlc-devel] Deinterlacer documentation

[Jean-Baptiste Kempf]

Hello,

On Sun, Apr 03, 2011 at 05:12:20PM +0300, Juha Jeronen wrote :
> This is still some time into the future, but after I'm done with the
> IVTC patch and the big refactor to the deinterlacer, I'm planning to
> write some documentation for the module.

Amazing.

> Developer documentation is needed to keep the deinterlacer
> non-intimidating for new developers. In this part, the structure of the
> (upcoming) refactored module will be described, and practical hints
> given as to how to add a new deinterlacing mode (which files to look at,
> what the flags in filter_sys_t mean and how to add new ones if needed,
> etc.). How to handle the different chroma formats will be explained
> briefly. There will be a text file (probably called HACKING) in the
> (upcoming) deinterlacer directory when I'm done with this.
> 
> The second thing is, the user documentation for a general semi-technical
> audience needs to be updated after Phosphor and IVTC. The wiki page
> http://wiki.videolan.org/Deinterlacing is a good starting point.

Yes for user

http://wiki.videolan.org/Documentation:Hacker%27s_Guide/Video_Output
http://wiki.videolan.org/Documentation:Hacker%27s_Guide
for dev documentatoin.

> Here's why I'm posting this - is there anything specific any of you
> would like to see explained in the user documentation for the deinterlacer?

Yes, how are the deinterlaced frames stored...
I had to write a decoder (crystalhd) and seriously I had a lot of
difficulties for interlaced mode.

> 4) Yadif needs a better explanation - what does the algorithm do, on a
> general level? I'll try, but I'm not sure if I can help with this.

Only MN should know :D

> 5) IVTC needs to be documented. I think it's sufficient to say that this
> filter attempts to remove telecine, mention that the main use case is
> NTSC anime, and "for further information" point to the explanation of
> telecine.

Sure.

> 7) Recommendations should be revised after Phosphor and IVTC. Whether to
> choose Bob, Linear or Phosphor is mainly a matter of taste. For
> telecined input, IVTC is clearly The Right Thing.
And yadif ?

Best Regards,

-- 
Jean-Baptiste Kempf
http://www.jbkempf.com/
+33 672 704 734