PDA

View Full Version : Documenting AviSynth api


Wilbert
17th September 2011, 15:49
As is well known the AviSynth api is poorly documented. The part which is documented is scattered among the wiki and this forum. Some of it can be found here http://avisynth.org/mediawiki/Filter_SDK .

A while ago I started to collect, rewrite and complete all the documentation and I can use some help. The idea is that the content in the above wiki link will be replaced by something which is well structured, complete and contains a lot of examples.

What I have done so far:

http://avisynth.org/mediawiki/User:Wilbert/Filter_SDK
http://avisynth.org/mediawiki/Cplusplus_API
http://avisynth.org/mediawiki/Cplusplus_API/VideoInfo
http://avisynth.org/mediawiki/C_API

As you can see a lot is still missing. I need people who are willing to correct and proof-read the stuff about the C++ api. I also need people who are willing to document the C api and create a c-version of the example plugins: Simple Sample 1.6 and Simple Sample 1.7. Any volunteers who are willing to help?

I also would like to hear your ideas about what I have done so far. Is it better than what existed, should it be organized in a different way, do other things need to be added, other relevant things which you can think off ???

kemuri-_9
18th September 2011, 03:03
I have a fair bit of experience in the C interface so I may be able to help there, granted I can find time to do so in my schedule.

If I were to write simple sample 1.6 and 1.7 in the C interface, how should it be provided to you?

Wilbert
18th September 2011, 12:21
I have a fair bit of experience in the C interface so I may be able to help there, granted I can find time to do so in my schedule.
That would be great!

If I were to write simple sample 1.6 and 1.7 in the C interface, how should it be provided to you?
If you provide it in html or doc format would be fine. Adding it to the wiki is fine too if you prefer that.

Wilbert
29th April 2012, 22:02
Some questions for those who know the internals better than i do:

1) SetCacheHints(CACHE_RANGE, frame_range)

Does frame_range denote the diameter or radius of frames to be cached? Is it the diameter prior to v2.56? The cache code is too complicated for me to follow.

2) PushContext / PopContext / PopContextGlobal

What's the difference between those and when is each used?

3) What's the difference between SetVar and SetGlobalVar?

4) What's the difference between CACHE_AUDIO_AUTO and CACHE_AUDIO?

TheFluff
1st May 2012, 13:14
3: the first one sets a local variable and the second sets a global. That is, the first one is equivalent to a simple "foo = bar", while the second is equivalent to "global foo = bar".