Cleanup

Author: jabbany

BUILDING.md

@@ -1,10 +1,11 @@
-Building 编译项目
-==============================
-本项目采用 grunt 管理编译，有关 Grunt 系统的使用请参考[官方文档](http://gruntjs.com/getting-started)
-脚本弹幕部分的编译还需要 [TypeScript](http://www.typescriptlang.org/) 。这些库还会依赖于
-NodeJS环境。
+# Building 编译项目
 
-### 确定你是否需要编译 （Do I need to build CCL?）
+本项目采用 grunt 管理编译，有关 Grunt 系统的使用请参考
+[官方文档](http://gruntjs.com/getting-started) 脚本弹幕部分的编译需要 
+[TypeScript](http://www.typescriptlang.org/) 。
+这些库还会依赖于NodeJS环境。
+
+### 确定你是否需要编译 Do I need to build CCL?
 CommentCoreLibrary在库外提供了很多可扩展的空间，你可以相对简单的增加新的弹幕格式的支持，新的弹幕
 运行模式的支持和挂载各种不同的定时元件。CCL提供了丰富的扩展支持，通过预处理过滤器和运行时过滤器可以
 实现非常多的特殊功能支持。编译库意味着你可能需要一些默认环境没有的软件，比如 NodeJS 平台，为此需要
@@ -13,8 +14,8 @@ CommentCoreLibrary在库外提供了很多可扩展的空间，你可以相对
 当然自己编译也会带来一些优势，比如更小的库大小和更加专注的功能支持。还有，希望帮助CCL实现更多支持的
 开发者们也需要知道如何有效的编译。
 
-### 配置编译环境（Setup Build Environment）
-初次编译请确保你安装了 `node>=0.8.0`，为全局系统安装 grunt 请执行：
+### 配置编译环境Setup Build Environment
+初次编译请确保你安装了 `node>=1.0.0`，为全局系统安装 grunt 请执行：
 
     npm install -g grunt-cli
 
@@ -32,7 +33,7 @@ CommentCoreLibrary在库外提供了很多可扩展的空间，你可以相对
 即可按照默认模板编译。除此之外，你还可以改变编译目标：
 
 - `build` ： 只编译项目，不会clean掉build文件夹下的产物
-- `build:core_only` ： 只编译弹幕核心，不包括CommentProvider和parsers里面的解析器。
+- `build:core` ： 只编译弹幕核心，不包括CommentProvider和parsers里面的解析器。
     这个更加适用不需要已有的弹幕格式的各种二次开发
 - `build:scripting` ： 只编译代码弹幕支持
 

README.md

@@ -6,6 +6,8 @@
 [![Build Status: Linux](https://travis-ci.org/jabbany/CommentCoreLibrary.svg?branch=master)](https://travis-ci.org/jabbany/CommentCoreLibrary)
 [![Coverage Status](https://img.shields.io/coveralls/jabbany/CommentCoreLibrary.svg)](https://coveralls.io/r/jabbany/CommentCoreLibrary?branch=master)
 
+Other Languages: [简体中文](README.zh_cn.md)
+
 The CommentCoreLibrary is a set of Javascript modules that make up the
 core controller for comments streaming on top of timed media (video or audio).
 It is intended as a catalyst for the development of timed "danmaku" comments
@@ -55,33 +57,4 @@ Also, feel free to have a look at our sister project
 [ABPlayerHTML5](https://github.com/jabbany/ABPlayerHTML5) for a reference
 implementation of a video player with CommentCoreLibrary.
 
-# 弹幕核心通用构件
-弹幕核心通用构件是一套基于JavaScript构建的弹幕控制器，意在催化HTML5下弹幕播放器的发展。同时方便
-希望了解弹幕播放器运作原理的开发者，提供简单但是深入的入门。开发者们可以根据弹幕核心通用构件来自定义
-自己的流媒体注释播放模式。
-
-不管你在开发基于Javascript的Web服务，还是其他的需要弹幕播放功能服务，都可以参考弹幕核心
-的实现代码。我们以简单的方法构建了 (1) 时间轴管理 (2) 基础空间规划 (3) 弹幕过滤 (4)
-高级弹幕效果 (5) 基础格式解析 (6) 代码弹幕支持。
-
-## 测试
-你可以在[这里](http://jabbany.github.io/CommentCoreLibrary/demo) 访问到测试页面。
-我们欢迎各种[BUG报告](CONTRIBUTING.md)。
-
-## 许可
-本项目采取非常宽松的MIT许可。该许可允许你把本项目运用在任何开源或是闭源的，非营利或商业性的项目中。
-您只需在使用到的地方添加下面一行注释：
-
-    CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - Licensed under the MIT license
-
-## 使用
-- 有关本项目的[文档](docs/) 可以在 `docs/` 文件夹里面找到。
-- 一些实验性模块在 `experimental/` 里。
-- 测试数据在 `test/` 里。
-
-## 做出贡献
-非常欢迎提交问题报告和意见建议，同时你也可以在GitHub上Fork本工程，并发送Pull请求来提交
-你对项目的贡献。我们非常欢迎二次开发哟！有关具体介绍请参考 [CONTRIBUTING](CONTRIBUTING.md)。
 
-我们欢迎对项目任何细节处的针对性研发，尤其比如：解析功能、高级弹幕/代码弹幕和CSS优化等。
-如果希望研发播放器的构造和功能，请参考姊妹项目 ABPlayerHTML5。

README.zh_cn.md

@@ -0,0 +1,39 @@
+# 弹幕核心通用构件 CommentCoreLibrary
+[![NPM version](https://badge.fury.io/js/comment-core-library.svg)](http://badge.fury.io/js/comment-core-library)
+[![Bower version](https://badge.fury.io/bo/comment-core-library.svg)](http://badge.fury.io/bo/comment-core-library)
+[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+[![Build Status: Linux](https://travis-ci.org/jabbany/CommentCoreLibrary.svg?branch=master)](https://travis-ci.org/jabbany/CommentCoreLibrary)
+[![Coverage Status](https://img.shields.io/coveralls/jabbany/CommentCoreLibrary.svg)](https://coveralls.io/r/jabbany/CommentCoreLibrary?branch=master)
+
+其它语言: [English](README.md)
+
+弹幕核心通用构件是一套基于JavaScript构建的弹幕控制器，意在催化HTML5下弹幕播放器的发展。同时方便
+希望了解弹幕播放器运作原理的开发者，提供简单但是深入的入门。开发者们可以根据弹幕核心通用构件来自定义
+自己的流媒体注释播放模式。
+
+不管你在开发基于Javascript的Web服务，还是其他的需要弹幕播放功能服务，都可以参考弹幕核心
+的实现代码。我们以简单的方法构建了 (1) 时间轴管理 (2) 基础空间规划 (3) 弹幕过滤 (4)
+高级弹幕效果 (5) 基础格式解析 (6) 代码弹幕支持。
+
+## 测试
+你可以在[这里](http://jabbany.github.io/CommentCoreLibrary/demo) 访问到测试页面。
+我们欢迎各种[BUG报告](CONTRIBUTING.md)。
+
+## 许可
+本项目采取非常宽松的MIT许可。该许可允许你把本项目运用在任何开源或是闭源的，非营利或商业性的项目中。
+您只需在使用到的地方添加下面一行注释：
+
+    CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - Licensed under the MIT license
+
+## 使用
+- 有关本项目的[文档](docs/) 可以在 `docs/` 文件夹里面找到。
+- 一些实验性模块在 `experimental/` 里。
+- 测试数据在 `test/` 里。
+
+## 做出贡献
+非常欢迎提交问题报告和意见建议，同时你也可以在GitHub上Fork本工程，并发送Pull请求来提交
+你对项目的贡献。我们非常欢迎二次开发哟！有关具体介绍请参考 [CONTRIBUTING](CONTRIBUTING.md)。
+
+我们欢迎对项目任何细节处的针对性研发，尤其比如：解析功能、高级弹幕/代码弹幕和CSS优化等。
+如果希望研发播放器的构造和功能，请参考姊妹项目 ABPlayerHTML5。

demo/player-demo.htm

@@ -32,11 +32,11 @@
                     cm.time(Math.round(videoPlayer.currentTime * 1000));
                 }, 10);
             }
-            cm.startTimer();
+            cm.start();
             videoPlayer.play(); 
         }else{
             if(cm != null){
-                cm.stopTimer();
+                cm.stop();
                 clearTimeout(timer);
             }
             videoPlayer.pause(); 

demo/scripting/ccl.htm

@@ -186,7 +186,7 @@ <h2>Tests</h2>
 	});
 }
 function stop(){
-	cm.stopTimer();
+	cm.stop();
 	if(cm.scripting){
 		cm.scripting.send("Update:TimeUpdate",{
 			"state":"pause",
@@ -196,7 +196,7 @@ <h2>Tests</h2>
 	clearTimeout(tmr);
 }
 function resume(){
-	cm.startTimer();
+	cm.start();
 	start = new Date().getTime() - playhead;
 	lasthead = playhead;
 	tmr = setInterval(timeupdate,42);

dist/CommentCoreLibrary.js

@@ -1018,7 +1018,7 @@ var CommentManager = (function() {
         /** Precompute the offset width **/
         this.width = this.stage.offsetWidth;
         this.height = this.stage.offsetHeight;
-        this.startTimer = function () {
+        this._startTimer = function () {
             if (__timer > 0) {
                 return;
             }
@@ -1030,21 +1030,21 @@ var CommentManager = (function() {
                 cmMgr.onTimerEvent(elapsed,cmMgr);
             },10);
         };
-        this.stopTimer = function () {
+        this._stopTimer = function () {
             window.clearInterval(__timer);
             __timer = 0;
         };
     }
 
     /** Public **/
     CommentManager.prototype.stop = function(){
-        this.stopTimer();
+        this._stopTimer();
         // Send stop signal to all comments
         this.runline.forEach(function (c) { c.stop(); });
     };
 
     CommentManager.prototype.start = function(){
-        this.startTimer();
+        this._startTimer();
     };
 
     CommentManager.prototype.seek = function(time){

dist/CommentCoreLibrary.min.js

@@ -1,2 +1,39 @@
-Bilibili 弹幕XML 粗略解析定义文档
-====================== 
+# Bilibili 弹幕XML 粗略解析定义文档
+以下为探索出的 Bilibili 弹幕格式定义。目前 CommentCoreLibrary 可以还原这个格式下的大部分定义。
+不过由于有的定义是猜测的，所以还原后效果可能并不完全等同原始播放器。
+
+## 格式范例
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <i>
+      <chatserver>chat.bilibili.tv</chatserver>
+      <chatid>91236</chatid>
+      <source>k-v</source>
+      <d p="##,#,##,######,######,#,....,########">...</d>
+    </i>
+    
+## 普通部分
+普通弹幕文字为 `d` 标签内的text部分，参数取自 `p` 属性，顺序如下:
+
+1. stime: 弹幕出现时间 (s)
+2. mode: 弹幕类型 (`< 7` 时为普通弹幕)
+3. size: 字号
+4. color: 文字颜色
+5. date: 发送时间戳
+6. pool: 弹幕池ID
+7. author: 发送者ID
+8. dbid: 数据库记录ID（单调递增）
+
+## 高级弹幕 `innerText`
+当 `mode >= 7`时，弹幕为高级弹幕，text部分为JSON对象。根对象是一个数组，属性按照出没顺序
+
+### 基础属性
+1. x 坐标: 整数时是绝对坐标，浮点时表示相对坐标
+2. y 坐标: 整数时是绝对坐标，浮点时表示相对坐标
+3. alpha 渐变: 格式 `start-end` 的字符串表示透明度渐变
+4. duration 生存周期: 弹幕生存时间，默认 2500ms
+5. text: 文字
+6. (OPT) rotation Y: 可选，y坐标轴旋转，单位: deg
+7. (OPT) rotation Z: 可选，z坐标轴旋转，单位: deg
+8. 
+