imsc/README

  _                                 _    _____ 
 (_)                               | |  / ____|
  _   _ __ ___    ___    ___       | | | (___  
 | | | '_ ` _ \  / __|  / __|  _   | |  \___ \ 
 | | | | | | | | \__ \ | (__  | |__| |  ____) |
 |_| |_| |_| |_| |___/  \___|  \____/  |_____/ 
                                               
                                               
INTRODUCTION
============

imscJS is a JavaScript library for rendering IMSC1 Text and Image Profile
documents [1] to HTML5. IMSC1 is a profile of TTML [2] designed for subtitle and 
caption delivery worldwide.

[1] https://www.w3.org/TR/ttml-imsc1/
[2] https://www.w3.org/TR/ttaf1-dfxp

A live sample web app using imscJS is available at [3].

[3] http://sandflow.com/imsc1proc/index.html

Renders of IRT and TTML test vectors are available at [4], respectively.

[4] http://sandflow.com/imsc1proc/samples.html



KNOWN ISSUES AND LIMITATIONS
============================

imscJS is primarily developed on the latest released versions of Firefox and 
Chrome. Microsoft Internet Explorer is not supported at this point. 

imscJS is intended to reflect the most recent published versions of TTML1 and 
IMSC1, as clarified by proposed resolutions to issues captured in their
respective bug trackers [1-2].

[1] https://github.com/w3c/ttml1/issues
[2] https://github.com/w3c/imsc/issues

imscJS bugs are tracked at [3]

[3] https://github.com/sandflow/regxmllib/issues



RUNTIME DEPENDENCIES
====================

(required) sax-js (1.2.1) [https://www.npmjs.com/package/sax]

imscJS defines an NPM package (see DEVELOPMENT DEPENDENCIES and PACKAGE below) to simplify development, 
track dependencies and manage versions, but has no runtime dependency on node.js. Rendering to HTML5 requires a 
browser environment but parsing an IMSC1 document and tranforming it into ISDs does not.



DEVELOPMENT DEPENDENCIES
========================

(required) node.js (see package.json for a complete list of dependencies)

(recommended) git

(recommended) Netbeans 8.2

imscJS consists of a collection of modules (see MODULES below), which can be used in a node 
environment using the 'require' functionality, or standalone, in which case each module hosts its 
definitions under a global name. The modules can be combined into a single file using Browserify [1] 
to simplify use in web apps (see Gruntfile.js for an example).



QUICK START
===========

* build the 'build' target defined in Gruntfile.js using grunt [1]. This will build the library and the tests into the 
build/public_html directory, which can be served by popular web server.

[1] http://gruntjs.com/

* the resulting imsc.js and sax.js files at build/public_html/libs are, respectively, the 
imscJS library and its sax-js dependency. Both are included in a web page using the following:

```
        <script src="libs/sax.js"></script>
        <script src="libs/imsc.js"></script>
```

See TESTS AND SAMPLES below for a list of samples available.
    

    
ARCHITECTURE
============

imscJS renders an IMSC1 document in three distinct steps:

* `fromXML(xmlstring, errorHandler)` parses the document and returns a TT object. The latter contains opaque representation of the document 
and exposes the method `getMediaTimeEvents()` that returns a list of time offsets (in seconds) of the ISD, i.e. the points in time
where the visual representation of the document change.

* `generateISD(tt, offset, errorHandler)` creates a canonical representation of the document (provided as a TT object generated by `fromXML()`)
at a point in time (`offset` parameter). This point in time does not have to be one of the values returned by `getMediaTimeEvents()`.

* `renderHTML(isd, div)` renders the object returned by `generateISD()` into a DOM "div" element.


MODULES
=======

The imscJS codebase is arranged in the following modules (the token between parantheses is the global name 
used if 'require' is not used to load modules):

* doc.js (imscDoc): parses an IMSC1 document into an in-memory TT object
* isd.js (imscISD): generates an ISD object from a TT object
* html.js (imscHTML): generates an HTML fragment from an ISD object
* names.js (imscNames): common constants
* styles.js (imscStyles): defines TTML styling attributes processing
* utils.js (imscUtils): common utility functions



TESTS AND SAMPLES
=================

Formal unit tests are located at [1] and run as a webapp [2] using QUnit [3].

[1] src/test/webapp/js/unit-tests.js
[2] src/test/webapp/unit_tests.html
[3] https://qunitjs.com/

Also included is the 'samples' webapp [4] that renders the samples listed at [5].

[4] src/test/webapp/samples.html
[5] src/test/resources/samples/samples.json

The samples.json provided with the distribution expects the following two directories to be added to [6]

* "irt" directory that contains the "ttml" and "png" directories at [7]. These are test vectors provided by the IRT.
* "ttml" directory that contains the directories at [8]. These are the formal TTML1 test vectors provided by the W3C. 
Only tests that are compatible with IMSC1 are referenced.

[6] src/test/resources/samples/
[7] https://github.com/IRT-Open-Source/irt-ebu-tt-d-application-samples
[8] https://github.com/w3c/ttml1/tree/gh-pages/testsuite



NPM PACKAGE
===========

imscJS is released as an NPM package under the name "imsc".



NOTABLE DIRECTORIES AND FILES
=============================

/package.json                           NPM package definition

/Gruntfile.js                           Grunt build script

/properties.json                        General project properties

/README                                 This file

/LICENSE                                License under which imscJS is made available

/src/main/js                            JavaScript modules

/src/test/resources                     Test files

/src/test/webapp                        Test web applications

/build                                  Build output