mirror of
https://github.com/psychopy/psychojs.git
synced 2025-05-10 10:40:54 +00:00
497 lines
15 KiB
HTML
497 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: visual/MovieStim.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: visual/MovieStim.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Movie Stimulus.
|
|
*
|
|
* @author Alain Pitiot
|
|
* @version 2020.2
|
|
* @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020 Open Science Tools Ltd. (https://opensciencetools.org)
|
|
* @license Distributed under the terms of the MIT License
|
|
*/
|
|
|
|
|
|
import {VisualStim} from './VisualStim';
|
|
import {Color} from '../util/Color';
|
|
import {ColorMixin} from '../util/ColorMixin';
|
|
import * as util from '../util/Util';
|
|
import {PsychoJS} from "../core/PsychoJS";
|
|
|
|
|
|
/**
|
|
* Movie Stimulus.
|
|
*
|
|
* @name module:visual.MovieStim
|
|
* @class
|
|
* @extends VisualStim
|
|
* @param {Object} options
|
|
* @param {String} options.name - the name used when logging messages from this stimulus
|
|
* @param {module:core.Window} options.win - the associated Window
|
|
* @param {string | HTMLVideoElement} options.movie - the name of the movie resource or the HTMLVideoElement corresponding to the movie
|
|
* @param {string} [options.units= "norm"] - the units of the stimulus (e.g. for size, position, vertices)
|
|
* @param {Array.<number>} [options.pos= [0, 0]] - the position of the center of the stimulus
|
|
* @param {string} [options.units= 'norm'] - the units of the stimulus vertices, size and position
|
|
* @param {number} [options.ori= 0.0] - the orientation (in degrees)
|
|
* @param {number} [options.size] - the size of the rendered image (the size of the image will be used if size is not specified)
|
|
* @param {Color} [options.color= Color('white')] the background color
|
|
* @param {number} [options.opacity= 1.0] - the opacity
|
|
* @param {number} [options.contrast= 1.0] - the contrast
|
|
* @param {boolean} [options.interpolate= false] - whether or not the image is interpolated
|
|
* @param {boolean} [options.flipHoriz= false] - whether or not to flip horizontally
|
|
* @param {boolean} [options.flipVert= false] - whether or not to flip vertically
|
|
* @param {boolean} [options.loop= false] - whether or not to loop the movie
|
|
* @param {number} [options.volume= 1.0] - the volume of the audio track (must be between 0.0 and 1.0)
|
|
* @param {boolean} [options.noAudio= false] - whether or not to play the audio
|
|
* @param {boolean} [options.autoPlay= true] - whether or not to autoplay the video
|
|
* @param {boolean} [options.autoDraw= false] - whether or not the stimulus should be automatically drawn on every frame flip
|
|
* @param {boolean} [options.autoLog= false] - whether or not to log
|
|
*
|
|
* @todo autoPlay does not work for the moment.
|
|
*/
|
|
export class MovieStim extends VisualStim
|
|
{
|
|
constructor({name, win, movie, pos, units, ori, size, color, opacity, contrast, interpolate, flipHoriz, flipVert, loop, volume, noAudio, autoPlay, autoDraw, autoLog} = {})
|
|
{
|
|
super({name, win, units, ori, opacity, pos, size, autoDraw, autoLog});
|
|
|
|
this.psychoJS.logger.debug('create a new MovieStim with name: ', name);
|
|
|
|
// movie and movie control:
|
|
this._addAttribute(
|
|
'movie',
|
|
movie
|
|
);
|
|
this._addAttribute(
|
|
'volume',
|
|
volume,
|
|
1.0,
|
|
this._onChange(false, false)
|
|
);
|
|
this._addAttribute(
|
|
'noAudio',
|
|
noAudio,
|
|
false,
|
|
this._onChange(false, false)
|
|
);
|
|
this._addAttribute(
|
|
'autoPlay',
|
|
autoPlay,
|
|
true,
|
|
this._onChange(false, false)
|
|
);
|
|
|
|
this._addAttribute(
|
|
'flipHoriz',
|
|
flipHoriz,
|
|
false,
|
|
this._onChange(false, false)
|
|
);
|
|
this._addAttribute(
|
|
'flipVert',
|
|
flipVert,
|
|
false,
|
|
this._onChange(false, false)
|
|
);
|
|
this._addAttribute(
|
|
'interpolate',
|
|
interpolate,
|
|
false,
|
|
this._onChange(true, false)
|
|
);
|
|
|
|
// colors:
|
|
this._addAttribute(
|
|
'color',
|
|
color,
|
|
'white',
|
|
this._onChange(true, false)
|
|
);
|
|
this._addAttribute(
|
|
'contrast',
|
|
contrast,
|
|
1.0,
|
|
this._onChange(true, false)
|
|
);
|
|
this._addAttribute(
|
|
'opacity',
|
|
opacity,
|
|
1.0,
|
|
this._onChange(false, false)
|
|
);
|
|
this._addAttribute(
|
|
'loop',
|
|
loop,
|
|
false,
|
|
this._onChange(false, false)
|
|
);
|
|
|
|
|
|
// estimate the bounding box:
|
|
this._estimateBoundingBox();
|
|
|
|
// check whether the fastSeek method on HTMLVideoElement is implemented:
|
|
const videoElement = document.createElement('video');
|
|
this._hasFastSeek = (typeof videoElement.fastSeek === 'function');
|
|
|
|
if (this._autoLog)
|
|
{
|
|
this._psychoJS.experimentLogger.exp(`Created ${this.name} = ${this.toString()}`);
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Setter for the movie attribute.
|
|
*
|
|
* @name module:visual.MovieStim#setMovie
|
|
* @public
|
|
* @param {string | HTMLVideoElement} movie - the name of the movie resource or the HTMLVideoElement corresponding to the movie
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setMovie(movie, log = false)
|
|
{
|
|
const response = {
|
|
origin: 'MovieStim.setMovie',
|
|
context: 'when setting the movie of MovieStim: ' + this._name
|
|
};
|
|
|
|
try
|
|
{
|
|
// movie is undefined: that's fine but we raise a warning in case this is a symptom of an actual problem
|
|
if (typeof movie === 'undefined')
|
|
{
|
|
this.psychoJS.logger.warn('setting the movie of MovieStim: ' + this._name + ' with argument: undefined.');
|
|
this.psychoJS.logger.debug('set the movie of MovieStim: ' + this._name + ' as: undefined');
|
|
}
|
|
else
|
|
{
|
|
// movie is a string: it should be the name of a resource, which we load
|
|
if (typeof movie === 'string')
|
|
{
|
|
movie = this.psychoJS.serverManager.getResource(movie);
|
|
}
|
|
|
|
// movie should now be an actual HTMLVideoElement: we raise an error if it is not
|
|
if (!(movie instanceof HTMLVideoElement))
|
|
{
|
|
throw 'the argument: ' + movie.toString() + ' is not a video" }';
|
|
}
|
|
|
|
this.psychoJS.logger.debug(`set the movie of MovieStim: ${this._name} as: src= ${movie.src}, size= ${movie.videoWidth}x${movie.videoHeight}, duration= ${movie.duration}s`);
|
|
}
|
|
|
|
// Make sure just one listener attached across instances
|
|
// https://stackoverflow.com/questions/11455515
|
|
if (!movie.onended)
|
|
{
|
|
movie.onended = () =>
|
|
{
|
|
this.status = PsychoJS.Status.FINISHED;
|
|
};
|
|
}
|
|
|
|
this._setAttribute('movie', movie, log);
|
|
this._needUpdate = true;
|
|
this._needPixiUpdate = true;
|
|
}
|
|
catch (error)
|
|
{
|
|
throw Object.assign(response, {error});
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Reset the stimulus.
|
|
*
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
reset(log = false)
|
|
{
|
|
this.status = PsychoJS.Status.NOT_STARTED;
|
|
this._movie.pause();
|
|
this.seek(0, log);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Start playing the movie.
|
|
*
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
play(log = false)
|
|
{
|
|
this.status = PsychoJS.Status.STARTED;
|
|
|
|
// As found on https://goo.gl/LdLk22
|
|
const playPromise = this._movie.play();
|
|
|
|
if (playPromise !== undefined)
|
|
{
|
|
playPromise.catch((error) => {
|
|
throw {
|
|
origin: 'MovieStim.play',
|
|
context: `when attempting to play MovieStim: ${this._name}`,
|
|
error
|
|
};
|
|
});
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Pause the movie.
|
|
*
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
pause(log = false)
|
|
{
|
|
this.status = PsychoJS.Status.STOPPED;
|
|
this._movie.pause();
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Stop the movie and reset to 0s.
|
|
*
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
stop(log = false)
|
|
{
|
|
this.status = PsychoJS.Status.STOPPED;
|
|
this._movie.pause();
|
|
this.seek(0, log);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Jump to a specific timepoint
|
|
*
|
|
* <p>Note: seek is experimental and does not work on all browsers at the moment.</p>
|
|
*
|
|
* @param {number} timePoint - the timepoint to which to jump (in second)
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
seek(timePoint, log = false)
|
|
{
|
|
if (timePoint < 0 || timePoint > this._movie.duration)
|
|
{
|
|
throw {
|
|
origin: 'MovieStim.seek',
|
|
context: `when seeking to timepoint: ${timePoint} of MovieStim: ${this._name}`,
|
|
error: `the timepoint does not belong to [0, ${this._movie.duration}`
|
|
};
|
|
}
|
|
|
|
if (this._hasFastSeek)
|
|
{
|
|
this._movie.fastSeek(timePoint);
|
|
}
|
|
else
|
|
{
|
|
try
|
|
{
|
|
this._movie.currentTime = timePoint;
|
|
}
|
|
catch (error)
|
|
{
|
|
throw {
|
|
origin: 'MovieStim.seek',
|
|
context: `when seeking to timepoint: ${timePoint} of MovieStim: ${this._name}`,
|
|
error
|
|
};
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Estimate the bounding box.
|
|
*
|
|
* @name module:visual.ImageStim#_estimateBoundingBox
|
|
* @function
|
|
* @override
|
|
* @protected
|
|
*/
|
|
_estimateBoundingBox()
|
|
{
|
|
const size = this._getDisplaySize();
|
|
if (typeof size !== 'undefined')
|
|
{
|
|
this._boundingBox = new PIXI.Rectangle(
|
|
this._pos[0] - size[0] / 2,
|
|
this._pos[1] - size[1] / 2,
|
|
size[0],
|
|
size[1]
|
|
);
|
|
}
|
|
|
|
// TODO take the orientation into account
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Update the stimulus, if necessary.
|
|
*
|
|
* @name module:visual.MovieStim#_updateIfNeeded
|
|
* @private
|
|
*/
|
|
_updateIfNeeded()
|
|
{
|
|
if (!this._needUpdate)
|
|
{
|
|
return;
|
|
}
|
|
this._needUpdate = false;
|
|
|
|
// update the PIXI representation, if need be:
|
|
if (this._needPixiUpdate)
|
|
{
|
|
this._needPixiUpdate = false;
|
|
|
|
if (typeof this._pixi !== 'undefined')
|
|
{
|
|
// Leave original video in place
|
|
// https://pixijs.download/dev/docs/PIXI.Sprite.html#destroy
|
|
this._pixi.destroy({
|
|
children: true,
|
|
texture: true,
|
|
baseTexture: false
|
|
});
|
|
}
|
|
this._pixi = undefined;
|
|
|
|
// no movie to draw: return immediately
|
|
if (typeof this._movie === 'undefined')
|
|
{
|
|
return;
|
|
}
|
|
|
|
// create a PixiJS video sprite:
|
|
this._texture = PIXI.Texture.from(this._movie, { resourceOptions: { autoPlay: this.autoPlay } });
|
|
this._pixi = new PIXI.Sprite(this._texture);
|
|
|
|
// since _texture.width may not be immedialy available but the rest of the code needs its value
|
|
// we arrange for repeated calls to _updateIfNeeded until we have a width:
|
|
if (this._texture.width === 0)
|
|
{
|
|
this._needUpdate = true;
|
|
this._needPixiUpdate = true;
|
|
return;
|
|
}
|
|
}
|
|
|
|
// audio:
|
|
this._movie.muted = this._noAudio;
|
|
this._movie.volume = this._volume;
|
|
|
|
// loop:
|
|
this._movie.loop = this._loop;
|
|
|
|
// opacity:
|
|
this._pixi.alpha = this.opacity;
|
|
|
|
// set the scale:
|
|
const displaySize = this._getDisplaySize();
|
|
const size_px = util.to_px(displaySize, this.units, this.win);
|
|
const scaleX = size_px[0] / this._texture.width;
|
|
const scaleY = size_px[1] / this._texture.height;
|
|
this._pixi.scale.x = this.flipHoriz ? -scaleX : scaleX;
|
|
this._pixi.scale.y = this.flipVert ? scaleY : -scaleY;
|
|
|
|
// set the position, rotation, and anchor (movie centered on pos):
|
|
this._pixi.position = util.to_pixiPoint(this.pos, this.units, this.win);
|
|
this._pixi.rotation = this.ori * Math.PI / 180;
|
|
this._pixi.anchor.x = 0.5;
|
|
this._pixi.anchor.y = 0.5;
|
|
|
|
// re-estimate the bounding box, as the texture's width may now be available:
|
|
this._estimateBoundingBox();
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Get the size of the display image, which is either that of the ImageStim or that of the image
|
|
* it contains.
|
|
*
|
|
* @name module:visual.ImageStim#_getDisplaySize
|
|
* @private
|
|
* @return {number[]} the size of the displayed image
|
|
*/
|
|
_getDisplaySize()
|
|
{
|
|
let displaySize = this.size;
|
|
|
|
if (typeof displaySize === 'undefined')
|
|
{
|
|
// use the size of the texture, if we have access to it:
|
|
if (typeof this._texture !== 'undefined' && this._texture.width > 0)
|
|
{
|
|
const textureSize = [this._texture.width, this._texture.height];
|
|
displaySize = util.to_unit(textureSize, 'pix', this.win, this.units);
|
|
}
|
|
}
|
|
|
|
return displaySize;
|
|
}
|
|
|
|
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-core.html">core</a></li><li><a href="module-data.html">data</a></li><li><a href="module-sound.html">sound</a></li><li><a href="module-util.html">util</a></li><li><a href="module-visual.html">visual</a></li></ul><h3>Classes</h3><ul><li><a href="module-core.BuilderKeyResponse.html">BuilderKeyResponse</a></li><li><a href="module-core.EventManager.html">EventManager</a></li><li><a href="module-core.GUI.html">GUI</a></li><li><a href="module-core.Keyboard.html">Keyboard</a></li><li><a href="module-core.KeyPress.html">KeyPress</a></li><li><a href="module-core.Logger.html">Logger</a></li><li><a href="module-core.MinimalStim.html">MinimalStim</a></li><li><a href="module-core.Mouse.html">Mouse</a></li><li><a href="module-core.PsychoJS.html">PsychoJS</a></li><li><a href="module-core.ServerManager.html">ServerManager</a></li><li><a href="module-core.Window.html">Window</a></li><li><a href="module-data.ExperimentHandler.html">ExperimentHandler</a></li><li><a href="module-data.TrialHandler.html">TrialHandler</a></li><li><a href="module-sound.Sound.html">Sound</a></li><li><a href="module-sound.TonePlayer.html">TonePlayer</a></li><li><a href="module-sound.TrackPlayer.html">TrackPlayer</a></li><li><a href="module-util.Clock.html">Clock</a></li><li><a href="module-util.Color.html">Color</a></li><li><a href="module-util.CountdownTimer.html">CountdownTimer</a></li><li><a href="module-util.EventEmitter.html">EventEmitter</a></li><li><a href="module-util.MixinBuilder.html">MixinBuilder</a></li><li><a href="module-util.MonotonicClock.html">MonotonicClock</a></li><li><a href="module-util.PsychObject.html">PsychObject</a></li><li><a href="module-util.Scheduler.html">Scheduler</a></li><li><a href="module-visual.Form.html">Form</a></li><li><a href="module-visual.ImageStim.html">ImageStim</a></li><li><a href="module-visual.MovieStim.html">MovieStim</a></li><li><a href="module-visual.Polygon.html">Polygon</a></li><li><a href="module-visual.Rect.html">Rect</a></li><li><a href="module-visual.ShapeStim.html">ShapeStim</a></li><li><a href="module-visual.Slider.html">Slider</a></li><li><a href="module-visual.TextBox.html">TextBox</a></li><li><a href="module-visual.TextStim.html">TextStim</a></li><li><a href="module-visual.VisualStim.html">VisualStim</a></li><li><a href="TextInput.html">TextInput</a></li></ul><h3>Interfaces</h3><ul><li><a href="module-sound.SoundPlayer.html">SoundPlayer</a></li></ul><h3>Mixins</h3><ul><li><a href="module-core.WindowMixin.html">WindowMixin</a></li><li><a href="module-util.ColorMixin.html">ColorMixin</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Feb 20 2021 10:19:19 GMT+0100 (Central European Standard Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|