Initial Commit

This commit is contained in:
Ales (Shagi) Zabala Alava 2020-11-02 18:37:13 +01:00
commit 257ec9301b
381 changed files with 323267 additions and 0 deletions

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
/negromate.web.egg-info
/build
/dist

674
LICENSE.txt Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them 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 in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. 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 rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU 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
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 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 PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
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
free software which everyone can redistribute and change under these terms.
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
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 3 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, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

6
MANIFEST.in Normal file
View File

@ -0,0 +1,6 @@
recursive-include negromate/web/templates *
recursive-include negromate/web/static *
recursive-exclude negromate/web/static/node_modules *
recursive-exclude negromate/web/static/js/libjass/node_modules *
exclude negromate/web/static/.gitignore
exclude negromate/web/static/package-lock.json

4
README.md Normal file
View File

@ -0,0 +1,4 @@
Negro Mate Web
==================
Static html compiler for the web of Negro Mate.

11
build.py Executable file
View File

@ -0,0 +1,11 @@
#!/usr/bin/env python
import sys
from pathlib import Path, PurePath
from negromateweb.builder import Builder
builder = Builder(
Path('../bideoak'),
Path('../libreto/libreto.pdf'),
)
builder.build()

0
negromate/__init__.py Normal file
View File

View File

@ -0,0 +1 @@
VERSION = "1.0"

141
negromate/web/builder.py Normal file
View File

@ -0,0 +1,141 @@
import os
from shutil import copy
import sys
from pathlib import Path
import subprocess
from jinja2 import Environment, PackageLoader, select_autoescape
from jinja2.utils import Markup
import srt
from negromate.songs import load_songs
from .karaoke_templates import update_karaoke_songs
class SongPage:
def __init__(self, song):
self.song = song
def get_context_data(self):
parsed_srt = None
if self.song.srt:
with self.song.srt.open('r') as srtfile:
try:
srt_str = srtfile.read().encode('utf-8').decode('utf-8-sig')
parsed_srt = list(srt.parse(srt_str))
except Exception as e:
print("{}: srt parse error: {}".format(self.song.path.name, e))
root_path = os.path.relpath(self.song.root, self.song.path)
return {
'song': self,
'parsed_srt': parsed_srt,
'root_path': root_path,
}
def render(self, builder, context):
ctx = self.get_context_data()
ctx.update(context)
builder.render('song.html', self.song.path, ctx)
def __getattr__(self, name):
return getattr(self.song, name)
class Builder:
def __init__(self, root_folder, libreto):
self.root_folder = root_folder
self.libreto = libreto
self.src_dir = Path(__file__).parent
self.static_dir = self.src_dir / 'static'
self.env = Environment(
loader=PackageLoader('negromate.web', 'templates'),
autoescape=select_autoescape(['html']),
)
self.env.filters['url'] = self.url
self.env.filters['display_boolean'] = self.display_boolean
self.current_path = self.root_folder
def url(self, path):
return os.path.relpath(path, self.current_path)
def display_boolean(self, value):
if value:
return Markup('&check;')
else:
return Markup('&cross;')
def render(self, template, target, context):
html_file = target / 'index.html'
page_template = self.env.get_template(template)
root_path = os.path.relpath(self.root_folder, target)
context['root_path'] = root_path
with html_file.open('w') as page:
page.write(page_template.render(context))
def build(self):
songs, pending_songs = load_songs(self.root_folder)
songs = [SongPage(s) for s in songs]
pending_songs = [SongPage(s) for s in pending_songs]
global_context = {
'songs': songs,
'root_folder': self.root_folder,
}
for song in songs:
self.current_path = song.path
song.render(self, global_context)
self.render('index.html', self.root_folder, global_context)
home = self.root_folder / 'home'
self.current_path = home
if not home.exists():
home.mkdir()
self.render('home.html', home, global_context)
playlist = self.root_folder / 'playlist'
self.current_path = playlist
if not playlist.exists():
playlist.mkdir()
self.render('playlist.html', playlist, global_context)
todo = self.root_folder / 'todo'
self.current_path = todo
if not todo.exists():
todo.mkdir()
todo_context = {
'pending_songs': pending_songs,
}
todo_context.update(global_context)
self.render('todo.html', todo, todo_context)
template_file = self.src_dir / 'templates' / 'karaoke.ass'
update_karaoke_songs(songs, template_file)
static = self.root_folder / 'static'
if not static.exists():
static.mkdir()
subprocess.check_call([
'rsync',
'-ra',
str(self.static_dir),
str(self.root_folder.absolute()),
])
libreto = self.root_folder / 'static/libreto/libreto.pdf'
copy(str(self.libreto.absolute()), str(libreto.absolute()))
def main():
builder = Builder(
Path(sys.argv[1]),
Path(sys.argv[2]),
)
builder.build()

11
negromate/web/commands.py Normal file
View File

@ -0,0 +1,11 @@
from pathlib import Path
from .builder import Builder
def build():
builder = Builder(
Path(sys.argv[1]),
Path(sys.argv[2]),
)
builder.build()

View File

@ -0,0 +1,89 @@
import os
import subprocess
import time
from contextlib import contextmanager
import ass
from negromate.songs.utils import needs_change
@contextmanager
def Xephyr_env(display=":2", *args, **kwargs):
env = os.environ.copy()
xephyr = subprocess.Popen(["Xephyr", display])
env['DISPLAY'] = display
try:
yield env
finally:
xephyr.kill()
def set_template(template_subtitles, orig_file, target_file=None):
if target_file is None:
target_file = orig_file
with open(orig_file, 'r') as orig:
subtitles = ass.parse(orig)
new_events = []
for dialogue in template_subtitles.events:
new_events.append(dialogue)
for dialogue in subtitles.events:
if dialogue.effect.startswith('code'):
continue
if dialogue.effect.startswith('template'):
continue
new_events.append(dialogue)
subtitles.events = new_events
with open(target_file, 'w', encoding='utf-8-sig') as target:
subtitles.dump_file(target)
def run(command, env, wait=None):
program = subprocess.Popen(
command,
env=env,
)
if wait is not None:
time.sleep(wait)
def apply_template(subtitles, env):
run(["aegisub-3.2", subtitles], env=env, wait=2)
# Si pide confirmación para cargar video ignorar el popup
run(["xdotool", "key", "Escape"], env=env, wait=0.1)
# abrir el menú de automatización, bajar dos y darle a aplicar template
run(["xdotool", "key", "alt+u"], env=env, wait=0.1)
run(["xdotool", "key", "Down"], env=env, wait=0.1)
run(["xdotool", "key", "Down"], env=env, wait=0.1)
run(["xdotool", "key", "Return"], env=env, wait=2)
# guardar
run(["xdotool", "key", "ctrl+s"], env=env)
# cerrar programa
run(["xdotool", "key", "ctrl+q"], env=env)
def update_karaoke_songs(songs, template_file):
with open(template_file, 'r') as template:
template_subtitles = ass.parse(template)
with Xephyr_env() as env:
for song in songs:
if song.metadata.get('karaoke'):
target = song.path / "{}.karaoke.ass".format(song.path.name)
if needs_change(target, (song.ass, template_file)):
set_template(
template_subtitles=template_subtitles,
orig_file=str(song.ass),
target_file=str(target)
)
time.sleep(2)
apply_template(str(target), env)
time.sleep(2)

2
negromate/web/static/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
node_modules
package-lock.json

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@ -0,0 +1,118 @@
body {
display: flex;
flex-wrap: wrap;
background-color: #232323;
color: #aaa;
font-family: "CyrBit";
font-size: 20pt;
}
a {
color: #aaa;
text-decoration: none;
}
header#header {
width:100%;
display: inline-block;
}
footer {
font-size: smaller;
width: 100%;
}
table {
width: 90%;
border: 1px solid white;
border-collapse: collapse;
margin: 0 auto;
}
table td, table th {
border: 1px solid white;
}
#menu {
display: inline-block;
flex: 1 10em;
}
#menu ul {
list-style-type: none;
padding: 0;
border: 1px solid gray;
border-radius: 0.5em;
}
#menu ul li {
border-bottom: 1px solid gray;
padding: 0.5em 1em;
}
#libreto, #playlist, #onion, #todo {
border: 1px solid #aaa;
border-radius: 0.5em;
text-align: center;
}
#libreto img {
width: 200px;
margin-left: auto;
margin-right: auto;
display: block;
}
#content {
display: inline-block;
margin-left: 1em;
flex: 10;
}
.songs {
display: flex;
flex-wrap: wrap;
}
.songs figure {
flex: 0;
border: 1px solid gray;
text-align: center;
padding: 0.5em;
border-radius: 0.5em;
}
.songs figure figcaption {
font-weight: bold;
}
video {
width: 100%;
}
.lyrics {
line-height: 1.2em;
}
#song-playlist #video-playlist {
width: 100%;
}
.vjs-mouse.vjs-playlist {
font-size: 15pt;
}
.vjs-mouse.vjs-playlist .vjs-playlist-item-list {
display: flex;
flex-wrap: wrap;
}
.vjs-playlist .vjs-playlist-item {
flex: 0 200px;
}
.video-js .vjs-big-play-button {
top: 50%;
left: 50%;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

View File

@ -0,0 +1,14 @@
/build/doc.js
/build/typescript/typescript.d.ts
/build/typescript/*.js
/dist/
/lib/
!/lib/libjass.css
/node_modules/
/npm-debug.log
/src/version.ts

View File

@ -0,0 +1,7 @@
language: node_js
node_js:
- "6"
- "7"
before_script:
- "node ./build.js doc"
sudo: false

View File

@ -0,0 +1,133 @@
### v0.11.0 - 2016/01/24
- BREAKING CHANGE - WebRenderer.resize(width, height) used to have a broken implementation of letterboxing to move the subs div right or down. Now it's WebRenderer.resize(width, height, left, top) and expects the caller to calculate letterboxing itself and supply left and top accordingly. DefaultRenderer does it using the video resolution and users of WebRenderer can do the same.
- BREAKING CHANGE - DefaultRenderer.resize() now ignores its parameters and always resizes to its video element's dimensions. It had already stopped resizing the video element when it was renamed from resizeVideo in v0.6.0, so it doesn't make sense to let it take a completely different width and height.
- BREAKING CHANGE - Removed fullscreen support in DefaultRenderer. It started out as a hack using max z-index and works on even fewer browsers now. It probably didn't work for you anyway so it should be no big loss.
- Implemented experimental support for \t
- Added RendererSettings.fallbackFonts to set the fallback fonts for all styles. Defaults to 'Arial, Helvetica, sans-serif, "Segoe UI Symbol"'.
- Better compatibility with loose ASS scripts - assume unnamed first section is Script Info, fall back to Default style for missing styles, recognize arbitrary-case property names, normalize asterisks in style names, etc.
- Various font size improvements - faster calculation, fix for incorrect size when line-height is overridden by site CSS, fix for incorrect scaled sizes for letterboxed subs, fix for incorrect metrics for web fonts, etc. The last one requires that all web fonts be specified in RendererSettings.fontMap to be rendered accurately.
- WebRenderer now supports using local() URLs in addition to url() in CSS font-face rules.
- Added RendererSettings.useAttachedFonts. If true, TTF fonts attached to the script will be used in addition to fonts specified in RendererSettings.fontMap. This setting is false by default, and should only be enabled on trusted fonts since it uses a very naive base64 and TTF parser to extract the font names from the attachment. It also requires ES6 typed arrays - ArrayBuffer, DataView, Uint8Array, etc. in the environment.
- Various pre-render, SVG filter and DOM perf improvements.
- Fixed \fscx and \fscy to not scale shadows.
- Fixed \fscx and \fscy to have optional values.
- Fixed \fs+ and \fs- to have required values.
- Fixed \r<target_style> to use the target style's alpha values instead of 1.
- Fixed \fad subs to not flash after the fade-out ends with low-resolution clocks.
- Fixed outlines to not be darker than they should be.
- Fixed styles to not ignore the ScaleX and ScaleY properties in the script.
- Fixed lack of sufficient space between normal and italic text.
- Fixed SVG filters to interpolate in sRGB space instead of RGB.
- Fixed ASS parser to complain if a script doesn't have a Script Info section at all.
- The promise returned from ASS.from*() is now properly rejected due to errors from loading the script, instead of just remaining unresolved forever.
- Fixed SRT parser to swallow UTF-8 BOM just like the ASS parser.
- Fixed all clocks to suppress redundant ticks if the current timestamp hasn't change from the last tick.
- Fixed {AutoClock, VideoClock}.{setEnabled, toggle} methods to actually enable / disable the high-resolution timer.
### v0.10.0 - 2015/05/05
- Implemented libjass.renderers.AutoClock, a clock that automatically ticks and generates clock events according to the state of an external driver.
- Implemented \k
- libjass.{Set, Map, Promise} can now be set to null to force the use of the polyfills, even if it defaulted to a runtime-provided implementation.
- Added ASS.fromReadableStream(), a function that can be used to parse ASS from a readable stream such as the response of window.fetch().
- ASS.fromUrl() now tries to use window.fetch() if available instead of XMLHttpRequest.
- Fixed constant pausing and playing on Firefox triggered by how slowly it updates video.currentTime (wasn't noticeable but still undesirable).
- Fixed a dialogue's animation state not getting updated while seeking if the start and end times of the seek were within its start and end times.
- Fixed wrapping mode 1 (end-of-line wrapping) to actually wrap.
- Fixed parser to parse the time components of karaoke tags as centiseconds instead of seconds.
- Fixed parser to swallow leading BOM, if any.
- Fixed errors reported by webworker API were empty objects without message and stack properties.
### v0.9.0 - 2014/11/27
- BREAKING CHANGE - ASS.fromString() now returns a Promise of an ASS object, not an ASS object directly. The synchronous ASS parser used by ASS.fromString() is no more.
- BACKWARD-COMPATIBLE CHANGE - WebRenderer constructor parameters order has changed from (ass, clock, settings, libjassSubsWrapper) to (ass, clock, libjassSubsWrapper, settings). The constructor will detect the old order and reorder accordingly.
- Added ASS.fromStream and ASS.fromXhr that read a stream and an XMLHttpRequest object's response respectively and return (a Promise of) an ASS object. Both of these parse the script asynchronously.
- Added RendererSettings.enableSvg that can be used to toggle the use of SVG filter effects for outlines and blur.
- libjass.js now has an AMD wrapper so that it can be used with RequireJS, etc.
- Settings parameter is now optional for WebRenderer and DefaultRenderer.
- Added support for clock rates apart from 1 to clocks and renderers.
- Added a parameter to libjass.createWorker to specify the path to libjass.js that will run in the worker.
- Fixed Style and Dialogue constructors not setting defaults for missing properties.
- Fixed color and alpha parser to support more formats.
- Fixed SRT parser to replace all HTML tags it finds, instead of just the first one.
- Fixed font size calculation to use the vertical scale instead of horizontal.
- Fixed line-height on newlines.
- Fixed missing perspective on X and Y rotations.
### v0.8.0 - 2014/08/16
- Added web worker support. libjass.parse can now be offloaded to a web worker.
- Implemented \fs+ and \fs-
- Added ASS.addEvent() to add dialogue lines to an ASS object.
- Renamed ClockEvent.TimeUpdate to ClockEvent.Tick, and added ClockEvent.Stop
- Clock.enable() and .disable() now return a boolean to indicate whether the function had any effect.
- Added Clock.setEnabled() to force the enabled-state to the given value.
- Renamed ManualClock.timeUpdate() to ManualClock.tick()
- Moved WebRenderer.enable(), .disable() and .enabled to NullRenderer
- Fixed not being able to parse tags with default values.
- Fixed font preloader downloading the same font multiple times because it didn't filter for duplicates.
- Fixed min-width value not taking separate left and right margins into account.
- Fixed absolutely positioned subs were always left-aligned even if they had an alignment tag.
- Fixed blur and outlines getting truncated.
### v0.7.0 - 2014/05/15
- Implemented \be
- Split a new renderer, WebRenderer, off DefaultRenderer that doesn't rely on a video element.
- All renderers now require a Clock to generate time events. VideoClock is a Clock backed by a video element, while ManualClock is a clock that can be used to generate arbitrary time events.
### v0.6.0 - 2014/03/24
- All script properties and style properties are now parsed and stored in the ASS and Style objects.
- Basic SRT support, by passing in a libjass.Format argument to ASS.fromString()
- \clip and \iclip now have their drawing instructions parsed as an array of libjass.parts.drawing.Instruction's instead of just a string.
- Added DefaultRenderer.enable(), DefaultRenderer.disable() and DefaultRenderer.toggle() to change whether the renderer is displaying subtitles or not.
- DefaultRenderer.resizeVideo is now called DefaultRenderer.resize. Now it only resizes the subtitle wrapper div, not the video element.
- Replaced the 41ms setInterval-bsed timer with a requestAnimationFrame-based timer to reduce load on minimized or hidden browser tabs.
- DefaultRenderer now renders dialogues in the correct order according to the script.
- Fixed incorrect font sizes.
- Replaced jake with gulp.
### v0.5.0 - 2014/01/26
- Removed preLoadFonts renderer setting. It was redundant with the actual fontMap setting since the presence or absence of that setting is enough to signal whether the user wants to preload fonts or not.
- Multiple renderers can now be used on the same page without conflicting with each other.
- Implemented \shad, \xshad, \yshad
- Fixed ASS draw scale being used incorrectly.
- ASS.resolutionX and ASS.resolutionY are now properties of ASS.properties, a ScriptProperties object.
### v0.4.0 - 2013/12/27
- All parts moved from the libjass.tags namespace to the libjass.parts namespace.
- Replaced PEG.js parser with a hand-written one. This allows for parsing lines that are strictly invalid grammar but are parsed successfully by VSFilter or libass.
- All ASS tags are now supported by the parser.
- Removed the useHighResolutionTimer setting for DefaultRenderer. DefaultRenderer always uses the 41ms timer now.
- Implemented \move
- Implemented ASS draw
- Fixed subs overflowing the video dimensions still being visible.
- SVG filters are now used for outlines and blur.
- Delay parsing of dialogue lines till they need to be pre-rendered. As a side-effect, all fonts in the font map are preloaded now, not just the ones used in the current script.
### v0.3.0 - 2013/10/28
- Moved libjass.DefaultRenderer to libjass.renderers.DefaultRenderer
- Added libjass.renderers.NullRenderer, a renderer that doesn't render anything.
- DefaultRenderer's fontMap setting is now a Map instead of an Object. It now supports more than one URL for each font name.
- DefaultRenderer now generates the subtitle wrapper div itself.
- DefaultRenderer now takes video letterboxing into account when resizing the subtitles.
- DefaultRenderer has a new setting useHighResolutionTimer that makes it use a 41ms timer instead of video.timeUpdate's 250ms timer.
- div IDs and CSS class names are now prefixed with "libjass-" to avoid collisions with other elements on the page.
- All numeric CSS property values are now truncated to three decimal places.
- Added ```jake watch``` that rebuilds and runs tests on changes to the source.
- Added ```jake doc``` that builds API documentation.
- Added Travis CI build.
### v0.2.0 - 2013/09/11
- Added libjass.DefaultRenderer, a class that handles initializing the layer div's, preloading fonts, and drawing Dialogues based on the current video time.
- libjass.js can now be loaded in node. Only the parser can be used.
- Tests can now be run with ```jake test``` or ```npm test``` using Mocha.
### v0.1.0 - 2013/08/29
- First npm release.

View File

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -0,0 +1,171 @@
[![Build Status](https://travis-ci.org/Arnavion/libjass.png?branch=master)](https://travis-ci.org/Arnavion/libjass)
libjass is a JavaScript library written in TypeScript to render ASS subs in the browser. [Check out the demo.](http://arnavion.github.io/libjass/demo/index.xhtml)
### What's special about libjass?
* libjass requires no tweaks to the ASS file from the original video.
* libjass uses the browser's native CSS engine by converting the components of each line in the ASS script into a series of styled &lt;div&gt; and &lt;span&gt; elements. This allows all the layout and rendering to be handled by the browser instead of requiring complex and costly drawing and animation code. For example, libjass uses CSS3 animations to simulate tags such as \fad. While a canvas-drawing library would have to re-draw such a subtitle on the canvas for every frame of the video, libjass only renders it once and lets the browser render the fade effect.
As a result, libjass is able to render subtitles with very low CPU usage. The downside to libjass's aproach is that it is hard (and potentially impossible) to map all effects possible in ASS (using \t, ASS draw) etc. into DOM elements. As of now, the subset of tags supported by libjass has no such problems.
### I want to use libjass for my website. What do I need to do?
You can install the latest release of libjass
* using npm with `npm install libjass` and load with `var libjass = require("libjass");`
* using bower with `bower install https://github.com/Arnavion/libjass/releases/download/<release name>/libjass.zip`
* using jspm with `jspm install github:Arnavion/libjass` and load with `import libjass from "Arnavion/libjass";`
Inside the package, you will find libjass.js and libjass.css, which you need to load on your website with your video.
Alternatively, you can build libjass from source by cloning this repository and running `npm install`. This will install the dependencies and run the build. libjass.js and libjass.css will be found in the lib/ directory.
Only libjass.js and libjass.css are needed to use libjass on your website. The other files are only used during the build process and you don't need to deploy them to your website.
### What are all these files?
* The src/ directory contains the source of libjass. They are TypeScript files and get compiled into JavaScript for the browser using the TypeScript compiler.
* build.js is the build script. The build command will use this script to build libjass.js. The build/ directory contains other files used for the build.
* The tests/ directory contains unit and functional tests.
* The lib/ directory contains libjass.js and libjass.css. You will need to deploy these to your website.
### How do I use libjass?
The API documentation is linked in the Links section below. Here's an overview:
* The [ASS.fromUrl()](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromUrl) function takes in a URL to an ASS script and returns a promise that resolves to an [ASS](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS) object. This ASS object represents the script properties, the line styles and dialogue lines in it. Alternatively, you can use [ASS.fromString()](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromString) to convert a string of the script contents into an ASS object.
* Next, you initialize a renderer to render the subtitles. libjass ships with an easy-to-use renderer, the [DefaultRenderer](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.DefaultRenderer). It uses information from the ASS object to build up a series of div elements around the video tag. There is a wrapper (.libjass-subs) containing div's corresponding to the layers in the ASS script, and each layer has div's corresponding to the 9 alignment directions. libjass.css contains styles for these div's to render them at the correct location.
* The renderer uses [window.requestAnimationFrame](https://developer.mozilla.org/en-US/docs/Web/API/window.requestAnimationFrame) as a source of timer ticks. In each tick, it determines the set of dialogues to be shown at the current video time, renders each of them as a div, and appendChild's the div into the appropriate layer+alignment div.
* The renderer can be told to dynamically change the size of the subtitles based on user input by calling [WebRenderer.resize()](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.WebRenderer.resize)
* Lastly, the renderer contains an implementation of preloading fonts before playing the video. It uses a map of font names to URLs - this map can be conveniently created from a CSS file containing @font-face rules using [RendererSettings.makeFontMapFromStyleElement()](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.RendererSettings.makeFontMapFromStyleElement)
* For an example of using libjass, check out [the demo.](http://arnavion.github.io/libjass/demo/index.xhtml) It has comments explaining basic usage and pointers to some advanced usage.
### What browser and JavaScript features does libjass need?
* libjass uses some ES5 features like getters and setters (via Object.defineProperty), and assumptions like the behavior of parseInt with leading zeros. It cannot be used with an ES3 environment.
* libjass will use ES6 Set, Map and Promise if they're available on the global object. If they're not present, it will use its own minimal internal implementations. If you have implementations of these that you would like libjass to use but don't want to register them on the global object, you can provide them to libjass specifically by setting the [libjass.Set](http://arnavion.github.io/libjass/api.xhtml#libjass.Set), [libjass.Map](http://arnavion.github.io/libjass/api.xhtml#libjass.Map) and [libjass.Promise](http://arnavion.github.io/libjass/api.xhtml#libjass.Promise) properties.
* [AutoClock](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.AutoClock) and [VideoClock](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.VideoClock) use [window.requestAnimationFrame](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame) to generate clock ticks.
* [WebRenderer](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.WebRenderer) and [DefaultRenderer](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.DefaultRenderer) use [SVG filter effects for HTML](http://caniuse.com/#feat=svg-html) to render outlines and blur. This feature is not available on all browsers, so you can tell them to fall back to more widely available CSS methods by setting the [RendererSettings.enableSvg](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.RendererSettings.enableSvg) property to false.
* WebRenderer and DefaultRenderer use [CSS3 animations](http://caniuse.com/#feat=css-animation) for effects like \mov and \fad.
* Using fonts attached to the script requires [ES6 typed arrays](http://caniuse.com/#feat=typedarrays) (ArrayBuffer, DataView, Uint8Array, etc).
### Can I use libjass in node?
libjass's parser works in node. Entire scripts can be parsed via [ASS.fromString()](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromString)
```javascript
> var libjass = require("libjass")
undefined
> var ass; libjass.ASS.fromString(fs.readFileSync("mysubs.ass", "utf8")).then(function (result) { ass = result; })
{}
> ass.properties.resolutionX
1280
> ass.dialogues.length
9
> ass.dialogues[0].toString()
'#0 [646.460-652.130] {\\fad(200,0)}Sapien rhoncus, suscipit posuere in nunc pellentesque'
> var parts = ass.dialogues[0].parts
undefined
> parts.length
2
> parts[0] instanceof libjass.parts.Fade
true
> parts[0].toString()
'Fade { start: 0.2, end: 0 }'
```
[libjass.parser.parse](http://arnavion.github.io/libjass/api.xhtml#libjass.parser.parse) parses the first parameter using the second parameter as the rule name. For example, the [dialogueParts](http://arnavion.github.io/libjass/api.xhtml#./parser/parse.ParserRun.parse_dialogueParts) rule can be used to get an array of [libjass.parts](http://arnavion.github.io/libjass/api.xhtml#libjass.parts) objects that represent the parts of an ASS dialogue line.
```javascript
> var parts = libjass.parser.parse("{\\an8}Are {\\i1}you{\\i0} the one who stole the clock?!", "dialogueParts")
undefined
> parts.join(" ")
'Alignment { value: 8 } Text { value: Are } Italic { value: true } Text { value: you } Italic { value: false } Text { value: the one who stole the clock?! }'
> parts.length
6
> parts[0].toString()
'Alignment { value: 8 }'
> parts[0] instanceof libjass.parts.Alignment
true
> parts[0].value
8
```
The rule names are derived from the methods on the [ParserRun class](http://arnavion.github.io/libjass/api.xhtml#./parser/parse.ParserRun).
See the tests, particularly the ones in tests/unit/miscellaneous.js, for examples.
### Can I contribute?
Yes! Feature requests, suggestions, bug reports and pull requests are welcome! I'm especially looking for details and edge-cases of the ASS syntax that libjass doesn't support.
You can also join the IRC channel in the links section below and ask any questions.
### Supported features
* Styles: Italic, Bold, Underline, StrikeOut, FontName, FontSize, ScaleX, ScaleY, Spacing, PrimaryColor, OutlineColor, BackColor, Outline, Shadow, Alignment, MarginL, MarginR, MarginV
* Tags: \i, \b, \u, \s, \bord, \xbord, \ybord, \shad, \xshad, \yshad, \be, \blur, \fn, \fs, \fscx, \fscy, \fsp, \frx, \fry, \frz, \fr, \fax, \fay, \c, \1c, \3c, \4c, \alpha, \1a, \3a, \4a, \an, \a, \k, \q, \r, \pos, \move, \fad, \fade, \t (experimental), \p
* Custom fonts, using CSS web fonts.
### Known issues
* Unsupported tags: \fe, \2c, \2a, \K, \kf, \ko, \org, \clip, \iclip
* \an4, \an5, \an6 aren't positioned correctly.
* Smart line wrapping is not supported. Such lines are rendered as [wrapping style 1 (end-of-line wrapping).](http://docs.aegisub.org/3.0/ASS_Tags/#wrapstyle)
* Lines with multiple rotations aren't rotated the same as VSFilter or libass. See [#14](https://github.com/Arnavion/libjass/issues/14)
- Desktop renderers include borders when calculating space between adjacent lines. libjass doesn't.
### Links
* [GitHub](https://github.com/Arnavion/libjass/)
* IRC channel - #libjass on irc.rizon.net
* [API documentation](http://arnavion.github.io/libjass/api.xhtml)
* [Aegisub's documentation on ASS](http://docs.aegisub.org/3.0/ASS_Tags/)
### License
```
libjass
https://github.com/Arnavion/libjass
Copyright 2013 Arnav Singh
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

View File

@ -0,0 +1,281 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var fs = require("fs");
var path = require("path");
var stream = require("stream");
var async = require("async");
var task = require("async-build");
(function () {
var _TypeScript = null;
var _UglifyJS = null;
var _npm = null;
Object.defineProperties(global, {
TypeScript: { get: function () { return _TypeScript || (_TypeScript = require("./build/typescript/index.js")); } },
UglifyJS: { get: function () { return _UglifyJS || (_UglifyJS = require("./build/uglify.js")); } },
npm: { get: function () { return _npm || (_npm = require("npm")); } },
});
})();
task("build-tools", function (callback) {
async.every(["./build/typescript/typescript.d.ts", "./build/typescript/index.js", "./build/doc.js"], fs.exists.bind(fs), function (allExist) {
if (allExist) {
callback();
return;
}
var typescriptPath = path.join(require.resolve("typescript"), "..", "..");
async.waterfall([
async.parallel.bind(async, [
fs.readFile.bind(fs, path.join(typescriptPath, "lib", "typescript.d.ts"), "utf8"),
fs.readFile.bind(fs, "./build/typescript/extras.d.ts", "utf8")
]),
function (results, callback) {
var newDts = results[0] + "\n\n" + results[1];
fs.writeFile("./build/typescript/typescript.d.ts", newDts, "utf8", callback);
},
function (callback) {
npm.load(function () {
npm.commands["run-script"](["build"], callback);
});
}
], callback);
});
});
task("default", ["libjass.js", "libjass.min.js"]);
task("version.ts", function (callback) {
fs.exists("./src/version.ts", function (exists) {
if (exists) {
callback();
return;
}
async.waterfall([
fs.readFile.bind(fs, "./package.json"),
function (buffer, callback) {
try {
var packageJson = JSON.parse(buffer);
var versionString = packageJson.version;
var versionParts = versionString.split(".").map(function (num) { return parseInt(num); });
var versionFileContents =
"/* tslint:disable */\n" +
"\n" +
"/**\n" +
" * The version of libjass. An array like\n" +
" *\n" +
" * [\"0.12.0\", 0, 12, 0]\n" +
" *\n" +
" * @type {!Array.<string|number>}\n" +
" */\n" +
"export const version = " + JSON.stringify([versionString].concat(versionParts)) + ";\n";
callback(null, versionFileContents);
}
catch (ex) {
callback(ex);
}
},
function (contents, callback) {
fs.writeFile("./src/version.ts", contents, "utf8", callback);
}
], callback);
});
});
task("libjass.js", ["build-tools", "version.ts"], function (callback) {
fs.exists("./lib/libjass.js", function (exists) {
if (exists) {
callback();
return;
}
callback(null, task.src("./src/tsconfig.json")
.pipe(TypeScript.build("./src/index.ts", "libjass"))
.pipe(UglifyJS.build("libjass", ["AttachmentType", "BorderStyle", "ClockEvent", "Format", "WorkerCommands", "WrappingStyle"]))
.pipe(task.dest("./lib")));
});
});
task("libjass.min.js", ["libjass.js"], function (callback) {
fs.exists("./lib/libjass.min.js", function (exists) {
if (exists) {
callback();
return;
}
callback(null, task.src(["./lib/libjass.js", "./lib/libjass.js.map"], { relativeTo: "./lib" })
.pipe(UglifyJS.minify())
.pipe(task.dest("./lib")));
});
});
task("clean", task.clean(["./src/version.ts", "./lib/libjass.js", "./lib/libjass.js.map", "./lib/libjass.min.js", "./lib/libjass.min.js.map"]));
task("watch", ["build-tools", "version.ts"], function (callback) {
npm.load(function () {
var testRunning = false;
var rerunTest = false;
var startTest = function () {
npm.commands["run-script"](["test-lib"], function () {
testRunning = false;
if (rerunTest) {
startTest();
rerunTest = false;
}
});
testRunning = true;
};
var runTest = function () {
if (!testRunning) {
startTest();
}
else {
rerunTest = true;
}
};
task.src("./src/tsconfig.json")
.pipe(TypeScript.watch("./src/index.ts", "libjass"))
.pipe(UglifyJS.watch("libjass", ["BorderStyle", "ClockEvent", "Format", "WorkerCommands", "WrappingStyle"]))
.pipe(task.dest("./lib"))
.pipe(new task.FileTransform(function (file) {
if (file.path === "libjass.js") {
runTest();
}
}));
task.watch("./tests/unit/", runTest);
});
});
task("test-lib", ["libjass.js"], function (callback) {
npm.load(function () {
npm.commands["run-script"](["test-lib"], callback);
});
});
task("test-minified", ["libjass.min.js"], function (callback) {
npm.load(function () {
npm.commands["run-script"](["test-minified"], callback);
});
});
// Start Selenium server with
// java.exe -jar .\selenium-server-standalone-2.48.2.jar -Dwebdriver.ie.driver=IEDriverServer.exe -Dwebdriver.chrome.driver=chromedriver.exe
task("test-browser", ["libjass.js"], function (callback) {
npm.load(function () {
npm.commands["run-script"](["test-browser"], callback);
});
});
task("test", ["test-lib", "test-minified"]);
task("demo", ["libjass.js"], function () {
return task.src(["./lib/libjass.js", "./lib/libjass.js.map", "./lib/libjass.css"], { relativeTo: "./lib" }).pipe(task.dest("../libjass-gh-pages/demo/"));
});
task("doc", ["make-doc", "test-doc"]);
task("make-doc", ["build-tools", "version.ts"], function () {
var Doc = require("./build/doc.js");
return task.src("./src/tsconfig.json")
.pipe(Doc.build("./api.xhtml", "./src/index.ts", "libjass"))
.pipe(task.dest("../libjass-gh-pages/"));
});
task("test-doc", ["make-doc", "libjass.js"], function (callback) {
npm.load(function () {
npm.commands["run-script"](["test-doc"], callback);
});
});
task("dist", ["libjass.js", "libjass.min.js", "test", "test-browser", "demo", "doc"], function (callback) {
var inputFiles = [
"./README.md", "./CHANGELOG.md", "./LICENSE",
"./lib/libjass.js", "./lib/libjass.js.map",
"./lib/libjass.min.js", "./lib/libjass.min.js.map",
"./lib/libjass.css"
];
var files = Object.create(null);
inputFiles.forEach(function (filename) {
files["./dist/" + path.basename(filename)] = filename;
});
async.series([
// Clean dist/
task.clean(Object.keys(files).concat(["./dist/package.json"])),
// Create dist/ if necessary
function (callback) {
fs.mkdir("./dist", function (err) {
if (err && err.code !== "EEXIST") {
callback(err);
return;
}
callback();
});
},
// Copy all files except package.json
async.forEachOf.bind(async, files, function (inputFilename, outputFilename, callback) {
async.waterfall([fs.readFile.bind(fs, inputFilename), fs.writeFile.bind(fs, outputFilename)], callback);
}),
// Copy package.json
async.waterfall.bind(async, [
fs.readFile.bind(fs, "./package.json"),
function (data, callback) {
try {
var packageJson = JSON.parse(data);
packageJson.devDependencies = undefined;
packageJson.private = undefined;
packageJson.scripts = undefined;
packageJson.main = "libjass.js";
}
catch (ex) {
callback(ex);
return;
}
callback(null, new Buffer(JSON.stringify(packageJson, null, "\t")));
},
fs.writeFile.bind(fs, "./dist/package.json")
])
], callback);
});
task.runArgv(function (err) {
if (err) {
process.exit(1);
}
});

View File

@ -0,0 +1,884 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FileTransform } from "async-build";
import * as AST from "./typescript/ast";
import { Compiler } from "./typescript/compiler";
import { walk } from "./typescript/walker";
function flatten<T>(arr: T[][]): T[] {
let result: T[] = [];
for (const a of arr) {
result = result.concat(a);
}
return result;
}
const sorter = (() => {
function visibilitySorter(value1: { isPrivate?: boolean; isProtected?: boolean; }, value2: { isPrivate?: boolean; isProtected?: boolean; }) {
if (value1.isPrivate === value2.isPrivate && value1.isProtected === value2.isProtected) {
return 0;
}
if (value1.isPrivate) {
return 1;
}
if (value2.isPrivate) {
return -1;
}
if (value1.isProtected) {
return 1;
}
if (value2.isProtected) {
return -1;
}
return 0;
}
const types = [AST.Property, AST.Function, AST.Interface, AST.Class, AST.Enum];
function typeSorter(value1: AST.ModuleMember | AST.NamespaceMember, value2: AST.ModuleMember | AST.NamespaceMember) {
let type1Index = -1;
let type2Index = -1;
types.every((type, index) => {
if (value1 instanceof type) {
type1Index = index;
}
if (value2 instanceof type) {
type2Index = index;
}
return (type1Index === -1) || (type2Index === -1);
});
return type1Index - type2Index;
}
function nameSorter(value1: { name: string }, value2: { name: string }) {
return value1.name.localeCompare(value2.name);
}
const sorters: ((value1: AST.ModuleMember, value2: AST.ModuleMember) => number)[] = [visibilitySorter, typeSorter, nameSorter];
return (value1: AST.ModuleMember, value2: AST.ModuleMember) => {
for (const sorter of sorters) {
const result = sorter(value1, value2);
if (result !== 0) {
return result;
}
}
return 0;
};
})();
function indenter(indent: number) {
return (line: string) => ((line === "") ? line : (Array(indent + 1).join("\t") + line));
}
function sanitize(str: string) {
return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
}
function toVariableName(item: { name: string }) {
// TODO: Handle non-letters (are both their toLowerCase() and toUpperCase())
const name = item.name;
let result = "";
for (let i = 0; i < name.length; i++) {
if (name[i] === name[i].toLowerCase()) {
// This is lower case. Write it as lower case.
result += name[i];
}
else {
// This is upper case.
if (i === 0) {
// This is the first character. Write it as lower case.
result += name[i].toLowerCase();
}
else if (name[i - 1] === name[i - 1].toUpperCase()) {
// The previous character was upper case.
if (i === name.length - 1) {
// This is the last character. Write it as lower case.
result += name[i].toLowerCase();
}
else if (name[i + 1] === name[i + 1].toLowerCase()) {
// The next character is lower case so this is the start of a new word. Write this one as upper case.
result += name[i];
}
else {
// The next character is upper case. Write this one as lower case.
result += name[i].toLowerCase();
}
}
else {
// Previous character was lower case so this is the start of a new word. Write this one as upper case.
result += name[i];
}
}
}
return result;
}
function toUsageName(item: AST.Class | AST.Interface | AST.Function | AST.Property | AST.Enum): string {
if (item.parent instanceof AST.Module) {
return item.name;
}
if (item instanceof AST.Class || item instanceof AST.Interface || item instanceof AST.Enum) {
if (item.isPrivate) {
return item.name;
}
return item.fullName;
}
if (item.parent instanceof AST.Namespace) {
if ((item as AST.CanBePrivate).isPrivate) {
return item.name;
}
return item.fullName;
}
if ((item as AST.CanBeStatic).isStatic) {
return toUsageName(item.parent as AST.Class | AST.Interface) + '.' + item.name;
}
return toVariableName(item.parent) + '.' + item.name;
}
function toId(item: { fullName?: string; name: string; }): string {
return sanitize((item.fullName === undefined) ? item.name : item.fullName);
}
function toLink(item: AST.ModuleMember | AST.EnumMember | AST.TypeReference): string {
let result = `<a href="#${ toId(item) }">${ sanitize(item.name) }`;
if (AST.hasGenerics(item) && item.generics.length > 0) {
const generics = item.generics as (string | AST.TypeReference | AST.IntrinsicTypeReference)[];
result += sanitize(`.<${ generics.map(generic =>
(generic instanceof AST.TypeReference || generic instanceof AST.IntrinsicTypeReference) ? generic.name : generic
).join(', ') }>`);
}
result += '</a>';
return result;
}
function writeDescription(text: string): string {
let result = sanitize(text).replace(/\{@link ([^} ]+)\}/g, (substring, linkTarget) => `<a href="#${ linkTarget }">${ linkTarget }</a>`);
let inCodeBlock = false;
result = result.split("\n").map(line => {
if (line.substr(0, " ".length) === " ") {
line = line.substr(" ".length);
if (!inCodeBlock) {
inCodeBlock = true;
line = `<pre class="code"><code>${ line }`;
}
}
else if (line.length > 0 && inCodeBlock) {
inCodeBlock = false;
line = `</code></pre>${ line }`;
}
else if (line.length === 0 && !inCodeBlock) {
line = "</p><p>";
}
return line;
}).join("\n");
if (inCodeBlock) {
result += '</code></pre>';
}
result = `<p>${ result }</p>`.replace(/<p>\s*<\/p>/g, "").replace(/<p>\s+/g, "<p>").replace(/\s+<\/p>/g, "</p>");
if (result.substr("<p>".length).indexOf("<p>") === -1) {
result = result.substring("<p>".length, result.length - "</p>".length);
}
return result;
}
function writeParameters(parameters: AST.Parameter[]): string[] {
if (parameters.length === 0) {
return [];
}
return [
'<dd class="parameters">',
' <dl>'
].concat(flatten(parameters.map(parameter => {
return [
` <dt class="parameter name">${ sanitize(parameter.name) }</dt>`,
` <dd class="parameter type">${ sanitize(parameter.type) }</dd>`,
` <dd class="parameter description">${ writeDescription(parameter.description) }</dd>`
].concat(writeParameters(parameter.subParameters).map(indenter(2)));
}))).concat([
' </dl>',
'</dd>'
]);
}
function functionToHtml(func: AST.Function): string[] {
return [
`<dl id="${ toId(func) }" class="function${
func.isAbstract ? ' abstract' : '' }${
func.isPrivate ? ' private' : ''}${
func.isProtected ? ' protected' : ''}${
func.isStatic ? ' static' : ''}">`,
` <dt class="name">${ toLink(func) }</dt>`,
' <dd class="description">',
` ${ writeDescription(func.description) }`,
' </dd>',
` <dd class="usage"><fieldset><legend /><pre><code>${
sanitize(
`${ (func.returnType !== null) ? 'var result = ' : '' }${ toUsageName(func) }(${
func.parameters.map(parameter => parameter.name).join(', ') });`
) }</code></pre></fieldset></dd>`
].concat(writeParameters(func.parameters).map(indenter(1))).concat(
(func.returnType === null) ? [] : [
' <dt>Returns</dt>',
` <dd class="return type">${ sanitize(func.returnType.type) }</dd>`,
` <dd class="return description">${ writeDescription(func.returnType.description) }</dd>`
]
).concat([
'</dl>',
''
]);
}
function interfaceToHtml(interfase: AST.Interface): string[] {
const members: AST.InterfaceMember[] = [];
Object.keys(interfase.members).forEach(memberName => members.push(interfase.members[memberName]));
members.sort(sorter);
return [
`<dl id="${ toId(interfase) }" class="interface${ interfase.isPrivate ? ' private' : '' }">`,
` <dt class="name">interface ${ toLink(interfase) }${ (interfase.baseTypes.length > 0) ? ` extends ${
interfase.baseTypes.map(baseType => baseType instanceof AST.TypeReference ? toLink(baseType) : baseType.name).join(', ')
}` : '' }</dt>`,
' <dd class="description">',
` ${ writeDescription(interfase.description) }`,
' </dd>',
' <dd class="members">'
].concat(flatten(members.map(member => {
if (member instanceof AST.Property) {
return propertyToHtml(member).map(indenter(2));
}
else if (member instanceof AST.Function) {
return functionToHtml(member).map(indenter(2));
}
else {
throw new Error(`Unrecognized member type: ${ (member as any).constructor.name }`);
}
}))).concat([
' </dd>',
'</dl>',
''
]);
}
function classToHtml(clazz: AST.Class): string[] {
const members: AST.InterfaceMember[] = [];
Object.keys(clazz.members).forEach(memberName => members.push(clazz.members[memberName]));
members.sort(sorter);
return [
`<dl id="${ toId(clazz) }" class="clazz${
clazz.isAbstract ? ' abstract' : ''}${
clazz.isPrivate ? ' private' : ''}">`,
` <dt class="name">class ${ toLink(clazz) }${
(clazz.baseType !== null) ? ` extends ${ (clazz.baseType instanceof AST.TypeReference) ? toLink(clazz.baseType) : clazz.baseType.name }` : '' }${
(clazz.interfaces.length > 0) ? ` implements ${ clazz.interfaces.map(interfase => interfase instanceof AST.TypeReference ? toLink(interfase) : interfase.name).join(', ') }` : ''}</dt>`,
' <dd class="description">',
` ${ writeDescription(clazz.description) }`,
' </dd>',
` <dd class="usage"><fieldset><legend /><pre><code>${
sanitize(
`var ${ toVariableName(clazz) } = new ${ toUsageName(clazz) }(${
clazz.parameters.map(parameter => parameter.name).join(', ') });`
) }</code></pre></fieldset></dd>`
].concat(writeParameters(clazz.parameters).map(indenter(1))).concat([
' <dd class="members">'
]).concat(flatten(members.map(member => {
if (member instanceof AST.Property) {
return propertyToHtml(member).map(indenter(2));
}
else if (member instanceof AST.Function) {
return functionToHtml(member).map(indenter(2));
}
else {
throw new Error(`Unrecognized member type: ${ (member as any).constructor.name }`);
}
}))).concat([
' </dd>',
'</dl>',
''
]);
}
function enumToHtml(enumType: AST.Enum): string[] {
return [
`<dl id="${ toId(enumType) }" class="enum${ enumType.isPrivate ? ' private' : '' }">`,
` <dt class="name">enum <a href="#${ sanitize(enumType.fullName) }">${ sanitize(enumType.name) }</a></dt>`,
' <dd class="description">',
` ${ writeDescription(enumType.description) }`,
' </dd>'
].concat([
' <dd class="members">'
]).concat(flatten(enumType.members.map(member => [
` <dl id="${ toId(member) }" class="member">`,
` <dt class="name">${ toLink(member) } = ${ member.value }</dt>`,
' <dd class="description">',
` ${ writeDescription(member.description) }`,
' </dd>',
' </dl>'
]))).concat([
' </dd>',
'</dl>',
''
]);
}
function propertyToHtml(property: AST.Property): string[] {
return [
`<dl id="${ toId(property) }" class="property">`,
` <dt class="name">${ toLink(property) }</dt>`
].concat((property.getter === null) ? [] : [
` <dt class="getter${ property.getter.isPrivate ? ' private' : '' }">Getter</dt>`,
' <dd class="description">',
` ${ writeDescription(property.getter.description) }`,
' </dd>',
` <dd class="usage"><fieldset><legend /><pre><code>${ sanitize(`var result = ${ toUsageName(property) };`) }</code></pre></fieldset></dd>`,
` <dd class="return type">${ sanitize(property.getter.type) }</dd>`
]).concat((property.setter === null) ? [] : [
` <dt class="setter${ property.setter.isPrivate ? ' private' : '' }">Setter</dt>`,
' <dd class="description">',
` ${ writeDescription(property.setter.description) }`,
' </dd>',
` <dd class="usage"><fieldset><legend /><pre><code>${ sanitize(`${ toUsageName(property) } = value;`) }</code></pre></fieldset></dd>`
].concat(writeParameters([new AST.Parameter("value", "", property.setter.type)]).map(indenter(1)))).concat([
'</dl>',
''
]);
}
export function build(outputFilePath: string, root: string, rootNamespaceName: string): FileTransform {
const compiler = new Compiler();
return new FileTransform(function (file): void {
// Compile
compiler.compile(file);
// Walk
const walkResult = walk(compiler, root, rootNamespaceName);
const namespaces = walkResult.namespaces;
const modules = walkResult.modules;
// Make HTML
const namespaceNames = Object.keys(namespaces)
.filter(namespaceName => namespaceName.substr(0, rootNamespaceName.length) === rootNamespaceName)
.sort((ns1, ns2) => ns1.localeCompare(ns2));
const moduleNames = Object.keys(modules).sort((ns1, ns2) => ns1.localeCompare(ns2)).filter(moduleName => Object.keys(modules[moduleName].members).length > 0);
this.push({
path: outputFilePath,
contents: Buffer.concat([new Buffer(
`<?xml version="1.0" encoding="utf-8" ?>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>${ rootNamespaceName } API Documentation</title>
<style type="text/css">
<![CDATA[
html, body, .navigation, .content {
height: 100%;
margin: 0;
}
.navigation, .content {
overflow-y: scroll;
}
.navigation {
float: left;
background-color: white;
padding: 0 20px;
margin-right: 20px;
}
.navigation .namespace, .navigation .module {
margin-top: 1em;
}
.navigation .elements {
margin: 0;
}
.content > section:not(:last-child) {
border-bottom: 1px solid black;
}
.clazz, .enum, .function, .interface, .property {
margin-left: 30px;
padding: 10px;
}
.getter, .setter {
font-size: large;
}
section > .clazz:nth-child(2n), section > .enum:nth-child(2n), section > .function:nth-child(2n), section > .interface:nth-child(2n), section > .property:nth-child(2n) {
background-color: rgb(221, 250, 238);
}
section > .clazz:nth-child(2n + 1), section > .enum:nth-child(2n + 1), section > .function:nth-child(2n + 1), section > .interface:nth-child(2n + 1), section > .property:nth-child(2n + 1) {
background-color: rgb(244, 250, 221);
}
.name {
font-size: x-large;
}
.usage {
font-size: large;
font-style: italic;
}
.usage legend:before {
content: "Usage";
}
.usage fieldset {
min-width: initial;
overflow-x: auto;
}
.usage pre {
margin: 0;
}
.clazz .function, .clazz .property, .interface .function, .interface .property, .enum .member {
background-color: rgb(250, 241, 221);
}
.parameter.name {
font-size: large;
}
.type {
font-style: italic;
}
.type:before {
content: "Type: ";
}
.abstract > .name:before {
content: "abstract ";
}
.clazz .private > .name:before {
content: "private ";
}
.clazz .protected > .name:before {
content: "protected ";
}
.static > .name:before {
content: "static ";
}
.abstract.private > .name:before {
content: "abstract private ";
}
.private.static > .name:before {
content: "static private ";
}
.abstract.protected > .name:before {
content: "abstract protected ";
}
.protected.static > .name:before {
content: "static protected ";
}
body:not(.show-private) .clazz .private, body:not(.show-private) .clazz .protected, body:not(.show-private) .module {
display: none;
}
.description .code {
margin-left: 30px;
}
]]>
</style>
<script>
<![CDATA[
addEventListener("DOMContentLoaded", function () {
document.querySelector("#show-private").addEventListener("change", function (event) {
document.body.className = (event.target.checked ? "show-private" : "");
}, false);
showPrivateIfNecessary();
}, false);
function showPrivateIfNecessary() {
var jumpToElement = document.querySelector("[id=\\"" + location.hash.substr(1) + "\\"]");
if (jumpToElement !== null && jumpToElement.offsetHeight === 0) {
document.querySelector("#show-private").click()
jumpToElement.scrollIntoView();
}
}
addEventListener("hashchange", showPrivateIfNecessary, false);
]]>
</script>
</head>
<body>
<nav class="navigation">
<label><input type="checkbox" id="show-private" />Show private</label>
`
)].concat(namespaceNames.map(namespaceName => {
const namespace = namespaces[namespaceName];
const namespaceMembers: AST.NamespaceMember[] = [];
for (const memberName of Object.keys(namespace.members)) {
namespaceMembers.push(namespace.members[memberName]);
}
namespaceMembers.sort(sorter);
return Buffer.concat([new Buffer(
` <fieldset class="namespace">
<legend><a href="#${ sanitize(namespaceName) }">${ sanitize(namespaceName) }</a></legend>
<ul class="elements">
`
)].concat(namespaceMembers.map(member => new Buffer(
` <li><a href="#${ sanitize(member.fullName) }">${ sanitize(member.name) }</a></li>
`
))).concat([new Buffer(
` </ul>
</fieldset>
`
)]));
})).concat(moduleNames.map(moduleName => {
const module = modules[moduleName];
const moduleMembers: AST.ModuleMemberWithoutReference[] = [];
for (const memberName of Object.keys(module.members)) {
const member = module.members[memberName];
if ((member as AST.HasParent).parent === module) {
moduleMembers.push(member as AST.ModuleMemberWithoutReference);
}
}
if (moduleMembers.length === 0) {
return new Buffer("");
}
moduleMembers.sort(sorter);
return Buffer.concat([new Buffer(
` <fieldset class="module">
<legend><a href="#${ sanitize(moduleName) }">${ sanitize(moduleName) }</a></legend>
<ul class="elements">
`
)].concat(moduleMembers.map(member => new Buffer(
` <li><a href="#${ sanitize(member.fullName) }">${ sanitize(member.name) }</a></li>
`
))).concat([new Buffer(
` </ul>
</fieldset>
`
)]));
})).concat([new Buffer(
` </nav>
<div class="content">
`
)]).concat(flatten(namespaceNames.map(namespaceName => {
const namespace = namespaces[namespaceName];
const namespaceMembers: AST.NamespaceMember[] = [];
for (const memberName of Object.keys(namespace.members)) {
namespaceMembers.push(namespace.members[memberName]);
}
namespaceMembers.sort(sorter);
const properties = namespaceMembers.filter(member => member instanceof AST.Property) as AST.Property[];
const functions = namespaceMembers.filter(member => member instanceof AST.Function) as AST.Function[];
const interfaces = namespaceMembers.filter(member => member instanceof AST.Interface) as AST.Interface[];
const classes = namespaceMembers.filter(member => member instanceof AST.Class) as AST.Class[];
const enums = namespaceMembers.filter(member => member instanceof AST.Enum) as AST.Enum[];
const result = [new Buffer(
` <section class="namespace">
<h1 id="${ sanitize(namespaceName) }">Namespace ${ sanitize(namespaceName) }</h1>
`
)];
if (properties.length > 0) {
result.push(new Buffer(
` <section>
<h2>Properties</h2>
`
));
for (const property of properties) {
result.push(new Buffer(propertyToHtml(property).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (functions.length > 0) {
result.push(new Buffer(
` <section>
<h2>Free functions</h2>
`
));
for (const func of functions) {
result.push(new Buffer(functionToHtml(func).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (interfaces.length > 0) {
result.push(new Buffer(
` <section>
<h2>Interfaces</h2>
`
));
for (const interfase of interfaces) {
result.push(new Buffer(interfaceToHtml(interfase).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (classes.length > 0) {
result.push(new Buffer(
` <section>
<h2>Classes</h2>
`
));
for (const clazz of classes) {
result.push(new Buffer(classToHtml(clazz).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (enums.length > 0) {
result.push(new Buffer(
` <section>
<h2>Enums</h2>
`
));
for (const enumType of enums) {
result.push(new Buffer(enumToHtml(enumType).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
result.push(new Buffer(
` </section>
`
));
return result;
}))).concat(flatten(moduleNames.map(moduleName => {
const module = modules[moduleName];
const moduleMembers: AST.ModuleMember[] = [];
for (const memberName of Object.keys(module.members)) {
const member = module.members[memberName];
if ((member as AST.HasParent).parent === module) {
moduleMembers.push(member);
}
}
if (moduleMembers.length === 0) {
return [];
}
moduleMembers.sort(sorter);
const properties = moduleMembers.filter(member => member instanceof AST.Property) as AST.Property[];
const functions = moduleMembers.filter(member => member instanceof AST.Function) as AST.Function[];
const interfaces = moduleMembers.filter(member => member instanceof AST.Interface) as AST.Interface[];
const classes = moduleMembers.filter(member => member instanceof AST.Class) as AST.Class[];
const enums = moduleMembers.filter(member => member instanceof AST.Enum) as AST.Enum[];
const result = [new Buffer(
` <section class="module">
<h1 id="${ sanitize(moduleName) }">Module ${ sanitize(moduleName) }</h1>
`
)];
if (properties.length > 0) {
result.push(new Buffer(
` <section>
<h2>Properties</h2>
`
));
for (const property of properties) {
result.push(new Buffer(propertyToHtml(property).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (functions.length > 0) {
result.push(new Buffer(
` <section>
<h2>Free functions</h2>
`
));
for (const func of functions) {
result.push(new Buffer(functionToHtml(func).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (interfaces.length > 0) {
result.push(new Buffer(
` <section>
<h2>Interfaces</h2>
`
));
for (const interfase of interfaces) {
result.push(new Buffer(interfaceToHtml(interfase).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (classes.length > 0) {
result.push(new Buffer(
` <section>
<h2>Classes</h2>
`
));
for (const clazz of classes) {
result.push(new Buffer(classToHtml(clazz).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
if (enums.length > 0) {
result.push(new Buffer(
` <section>
<h2>Enums</h2>
`
));
for (const enumType of enums) {
result.push(new Buffer(enumToHtml(enumType).map(indenter(5)).join("\n")));
}
result.push(new Buffer(
` </section>
`
));
}
result.push(new Buffer(
` </section>
`
));
return result;
}))).concat([new Buffer(
` </div>
</body>
</html>
`
)]))
});
});
}

View File

@ -0,0 +1,24 @@
// Type definitions for Node.js v0.12.0
// Project: http://nodejs.org/
// Definitions by: Microsoft TypeScript <http://typescriptlang.org>, DefinitelyTyped <https://github.com/borisyankov/DefinitelyTyped>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
declare var require: {
resolve(id: string): string;
};
interface BufferConstructor {
new (str: string): Buffer;
prototype: Buffer;
concat(list: Buffer[]): Buffer;
}
declare module "fs" {
export function existsSync(filename: string): boolean;
export function readFileSync(filename: string, options: { encoding: string }): string;
}
declare module "path" {
export function basename(p: string, ext?: string): string;
export function extname(p: string): string;
}

View File

@ -0,0 +1,26 @@
{
"compilerOptions": {
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"noUnusedLocals": true,
"noUnusedParameters": false,
"strictNullChecks": false,
"target": "es5",
"module": "commonjs",
"moduleResolution": "classic",
"noImplicitUseStrict": false,
"types": []
},
"files": [
"./typescript/index.ts",
"./doc.ts",
"./node.d.ts",
"./typescript/typescript.d.ts",
"../node_modules/async-build/typings.d.ts"
]
}

View File

@ -0,0 +1,204 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import ts = require("typescript");
export class HasParent {
public parent: HasParent = null;
constructor(public name: string) { }
get fullName(): string {
if (this.parent === null) {
return this.name;
}
const parent = this.parent;
if (parent instanceof Namespace) {
return parent.getMemberFullName(this);
}
return `${ this.parent.fullName }.${ this.name }`;
}
}
export class Module extends HasParent {
public parent: Module = null;
public members: { [name: string]: ModuleMember } = Object.create(null);
constructor(public fileName: string) {
super(fileName);
}
}
export type ModuleMember = Class | Interface | Function | Property | Enum | Reference;
export type ModuleMemberWithoutReference = Class | Interface | Function | Property | Enum;
export class Reference {
constructor(public moduleName: string, public name: string, public isPrivate: boolean) { }
}
export class Namespace extends HasParent {
public parent: Namespace = null;
public members: { [name: string]: NamespaceMember } = Object.create(null);
constructor(name: string) {
super(name);
}
getMemberFullName(member: HasParent) {
return `${ this.fullName }.${ member.name }`;
}
}
export type NamespaceMember = Class | Interface | Function | Property | Enum;
export class Class extends HasParent {
public parent: Module | Namespace = null;
public unresolvedBaseType: UnresolvedType | TypeReference | IntrinsicTypeReference;
public baseType: TypeReference | IntrinsicTypeReference = null;
public unresolvedInterfaces: (UnresolvedType | TypeReference | IntrinsicTypeReference)[];
public interfaces: (TypeReference | IntrinsicTypeReference)[] = [];
public members: { [name: string]: InterfaceMember } = Object.create(null);
constructor(name: string, public astNode: ts.Node, public description: string, public generics: string[], public parameters: Parameter[], baseType: UnresolvedType | TypeReference | IntrinsicTypeReference, interfaces: (UnresolvedType | TypeReference | IntrinsicTypeReference)[], public isAbstract: boolean, public isPrivate: boolean) {
super(name);
this.unresolvedBaseType = baseType;
this.unresolvedInterfaces = interfaces;
}
}
export type InterfaceMember = Property | Function;
export class Interface extends HasParent {
public parent: Module | Namespace = null;
public unresolvedBaseTypes: (UnresolvedType | TypeReference | IntrinsicTypeReference)[];
public baseTypes: (TypeReference | IntrinsicTypeReference)[] = [];
public members: { [name: string]: InterfaceMember } = Object.create(null);
constructor(name: string, public astNode: ts.Node, public description: string, public generics: string[], baseTypes: (UnresolvedType | TypeReference | IntrinsicTypeReference)[], public isPrivate: boolean) {
super(name);
this.unresolvedBaseTypes = baseTypes;
}
}
export class Function extends HasParent {
public parent: Module | Namespace | Class | Interface = null;
constructor(name: string, public astNode: ts.Node, public description: string, public generics: string[], public parameters: Parameter[], public returnType: ReturnType, public isAbstract: boolean, public isPrivate: boolean, public isProtected: boolean, public isStatic: boolean) {
super(name);
}
}
export class Property extends HasParent {
public parent: Module | Namespace | Class | Interface = null;
public getter: Getter = null;
public setter: Setter = null;
constructor(name: string) {
super(name);
}
}
export class Getter {
constructor(public astNode: ts.Node, public description: string, public type: string, public isPrivate: boolean) { }
}
export class Setter {
constructor(public astNode: ts.Node, public description: string, public type: string, public isPrivate: boolean) { }
}
export class Parameter {
public subParameters: Parameter[] = [];
constructor(public name: string, public description: string, public type: string) { }
}
export class ReturnType {
constructor(public description: string, public type: string) { }
}
export class Enum extends HasParent {
public parent: Module | Namespace = null;
public members: EnumMember[] = [];
constructor(name: string, public astNode: ts.Node, public description: string, public isPrivate: boolean) {
super(name);
}
}
export class EnumMember extends HasParent {
public parent: Enum = null;
constructor(name: string, public description: string, public value: number) {
super(name);
}
}
export class TypeReference {
constructor(public type: NamespaceMember, public generics: (TypeReference | IntrinsicTypeReference)[]) { }
get name(): string {
return this.type.name;
}
get fullName(): string {
return this.type.fullName;
}
}
export class IntrinsicTypeReference {
public fullName: string;
constructor(public name: string) {
this.fullName = name;
}
}
export class UnresolvedType {
constructor(public symbol: ts.Symbol, public generics: (UnresolvedType | IntrinsicTypeReference)[]) { }
}
export type HasStringGenerics = Class | Interface | Function;
export function hasStringGenerics(item: NamespaceMember): item is HasStringGenerics {
return (item as HasGenerics).generics !== undefined;
}
export type HasGenerics = HasStringGenerics | TypeReference;
export function hasGenerics(item: ModuleMember | EnumMember | TypeReference): item is HasGenerics {
return (item as HasGenerics).generics !== undefined;
}
export type CanBePrivate = Class | Interface | Function | Getter | Setter | Enum | Reference;
export type CanBeProtected = Function;
export type CanBeStatic = Function;

View File

@ -0,0 +1,308 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import path = require("path");
import ts = require("typescript");
import { File, FileTransform } from "async-build";
import * as AST from "./ast";
import { walk } from "./walker";
export interface StreamingCompilerHost extends ts.CompilerHost {
setOutputStream(outputStream: FileTransform): void;
}
function createCompilerHost(options: ts.CompilerOptions): StreamingCompilerHost {
const host = ts.createCompilerHost(options) as StreamingCompilerHost;
let _outputStream: FileTransform = null;
host.setOutputStream = outputStream => _outputStream = outputStream;
host.writeFile = (fileName, data, writeByteOrderMark, onError?, sourceFiles?): void => {
_outputStream.push({
path: fileName,
contents: new Buffer(data)
});
};
host.useCaseSensitiveFileNames = () => true;
host.getNewLine = () => "\n";
return host;
}
export class Compiler {
private _projectRoot: string = null;
private _host: StreamingCompilerHost;
private _program: ts.Program = null;
compile(projectConfigFile: File) {
this._projectRoot = path.dirname(projectConfigFile.path);
const projectConfig = ts.parseJsonConfigFileContent(JSON.parse(projectConfigFile.contents.toString()), ts.sys, this._projectRoot);
this._host = createCompilerHost(projectConfig.options);
this._program = ts.createProgram(projectConfig.fileNames, projectConfig.options, this._host);
const syntacticDiagnostics = this._program.getSyntacticDiagnostics();
if (syntacticDiagnostics.length > 0) {
this._reportDiagnostics(syntacticDiagnostics);
throw new Error("There were one or more syntactic diagnostics.");
}
const optionsDiagnostics = this._program.getOptionsDiagnostics();
if (optionsDiagnostics.length > 0) {
this._reportDiagnostics(optionsDiagnostics);
throw new Error("There were one or more options diagnostics.");
}
const globalDiagnostics = this._program.getGlobalDiagnostics();
if (globalDiagnostics.length > 0) {
this._reportDiagnostics(globalDiagnostics);
throw new Error("There were one or more global diagnostics.");
}
const semanticDiagnostics = this._program.getSemanticDiagnostics();
if (semanticDiagnostics.length > 0) {
this._reportDiagnostics(semanticDiagnostics);
throw new Error("There were one or more semantic diagnostics.");
}
};
writeFiles(outputStream: FileTransform) {
this._host.setOutputStream(outputStream);
const emitDiagnostics = this._program.emit().diagnostics;
if (emitDiagnostics.length > 0) {
this._reportDiagnostics(emitDiagnostics);
throw new Error("There were one or more emit diagnostics.");
}
};
get projectRoot(): string {
return this._projectRoot;
}
get typeChecker(): ts.TypeChecker {
return this._program.getTypeChecker();
}
get sourceFiles(): ts.SourceFile[] {
return this._program.getSourceFiles();
}
private _reportDiagnostics(diagnostics: ts.Diagnostic[]) {
for (const diagnostic of diagnostics) {
let message = "";
if (diagnostic.file) {
const location = ts.getLineAndCharacterOfPosition(diagnostic.file, diagnostic.start);
message = `${ diagnostic.file.fileName }(${ location.line + 1 },${ location.character }): `;
}
message +=
ts.DiagnosticCategory[diagnostic.category].toLowerCase() +
` TS${ diagnostic.code }: ` +
ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
console.error(message);
}
};
}
export function build(root: string, rootNamespaceName: string): FileTransform {
const compiler = new Compiler();
return new FileTransform(function (projectConfigFile): void {
console.log("Compiling " + projectConfigFile.path + "...");
compiler.compile(projectConfigFile);
const walkResult = walk(compiler, root, rootNamespaceName);
addJSDocComments(walkResult.modules);
compiler.writeFiles(this);
console.log("Compile succeeded.");
});
}
function addJSDocComments(modules: { [name: string]: AST.Module }): void {
function visitor(current: AST.Module | AST.ModuleMember | AST.InterfaceMember) {
if (current instanceof AST.Module) {
for (const memberName of Object.keys(current.members)) {
visitor(current.members[memberName]);
}
return;
}
const newComments: string[] = [];
if (current instanceof AST.Class) {
newComments.push("@constructor");
if (current.baseType !== null) {
const baseType = current.baseType;
newComments.push(
"@extends {" +
baseType.fullName + (
(baseType instanceof AST.TypeReference && baseType.generics.length) > 0 ?
(".<" + (baseType as AST.TypeReference).generics.map(generic => generic.fullName).join(", ") + ">") :
""
) +
"}"
);
}
if (current.interfaces.length > 0) {
current.interfaces.forEach(interfase => {
newComments.push(
"@implements {" +
interfase.fullName + (
(interfase instanceof AST.TypeReference && interfase.generics.length > 0) ?
(".<" + interfase.generics.map(generic => generic.fullName).join(", ") + ">") :
""
) +
"}"
);
});
}
Object.keys(current.members).forEach(memberName => visitor(current.members[memberName]));
}
else if (current instanceof AST.Enum) {
newComments.push("@enum");
}
else if (current instanceof AST.Reference) {
return;
}
if (current.parent instanceof AST.Namespace) {
newComments.push("@memberOf " + current.parent.fullName);
}
if (AST.hasStringGenerics(current) && current.generics.length > 0) {
newComments.push("@template " + current.generics.join(", "));
}
if ((current as AST.CanBePrivate).isPrivate) {
newComments.push("@private");
}
if ((current as AST.CanBeProtected).isProtected) {
newComments.push("@protected");
}
if ((current as AST.CanBeStatic).isStatic) {
newComments.push("@static");
}
if (newComments.length > 0) {
if (current instanceof AST.Property) {
const nodes: ts.Node[] = [];
if (current.getter !== null) { nodes.push(current.getter.astNode); }
if (current.setter !== null && nodes[0] !== current.setter.astNode) { nodes.push(current.setter.astNode); }
for (const node of nodes) {
(node as any)["typescript-new-comment"] = newComments;
}
}
else {
(current.astNode as any)["typescript-new-comment"] = newComments;
}
}
}
for (const moduleName of Object.keys(modules)) {
visitor(modules[moduleName]);
}
}
class FakeSourceFile {
public text: string;
public lineMap: number[];
constructor(originalSourceFile: ts.SourceFile) {
this.text = originalSourceFile.text;
this.lineMap = ts.getLineStarts(originalSourceFile).slice();
}
addComment(originalComment: ts.CommentRange, newComments: string[]): ts.CommentRange & { sourceFile: FakeSourceFile } {
var pos = this.text.length;
this.text += "/**\n";
this.lineMap.push(this.text.length);
var originalCommentLines = this.text.substring(originalComment.pos, originalComment.end).split("\n");
originalCommentLines.shift();
originalCommentLines = originalCommentLines.map(line => line.replace(/^\s+/, " "));
if (originalCommentLines.length > 1) {
originalCommentLines.splice(originalCommentLines.length - 1, 0, " *");
}
for (const newComment of newComments) {
originalCommentLines.splice(originalCommentLines.length - 1, 0, " * " + newComment);
}
for (const newCommentLine of originalCommentLines) {
this.text += newCommentLine + "\n";
this.lineMap.push(this.text.length);
}
var end = this.text.length;
return { pos, end, hasTrailingNewLine: originalComment.hasTrailingNewLine, kind: ts.SyntaxKind.MultiLineCommentTrivia, sourceFile: this };
}
}
var fakeSourceFiles: { [name: string]: FakeSourceFile } = Object.create(null);
export const oldGetLeadingCommentRangesOfNodeFromText: typeof ts.getLeadingCommentRangesOfNodeFromText = ts.getLeadingCommentRangesOfNodeFromText.bind(ts);
ts.getLeadingCommentRangesOfNodeFromText = (node: ts.Node, text: string) => {
const originalComments = oldGetLeadingCommentRangesOfNodeFromText(node, text);
if (originalComments !== undefined && (<any>node)["typescript-new-comment"] !== undefined) {
const sourceFileOfNode = ts.getSourceFileOfNode(node);
let fakeSourceFile = fakeSourceFiles[sourceFileOfNode.fileName];
if (fakeSourceFile === undefined) {
fakeSourceFile = fakeSourceFiles[sourceFileOfNode.fileName] = new FakeSourceFile(sourceFileOfNode);
}
originalComments[originalComments.length - 1] = fakeSourceFile.addComment(originalComments[originalComments.length - 1], (<any>node)["typescript-new-comment"]);
}
return originalComments;
};
var oldWriteCommentRange: typeof ts.writeCommentRange = ts.writeCommentRange.bind(ts);
ts.writeCommentRange = (text: string, lineMap: number[], writer: ts.EmitTextWriter, comment: ts.CommentRange, newLine: string) => {
if ((<{ sourceFile: ts.SourceFile }><any>comment).sourceFile) {
const currentSourceFile = (<{ sourceFile: ts.SourceFile }><any>comment).sourceFile;
text = currentSourceFile.text;
lineMap = currentSourceFile.lineMap;
}
return oldWriteCommentRange(text, lineMap, writer, comment, newLine);
};

View File

@ -0,0 +1,22 @@
declare namespace ts {
interface EmitTextWriter { }
interface IntrinsicType extends Type {
intrinsicName: string;
}
interface SourceFile {
lineMap: number[];
}
function forEachProperty<T, U>(map: Map<T>, callback: (value: T, key: string) => U): U;
function getClassExtendsHeritageClauseElement(node: ClassLikeDeclaration | InterfaceDeclaration): ExpressionWithTypeArguments;
function getClassImplementsHeritageClauseElements(node: ClassLikeDeclaration): ExpressionWithTypeArguments[];
function getInterfaceBaseTypeNodes(node: InterfaceDeclaration): ExpressionWithTypeArguments[];
function getLeadingCommentRangesOfNodeFromText(node: Node, text: string): CommentRange[];
function getLineStarts(sourceFile: SourceFile): number[];
function getSourceFileOfNode(node: Node): SourceFile;
function getTextOfNode(node: Node, includeTrivia?: boolean): string;
function normalizeSlashes(path: string): string;
function writeCommentRange(text: string, lineMap: number[], writer: EmitTextWriter, comment: CommentRange, newLine: string): void;
}

View File

@ -0,0 +1,21 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export { build } from "./compiler";

View File

@ -0,0 +1,888 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import path = require("path");
import ts = require("typescript");
import { Compiler, oldGetLeadingCommentRangesOfNodeFromText } from "./compiler";
import * as AST from "./ast";
function hasModifier(node: ts.Node, flags: ts.NodeFlags): boolean {
return (node.flags & flags) !== 0;
}
interface JSDoc {
description: string;
isAbstract: boolean;
parameters: { [name: string]: AST.Parameter };
returnType: AST.ReturnType;
typeAnnotation: string;
}
class WalkerScope {
private _scopes: AST.HasParent[] = [];
get current(): AST.HasParent {
return (this._scopes.length > 0) ? this._scopes[this._scopes.length - 1] : null;
}
enter<T extends AST.HasParent>(scope: T): T {
scope.parent = this.current;
this._scopes.push(scope);
return scope;
}
leave(): void {
this._scopes.pop();
}
}
class Walker {
private _typeChecker: ts.TypeChecker;
private _globalNS: AST.Namespace = new AST.Namespace("Global");
private _scope: WalkerScope = new WalkerScope();
private _currentSourceFile: ts.SourceFile;
public modules: { [name: string]: AST.Module } = Object.create(null);
public namespaces: { [name: string]: AST.Namespace } = Object.create(null);
constructor(private _compiler: Compiler) {
this._typeChecker = _compiler.typeChecker;
this._globalNS.getMemberFullName = member => member.name;
}
walk(sourceFile: ts.SourceFile): void {
const moduleName = this._moduleNameFromFileName(sourceFile.fileName);
if (!(moduleName in this.modules)) {
this.modules[moduleName] = new AST.Module(moduleName);
}
const module = this._scope.enter(this.modules[moduleName]);
this._currentSourceFile = sourceFile;
for (const statement of sourceFile.statements) {
this._walk(statement, module);
}
this._scope.leave();
}
private _walk(node: ts.Node, parent: AST.Module): void {
switch (node.kind) {
case ts.SyntaxKind.VariableStatement:
this._visitVariableStatement(node as ts.VariableStatement, parent);
break;
case ts.SyntaxKind.FunctionDeclaration:
this._visitFunctionDeclaration(node as ts.FunctionDeclaration, parent);
break;
case ts.SyntaxKind.ClassDeclaration:
this._visitClassDeclaration(node as ts.ClassDeclaration, parent);
break;
case ts.SyntaxKind.InterfaceDeclaration:
this._visitInterfaceDeclaration(node as ts.InterfaceDeclaration, parent);
break;
case ts.SyntaxKind.EnumDeclaration:
this._visitEnumDeclaration(node as ts.EnumDeclaration, parent);
break;
case ts.SyntaxKind.ImportDeclaration:
this._visitImportDeclaration(node as ts.ImportDeclaration, parent);
break;
case ts.SyntaxKind.ExportDeclaration:
this._visitExportDeclaration(node as ts.ExportDeclaration, parent);
break;
case ts.SyntaxKind.ExpressionStatement:
case ts.SyntaxKind.ForOfStatement:
case ts.SyntaxKind.IfStatement:
case ts.SyntaxKind.TypeAliasDeclaration:
break;
default:
console.error(node.kind, ts.SyntaxKind[node.kind], node);
throw new Error("Unrecognized node.");
}
}
private _walkClassMember(node: ts.Node, clazz: AST.Class): void {
switch (node.kind) {
case ts.SyntaxKind.PropertySignature:
case ts.SyntaxKind.PropertyDeclaration:
this._visitProperty(node as ts.PropertyDeclaration, clazz);
break;
case ts.SyntaxKind.MethodSignature:
case ts.SyntaxKind.MethodDeclaration:
this._visitMethod(node as ts.MethodDeclaration, clazz);
break;
case ts.SyntaxKind.GetAccessor:
this._visitGetAccessor(node as ts.AccessorDeclaration, clazz);
break;
case ts.SyntaxKind.SetAccessor:
this._visitSetAccessor(node as ts.AccessorDeclaration, clazz);
break;
case ts.SyntaxKind.TypeParameter:
case ts.SyntaxKind.Parameter:
case ts.SyntaxKind.Constructor:
break;
default:
console.error(node.kind, ts.SyntaxKind[node.kind], node);
throw new Error("Unrecognized node.");
}
}
private _walkInterfaceMember(node: ts.Node, interfase: AST.Interface): void {
switch (node.kind) {
case ts.SyntaxKind.PropertySignature:
case ts.SyntaxKind.PropertyDeclaration:
this._visitProperty(node as ts.PropertyDeclaration, interfase);
break;
case ts.SyntaxKind.MethodSignature:
case ts.SyntaxKind.MethodDeclaration:
this._visitMethod(node as ts.MethodDeclaration, interfase);
break;
case ts.SyntaxKind.TypeParameter:
case ts.SyntaxKind.CallSignature:
case ts.SyntaxKind.ConstructSignature:
case ts.SyntaxKind.IndexSignature:
break;
default:
console.error(node.kind, ts.SyntaxKind[node.kind], node);
throw new Error("Unrecognized node.");
}
}
private _visitProperty(node: ts.PropertyDeclaration, parent: AST.Class | AST.Interface) {
if (hasModifier(node, ts.NodeFlags.Private)) {
return;
}
const jsDoc = this._parseJSDoc(node);
if (jsDoc.typeAnnotation === null) {
this._notifyIncorrectJsDoc(`Field ${ ts.getTextOfNode(node.name) } has no @type annotation.`);
jsDoc.typeAnnotation = "*";
}
const property = this._scope.enter(new AST.Property(ts.getTextOfNode(node.name)));
parent.members[property.name] = property;
property.getter = new AST.Getter(node, jsDoc.description, jsDoc.typeAnnotation, false);
property.setter = new AST.Setter(node, jsDoc.description, jsDoc.typeAnnotation, false);
this._scope.leave();
}
private _visitMethod(node: ts.MethodDeclaration, parent: AST.Class | AST.Interface) {
const jsDoc = this._parseJSDoc(node);
const parameters = this._connectParameters(node.parameters, jsDoc.parameters,
parameterName => `Could not find @param annotation for ${ parameterName } on method ${ ts.getTextOfNode(node.name) }`
);
if (jsDoc.returnType === null && (node.type === undefined || node.type.kind !== ts.SyntaxKind.VoidKeyword)) {
this._notifyIncorrectJsDoc(`Missing @return annotation for method ${ ts.getTextOfNode(node.name) }`);
jsDoc.returnType = new AST.ReturnType("", "*");
}
const isPrivate = hasModifier(node, ts.NodeFlags.Private);
const isProtected = hasModifier(node, ts.NodeFlags.Protected);
const isStatic = hasModifier(node, ts.NodeFlags.Static);
const generics = this._getGenericsOfSignatureDeclaration(node);
const method = this._scope.enter(new AST.Function(ts.getTextOfNode(node.name), node, jsDoc.description, generics, parameters, jsDoc.returnType, jsDoc.isAbstract, isPrivate, isProtected, isStatic));
parent.members[method.name] = method;
this._scope.leave();
}
private _visitGetAccessor(node: ts.AccessorDeclaration, clazz: AST.Class): void {
const jsDoc = this._parseJSDoc(node);
const name = ts.getTextOfNode(node.name);
const isPrivate = hasModifier(node, ts.NodeFlags.Private);
let property = clazz.members[name] as AST.Property;
if (property === undefined) {
this._scope.enter(property = new AST.Property(name));
clazz.members[property.name] = property;
this._scope.leave();
}
if (jsDoc.typeAnnotation === null) {
this._notifyIncorrectJsDoc(`Getter ${ name } has no @type annotation.`);
}
property.getter = new AST.Getter(node, jsDoc.description, jsDoc.typeAnnotation, isPrivate);
}
private _visitSetAccessor(node: ts.AccessorDeclaration, clazz: AST.Class): void {
const jsDoc = this._parseJSDoc(node);
const name = ts.getTextOfNode(node.name);
const isPrivate = hasModifier(node, ts.NodeFlags.Private);
let property = clazz.members[name] as AST.Property;
if (property === undefined) {
this._scope.enter(property = new AST.Property(name));
clazz.members[property.name] = property;
this._scope.leave();
}
if (jsDoc.typeAnnotation === null) {
this._notifyIncorrectJsDoc(`Setter ${ name } has no @type annotation.`);
}
property.setter = new AST.Setter(node, jsDoc.description, jsDoc.typeAnnotation, isPrivate);
}
private _visitVariableStatement(node: ts.VariableStatement, parent: AST.Module): void {
if (node.declarationList.declarations.length > 1) {
return;
}
const declaration = node.declarationList.declarations[0];
if (hasModifier(declaration, ts.NodeFlags.Ambient)) {
return;
}
const jsDoc = this._parseJSDoc(node);
if (jsDoc.typeAnnotation === null) {
return;
}
const property = this._scope.enter(new AST.Property(ts.getTextOfNode(declaration.name)));
property.getter = new AST.Getter(node, jsDoc.description, jsDoc.typeAnnotation, false);
parent.members[property.name] = property;
this._scope.leave();
}
private _visitFunctionDeclaration(node: ts.FunctionDeclaration, parent: AST.Module): void {
const jsDoc = this._parseJSDoc(node);
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
const generics = this._getGenericsOfSignatureDeclaration(node);
const parameters = this._connectParameters(node.parameters, jsDoc.parameters,
parameterName => `Could not find @param annotation for ${ parameterName } on function ${ node.name.text }`
);
if (node.type === undefined) {
this._notifyIncorrectJsDoc(`Missing return type annotation for function ${ node.name.text }`);
jsDoc.returnType = new AST.ReturnType("", "*");
}
else if (jsDoc.returnType === null && node.type.kind !== ts.SyntaxKind.VoidKeyword) {
this._notifyIncorrectJsDoc(`Missing @return annotation for function ${ node.name.text }`);
jsDoc.returnType = new AST.ReturnType("", "*");
}
const freeFunction = this._scope.enter(new AST.Function(node.name.text, node, jsDoc.description, generics, parameters, jsDoc.returnType, jsDoc.isAbstract, isPrivate, false, false));
parent.members[freeFunction.name] = freeFunction;
this._scope.leave();
}
private _visitClassDeclaration(node: ts.ClassDeclaration, parent: AST.Module): void {
const jsDoc = this._parseJSDoc(node);
const type = this._typeChecker.getTypeAtLocation(node) as ts.InterfaceType;
const generics = this._getGenericsOfInterfaceType(type);
const baseTypeHeritageClauseElement = ts.getClassExtendsHeritageClauseElement(node) || null;
let baseType: AST.UnresolvedType = null;
if (baseTypeHeritageClauseElement !== null) {
baseType = new AST.UnresolvedType(
this._typeChecker.getTypeAtLocation(baseTypeHeritageClauseElement).symbol,
this._getGenericsOfTypeReferenceNode(baseTypeHeritageClauseElement, generics)
);
}
const interfaces = (ts.getClassImplementsHeritageClauseElements(node) || []).map(type => new AST.UnresolvedType(
this._typeChecker.getTypeAtLocation(type).symbol,
this._getGenericsOfTypeReferenceNode(type, generics)
));
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
let parameters: AST.Parameter[] = [];
if (type.symbol.members["__constructor"] !== undefined) {
parameters = this._connectParameters((type.symbol.members["__constructor"].declarations[0] as ts.ConstructorDeclaration).parameters, jsDoc.parameters,
parameterName => `Could not find @param annotation for ${ parameterName } on constructor in class ${ node.name.text }`
);
}
else if (Object.keys(jsDoc.parameters).length > 0) {
this._notifyIncorrectJsDoc("There are @param annotations on this class but it has no constructors.");
}
const clazz = this._scope.enter(new AST.Class(node.name.text, node, jsDoc.description, generics, parameters, baseType, interfaces, jsDoc.isAbstract, isPrivate));
parent.members[clazz.name] = clazz;
ts.forEachProperty(type.symbol.exports, symbol => {
if (symbol.name === "prototype") {
return;
}
for (const declaration of symbol.declarations) {
this._walkClassMember(declaration, clazz);
}
});
ts.forEachProperty(type.symbol.members, symbol => {
for (const declaration of symbol.declarations) {
this._walkClassMember(declaration, clazz);
}
});
this._scope.leave();
}
private _visitInterfaceDeclaration(node: ts.InterfaceDeclaration, parent: AST.Module): void {
const jsDoc = this._parseJSDoc(node);
const type = this._typeChecker.getTypeAtLocation(node) as ts.InterfaceType;
const generics = this._getGenericsOfInterfaceType(type);
const baseTypes = (ts.getInterfaceBaseTypeNodes(node) || []).map(type => new AST.UnresolvedType(
this._typeChecker.getTypeAtLocation(type).symbol,
this._getGenericsOfTypeReferenceNode(type, generics)
));
const existingInterfaceType = parent.members[node.name.text];
if (existingInterfaceType !== undefined) {
return;
}
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
const interfase = this._scope.enter(new AST.Interface(node.name.text, node, jsDoc.description, generics, baseTypes, isPrivate));
parent.members[interfase.name] = interfase;
ts.forEachProperty(type.symbol.members, symbol => {
for (const declaration of symbol.declarations) {
this._walkInterfaceMember(declaration, interfase);
}
});
this._scope.leave();
}
private _visitEnumDeclaration(node: ts.EnumDeclaration, parent: AST.Module): void {
const jsDoc = this._parseJSDoc(node);
const existingEnumType = parent.members[node.name.text];
if (existingEnumType !== undefined) {
return;
}
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
const type = this._typeChecker.getTypeAtLocation(node);
const enumType = this._scope.enter(new AST.Enum(node.name.text, node, jsDoc.description, isPrivate));
parent.members[enumType.name] = enumType;
ts.forEachProperty(type.symbol.exports, symbol => {
this._visitEnumMember(symbol.declarations[0] as ts.EnumMember, enumType);
});
this._scope.leave();
}
private _visitEnumMember(node: ts.EnumMember, parent: AST.Enum): void {
const jsDoc = this._parseJSDoc(node);
const value = (node.initializer === undefined) ? null : parseInt((node.initializer as ts.LiteralExpression).text);
const enumMember = this._scope.enter(new AST.EnumMember(ts.getTextOfNode(node.name), (jsDoc === null) ? "" : jsDoc.description, value));
parent.members.push(enumMember);
this._scope.leave();
}
private _visitImportDeclaration(node: ts.ImportDeclaration, parent: AST.Module): void {
if (node.importClause === undefined) {
// import "foo";
return;
}
if (node.importClause.namedBindings === undefined) {
throw new Error("Default import is not supported.");
}
const moduleName = this._resolve((node.moduleSpecifier as ts.LiteralExpression).text, parent);
if ((node.importClause.namedBindings as ts.NamespaceImport).name !== undefined) {
// import * as foo from "baz";
parent.members[(node.importClause.namedBindings as ts.NamespaceImport).name.text] = new AST.Reference(moduleName, "*", true);
}
else if ((node.importClause.namedBindings as ts.NamedImports).elements !== undefined) {
// import { foo, bar } from "baz";
for (const element of (node.importClause.namedBindings as ts.NamedImports).elements) {
const importedName = element.propertyName && element.propertyName.text || element.name.text;
parent.members[element.name.text] = new AST.Reference(moduleName, importedName, true);
}
}
else {
throw new Error("Unrecognized import declaration syntax.");
}
}
private _visitExportDeclaration(node: ts.ExportDeclaration, parent: AST.Module): void {
if (node.moduleSpecifier !== undefined) {
// export { foo } from "bar";
const moduleName = this._resolve((node.moduleSpecifier as ts.LiteralExpression).text, parent);
for (const element of node.exportClause.elements) {
const importedName = element.propertyName && element.propertyName.text || element.name.text;
parent.members[element.name.text] = new AST.Reference(moduleName, importedName, false);
}
}
else {
// export { foo };
for (const element of node.exportClause.elements) {
(parent.members[element.name.text] as AST.CanBePrivate).isPrivate = false;
}
}
}
private _resolve(relativeModuleName: string, currentModule: AST.Module): string {
let result = ts.normalizeSlashes(path.join(currentModule.name, `../${ relativeModuleName }`));
if (result[0] !== ".") {
result = `./${ result }`;
}
return result;
}
private _parseJSDoc(node: ts.Node): JSDoc {
let comments = oldGetLeadingCommentRangesOfNodeFromText(node, this._currentSourceFile.text);
if (comments === undefined) {
comments = [];
}
if (comments.length > 1) {
comments = [comments[comments.length - 1]];
}
const comment =
(comments.length === 0) ?
"" :
this._currentSourceFile.text.substring(comments[0].pos, comments[0].end);
const commentStartIndex = comment.indexOf("/**");
const commentEndIndex = comment.lastIndexOf("*/");
const lines =
(commentStartIndex === -1 || commentEndIndex === -1) ?
[] :
comment.substring(commentStartIndex + 2, commentEndIndex).split("\n").map(line => {
const match = line.match(/^[ \t]*\* (.*)/);
if (match === null) {
return "";
}
return match[1];
});
let rootDescription = "";
const parameters: { [name: string]: AST.Parameter } = Object.create(null);
let typeAnnotation: string = null;
let returnType: AST.ReturnType = null;
let isAbstract = false;
let lastRead: { description: string } = null;
for (const line of lines) {
const firstWordMatch = line.match(/^\s*(\S+)(\s*)/);
const firstWord = (firstWordMatch !== null) ? firstWordMatch[1] : "";
let remainingLine = (firstWordMatch !== null) ? line.substring(firstWordMatch[0].length) : "";
if (firstWord[0] === "@") {
lastRead = null;
}
switch (firstWord) {
case "@abstract":
isAbstract = true;
break;
case "@param": {
let type: string;
[type, remainingLine] = this._readType(remainingLine);
const [, name, description] = remainingLine.match(/(\S+)\s*(.*)/);
const subParameterMatch = name.match(/^(?:(.+)\.([^\.]+))|(?:(.+)\[("[^\[\]"]+")\])$/);
if (subParameterMatch === null) {
parameters[name] = lastRead = new AST.Parameter(name, description, type);
}
else {
const parentName = subParameterMatch[1] || subParameterMatch[3];
const childName = subParameterMatch[2] || subParameterMatch[4];
const parentParameter = parameters[parentName];
parentParameter.subParameters.push(lastRead = new AST.Parameter(childName, description, type));
}
break;
}
case "@return": {
const [type, description] = this._readType(remainingLine);
returnType = lastRead = new AST.ReturnType(description, type);
break;
}
case "@type":
[typeAnnotation] = this._readType(remainingLine);
break;
default:
if (lastRead !== null) {
lastRead.description += "\n" + line;
}
else {
rootDescription += ((rootDescription.length > 0) ? "\n" : "") + line;
}
break;
}
}
return {
description: rootDescription,
isAbstract: isAbstract,
parameters: parameters,
returnType: returnType,
typeAnnotation: typeAnnotation,
};
}
private _readType(remainingLine: string): [string, string] {
if (remainingLine[0] !== "{") {
return ["*", remainingLine];
}
let index = -1;
let numberOfUnterminatedBraces = 0;
for (let i = 0; i < remainingLine.length; i++) {
if (remainingLine[i] === "{") {
numberOfUnterminatedBraces++;
}
else if (remainingLine[i] === "}") {
numberOfUnterminatedBraces--;
if (numberOfUnterminatedBraces === 0) {
index = i;
break;
}
}
}
if (index === -1) {
throw new Error("Unterminated type specifier.");
}
const type = remainingLine.substr(1, index - 1);
remainingLine = remainingLine.substr(index + 1).replace(/^\s+/, "");
return [type, remainingLine];
}
private _getGenericsOfSignatureDeclaration(signatureDeclaration: ts.SignatureDeclaration): string[] {
if (signatureDeclaration.typeParameters === undefined) {
return [];
}
return signatureDeclaration.typeParameters.map(typeParameter => typeParameter.name.text);
}
private _getGenericsOfTypeReferenceNode(typeReferenceNode: ts.ExpressionWithTypeArguments, intrinsicGenerics: string[]): (AST.UnresolvedType | AST.IntrinsicTypeReference)[] {
if (typeReferenceNode.typeArguments === undefined) {
return [];
}
const typeReference = this._typeChecker.getTypeAtLocation(typeReferenceNode) as ts.TypeReference;
return typeReference.typeArguments.map(typeArgument => {
if ((typeArgument as ts.IntrinsicType).intrinsicName !== undefined) {
return new AST.IntrinsicTypeReference((typeArgument as ts.IntrinsicType).intrinsicName);
}
if (typeArgument.flags & ts.TypeFlags.TypeParameter) {
if (intrinsicGenerics.indexOf(typeArgument.symbol.name) !== -1) {
return new AST.IntrinsicTypeReference(typeArgument.symbol.name);
}
throw new Error(`Unbound type parameter ${ typeArgument.symbol.name }`);
}
return new AST.UnresolvedType(typeArgument.symbol, []);
});
}
private _getGenericsOfInterfaceType(interfaceType: ts.InterfaceType): string[] {
if (interfaceType.typeParameters === undefined) {
return [];
}
return interfaceType.typeParameters.map(typeParameter => {
return typeParameter.symbol.name;
});
}
private _connectParameters(astParameters: ts.ParameterDeclaration[], jsDocParameters: { [name: string]: AST.Parameter }, onMissingMessageCallback: (parameterName: string) => string) {
return astParameters.map(parameter => {
let parameterName = (parameter.name as ts.Identifier).text;
if (parameterName[0] === "_") {
parameterName = parameterName.substr(1);
}
let jsDocParameter = jsDocParameters[parameterName];
if (jsDocParameter === undefined) {
this._notifyIncorrectJsDoc(onMissingMessageCallback.call(this, parameterName));
jsDocParameter = new AST.Parameter(parameterName, "*", "");
}
return jsDocParameter;
});
}
private _notifyIncorrectJsDoc(message: string): void {
const fileName = path.basename(this._currentSourceFile.fileName);
if (fileName === "lib.es5.d.ts" || fileName === "lib.dom.d.ts") {
return;
}
throw new Error(`${ fileName }: ${ this._scope.current.fullName }: ${ message }`);
}
link(rootNamespaceName: string): void {
for (const moduleName of Object.keys(this.modules)) {
const module = this.modules[moduleName];
for (const memberName of Object.keys(module.members)) {
const member = module.members[memberName];
if (member instanceof AST.Class) {
if (member.unresolvedBaseType instanceof AST.UnresolvedType) {
member.baseType = this._resolveTypeReference(member.unresolvedBaseType);
}
else {
member.baseType = member.unresolvedBaseType;
}
member.interfaces = member.unresolvedInterfaces.map(interfase => {
if (interfase instanceof AST.UnresolvedType) {
return this._resolveTypeReference(interfase);
}
return interfase;
});
}
else if (member instanceof AST.Interface) {
member.baseTypes = member.unresolvedBaseTypes.map(baseType => {
if (baseType instanceof AST.UnresolvedType) {
return this._resolveTypeReference(baseType);
}
return baseType;
});
}
else if (member instanceof AST.Enum) {
let value = 0;
for (const enumMember of member.members) {
if (enumMember.value === null) {
enumMember.value = value;
}
else {
value = enumMember.value;
}
value++;
}
}
}
}
this.namespaces[rootNamespaceName] = this._scope.enter(new AST.Namespace(rootNamespaceName));
this._moduleToNamespace(this.modules["./index"]);
this._scope.leave();
}
private _moduleToNamespace(module: AST.Module): void {
for (const memberName of Object.keys(module.members)) {
let member = module.members[memberName];
if (member instanceof AST.Reference) {
if (member.isPrivate) {
continue;
}
if (member.name === "*") {
const newNamespace = this._scope.enter(new AST.Namespace(memberName));
const existingNamespace = this.namespaces[newNamespace.fullName];
if (existingNamespace !== undefined) {
this._scope.leave();
this._scope.enter(existingNamespace);
}
else {
this.namespaces[newNamespace.fullName] = newNamespace;
}
let referencedModuleName = member.moduleName;
let referencedModule = this.modules[referencedModuleName];
if (referencedModule === undefined && ((referencedModuleName + "/index") in this.modules)) {
member.moduleName = referencedModuleName = referencedModuleName + "/index";
referencedModule = this.modules[referencedModuleName];
}
this._moduleToNamespace(referencedModule);
this._scope.leave();
}
else {
while (member instanceof AST.Reference) {
member = this.modules[member.moduleName].members[member.name];
}
this._scope.enter(member);
this._scope.leave();
(this._scope.current as AST.Namespace).members[member.name] = member;
}
}
else if (!(member as AST.CanBePrivate).isPrivate) {
this._scope.enter(member);
this._scope.leave();
(this._scope.current as AST.Namespace).members[member.name] = member;
}
}
}
private _resolveTypeReference(unresolvedType: AST.UnresolvedType): AST.TypeReference | AST.IntrinsicTypeReference {
let node: ts.Node = unresolvedType.symbol.declarations[0];
while (node.kind !== ts.SyntaxKind.SourceFile) {
node = node.parent;
}
const sourceFile = node as ts.SourceFile;
if (sourceFile.fileName.substr(-"globals.d.ts".length) === "globals.d.ts") {
return new AST.IntrinsicTypeReference(unresolvedType.symbol.name);
}
else {
const moduleName = this._moduleNameFromFileName(sourceFile.fileName);
const module = this.modules[moduleName];
let result = module.members[unresolvedType.symbol.name];
if (result === undefined) {
throw new Error(`Type ${unresolvedType.symbol.name} could not be resolved.`);
}
while (result instanceof AST.Reference) {
result = this.modules[result.moduleName].members[result.name];
}
const resultGenerics = unresolvedType.generics.map(generic => {
if (generic instanceof AST.UnresolvedType) {
return this._resolveTypeReference(generic);
}
return generic;
});
return new AST.TypeReference(result, resultGenerics);
}
}
private _moduleNameFromFileName(fileName: string): string {
let result = ts.normalizeSlashes(path.relative(this._compiler.projectRoot, fileName));
result = result.substr(0, result.length - ".ts".length);
if (result[0] !== ".") {
result = `./${ result }`;
}
return result;
}
}
export function walk(compiler: Compiler, root: string, rootNamespaceName: string) {
const sourceFiles = compiler.sourceFiles;
const walker = new Walker(compiler);
// Walk
for (const sourceFile of sourceFiles) {
if (
path.basename(sourceFile.fileName) === "lib.es5.d.ts" ||
path.basename(sourceFile.fileName) === "lib.dom.d.ts" ||
sourceFile.fileName.substr(-"globals.d.ts".length) === "globals.d.ts"
) {
continue;
}
walker.walk(sourceFile);
}
// Link base types and set enum member values if unspecified.
walker.link(rootNamespaceName);
// Return types
return { namespaces: walker.namespaces, modules: walker.modules };
}

View File

@ -0,0 +1,447 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var fs = require("fs");
var path = require("path");
var UglifyJS = require("uglify-js");
var FileTransform = require("async-build").FileTransform;
var Run = (function () {
function Run(outputLibraryName, unusedVarsToIgnore) {
this._outputLibraryName = outputLibraryName;
this._unusedVarsToIgnore = unusedVarsToIgnore;
this._root = UglifyJS.parse(fs.readFileSync(path.resolve(__filename, "..", "umd-wrapper.js"), "utf8"));
this._root.figure_out_scope({ screw_ie8: true });
this._toInsert = null;
this._rootSourceMap = null;
}
Run.prototype.addFile = function (file) {
switch (path.extname(file.path)) {
case ".js":
try {
this._toInsert = UglifyJS.parse(file.contents.toString(), {
filename: path.basename(file.path),
toplevel: null,
}).body;
}
catch (ex) {
if (ex instanceof UglifyJS.JS_Parse_Error) {
throw new Error("UglifyJS parse error: " + ex.toString() + "\n");
}
throw ex;
}
break;
case ".map":
var rawSourceMap = JSON.parse(file.contents.toString());
this._rootSourceMap = UglifyJS.SourceMap({
file: this._outputLibraryName + ".js",
root: "",
orig: rawSourceMap,
});
var generator = this._rootSourceMap.get();
rawSourceMap.sources.forEach(function (sourceRelativePath, index) {
generator.setSourceContent(sourceRelativePath, rawSourceMap.sourcesContent[index]);
});
break;
}
};
Run.prototype.build = function (outputStream) {
var _this = this;
// Splice in the TS output into the UMD wrapper.
var insertionParent = this._root.body[0].body.args[1].body;
this._toInsert.reverse();
for (var i = this._toInsert.length - 1; i >= 0; i--) {
var node = this._toInsert[i];
if (node instanceof UglifyJS.AST_Var) {
for (var j = 0; j < node.definitions.length; j++) {
var definition = node.definitions[j];
if (definition.name.name === "__extends" || definition.name.name === "__decorate") {
definition.value = definition.value.right;
}
}
insertionParent.splice(-1, 0, node);
this._toInsert.splice(i, 1);
}
}
insertionParent.splice.apply(insertionParent, [-1, 0].concat(this._toInsert));
// Fixups
for (var i = 0; i < this._toInsert.length; i++) {
var node = this._toInsert[i];
if (node instanceof UglifyJS.AST_Statement && node.body instanceof UglifyJS.AST_Call && node.body.expression.name === "define") {
var defineCall = node.body;
defineCall.expression.name = "def";
if (defineCall.args[1].elements[0].value !== "require") {
throw new Error("Expected first dep to be require");
}
defineCall.args[1].elements.shift();
defineCall.args[2].argnames.shift();
if (defineCall.args[1].elements[0].value !== "exports") {
throw new Error("Expected second dep to be exports");
}
defineCall.args[1].elements.shift();
defineCall.args[2].argnames.push(defineCall.args[2].argnames.shift());
}
}
// Remove all license headers except the one from the UMD wrapper
var firstLicenseHeader = null;
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node.start) {
(node.start.comments_before || []).some(function (comment, i) {
if (comment.value.indexOf("Copyright") !== -1) {
if (firstLicenseHeader === null) {
firstLicenseHeader = comment;
}
else if (comment !== firstLicenseHeader) {
node.start.comments_before.splice(i, 1);
}
return true;
}
return false;
});
}
}));
// Fixup anonymous functions to print a space after "function"
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node instanceof UglifyJS.AST_Lambda && !node.name) {
node.name = Object.create(UglifyJS.AST_Node.prototype);
node.name.print = function () { };
}
}));
// Fix alignment of multi-line block comments
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node.start && node.start.comments_before) {
node.start.comments_before.forEach(function (comment) {
if (comment.value.indexOf("Copyright") !== -1) {
return;
}
var lines = comment.value.split("\n");
if (lines.length < 2) {
return;
}
var indent = " "; // 5 spaces
for (var i = 0; i < comment.col; i++) {
indent += " ";
}
lines[lines.length - 1] = lines[lines.length - 1].replace(/\s+$/, indent);
comment.value = [lines[0]].concat(lines.slice(1).map(function (line) { return line.replace(/^\s+/, indent); })).join("\n");
});
}
}));
this._root.figure_out_scope({ screw_ie8: true });
// Remove some things from the AST
var nodesToRemove = [];
// Set if there are any unused variables apart from the ones in unusedVarsToIgnore
var haveUnusedVars = false;
// Repeat because removing some declarations may make others unreferenced
for (;;) {
this._root.figure_out_scope({ screw_ie8: true });
// Unreferenced variable and function declarations, and unreferenced terminal function arguments
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node instanceof UglifyJS.AST_SymbolDeclaration && node.unreferenced()) {
if (node instanceof UglifyJS.AST_SymbolFunarg) {
if (this.parent().argnames.indexOf(node) === this.parent().argnames.length - 1) {
nodesToRemove.push({ node: node, parent: this.parent().argnames });
}
}
else if (node instanceof UglifyJS.AST_SymbolVar) {
if (_this._unusedVarsToIgnore.indexOf(node.name) !== -1) {
nodesToRemove.push({ node: this.parent(), parent: this.parent(1).definitions });
if (this.parent(1).definitions.length === 1) {
nodesToRemove.push({ node: this.parent(1), parent: this.parent(2).body });
}
}
else {
haveUnusedVars = true;
}
}
else if (node instanceof UglifyJS.AST_SymbolDefun) {
nodesToRemove.push({ node: this.parent(), parent: this.parent(1).body });
}
}
}));
if (nodesToRemove.length === 0) {
break;
}
nodesToRemove.forEach(function (tuple) {
tuple.parent.splice(tuple.parent.indexOf(tuple.node), 1);
});
nodesToRemove = [];
}
// Move var statements at the end of blocks (generated by TS for rest parameters) to the start of the block.
// This is needed to prevent unreachable-code warnings from UJS
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (
node instanceof UglifyJS.AST_Block &&
node.body[node.body.length - 1] instanceof UglifyJS.AST_Var
) {
node.body.unshift(node.body.pop());
}
}));
// Split multiple vars per declaration into one var per declaration
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (
node instanceof UglifyJS.AST_Var &&
node.definitions.length > 1 &&
this.parent() instanceof UglifyJS.AST_Block
) {
var parent = this.parent().body;
parent.splice.apply(parent, [parent.indexOf(node), 1].concat(node.definitions.map(function (definition) {
return new UglifyJS.AST_Var({ start: node.start, end: node.end, definitions: [definition] });
})));
}
}));
// Rename all function arguments that begin with _ to not have the _.
// This converts the TypeScript syntax of declaring private members in the constructor declaration `function Color(private _red: number, ...)` to `function Color(red, ...)`
// so that it matches the JSDoc (and looks nicer).
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (
node instanceof UglifyJS.AST_SymbolFunarg &&
node.thedef.name[0] === "_" &&
node.thedef.name[1] !== "_" &&
node.thedef.name !== "_super" // Don't rename _super (used in TypeScript's inheritance shim) to super. super is a reserved word.
) {
node.thedef.name = node.thedef.name.slice(1);
}
}));
// Output
var output = {
source_map: this._rootSourceMap,
ascii_only: true,
beautify: true,
comments: function (node, comment) {
return comment.value.indexOf("tslint") === -1;
},
};
var stream = UglifyJS.OutputStream(output);
this._root.print(stream);
outputStream.push({
path: this._outputLibraryName + ".js",
contents: Buffer.concat([new Buffer(stream.toString()), new Buffer("\n//# sourceMappingURL=" + this._outputLibraryName + ".js.map")])
});
outputStream.push({
path: this._outputLibraryName + ".js.map",
contents: new Buffer(this._rootSourceMap.get().toString())
});
// Print unused variables
if (haveUnusedVars) {
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node instanceof UglifyJS.AST_SymbolVar && node.unreferenced()) {
if (_this._unusedVarsToIgnore.indexOf(node.name) === -1) {
console.warn("Unused variable %s at %s:%s:%s", node.name, node.start.file, node.start.line, node.start.col);
}
}
}));
}
};
return Run;
})();
module.exports = {
build: function (outputLibraryName, unusedVarsToIgnore) {
var run = new Run(outputLibraryName, unusedVarsToIgnore);
return new FileTransform(function (file) {
run.addFile(file);
}, function () {
run.build(this);
});
},
watch: function (outputLibraryName, unusedVarsToIgnore) {
var files = Object.create(null);
return new FileTransform(function (file) {
if (file.path !== "END") {
files[file.path] = file;
}
else {
var run = new Run(outputLibraryName, unusedVarsToIgnore);
Object.keys(files).forEach(function (filename) {
run.addFile(files[filename]);
});
run.build(this);
}
});
},
minify: function () {
var codeFile = null;
var sourceMapFile = null;
return new FileTransform(function (file) {
switch (path.extname(file.path)) {
case ".js":
codeFile = file;
break;
case ".map":
sourceMapFile = file;
break;
}
if (codeFile !== null && sourceMapFile !== null) {
UglifyJS.base54.reset();
// Parse
var root = null;
root = UglifyJS.parse(codeFile.contents.toString(), {
filename: path.basename(codeFile.path),
toplevel: root
});
root.figure_out_scope({ screw_ie8: true });
// Warnings
root.scope_warnings({
func_arguments: false
});
// Compress
var compressor = UglifyJS.Compressor({
warnings: true,
screw_ie8: true
});
root = root.transform(compressor);
// Mangle
root.figure_out_scope({ screw_ie8: true });
root.compute_char_frequency();
root.mangle_names({ screw_ie8: true });
root = UglifyJS.mangle_properties(root, {
regex: /^_/
});
// Output
var firstLicenseHeaderFound = false; // To detect and preserve the first license header
var output = {
source_map: UglifyJS.SourceMap({
file: path.basename(sourceMapFile.path),
orig: sourceMapFile.contents.toString()
}),
ascii_only: true,
comments: function (node, comment) {
if (!firstLicenseHeaderFound && comment.value.indexOf("Copyright") !== -1) {
firstLicenseHeaderFound = true;
return true;
}
return false;
},
screw_ie8: true
};
var stream = UglifyJS.OutputStream(output);
root.print(stream);
codeFile.path = codeFile.path.replace(/\.js$/, ".min.js");
sourceMapFile.path = sourceMapFile.path.replace(/\.js\.map$/, ".min.js.map");
codeFile.contents = Buffer.concat([new Buffer(stream.toString()), new Buffer("\n//# sourceMappingURL="), new Buffer(sourceMapFile.path)]);
this.push(codeFile);
var inputSourceMapObject = JSON.parse(sourceMapFile.contents.toString());
var outputSourceMapObject = output.source_map.get();
outputSourceMapObject._sources.toArray().forEach(function (filename, i) {
outputSourceMapObject.setSourceContent(filename, inputSourceMapObject.sourcesContent[i]);
});
sourceMapFile.contents = new Buffer(output.source_map.toString());
this.push(sourceMapFile);
codeFile = null;
sourceMapFile = null;
}
});
}
};
var originalSymbolUnreferenced = UglifyJS.AST_Symbol.prototype.unreferenced;
// Workaround for https://github.com/mishoo/UglifyJS2/issues/789 - Nodes explicitly marked with ujs:unreferenced will not be warned for.
UglifyJS.AST_Symbol.prototype.unreferenced = function () {
if (this.start.comments_before.length > 0 && this.start.comments_before[0].value.trim() === "ujs:unreferenced") {
return false;
}
return originalSymbolUnreferenced.call(this);
};

View File

@ -0,0 +1,65 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @license
*/
(function (root, factory) {
var global = this;
if (typeof define === "function" && define.amd) {
define([], function() {
return factory(global);
});
}
else if (typeof exports === "object" && typeof module === "object") {
module.exports = factory(global);
}
else if (typeof exports === "object") {
exports.libjass = factory(global);
}
else {
root.libjass = factory(global);
}
})(this, function (global) {
"use strict";
var registeredModules = Object.create(null);
var installedModules = Object.create(null);
function def(moduleId, deps, body) {
installedModules[moduleId] = { deps: deps, body: body, };
}
function req(moduleId) {
if (moduleId in registeredModules) {
return registeredModules[moduleId];
}
var exports = registeredModules[moduleId] = Object.create(null);
var deps = installedModules[moduleId].deps.map(req);
deps.push(exports);
installedModules[moduleId].body.apply(null, deps);
return exports;
}
return req("index");
});

View File

@ -0,0 +1,44 @@
{
"name": "libjass",
"version": "0.12.0",
"description": "A library to render ASS subtitles on HTML5 video in the browser.",
"keywords": [
"browser",
"html5",
"subtitles"
],
"homepage": "https://github.com/Arnavion/libjass",
"bugs": "https://github.com/Arnavion/libjass/issues",
"license": "Apache-2.0",
"contributors": [
{
"name": "Arnav Singh",
"email": "arnavion@gmail.com"
}
],
"repository": {
"type": "git",
"url": "https://github.com/Arnavion/libjass"
},
"main": "lib/libjass.js",
"scripts": {
"prepublish": "node ./build.js clean default",
"build": "tsc -p ./build/tsconfig.json",
"test": "node ./build.js test",
"test-lib": "intern-client config=tests/intern reporters=Pretty",
"test-minified": "intern-client config=tests/intern reporters=Pretty minified=true",
"test-browser": "intern-runner config=tests/intern",
"test-doc": "intern-client config=tests/intern-doc reporters=Pretty"
},
"devDependencies": {
"async": "1.x >=1.4",
"async-build": "0.3.1",
"intern": "3.x >=3.2.0",
"npm": "4.x",
"pngjs": "3.x",
"sax": "1.x",
"typescript": "2.0.10",
"uglify-js": "2.x >=2.4.24"
},
"private": true
}

View File

@ -0,0 +1,163 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
interface Array<T> {
filter<S extends T>(callbackfn: (value: T, index: number, array: T[]) => value is S, thisArg?: any): S[];
}
interface WorkerGlobalScope {
postMessage(message: any): void;
addEventListener(type: string, listener: (message: any) => void, useCapture: boolean): void;
}
interface FontFace {
family: string;
load(): Promise<FontFace>;
}
interface FontFaceSet {
add(fontFace: FontFace): FontFaceSet;
forEach(callbackfn: (fontFace: FontFace, index: FontFace, set: FontFaceSet) => void, thisArg?: any): void;
}
interface Map<K, V> {
size: number;
get(key: K): V | undefined;
has(key: K): boolean;
set(key: K, value: V): this;
delete(key: K): boolean;
clear(): void;
forEach(callbackfn: (value: V, index: K, map: this) => void, thisArg?: any): void;
}
interface Node {
cloneNode(deep?: boolean): this;
}
interface Promise<T> extends Thenable<T> {
then<U>(onFulfilled: (value: T) => Thenable<U>, onRejected?: (reason: any) => U | Thenable<U>): Promise<U>;
/* tslint:disable-next-line:unified-signatures */
then<U>(onFulfilled: (value: T) => U, onRejected?: (reason: any) => U | Thenable<U>): Promise<U>;
catch(onRejected: (reason: any) => T | Thenable<T>): Promise<T>;
}
interface ReadableStream {
getReader(): ReadableStreamReader;
}
interface ReadableStreamReader {
read(): Promise<{ value: Uint8Array; done: boolean; }>;
}
interface Set<T> {
size: number;
add(value: T): this;
clear(): void;
has(value: T): boolean;
forEach(callbackfn: (value: T, index: T, set: this) => void, thisArg?: any): void;
}
interface SVGFEComponentTransferElement {
appendChild(newChild: SVGFEFuncAElement): SVGFEFuncAElement;
appendChild(newChild: SVGFEFuncBElement): SVGFEFuncBElement;
appendChild(newChild: SVGFEFuncGElement): SVGFEFuncGElement;
appendChild(newChild: SVGFEFuncRElement): SVGFEFuncRElement;
}
interface SVGFEMergeElement {
appendChild(newChild: SVGFEMergeNodeElement): SVGFEMergeNodeElement;
}
interface TextDecoder {
decode(input: ArrayBuffer | ArrayBufferView, options: { stream: boolean }): string;
}
interface Thenable<T> {
then: ThenableThen<T>;
}
type ThenableThen<T> = (this: Thenable<T>, resolve: ((resolution: T | Thenable<T>) => void) | undefined, reject: ((reason: any) => void) | undefined) => void;
/**
* The interface implemented by a communication channel to the other side.
*/
interface WorkerCommunication {
addEventListener(type: "message", listener: (ev: MessageEvent) => any, useCapture?: boolean): void;
addEventListener(type: string, listener: EventListener, useCapture?: boolean): void;
postMessage(message: any): void;
}
declare const exports: any;
declare const global: (WorkerGlobalScope) & {
FontFace?: {
new (family: string, source: string): FontFace;
};
Map?: {
new <K, V>(iterable?: [K, V][]): Map<K, V>;
/* tslint:disable-next-line:member-ordering */
prototype: Map<any, any> | { forEach: undefined };
};
MutationObserver?: typeof MutationObserver;
Promise?: {
new <T>(init: (resolve: (value: T | Thenable<T>) => void, reject: (reason: any) => void) => void): Promise<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Promise<any>;
resolve<T>(value: T | Thenable<T>): Promise<T>;
reject<T>(reason: any): Promise<T>;
all<T>(values: (T | Thenable<T>)[]): Promise<T[]>;
race<T>(values: (T | Thenable<T>)[]): Promise<T>;
};
ReadableStream?: {
prototype: ReadableStream | { getReader: undefined; };
};
Set?: {
new <T>(iterable?: T[]): Set<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Set<any> | { forEach: undefined };
};
TextDecoder?: { new (encoding: string, options: { ignoreBOM: boolean }): TextDecoder };
WebkitMutationObserver?: typeof MutationObserver;
Worker?: typeof Worker,
WorkerGlobalScope?: {
prototype: WorkerGlobalScope;
new (): WorkerGlobalScope;
};
document?: {
currentScript?: HTMLScriptElement;
fonts?: FontFaceSet;
};
fetch?(url: string): Promise<{ body: ReadableStream; ok?: boolean; status?: number; }>;
process?: {
nextTick?(callback: () => void): void;
}
};

View File

@ -0,0 +1,137 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as settings from "./settings";
export { debugMode, verboseMode } from "./settings";
import * as set from "./utility/set";
export { Set } from "./utility/set";
import * as map from "./utility/map";
export { Map } from "./utility/map";
import * as promise from "./utility/promise";
export { Promise, DeferredPromise } from "./utility/promise";
import * as webworker from "./webworker";
export { webworker };
import * as parts from "./parts";
export { parts };
import * as parser from "./parser";
export { parser };
import * as renderers from "./renderers";
export { renderers };
export { serialize, deserialize } from "./serialization";
export { ASS } from "./types/ass";
export { Attachment, AttachmentType } from "./types/attachment";
export { Dialogue } from "./types/dialogue";
export { ScriptProperties } from "./types/script-properties";
export { Style } from "./types/style";
export { BorderStyle, Format, WrappingStyle } from "./types/misc";
export { version } from "./version";
/**
* Configures libjass with the given properties.
*
* @param {!*} newConfig
* @param {?boolean} newConfig["debugMode"] When true, libjass logs some debug messages.
* @param {?boolean} newConfig["verboseMode"] When true, libjass logs some more debug messages. This setting is independent of {@link libjass.debugMode}
* @param {?function(new:Set, !Array.<T>=)} newConfig["Set"] Sets the Set implementation used by libjass to the provided one. If null, {@link ./utility/set.SimpleSet} is used.
* @param {?function(new:Map, !Array.<!Array.<*>>=)} newConfig["Map"] Sets the Map implementation used by libjass to the provided one. If null, {@link ./utility/map.SimpleMap} is used.
* @param {?function(new:Promise)} newConfig["Promise"] Sets the Promise implementation used by libjass to the provided one. If null, {@link ./utility/promise.SimplePromise} is used.
*/
export function configure(newConfig: {
debugMode?: boolean,
verboseMode?: boolean,
Set?: typeof set.Set | null,
Map?: typeof map.Map | null,
Promise?: typeof promise.Promise | null,
}): void {
if (typeof newConfig.debugMode === "boolean") {
settings.setDebugMode(newConfig.debugMode);
}
if (typeof newConfig.verboseMode === "boolean") {
settings.setVerboseMode(newConfig.verboseMode);
}
if (typeof newConfig.Set === "function" || newConfig.Set === null) {
set.setImplementation(newConfig.Set);
}
if (typeof newConfig.Map === "function" || newConfig.Map === null) {
map.setImplementation(newConfig.Map);
}
if (typeof newConfig.Promise === "function" || newConfig.Promise === null) {
promise.setImplementation(newConfig.Promise);
}
}
// Getters below are to work around https://github.com/Microsoft/TypeScript/issues/6366
Object.defineProperties(exports, {
debugMode: {
get: () => settings.debugMode,
set: value => {
console.warn("Setter `libjass.debugMode = value` has been deprecated. Use `libjass.configure({ debugMode: value })` instead.");
settings.setDebugMode(value);
},
},
verboseMode: {
get: () => settings.verboseMode,
set: value => {
console.warn("Setter `libjass.verboseMode = value` has been deprecated. Use `libjass.configure({ verboseMode: value })` instead.");
settings.setVerboseMode(value);
},
},
Set: {
get: () => set.Set,
set: value => {
console.warn("Setter `libjass.Set = value` has been deprecated. Use `libjass.configure({ Set: value })` instead.");
set.setImplementation(value);
},
},
Map: {
get: () => map.Map,
set: value => {
console.warn("Setter `libjass.Map = value` has been deprecated. Use `libjass.configure({ Map: value })` instead.");
map.setImplementation(value);
},
},
Promise: {
get: () => promise.Promise,
set: value => {
console.warn("Setter `libjass.Promise = value` has been deprecated. Use `libjass.configure({ Promise: value })` instead.");
promise.setImplementation(value);
},
},
});

View File

@ -0,0 +1,23 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export { parse } from "./parse";
export { BrowserReadableStream, Stream, StringStream, XhrStream } from "./streams";
export { StreamParser, SrtStreamParser } from "./stream-parsers";

View File

@ -0,0 +1,68 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Property, TypedTemplate } from "../types/misc";
import { Map } from "../utility/map";
/**
* Parses a line into a {@link ./types/misc.Property}.
*
* @param {string} line
* @return {Property}
*/
export function parseLineIntoProperty(line: string): Property | null {
const colonPos = line.indexOf(":");
if (colonPos === -1) {
return null;
}
const name = line.substr(0, colonPos);
const value = line.substr(colonPos + 1).replace(/^\s+/, "");
return { name, value };
}
/**
* Parses a line into a {@link ./types/misc.TypedTemplate} according to the given format specifier.
*
* @param {string} line
* @param {!Array.<string>} formatSpecifier
* @return {TypedTemplate}
*/
export function parseLineIntoTypedTemplate(line: string, formatSpecifier: string[]): TypedTemplate | null {
const property = parseLineIntoProperty(line);
if (property === null) {
return null;
}
const value = property.value.split(",");
if (value.length > formatSpecifier.length) {
value[formatSpecifier.length - 1] = value.slice(formatSpecifier.length - 1).join(",");
}
const template = new Map<string, string>();
formatSpecifier.forEach((formatKey, index) => {
template.set(formatKey, value[index]);
});
return { type: property.name, template };
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,438 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { debugMode } from "../settings";
import { ASS } from "../types/ass";
import { Attachment, AttachmentType } from "../types/attachment";
import { Dialogue } from "../types/dialogue";
import { Style } from "../types/style";
import { Map } from "../utility/map";
import { DeferredPromise } from "../utility/promise";
import { parseLineIntoProperty } from "./misc";
import { Stream } from "./streams";
enum Section {
ScriptInfo,
Styles,
Events,
Fonts,
Graphics,
Other,
EOF,
}
/**
* A parser that parses an {@link libjass.ASS} object from a {@link libjass.parser.Stream}.
*
* @param {!libjass.parser.Stream} stream The {@link libjass.parser.Stream} to parse
*/
export class StreamParser {
private _ass: ASS = new ASS();
private _minimalDeferred: DeferredPromise<ASS> = new DeferredPromise<ASS>();
private _deferred: DeferredPromise<ASS> = new DeferredPromise<ASS>();
private _shouldSwallowBom: boolean = true;
private _currentSection: Section = Section.ScriptInfo;
private _currentAttachment: Attachment | null = null;
constructor(private _stream: Stream) {
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._minimalDeferred.reject(reason);
this._deferred.reject(reason);
});
}
/**
* @type {!Promise.<!libjass.ASS>} A promise that will be resolved when the script properties of the ASS script have been parsed from the stream. Styles and events have not necessarily been
* parsed at the point this promise becomes resolved.
*/
get minimalASS(): Promise<ASS> {
return this._minimalDeferred.promise;
}
/**
* @type {!Promise.<!libjass.ASS>} A promise that will be resolved when the entire stream has been parsed.
*/
get ass(): Promise<ASS> {
return this._deferred.promise;
}
/**
* @type {number}
*/
private get currentSection(): Section {
return this._currentSection;
}
/**
* @type {number}
*/
private set currentSection(value: Section) {
if (this._currentAttachment !== null) {
this._ass.addAttachment(this._currentAttachment);
this._currentAttachment = null;
}
if (this._currentSection === Section.ScriptInfo && value !== Section.ScriptInfo) {
// Exiting script info section
this._minimalDeferred.resolve(this._ass);
}
if (value === Section.EOF) {
const scriptProperties = this._ass.properties;
/* tslint:disable-next-line:strict-type-predicates */
if (scriptProperties.resolutionX === undefined || scriptProperties.resolutionY === undefined) {
// Malformed script.
this._minimalDeferred.reject("Malformed ASS script.");
this._deferred.reject("Malformed ASS script.");
}
else {
this._minimalDeferred.resolve(this._ass);
this._deferred.resolve(this._ass);
}
}
this._currentSection = value;
}
/**
* @param {string} line
*/
private _onNextLine(line: string | null): void {
if (line === null) {
this.currentSection = Section.EOF;
return;
}
if (line[line.length - 1] === "\r") {
line = line.substr(0, line.length - 1);
}
if (line.charCodeAt(0) === 0xfeff && this._shouldSwallowBom) {
line = line.substr(1);
}
this._shouldSwallowBom = false;
if (line === "") {
// Ignore empty lines.
}
else if (line[0] === ";" && this._currentAttachment === null) {
// Lines starting with ; are comments, unless reading an attachment.
}
else if (line === "[Script Info]") {
this.currentSection = Section.ScriptInfo;
}
else if (line === "[V4+ Styles]" || line === "[V4 Styles]") {
this.currentSection = Section.Styles;
}
else if (line === "[Events]") {
this.currentSection = Section.Events;
}
else if (line === "[Fonts]") {
this.currentSection = Section.Fonts;
}
else if (line === "[Graphics]") {
this.currentSection = Section.Graphics;
}
else {
if (this._currentAttachment === null && line[0] === "[" && line[line.length - 1] === "]") {
/* This looks like the start of a new section. The section name is unrecognized if it is.
* Since there's no current attachment being parsed it's definitely the start of a new section.
* If an attachment is being parsed, this might be part of the attachment.
*/
this.currentSection = Section.Other;
}
switch (this.currentSection) {
case Section.ScriptInfo:
const property = parseLineIntoProperty(line);
if (property !== null) {
switch (property.name) {
case "PlayResX":
this._ass.properties.resolutionX = parseInt(property.value);
break;
case "PlayResY":
this._ass.properties.resolutionY = parseInt(property.value);
break;
case "WrapStyle":
this._ass.properties.wrappingStyle = parseInt(property.value);
break;
case "ScaledBorderAndShadow":
this._ass.properties.scaleBorderAndShadow = (property.value === "yes");
break;
}
}
break;
case Section.Styles:
if (this._ass.stylesFormatSpecifier === null) {
const property = parseLineIntoProperty(line);
if (property !== null && property.name === "Format") {
this._ass.stylesFormatSpecifier = property.value.split(",").map(str => str.trim());
}
else {
// Ignore any non-format lines
}
}
else {
try {
this._ass.addStyle(line);
}
catch (ex) {
if (debugMode) {
console.error(`Could not parse style from line ${ line } - ${ ex.stack || ex }`);
}
}
}
break;
case Section.Events:
if (this._ass.dialoguesFormatSpecifier === null) {
const property = parseLineIntoProperty(line);
if (property !== null && property.name === "Format") {
this._ass.dialoguesFormatSpecifier = property.value.split(",").map(str => str.trim());
}
else {
// Ignore any non-format lines
}
}
else {
try {
this._ass.addEvent(line);
}
catch (ex) {
if (debugMode) {
console.error(`Could not parse event from line ${ line } - ${ ex.stack || ex }`);
}
}
}
break;
case Section.Fonts:
case Section.Graphics:
const startOfNewAttachmentRegex = (this.currentSection === Section.Fonts) ? /^fontname:(.+)/ : /^filename:(.+)/;
const startOfNewAttachment = startOfNewAttachmentRegex.exec(line);
if (startOfNewAttachment !== null) {
// Start of new attachment
if (this._currentAttachment !== null) {
this._ass.addAttachment(this._currentAttachment);
this._currentAttachment = null;
}
this._currentAttachment = new Attachment(startOfNewAttachment[1].trim(), (this.currentSection === Section.Fonts) ? AttachmentType.Font : AttachmentType.Graphic);
}
else if (this._currentAttachment !== null) {
try {
this._currentAttachment.contents += uuencodedToBase64(line);
}
catch (ex) {
if (debugMode) {
console.error(`Encountered error while reading font ${ this._currentAttachment.filename }: %o`, ex);
}
this._currentAttachment = null;
}
}
else {
// Ignore.
}
break;
case Section.Other:
// Ignore other sections.
break;
default:
throw new Error(`Unhandled state ${ this.currentSection }`);
}
}
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._minimalDeferred.reject(reason);
this._deferred.reject(reason);
});
}
}
/**
* A parser that parses an {@link libjass.ASS} object from a {@link libjass.parser.Stream} of an SRT script.
*
* @param {!libjass.parser.Stream} stream The {@link libjass.parser.Stream} to parse
*/
export class SrtStreamParser {
private _ass: ASS = new ASS();
private _deferred: DeferredPromise<ASS> = new DeferredPromise<ASS>();
private _shouldSwallowBom: boolean = true;
private _currentDialogueNumber: string | null = null;
private _currentDialogueStart: string | null = null;
private _currentDialogueEnd: string | null = null;
private _currentDialogueText: string | null = null;
constructor(private _stream: Stream) {
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._deferred.reject(reason);
});
this._ass.properties.resolutionX = 1280;
this._ass.properties.resolutionY = 720;
this._ass.properties.wrappingStyle = 1;
this._ass.properties.scaleBorderAndShadow = true;
const newStyle = new Style(new Map([["Name", "Default"], ["FontSize", "36"]]));
this._ass.styles.set(newStyle.name, newStyle);
}
/**
* @type {!Promise.<!libjass.ASS>} A promise that will be resolved when the entire stream has been parsed.
*/
get ass(): Promise<ASS> {
return this._deferred.promise;
}
/**
* @param {string} line
*/
private _onNextLine(line: string | null): void {
if (line === null) {
if (this._currentDialogueNumber !== null && this._currentDialogueStart !== null && this._currentDialogueEnd !== null && this._currentDialogueText !== null) {
this._ass.dialogues.push(new Dialogue(new Map([
["Style", "Default"],
["Start", this._currentDialogueStart],
["End", this._currentDialogueEnd],
["Text", this._currentDialogueText],
]), this._ass));
}
this._deferred.resolve(this._ass);
return;
}
if (line[line.length - 1] === "\r") {
line = line.substr(0, line.length - 1);
}
if (line.charCodeAt(0) === 0xfeff && this._shouldSwallowBom) {
line = line.substr(1);
}
this._shouldSwallowBom = false;
if (line === "") {
if (this._currentDialogueNumber !== null && this._currentDialogueStart !== null && this._currentDialogueEnd !== null && this._currentDialogueText !== null) {
this._ass.dialogues.push(new Dialogue(new Map([
["Style", "Default"],
["Start", this._currentDialogueStart],
["End", this._currentDialogueEnd],
["Text", this._currentDialogueText],
]), this._ass));
}
this._currentDialogueNumber = this._currentDialogueStart = this._currentDialogueEnd = this._currentDialogueText = null;
}
else {
if (this._currentDialogueNumber === null) {
if (/^\d+$/.test(line)) {
this._currentDialogueNumber = line;
}
}
else if (this._currentDialogueStart === null && this._currentDialogueEnd === null) {
const match = /^(\d\d:\d\d:\d\d,\d\d\d) --> (\d\d:\d\d:\d\d,\d\d\d)/.exec(line);
if (match !== null) {
this._currentDialogueStart = match[1].replace(",", ".");
this._currentDialogueEnd = match[2].replace(",", ".");
}
}
else {
line = line
.replace(/<b>/g, "{\\b1}").replace(/\{b\}/g, "{\\b1}")
.replace(/<\/b>/g, "{\\b0}").replace(/\{\/b\}/g, "{\\b0}")
.replace(/<i>/g, "{\\i1}").replace(/\{i\}/g, "{\\i1}")
.replace(/<\/i>/g, "{\\i0}").replace(/\{\/i\}/g, "{\\i0}")
.replace(/<u>/g, "{\\u1}").replace(/\{u\}/g, "{\\u1}")
.replace(/<\/u>/g, "{\\u0}").replace(/\{\/u\}/g, "{\\u0}")
.replace(
/<font color="#([0-9a-fA-F]{2})([0-9a-fA-F]{2})([0-9a-fA-F]{2})">/g,
(/* ujs:unreferenced */ _substring: string, red: string, green: string, blue: string) => `{\c&H${ blue }${ green }${ red }&}`,
).replace(/<\/font>/g, "{\\c}");
if (this._currentDialogueText !== null) {
this._currentDialogueText += "\\N" + line;
}
else {
this._currentDialogueText = line;
}
}
}
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._deferred.reject(reason);
});
}
}
/**
* Converts a uuencoded string to a base64 string.
*
* @param {string} str
* @return {string}
*/
function uuencodedToBase64(str: string): string {
let result = "";
for (let i = 0; i < str.length; i++) {
const charCode = str.charCodeAt(i) - 33;
if (charCode < 0 || charCode > 63) {
throw new Error(`Out-of-range character code ${ charCode } at index ${ i } in string ${ str }`);
}
if (charCode < 26) {
result += String.fromCharCode("A".charCodeAt(0) + charCode);
}
else if (charCode < 52) {
result += String.fromCharCode("a".charCodeAt(0) + charCode - 26);
}
else if (charCode < 62) {
result += String.fromCharCode("0".charCodeAt(0) + charCode - 52);
}
else if (charCode === 62) {
result += "+";
}
else {
result += "/";
}
}
return result;
}

View File

@ -0,0 +1,251 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DeferredPromise, Promise } from "../utility/promise";
/**
* An interface for a stream.
*/
export interface Stream {
/**
* @return {!Promise.<?string>} A promise that will be resolved with the next line, or null if the stream is exhausted.
*/
nextLine(): Promise<string | null>;
}
/**
* A {@link libjass.parser.Stream} that reads from a string in memory.
*
* @param {string} str The string
*/
export class StringStream implements Stream {
private _readTill: number = 0;
constructor(private _str: string) { }
/**
* @return {!Promise.<?string>} A promise that will be resolved with the next line, or null if the string has been completely read.
*/
nextLine(): Promise<string | null> {
let result: Promise<string | null>;
if (this._readTill < this._str.length) {
const nextNewLinePos = this._str.indexOf("\n", this._readTill);
if (nextNewLinePos !== -1) {
result = Promise.resolve(this._str.substring(this._readTill, nextNewLinePos));
this._readTill = nextNewLinePos + 1;
}
else {
result = Promise.resolve(this._str.substr(this._readTill));
this._readTill = this._str.length;
}
}
else {
result = Promise.resolve<string | null>(null);
}
return result;
}
}
/**
* A {@link libjass.parser.Stream} that reads from an XMLHttpRequest object.
*
* @param {!XMLHttpRequest} xhr The XMLHttpRequest object. Make sure to not call .open() on this object before passing it in here,
* since event handlers cannot be registered after open() has been called.
*/
export class XhrStream implements Stream {
private _readTill: number = 0;
private _pendingDeferred: DeferredPromise<string | null> | null = null;
private _failedError: ErrorEvent | null = null;
constructor(private _xhr: XMLHttpRequest) {
_xhr.addEventListener("progress", () => this._onXhrProgress(), false);
_xhr.addEventListener("load", () => this._onXhrLoad(), false);
_xhr.addEventListener("error", event => this._onXhrError(event), false);
}
/**
* @return {!Promise.<?string>} A promise that will be resolved with the next line, or null if the stream is exhausted.
*/
nextLine(): Promise<string> {
if (this._pendingDeferred !== null) {
throw new Error("XhrStream only supports one pending unfulfilled read at a time.");
}
const deferred = this._pendingDeferred = new DeferredPromise<string>();
this._tryResolveNextLine();
return deferred.promise;
}
/**
*/
private _onXhrProgress(): void {
if (this._pendingDeferred === null) {
return;
}
if (this._xhr.readyState === XMLHttpRequest.DONE) {
/* Suppress resolving next line here. Let the "load" or "error" event handlers do it.
*
* This is required because a failed XHR fires the progress event with readyState === DONE before it fires the error event.
* This would confuse _tryResolveNextLine() into thinking the request succeeded with no data if it was called here.
*/
return;
}
this._tryResolveNextLine();
}
/**
*/
private _onXhrLoad(): void {
if (this._pendingDeferred === null) {
return;
}
this._tryResolveNextLine();
}
/**
* @param {!ErrorEvent} event
*/
private _onXhrError(event: ErrorEvent): void {
this._failedError = event;
if (this._pendingDeferred === null) {
return;
}
this._tryResolveNextLine();
}
/**
*/
private _tryResolveNextLine(): void {
if (this._failedError !== null) {
this._pendingDeferred!.reject(this._failedError);
return;
}
const response = this._xhr.responseText;
const nextNewLinePos = response.indexOf("\n", this._readTill);
if (nextNewLinePos !== -1) {
this._pendingDeferred!.resolve(response.substring(this._readTill, nextNewLinePos));
this._readTill = nextNewLinePos + 1;
this._pendingDeferred = null;
}
else if (this._xhr.readyState === XMLHttpRequest.DONE) {
// No more data. This is the last line.
if (this._readTill < response.length) {
this._pendingDeferred!.resolve(response.substr(this._readTill));
this._readTill = response.length;
}
else {
this._pendingDeferred!.resolve(null);
}
this._pendingDeferred = null;
}
}
}
/**
* A {@link libjass.parser.Stream} that reads from a ReadableStream object.
*
* @param {!ReadableStream} stream
* @param {string} encoding
*/
export class BrowserReadableStream implements Stream {
/**
* @return {boolean} Whether BrowserReadableStream is supported in this environment.
*/
static isSupported(): boolean {
return (
global.ReadableStream !== undefined &&
typeof global.ReadableStream.prototype.getReader === "function" &&
typeof global.TextDecoder === "function"
);
}
private _reader: ReadableStreamReader;
private _decoder: TextDecoder;
private _buffer: string = "";
private _pendingDeferred: DeferredPromise<string | null> | null = null;
constructor(stream: ReadableStream, encoding: string) {
this._reader = stream.getReader();
this._decoder = new global.TextDecoder!(encoding, { ignoreBOM: true });
}
/**
* @return {!Promise.<?string>} A promise that will be resolved with the next line, or null if the stream is exhausted.
*/
nextLine(): Promise<string> {
if (this._pendingDeferred !== null) {
throw new Error("BrowserReadableStream only supports one pending unfulfilled read at a time.");
}
const deferred = this._pendingDeferred = new DeferredPromise<string>();
this._tryResolveNextLine();
return deferred.promise;
}
/**
*/
private _tryResolveNextLine(): void {
const nextNewLinePos = this._buffer.indexOf("\n");
if (nextNewLinePos !== -1) {
this._pendingDeferred!.resolve(this._buffer.substr(0, nextNewLinePos));
this._buffer = this._buffer.substr(nextNewLinePos + 1);
this._pendingDeferred = null;
}
else {
/* tslint:disable-next-line:no-floating-promises */
this._reader.read().then(next => {
const { value, done } = next;
if (!done) {
this._buffer += this._decoder.decode(value, { stream: true });
this._tryResolveNextLine();
}
else {
// No more data.
if (this._buffer.length === 0) {
this._pendingDeferred!.resolve(null);
}
else {
this._pendingDeferred!.resolve(this._buffer);
this._buffer = "";
}
this._pendingDeferred = null;
}
});
}
}
}

View File

@ -0,0 +1,228 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Attachment } from "../types/attachment";
import { Map } from "../utility/map";
import { Set } from "../utility/set";
type DataReader = { dataView: DataView; position: number; };
enum DataType {
Char,
Uint16,
Uint32,
}
type StructMemberDefinition = { type: DataType; field: string; };
const fieldDecorators = new Map<DataType, (proto: any, field: string) => void>();
@struct
class OffsetTable {
/** @type {function(!{ dataView: DataView, position: number }): OffsetTable} */
static read: (reader: DataReader) => OffsetTable;
/** @type {number} */ @field(DataType.Uint16) majorVersion: number;
/** @type {number} */ @field(DataType.Uint16) minorVersion: number;
/** @type {number} */ @field(DataType.Uint16) numTables: number;
/** @type {number} */ @field(DataType.Uint16) searchRange: number;
/** @type {number} */ @field(DataType.Uint16) entrySelector: number;
/** @type {number} */ @field(DataType.Uint16) rangeShift: number;
}
@struct
class TableRecord {
/** @type {function(!{ dataView: DataView, position: number }): TableRecord} */
static read: (reader: DataReader) => TableRecord;
/** @type {string} */ @field(DataType.Char) c1: string;
/** @type {string} */ @field(DataType.Char) c2: string;
/** @type {string} */ @field(DataType.Char) c3: string;
/** @type {string} */ @field(DataType.Char) c4: string;
/** @type {number} */ @field(DataType.Uint32) checksum: number;
/** @type {number} */ @field(DataType.Uint32) offset: number;
/** @type {number} */ @field(DataType.Uint32) length: number;
}
@struct
class NameTableHeader {
/** @type {function(!{ dataView: DataView, position: number }): NameTableHeader} */
static read: (reader: DataReader) => NameTableHeader;
/** @type {number} */ @field(DataType.Uint16) formatSelector: number;
/** @type {number} */ @field(DataType.Uint16) count: number;
/** @type {number} */ @field(DataType.Uint16) stringOffset: number;
}
@struct
class NameRecord {
/** @type {function(!{ dataView: DataView, position: number }): NameRecord} */
static read: (reader: DataReader) => NameRecord;
/** @type {number} */ @field(DataType.Uint16) platformId: number;
/** @type {number} */ @field(DataType.Uint16) encodingId: number;
/** @type {number} */ @field(DataType.Uint16) languageId: number;
/** @type {number} */ @field(DataType.Uint16) nameId: number;
/** @type {number} */ @field(DataType.Uint16) length: number;
/** @type {number} */ @field(DataType.Uint16) offset: number;
}
/**
* Gets all the font names from the given font attachment.
*
* @param {!libjass.Attachment} attachment
* @return {!libjass.Set.<string>}
*/
export function getTtfNames(attachment: Attachment): Set<string> {
const decoded = atob(attachment.contents);
const bytes = new Uint8Array(new ArrayBuffer(decoded.length));
for (let i = 0; i < decoded.length; i++) {
bytes[i] = decoded.charCodeAt(i);
}
const reader = { dataView: new DataView(bytes.buffer), position: 0 };
const offsetTable = OffsetTable.read(reader);
let nameTableRecord: TableRecord | null = null;
for (let i = 0; i < offsetTable.numTables; i++) {
const tableRecord = TableRecord.read(reader);
if (tableRecord.c1 + tableRecord.c2 + tableRecord.c3 + tableRecord.c4 === "name") {
nameTableRecord = tableRecord;
break;
}
}
if (nameTableRecord === null) {
throw new Error('Could not find "name" table record.');
}
reader.position = nameTableRecord.offset;
const nameTableHeader = NameTableHeader.read(reader);
const result = new Set<string>();
for (let i = 0; i < nameTableHeader.count; i++) {
const nameRecord = NameRecord.read(reader);
switch (nameRecord.nameId) {
case 1:
case 4:
case 6:
const recordOffset = nameTableRecord.offset + nameTableHeader.stringOffset + nameRecord.offset;
const nameBytes = bytes.subarray(recordOffset, recordOffset + nameRecord.length);
switch (nameRecord.platformId) {
case 1: {
let name = "";
/* tslint:disable-next-line:prefer-for-of */
for (let j = 0; j < nameBytes.length; j++) {
name += String.fromCharCode(nameBytes[j]);
}
result.add(name);
break;
}
case 3: {
let name = "";
for (let j = 0; j < nameBytes.length; j += 2) {
/* tslint:disable-next-line:no-bitwise */
name += String.fromCharCode((nameBytes[j] << 8) + nameBytes[j + 1]);
}
result.add(name);
break;
}
}
break;
default:
break;
}
}
return result;
}
/**
* @param {!function(new(): T)} clazz
* @return {!function(new(): T)}
*/
function struct<T>(clazz: { new (): T; read(reader: DataReader): T; }): { new (): T; read(reader: DataReader): T; } {
const fields: StructMemberDefinition[] = (clazz as any).__fields;
clazz.read = (reader: DataReader) => {
const result: any = new clazz();
for (const field of fields) {
let value: any;
switch (field.type) {
case DataType.Char:
value = String.fromCharCode(reader.dataView.getInt8(reader.position));
reader.position += 1;
break;
case DataType.Uint16:
value = reader.dataView.getUint16(reader.position);
reader.position += 2;
break;
case DataType.Uint32:
value = reader.dataView.getUint32(reader.position);
reader.position += 4;
break;
}
result[field.field] = value;
}
return result;
};
return clazz;
}
/**
* @param {number} type
* @return {function(T, string)}
*/
function field<T>(type: DataType): (proto: T, field: string) => void {
let existingDecorator = fieldDecorators.get(type);
if (existingDecorator === undefined) {
existingDecorator = (proto: T, field: string) => {
const ctor: { __fields?: StructMemberDefinition[] } = proto.constructor;
if (ctor.__fields === undefined) {
ctor.__fields = [];
}
ctor.__fields.push({ type, field });
};
fieldDecorators.set(type, existingDecorator);
}
return existingDecorator;
}

View File

@ -0,0 +1,148 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The base interface of the drawing instructions.
*/
export interface Instruction { }
/**
* An instruction to move to a particular position.
*
* @param {number} x
* @param {number} y
*/
export class MoveInstruction implements Instruction {
constructor(private _x: number, private _y: number) { }
/**
* The X position of this move instruction.
*
* @type {number}
*/
get x(): number {
return this._x;
}
/**
* The Y position of this move instruction.
*
* @type {number}
*/
get y(): number {
return this._y;
}
}
/**
* An instruction to draw a line to a particular position.
*
* @param {number} x
* @param {number} y
*/
export class LineInstruction implements Instruction {
constructor(private _x: number, private _y: number) { }
/**
* The X position of this line instruction.
*
* @type {number}
*/
get x(): number {
return this._x;
}
/**
* The Y position of this line instruction.
*
* @type {number}
*/
get y(): number {
return this._y;
}
}
/**
* An instruction to draw a cubic bezier curve to a particular position, with two given control points.
*
* @param {number} x1
* @param {number} y1
* @param {number} x2
* @param {number} y2
* @param {number} x3
* @param {number} y3
*/
export class CubicBezierCurveInstruction implements Instruction {
constructor(private _x1: number, private _y1: number, private _x2: number, private _y2: number, private _x3: number, private _y3: number) { }
/**
* The X position of the first control point of this cubic bezier curve instruction.
*
* @type {number}
*/
get x1(): number {
return this._x1;
}
/**
* The Y position of the first control point of this cubic bezier curve instruction.
*
* @type {number}
*/
get y1(): number {
return this._y1;
}
/**
* The X position of the second control point of this cubic bezier curve instruction.
*
* @type {number}
*/
get x2(): number {
return this._x2;
}
/**
* The Y position of the second control point of this cubic bezier curve instruction.
*
* @type {number}
*/
get y2(): number {
return this._y2;
}
/**
* The ending X position of this cubic bezier curve instruction.
*
* @type {number}
*/
get x3(): number {
return this._x3;
}
/**
* The ending Y position of this cubic bezier curve instruction.
*
* @type {number}
*/
get y3(): number {
return this._y3;
}
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,252 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { debugMode } from "../../settings";
import { Clock, ClockEvent } from "./base";
import { ManualClock } from "./manual";
/**
* An implementation of {@link libjass.renderers.Clock} that automatically ticks and generates {@link libjass.renderers.ClockEvent}s according to the state of an external driver.
*
* For example, if you're using libjass to render subtitles on a canvas with your own video controls, these video controls will function as the driver to this AutoClock.
* It would call {@link libjass.renderers.AutoClock.play}, {@link libjass.renderers.AutoClock.pause}, etc. when the user pressed the corresponding video controls.
*
* The difference from ManualClock is that AutoClock does not require the driver to call something like {@link libjass.renderers.ManualClock.tick}. Instead it keeps its
* own time with a high-resolution requestAnimationFrame-based timer.
*
* If using libjass with a <video> element, consider using {@link libjass.renderers.VideoClock} that uses the video element as a driver.
*
* @param {function():number} getCurrentTime A callback that will be invoked to get the current time of the external driver.
* @param {number} autoPauseAfter If two calls to getCurrentTime are more than autoPauseAfter milliseconds apart but return the same time, then the external driver will be
* considered to have paused.
*/
export class AutoClock implements Clock {
private _manualClock: ManualClock = new ManualClock();
private _nextAnimationFrameRequestId: number | null = null;
private _lastKnownExternalTime: number | null = null;
private _lastKnownExternalTimeObtainedAt: number = 0;
constructor(private _getCurrentTime: () => number, private _autoPauseAfter: number) { }
/**
* Tells the clock to start generating ticks.
*/
play(): void {
if (!this._manualClock.enabled) {
return;
}
this._startTicking();
this._manualClock.play();
}
/**
* Tells the clock to pause.
*/
pause(): void {
if (!this._manualClock.enabled) {
return;
}
if (this._nextAnimationFrameRequestId === null) {
if (debugMode) {
console.warn("AutoClock.pause: Abnormal state detected. AutoClock._nextAnimationFrameRequestId should not have been null.");
}
return;
}
this._stopTicking();
this._manualClock.pause();
}
/**
* Tells the clock that the external driver is seeking.
*/
seeking(): void {
this._manualClock.seek(this._getCurrentTime());
}
// Clock members
/**
* @type {number}
*/
get currentTime(): number {
return this._manualClock.currentTime;
}
/**
* @type {boolean}
*/
get enabled(): boolean {
return this._manualClock.enabled;
}
/**
* @type {boolean}
*/
get paused(): boolean {
return this._manualClock.paused;
}
/**
* Gets the rate of the clock - how fast the clock ticks compared to real time.
*
* @type {number}
*/
get rate(): number {
return this._manualClock.rate;
}
/**
* Sets the rate of the clock - how fast the clock ticks compared to real time.
*
* @param {number} rate The new rate of the clock.
*/
setRate(rate: number): void {
this._manualClock.setRate(rate);
}
/**
* Enable the clock.
*
* @return {boolean} True if the clock is now enabled, false if it was already enabled.
*/
enable(): boolean {
if (!this._manualClock.enable()) {
return false;
}
this._startTicking();
return true;
}
/**
* Disable the clock.
*
* @return {boolean} True if the clock is now disabled, false if it was already disabled.
*/
disable(): boolean {
if (!this._manualClock.disable()) {
return false;
}
this._stopTicking();
return true;
}
/**
* Toggle the clock.
*/
toggle(): void {
if (this._manualClock.enabled) {
this.disable();
}
else {
this.enable();
}
}
/**
* Enable or disable the clock.
*
* @param {boolean} enabled If true, the clock is enabled, otherwise it's disabled.
* @return {boolean} True if the clock is now in the given state, false if it was already in that state.
*/
setEnabled(enabled: boolean): boolean {
if (enabled) {
return this.enable();
}
else {
return this.disable();
}
}
/**
* @param {number} type
* @param {!Function} listener
*/
addEventListener(type: ClockEvent, listener: Function): void {
this._manualClock.addEventListener(type, listener);
}
/**
* @param {number} timeStamp
*/
private _onTimerTick(timeStamp: number): void {
if (!this._manualClock.enabled) {
if (debugMode) {
console.warn("AutoClock._onTimerTick: Called when disabled.");
}
return;
}
const currentTime = this._manualClock.currentTime;
const currentExternalTime = this._getCurrentTime();
if (!this._manualClock.paused) {
if (this._lastKnownExternalTime !== null && currentExternalTime === this._lastKnownExternalTime) {
if (timeStamp - this._lastKnownExternalTimeObtainedAt > this._autoPauseAfter) {
this._lastKnownExternalTimeObtainedAt = 0;
this._manualClock.seek(currentExternalTime);
}
else {
this._manualClock.tick((timeStamp - this._lastKnownExternalTimeObtainedAt) / 1000 * this._manualClock.rate + this._lastKnownExternalTime);
}
}
else {
this._lastKnownExternalTime = currentExternalTime;
this._lastKnownExternalTimeObtainedAt = timeStamp;
this._manualClock.tick(currentExternalTime);
}
}
else {
if (currentTime !== currentExternalTime) {
this._lastKnownExternalTime = currentExternalTime;
this._lastKnownExternalTimeObtainedAt = timeStamp;
this._manualClock.tick(currentExternalTime);
}
}
this._nextAnimationFrameRequestId = requestAnimationFrame(timeStamp => this._onTimerTick(timeStamp));
}
private _startTicking(): void {
if (this._nextAnimationFrameRequestId === null) {
this._nextAnimationFrameRequestId = requestAnimationFrame(timeStamp => this._onTimerTick(timeStamp));
}
}
private _stopTicking(): void {
if (this._nextAnimationFrameRequestId !== null) {
cancelAnimationFrame(this._nextAnimationFrameRequestId);
this._nextAnimationFrameRequestId = null;
}
}
}

View File

@ -0,0 +1,135 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A mixin class that represents an event source.
*/
export class EventSource<T> {
/**
* A map from event type to an array of all the listeners registered for that event type.
*
* @type {!Map.<T, !Array.<Function>>}
*/
_eventListeners: Map<T, Function[]>;
/**
* Add a listener for the given event.
*
* @param {!T} type The type of event to attach the listener for
* @param {!Function} listener The listener
*/
addEventListener(type: T, listener: Function): void {
let listeners = this._eventListeners.get(type);
if (listeners === undefined) {
this._eventListeners.set(type, listeners = []);
}
listeners.push(listener);
}
/**
* Calls all listeners registered for the given event type.
*
* @param {!T} type The type of event to dispatch
* @param {!Array.<*>} args Arguments for the listeners of the event
*/
_dispatchEvent(type: T, args: Object[]): void {
const listeners = this._eventListeners.get(type);
if (listeners !== undefined) {
for (const listener of listeners) {
listener.apply(this, args);
}
}
}
}
/**
* The type of clock event.
*/
export enum ClockEvent {
Play,
Tick,
Pause,
Stop,
RateChange,
}
/**
* The clock interface. A clock is used by a renderer as a source of {@link libjass.renderers.ClockEvent}s.
*/
export interface Clock {
/**
* @type {number}
*/
currentTime: number;
/**
* @type {boolean}
*/
enabled: boolean;
/**
* @type {boolean}
*/
paused: boolean;
/**
* Gets the rate of the clock - how fast the clock ticks compared to real time.
*
* @type {number}
*/
rate: number;
/**
* Enable the clock.
*
* @return {boolean} True if the clock is now enabled, false if it was already enabled.
*/
enable(): boolean;
/**
* Disable the clock.
*
* @return {boolean} True if the clock is now disabled, false if it was already disabled.
*/
disable(): boolean;
/**
* Toggle the clock.
*/
toggle(): void;
/**
* Enable or disable the clock.
*
* @param {boolean} enabled If true, the clock is enabled, otherwise it's disabled.
* @return {boolean} True if the clock is now in the given state, false if it was already in that state.
*/
setEnabled(enabled: boolean): boolean;
// EventSource members
/**
* @param {number} type
* @param {!Function} listener
*/
addEventListener(type: ClockEvent, listener: Function): void;
}

View File

@ -0,0 +1,250 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Map } from "../../utility/map";
import { mixin } from "../../utility/mixin";
import { Clock, ClockEvent, EventSource } from "./base";
/**
* An implementation of {@link libjass.renderers.Clock} that allows user script to manually trigger {@link libjass.renderers.ClockEvent}s.
*/
export class ManualClock implements Clock, EventSource<ClockEvent> {
private _currentTime: number = -1;
private _rate: number = 1;
private _enabled: boolean = true;
private _paused: boolean = true;
/**
* Trigger a {@link libjass.renderers.ClockEvent.Play}
*/
play(): void {
if (!this._enabled) {
return;
}
if (!this._paused) {
return;
}
this._paused = false;
this._dispatchEvent(ClockEvent.Play, []);
}
/**
* Trigger a {@link libjass.renderers.ClockEvent.Tick} with the given time.
*
* @param {number} currentTime
*/
tick(currentTime: number): void {
if (!this._enabled) {
return;
}
if (this._currentTime === currentTime) {
return;
}
this.play();
this._currentTime = currentTime;
this._dispatchEvent(ClockEvent.Tick, []);
}
/**
* Seek to the given time. Unlike {@link libjass.renderers.ManualClock.tick} this is used to represent a discontinuous jump, such as the user seeking
* via the video element's position bar.
*
* @param {number} time
*/
seek(time: number): void {
if (!this._enabled) {
return;
}
this.pause();
if (this._currentTime === time) {
return;
}
this.stop();
this.tick(time);
this.pause();
}
/**
* Trigger a {@link libjass.renderers.ClockEvent.Pause}
*/
pause(): void {
if (!this._enabled) {
return;
}
if (this._paused) {
return;
}
this._paused = true;
this._dispatchEvent(ClockEvent.Pause, []);
}
/**
* Trigger a {@link libjass.renderers.ClockEvent.Stop}
*/
stop(): void {
this._dispatchEvent(ClockEvent.Stop, []);
}
// Clock members
/**
* @type {number}
*/
get currentTime(): number {
return this._currentTime;
}
/**
* @type {boolean}
*/
get enabled(): boolean {
return this._enabled;
}
/**
* @type {boolean}
*/
get paused(): boolean {
return this._paused;
}
/**
* Gets the rate of the clock - how fast the clock ticks compared to real time.
*
* @type {number}
*/
get rate(): number {
return this._rate;
}
/**
* Sets the rate of the clock - how fast the clock ticks compared to real time.
*
* @param {number} rate The new rate of the clock.
*/
setRate(rate: number): void {
if (this._rate === rate) {
return;
}
this._rate = rate;
this._dispatchEvent(ClockEvent.RateChange, []);
}
/**
* Enable the clock.
*
* @return {boolean} True if the clock is now enabled, false if it was already enabled.
*/
enable(): boolean {
if (this._enabled) {
return false;
}
this._enabled = true;
return true;
}
/**
* Disable the clock.
*
* @return {boolean} True if the clock is now disabled, false if it was already disabled.
*/
disable(): boolean {
if (!this._enabled) {
return false;
}
this.pause();
this.stop();
this._enabled = false;
return true;
}
/**
* Toggle the clock.
*/
toggle(): void {
if (this._enabled) {
this.disable();
}
else {
this.enable();
}
}
/**
* Enable or disable the clock.
*
* @param {boolean} enabled If true, the clock is enabled, otherwise it's disabled.
* @return {boolean} True if the clock is now in the given state, false if it was already in that state.
*/
setEnabled(enabled: boolean): boolean {
if (enabled) {
return this.enable();
}
else {
return this.disable();
}
}
/* tslint:disable:member-ordering */
// EventSource members
/**
* @type {!Map.<T, !Array.<Function>>}
*/
_eventListeners: Map<ClockEvent, Function[]> = new Map<ClockEvent, Function[]>();
/**
* @type {function(number, !Function)}
*/
addEventListener: (type: ClockEvent, listener: Function) => void;
/**
* @type {function(number, Array.<*>)}
*/
_dispatchEvent: (type: ClockEvent, args: Object[]) => void;
/* tslint:enable:member-ordering */
}
mixin(ManualClock, [EventSource]);

View File

@ -0,0 +1,122 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AutoClock } from "./auto";
import { Clock, ClockEvent } from "./base";
/**
* An implementation of libjass.renderers.Clock that generates {@link libjass.renderers.ClockEvent}s according to the state of a <video> element.
*
* @param {!HTMLVideoElement} video
*/
export class VideoClock implements Clock {
private _autoClock: AutoClock;
constructor(video: HTMLVideoElement) {
this._autoClock = new AutoClock(() => video.currentTime, 100);
video.addEventListener("playing", () => this._autoClock.play(), false);
video.addEventListener("pause", () => this._autoClock.pause(), false);
video.addEventListener("seeking", () => this._autoClock.seeking(), false);
video.addEventListener("ratechange", () => this._autoClock.setRate(video.playbackRate), false);
}
/**
* @type {number}
*/
get currentTime(): number {
return this._autoClock.currentTime;
}
/**
* @type {boolean}
*/
get enabled(): boolean {
return this._autoClock.enabled;
}
/**
* @type {boolean}
*/
get paused(): boolean {
return this._autoClock.paused;
}
/**
* Gets the rate of the clock - how fast the clock ticks compared to real time.
*
* @type {number}
*/
get rate(): number {
return this._autoClock.rate;
}
/**
* Enable the clock.
*
* @return {boolean} True if the clock is now enabled, false if it was already enabled.
*/
enable(): boolean {
return this._autoClock.enable();
}
/**
* Disable the clock.
*
* @return {boolean} True if the clock is now disabled, false if it was already disabled.
*/
disable(): boolean {
return this._autoClock.disable();
}
/**
* Toggle the clock.
*/
toggle(): void {
if (this._autoClock.enabled) {
this.disable();
}
else {
this.enable();
}
}
/**
* Enable or disable the clock.
*
* @param {boolean} enabled If true, the clock is enabled, otherwise it's disabled.
* @return {boolean} True if the clock is now in the given state, false if it was already in that state.
*/
setEnabled(enabled: boolean): boolean {
if (enabled) {
return this.enable();
}
else {
return this.disable();
}
}
/**
* @param {number} type
* @param {!Function} listener
*/
addEventListener(type: ClockEvent, listener: Function): void {
this._autoClock.addEventListener(type, listener);
}
}

View File

@ -0,0 +1,77 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { VideoClock } from "./clocks/video";
import { RendererSettings } from "./settings";
import { WebRenderer } from "./web/renderer";
import { ASS } from "../types/ass";
/**
* A default renderer implementation.
*
* @param {!HTMLVideoElement} video
* @param {!libjass.ASS} ass
* @param {libjass.renderers.RendererSettings} settings
*/
export class DefaultRenderer extends WebRenderer {
constructor(private _video: HTMLVideoElement, ass: ASS, settings?: RendererSettings) {
super(ass, new VideoClock(_video), document.createElement("div"), settings);
this._video.parentElement!.replaceChild(this.libjassSubsWrapper, this._video);
this.libjassSubsWrapper.insertBefore(this._video, this.libjassSubsWrapper.firstElementChild);
}
/**
* Resize the subtitles to the dimensions of the video element.
*
* This method accounts for letterboxing if the video element's size is not the same ratio as the video resolution.
*/
resize(): void {
// Handle letterboxing around the video. If the width or height are greater than the video can be, then consider that dead space.
const videoWidth = this._video.videoWidth;
const videoHeight = this._video.videoHeight;
const videoOffsetWidth = this._video.offsetWidth;
const videoOffsetHeight = this._video.offsetHeight;
const ratio = Math.min(videoOffsetWidth / videoWidth, videoOffsetHeight / videoHeight);
const subsWrapperWidth = videoWidth * ratio;
const subsWrapperHeight = videoHeight * ratio;
const subsWrapperLeft = (videoOffsetWidth - subsWrapperWidth) / 2;
const subsWrapperTop = (videoOffsetHeight - subsWrapperHeight) / 2;
super.resize(subsWrapperWidth, subsWrapperHeight, subsWrapperLeft, subsWrapperTop);
}
/**
* @deprecated
*/
resizeVideo(): void {
console.warn("`DefaultRenderer.resizeVideo(width, height)` has been deprecated. Use `DefaultRenderer.resize()` instead.");
this.resize();
}
protected _ready(): void {
this.resize();
super._ready();
}
}

View File

@ -0,0 +1,29 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export { Clock, ClockEvent, EventSource } from "./clocks/base";
export { AutoClock } from "./clocks/auto";
export { ManualClock } from "./clocks/manual";
export { VideoClock } from "./clocks/video";
export { DefaultRenderer } from "./default";
export { NullRenderer } from "./null";
export { WebRenderer } from "./web/renderer";
export { RendererSettings } from "./settings";

View File

@ -0,0 +1,208 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { debugMode, verboseMode } from "../settings";
import { ASS } from "../types/ass";
import { Dialogue } from "../types/dialogue";
import { Clock, ClockEvent } from "./clocks/base";
import { RendererSettings } from "./settings";
/**
* A renderer implementation that doesn't output anything.
*
* @param {!libjass.ASS} ass
* @param {!libjass.renderers.Clock} clock
* @param {libjass.renderers.RendererSettings} settings
*/
export class NullRenderer {
private static _lastRendererId: number = -1;
private _id: number;
private _settings: RendererSettings;
constructor(private _ass: ASS, private _clock: Clock, settings?: RendererSettings) {
this._id = ++NullRenderer._lastRendererId;
this._settings = RendererSettings.from(settings);
this._clock.addEventListener(ClockEvent.Play, () => this._onClockPlay());
this._clock.addEventListener(ClockEvent.Tick, () => this._onClockTick());
this._clock.addEventListener(ClockEvent.Pause, () => this._onClockPause());
this._clock.addEventListener(ClockEvent.Stop, () => this._onClockStop());
this._clock.addEventListener(ClockEvent.RateChange, () => this._onClockRateChange());
}
/**
* The unique ID of this renderer. Auto-generated.
*
* @type {number}
*/
get id(): number {
return this._id;
}
/**
* @type {!libjass.ASS}
*/
get ass(): ASS {
return this._ass;
}
/**
* @type {!libjass.renderers.Clock}
*/
get clock(): Clock {
return this._clock;
}
/**
* @type {!libjass.renderers.RendererSettings}
*/
get settings(): RendererSettings {
return this._settings;
}
/**
* Pre-render a dialogue. This is a no-op for this type.
*
* @param {!libjass.Dialogue} dialogue
*/
preRender(_dialogue: Dialogue): void { }
/**
* Draw a dialogue. This is a no-op for this type.
*
* @param {!libjass.Dialogue} dialogue
*/
draw(_dialogue: Dialogue): void { }
/**
* Enable the renderer.
*
* @return {boolean} True if the renderer is now enabled, false if it was already enabled.
*/
enable(): boolean {
return this._clock.enable();
}
/**
* Disable the renderer.
*
* @return {boolean} True if the renderer is now disabled, false if it was already disabled.
*/
disable(): boolean {
return this._clock.disable();
}
/**
* Toggle the renderer.
*/
toggle(): void {
this._clock.toggle();
}
/**
* Enable or disable the renderer.
*
* @param {boolean} enabled If true, the renderer is enabled, otherwise it's disabled.
* @return {boolean} True if the renderer is now in the given state, false if it was already in that state.
*/
setEnabled(enabled: boolean): boolean {
return this._clock.setEnabled(enabled);
}
/**
* @type {boolean}
*/
get enabled(): boolean {
return this._clock.enabled;
}
/**
* Runs when the clock is enabled, or starts playing, or is resumed from pause.
*/
protected _onClockPlay(): void {
if (verboseMode) {
console.log("NullRenderer._onClockPlay");
}
}
/**
* Runs when the clock's current time changed. This might be a result of either regular playback or seeking.
*/
protected _onClockTick(): void {
const currentTime = this._clock.currentTime;
if (verboseMode) {
console.log(`NullRenderer._onClockTick: currentTime = ${ currentTime }`);
}
for (const dialogue of this._ass.dialogues) {
try {
if (dialogue.end > currentTime) {
if (dialogue.start <= currentTime) {
// This dialogue is visible right now. Draw it.
this.draw(dialogue);
}
else if (dialogue.start <= (currentTime + this._settings.preRenderTime)) {
// This dialogue will be visible soon. Pre-render it.
this.preRender(dialogue);
}
}
}
catch (ex) {
if (debugMode) {
console.error(`Rendering dialogue ${ dialogue.id } failed.`, ex);
}
}
}
}
/**
* Runs when the clock is paused.
*/
protected _onClockPause(): void {
if (verboseMode) {
console.log("NullRenderer._onClockPause");
}
}
/**
* Runs when the clock is disabled.
*/
protected _onClockStop(): void {
if (verboseMode) {
console.log("NullRenderer._onClockStop");
}
}
/**
* Runs when the clock changes its rate.
*/
protected _onClockRateChange(): void {
if (verboseMode) {
console.log("NullRenderer._onClockRateChange");
}
}
}

View File

@ -0,0 +1,240 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { debugMode } from "../settings";
import { Map } from "../utility/map";
/**
* Settings for the renderer.
*/
export class RendererSettings {
/**
* A convenience method to create a font map from a <style> or <link> element that contains @font-face rules. There should be one @font-face rule for each font name, mapping to a font file URL.
*
* For example:
*
* @font-face {
* font-family: "Helvetica";
* src: url("/fonts/helvetica.ttf"), local("Arial");
* }
*
* More complicated @font-face syntax like format() or multi-line src are not supported.
*
* @param {!LinkStyle} linkStyle
* @return {!Map.<string, string>}
*/
static makeFontMapFromStyleElement(linkStyle: LinkStyle): Map<string, string> {
const fontMap = new Map<string, string>();
const styleSheet = linkStyle.sheet as CSSStyleSheet;
/* tslint:disable-next-line:prefer-for-of */
for (let i = 0; i < styleSheet.cssRules.length; i++) {
const rule = styleSheet.cssRules[i];
if (isFontFaceRule(rule)) {
const name = rule.style.getPropertyValue("font-family").match(/^["']?(.*?)["']?$/)![1];
let src = rule.style.getPropertyValue("src");
if (!src) {
src = rule.cssText.split("\n")
.map(line => line.match(/src:\s*([^;]+?)\s*;/))
.filter((matches): matches is RegExpMatchArray => matches !== null)
.map(matches => matches[1])[0];
}
fontMap.set(name, src);
}
}
return fontMap;
}
/**
* Converts an arbitrary object into a {@link libjass.renderers.RendererSettings} object.
*
* @param {*} object
* @return {!libjass.renderers.RendererSettings}
*/
static from(object?: any): RendererSettings {
if (object === undefined || object === null) {
object = {};
}
const {
fontMap = null,
preRenderTime = 5,
preciseOutlines = false,
enableSvg = testSupportsSvg(),
fallbackFonts = 'Arial, Helvetica, sans-serif, "Segoe UI Symbol"',
useAttachedFonts = false,
} = object as RendererSettings;
const result = new RendererSettings();
result.fontMap = fontMap;
result.preRenderTime = preRenderTime;
result.preciseOutlines = preciseOutlines;
result.enableSvg = enableSvg;
result.fallbackFonts = fallbackFonts;
result.useAttachedFonts = useAttachedFonts;
return result;
}
/**
* A map of font name to one or more URLs of that font. If provided, the fonts in this map are pre-loaded by the WebRenderer when it's created.
*
* The key of each entry of the map is the font name used in the ASS script. There are three choices for the value:
*
* - A single string that you would use for the src attribute of a @font-face rule. Eg: `'url("/fonts.foo.ttf"), url("/fonts/foo-fallback.ttf"), local("Arial.ttf")'`
*
* - An array of the individual sources that you would use for the src attribute of a @font-face rule. Eg: `['url("/fonts.foo.ttf")', 'url("/fonts/foo-fallback.ttf")', 'local("Arial")']`
*
* - An array of URLs. Eg: `["/fonts.foo.ttf", "/fonts/foo-fallback.ttf"]`
*
* Only the first and second forms allow you to use local fonts. The third form only allows you to use remote fonts.
*
* If you have a <style> or <link> element on the page containing @font-face rules, you can use the {@link libjass.renderers.RendererSettings.makeFontMapFromStyleElement}
* convenience method to create a font map.
*
* Defaults to null.
*
* @type {Map.<string, (string|!Array.<string>)>}
*/
fontMap: Map<string, string | string[]> | null;
/**
* Subtitles will be pre-rendered for this amount of time (seconds).
*
* Defaults to 5.
*
* @type {number}
*/
preRenderTime: number;
/**
* Subtitle outlines will be rendered in full detail. When false, the value of blur is used to draw less outlines for better performance and (hopefully) similar output.
*
* Defaults to false.
*
* @type {boolean}
*/
preciseOutlines: boolean;
/**
* Outlines and blur are implemented using SVG filters by default. When false, they will be rendered using alternative means.
*
* IE 11 and below do not support SVG filters on HTML elements so this should be set to false there. See http://caniuse.com/svg-html for details.
*
* Defaults to true.
*
* @type {boolean}
*/
enableSvg: boolean;
/**
* Comma-separated list of fonts to be used when font specified in ASS Styles not loaded.
*
* The value should be a valid CSS font-family property (i.e. comma-separated and individual names in quotes if necessary). Use empty string to disable fallback.
*
* Defaults to 'Arial, Helvetica, sans-serif, "Segoe UI Symbol"'.
*
* @type {string}
*/
fallbackFonts: string;
/**
* If true, attached TTF fonts in the ASS script will be used. The font is loaded as a data: URI. Requires ES6 typed arrays (ArrayBuffer, DataView, Uint8Array, etc).
*
* The font is naively parsed to extract the strings that will be used as the font family. Do not use this option with untrusted fonts or scripts.
*
* Defaults to false.
*
* @type {boolean}
*/
useAttachedFonts: boolean;
}
/**
* @param {!CSSRule} rule
* @return {boolean}
*/
function isFontFaceRule(rule: CSSRule): rule is CSSFontFaceRule {
return rule.type === CSSRule.FONT_FACE_RULE;
}
/**
* Returns true if this environment may support SVG filter effects. May return false positives.
*
* @return {boolean}
*/
function testSupportsSvg(): boolean {
if (debugMode) {
console.log("Testing whether SVG filter effects are supported.");
}
if (global.document === undefined) {
if (debugMode) {
console.log("This doesn't look like a browser. Assuming it doesn't support SVG filter effects.");
}
return false;
}
const morphologyFilter = document.createElementNS("http://www.w3.org/2000/svg", "feMorphology");
// https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/6618301/
try {
morphologyFilter.radiusX.baseVal = 1;
}
catch (ex) {
if (debugMode) {
if (ex instanceof DOMException) {
const domException = ex as DOMException;
if (domException.code === DOMException.NO_MODIFICATION_ALLOWED_ERR) {
console.log("Setting SVGFEMorphologyElement.radiusX.baseVal threw NoModificationAllowedError. This browser doesn't support SVG DOM correctly.");
}
else {
console.log(`Setting SVGFEMorphologyElement.radiusX.baseVal threw unexpected DOMException code ${ domException.code }. This browser doesn't support SVG DOM correctly.`);
}
}
else {
console.log(`Setting SVGFEMorphologyElement.radiusX.baseVal threw unexpected exception ${ ex }. This browser doesn't support SVG SVG DOM correctly.`);
}
}
return false;
}
// https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/6618454/
morphologyFilter.setAttribute("radius", "1");
if (morphologyFilter.cloneNode().getAttribute("radius") !== "1") {
if (debugMode) {
console.log("SVGFEMorphologyElement's radius attribute was corrupted when cloned. This browser doesn't support SVG DOM correctly.");
}
return false;
}
if (debugMode) {
console.log("This browser may support SVG filter effects.");
}
return true;
}

View File

@ -0,0 +1,126 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Keyframe } from "./keyframe";
import { NullRenderer } from "../null";
import { Map } from "../../utility/map";
/**
* This class represents a collection of animations. Each animation contains one or more keyframes.
* The collection can then be converted to a CSS3 representation.
*
* @param {!libjass.renderers.NullRenderer} renderer The renderer that this collection is associated with
* @param {!HTMLStyleElement} style A <style> element to insert the animation rules into
*/
export class AnimationCollection {
private static _nextId: number = 0;
private _id: string;
private _rate: number;
private _animationStyle: string = "";
private _animationDelays: Map<string, number> = new Map<string, number>();
private _numAnimations: number = 0;
constructor(renderer: NullRenderer, private _style: HTMLStyleElement) {
this._id = `${ renderer.id }-${ AnimationCollection._nextId++ }`;
this._rate = renderer.clock.rate;
}
/**
* This string should be set as the "animation" CSS property of the target element.
*
* @type {string}
*/
get animationStyle(): string {
return this._animationStyle;
}
/**
* This array should be used to set the "animation-delay" CSS property of the target element.
*
* @type {!Array.<number>}
*/
get animationDelays(): Map<string, number> {
return this._animationDelays;
}
/**
* Add an animation to this collection. The given keyframes together make one animation.
*
* @param {string} timingFunction One of the acceptable values for the "animation-timing-function" CSS property
* @param {!Array.<!libjass.renderers.Keyframe>} keyframes
*/
add(timingFunction: string, keyframes: Keyframe[]): void {
let start: number | null = null;
let end: number | null = null;
for (const keyframe of keyframes) {
if (start === null) {
start = keyframe.time;
}
end = keyframe.time;
}
if (start === null || end === null) {
throw new Error("Atleast one keyframe must be provided.");
}
let ruleCssText = "";
for (const keyframe of keyframes) {
ruleCssText +=
` ${ (100 * ((end - start === 0) ? 1 : ((keyframe.time - start) / (end - start)))).toFixed(3) }% {
`;
keyframe.properties.forEach((value, name) => {
ruleCssText +=
` ${ name }: ${ value };
`;
});
ruleCssText +=
` }
`;
}
const animationName = `animation-${ this._id }-${ this._numAnimations++ }`;
this._style.appendChild(document.createTextNode(
`@-webkit-keyframes ${ animationName } {
${ ruleCssText }
}`));
this._style.appendChild(document.createTextNode(
`@keyframes ${ animationName } {
${ ruleCssText }
}`));
if (this._animationStyle !== "") {
this._animationStyle += ",";
}
this._animationStyle += `${ animationName } ${ ((end - start) / this._rate).toFixed(3) }s ${ timingFunction }`;
this._animationDelays.set(animationName, start);
}
}

View File

@ -0,0 +1,131 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as parts from "../../parts";
/**
* This class represents an ASS drawing - a set of drawing instructions between {\p} tags.
*
* @param {number} outputScaleX
* @param {number} outputScaleY
*/
export class DrawingStyles {
private _scale: number = 1;
private _baselineOffset: number = 0;
constructor(private _outputScaleX: number, private _outputScaleY: number) { }
/**
* @type {number}
*/
set scale(value: number) {
this._scale = value;
}
/**
* @type {number}
*/
set baselineOffset(value: number) {
this._baselineOffset = value;
}
/**
* Converts this drawing to an <svg> element.
*
* @param {!libjass.parts.DrawingInstructions} drawingInstructions
* @param {!libjass.parts.Color} fillColor
* @return {!SVGSVGElement}
*/
toSVG(drawingInstructions: parts.DrawingInstructions, fillColor: parts.Color): SVGSVGElement {
const svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svg.setAttribute("version", "1.1");
if (drawingInstructions.instructions.length === 0) {
return svg;
}
const scaleFactor = Math.pow(2, this._scale - 1);
const scaleX = this._outputScaleX / scaleFactor;
const scaleY = this._outputScaleY / scaleFactor;
const path = document.createElementNS("http://www.w3.org/2000/svg", "path");
let pathString = "";
let bboxMinX = Infinity;
let bboxMaxX = -Infinity;
let bboxMinY = Infinity;
let bboxMaxY = -Infinity;
for (const instruction of drawingInstructions.instructions) {
if (instruction instanceof parts.drawing.MoveInstruction) {
pathString += ` M ${ instruction.x.toFixed(3) } ${ (instruction.y + this._baselineOffset).toFixed(3) }`;
bboxMinX = Math.min(bboxMinX, instruction.x);
bboxMaxX = Math.max(bboxMaxX, instruction.x);
bboxMinY = Math.min(bboxMinY, instruction.y + this._baselineOffset);
bboxMaxY = Math.max(bboxMaxY, instruction.y + this._baselineOffset);
}
else if (instruction instanceof parts.drawing.LineInstruction) {
pathString += ` L ${ instruction.x.toFixed(3) } ${ (instruction.y + this._baselineOffset).toFixed(3) }`;
bboxMinX = Math.min(bboxMinX, instruction.x);
bboxMaxX = Math.max(bboxMaxX, instruction.x);
bboxMinY = Math.min(bboxMinY, instruction.y + this._baselineOffset);
bboxMaxY = Math.max(bboxMaxY, instruction.y + this._baselineOffset);
}
else if (instruction instanceof parts.drawing.CubicBezierCurveInstruction) {
pathString += ` C ${ instruction.x1.toFixed(3) } ${ (instruction.y1 + this._baselineOffset).toFixed(3) } ${ instruction.x2.toFixed(3) } ${ (instruction.y2 + this._baselineOffset).toFixed(3) } ${ instruction.x3.toFixed(3) } ${ (instruction.y3 + this._baselineOffset).toFixed(3) }`;
bboxMinX = Math.min(bboxMinX, instruction.x1, instruction.x2, instruction.x3);
bboxMaxX = Math.max(bboxMaxX, instruction.x1, instruction.x2, instruction.x3);
bboxMinY = Math.min(bboxMinY, instruction.y1 + this._baselineOffset, instruction.y2 + this._baselineOffset, instruction.y3 + this._baselineOffset);
bboxMaxY = Math.max(bboxMaxY, instruction.y1 + this._baselineOffset, instruction.y2 + this._baselineOffset, instruction.y3 + this._baselineOffset);
}
}
bboxMinX *= scaleX;
bboxMaxX *= scaleX;
bboxMinY *= scaleY;
bboxMaxY *= scaleY;
const bboxWidth = bboxMaxX - bboxMinX;
const bboxHeight = bboxMaxY - bboxMinY;
svg.width.baseVal.valueAsString = `${ bboxWidth.toFixed(3) }px`;
svg.height.baseVal.valueAsString = `${ bboxHeight.toFixed(3) }px`;
// svg.viewBox.baseVal is null in atleast FF. See https://bugzilla.mozilla.org/show_bug.cgi?id=888307 which justifies it with SVG 1.2 spec.
svg.setAttribute("viewBox", `${ bboxMinX } ${ bboxMinY } ${ bboxWidth } ${ bboxHeight }`);
svg.style.position = "relative";
svg.style.left = `${ bboxMinX.toFixed(3) }px`;
svg.style.top = `${ bboxMinY.toFixed(3) }px`;
const g = document.createElementNS("http://www.w3.org/2000/svg", "g");
svg.appendChild(g);
g.setAttribute("transform", `scale(${ scaleX.toFixed(3) } ${ scaleY.toFixed(3) })`);
g.appendChild(path);
path.setAttribute("d", pathString);
path.setAttribute("fill", fillColor.toString());
return svg;
}
}

View File

@ -0,0 +1,121 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Promise } from "../../utility/promise";
/**
* @param {string} fontFamily
* @param {number} fontSize
* @param {string} fallbackFonts
* @param {!HTMLDivElement} fontSizeElement
*/
function prepareFontSizeElement(fontFamily: string, fontSize: number, fallbackFonts: string, fontSizeElement: HTMLDivElement): void {
let fonts = `"${ fontFamily }"`;
if (fallbackFonts !== "") {
fonts += `, ${ fallbackFonts }`;
}
fontSizeElement.style.fontFamily = fonts;
fontSizeElement.style.fontSize = `${ fontSize }px`;
}
/**
* @param {string} fontFamily
* @param {number} fontSize
* @param {string} fallbackFonts
* @param {!HTMLDivElement} fontSizeElement
* @return {!Promise.<number>}
*/
function lineHeightForFontSize(fontFamily: string, fontSize: number, fallbackFonts: string, fontSizeElement: HTMLDivElement): Promise<number> {
prepareFontSizeElement(fontFamily, fontSize, fallbackFonts, fontSizeElement);
return new Promise<number>(resolve => setTimeout(() => resolve(fontSizeElement.offsetHeight), 1000));
}
/**
* @param {string} fontFamily
* @param {number} fontSize
* @param {string} fallbackFonts
* @param {!HTMLDivElement} fontSizeElement
* @return {number}
*/
function lineHeightForFontSizeSync(fontFamily: string, fontSize: number, fallbackFonts: string, fontSizeElement: HTMLDivElement): number {
prepareFontSizeElement(fontFamily, fontSize, fallbackFonts, fontSizeElement);
return fontSizeElement.offsetHeight;
}
/**
* @param {number} lowerLineHeight
* @param {number} upperLineHeight
* @return {[number, number]}
*/
function fontMetricsFromLineHeights(lowerLineHeight: number, upperLineHeight: number): [number, number] {
return [lowerLineHeight, (360 - 180) / (upperLineHeight - lowerLineHeight)];
}
/**
* Calculates font metrics for the given font family.
*
* @param {string} fontFamily
* @param {string} fallbackFonts
* @param {!HTMLDivElement} fontSizeElement
* @return {!Promise.<[number, number]>}
*/
export function calculateFontMetrics(fontFamily: string, fallbackFonts: string, fontSizeElement: HTMLDivElement): Promise<[number, number]> {
return lineHeightForFontSize(fontFamily, 180, fallbackFonts, fontSizeElement).then(lowerLineHeight =>
lineHeightForFontSize(fontFamily, 360, fallbackFonts, fontSizeElement).then(upperLineHeight =>
fontMetricsFromLineHeights(lowerLineHeight, upperLineHeight)));
}
/**
* @param {number} lineHeight
* @param {number} lowerLineHeight
* @param {number} factor
* @return {number}
*/
function fontSizeFromMetrics(lineHeight: number, lowerLineHeight: number, factor: number): number {
return 180 + (lineHeight - lowerLineHeight) * factor;
}
/**
* Uses linear interpolation to calculate the CSS font size that would give the specified line height for the specified font family.
*
* WARNING: If fontMetricsCache doesn't already contain a cached value for this font family, and it is not a font already installed on the user's device, then this function
* may return wrong values. To avoid this, make sure to preload the font using the {@link libjass.renderers.RendererSettings.fontMap} property when constructing the renderer.
*
* @param {string} fontFamily
* @param {number} lineHeight
* @param {string} fallbackFonts
* @param {!HTMLDivElement} fontSizeElement
* @param {!Map.<string, [number, number]>} fontMetricsCache
* @return {number}
*/
export function fontSizeForLineHeight(fontFamily: string, lineHeight: number, fallbackFonts: string, fontSizeElement: HTMLDivElement, fontMetricsCache: Map<string, [number, number]>): number {
let existingMetrics = fontMetricsCache.get(fontFamily);
if (existingMetrics === undefined) {
const lowerLineHeight = lineHeightForFontSizeSync(fontFamily, 180, fallbackFonts, fontSizeElement);
const upperLineHeight = lineHeightForFontSizeSync(fontFamily, 360, fallbackFonts, fontSizeElement);
fontMetricsCache.set(fontFamily, existingMetrics = fontMetricsFromLineHeights(lowerLineHeight, upperLineHeight));
}
const [lowerLineHeight, factor] = existingMetrics;
return fontSizeFromMetrics(lineHeight, lowerLineHeight, factor);
}

View File

@ -0,0 +1,43 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* This class represents a single keyframe. It has a list of CSS properties (names and values) associated with a point in time. Multiple keyframes make up an animation.
*
* @param {number} time
* @param {!Map.<string, string>} properties
*/
export class Keyframe {
constructor(private _time: number, private _properties: Map<string, string>) { }
/**
* @type {number}
*/
get time(): number {
return this._time;
}
/**
* @type {!Map.<string, string>}
*/
get properties(): Map<string, string> {
return this._properties;
}
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,78 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Map } from "./utility/map";
const classes = new Map<number, Function & { fromJSON?(obj: any): any }>();
/**
* Registers a class as a serializable type.
*
* @param {function(new:*)} clazz
*/
export function registerClass(clazz: Function & { fromJSON?(obj: any): any }): void {
clazz.prototype._classTag = classes.size;
classes.set(clazz.prototype._classTag, clazz);
}
/**
* Serializes the given object.
*
* @param {*} obj
* @return {string}
*/
export function serialize(obj: any): string {
return JSON.stringify(obj, (/* ujs:unreferenced */ _key: string, value: any) => {
if (value && (value._classTag !== undefined) && !Object.prototype.hasOwnProperty.call(value, "_classTag")) {
// Copy the _classTag from this object's prototype to itself, so that it will be serialized.
value._classTag = value._classTag;
}
return value;
});
}
/**
* @param {string} str
* @return {*}
*/
export function deserialize(str: string): any {
return JSON.parse(str, (/* ujs:unreferenced */ _key: string, value: any) => {
if (value && (value._classTag !== undefined)) {
const clazz = classes.get(value._classTag);
if (clazz === undefined) {
throw new Error(`Unknown class of tag ${ value._classTag } cannot be deserialized.`);
}
if (typeof clazz.fromJSON === "function") {
value = clazz.fromJSON(value);
}
else {
const hydratedValue = Object.create(clazz.prototype);
for (const key of Object.keys(value)) {
hydratedValue[key] = value[key];
}
value = hydratedValue;
}
}
return value;
});
}

View File

@ -0,0 +1,51 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Debug mode. When true, libjass logs some debug messages.
*
* @type {boolean}
*/
export let debugMode: boolean = false;
/**
* Verbose debug mode. When true, libjass logs some more debug messages. This setting is independent of {@link libjass.debugMode}
*
* @type {boolean}
*/
export let verboseMode: boolean = false;
/**
* Sets the debug mode.
*
* @param {boolean} value
*/
export function setDebugMode(value: boolean): void {
debugMode = value;
}
/**
* Sets the verbose debug mode.
*
* @param {boolean} value
*/
export function setVerboseMode(value: boolean): void {
verboseMode = value;
}

View File

@ -0,0 +1,24 @@
{
"compilerOptions": {
"lib": ["es5", "dom"],
"experimentalDecorators": true,
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"noUnusedLocals": true,
"noUnusedParameters": false,
"strictNullChecks": true,
"target": "es5",
"module": "amd",
"moduleResolution": "node",
"outFile": "../lib/libjass.js",
"noImplicitUseStrict": true,
"sourceMap": true,
"inlineSources": true,
"types": []
}
}

View File

@ -0,0 +1,164 @@
{
"$schema": "http://json.schemastore.org/tslint",
"rules": {
"adjacent-overload-signatures": true,
"ban-types": false,
"member-access": false,
"member-ordering": [true, { "order": [
"public-static-field",
"public-static-method",
"protected-static-field",
"protected-static-method",
"private-static-field",
"private-static-method",
"public-instance-field",
"protected-instance-field",
"private-instance-field",
"public-constructor",
"public-instance-method",
"protected-constructor",
"protected-instance-method",
"private-constructor",
"private-instance-method"
]}],
"no-any": false,
"no-empty-interface": false,
"no-import-side-effect": true,
"no-inferrable-types": false,
"no-internal-module": true,
"no-magic-numbers": false,
"no-namespace": true,
"no-non-null-assertion": false,
"no-reference": true,
"no-var-requires": true,
"only-arrow-functions": false,
"prefer-for-of": true,
"promise-function-async": false,
"typedef": [true, "call-signature", "parameter", "property-declaration", "member-variable-declaration"],
"typedef-whitespace": [true, {
"call-signature": "nospace",
"index-signature": "nospace",
"parameter": "nospace",
"property-declaration": "nospace",
"variable-declaration": "nospace"
}, {
"call-signature": "space",
"index-signature": "space",
"parameter": "space",
"property-declaration": "space",
"variable-declaration": "space"
}],
"unified-signatures": true,
"await-promise": true,
"ban": false,
"curly": true,
"forin": true,
"import-blacklist": false,
"label-position": true,
"no-arg": true,
"no-bitwise": true,
"no-conditional-assignment": true,
"no-console": false,
"no-construct": true,
"no-debugger": true,
"no-duplicate-super": true,
"no-duplicate-variable": true,
"no-empty": false,
"no-eval": true,
"no-floating-promises": true,
"no-for-in-array": true,
"no-inferred-empty-object-type": true,
"no-invalid-template-strings": true,
"no-invalid-this": false,
"no-misused-new": true,
"no-null-keyword": false,
"no-shadowed-variable": false,
"no-sparse-arrays": true,
"no-string-literal": true,
"no-string-throw": true,
"no-switch-case-fall-through": true,
"no-unbound-method": false,
"no-unsafe-any": false,
"no-unsafe-finally": true,
"no-unused-expression": true,
"no-unused-variable": [true, "check-parameters"],
"no-use-before-declare": false,
"no-var-keyword": true,
"no-void-expression": [true, "ignore-arrow-function-shorthand"],
"radix": false,
"restrict-plus-operands": true,
"strict-boolean-expressions": false,
"strict-type-predicates": true,
"switch-default": false,
"triple-equals": true,
"typeof-compare": true,
"use-isnan": true,
"cyclomatic-complexity": false,
"eofline": true,
"indent": [true, "tabs"],
"linebreak-style": [true, "LF"],
"max-classes-per-file": false,
"max-file-line-count": false,
"max-line-length": false,
"no-default-export": true,
"no-mergeable-namespace": true,
"no-require-imports": true,
"object-literal-sort-keys": false,
"prefer-const": [true, { "destructuring": "all" }],
"trailing-comma": [true, { "multiline": "always", "singleline": "never" }],
"align": [true, "statements"],
"array-type": [true, "array"],
"arrow-parens": [true, "ban-single-arg-parens"],
"arrow-return-shorthand": true,
"callable-types": true,
"class-name": true,
"comment-format": [true, "check-space"],
"completed-docs": false,
"file-header": ["true", "Copyright \\d{4}"],
"import-spacing": true,
"interface-name": [true, "never-prefix"],
"interface-over-type-literal": false,
"jsdoc-format": true,
"match-default-export-name": true,
"newline-before-return": false,
"new-parens": true,
"no-angle-bracket-type-assertion": true,
"no-boolean-literal-compare": true,
"no-consecutive-blank-lines": true,
"no-parameter-properties": false,
"no-reference-import": true,
"no-trailing-whitespace": true,
"no-unnecessary-callback-wrapper": true,
"no-unnecessary-initializer": true,
"no-unnecessary-qualifier": true,
"object-literal-key-quotes": [true, "as-needed"],
"object-literal-shorthand": true,
"one-line": [true, "check-open-brace", "check-whitespace"],
"one-variable-per-declaration": true,
"ordered-imports": [true, { "import-sources-order": "case-insensitive", "named-imports-order": "case-insensitive" }],
"prefer-function-over-method": [true, "allow-public", "allow-protected"],
"prefer-method-signature": true,
"prefer-template": [true, "allow-single-concat"],
"quotemark": [true, "double", "avoid-escape"],
"return-undefined": true,
"space-before-function-paren": [true, {
"anonymous": "always",
"named": "never",
"asyncArrow": "always",
"method": "never",
"constructor": "never"
}],
"semicolon": [true, "always"],
"variable-name": [true, "ban-keywords", "check-format", "allow-leading-underscore"],
"whitespace": [true, "check-branch", "check-decl", "check-operator", "check-module", "check-separator", "check-type", "check-typecast", "check-preblock"]
}
}

View File

@ -0,0 +1,322 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { parseLineIntoTypedTemplate } from "../parser/misc";
import { SrtStreamParser, StreamParser } from "../parser/stream-parsers";
import { BrowserReadableStream, Stream, StringStream, XhrStream } from "../parser/streams";
import { registerClass as serializable } from "../serialization";
import { debugMode, verboseMode } from "../settings";
import { Map } from "../utility/map";
import { Promise } from "../utility/promise";
import { Attachment } from "./attachment";
import { Dialogue } from "./dialogue";
import { Format } from "./misc";
import { ScriptProperties } from "./script-properties";
import { Style } from "./style";
/**
* This class represents an ASS script. It contains the {@link libjass.ScriptProperties}, an array of {@link libjass.Style}s, and an array of {@link libjass.Dialogue}s.
*/
@serializable
export class ASS {
/**
* Creates an ASS object from the raw text of an ASS script.
*
* @param {string} raw The raw text of the script.
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>}
*/
static fromString(raw: string, type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
return ASS.fromStream(new StringStream(raw), type);
}
/**
* Creates an ASS object from the given {@link libjass.parser.Stream}.
*
* @param {!libjass.parser.Stream} stream The stream to parse the script from
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromStream(stream: Stream, type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
switch (type) {
case Format.ASS:
case "ass":
return new StreamParser(stream).ass;
case Format.SRT:
case "srt":
return new SrtStreamParser(stream).ass;
default:
throw new Error(`Invalid value of type: ${ type }`);
}
}
/**
* Creates an ASS object from the given URL.
*
* @param {string} url The URL of the script.
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromUrl(url: string, type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
let fetchPromise: Promise<ASS>;
if (typeof global.fetch === "function" && BrowserReadableStream.isSupported()) {
fetchPromise = global.fetch(url).then(response => {
if (response.ok === false || (response.ok === undefined && (response.status === undefined || response.status < 200 || response.status > 299))) {
throw new Error(`HTTP request for ${ url } failed with status code ${ response.status }`);
}
return ASS.fromReadableStream(response.body, "utf-8", type);
});
}
else {
fetchPromise = Promise.reject<ASS>(new Error("Not supported."));
}
return fetchPromise.catch(reason => {
if (debugMode) {
console.log("fetch() failed, falling back to XHR: %o", reason);
}
const xhr = new XMLHttpRequest();
const result = ASS.fromStream(new XhrStream(xhr), type);
xhr.open("GET", url, true);
xhr.send();
return result;
});
}
/**
* Creates an ASS object from the given ReadableStream.
*
* @param {!ReadableStream} stream
* @param {string="utf-8"} encoding
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromReadableStream(stream: ReadableStream, encoding: string = "utf-8", type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
return ASS.fromStream(new BrowserReadableStream(stream, encoding), type);
}
/**
* Custom deserialization for ASS objects.
*
* @param {!*} obj
* @return {!libjass.ASS}
*/
static fromJSON(obj: any): ASS {
const result: ASS = Object.create(ASS.prototype);
result._properties = obj._properties;
result._styles = new Map<string, Style>();
for (const name of Object.keys(obj._styles)) {
const style = obj._styles[name];
result._styles.set(name, style);
}
result._dialogues = obj._dialogues;
result._attachments = obj._attachments;
result._stylesFormatSpecifier = obj._stylesFormatSpecifier;
result._dialoguesFormatSpecifier = obj._dialoguesFormatSpecifier;
return result;
}
private _properties: ScriptProperties = new ScriptProperties();
private _styles: Map<string, Style> = new Map<string, Style>();
private _dialogues: Dialogue[] = [];
private _attachments: Attachment[] = [];
private _stylesFormatSpecifier: string[] | null = null;
private _dialoguesFormatSpecifier: string[] | null = null;
/**
* The properties of this script.
*
* @type {!libjass.ScriptProperties}
*/
get properties(): ScriptProperties {
return this._properties;
}
/**
* The styles in this script.
*
* @type {!Map.<string, !libjass.Style>}
*/
get styles(): Map<string, Style> {
return this._styles;
}
/**
* The dialogues in this script.
*
* @type {!Array.<!libjass.Dialogue>}
*/
get dialogues(): Dialogue[] {
return this._dialogues;
}
/**
* The attachments of this script.
*
* @type {!Array.<!libjass.Attachment>}
*/
get attachments(): Attachment[] {
return this._attachments;
}
/**
* The format specifier for the styles section.
*
* @type {Array.<string>}
*/
get stylesFormatSpecifier(): string[] | null {
return this._stylesFormatSpecifier;
}
/**
* The format specifier for the events section.
*
* @type {Array.<string>}
*/
set stylesFormatSpecifier(value: string[] | null) {
this._stylesFormatSpecifier = value;
}
/**
* The format specifier for the styles section.
*
* @type {Array.<string>}
*/
get dialoguesFormatSpecifier(): string[] | null {
return this._dialoguesFormatSpecifier;
}
/**
* The format specifier for the events section.
*
* @type {Array.<string>}
*/
set dialoguesFormatSpecifier(value: string[] | null) {
this._dialoguesFormatSpecifier = value;
}
constructor() {
// Deprecated constructor argument
if (arguments.length === 1) {
throw new Error("Constructor `new ASS(rawASS)` has been deprecated. Use `ASS.fromString(rawASS)` instead.");
}
this._styles.set("Default", new Style(new Map([["Name", "Default"]])));
}
/**
* Add a style to this ASS script.
*
* @param {string} line The line from the script that contains the new style.
*/
addStyle(line: string): void {
if (this._stylesFormatSpecifier === null) {
throw new Error("stylesFormatSpecifier is not set.");
}
const styleLine = parseLineIntoTypedTemplate(line, this._stylesFormatSpecifier);
if (styleLine === null || styleLine.type !== "Style") {
return;
}
const styleTemplate = styleLine.template;
if (verboseMode) {
let repr = "";
styleTemplate.forEach((value, key) => repr += `${ key } = ${ value }, `);
console.log(`Read style: ${ repr }`);
}
// Create the dialogue and add it to the dialogues array
const style = new Style(styleTemplate);
this._styles.set(style.name, style);
}
/**
* Add an event to this ASS script.
*
* @param {string} line The line from the script that contains the new event.
*/
addEvent(line: string): void {
if (this._dialoguesFormatSpecifier === null) {
throw new Error("dialoguesFormatSpecifier is not set.");
}
const dialogueLine = parseLineIntoTypedTemplate(line, this._dialoguesFormatSpecifier);
if (dialogueLine === null || dialogueLine.type !== "Dialogue") {
return;
}
const dialogueTemplate = dialogueLine.template;
if (verboseMode) {
let repr = "";
dialogueTemplate.forEach((value, key) => repr += `${ key } = ${ value }, `);
console.log(`Read dialogue: ${ repr }`);
}
// Create the dialogue and add it to the dialogues array
this.dialogues.push(new Dialogue(dialogueTemplate, this));
}
/**
* Add an attachment to this ASS script.
*
* @param {!libjass.Attachment} attachment
*/
addAttachment(attachment: Attachment): void {
this._attachments.push(attachment);
}
/**
* Custom JSON serialization for ASS objects.
*
* @return {!*}
*/
toJSON(): any {
const result = Object.create(null);
result._properties = this._properties;
result._styles = Object.create(null);
this._styles.forEach((style, name) => result._styles[name] = style);
result._dialogues = this._dialogues;
result._attachments = this._attachments;
result._stylesFormatSpecifier = this._stylesFormatSpecifier;
result._dialoguesFormatSpecifier = this._dialoguesFormatSpecifier;
result._classTag = (ASS.prototype as any)._classTag;
return result;
}
}

View File

@ -0,0 +1,78 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { registerClass as serializable } from "../serialization";
/**
* The type of an attachment.
*/
export enum AttachmentType {
Font,
Graphic,
}
/**
* This class represents an attachment in a {@link libjass.ASS} script.
*
* @param {string} filename The filename of this attachment.
* @param {number} type The type of this attachment.
*/
@serializable
export class Attachment {
private _contents: string = "";
constructor(private _filename: string, private _type: AttachmentType) { }
/**
* The filename of this attachment.
*
* @type {number}
*/
get filename(): string {
return this._filename;
}
/**
* The type of this attachment.
*
* @type {number}
*/
get type(): AttachmentType {
return this._type;
}
/**
* The contents of this attachment in base64 encoding.
*
* @type {number}
*/
get contents(): string {
return this._contents;
}
/**
* The contents of this attachment in base64 encoding.
*
* @type {number}
*/
set contents(value: string) {
this._contents = value;
}
}

View File

@ -0,0 +1,270 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ASS } from "./ass";
import { Style } from "./style";
import { valueOrDefault } from "./misc";
import { parse } from "../parser/parse";
import * as parts from "../parts";
import { registerClass as serializable } from "../serialization";
import { debugMode } from "../settings";
import { Map } from "../utility/map";
/**
* This class represents a dialogue in a {@link libjass.ASS} script.
*
* @param {!Map.<string, string>} template The template object that contains the dialogue's properties. It is a map of the string values read from the ASS file.
* @param {string} template["Style"] The name of the default style of this dialogue
* @param {string} template["Start"] The start time
* @param {string} template["End"] The end time
* @param {string} template["Layer"] The layer number
* @param {string} template["Text"] The text of this dialogue
* @param {!libjass.ASS} ass The ASS object to which this dialogue belongs
*/
@serializable
export class Dialogue {
private static _lastDialogueId: number = -1;
private _id: number;
private _style: Style;
private _start: number;
private _end: number;
private _layer: number;
private _alignment: number;
private _rawPartsString: string;
private _parts: parts.Part[] | null = null;
private _containsTransformTag: boolean = false;
constructor(template: Map<string, string>, ass: ASS) {
{
const normalizedTemplate = new Map<string, string>();
template.forEach((value, key) => {
normalizedTemplate.set(key.toLowerCase(), value);
});
template = normalizedTemplate;
}
this._id = ++Dialogue._lastDialogueId;
let styleName = template.get("style");
if (typeof styleName === "string") {
styleName = styleName.replace(/^\*+/, "");
if (styleName.match(/^Default$/i) !== null) {
styleName = "Default";
}
}
let style = (styleName !== undefined) ? ass.styles.get(styleName) : undefined;
if (style === undefined) {
if (debugMode) {
console.warn(`Unrecognized style ${ styleName }. Falling back to "Default"`);
}
style = ass.styles.get("Default");
if (style === undefined) {
throw new Error(`Unrecognized style ${ styleName }. Could not fall back to "Default" style since it doesn't exist.`);
}
}
this._style = style;
const start = template.get("start");
if (typeof start !== "string") {
throw new Error(`Dialogue start time ${ start } is not a string.`);
}
this._start = toTime(start);
const end = template.get("end");
if (typeof end !== "string") {
throw new Error(`Dialogue end time ${ end } is not a string.`);
}
this._end = toTime(end);
this._layer = Math.max(valueOrDefault(template, "layer", parseInt, value => !isNaN(value), "0"), 0);
const text = template.get("text");
if (typeof text !== "string") {
throw new Error(`Dialogue text ${ text } is not a string.`);
}
this._rawPartsString = text;
}
/**
* The unique ID of this dialogue. Auto-generated.
*
* @type {number}
*/
get id(): number {
return this._id;
}
/**
* The start time of this dialogue.
*
* @type {number}
*/
get start(): number {
return this._start;
}
/**
* The end time of this dialogue.
*
* @type {number}
*/
get end(): number {
return this._end;
}
/**
* The default style of this dialogue.
*
* @type {!libjass.Style}
*/
get style(): Style {
return this._style;
}
/**
* The alignment number of this dialogue.
*
* @type {number}
*/
get alignment(): number {
if (this._parts === null) {
this._parsePartsString();
}
return this._alignment;
}
/**
* The layer number of this dialogue.
*
* @type {number}
*/
get layer(): number {
return this._layer;
}
/**
* The {@link libjass.parts} of this dialogue.
*
* @type {!Array.<!libjass.parts.Part>}
*/
get parts(): parts.Part[] {
if (this._parts === null) {
this._parsePartsString();
}
return this._parts!;
}
/**
* Convenience getter for whether this dialogue contains a {\t} tag.
*
* @type {boolean}
*/
get containsTransformTag(): boolean {
if (this._parts === null) {
this._parsePartsString();
}
return this._containsTransformTag;
}
/**
* @return {string} A simple representation of this dialogue's properties and parts.
*/
toString(): string {
return `#${ this._id } [${ this._start.toFixed(3) }-${ this._end.toFixed(3) }] ${ (this._parts !== null) ? this._parts.join(", ") : this._rawPartsString }`;
}
/**
* Parses this dialogue's parts from the raw parts string.
*/
private _parsePartsString(): void {
this._parts = parse(this._rawPartsString, "dialogueParts") as parts.Part[];
this._alignment = this._style.alignment;
this._parts.forEach((part, index) => {
if (part instanceof parts.Alignment) {
this._alignment = part.value;
}
else if (part instanceof parts.Move) {
if (part.t1 === null || part.t2 === null) {
this._parts![index] =
new parts.Move(
part.x1, part.y1, part.x2, part.y2,
0, this._end - this._start,
);
}
}
else if (part instanceof parts.Transform) {
if (part.start === null || part.end === null || part.accel === null) {
this._parts![index] =
new parts.Transform(
(part.start === null) ? 0 : part.start,
(part.end === null) ? (this._end - this._start) : part.end,
(part.accel === null) ? 1 : part.accel,
part.tags,
);
}
this._containsTransformTag = true;
}
});
if (debugMode) {
const possiblyIncorrectParses = this._parts.filter(part => part instanceof parts.Comment && part.value.indexOf("\\") !== -1);
if (possiblyIncorrectParses.length > 0) {
console.warn(
`Possible incorrect parse:
${ this._rawPartsString }
was parsed as
${ this.toString() }
The possibly incorrect parses are:
${ possiblyIncorrectParses.join("\n") }`,
);
}
}
}
}
/**
* Converts this string into the number of seconds it represents. This string must be in the form of hh:mm:ss.MMM
*
* @param {string} str
* @return {number}
*/
function toTime(str: string): number {
return str.split(":").reduce<number>((previousValue, currentValue) => previousValue * 60 + parseFloat(currentValue), 0);
}

View File

@ -0,0 +1,103 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The format of the string passed to {@link libjass.ASS.fromString}
*/
export enum Format {
ASS,
SRT,
}
/**
* The wrapping style defined in the {@link libjass.ScriptProperties}
*/
export enum WrappingStyle {
SmartWrappingWithWiderTopLine = 0,
SmartWrappingWithWiderBottomLine = 3,
EndOfLineWrapping = 1,
NoLineWrapping = 2,
}
/**
* The border style defined in the {@link libjass.Style} properties.
*/
export enum BorderStyle {
Outline = 1,
OpaqueBox = 3,
}
/**
* A property.
*/
export interface Property {
/**
* @type {string}
*/
name: string;
/**
* @type {string}
*/
value: string;
}
/**
* A template object with a particular type.
*/
export interface TypedTemplate {
/**
* @type {string}
*/
type: string;
/**
* @type {!Map.<string, string>}
*/
template: Map<string, string>;
}
/**
* @param {!Map.<string, string>} template
* @param {string} key
* @param {function(string):T} converter
* @param {?function(T):boolean} validator
* @param {T} defaultValue
* @return {T}
*/
export function valueOrDefault<T>(template: Map<string, string>, key: string, converter: (str: string) => T, validator: ((value: T) => boolean) | null, defaultValue: string): T {
const value = template.get(key);
if (value === undefined) {
return converter(defaultValue);
}
try {
const result = converter(value);
if (validator !== null && !validator(result)) {
throw new Error("Validation failed.");
}
return result;
}
catch (ex) {
throw new Error(`Property ${ key } has invalid value ${ value } - ${ ex.stack }`);
}
}

View File

@ -0,0 +1,106 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { registerClass as serializable } from "../serialization";
import { WrappingStyle } from "./misc";
/**
* This class represents the properties of a {@link libjass.ASS} script.
*/
@serializable
export class ScriptProperties {
private _resolutionX: number;
private _resolutionY: number;
private _wrappingStyle: WrappingStyle;
private _scaleBorderAndShadow: boolean;
/**
* The horizontal script resolution.
*
* @type {number}
*/
get resolutionX(): number {
return this._resolutionX;
}
/**
* The horizontal script resolution.
*
* @type {number}
*/
set resolutionX(value: number) {
this._resolutionX = value;
}
/**
* The vertical script resolution.
*
* @type {number}
*/
get resolutionY(): number {
return this._resolutionY;
}
/**
* The vertical script resolution.
*
* @type {number}
*/
set resolutionY(value: number) {
this._resolutionY = value;
}
/**
* The wrap style. One of the {@link libjass.WrappingStyle} constants.
*
* @type {number}
*/
get wrappingStyle(): WrappingStyle {
return this._wrappingStyle;
}
/**
* The wrap style. One of the {@link libjass.WrappingStyle} constants.
*
* @type {number}
*/
set wrappingStyle(value: WrappingStyle) {
this._wrappingStyle = value;
}
/**
* Whether to scale outline widths and shadow depths from script resolution to video resolution or not. If true, widths and depths are scaled.
*
* @type {boolean}
*/
get scaleBorderAndShadow(): boolean {
return this._scaleBorderAndShadow;
}
/**
* Whether to scale outline widths and shadow depths from script resolution to video resolution or not. If true, widths and depths are scaled.
*
* @type {boolean}
*/
set scaleBorderAndShadow(value: boolean) {
this._scaleBorderAndShadow = value;
}
}

View File

@ -0,0 +1,334 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { parse } from "../parser/parse";
import { Color } from "../parts";
import { registerClass as serializable } from "../serialization";
import { Map } from "../utility/map";
import { BorderStyle, valueOrDefault } from "./misc";
/**
* This class represents a single global style declaration in a {@link libjass.ASS} script. The styles can be obtained via the {@link libjass.ASS.styles} property.
*
* @param {!Map.<string, string>} template The template object that contains the style's properties. It is a map of the string values read from the ASS file.
* @param {string} template["Name"] The name of the style
* @param {string} template["Italic"] -1 if the style is italicized
* @param {string} template["Bold"] -1 if the style is bold
* @param {string} template["Underline"] -1 if the style is underlined
* @param {string} template["StrikeOut"] -1 if the style is struck-through
* @param {string} template["Fontname"] The name of the font
* @param {string} template["Fontsize"] The size of the font
* @param {string} template["ScaleX"] The horizontal scaling of the font
* @param {string} template["ScaleY"] The vertical scaling of the font
* @param {string} template["Spacing"] The letter spacing of the font
* @param {string} template["PrimaryColour"] The primary color
* @param {string} template["OutlineColour"] The outline color
* @param {string} template["BackColour"] The shadow color
* @param {string} template["Outline"] The outline thickness
* @param {string} template["Shadow"] The shadow depth
* @param {string} template["Alignment"] The alignment number
* @param {string} template["MarginL"] The left margin
* @param {string} template["MarginR"] The right margin
* @param {string} template["MarginV"] The vertical margin
*/
@serializable
export class Style {
private _name: string;
private _italic: boolean;
private _bold: boolean;
private _underline: boolean;
private _strikeThrough: boolean;
private _fontName: string;
private _fontSize: number;
private _fontScaleX: number;
private _fontScaleY: number;
private _letterSpacing: number;
private _rotationZ: number;
private _primaryColor: Color;
private _secondaryColor: Color;
private _outlineColor: Color;
private _shadowColor: Color;
private _outlineThickness: number;
private _borderStyle: BorderStyle;
private _shadowDepth: number;
private _alignment: number;
private _marginLeft: number;
private _marginRight: number;
private _marginVertical: number;
constructor(template: Map<string, string>) {
{
const normalizedTemplate = new Map<string, string>();
template.forEach((value, key) => {
normalizedTemplate.set(key.toLowerCase(), value);
});
template = normalizedTemplate;
}
const name = template.get("name");
if (typeof name !== "string") {
throw new Error(`Style name ${ name } is not a string.`);
}
this._name = name.replace(/^\*+/, "");
this._italic = !!valueOrDefault(template, "italic", parseFloat, value => !isNaN(value), "0");
this._bold = !!valueOrDefault(template, "bold", parseFloat, value => !isNaN(value), "0");
this._underline = !!valueOrDefault(template, "underline", parseFloat, value => !isNaN(value), "0");
this._strikeThrough = !!valueOrDefault(template, "strikeout", parseFloat, value => !isNaN(value), "0");
this._fontName = valueOrDefault(template, "fontname", str => str, value => value.constructor === String, "sans-serif");
this._fontSize = valueOrDefault(template, "fontsize", parseFloat, value => !isNaN(value), "18");
this._fontScaleX = valueOrDefault(template, "scalex", parseFloat, value => value >= 0, "100") / 100;
this._fontScaleY = valueOrDefault(template, "scaley", parseFloat, value => value >= 0, "100") / 100;
this._letterSpacing = valueOrDefault(template, "spacing", parseFloat, value => value >= 0, "0");
this._rotationZ = valueOrDefault(template, "angle", parseFloat, value => !isNaN(value), "0");
this._primaryColor = valueOrDefault(template, "primarycolour", str => parse(str, "colorWithAlpha") as Color, null, "&H00FFFFFF");
this._secondaryColor = valueOrDefault(template, "secondarycolour", str => parse(str, "colorWithAlpha") as Color, null, "&H00FFFF00");
this._outlineColor = valueOrDefault(template, "outlinecolour", str => parse(str, "colorWithAlpha") as Color, null, "&H00000000");
this._shadowColor = valueOrDefault(template, "backcolour", str => parse(str, "colorWithAlpha") as Color, null, "&H80000000");
this._outlineThickness = valueOrDefault(template, "outline", parseFloat, value => value >= 0, "2");
this._borderStyle = valueOrDefault(template, "borderstyle", parseInt, value => (BorderStyle as any)[(BorderStyle as any)[value]] === value, "1");
this._shadowDepth = valueOrDefault(template, "shadow", parseFloat, value => value >= 0, "3");
this._alignment = valueOrDefault(template, "alignment", parseInt, value => value >= 1 && value <= 9, "2");
this._marginLeft = valueOrDefault(template, "marginl", parseFloat, value => !isNaN(value), "20");
this._marginRight = valueOrDefault(template, "marginr", parseFloat, value => !isNaN(value), "20");
this._marginVertical = valueOrDefault(template, "marginv", parseFloat, value => !isNaN(value), "20");
}
/**
* The name of this style.
*
* @type {string}
*/
get name(): string {
return this._name;
}
/**
* Whether this style is italicized or not.
*
* @type {string}
*/
get italic(): boolean {
return this._italic;
}
/**
* Whether this style is bold or not.
*
* @type {boolean}
*/
get bold(): boolean {
return this._bold;
}
/**
* Whether this style is underlined or not.
*
* @type {boolean}
*/
get underline(): boolean {
return this._underline;
}
/**
* Whether this style is struck-through or not.
*
* @type {boolean}
*/
get strikeThrough(): boolean {
return this._strikeThrough;
}
/**
* The name of this style's font.
*
* @type {string}
*/
get fontName(): string {
return this._fontName;
}
/**
* The size of this style's font.
*
* @type {number}
*/
get fontSize(): number {
return this._fontSize;
}
/**
* The horizontal scaling of this style's font.
*
* @type {number}
*/
get fontScaleX(): number {
return this._fontScaleX;
}
/**
* The vertical scaling of this style's font.
*
* @type {number}
*/
get fontScaleY(): number {
return this._fontScaleY;
}
/**
* The letter spacing scaling of this style's font.
*
* @type {number}
*/
get letterSpacing(): number {
return this._letterSpacing;
}
/**
* The default Z-rotation of this style.
*
* @type {number}
*/
get rotationZ(): number {
return this._rotationZ;
}
/**
* The color of this style's font.
*
* @type {!libjass.parts.Color}
*/
get primaryColor(): Color {
return this._primaryColor;
}
/**
* The alternate color of this style's font, used in karaoke.
*
* @type {!libjass.parts.Color}
*/
get secondaryColor(): Color {
return this._secondaryColor;
}
/**
* The color of this style's outline.
*
* @type {!libjass.parts.Color}
*/
get outlineColor(): Color {
return this._outlineColor;
}
/**
* The color of this style's shadow.
*
* @type {!libjass.parts.Color}
*/
get shadowColor(): Color {
return this._shadowColor;
}
/**
* The thickness of this style's outline.
*
* @type {number}
*/
get outlineThickness(): number {
return this._outlineThickness;
}
/**
* The border style of this style.
*
* @type {number}
*/
get borderStyle(): BorderStyle {
return this._borderStyle;
}
/**
* The depth of this style's shadow.
*
* @type {number}
*/
get shadowDepth(): number {
return this._shadowDepth;
}
/**
* The alignment of dialogues of this style.
*
* @type {number}
*/
get alignment(): number {
return this._alignment;
}
/**
* The left margin of dialogues of this style.
*
* @type {number}
*/
get marginLeft(): number {
return this._marginLeft;
}
/**
* The right margin of dialogues of this style.
*
* @type {number}
*/
get marginRight(): number {
return this._marginRight;
}
/**
* The vertical margin of dialogues of this style.
*
* @type {number}
*/
get marginVertical(): number {
return this._marginVertical;
}
}

View File

@ -0,0 +1,221 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Map implementation for browsers that don't support it. Only supports keys which are of Number or String type, or which have a property called "id".
*
* Keys and values are stored as properties of an object, with property names derived from the key type.
*
* @param {!Array.<!Array.<*>>=} iterable Only an array of elements (where each element is a 2-tuple of key and value) is supported.
*/
class SimpleMap<K, V> implements Map<K, V> {
private _keys: { [key: string]: K };
private _values: { [key: string]: V };
private _size: number;
constructor(iterable?: [K, V][]) {
this.clear();
if (iterable === undefined) {
return;
}
if (!Array.isArray(iterable)) {
throw new Error("Non-array iterables are not supported by the SimpleMap constructor.");
}
for (const element of iterable) {
this.set(element[0], element[1]);
}
}
/**
* @param {K} key
* @return {?V}
*/
get(key: K): V | undefined {
const property = keyToProperty(key);
if (property === null) {
return undefined;
}
return this._values[property];
}
/**
* @param {K} key
* @return {boolean}
*/
has(key: K): boolean {
const property = keyToProperty(key);
if (property === null) {
return false;
}
return property in this._keys;
}
/**
* @param {K} key
* @param {V} value
* @return {libjass.Map.<K, V>} This map
*/
set(key: K, value: V): this {
const property = keyToProperty(key);
if (property === null) {
throw new Error("This Map implementation only supports Number and String keys, or keys with an id property.");
}
if (!(property in this._keys)) {
this._size++;
}
this._keys[property] = key;
this._values[property] = value;
return this;
}
/**
* @param {K} key
* @return {boolean} true if the key was present before being deleted, false otherwise
*/
delete(key: K): boolean {
const property = keyToProperty(key);
if (property === null) {
return false;
}
const result = property in this._keys;
if (result) {
delete this._keys[property];
delete this._values[property];
this._size--;
}
return result;
}
/**
*/
clear(): void {
this._keys = Object.create(null);
this._values = Object.create(null);
this._size = 0;
}
/**
* @param {function(V, K, libjass.Map.<K, V>)} callbackfn A function that is called with each key and value in the map.
* @param {*} thisArg
*/
forEach(callbackfn: (value: V, index: K, map: this) => void, thisArg?: any): void {
for (const property of Object.keys(this._keys)) {
callbackfn.call(thisArg, this._values[property], this._keys[property], this);
}
}
/**
* @type {number}
*/
get size(): number {
return this._size;
}
}
/* tslint:disable:variable-name */
/**
* Set to the global implementation of Map if the environment has one, else set to {@link ./utility/map.SimpleMap}
*
* Can be set to a value using {@link libjass.configure}
*
* Set it to null to force {@link ./utility/map.SimpleMap} to be used even if a global Map is present.
*
* @type {function(new:Map, !Array.<!Array.<*>>=)}
*/
export let Map: {
new <K, V>(iterable?: [K, V][]): Map<K, V>;
/* tslint:disable-next-line:member-ordering */
prototype: Map<any, any>;
} = (() => {
const globalMap = global.Map;
if (globalMap === undefined) {
return SimpleMap;
}
if (typeof globalMap.prototype.forEach !== "function") {
return SimpleMap;
}
try {
if (new globalMap([[1, "foo"], [2, "bar"]]).size !== 2) {
return SimpleMap;
}
}
catch (ex) {
return SimpleMap;
}
return globalMap as any;
})();
/* tslint:enable:variable-name */
/**
* Sets the Map implementation used by libjass to the provided one. If null, {@link ./utility/map.SimpleMap} is used.
*
* @param {?function(new:Map, !Array.<!Array.<*>>=)} value
*/
export function setImplementation(value: typeof Map | null): void {
if (value !== null) {
Map = value;
}
else {
Map = SimpleMap;
}
}
/**
* Converts the given key into a property name for the internal map.
*
* @param {*} key
* @return {?string}
*/
function keyToProperty(key: any): string | null {
if (typeof key === "number") {
return `#${ key }`;
}
if (typeof key === "string") {
return `'${ key }`;
}
if ((key as any).id !== undefined) {
return `!${ (key as any).id }`;
}
return null;
}

View File

@ -0,0 +1,33 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Adds properties of the given mixins' prototypes to the given class's prototype.
*
* @param {!*} clazz
* @param {!Array.<*>} mixins
*/
export function mixin(clazz: any, mixins: any[]): void {
for (const mixin of mixins) {
for (const name of Object.getOwnPropertyNames(mixin.prototype)) {
clazz.prototype[name] = mixin.prototype[name];
}
}
}

View File

@ -0,0 +1,497 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Based on https://github.com/petkaantonov/bluebird/blob/1b1467b95442c12378d0ea280ede61d640ab5510/src/schedule.js
const enqueueJob = (function (): (callback: () => void) => void {
/* tslint:disable-next-line:variable-name */
const MutationObserver = global.MutationObserver || global.WebkitMutationObserver;
if (global.process !== undefined && typeof global.process.nextTick === "function") {
const nextTick = global.process.nextTick;
return (callback: () => void) => {
nextTick(callback);
};
}
else if (MutationObserver !== undefined) {
const pending: (() => void)[] = [];
let currentlyPending = false;
const div = document.createElement("div");
const observer = new MutationObserver(() => {
const processing = pending.splice(0, pending.length);
for (const callback of processing) {
callback();
}
currentlyPending = false;
if (pending.length > 0) {
div.classList.toggle("foo");
currentlyPending = true;
}
});
observer.observe(div, { attributes: true });
return (callback: () => void) => {
pending.push(callback);
if (!currentlyPending) {
div.classList.toggle("foo");
currentlyPending = true;
}
};
}
else {
return (callback: () => void) => setTimeout(callback, 0);
}
})();
/**
* Promise implementation for browsers that don't support it.
*
* @param {function(function(T|!Thenable.<T>), function(*))} executor
*/
class SimplePromise<T> {
/**
* @param {T|!Thenable.<T>} value
* @return {!Promise.<T>}
*/
static resolve<T>(value: T | Thenable<T>): Promise<T> {
if (value instanceof SimplePromise) {
return value;
}
return new Promise<T>(resolve => resolve(value));
}
/**
* @param {*} reason
* @return {!Promise.<T>}
*/
static reject<T>(reason: any): Promise<T> {
return new Promise<T>((/* ujs:unreferenced */ _resolve, reject) => reject(reason));
}
/**
* @param {!Array.<T|!Thenable.<T>>} values
* @return {!Promise.<!Array.<T>>}
*/
static all<T>(values: (T | Thenable<T>)[]): Promise<T[]> {
return new Promise<T[]>((resolve, reject) => {
const result: T[] = [];
let numUnresolved = values.length;
if (numUnresolved === 0) {
resolve(result);
return;
}
values.forEach((value, index) => Promise.resolve(value).then(value => {
result[index] = value;
numUnresolved--;
if (numUnresolved === 0) {
resolve(result);
}
}, reject));
});
}
/**
* @param {!Array.<T|!Thenable.<T>>} values
* @return {!Promise.<T>}
*/
static race<T>(values: (T | Thenable<T>)[]): Promise<T> {
return new Promise<T>((resolve, reject) => {
for (const value of values) {
/* tslint:disable-next-line:no-floating-promises */
Promise.resolve(value).then(resolve, reject);
}
});
}
private _state: SimplePromiseState<T> = { state: "pending" };
private _fulfillReactions: FulfilledPromiseReaction<T, any>[] = [];
private _rejectReactions: RejectedPromiseReaction<any>[] = [];
constructor(executor: (resolve: (resolution: T | Thenable<T>) => void, reject: (reason: any) => void) => void) {
/* tslint:disable-next-line:strict-type-predicates */
if (typeof executor !== "function") {
throw new TypeError(`typeof executor !== "function"`);
}
const { resolve, reject } = this._createResolvingFunctions();
try {
executor(resolve, reject);
}
catch (ex) {
reject(ex);
}
}
/**
* @param {?function(T):(U|!Thenable.<U>)} onFulfilled
* @param {?function(*):(U|!Thenable.<U>)} onRejected
* @return {!Promise.<U>}
*/
then<U>(onFulfilled: ((value: T) => U | Thenable<U>) | undefined, onRejected?: (reason: any) => U | Thenable<U>): Promise<U> {
const resultCapability = new DeferredPromise<U>();
if (typeof onFulfilled !== "function") {
onFulfilled = (value: T) => value as any as U;
}
if (typeof onRejected !== "function") {
onRejected = (reason: any): U => { throw reason; };
}
const fulfillReaction: FulfilledPromiseReaction<T, U> = {
capabilities: resultCapability,
handler: onFulfilled,
};
const rejectReaction: RejectedPromiseReaction<U> = {
capabilities: resultCapability,
handler: onRejected,
};
switch (this._state.state) {
case "pending":
this._fulfillReactions.push(fulfillReaction);
this._rejectReactions.push(rejectReaction);
break;
case "fulfilled":
enqueueFulfilledReactionJob(fulfillReaction, this._state.value);
break;
case "rejected":
enqueueRejectedReactionJob(rejectReaction, this._state.reason);
break;
}
return resultCapability.promise;
}
/**
* @param {function(*):(T|!Thenable.<T>)} onRejected
* @return {!Promise.<T>}
*/
catch(onRejected: (reason: any) => T | Thenable<T>): Promise<T> {
return this.then(undefined, onRejected);
}
/**
* @return {{ resolve(T|!Thenable.<T>), reject(*) }}
*/
private _createResolvingFunctions(): { resolve(resolution: T | Thenable<T>): void; reject(reason: any): void; } {
let alreadyResolved = false;
const resolve = (resolution: T | Thenable<T>): void => {
if (alreadyResolved) {
return;
}
alreadyResolved = true;
if (resolution === this) {
this._reject(new TypeError(`resolution === this`));
return;
}
/* tslint:disable-next-line:strict-type-predicates */
if (resolution === null || (typeof resolution !== "object" && typeof resolution !== "function")) {
this._fulfill(resolution as T);
return;
}
let then: ThenableThen<T>;
try {
then = (resolution as Thenable<T>).then;
}
catch (ex) {
this._reject(ex);
return;
}
/* tslint:disable-next-line:strict-type-predicates */
if (typeof then !== "function") {
this._fulfill(resolution as T);
return;
}
enqueueJob(() => this._resolveWithThenable(resolution as Thenable<T>, then));
};
const reject = (reason: any): void => {
if (alreadyResolved) {
return;
}
alreadyResolved = true;
this._reject(reason);
};
return { resolve, reject };
}
/**
* @param {!Thenable.<T>} thenable
* @param {{function(this:!Thenable.<T>, function(T|!Thenable.<T>), function(*))}} then
*/
private _resolveWithThenable(thenable: Thenable<T>, then: ThenableThen<T>): void {
const { resolve, reject } = this._createResolvingFunctions();
try {
then.call(thenable, resolve, reject);
}
catch (ex) {
reject(ex);
}
}
/**
* @param {T} value
*/
private _fulfill(value: T): void {
const reactions = this._fulfillReactions;
this._state = { state: "fulfilled", value };
this._fulfillReactions = [];
this._rejectReactions = [];
for (const reaction of reactions) {
enqueueFulfilledReactionJob(reaction, value);
}
}
/**
* @param {*} reason
*/
private _reject(reason: any): void {
const reactions = this._rejectReactions;
this._state = { state: "rejected", reason };
this._fulfillReactions = [];
this._rejectReactions = [];
for (const reaction of reactions) {
enqueueRejectedReactionJob(reaction, reason);
}
}
}
/* tslint:disable:variable-name */
/**
* Set to the global implementation of Promise if the environment has one, else set to {@link ./utility/promise.SimplePromise}
*
* Can be set to a value using {@link libjass.configure}
*
* Set it to null to force {@link ./utility/promise.SimplePromise} to be used even if a global Promise is present.
*
* @type {function(new:Promise)}
*/
export let Promise: {
new <T>(init: (resolve: (value: T | Thenable<T>) => void, reject: (reason: any) => void) => void): Promise<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Promise<any>;
resolve<T>(value: T | Thenable<T>): Promise<T>;
reject<T>(reason: any): Promise<T>;
all<T>(values: (T | Thenable<T>)[]): Promise<T[]>;
race<T>(values: (T | Thenable<T>)[]): Promise<T>;
} = global.Promise || SimplePromise;
/* tslint:enable:variable-name */
interface FulfilledPromiseReaction<T, U> {
/** @type {!libjass.DeferredPromise.<U>} */
capabilities: DeferredPromise<U>;
/**
* @param {T} value
* @return {U|!Thenable.<U>}
*/
handler(value: T): U | Thenable<U>;
}
interface RejectedPromiseReaction<U> {
/** @type {!libjass.DeferredPromise.<U>} */
capabilities: DeferredPromise<U>;
/**
* @param {*} reason
* @return {U|!Thenable.<U>}
*/
handler(reason: any): U | Thenable<U>;
}
/**
* The state of the {@link ./utility/promise.SimplePromise}
*/
type SimplePromiseState<T> = { state: "pending" } | { state: "fulfilled"; value: T; } | { state: "rejected"; reason: any; };
/**
* Sets the Promise implementation used by libjass to the provided one. If null, {@link ./utility/promise.SimplePromise} is used.
*
* @param {?function(new:Promise)} value
*/
export function setImplementation(value: typeof Promise | null): void {
if (value !== null) {
Promise = value;
}
else {
Promise = SimplePromise;
}
}
/**
* A deferred promise.
*/
export class DeferredPromise<T> {
/**
* @type {function(T|!Thenable.<T>)}
*/
resolve: (value: T | Thenable<T>) => void;
/**
* @type {function(*)} reason
*/
reject: (reason: any) => void;
private _promise: Promise<T>;
constructor() {
this._promise = new Promise<T>((resolve, reject) => {
Object.defineProperties(this, {
resolve: { value: resolve, enumerable: true },
reject: { value: reject, enumerable: true },
});
});
}
/**
* @type {!Promise.<T>}
*/
get promise(): Promise<T> {
return this._promise;
}
}
/**
* Returns a promise that resolves to the first (in iteration order) promise that fulfills, and rejects if all the promises reject.
*
* @param {!Array.<!Promise.<T>>} promises
* @return {!Promise.<T>}
*/
export function first<T>(promises: Promise<T>[]): Promise<T> {
return first_rec(promises, []);
}
/**
* @param {!Array.<!Promise.<T>>} promises
* @param {!Array.<*>} previousRejections
* @return {!Promise.<T>}
*/
function first_rec<T>(promises: Promise<T>[], previousRejections: any[]): Promise<T> {
if (promises.length === 0) {
return Promise.reject(previousRejections);
}
const [head, ...tail] = promises;
return head.catch(reason => first_rec(tail, previousRejections.concat(reason)));
}
/**
* Returns a promise that resolves to the first (in time order) promise that fulfills, and rejects if all the promises reject.
*
* @param {!Array.<!Promise.<T>>} promises
* @return {!Promise.<T>}
*/
export function any<T>(promises: Promise<T>[]): Promise<T> {
return new Promise<T>((resolve, reject) =>
Promise.all<any>(promises.map(promise => promise.then(resolve, reason => reason))).then(reject));
}
/**
* Returns a promise that runs the given callback when the promise has resolved regardless of whether it fulfilled or rejected.
*
* @param {!Promise.<T>} promise
* @param {function()} body
* @return {!Promise.<T>}
*/
export function lastly<T>(promise: Promise<T>, body: () => void): Promise<T> {
return promise.then<any>(value => {
body();
return value;
}, reason => {
body();
throw reason;
});
}
/**
* @param {!FulfilledPromiseReaction.<T, *>} reaction
* @param {T} value
*/
function enqueueFulfilledReactionJob<T>(reaction: FulfilledPromiseReaction<T, any>, value: T): void {
enqueueJob(() => {
const { capabilities: { resolve, reject }, handler } = reaction;
let handlerResult: any | Thenable<any>;
try {
handlerResult = handler(value);
}
catch (ex) {
reject(ex);
return;
}
resolve(handlerResult);
});
}
/**
* @param {!RejectedPromiseReaction.<*>} reaction
* @param {*} reason
*/
function enqueueRejectedReactionJob(reaction: RejectedPromiseReaction<any>, reason: any): void {
enqueueJob(() => {
const { capabilities: { resolve, reject }, handler } = reaction;
let handlerResult: any | Thenable<any>;
try {
handlerResult = handler(reason);
}
catch (ex) {
reject(ex);
return;
}
resolve(handlerResult);
});
}

View File

@ -0,0 +1,178 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Set implementation for browsers that don't support it. Only supports Number and String elements.
*
* Elements are stored as properties of an object, with names derived from their type.
*
* @param {!Array.<T>=} iterable Only an array of values is supported.
*/
class SimpleSet<T> implements Set<T> {
private _elements: { [key: string]: T };
private _size: number;
constructor(iterable?: T[]) {
this.clear();
if (iterable === undefined) {
return;
}
if (!Array.isArray(iterable)) {
throw new Error("Non-array iterables are not supported by the SimpleSet constructor.");
}
for (const value of iterable) {
this.add(value);
}
}
/**
* @param {T} value
* @return {libjass.Set.<T>} This set
*/
add(value: T): this {
const property = toProperty(value);
if (property === null) {
throw new Error("This Set implementation only supports Number and String values.");
}
if (!(property in this._elements)) {
this._size++;
}
this._elements[property] = value;
return this;
}
/**
*/
clear(): void {
this._elements = Object.create(null);
this._size = 0;
}
/**
* @param {T} value
* @return {boolean}
*/
has(value: T): boolean {
const property = toProperty(value);
if (property === null) {
return false;
}
return property in this._elements;
}
/**
* @param {function(T, T, libjass.Set.<T>)} callbackfn A function that is called with each value in the set.
* @param {*} thisArg
*/
forEach(callbackfn: (value: T, index: T, set: this) => void, thisArg?: any): void {
for (const property of Object.keys(this._elements)) {
const element = this._elements[property];
callbackfn.call(thisArg, element, element, this);
}
}
/**
* @type {number}
*/
get size(): number {
return this._size;
}
}
/* tslint:disable:variable-name */
/**
* Set to the global implementation of Set if the environment has one, else set to {@link ./utility/set.SimpleSet}
*
* Can be set to a value using {@link libjass.configure}
*
* Set it to null to force {@link ./utility/set.SimpleSet} to be used even if a global Set is present.
*
* @type {function(new:Set, !Array.<T>=)}
*/
export let Set: {
new <T>(iterable?: T[]): Set<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Set<any>;
} = (() => {
const globalSet = global.Set;
if (globalSet === undefined) {
return SimpleSet;
}
if (typeof globalSet.prototype.forEach !== "function") {
return SimpleSet;
}
try {
if ((new globalSet([1, 2])).size !== 2) {
return SimpleSet;
}
}
catch (ex) {
return SimpleSet;
}
return globalSet as any;
})();
/* tslint:enable:variable-name */
/**
* Sets the Set implementation used by libjass to the provided one. If null, {@link ./utility/set.SimpleSet} is used.
*
* @param {?function(new:Set, !Array.<T>=)} value
*/
export function setImplementation(value: typeof Set | null): void {
if (value !== null) {
Set = value;
}
else {
Set = SimpleSet;
}
}
/**
* Converts the given value into a property name for the internal map.
*
* @param {*} value
* @return {?string}
*/
function toProperty(value: any): string | null {
if (typeof value === "number") {
return `#${ value }`;
}
if (typeof value === "string") {
return `'${ value }`;
}
return null;
}

View File

@ -0,0 +1,195 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { deserialize, serialize } from "../serialization";
import { Map } from "../utility/map";
import { DeferredPromise, Promise } from "../utility/promise";
import { WorkerCommands } from "./commands";
import { getWorkerCommandHandler, registerWorkerCommand } from "./misc";
/**
* Represents a communication channel between the host and the web worker. An instance of this class is created by calling {@link libjass.webworker.createWorker}
*/
export interface WorkerChannel {
/**
* Sends a request to the other side to execute the given command with the given parameters.
*
* @param {number} command
* @param {*} parameters
* @return {!Promise.<*>} A promise that will get resolved when the other side computes the result
*/
request(command: WorkerCommands, parameters: any): Promise<any>;
}
/**
* The signature of a handler registered to handle a particular command in {@link libjass.webworker.WorkerCommands}
*/
export type WorkerCommandHandler = (parameters: any) => Promise<any>;
/**
* The interface implemented by a request sent to the other side of the communication channel.
*/
interface WorkerRequestMessage {
/**
* An internal identifier for this request. Used to connect responses to their corresponding requests.
*
* @type {number}
*/
requestId: number;
/**
* The command type of this request.
*
* @type {number}
*/
command: WorkerCommands;
/**
* Any parameters serialized with this request.
*
* @type {*}
*/
parameters: any;
}
/**
* The interface implemented by a response received from the other side of the communication channel.
*/
interface WorkerResponseMessage {
/**
* An internal identifier for this response. Used to connect responses to their corresponding requests.
*
* @type {number}
*/
requestId: number;
/**
* Set if the computation of this response resulted in an error.
*
* @type {*}
*/
error: any;
/**
* The result of computing this response.
*
* @type {*}
*/
result: any;
}
/**
* Internal implementation of libjass.webworker.WorkerChannel
*
* @param {!*} comm The object used to talk to the other side of the channel. When created by the main thread, this is the Worker object.
* When created by the web worker, this is its global object.
*/
export class WorkerChannelImpl implements WorkerChannel {
private static _lastRequestId: number = -1;
private _pendingRequests: Map<number, DeferredPromise<any>> = new Map<number, DeferredPromise<any>>();
constructor(private _comm: WorkerCommunication) {
this._comm.addEventListener("message", ev => this._onMessage(ev.data as string), false);
}
/**
* @param {number} command
* @param {*} parameters
* @return {!Promise.<*>}
*/
request(command: WorkerCommands, parameters: any): Promise<any> {
const deferred = new DeferredPromise<any>();
const requestId = ++WorkerChannelImpl._lastRequestId;
this._pendingRequests.set(requestId, deferred);
const requestMessage: WorkerRequestMessage = { requestId, command, parameters };
this._comm.postMessage(serialize(requestMessage));
return deferred.promise;
}
/**
* @param {number} requestId
*/
cancelRequest(requestId: number): void {
const deferred = this._pendingRequests.get(requestId);
if (deferred === undefined) {
return;
}
this._pendingRequests.delete(requestId);
deferred.reject(new Error("Cancelled."));
}
/**
* @param {!WorkerResponseMessage} message
*/
private _respond(message: WorkerResponseMessage): void {
let { requestId, error, result } = message;
if (error instanceof Error) {
error = { message: error.message, stack: error.stack };
}
this._comm.postMessage(serialize({ command: WorkerCommands.Response, requestId, error, result }));
}
/**
* @param {string} rawMessage
*/
private _onMessage(rawMessage: string): void {
const message = deserialize(rawMessage) as { command: WorkerCommands };
if (message.command === WorkerCommands.Response) {
const responseMessage = message as any as WorkerResponseMessage;
const deferred = this._pendingRequests.get(responseMessage.requestId);
if (deferred !== undefined) {
this._pendingRequests.delete(responseMessage.requestId);
if (responseMessage.error === null) {
deferred.resolve(responseMessage.result);
}
else {
deferred.reject(responseMessage.error);
}
}
}
else {
const requestMessage = message as WorkerRequestMessage;
const requestId = requestMessage.requestId;
const commandCallback = getWorkerCommandHandler(requestMessage.command);
if (commandCallback === undefined) {
this._respond({ requestId, error: new Error(`No handler registered for command ${ requestMessage.command }`), result: null });
return;
}
/* tslint:disable-next-line:no-floating-promises */
commandCallback(requestMessage.parameters).then<WorkerResponseMessage>(
result => ({ requestId, error: null, result }),
error => ({ requestId, error, result: null }),
).then(responseMessage => this._respond(responseMessage));
}
}
}
registerWorkerCommand(WorkerCommands.Ping, () => Promise.resolve(null));

View File

@ -0,0 +1,28 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The commands that can be sent to or from a web worker.
*/
export enum WorkerCommands {
Response = 0,
Parse = 1,
Ping = 2,
}

View File

@ -0,0 +1,59 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { WorkerChannel, WorkerChannelImpl } from "./channel";
export { WorkerChannel } from "./channel";
export { WorkerCommands } from "./commands";
/**
* Indicates whether web workers are supposed in this environment or not.
*
* @type {boolean}
*/
export const supported = global.Worker !== undefined;
const _scriptNode = (global.document !== undefined && global.document.currentScript !== undefined) ? global.document.currentScript : null;
/**
* Create a new web worker and returns a {@link libjass.webworker.WorkerChannel} to it.
*
* @param {string=} scriptPath The path to libjass.js to be loaded in the web worker. If the browser supports document.currentScript, the parameter is optional and, if not provided,
* the path will be determined from the src attribute of the <script> element that contains the currently running copy of libjass.js
* @return {!libjass.webworker.WorkerChannel} A communication channel to the new web worker.
*/
export function createWorker(scriptPath?: string): WorkerChannel {
if (scriptPath === undefined) {
if (_scriptNode === null) {
throw new Error("Could not auto-detect path of libjass.js, and explicit path was not passed in.");
}
scriptPath = _scriptNode.src;
}
return new WorkerChannelImpl(new Worker(scriptPath));
}
if (global.WorkerGlobalScope !== undefined && global instanceof global.WorkerGlobalScope) {
// This is a web worker. Set up a channel to talk back to the main thread.
/* tslint:disable-next-line:no-unused-expression */
new WorkerChannelImpl(global);
}

View File

@ -0,0 +1,46 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Map } from "../utility/map";
import { WorkerCommandHandler } from "./channel";
import { WorkerCommands } from "./commands";
const workerCommands = new Map<WorkerCommands, WorkerCommandHandler>();
/**
* Registers a handler for the given worker command.
*
* @param {number} command The command that this handler will handle. One of the {@link libjass.webworker.WorkerCommands} constants.
* @param {function(*, function(*, *))} handler The handler. A function of the form (parameters: *, response: function(error: *, result: *): void): void
*/
export function registerWorkerCommand(command: WorkerCommands, handler: WorkerCommandHandler): void {
workerCommands.set(command, handler);
}
/**
* Gets the handler for the given worker command.
*
* @param {number} command
* @return {?function(*, function(*, *))}
*/
export function getWorkerCommandHandler(command: WorkerCommands): WorkerCommandHandler | undefined {
return workerCommands.get(command);
}

View File

@ -0,0 +1,84 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
define(["intern!tdd", "intern/chai!assert", "intern/dojo/node!fs", "intern/dojo/node!path", "intern/dojo/node!sax"], function (tdd, assert, fs, path, sax) {
tdd.suite("Documentation tests", function () {
var ids = [];
var hrefs = [];
tdd.before(function () {
var parser = sax.parser(true);
parser.onopentag = function (node) {
if (node.name === "a" && node.attributes.href[0] === "#") {
hrefs.push(node.attributes.href.substr(1));
}
if (node.attributes.id !== undefined) {
ids.push(node.attributes.id);
}
};
parser.onerror = function (error) { throw error; };
parser.write(fs.readFileSync(require.toUrl("../libjass-gh-pages/api.xhtml"), { encoding: "utf8" })).close();
});
tdd.test("api.xhtml", function () {
var brokenLinks = hrefs.filter(function (href) {
return ids.indexOf(href) === -1;
});
assert.equal(brokenLinks.length, 0, "Broken link(s): " + brokenLinks.map(function (href) { return '"' + href + '"'; }).join(", "));
});
tdd.test("README.md", function () {
var regex = /\[[^\]]+\]\(http:\/\/arnavion\.github\.io\/libjass\/api\.xhtml#([^)]+)\)/g;
var brokenLinks = [];
var readme = fs.readFileSync(require.toUrl("./README.md"), { encoding: "utf8" });
var match;
while ((match = regex.exec(readme)) !== null) {
if (ids.indexOf(match[1]) === -1) {
brokenLinks.push(match[1]);
}
}
assert.equal(brokenLinks.length, 0, "Broken link(s): " + brokenLinks.map(function (href) { return '"' + href + '"'; }).join(", "));
});
tdd.test("{@link} tags in the source", function () {
var regex = /\{@link ([^}]+)\}/g;
var brokenLinks = [];
var libjassJs = fs.readFileSync(require.toUrl("./lib/libjass.js"), { encoding: "utf8" });
var match;
while ((match = regex.exec(libjassJs)) !== null) {
if (ids.indexOf(match[1]) === -1) {
brokenLinks.push(match[1]);
}
}
assert.equal(brokenLinks.length, 0, "Broken link(s): " + brokenLinks.map(function (href) { return '"' + href + '"'; }).join(", "));
});
});
});

View File

@ -0,0 +1,18 @@
[Script Info]
Title:
ScriptType: v4.00+
WrapStyle: 0
PlayResX: 1280
PlayResY: 720
Scroll Position: 0
Active Line: 0
Video Zoom Percent: 1
ScaledBorderAndShadow: yes
[V4+ Styles]
Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
Style: Default,Arial,500,&H7F0000FF,&H00FFFFFF,&H7F000000,&H7F000000,0,0,0,0,100,100,0,0,1,10,0,2,75,75,75,1
[Events]
Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
Dialogue: 0,0:00:00.00,0:10:00.00,Default,,0,0,0,,X

View File

@ -0,0 +1,31 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
define(["intern!tdd", "require", "tests/support/test-page"], function (tdd, require, TestPage) {
tdd.suite("alpha", function () {
tdd.test("Basic", function () {
var testPage = new TestPage(this.remote, require.toUrl("tests/support/browser-test-page.html"), "/tests/functional/alpha/alpha.ass", 1280, 720, "rgb(47, 163, 254)");
return testPage
.prepare()
.then(function (testPage) { return testPage.seekAndCompareScreenshot(1, require.toUrl("./alpha-1.png")); })
.then(function (testPage) { return testPage.done(); });
});
});
});

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

View File

@ -0,0 +1,154 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
define(["intern!tdd", "intern/chai!assert", "require", "intern/dojo/node!leadfoot/helpers/pollUntil"], function (tdd, assert, require, pollUntil) {
tdd.suite("Auto clock", function () {
tdd.test("Operations", function () {
this.remote.session.setExecuteAsyncTimeout(10000);
return this.remote
.get(require.toUrl("tests/support/browser-test-page.html"))
.then(pollUntil('return (document.readyState === "complete") ? true : null;', 100))
.execute(function () {
window.driverStartTime = 0;
window.driverStartTimeAt = new Date();
window.driver = function () {
return (new Date() - driverStartTimeAt) / 1000 + driverStartTime;
};
window.clock = new libjass.renderers.AutoClock(driver);
window.events = [];
clock.addEventListener(libjass.renderers.ClockEvent.Play, function () {
events.push("play");
});
clock.addEventListener(libjass.renderers.ClockEvent.Tick, function () {
events.push("tick");
});
clock.addEventListener(libjass.renderers.ClockEvent.Pause, function () {
events.push("pause");
});
clock.addEventListener(libjass.renderers.ClockEvent.Stop, function () {
events.push("stop");
});
return { enabled: clock.enabled, paused: clock.paused, rate: clock.rate, events: events.slice() };
})
.then(function (clock) {
assert.strictEqual(clock.enabled, true);
assert.strictEqual(clock.paused, true);
assert.strictEqual(clock.rate, 1);
assert.deepEqual(clock.events, []);
})
.executeAsync(function (callback) {
clock.play();
setTimeout(function () {
callback({ enabled: clock.enabled, paused: clock.paused, events: events.slice() });
}, 1000);
})
.then(function (clock) {
assert.strictEqual(clock.enabled, true);
assert.strictEqual(clock.paused, false);
assert(clock.events.length >= 2);
assert.strictEqual(clock.events[0], "play");
for (var i = 1; i < clock.events.length; i++) {
assert.strictEqual(clock.events[i], "tick");
}
})
.execute(function () {
events = [];
clock.disable();
return { enabled: clock.enabled, paused: clock.paused, events: events.slice() };
})
.then(function (clock) {
assert.strictEqual(clock.enabled, false);
assert.strictEqual(clock.paused, true);
assert.deepEqual(clock.events, ["pause", "stop"]);
})
.execute(function () {
events = [];
clock.enable();
return { enabled: clock.enabled, paused: clock.paused, events: events.slice() };
})
.then(function (clock) {
assert.strictEqual(clock.enabled, true);
assert.strictEqual(clock.paused, true);
assert.deepEqual(clock.events, []);
})
.executeAsync(function (callback) {
setTimeout(function () {
callback({ enabled: clock.enabled, paused: clock.paused, events: events.slice() });
}, 1000);
})
.then(function (clock) {
assert.strictEqual(clock.enabled, true);
assert.strictEqual(clock.paused, false);
assert(clock.events.length >= 2);
assert.strictEqual(clock.events[0], "play");
for (var i = 1; i < clock.events.length; i++) {
assert.strictEqual(clock.events[i], "tick");
}
})
.execute(function () {
events = [];
driverStartTime = 30000;
clock.seeking();
var result = { enabled: clock.enabled, paused: clock.paused, currentTime: clock.currentTime, events: events.slice() };
events = [];
return result;
})
.then(function (clock) {
assert.strictEqual(clock.enabled, true);
assert.strictEqual(clock.paused, true);
assert(clock.currentTime >= 30);
assert.deepEqual(clock.events, ["pause", "stop", "play", "tick", "pause"]);
})
.executeAsync(function (callback) {
setTimeout(function () {
callback({ enabled: clock.enabled, paused: clock.paused, currentTime: clock.currentTime, events: events.slice() });
}, 1000);
})
.then(function (clock) {
assert.strictEqual(clock.enabled, true);
assert.strictEqual(clock.paused, false);
assert(clock.currentTime >= 31);
assert(clock.events.length >= 2);
assert.strictEqual(clock.events[0], "play");
for (var i = 1; i < clock.events.length; i++) {
assert.strictEqual(clock.events[i], "tick");
}
});
});
});
});

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

View File

@ -0,0 +1,32 @@
[Script Info]
Title:
ScriptType: v4.00+
WrapStyle: 0
PlayResX: 1280
PlayResY: 720
Scroll Position: 0
Active Line: 0
Video Zoom Percent: 1
ScaledBorderAndShadow: yes
[V4+ Styles]
Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
Style: Default,Arial,90,&H00FFFFFF,&H00000000,&H00000000,&H96000000,0,0,0,0,100,100,0,0,1,0,0,2,75,75,75,1
[Events]
Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an1\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an2\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an3\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an7\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an8\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an9\frz45}MM\NMM
Dialogue: 1,0:00:01.00,0:00:02.00,Default,,0,0,0,,{\an1\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:02.00,0:00:03.00,Default,,0,0,0,,{\an2\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:03.00,0:00:04.00,Default,,0,0,0,,{\an3\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:04.00,0:00:05.00,Default,,0,0,0,,{\an4\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:05.00,0:00:06.00,Default,,0,0,0,,{\an5\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:06.00,0:00:07.00,Default,,0,0,0,,{\an6\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:07.00,0:00:08.00,Default,,0,0,0,,{\an7\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:08.00,0:00:09.00,Default,,0,0,0,,{\an8\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:09.00,0:00:10.00,Default,,0,0,0,,{\an9\pos(640,360)\frz45}MM\NMM

View File

@ -0,0 +1,40 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
define(["intern!tdd", "require", "tests/support/test-page"], function (tdd, require, TestPage) {
tdd.suite("fr", function () {
tdd.test("frz", function () {
var testPage = new TestPage(this.remote, require.toUrl("tests/support/browser-test-page.html"), "/tests/functional/fr/frz.ass", 1280, 720);
return testPage
.prepare()
.then(function (testPage) { return testPage.seekAndCompareScreenshot(0.5, require.toUrl("./frz-01.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(1.5, require.toUrl("./frz-02.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(2.5, require.toUrl("./frz-03.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(3.5, require.toUrl("./frz-04.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(4.5, require.toUrl("./frz-05.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(5.5, require.toUrl("./frz-06.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(6.5, require.toUrl("./frz-07.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(7.5, require.toUrl("./frz-08.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(8.5, require.toUrl("./frz-09.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(9.5, require.toUrl("./frz-10.png")); })
.then(function (testPage) { return testPage.done(); });
});
});
});

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Some files were not shown because too many files have changed in this diff Show More