etro 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [0.7.0] - 2020-12-17
+### Added
+- Importing with CommonJS syntax.
+- MIME type option for `record`.
+
+### Changed
+- Movies are no longer hidden and silent when exporting.
+- Media layers' audio nodes can now be reconnected to other audio nodes.
+- `refresh` can be called when the movie is playing or recording to force render.
+
+### Removed
+- Image layers' `imageX`, `imageY`, `imageWidth` and `imageHeight` properties. Every image is now rendered over its entire layer.
+- Video layers' `mediaX`, `mediaY`, `mediaWidth` and `mediaHeight` properties. Every video is now rendered over its entire layer.
+
+### Fixed
+- Fix recording with only video or only audio.
+- Video layers' `clipWidth` and `clipHeight` are no longer treated as invalid options.
+- Image layers' `clipWidth` and `clipHeight` are no longer set in the constructor, so if the `clipWidth` option is not supplied and the layer's `width` changes `clipWidth` uses the new `width`.
+- Video and image layers' `width` and `height` default to their `clipWidth` and `clipHeight` respectively.
+- Elliptical mask effect throwing `TypeError: path.split is not a function`.
+- In shader effects, textures whose dimensions are not powers of two accept interpolation filters.
+- No longer ignore video layers' `mediaWidth` option.
+- Treat layers' `enabled` property as dynamic (allowing for keyframes and functions).
+- Make each media layer's duration depend on its playback rate.
+
+### Security
+- Update vulnerable dependencies.
+
 ## [0.6.0] - 2019-12-26
 ### Added
 - Add [API documentation](https://etrojs.dev/).
@@ -100,10 +128,11 @@
   - Gaussian blur
   - Transform
 
-[0.6.0]: https://github.com/etro-js/etro/compare/v0.6...HEAD
-[0.5.0]: https://github.com/etro-js/etro/compare/v0.5...v0.6
-[0.4.0]: https://github.com/etro-js/etro/compare/v0.4...v0.5
-[0.3.0]: https://github.com/etro-js/etro/compare/v0.3...v0.4
+[Unreleased]: https://github.com/etro-js/etro/compare/v0.7...HEAD
+[0.7.0]: https://github.com/etro-js/etro/compare/v0.6...v0.7
+[0.6.0]: https://github.com/etro-js/etro/compare/v0.5...v0.6
+[0.5.0]: https://github.com/etro-js/etro/compare/v0.4...v0.5
+[0.4.0]: https://github.com/etro-js/etro/compare/v0.3...v0.4
 [0.3.0]: https://github.com/etro-js/etro/compare/v0.2...v0.3
 [0.2.0]: https://github.com/etro-js/etro/compare/v0.1...v0.2
 [0.1.0]: https://github.com/etro-js/etro/releases/tag/v0.1

package/CONTRIBUTING.md

@@ -10,7 +10,7 @@ Thank you for considering contributing to Etro! There are many ways you can cont
 
 #### Step 0: Dependencies
 
-- You will need `git`, `node` and `npm`
+- You will need Git, Node, NPM and Chrome (for headless unit testing) installed
 
 #### Step 1: Fork
 
@@ -54,7 +54,7 @@ Thank you for considering contributing to Etro! There are many ways you can cont
   $ npm test
   ```
 
-  to lint the code, generate the [dist](dist) files and run unit tests on them.
+  to lint the code, generate the [dist](dist) files and run unit tests on them. It may be helpful to put these commands in a pre-commit hook.
 
 - Commit your changes
   - Please avoid squashing all your commits into one; we try to keep each commit atomic in the `master` branch
@@ -132,7 +132,7 @@ The base etro objects are the following:
 * `layer.Base` - the root type of layer
 * `effect.Base` - the root type of visual effect
 
-### Concepts
+### Etro concepts
 
 #### Pub/sub system
 

package/README.md

@@ -7,7 +7,7 @@
 
 ![Screenshot](screenshots/2019-08-17_0.png)
 
-Etro is a completely in-browser video-editing library. Similar to conventional video-editing software, it lets you layer media and other content on a timeline. Audio, image, video and other tracks are supported, along with powerful video and audio manipulation to existing tracks. Being very flexible and extendable, you can choose to only use the core components or define your own.
+Etro is a completely in-browser video-editing framework. Similar to GUI-based video-editing software, it lets you layer media and other content on a timeline. Audio, image, video and other tracks are supported, along with powerful video and audio manipulation to existing tracks. Being very flexible and extendable, you can choose to only use the core components or define your own.
 
 ## Features
 
@@ -18,35 +18,43 @@ Etro is a completely in-browser video-editing library. Similar to conventional v
 - Built-in hardware accelerated visual effects
 - More coming soon
 
+## Installation
+
+```
+npm install etro
+```
+
 ## Usage
 
+You can use CommonJS syntax:
+```js
+import etro from 'etro'
+```
+
+Or include it as a global `etro`:
 ```html
-<script src="https://unpkg.com/etro@latest/dist/etro.js"></script>
+<script src="node_modules/etro/dist/etro-iife.js"></script>
 ```
 
-Then, to create a movie (which is a project)
+Then, to create a movie (a Etro "project")
 ```js
-const movie = new etro.Movie(canvas);
+var movie = new etro.Movie(canvas);
 ```
 
 Then, add layers
 ```js
 movie
-  // add an empty blue layer starting at 0s and lasting 3s and filling the entire screen
-  .addLayer(new etro.layer.Base(0, 3, {background: 'blue'}))
+  // add a solid blue layer starting at 0s and lasting 3s and filling the entire screen
+  .addLayer(new etro.layer.Visual(0, 3, {background: 'blue'}))
   // add a cropped video layer starting at 2.5s
   .addLayer(new etro.layer.Video(2.5, video, {mediaX: 10, mediaY: -25}));
 ```
 
-To start the movie, just like any ol' `<video>` or `<audio>`, use `.play()`
+Finally, start the movie
 ```js
 movie.play();
 ```
 
-## License
-
-Distributed under GNU General Public License v3. See `LICENSE` for more information.
-
 ## Further Reading
 
 - [Documentation](https://etrojs.dev)
@@ -55,3 +63,7 @@ Distributed under GNU General Public License v3. See `LICENSE` for more informat
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md)
+
+## License
+
+Distributed under GNU General Public License v3. See `LICENSE` for more information.