X-Git-Url: http://git.xonotic.org/?p=xonotic%2Fxonotic.git;a=blobdiff_plain;f=misc%2Ftools%2FNexuizDemoRecorder%2Fmain%2Fsrc%2Fmain%2Fresources%2Fhelp%2Fhtml%2Fplugin-virtualdub.html;h=49df2e0794f4c12645e5424669939dd79759c0b2;hp=9824ee7ab7fb7c1dc630fbea2a4e3595c8fc8d80;hb=d36387088cb9338aa4484a7e6e82bfe69defa1e2;hpb=e5832bf2ecac60a672a29c85cd8dec341a215e1c diff --git a/misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/plugin-virtualdub.html b/misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/plugin-virtualdub.html index 9824ee7a..49df2e07 100644 --- a/misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/plugin-virtualdub.html +++ b/misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/plugin-virtualdub.html @@ -1,163 +1,163 @@ - - - - - - - - - - -

VirtualDub plug-in

-

Introduction

-

Important: Make sure that -you read this documentation carefully in order to avoid mistakes!

-

The prerequisite for using this -plug-in is that you already familiar with the “manual” -process of encoding clips with VirtualDub (www.virtualdub.org). -The great thing about VirtualDub is that it offers both a graphical -user interface (GUI), accessible via virtualdub.exe, and a -command line interface (CLI), accessible via vdub.exe.

-

Step 1: create VDub configuration -files (VCF)

-

Let's say we had a clip that we -wanted to encode not only once, but twice – into different -formats. Let's say that the first goal is to encode it to a loss-less -Huffyuv clip, and the second goal is to encode it to a quality-based -1-pass XviD clip using MP3 sound.

-

What you need to do first is to open -VirtualDub, set up the settings for one of the goals (by going into -the video compression and audio compression dialogs) and then click -on File → Save processing settings (CTRL+S). You will end up -with saving a .vcf file somewhere on your hard drive … -remember where you put it! After that, you'd set up the settings for -your second goal and save these processing settings as well, as a new -.vcf file.

-

Step 2: Enable and set up the VDub -plug-in

-

First we need to set up the global -settings of the plug-in. Go into the preferences dialog and enable -the plug-in.

-

-

Use the “...” button to -specify the path to the vdub.exe file. The setting max number of -VCFs per job is important, because the number you put in there -will influence how many VCF files you will be able to select in the -job dialog (the dialog where you create or edit a -job/template). For our example we need to set it to 2, but it doesn't -matter if you choose a higher value. Since VDub will encode two -files for us, we will have to tell VDub under which filenames to save -them. You can select which approach you want to use by configuring -the setting output as suffix(0) or file(1). If you don't -check the checkbox this means that you will enter a small part of the -file name, the suffix, that will be put at the end of the -original file name. E.g. if your original filename was -“C:\render\myVideoFile.avi”, and the suffix is -“_huffyuv”, the resulting file would be -“C:\render\myVideoFile_huffyuv.avi”. However, if you -checked that checkbox, you would instead get a “...” -button that allows you to specify the filename for the resulting file -manually (this is handy if you wanted to save the file to another -folder for example).

-

The show extra options setting -will be explained at the end of this page.

-

Let's now have a look at the dialog -when editing a job

-

Step 3: Set up the job-specific -settings

-

Open the job dialog.

-

/P> -

Let's ignore the 2 checkboxes at the -top for a moment. What you will need to do is to specify the path to -the 2 .vcf files you created previously in VirtualDub in step 1. Then -you need to specify the suffix (or the file using the file-chooser) -so that VDub knows where to save the encoded videos.

-

Step 4: Run the plug-in

- -

Additional information

-

Empty VCF paths

-

As you know you can specify any -number in the preferences dialog for the setting max number -of VCFs per job. In case of our example that consists of 2 jobs, -if you selected 3 (or more) as max. number, and then opened the job -dialog, you would see 3 fields each for the path to VCF file -and output file setting. This, however, is not a problem. The -plug-in will only execute those VCF jobs for which both the path to -the VCF and the output file fields are filled with proper -information.

-

VDub job control

-

You still don't know what the 2 -checkboxes in the job dialog at the top of the VDub settings -mean. What you need to know is that VirtualDub is having its own “job -queue”, which, however, is called “job control”.

-

The following scenarios can make -sense:

- -

The reason why these checkboxes exist -is flexibility. I often want the NDR to record stuff over night, -because during the recording process my PC is virtually unusable. -However, encoding clips in VirtualDub is a task that, depending on -the codec, can be done in the background and allows me to use the PC -for other things. In this case I'd disable both checkboxes, have the -NDR record all clips and add them to VirtualDub's job control, and -then on the next day, I decide when and which jobs to encode into -different formats from within the VirtualDub GUI.

-

And btw, just to be clear, the second -checkbox means that, when enabled, VirtualDub would actually -start encoding all clips that have already been in -VirtualDub's job control and that have not been encoded yet.

-

Extra options

-

If you selected the show extra -options checkbox in the preferences dialog, you will -notice that, in the job dialog, you got 2 additional -settings/checkboxes for each VCF file. Their names are pretty much -self-explanatory. I added these checkboxes because, after a scene was -rendered, I usually have the clip encoded into a loss-less format -(e.g. Huffyuv) right away. Since it is no problem to encode further -things (e.g. compressed XviD movies) based on the Huffyuv clip -(instead of always using the original avi file), enabling both these -checkboxes for VCF 1 would mean that the 2nd (3rd, -4th …) VCF jobs will be based on the -huffyuv-encoded file, and I got rid of original, big video as well, -saving hard disk space.

-

Trouble shooting

-

In case you suspect that the -expected, encoded file(s) is somehow incorrect (or even missing), -have a look at the logs directory in the NDR folder. You will -see log-files with the following format:

-

VirtualDub_NameOfTheJob_vcf1.log

-

Instead of “vcf1” you -might also find “vcf2”, “vcf3”... it -specifies for which VCF file of that job the log file stands for.

-



-

- - - + + + + + + + + + + +

VirtualDub plug-in

+

Introduction

+

Important: Make sure that +you read this documentation carefully in order to avoid mistakes!

+

The prerequisite for using this +plug-in is that you already familiar with the “manual” +process of encoding clips with VirtualDub (www.virtualdub.org). +The great thing about VirtualDub is that it offers both a graphical +user interface (GUI), accessible via virtualdub.exe, and a +command line interface (CLI), accessible via vdub.exe.

+

Step 1: create VDub configuration +files (VCF)

+

Let's say we had a clip that we +wanted to encode not only once, but twice – into different +formats. Let's say that the first goal is to encode it to a loss-less +Huffyuv clip, and the second goal is to encode it to a quality-based +1-pass XviD clip using MP3 sound.

+

What you need to do first is to open +VirtualDub, set up the settings for one of the goals (by going into +the video compression and audio compression dialogs) and then click +on File → Save processing settings (CTRL+S). You will end up +with saving a .vcf file somewhere on your hard drive … +remember where you put it! After that, you'd set up the settings for +your second goal and save these processing settings as well, as a new +.vcf file.

+

Step 2: Enable and set up the VDub +plug-in

+

First we need to set up the global +settings of the plug-in. Go into the preferences dialog and enable +the plug-in.

+

+

Use the “...” button to +specify the path to the vdub.exe file. The setting max number of +VCFs per job is important, because the number you put in there +will influence how many VCF files you will be able to select in the +job dialog (the dialog where you create or edit a +job/template). For our example we need to set it to 2, but it doesn't +matter if you choose a higher value. Since VDub will encode two +files for us, we will have to tell VDub under which filenames to save +them. You can select which approach you want to use by configuring +the setting output as suffix(0) or file(1). If you don't +check the checkbox this means that you will enter a small part of the +file name, the suffix, that will be put at the end of the +original file name. E.g. if your original filename was +“C:\render\myVideoFile.avi”, and the suffix is +“_huffyuv”, the resulting file would be +“C:\render\myVideoFile_huffyuv.avi”. However, if you +checked that checkbox, you would instead get a “...” +button that allows you to specify the filename for the resulting file +manually (this is handy if you wanted to save the file to another +folder for example).

+

The show extra options setting +will be explained at the end of this page.

+

Let's now have a look at the dialog +when editing a job

+

Step 3: Set up the job-specific +settings

+

Open the job dialog.

+

/P> +

Let's ignore the 2 checkboxes at the +top for a moment. What you will need to do is to specify the path to +the 2 .vcf files you created previously in VirtualDub in step 1. Then +you need to specify the suffix (or the file using the file-chooser) +so that VDub knows where to save the encoded videos.

+

Step 4: Run the plug-in

+ +

Additional information

+

Empty VCF paths

+

As you know you can specify any +number in the preferences dialog for the setting max number +of VCFs per job. In case of our example that consists of 2 jobs, +if you selected 3 (or more) as max. number, and then opened the job +dialog, you would see 3 fields each for the path to VCF file +and output file setting. This, however, is not a problem. The +plug-in will only execute those VCF jobs for which both the path to +the VCF and the output file fields are filled with proper +information.

+

VDub job control

+

You still don't know what the 2 +checkboxes in the job dialog at the top of the VDub settings +mean. What you need to know is that VirtualDub is having its own “job +queue”, which, however, is called “job control”.

+

The following scenarios can make +sense:

+ +

The reason why these checkboxes exist +is flexibility. I often want the NDR to record stuff over night, +because during the recording process my PC is virtually unusable. +However, encoding clips in VirtualDub is a task that, depending on +the codec, can be done in the background and allows me to use the PC +for other things. In this case I'd disable both checkboxes, have the +NDR record all clips and add them to VirtualDub's job control, and +then on the next day, I decide when and which jobs to encode into +different formats from within the VirtualDub GUI.

+

And btw, just to be clear, the second +checkbox means that, when enabled, VirtualDub would actually +start encoding all clips that have already been in +VirtualDub's job control and that have not been encoded yet.

+

Extra options

+

If you selected the show extra +options checkbox in the preferences dialog, you will +notice that, in the job dialog, you got 2 additional +settings/checkboxes for each VCF file. Their names are pretty much +self-explanatory. I added these checkboxes because, after a scene was +rendered, I usually have the clip encoded into a loss-less format +(e.g. Huffyuv) right away. Since it is no problem to encode further +things (e.g. compressed XviD movies) based on the Huffyuv clip +(instead of always using the original avi file), enabling both these +checkboxes for VCF 1 would mean that the 2nd (3rd, +4th …) VCF jobs will be based on the +huffyuv-encoded file, and I got rid of original, big video as well, +saving hard disk space.

+

Trouble shooting

+

In case you suspect that the +expected, encoded file(s) is somehow incorrect (or even missing), +have a look at the logs directory in the NDR folder. You will +see log-files with the following format:

+

VirtualDub_NameOfTheJob_vcf1.log

+

Instead of “vcf1” you +might also find “vcf2”, “vcf3”... it +specifies for which VCF file of that job the log file stands for.

+



+

+ + +