Ported REAMDE file to Markdown + updated build script accordingly.

This commit is contained in:
LoRd_MuldeR 2014-08-13 16:43:38 +02:00
parent 9fb93a96fb
commit 5dc612e75c
8 changed files with 479 additions and 418 deletions

1
.gitignore vendored
View File

@ -14,3 +14,4 @@
*.opensdf *.opensdf
*.old *.old
*.db *.db
*.local.*

View File

@ -1,13 +1,25 @@
GNU GENERAL PUBLIC LICENSE <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
Version 2, June 1991 <html><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GNU General Public License v2.0 - GNU Project - Free Software Foundation (FSF)</title>
<link rel="alternate" type="application/rdf+xml" href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.rdf">
</head>
<body>
<h3><a id="SEC1">GNU GENERAL PUBLIC LICENSE</a></h3>
<p>
Version 2, June 1991
</p>
Copyright (C) 1989, 1991 Free Software Foundation, Inc. <pre>Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre>
<h3><a id="preamble"></a><a id="SEC2">Preamble</a></h3>
<p>
The licenses for most software are designed to take away your The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free License is intended to guarantee your freedom to share and change free
@ -15,51 +27,69 @@ software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to the GNU Lesser General Public License instead.) You can apply it to
your programs, too. your programs, too.
</p>
<p>
When we speak of free software, we are referring to freedom, not When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things. in new free programs; and that you know you can do these things.
</p>
<p>
To protect your rights, we need to make restrictions that forbid To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights. anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it. distribute copies of the software, or if you modify it.
</p>
<p>
For example, if you distribute copies of such a program, whether For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their source code. And you must show them these terms so they know their
rights. rights.
</p>
<p>
We protect your rights with two steps: (1) copyright the software, and We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy, (2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software. distribute and/or modify the software.
</p>
<p>
Also, for each author's protection and ours, we want to make certain Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original that any problems introduced by others will not reflect on the original
authors' reputations. authors' reputations.
</p>
<p>
Finally, any free program is threatened constantly by software Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all. patent must be licensed for everyone's free use or not licensed at all.
</p>
<p>
The precise terms and conditions for copying, distribution and The precise terms and conditions for copying, distribution and
modification follow. modification follow.
</p>
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains <h3><a id="terms"></a><a id="SEC3">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</a></h3>
<a id="section0"></a><p>
<strong>0.</strong>
This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below, under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program" refers to any such program or work, and a "work based on the Program"
@ -68,39 +98,60 @@ that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you". the term "modification".) Each licensee is addressed as "you".
</p>
<p>
Activities other than copying, distribution and modification are not Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program). Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does. Whether that is true depends on what the Program does.
</p>
1. You may copy and distribute verbatim copies of the Program's <a id="section1"></a><p>
<strong>1.</strong>
You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty; notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License and give any other recipients of the Program a copy of this License
along with the Program. along with the Program.
</p>
<p>
You may charge a fee for the physical act of transferring a copy, and You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee. you may at your option offer warranty protection in exchange for a fee.
</p>
2. You may modify your copy or copies of the Program or any portion <a id="section2"></a><p>
<strong>2.</strong>
You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1 distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions: above, provided that you also meet all of these conditions:
</p>
a) You must cause the modified files to carry prominent notices <dl>
<dt></dt>
<dd>
<strong>a)</strong>
You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change. stating that you changed the files and the date of any change.
</dd>
b) You must cause any work that you distribute or publish, that in <dt></dt>
<dd>
<strong>b)</strong>
You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License. parties under the terms of this License.
</dd>
c) If the modified program normally reads commands interactively <dt></dt>
<dd>
<strong>c)</strong>
If the modified program normally reads commands interactively
when run, you must cause it, when started running for such when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a announcement including an appropriate copyright notice and a
@ -110,7 +161,10 @@ above, provided that you also meet all of these conditions:
License. (Exception: if the Program itself is interactive but License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on does not normally print such an announcement, your work based on
the Program is not required to print an announcement.) the Program is not required to print an announcement.)
</dd>
</dl>
<p>
These requirements apply to the modified work as a whole. If These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program, identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in and can be reasonably considered independent and separate works in
@ -120,38 +174,62 @@ distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it. entire whole, and thus to each and every part regardless of who wrote it.
</p>
<p>
Thus, it is not the intent of this section to claim rights or contest Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or exercise the right to control the distribution of derivative or
collective works based on the Program. collective works based on the Program.
</p>
<p>
In addition, mere aggregation of another work not based on the Program In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under a storage or distribution medium does not bring the other work under
the scope of this License. the scope of this License.
</p>
3. You may copy and distribute the Program (or a work based on it, <a id="section3"></a><p>
<strong>3.</strong>
You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following: Sections 1 and 2 above provided that you also do one of the following:
</p>
a) Accompany it with the complete corresponding machine-readable <!-- we use this doubled UL to get the sub-sections indented, -->
<!-- while making the bullets as unobvious as possible. -->
<dl>
<dt></dt>
<dd>
<strong>a)</strong>
Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or, 1 and 2 above on a medium customarily used for software interchange; or,
</dd>
b) Accompany it with a written offer, valid for at least three <dt></dt>
<dd>
<strong>b)</strong>
Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or, customarily used for software interchange; or,
</dd>
c) Accompany it with the information you received as to the offer <dt></dt>
<dd>
<strong>c)</strong>
Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such received the program in object code or executable form with such
an offer, in accord with Subsection b above.) an offer, in accord with Subsection b above.)
</dd>
</dl>
<p>
The source code for a work means the preferred form of the work for The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any code means all the source code for all modules it contains, plus any
@ -162,22 +240,30 @@ anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component operating system on which the executable runs, unless that component
itself accompanies the executable. itself accompanies the executable.
</p>
<p>
If distribution of executable or object code is made by offering If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not distribution of the source code, even though third parties are not
compelled to copy the source along with the object code. compelled to copy the source along with the object code.
</p>
4. You may not copy, modify, sublicense, or distribute the Program <a id="section4"></a><p>
<strong>4.</strong>
You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License. void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such this License will not have their licenses terminated so long as such
parties remain in full compliance. parties remain in full compliance.
</p>
5. You are not required to accept this License, since you have not <a id="section5"></a><p>
<strong>5.</strong>
You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by prohibited by law if you do not accept this License. Therefore, by
@ -185,16 +271,22 @@ modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying all its terms and conditions for copying, distributing or modifying
the Program or works based on it. the Program or works based on it.
</p>
6. Each time you redistribute the Program (or any work based on the <a id="section6"></a><p>
<strong>6.</strong>
Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein. restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to You are not responsible for enforcing compliance by third parties to
this License. this License.
</p>
7. If, as a consequence of a court judgment or allegation of patent <a id="section7"></a><p>
<strong>7.</strong>
If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues), infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not otherwise) that contradict the conditions of this License, they do not
@ -206,12 +298,16 @@ license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program. refrain entirely from distribution of the Program.
</p>
<p>
If any portion of this section is held invalid or unenforceable under If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other apply and the section as a whole is intended to apply in other
circumstances. circumstances.
</p>
<p>
It is not the purpose of this section to induce you to infringe any It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the such claims; this section has the sole purpose of protecting the
@ -222,23 +318,33 @@ through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot to distribute software through any other system and a licensee cannot
impose that choice. impose that choice.
</p>
<p>
This section is intended to make thoroughly clear what is believed to This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License. be a consequence of the rest of this License.
</p>
8. If the distribution and/or use of the Program is restricted in <a id="section8"></a><p>
<strong>8.</strong>
If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License. the limitation as if written in the body of this License.
</p>
9. The Free Software Foundation may publish revised and/or new versions <a id="section9"></a><p>
<strong>9.</strong>
The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to be similar in spirit to the present version, but may differ in detail to
address new problems or concerns. address new problems or concerns.
</p>
<p>
Each version is given a distinguishing version number. If the Program Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions later version", you have the option of following the terms and conditions
@ -246,18 +352,24 @@ either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software this License, you may choose any version ever published by the Free Software
Foundation. Foundation.
</p>
10. If you wish to incorporate parts of the Program into other free <a id="section10"></a><p>
<strong>10.</strong>
If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally. of promoting the sharing and reuse of software generally.
</p>
NO WARRANTY <a id="section11"></a><p><strong>NO WARRANTY</strong></p>
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY <p>
<strong>11.</strong>
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
@ -266,8 +378,11 @@ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION. REPAIR OR CORRECTION.
</p>
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING <a id="section12"></a><p>
<strong>12.</strong>
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
@ -276,67 +391,91 @@ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES. POSSIBILITY OF SUCH DAMAGES.
</p>
END OF TERMS AND CONDITIONS <h3>END OF TERMS AND CONDITIONS</h3>
How to Apply These Terms to Your New Programs <h3><a id="howto"></a><a id="SEC4">How to Apply These Terms to Your New Programs</a></h3>
<p>
If you develop a new program, and you want it to be of the greatest If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms. free software which everyone can redistribute and change under these terms.
</p>
<p>
To do so, attach the following notices to the program. It is safest To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found. the "copyright" line and a pointer to where the full notice is found.
</p>
<one line to give the program's name and a brief idea of what it does.> <pre><var>one line to give the program's name and an idea of what it does.</var>
Copyright (C) <year> <name of author> Copyright (C) <var>yyyy</var> <var>name of author</var>
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or
it under the terms of the GNU General Public License as published by modify it under the terms of the GNU General Public License
the Free Software Foundation; either version 2 of the License, or as published by the Free Software Foundation; either version 2
(at your option) any later version. of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details. GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</pre>
<p>
Also add information on how to contact you by electronic and paper mail. Also add information on how to contact you by electronic and paper mail.
</p>
<p>
If the program is interactive, make it output a short notice like this If the program is interactive, make it output a short notice like this
when it starts in an interactive mode: when it starts in an interactive mode:
</p>
Gnomovision version 69, Copyright (C) year name of author <pre>Gnomovision version 69, Copyright (C) <var>year</var> <var>name of author</var>
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
This is free software, and you are welcome to redistribute it type `show w'. This is free software, and you are welcome
under certain conditions; type `show c' for details. to redistribute it under certain conditions; type `show c'
for details.
</pre>
The hypothetical commands `show w' and `show c' should show the appropriate <p>
parts of the General Public License. Of course, the commands you use may The hypothetical commands <samp>`show w'</samp> and <samp>`show c'</samp> should show
be called something other than `show w' and `show c'; they could even be the appropriate parts of the General Public License. Of course, the
mouse-clicks or menu items--whatever suits your program. commands you use may be called something other than <samp>`show w'</samp> and
<samp>`show c'</samp>; they could even be mouse-clicks or menu items--whatever
suits your program.
</p>
<p>
You should also get your employer (if you work as a programmer) or your You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names: necessary. Here is a sample; alter the names:
</p>
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989 <pre>Yoyodyne, Inc., hereby disclaims all copyright
Ty Coon, President of Vice interest in the program `Gnomovision'
(which makes passes at compilers) written
by James Hacker.
<var>signature of Ty Coon</var>, 1 April 1989
Ty Coon, President of Vice
</pre>
<p>
This General Public License does not permit incorporating your program into This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General library. If this is what you want to do, use the
Public License instead of this License. <a href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a>
instead of this License.
</p>
</body></html>

225
README.md Normal file
View File

@ -0,0 +1,225 @@
Simple x264/x265 Launcher
===============================================================================
**Copyright (C) 2004-2014 LoRd_MuldeR <<mulder2@gmx>>. Some rights reserved.**
**Please check http://muldersoft.com/ for news and updates !!!**
1. Introduction
-------------------------------------------------------------------------------
This application is a lightweight GUI front-end for the x264 H.264/AVC as well as the x265 H.265/HEVC encoder, based on the Qt toolkit.
Some key features of the Simple x264/x265 Launcher software include:
* Support for creating H.264/AVC (x264) and H.265/HEVC (x265) files
* Fully self-contained, *no* additional Codecs or Plugin's are required
* 64-Bit as well as 32-Bit encoder binaries are fully supported
* Optionally the "high bit-depth" encoder variants can be selected
* Batch encoding (job control) support is implemented
* If desired, multiple encoding jobs can be executed concurrently
* Adding new jobs via command-line interface is supported
* Input from the Avisynth *and* VapurSynth frame servers is supported
* 32-Bit Avisynth/VapourSynth can be mixed with 64-Bit x264/x265
* Straightforward encoder setup thanks to the Preset and Tuning system
* Custom encoder parameters can be added, if desired
* Easily manage your encoder configurations with user-defined templates
* Consistent "look & feel" on all systems thanks to the Qt toolkit
2. System Requirements
-------------------------------------------------------------------------------
The minimum system requirements to run Simple x264/x265 Launcher are as follows:
* Windows XP with Service Pack 2 or any later Windows system
* 64-Bit Windows is highly recommended (32-Bit Windows works as well)
* The CPU must support at least the MMX and SSE instruction sets
* Avisynth input only available with Avisynth 2.5+ installed
* VapourSynth input only available with VapourSynth R19+ installed
* YV16/YV24 color spaces require Avisynth 2.6 (see section 10)
Simple x264 Launcher is 100% standalone, i.e. it does **not** require Mircrosoft.NET, Java Runtime Environment or other dependencies.
The required Qt DLLs and encoder binaries are included in the setup.
3. Anti-Virus Warning
-------------------------------------------------------------------------------
Occasionally your Antivirus program may mistakenly detect "malware" (virus, trojan, worm, etc.) in some of the files here. This is called a "False Positive" and the files are actually innocent/clean. It's an error in your specific Antivirus software. In case you encounter such problems, go to http://www.virustotal.com/ and check the file again with multiple Antivirus engines! And take care with results like "suspicious" , "generic" or "packed". Those are **not** real hits, they are just wild speculation. Apparently Antivirus programs tend to suspect installers/uninstaller created with NSIS. Furthermore some Antivirus programs blindly suspect all UPX'd (packed) executables of being malware. Obviously this is a stupid generalization, so you can safely ignore those warnings! Last but not least: Always keep in mind that this is OpenSource software! If you don't trust the people providing the pre-compiled binaries, download the source codes and compile them yourself.
**DON'T SUBMIT ANY VIRUS/TROJAN REPORTS, UNLESS YOU HAVE VERIFIED THE INFECTION WITH MULTIPLE ANTIVIRUS ENGNINES. THANKS!**
4. License
-------------------------------------------------------------------------------
Simple x264/x265 Launcher is Copyright (C) 2004-2014 LoRd_MuldeR.
```
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```
http://www.gnu.org/licenses/gpl-2.0.txt
5. Third-Party Software
-------------------------------------------------------------------------------
The following third-party software is used by this application:
* The Qt GUI Toolkit is Copyright (C) 2012 Digia Plc.
http://qt.digia.com/
Qt is a free software, released under the terms of GNU GPL, version 3.
* The x264 encoder software is Copyright (C) 2003-2014 x264 project.
http://www.videolan.org/developers/x264.html
x264 is a free software and is released under the terms of the GNU GPL.
* The x265 encoder software is Copyright (C) 2013-2014 x265 project.
http://www.videolan.org/developers/x265.html
x265 is a free software and is released under the terms of the GNU GPL.
* AviSynth is Copyright (C) 2002-2006 Ben Rudiak-Gould et al.
http://avisynth.nl/index.php/Main_Page
AviSynth is a free software, released under the terms of the GNU GPL.
* VapourSynth is Copyright (c) 2012-2014 Fredrik Mellbin.
http://www.vapoursynth.com/
VapourSynth is free software, released under the terms of the GNU LGPL.
All third-party binaries included in this distribution package are redistributed in full accordance with the GNU General Public License, version 2. For further information see the respective web sites!
6. Portable Mode
-------------------------------------------------------------------------------
This application can be run in "portable" mode. Just rename the EXE file to 'x264_launcher_portable.exe' in order to trigger portable mode. In that mode all configuration files will be saved in the same folder where the EXE file resides. This may be helpful, if you want to run the application directly from your USB stick on different computers. Note, however, that in portable mode the install folder must be writeable!
7. Updating Your Encoder Binaries
-------------------------------------------------------------------------------
This application works best with the encoder binaries that are included in the distribution package. That's because these binaries have been tested to work properly with the GUI. Nonetheless in some cases you may want to replace the included binaries with a newer encoder version or with an alternative build of the same version. Generally newer versions of x264/x265 should work properly, though there is NO guarantee! In rare cases the CLI syntax (or console output) may have changed in a way that breaks the compatibility and therefore will require an update of the GUI itself. Furthermore this application does NOT provide any support for "unofficial" patches. Usually custom builds that contain "unofficial" patches will work anyway, but again there is NO guarantee. Using old (outdated) binaries with this application is NOT supported or intended. Please report bugs rather than reverting to an old version!
8. Timeout Warning
-------------------------------------------------------------------------------
This application provides "deadlock" prevention. This means that if an encoder process (x264 or Avisynth) stops responding, it will be terminated. This is done in order to ensure that the main program as well as the other encoder processes can continue properly. More specifically, a warning will be raised if the process does not respond for one minute. If the process still didn't respond after five minutes, it will be terminated and consequently the encoding job is aborted. In some rare cases, your Avisynth script may take a very long time to initialize and thus the process will be aborted before the encoding can start. For example, this can happen if FFMS2/FFVideoSource takes a very long time to index the source file. In that case, we recommend to index the source file beforehand, e.g. by using the 'ffmsindex' tool.
9. Custom Parameters
-------------------------------------------------------------------------------
This application provides a "Custom Parameters" edit box. All command-line parameters that you enter there will be passed to x264 or x265 unmodified. You can send arbitrary parameters - even such ones that are only available in patched builds. See the x264/x265 manuals or the Help Screen for a list of available parameters. However be aware that the GUI will not check your parameters at all! Thus using an unknown or unsupported parameter will cause your encode to fail. Using an existing parameter in the wrong way will cause your encode to fail too. Last but not least, some parameters are forbidden by the GUI. If some parameter is forbidden, that's because the GUI will set that parameter for you (if required) or because that parameter is NOT compatible with the GUI.
HINT: Occasionally your custom parameters string may become very long, especially when working with zones. In that case you can right-click on the "Custom Parameters" edit box and choose "Open the Text-Editor". This will open a multi-line text editor for easier parameter handling!
10. Color Spaces / Chroma Subsampling
-------------------------------------------------------------------------------
Avs2YUV converts the output of your Avisynth script to the YV12 format, i.e. YUV data with 4:2:0 chroma subsampling and 8-Bit precision. Usually this is exactly what you want/need. If, however, your Avisynth script outputs image data with a higher chroma resolution, e.g. YUY2 (4:2:2), then the conversion to YV12 (4:2:0) will discard some of the information. In that case, and if you want/need to keep the full chroma resolution of your Avisynth script's output, you will have to pass the <tt>-csp</tt> switch to Avs2YUV as a custom parameter! Use <tt>-csp I422</tt> for YUV 4:2:2 (YV16) and use <tt>-csp I444</tt> for YUV 4:4:4 (YV24). Please note that Avs2YUV can NOT pass through the "packed" YUY2 format. Thus it has to be converted to the "planar" YV16 format. As both, YUY2 and YV16, are YUV 4:2:2 formats, converting from YUY2 to YV16 is a lossless operation. Note, however, that Avisynth 2.5 did NOT support YV16/YV24, so you need to use Avisynth 2.6; otherwise Avs2YUV will fail to do the conversion! Also be aware that the x264 encoder itself will convert any YV16 or YV24 input back to the YV12 format, if you don't pass the suitable <tt>--output-csp i422/i444</tt> switch to x264 as a custom parameter! In short, to encode YUY2 from Avisynth, you have to pass <tt>-csp I422</tt> to Avs2YUV and <tt>--output-csp i422</tt> to x264 to avoid 4:2:0 downsampling.
11. Audio Processing/Encoding
-------------------------------------------------------------------------------
This application is a front-end to the x264 encoder. And, as x264 does NOT support audio processing/encoding yet, there is NO explicit support for audio encoding in this application. Thus, if you want to create a video file *with* audio, you will have to add the audio stream to the encoded video file afterwards. This process is called 'multiplexing' or just 'muxing'. In case you are dealing with Matroska (MKV) files, then "MKVMerge GUI" from the "MKVToolNix" package is the right tool for this task. If, instead, you are dealing with MP4 files, then you may use "MP4Box" or the "YAMB" front-end for muxing the audio stream.
Having said all that, there now is an unofficial "Audio" branch of x264 available. If you are using one of the modified x264 builds with "audio support" patch (e.g. those provided by JEEB), then you can process the audio with x264 and skip the additional muxing step. Basically the audio patch adds a new <tt>--acodec</tt> switch, which you can pass to x264 as a custom parameter. For example, you can pass <tt>--acodec aac</tt> for encoding the audio to the AAC format (recommended for MP4 files). Or you can pass <tt>--acodec vorbis</tt> for encoding the audio to the Ogg/Vorbis format (recommended for MKV files). Please be aware that audio encoding will work only, if your input file contains an audio stream! When using the built-in LAVF/FFMS input of x264, the audio can be encoded straight from the input file. This does NOT work with Avisynth input! Instead, if you want to encode audio from an Avisynth script, you must pass the <tt>--audiofile <path_to_avs_file></tt> switch to x264 as a custom parameter. For convenience, the string <tt>--audiofile $(INPUT)</tt> may be used.
12. OpenCL Support
-------------------------------------------------------------------------------
Newer builds of x264 now support OpenCL Lookahead, i.e. GPU accelerated encoding. This can be enabled with the <tt>--opencl</tt> custom parameter. But OpenCL Lookahead will only work if you have an OpenCL-capable graphics card *and* if you have an up-to-date video driver installed!
Note that x264 will now *only* try to load the OpenCL.DLL if you really use the <tt>--opencl</tt> option. Therefore, the "dummy" OpenCL.DLL included in older versions of the Simple x264 Launcher is **not** needed any more!!
13. Command-line Syntax
-------------------------------------------------------------------------------
PLEASE NOTE: These are parameters you can pass to Simple x264 Launcher, they can **not** be passed to x264 or x265 as "custom" parameters !!!
The following command-line switches are available:
```
--add-file <file> ............... Create a new job via GUI dialog
--add-job <src> <dest> <tpl> .... Create a new job directly from CLI
--[no-]force-start .............. Start the next job immediately
--[no-]force-enqueue ............ Append the next job to the queue
--skip-avisynth-check ........... Skip Avisynth detection
--skip-vapoursynth-check ........ Skip VapourSynth detection
--force-cpu-no-64bit ............ Forcefully disable 64-Bit support
--no-deadlock-detection ......... Don't abort a processes on deadlock
--[no-]console .................. Do [not] show the Debug console
--no-style ...................... Don't use the Qt "Plastique" style
```
Some details on the "--add-job" command-line switch:
```
<src> .... Specifies the source media file or AVS/VPY script file
<dest> ... Specifies the output H.264/HEVC/MKV/MP4 file to be written
<tpl> .... Specifies the template to be used ("-" uses defaults)
```
Use <tt>--[no-]force-start</tt> or <tt>--[no-]force-enqueue</tt> to tweak startup behavior. If neither is used, the default startup behavior applies.
14. Downloads & Updates
-------------------------------------------------------------------------------
Please download the latest version of Simple x264/x265 Launcher from one of the official download mirrors:
* https://github.com/lordmulder/Simple-x264-Launcher/releases/latest
* https://bitbucket.org/lord_mulder/simple-x264-launcher/downloads
* https://www.assembla.com/spaces/simple-x264-x265-launcher/documents
* http://sourceforge.net/projects/muldersoft/files/
15. Help & Support
-------------------------------------------------------------------------------
For help and support, please join the discussion at:
* http://forum.doom9.org/showthread.php?t=144140
Please *avoid* sending me e-mail with support requests. I get a lot of mail every day and cannot answer everything. Thank you!
16. Source Codes
-------------------------------------------------------------------------------
Simple x264/x265 Launcher is written in C++ and currently developed with Microsoft Visual Studio 2013. It is based on the Qt toolkit.
The source codes can be obtained from the official Git repository:
* https://github.com/lordmulder/Simple-x264-Launcher
* https://gitorious.org/simple-x264-launcher/simple-x264-launcher
* https://bitbucket.org/lord_mulder/simple-x264-launcher
* https://git.assembla.com/simple-x264-x265-launcher.git
Download Visual Studio Express 2013 for Windows *Desktop* here:
* http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs
Download the latest Qt toolkit (4.8.x) from the Qt Project web-site:
* http://download.qt-project.org/official_releases/qt/4.8/
**e.o.f.**

View File

@ -1,330 +0,0 @@
Simple x264/x265 Launcher - graphical front-end for x264 and x265
Copyright (C) 2004-2014 LoRd_MuldeR <MuldeR2@GMX.de>
Please check http://muldersoft.com/ for news and updates !!!
1. Introduction
---------------
This application is a lightweight GUI front-end for the x264 H.264/AVC
as well as the x265 H.265/HEVC encoder, based on the Qt toolkit.
Some key features of the Simple x264/x265 Launcher software include:
* Support for creating H.264/AVC (x264) and H.265/HEVC (x265) files
* Fully self-contained, *no* additional Codecs or Plugin's are required
* 64-Bit as well as 32-Bit encoder binaries are fully supported
* Optionally the "high bit-depth" encoder variants can be selected
* Batch encoding (job control) support is implemented
* If desired, multiple encoding jobs can be executed concurrently
* Adding new jobs via command-line interface is supported
* Input from the Avisynth *and* VapurSynth frame servers is supported
* 32-Bit Avisynth/VapourSynth can be mixed with 64-Bit x264/x265
* Straightforward encoder setup thanks to the Preset and Tuning system
* Custom encoder parameters can be added, if desired
* Easily manage your encoder configurations with user-defined templates
* Consistent "look & feel" on all systems thanks to the Qt toolkit
2. System Requirements
----------------------
* Windows XP with Service Pack 2 or any later Windows system
* 64-Bit Windows is highly recommended (32-Bit Windows works as well)
* The CPU must support at least the MMX and SSE instruction sets
* Avisynth input only available with Avisynth 2.5+ installed
* VapourSynth input only available with VapourSynth R19+ installed
* YV16/YV24 color spaces require Avisynth 2.6 (see section 10)
Simple x264 Launcher is 100% standalone, i.e. it does *not* require
Mircrosoft.NET, Java Runtime Environment or other dependencies.
The required Qt DLLs and encoder binaries are included in the setup.
3. Anti-Virus Warning
---------------------
Occasionally your Antivirus program may mistakenly detect "malware"
(virus, trojan, worm, etc.) in some of the files here. This is called a
"False Positive" and the files are actually innocent/clean. It´s an
error in your specific Antivirus software.
In case you encounter such problems, go to http://www.virustotal.com/
and check the file again with multiple Antivirus engines! And take care
with results like "suspicious" , "generic" or "packed". Those are *not*
real hits, they are just wild speculation.
Apparently Antivirus programs tend to suspect installers/uninstaller
created with NSIS. Furthermore some Antivirus programs blindly suspect
all UPX´d (packed) executables of being malware. Obviously this is a
stupid generalization, so you can safely ignore those warnings!
Last but not least: Always keep in mind that this is OpenSource
software! If you don´t trust the people providing the pre-compiled
binaries, download the source codes and compile them yourself.
DON´T SUBMIT ANY VIRUS/TROJAN REPORTS, UNLESS YOU HAVE VERIFIED THE
INFECTION WITH MULTIPLE ANTIVIRUS ENGNINES. THANKS!
4. License
----------
Simple x264/x265 Launcher is Copyright (C) 2004-2014 LoRd_MuldeR.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
http://www.gnu.org/licenses/gpl-2.0.txt
5. Third-Party Software
-----------------------
The following third-party software is used by this program:
The Qt GUI Toolkit is Copyright (C) 2012 Digia Plc.
http://qt.digia.com/
Qt is a free software, released under the terms of GNU GPL, version 3.
The x264 encoder software is Copyright (C) 2003-2014 x264 project.
http://www.videolan.org/developers/x264.html
x264 is a free software and is released under the terms of the GNU GPL.
The x265 encoder software is Copyright (C) 2013-2014 x265 project.
http://www.videolan.org/developers/x265.html
x265 is a free software and is released under the terms of the GNU GPL.
AviSynth is Copyright (C) 2002-2006 Ben Rudiak-Gould et al.
http://avisynth.nl/index.php/Main_Page
AviSynth is a free software, released under the terms of the GNU GPL.
VapourSynth is Copyright (c) 2012-2014 Fredrik Mellbin.
http://www.vapoursynth.com/
VapourSynth is free software, released under the terms of the GNU LGPL.
All third-party binaries included in this distribution package are
redistributed in full accordance with the GNU General Public License,
version 2. For further information see the respective web sites!
6. Portable Mode
----------------
This application can be run in "portable" mode. Just rename the EXE
file to 'x264_launcher_portable.exe' in order to trigger portable mode.
In that mode all configuration files will be saved in the same folder
where the EXE file resides. This may be helpful, if you want to run the
application directly from your USB stick on different computers. Note,
however, that in portable mode the install folder must be writable!
7. Updating Your Encoder Binaries
---------------------------------
This application works best with the encoder binaries that are included
in the distribution package. That's because these binaries have been
tested to work properly with the GUI. Nonetheless in some cases you may
want to replace the included binaries with a newer encoder version or
with an alternative build of the same version. Generally newer versions
of x264/x265 should work properly, though there is NO guarantee! In
rare cases the CLI syntax (or console output) may have changed in a way
that breaks the compatibility and therefore will require an update of
the GUI itself. Furthermore this application does NOT provide any
support for "unofficial" patches. Usually custom builds that contain
"unofficial" patches will work anyway, but again there is NO guarantee.
Using old (outdated) binaries with this application is NOT supported or
intended. Please report bugs rather than reverting to an old version!
8. Timeout Warning
------------------
This application provides "deadlock" prevention. This means that if an
encoder process (x264 or Avisynth) stops responding, it will be
terminated. This is done in order to ensure that the main program as
well as the other encoder processes can continue properly. More
specifically, a warning will be raised if the process does not respond
for one minute. If the process still didn't respond after five minutes,
it will be terminated and consequently the encoding job is aborted. In
some rare cases, your Avisynth script may take a very long time to
initialize and thus the process will be aborted before the encoding can
start. For example, this can happen if FFMS2/FFVideoSource takes a very
long time to index the source file. In that case, we recommend to index
the source file beforehand, e.g. by using the 'ffmsindex' tool.
9. Custom Parameters
--------------------
This application provides a "Custom Parameters" edit box. All command-
line parameters that you enter there will be passed to x264 or x265
unmodified. You can send arbitrary parameters - even such ones that are
only available in patched builds. See the x264/x265 manuals or the Help
Screen for a list of available parameters. However be aware that the
GUI will not check your parameters at all! Thus using an unknown or
unsupported parameter will cause your encode to fail. Using an existing
parameter in the wrong way will cause your encode to fail too. Last but
not least, some parameters are forbidden by the GUI. If some parameter
is forbidden, that's because the GUI will set that parameter for you
(if required) or because that parameter is NOT compatible with the GUI.
HINT: Occasionally your custom parameters string may become very long,
especially when working with zones. In that case you can right-click on
the "Custom Parameters" edit box and choose "Open the Text-Editor".
This will open a multi-line text editor for easier parameter handling!
10. Color Spaces / Chroma Subsampling
-------------------------------------
Avs2YUV converts the output of your Avisynth script to the YV12 format,
i.e. YUV data with 4:2:0 chroma subsampling and 8-Bit precision.
Usually this is exactly what you want/need. If, however, your Avisynth
script outputs image data with a higher chroma resolution, e.g. YUY2
(4:2:2), then the conversion to YV12 (4:2:0) will discard some of the
information. In that case, and if you want/need to keep the full chroma
resolution of your Avisynth script's output, you will have to pass the
"-csp" switch to Avs2YUV as a custom parameter! Use "-csp I422" for
YUV 4:2:2 (YV16) and use "-csp I444" for YUV 4:4:4 (YV24). Please note
that Avs2YUV can NOT pass through the "packed" YUY2 format. Thus it has
to be converted to the "planar" YV16 format. As both, YUY2 and YV16,
are YUV 4:2:2 formats, converting from YUY2 to YV16 is a lossless
operation. Note, however, that Avisynth 2.5 did NOT support YV16/YV24,
so you need to use Avisynth 2.6; otherwise Avs2YUV will fail to do the
conversion! Also be aware that the x264 encoder itself will convert any
YV16 or YV24 input back to the YV12 format, if you don't pass the
suitable "--output-csp i422/i444" switch to x264 as a custom parameter!
In short, to encode YUY2 from Avisynth, you have to pass "-csp I422" to
Avs2YUV and "--output-csp i422" to x264 to avoid 4:2:0 downsampling.
11. Audio Processing/Encoding
-----------------------------
This application is a front-end to the x264 encoder. And, as x264 does
NOT support audio processing/encoding yet, there is NO explicit support
for audio encoding in this application. Thus, if you want to create a
video file *with* audio, you will have to add the audio stream to the
encoded video file afterwards. This process is called 'multiplexing' or
just 'muxing'. In case you are dealing with Matroska (MKV) files, then
"MKVMerge GUI" from the "MKVToolNix" package is the right tool for this
task. If, instead, you are dealing with MP4 files, then you may use
"MP4Box" or the "YAMB" front-end for muxing the audio stream.
Having said all that, there now is an unofficial "Audio" branch of x264
available. If you are using one of the modified x264 builds with "audio
support" patch (e.g. those provided by JEEB), then you can process the
audio with x264 and skip the additional muxing step. Basically the
audio patch adds a new "--acodec" switch, which you can pass to x264 as
a custom parameter. For example, you can pass "--acodec aac" for
encoding the audio to the AAC format (recommended for MP4 files). Or
you can pass "--acodec vorbis" for encoding the audio to the Ogg/Vorbis
format (recommended for MKV files). Please be aware that audio encoding
will work only, if your input file contains an audio stream! When using
the built-in LAVF/FFMS input of x264, the audio can be encoded straight
from the input file. This does NOT work with Avisynth input! Instead,
if you want to encode audio from an Avisynth script, you must pass the
"--audiofile <path_to_avs_file>" switch to x264 as a custom parameter.
For convenience, the string "--audiofile $(INPUT)" may be used.
12. OpenCL Support
-----------------------
Newer builds of x264 now support OpenCL Lookahead, i.e. GPU accelerated
encoding. This can be enabled with the "--opencl" custom parameter. But
OpenCL Lookahead will only work if you have an OpenCL-capable graphics
card *and* if you have an up-to-date video driver installed!
Note that x264 will now *only* try to load the OpenCL.DLL if you really
use the "--opencl" option. Therefore, the "dummy" OpenCL.DLL included
in older versions of the Simple x264 Launcher is *NOT* needed anymore!!
13. Command-line Syntax
-----------------------
PLEASE NOTE: These are parameters you can pass to Simple x264 Launcher,
they can **not** be passed to x264 or x265 as "custom" parameters !!!
The following command-line switches are available:
--add-file <file> ............... Create a new job via GUI dialog
--add-job <src> <dest> <tpl> .... Create a new job directly from CLI
--[no-]force-start .............. Start the next job immediately
--[no-]force-enqueue ............ Append the next job to the queue
--skip-avisynth-check ........... Skip Avisynth detection
--skip-vapoursynth-check ........ Skip VapourSynth detection
--force-cpu-no-64bit ............ Forcefully disable 64-Bit support
--no-deadlock-detection ......... Don't abort a processes on deadlock
--[no-]console .................. Do [not] show the Debug console
--no-style ...................... Don't use the Qt "Plastique" style
Some details on the "--add-job" command-line switch:
<src> .... Specifies the source media file or AVS/VPY script file
<dest> ... Specifies the output H.264/HEVC/MKV/MP4 file to be written
<tpl> .... Specifies the template to be used ("-" uses defaults)
Use "--[no-]force-start" or "--[no-]force-enqueue" to tweak startup
behavior. If neither is used, the default startup behavior applies.
14. Downloads & Updates
-----------------------
Please download the latest version of Simple x264/x265 Launcher from
one of the official download mirrors:
* https://github.com/lordmulder/Simple-x264-Launcher/releases/latest
* https://bitbucket.org/lord_mulder/simple-x264-launcher/downloads
* https://www.assembla.com/spaces/simple-x264-x265-launcher/documents
* http://sourceforge.net/projects/muldersoft/files/
15. Help & Support
------------------
For help and support, please join the discussion at:
http://forum.doom9.org/showthread.php?t=144140
Please *avoid* sending me e-mail with support requests. Thank you!
(I get a lot of mail every day and cannot answer everything)
16. Source Codes
----------------
Simple x264/x265 Launcher is written in C++ and currently developed
with Microsoft Visual Studio 2013. It is based on the Qt toolkit.
The source codes can be obtained from the official Git repository:
* https://github.com/lordmulder/Simple-x264-Launcher
* https://gitorious.org/simple-x264-launcher/simple-x264-launcher
* https://bitbucket.org/lord_mulder/simple-x264-launcher
* https://git.assembla.com/simple-x264-x265-launcher.git
Download Visual Studio Express 2013 for Windows *Desktop* here:
http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs
Download the latest Qt toolkit (4.8.x) from the Qt Project web-site:
http://download.qt-project.org/official_releases/qt/4.8/
e.o.f.

12
etc/css/style.inc Normal file
View File

@ -0,0 +1,12 @@
<style type="text/css">
<!--
body { font-family: "Times New Roman", Times, serif; color: #000000; background-color: #FFFFFF; }
tt, pre, code { font-family: Courier New, Courier, mono; background-color: #EDF3F7; padding: 1px; }
h2 { margin-top: 2.0em; }
h3, h4 { margin-top: 1.75em; }
a { color: #0000BB; text-decoration: none; }
a:visited { color: #0000BB; text-decoration: none; }
a:active { color: #0000FF; text-decoration: none; }
a:hover { color: #0000FF; text-decoration: underline; }
-->
</style>

View File

@ -38,6 +38,10 @@ if not exist "%QTDIR%\bin\moc.exe" (
echo Qt meta compiler not found. Please check your QTVC_PATH var! echo Qt meta compiler not found. Please check your QTVC_PATH var!
goto BuildError goto BuildError
) )
if not exist "%PDOC_PATH%\pandoc.exe" (
echo Pandoc binary could not be found. Please check your PDOC_PATH var!
goto BuildError
)
REM /////////////////////////////////////////////////////////////////////////// REM ///////////////////////////////////////////////////////////////////////////
REM // Get current date and time (in ISO format) REM // Get current date and time (in ISO format)
@ -96,6 +100,7 @@ copy "%~dp0\bin\Release\toolset\common\*.exe" "%PACK_PATH%\toolset\common"
copy "%~dp0\bin\Release\toolset\common\*.gpg" "%PACK_PATH%\toolset\common" copy "%~dp0\bin\Release\toolset\common\*.gpg" "%PACK_PATH%\toolset\common"
copy "%~dp0\etc\sources\*.tar" "%PACK_PATH%\sources" copy "%~dp0\etc\sources\*.tar" "%PACK_PATH%\sources"
copy "%~dp0\*.txt" "%PACK_PATH%" copy "%~dp0\*.txt" "%PACK_PATH%"
copy "%~dp0\*.html" "%PACK_PATH%"
REM /////////////////////////////////////////////////////////////////////////// REM ///////////////////////////////////////////////////////////////////////////
REM // Copy dependencies REM // Copy dependencies
@ -113,6 +118,11 @@ copy "%QTVC_PATH%\bin\QtXml4.dll" "%PACK_PATH%"
copy "%QTVC_PATH%\plugins\imageformats\*.dll" "%PACK_PATH%\imageformats" copy "%QTVC_PATH%\plugins\imageformats\*.dll" "%PACK_PATH%\imageformats"
del "%PACK_PATH%\imageformats\*d4.dll" del "%PACK_PATH%\imageformats\*d4.dll"
REM ///////////////////////////////////////////////////////////////////////////
REM // Generate Docs
REM ///////////////////////////////////////////////////////////////////////////
"%PDOC_PATH%\pandoc.exe" --from markdown_github+header_attributes --to html5 --standalone -H "%~dp0\etc\css\style.inc" "%~dp0\README.md" --output "%PACK_PATH%\README.html"
REM /////////////////////////////////////////////////////////////////////////// REM ///////////////////////////////////////////////////////////////////////////
REM // Compress REM // Compress
REM /////////////////////////////////////////////////////////////////////////// REM ///////////////////////////////////////////////////////////////////////////
@ -125,6 +135,7 @@ REM ///////////////////////////////////////////////////////////////////////////
attrib +R "%PACK_PATH%\*.exe" attrib +R "%PACK_PATH%\*.exe"
attrib +R "%PACK_PATH%\*.dll" attrib +R "%PACK_PATH%\*.dll"
attrib +R "%PACK_PATH%\*.txt" attrib +R "%PACK_PATH%\*.txt"
attrib +R "%PACK_PATH%\*.html"
REM /////////////////////////////////////////////////////////////////////////// REM ///////////////////////////////////////////////////////////////////////////
REM // Setup install parameters REM // Setup install parameters

3
z_runme.bat Normal file
View File

@ -0,0 +1,3 @@
@echo off
cd /D "%~dp0\bin\Release"
x264_launcher.exe --console