This is the advanced guide on how to make a video filter and what all those confusing looking things in the template.clean file are in depth. If you want the beginners guide, scroll to the bottom.
[Video_Filters] *Required if your clean file skips video
This is where you would denote the type of scenes filtered. These are written like "-Gore=1" which would correspond with a [Video_Skip], like so "--Filter=Gore". These allow you or other people to turn off sections of skipping if so desired. If you wish to note exactly what the skipped scene contained, you can do so by writing what it was in plain text (example: beheading) directly below the end time.
[Audio_Filters] *Required if your clean file mutes audio
This is where you would denote the specific words filtered. These are written like "-God=1" which would correspond with an [Audio_Skip], like so "--Filter=God". These allow you or other people to turn off sections of muting if so desired.
Everything in this section here has to do with the generation of offsets for videos that may be different slightly different from the original video the filter was created using. These are VERY important to include when creating clean files, the omission of any of these numbers will break the filter and cause issues for other people trying to use the clean files.
These are manually input by you (the end user) in the event VLClean Player's automatically generated offset is not working. For more information on how to use this, check out our guide on audio offsets (http://forum.vlcleanplayer.com/index.php?topic=4.msg8). These are normally set to 0. In the off-chance you need to change them, they should both be the same number 99.9% of the time.
This is the offset from the video file the clean file was created using. This number is generated by VLClean Player by calculating the length in ms to the first audio spike of a specific decibel level. This can then be used to line up most (mind you, I said most) videos regardless of where you got it or "backed it up" from.
This is the filetype of the video file the clean file was created using. This is necessary mainly because AVI files have some odd playback offset issues, though so do MP4's so until we figure something out for those this is necessary.
This is the length of the video file the clean file was created using. If you are creating the filter, this is the length of the video file you are filtering. This should never be edited after it's uploaded to the VLClean filter database.
This is where you place video times that are a few seconds prior to any filter locations you feel would be a good test spot for checking if the filter worked on first run. Preferably something filtered that would not fall under any Level 1 category in-case the filter fails the first time around.
[Video_Skip] *Required if your clean file skips video
All of the video skips go in between these section markers. The actual video skip code is as follows.
- --Filter=Word - This is the scene type you are filtering, it must correspond with a [Video_Filters]
- -Start=0:00:00 - This is when the clean file begins skipping, usually just before the scene happens
- -End=0:00:00 - This is where the clean file skips to, usually just after the scene ends
[Audio_Skip] *Required if your clean file mutes audio
All of the audio mutes go in between these section markers. The actual audio mute code is as follows.
- --Filter=Word - This is the word you are filtering, it must correspond with an [Audio_Filters]
- -TimeStart=0:00:00 - This is the time when the filter begins the muting.
- -TimeOffset=000 - This is how many milliseconds the mute waits from the TimeStart to begin muting
- -MuteLength=000 - This is how many milliseconds the mute actually mutes for, this can be thousands.
Beginners Guide to making your first Clean File
Warning! This may look like a ton of steps but It's not. I am just being very thorough.
Creating and Building your .clean file | (Example) (http://forum.vlcleanplayer.com/my_images/guide/offsets.png)
- Locate the template.clean file from the VLClean Player's data folder
- Copy it to the folder that contains the video you wish to clean
- Rename the template file to the exact same file name as the video you are cleaning
- Open the clean file and fill in the Original_Length with the length of the video.
- Fill in the Original_Type with the filetype of the video (.mkv, .avi, .mk4, etc)
- Take the video file and drag it into VLClean Player and click Offset (this is slow)
- Fill in the Original_Offset with the video offset number it gives you
Preparing to clean your video | (Example) (http://forum.vlcleanplayer.com/my_images/guide/levels.png)
- Save the clean file and click "Reload" on the VLClean Player.
- Grab the subtitle file for the video if it's available (I use opensubtitles)
- Open the Build Mode in VLClean Player (Right click -> Build Mode)
- Drag the subtitle file into the sub drop-zone and wait for a folder to open
- Each file contains a "level (http://forum.vlcleanplayer.com/index.php?topic=2.0)" of profanity, the time it occurred and what was said.
Filtering audio from the the video | (Example) (http://forum.vlcleanplayer.com/my_images/guide/audiofilters.png)
- Pick a word you want to filter, note the time, then open the video's clean file.
- Locate the [Audio_Filters] header near the top of the clean file
- ReplaceMeWith the word to filter, like so (-Dmn=). Try to abbreviate
- Further down in the filter you will find an [Audio_Skip] heading.
- ReplaceMeWith its corresponding word from #3 like so (--Filter=Dmn)
- TimeStart is the time when the mute should begin, the subtitle's times are usually close
- TimeOffset is the mute delay length in milliseconds from the TimeStart
- MuteLength is the duration in milliseconds of the actual muting
Filtering scenes from the the video | (Example) (http://forum.vlcleanplayer.com/my_images/guide/videofilters.png)
- Pick a scene you want to filter, note the time, then open the video's clean file.
- Locate the [Video_Filters] header near the top of the clean file
- Replace UseMeToDescribe with the scene you are filtering, like so (-Nudity= or -Gore=)
- Further down in the filter you will find a [Video_Skip] heading.
- Replace UseMeToDescribe with its corresponding word from #3 like so (--Filter=Nudity)
- Start is the time when the skipping should begin, begin at a cut-scene if possible
- End is when Mr Smith enters the matrix and we all see deja vu. Right?
- Fine, End is the time when the skipping should end! (who would of guessed!)
How to easily verify any edit while cleaning the video | (Example) (http://forum.vlcleanplayer.com/my_images/guide/buildmode.png)
- Load your video into the VLClean Player and open Build Mode
- In the first box, type in a time that is just before the time you are filtering
- set a key you don't use often as a hotkey, the F keys are usually a good choice.
- save your clean file, then click Reload (the hotkey also does this) to load the changes
- Finally, after making an edit, press the hotkey to check it (it also auto-reloads clean file)