Mercurial > octave
view scripts/image/movie.m @ 30564:796f54d4ddbf stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
In all .txi and .texi files except gpl.txi and gpl.texi in the
doc/liboctave and doc/interpreter directories, change the copyright
to "Octave Project Developers", the same as used for other source
files. Update copyright notices for 2022 (not done since 2019). For
gpl.txi and gpl.texi, change the copyright notice to be "Free Software
Foundation, Inc." and leave the date at 2007 only because this file
only contains the text of the GPL, not anything created by the Octave
Project Developers.
Add Paul Thomas to contributors.in.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 28 Dec 2021 18:22:40 -0500 |
parents | 7854d5752dd2 |
children | 10a813492497 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2017-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave 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. ## ## Octave 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 Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} movie (@var{mov}) ## @deftypefnx {} {} movie (@var{mov}, @var{n}) ## @deftypefnx {} {} movie (@var{mov}, @var{n}, @var{fps}) ## @deftypefnx {} {} movie (@var{h}, @dots{}) ## Play a movie defined by an array of frame structures. ## ## The movie @var{mov} must be a struct array of frames with fields ## @qcode{"cdata"} and @qcode{"colormap"}, as returned by the @code{getframe} ## function. By default all images are displayed once, at 12 fps, in the ## current axes. ## ## The optional argument @var{n} is a scalar or vector of integers that ## controls the number of times the movie is displayed and which particular ## frames are shown: ## ## @table @asis ## @item First element: ## ## @table @asis ## @item @var{n}(1) > 0 ## Play the movie @var{n}(1) times. ## ## @item @var{n}(1) < 0 ## Play the movie @code{abs (@var{n}(1)} times alternatively in forward and ## backward order. ## @end table ## ## @item Other elements (if any): ## Indices of the frames in @var{mov} that will be displayed. ## @end table ## ## If the first argument is a handle to a figure or axes @var{h}, the movie is ## played in that figure or axes instead of the current axes. ## ## @seealso{getframe, im2frame, frame2im} ## @end deftypefn function movie (varargin) if (nargin == 0 || nargin > 4) print_usage (); endif ## Extract possible handle argument hax = []; if (ishghandle (varargin{1})) typ = get (varargin{1}, "type"); if (strcmp (typ, "axes")) hax = varargin{1}; elseif (strcmp (typ, "figure")) hax = get (varargin{1}, "currentaxes"); if (isempty (hax)) hax = axes ("parent", varargin{1}); endif else error ("movie: H must be a handle to an axes or figure"); endif varargin(1) = []; nargin = nargin - 1; if (nargin == 0) print_usage (); endif endif ## Extract other arguments n = 1; fps = 12; idx = []; mov = varargin{1}; if (! isfield (mov, "cdata") || ! isfield (mov, "colormap")) error ("movie: MOV must be a frame struct array"); elseif (numel (mov) < 2) error ("movie: MOV must contain at least two frames"); endif if (nargin > 1) n = varargin{2}; if (! isindex (abs (n(1)))) error ("movie: N must be a non-zero integer"); endif if (! isscalar (n)) idx = n(2:end)(:)'; n = n(1); if (! isindex (idx, numel (mov))) error (["movie: All elements N(2:end) must be valid indices ", ... "into the MOV struct array"]); endif endif if (nargin > 2) fps = varargin{3}; if (! (isnumeric (fps) && isscalar (fps) && fps > 0)) error ("movie: FPS must be a numeric scalar > 0"); endif endif endif if (isempty (hax)) hax = gca (); endif ## Build the list of frames to be displayed if (isempty (idx)) idx = (1:numel (mov)); endif if (n > 0) idx = repmat (idx, 1, n); else n = -n; tmp = repmat ([idx fliplr(idx)], 1, fix (n/2)); if (fix (n/2) != n/2) idx = [tmp, idx]; else idx = tmp; endif endif ## Initialize graphics objects if (isempty (mov(1).cdata)) error ("movie: empty image data at frame 1"); endif him = findobj (hax, "-depth", 1, "tag", "__movie_frame__"); if (isempty (him)) him = image ("parent", hax, "cdata", mov(1).cdata, "tag", "__movie_frame__"); else set (him, "cdata", mov(1).cdata); endif set (hax, "ydir", "reverse", "visible", "off"); ## Initialize the timer t = tau = 1/fps; timerid = tic (); for ii = idx cdata = mov(ii).cdata; if (isempty (cdata)) error ("movie: empty image data at frame %d", ii); endif set (him, "cdata", cdata); if (! isempty (mov(ii).colormap)) set (hax, "colormap", mov(ii).colormap) endif pause (t - toc (timerid)); t += tau; endfor endfunction %!demo %! nframes = 20; %! colors = jet (nframes); %! baseim = ones (20, 20, 3, "uint8"); %! mov(nframes) = struct ("cdata", [], "colormap", []); %! for ii = 1:nframes %! im = baseim * 255; %! im(:,ii,1) = colors(ii,1) * 255; %! im(:,ii,2) = colors(ii,2) * 255; %! im(:,ii,3) = colors(ii,3) * 255; %! mov(ii).cdata = im; %! endfor %! clf (); %! title ("Play movie forward 2 times"); %! movie (mov, 2); %!demo %! nframes = 20; %! colors = jet (nframes); %! baseim = ones (20, 20, 3, "uint8"); %! mov(nframes) = struct ("cdata", [], "colormap", []); %! for ii = 1:nframes %! im = baseim * 255; %! im(:,ii,1) = colors(ii,1) * 255; %! im(:,ii,2) = colors(ii,2) * 255; %! im(:,ii,3) = colors(ii,3) * 255; %! mov(ii).cdata = im; %! endfor %! clf (); %! title ("Play movie forward and backward 5 times at 25 fps"); %! movie (mov, -5, 25); %!demo %! nframes = 20; %! colors = jet (nframes); %! baseim = ones (20, 20, 3, "uint8"); %! mov(nframes) = struct ("cdata", [], "colormap", []); %! for ii = 1:nframes %! im = baseim * 255; %! im(:,ii,1) = colors(ii,1) * 255; %! im(:,ii,2) = colors(ii,2) * 255; %! im(:,ii,3) = colors(ii,3) * 255; %! mov(ii).cdata = im; %! endfor %! clf (); %! title ("Play downsampled movie 5 times"); %! movie (mov, [5 1:3:nframes]); %!demo %! clf (); %! z = sombrero (); %! hs = surf (z); %! axis manual %! nframes = 50; %! mov(nframes) = struct ("cdata", [], "colormap", []); %! for ii = 1:nframes %! set (hs, "zdata", z * sin (2*pi*ii/nframes)); %! mov(ii) = getframe (); %! endfor %! clf (); %! movie (mov, 3, 25); ## Test input validation %!error <Invalid call> movie () %!error <Invalid call> movie (1,2,3,4,5) %!error <MOV must be a frame struct array> movie ({2}) %!error <MOV must contain at least two frames> %! movie (struct ("cdata", [], "colormap", [])); %!error <N must be a non-zero integer> %! movie (struct ("cdata", {[], []}, "colormap", []), 2.3); %!error <N must be a non-zero integer> %! movie (struct ("cdata", {[], []}, "colormap", []), [2.3 -6]); %!error <All elements N\(2:end\) must be valid indices into the MOV struct> %! movie (struct ("cdata", {[], []}, "colormap", []), [1 -1]); %!error <All elements N\(2:end\) must be valid indices into the MOV struct> %! movie (struct ("cdata", {[], []}, "colormap", []), [1 5]); %!error <FPS must be a numeric scalar . 0> %! movie (struct ("cdata", {[], []}, "colormap", []), 1, "a"); %!error <FPS must be a numeric scalar . 0> %! movie (struct ("cdata", {[], []}, "colormap", []), 1, [1 1]); %!error <FPS must be a numeric scalar . 0> %! movie (struct ("cdata", {[], []}, "colormap", []), 1, -1/12); %!error <empty image data at frame 1> %! hf = figure ("visible", "off"); %! unwind_protect %! movie (hf, struct ("cdata", {[], []}, "colormap", [])); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!error <empty image data at frame 2> %! hf = figure ("visible", "off"); %! unwind_protect %! movie (struct ("cdata", {ones(2), []}, "colormap", [])); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect