[kdenlive] class documentation

[Karl-Philipp Richter]

Hi Dan,
Thanks for you input. I'm starting to get started :) In order to make
the best of your post, I created a little documentation patch at
https://bugs.kdenlive.org/view.php?id=3435.

Best regards,
Kalle

Am 14.01.2015 um 00:30 schrieb Dan Dennedy:
> On Mon, Jan 12, 2015 at 7:18 PM, Karl-Philipp Richter
> <richter at richtercloud.de <mailto:richter at richtercloud.de>> wrote:
> 
>     Hi,
>     I just got started with the kdenlive code from
>     git://anongit.kde.org/kdenlive <http://anongit.kde.org/kdenlive> and
>     realized that some classes don't have
>     documentation at all, e.g. `MeltJob::MeltJob`, `projectlist.cpp` hardly
>     contains comments in a relation to code of 1 to 100 - some have comments
>     in functions, but none have class or function comments. Do I have to do
>     something to generate the documentation in the source code?
> 
>     Background: I want to evaluate the necessary work to extract the clip
>     splitting functions in a reusable library - because it is just excellent
>     in kdenlive - and I don't seem to get started at all. I tried to
>     understand the code following its flow in `gdb`, but it's just too hard.
> 
>     Any help and pointers are appreciated.
> 
> 
> The library already exists as libmlt, but more precisely in its
> motion_est module (which is based on some really old FFmpeg code). The
> key thing to understand is that the motion_est filter collects the frame
> numbers for the shot changes into a list and sets it on the filter:
> 
> https://github.com/mltframework/mlt/blob/master/src/modules/motion_est/filter_motion_est.c#L962
> 
> Then, when you run  the output XML will contain this property of frame
> numbers:
> 
> melt ~/Movies/bbb_youtube_h264_499kbit.mp4 -attach motion_est -consumer
> xml all=1
> 
> The property value is a semicolon-delimited list. The number before the
> equal sign for each list item is the frame number.
> 
> -- 
> +-DRD-+