Filter/Script authors - submit your documentation to the Wiki

[raffriff42]

If you have written a filter or nontrivial script and you would like to submit it for consideration on the Avisynth wiki (http://avisynth.nl/), here is a template to get you started: http://avisynth.nl/index.php/ExampleFilter

It has places to post the download link, document your arguments, provide some sample code, et cetera.

I've quoted the template instructions below:

Right-Click the Edit tab at the top of the page (http://avisynth.nl/index.php?title=ExampleFilter&action=edit) and open in a new browser tab. Keep these instructions open for reference.
In the new tab, you will see a page full of Wiki code; copy everything below "END INSTRUCTIONS" to the clipboard.
In the new tab, edit the page URL:

Replace ?title=ExampleFilter&action=edit with /YourFilterName
Your filter name should be one word - no spaces - but this is not mandatory.
First letter must be UPPERCASE due to Wikicode requirements.
Don't forget to remove the "?" and replace it with "/"

Hit Enter. If the title is already in use, you will be taken to that page.

If the page already exists, hit your browser's Back button.
Try a different title: Rename your filter, or add a suffix like "/CoolFilter (updated)"

If your title is unique, you will be greeted with the "There is currently no text in this page" banner. Click on the "edit this page" link.
Paste the source code you copied in Step 2.
Areas that need your attention are marked with HTML comments <!-- like this -->. Fill in as much information as you can. Leave the rest.
Click the Show Preview button to see how your page will look.
Click the Save page button to create the new page.
If you did something wrong, Click the Edit tab and fix it.


Please don't worry about formatting or incomplete information; just do the best you can.
A more experienced user will come along and clean up the page for you, and add a link to your page @External filters ('http://avisynth.nl/index.php/External_filters') (don't do this yourself).(Hmmm, I suppose you could submit documentation for a filter or script even if you aren't the author...)

*EDIT: you need to register (http://avisynth.nl/index.php?title=Special:UserLogin) to edit on this wiki - there is no anonymous editing like there is on Wikipedia.

*EDIT: you might want to read, How can I contribute to the AviSynth documentation project? (http://avisynth.nl/index.php/Avisynth_wiki:Community_portal#How_can_I_contribute_to_the_AviSynth_documentation_project.3F)

[Reel.Deel]

This should make it easier for people to contribute.Thanks raffriff42 :)

[vcmohan]

can this thread be made sticky? Otherwise it will be out of normal display pages of the forum and searching will be a problem, without knowing name of thread.
Good work. Will get uniformity.

[vcmohan]

I do not see edit tab

[raffriff42]

You need to create an account first. Sorry, I should have mentioned that small detail...
http://avisynth.nl/index.php?title=Special:UserLogin

[Reel.Deel]

How about adding this to the 'get involved (http://avisynth.nl/index.php/Get_involved)' page?

[raffriff42]

I want somebody with no prior Wiki knowledge to guinea pig it! Tell me what about it sucks!

(I wanted to make a nice Web form but the Wiki doesn't support that, so I can only hope this edit-the-template model works well enough for most filter/script developers)

[vcmohan]

You need to create an account first. Sorry, I should have mentioned that small detail...
http://avisynth.nl/index.php?title=Special:UserLogin

I already have an account with avisynth and logged in. What I see is a 'discussion' tab. On clicking it, with a message that I am allowed, it took me to that page. I did not see edit tab.

[vcmohan]

I also suggest that you may get this thread listed under sticky threads, as otherwise it will not be normally shown after a few days. One need to know the thread name to search,

[foxyshadis]

I already have an account with avisynth and logged in. What I see is a 'discussion' tab. On clicking it, with a message that I am allowed, it took me to that page. I did not see edit tab.

I think Wilbert has to authorize your account first.

[Wilbert]

You should be able to edit pages if you email address is confirmed (provided you added one of course).

@vcmohan, what is your user-id?

[vcmohan]

You should be able to edit pages if you email address is confirmed (provided you added one of course).

@vcmohan, what is your user-id?

mine is vcmohan

[Reel.Deel]

mine is vcmohan

That name does not show up on this list (http://avisynth.nl/index.php?title=Special:ListUsers&limit=500). All of the old accounts from the old avisynth.org where not transferred to the new domain (avisynth.nl).

[vcmohan]

I already have an account with avisynth and logged in. What I see is a 'discussion' tab. On clicking it, with a message that I am allowed, it took me to that page. I did not see edit tab.

Tried to create a new account. Always rejects stating incorrect or missing confirmation code. Does it require a set answer for the captcha question ?

[Wilbert]

Does it require a set answer for the captcha question ?
Yes it does. If you can't get it to work i will create an account for you.

[vcmohan]

Yes it does. If you can't get it to work i will create an account for you. I tried Discrete Cosine Transform, Cascading Style Sheets. Did not work. Tried Direct Cash Transfer. Did not work. Please create one for me.

[StainlessS]

Well what is the password, do tell Wilbert, I'm intrigued, is it really "Dual-clutch transmission" ?

[vcmohan]

I am unable to proceed. As per instructions I have replaced
#* Replace '''?title=ExampleFilter&action=edit''' with
#* '''/AdaptiveMedian'''
and hit enter. Nothing happens. In preview I see the name.
Am I doing something wrong?

[raffriff42]

Step by step:

Go to ExampleFilter (http://avisynth.nl/index.php/ExampleFilter), click Edit
https://www.dropbox.com/s/a53lgiquwuh80k4/avisynth-wiki-template-01-start.png?raw=1


Right-click, Select All.
Right click again, Copy.
https://www.dropbox.com/s/zcmtvhqdmnvewyo/avisynth-wiki-template-02-copy.png?raw=1


Replace ?title=ExampleFilter&action=edit
with /YourFilterName
https://www.dropbox.com/s/h47mwlnoqdsaood/avisynth-wiki-template-03-select.png?raw=1

https://www.dropbox.com/s/7v8b9sqpe7m6o2a/avisynth-wiki-template-04-title.png?raw=1


Hit Enter or the equivalent browser button.
https://www.dropbox.com/s/osomhsm8hi20irz/avisynth-wiki-template-05-title%2Bgo.png?raw=1


Click Edit this page.
https://www.dropbox.com/s/5c6vuyopojido35/avisynth-wiki-template-06-edit.png?raw=1


Right click, Paste.
https://www.dropbox.com/s/42q78ij54djee7f/avisynth-wiki-template-07-paste.png?raw=1


Continue with instructions in the first post (http://forum.doom9.org/showthread.php?t=171356).

[vcmohan]

many thanks. It is clear now.

[vcmohan]

I now get the page which states that currently no text in this page. But the last link in that sentence "edit this page" is missing. Looks still I do not have permission. I have logged in OK as it shows on top of page

[Wilbert]

It's setup in such a way that only after ten edits you can add pages. So that might the problem you are experiencing. For some reason i can't promote you to that group, so you will have to make ten edits first.

I understand this setup is a bit annoying, but i hope you remember what happened to avisynth.org.

edit: i managed to add you to the group autoconfirmed. You should be able to add pages.

[raffriff42]

Huh, I don't think this is gonna work. Too complicated. :(

Maybe a simple questionnaire could be submitted to this forum - no Wiki knowledge or privileges would be required.

An experienced Wiki editor (probably Wilbert, Reel.Deal or myself) would do the conversion to Wiki code. More work for us. Eventually a script could be written to automate the conversion, at least partially.

Here's the kind of questionnaire I was thinking of: [Abstract] ########################
author_name=
author_URL=http://www.example.com
version=1.0
license_URL=http://www.gnu.org/licenses/gpl-2.0.txt
download_URL=http://www.example.com
discussion_URL=http://forum.doom9.org/showthread.php?t=171356



[Compatibility] ########################
Avisynth_2.60_supported=true
Avisynth_plus_supported=true
Progressive_source_supported=true
Interlaced_source_supported=true
RGB24_source_supported=true
RGB32_source_supported=true
YUY2_source_supported=true
YV12_source_supported=true
YV24_source_supported=true
YV16_source_supported=true
YV411_source_supported=true
Y8_source_supported=true
MMX_required=false
SSE2_required=false
SSE3_required=false
SSE4_required=false


[Requirements] ########################
## Plugins required to run this filter

## Example:
URL=http://avisynth.nl/index.php/MaskTools2
label=MaskTools2 2.0a48+

URL=http://avisynth.nl/index.php/RemoveGrain_v1.0b/RemoveGrain
label=RemoveGrain - part of the RemoveGrain v1.0b package.


[Functions] ########################
## Avisynth function declaration(s)

## Example:
function=DirectShowSource(string filename, float "fps", bool "seek", bool "audio",
\ bool "video", bool "convertfps", bool "seekzero", int "timeout", string "pixel_type",
\ int "framecount", string "logfile", int "logmask")


[Arguments] ########################
## A list of argument descriptions for the preceding function(s)

## Examples:
argument=fps
default=C.FrameRate
range=0.0001,1000.0
description=This is sometimes needed to specify the framerate of the video.

argument=seek
default=true
description=Set full seeking support.

argument=pixel_type
default=AUTO
description=limits the acceptable video stream subformats
allowed_values=YV24,YV16,YV12,YUY2,AYUV,Y41P,Y411,ARGB,RGB32,RGB24,YUV,YUVex,RGB,AUTO,FULL



[Short description] ########################
## a one-sentence description
Description=


[Long description] ########################
## Free form descriptive text goes here.


[Examples] ########################
## Code example(s) go here.

## This is some example code.
Avisource("example.avi")
ExampleFilter(blah=true)
#(end example)

## This is another example.
Avisource("example.avi")
ExampleFilter(blah=false)
#(end example)

#### (end of file)

[vcmohan]

I have a few comments/suggestions
1. The plugin versions which are specific for 2.6 do not work for 2.5.8 As the name, function, parameters are however identical, a provision to have a second download link be given. I tried adding a second download line but found that link was displayed against category.
2. Not all plugins have separate threads for discussion. Some have only announcements and some have both. Also author will have a link for fuller description of plugin. Provision for this link also may be given. I tried to smuggle this link at the end of one line description. 'click me for a full description". It worked but the link appears in normal text color.
3. version: I do not know how to get this info into the dll. I do not find any provision in the VC++ compiler, nor will my file browser lets me add this.

[foxyshadis]

1. If you have two downloads, add the second after the first, as in: 3=2.6: [http://myfilter.com/awesome26.zip Awesome]; 2.5: [http://myfilter.com/awesome25.zip Awesome]
A second line will screw up the wiki syntax, so you just have to add it on the same line, or add wiki line breaks.
2. Pick the most important one, or link both with relevant text if they're both important.
3. Add a version resource. If you don't want to, there are lots of alternatives (http://www.codeproject.com/Articles/37133/Simple-Version-Resource-Tool-for-Windows). The version tag is just a convenience, though; as long as the most recent is the latest that's all that matters for most plugins. Backward compatibility usually is only a pressing concern for a few plugins.

[vcmohan]

1. If you have two downloads, add the second after the first,.
Thanks. I discovered this. Please have a look at AdaptiveMedian wiki page. I could also include a link to author.s page.

[raffriff42]

That looks great, vcmohan, it just needs a little cleaning up, which is to be expected.

[vcmohan]

I have several plugins having more than one function. Specially EffectsMany and TransAll. Each have over 20 functions. I shudder at coding wiki page for them. May be just point to my HTML pages should be enough.
I was once prodded by an user to provide as many optional control parameters as possible, and leave it user to use or not use them. While coding wiki page I am repenting doing just that. Coding parameters is too much of a pain.

[StainlessS]

VCMohan, just give them a taste, and point to better description.

RT_Stats has somthing like 163 funcs, No way that could be compessed into a little page.

[vcmohan]

I have posted several of my plugins in the wiki. I find irksome some requirements.
1. the calling sequence is to be given as
fname{clip, int x, int y, string s, float f)
The order of parameter type and name are reverse to actual plugin source code. In that it is
fname([x]i[y]i[s]s[f]f)

[feisty2]

@vcmohan
can you port your "FQSharp" deconvolution filter to 16bpc when you got time? I found it quiet useful, thx

[foxyshadis]

I have posted several of my plugins in the wiki. I find irksome some requirements.
1. the calling sequence is to be given as
fname{clip, int x, int y, string s, float f)
The order of parameter type and name are reverse to actual plugin source code. In that it is
fname([x]i[y]i[s]s[f]f)

Seems that's more Ben Rudiak-Gould's fault, everything but the filter definition uses the first format (including Avisynth functions). What can you do?

[vcmohan]

@vcmohan
can you port your "FQSharp" deconvolution filter to 16bpc when you got time? I found it quiet useful, thx

Do you mean that this plugin be ported to vapoursynth to be able to handle 16 bit per color?

[feisty2]

Do you mean that this plugin be ported to vapoursynth to be able to handle 16 bit per color?

I mean the latter, to be able to process 16bits bit depth, thank you for your work

[feisty2]

@vcmohan
Right now, I really need an avisynth Fqsharp, Im not ready to make the whole process chain under vapoursynth yet, since some required functions have not been implemented in vs mvtools yet

[Reel.Deel]

@feisty2

This thread is about the wiki and its documentation and clearly not about requesting features for plugins. Please post this in the appropriate thread (http://forum.doom9.org/showthread.php?t=120496), if there isn't one, start a new one, easy as that. I hate to be the one who nitpicks but you've done this too many times. Another thing, while I'm at it, sometimes is good practice to just edit your post and add to it instead of posting consecutively 2 or 3 times, especially when is something about nothing.

[feisty2]

Okay, will keep that in mind next time

[violao]

Hi,

I created an account and confirmed my email address but still don't see edit tab. If I try to enter URL manually, such as http://avisynth.nl/index.php?title=Removeblend&action=edit then I get the following error:

Permission error
You do not have permission to edit this page, for the following reason:
You do not have permission to create new pages.

Can someone promote my account (account name: violao) so that I can add updated version of removeblend to the wiki?

Thanks!

[ChiDragon]

Did you read post #22 (http://forum.doom9.org/showpost.php?p=1700301&postcount=22)? Apparently you need to make 10 regular edits before you have permission to add a page, unless a higher-up manually intervenes.

[Reel.Deel]

@violao

I started a new page for you (still needs lots of work): http://avisynth.nl/index.php/RemoveBlend
Maybe you'll get the required edits from that page :).

[violao]

Thanks a lot. It does seem to work now.

[StainlessS]

violao,

If I remember correctly, RemoveBlend v0.2 with info=true, puts up a lot of info on frame and crashes if frame less than about 480x480
due to info.h text wrapping off bottom of frame with access violations.
There is a new info.h, best re-compile using that, also, Avisynth VERSION 2 header is well out of date, use VERSION 3 for v2.58+,
and you can remove the Internal.h dependency now.

Thread that started Info.h re-factor:- http://forum.doom9.org/showthread.php?t=156888&highlight=ddigit

Nice to see you back again, dont think I've ever seen you post in my time (Dec 2009 joined).

EDIT: v0.3 seems to suffer from same probs as v0.2 (on quick look).

Current Info.h with bounds checking can be found at MediaFire below in my sig, DEVELOPER folder
(Also included in DDigitTest as linked above, and VERSION 3 header should also be in DDigitTest zip).

[Wilbert]

Did you read post #22 (http://forum.doom9.org/showpost.php?p=1700301&postcount=22)? Apparently you need to make 10 regular edits before you have permission to add a page, unless a higher-up manually intervenes.
Done.

[violao]

Stainless,

Thanks for your suggestion.

--edited--

OK, I got the part with DrawStringPlanar coordinates.

But if I replace internal.h with avisynth25.h I get a bunch of compiler errors on WinNT.h :(

[Wilbert]

But if I replace internal.h with avisynth25.h I get a bunch of compiler errors on WinNT.h
You should include windows.h before avisynth.h.