HelpSource/Classes/MovieView.schelp

   1 CLASS:: MovieView
   2 redirect:: implClass
   3 summary:: A view responding to Wacom tablet
   4 categories:: GUI>Views
   5 related:: Classes/Image
   6
   7 DESCRIPTION::
   8
   9 MovieView can play movies such as .mov and mpg, and image files like jpg, png, tiff and others.
  10
  11 note:: Not available in strong::Qt GUI:: ::
  12
  13 note:: strong:: prerequisits in SwingOSC ::
  14
  15 JSCMovieView is currently based on the Java Media Framework (JMF) which is not part of the standard java environment (Java SE) but needs to be installed separately. There is a reference implementation from Sun available for Linux, Windows and Mac OS X. It can be downloaded from http://java.sun.com/products/java-media/jmf/index.jsp (note: for Mac OS X you need the generic cross-platform version).
  16
  17 The reference implementation has rather poor media support (check this page: http://java.sun.com/products/java-media/jmf/2.1.1/formats.html ), so you might need to convert your movies or look out for extra JMF plug-ins. A really good plug-in is fobs4j !(ffpmeg objects for java) -> http://fobs.sourceforge.net/ !
  18 You need to install the "jmf.jar" file in your system's java extensions folder, e.g. on Mac OS X that's "/Library/Java/Extensions". For fobs, do the same with "fobs4jmf.jar" and copy "jmf.properties" into "SwingOSC/build".
  19
  20 (in the future, FMJ (freedom for media in java) might be an alternative: http://fmj-sf.net)
  21 ::
  22
  23 CLASSMETHODS::
  24 PRIVATE:: key
  25
  26
  27 INSTANCEMETHODS::
  28
  29 METHOD:: path
  30     The path to the movie.
  31
  32 SUBSECTION:: Movie Control
  33
  34 METHOD:: start
  35 METHOD:: stop
  36 METHOD:: stepForward
  37 METHOD:: stepBack
  38 METHOD:: gotoEnd
  39 METHOD:: gotoBeginning
  40
  41 METHOD:: frame
  42     Go to frame.
  43
  44     argument::
  45         The frame index; an Integer.
  46
  47 METHOD:: playSelectionOnly
  48
  49     argument::
  50         A Boolean.
  51
  52 METHOD:: skipFrames
  53
  54     argument::
  55         An Integer.
  56
  57 METHOD:: muted
  58
  59     argument::
  60         A Boolean.
  61
  62 METHOD:: loopMode
  63
  64     Possible loop modes:
  65     list::
  66     ## 0 - Playback runs forward and backward between both endpoints.
  67     ## 1 - Restarts playback at beginning when end is reached.
  68     ## 2 - Playback stops when end is reached.
  69     ::
  70
  71     argument::
  72         One of the above Integers.
  73
  74 METHOD:: rate
  75
  76     argument::
  77         An instance of Float. 1.0 is the normal rate.
  78
  79
  80 SUBSECTION:: Movie Editing
  81
  82 METHOD:: copy
  83 METHOD:: clear
  84 METHOD:: cut
  85 METHOD:: paste
  86
  87 METHOD:: editable
  88     argument::
  89         A Boolean.
  90
  91 METHOD:: currentTime
  92     The current time.
  93     argument::
  94         Defaults to code::nil::.
  95
  96
  97 SUBSECTION:: Appearance
  98
  99 METHOD:: showControllerAndAdjustSize
 100
 101     argument:: show
 102         A Boolean. Default is code::true::.
 103     argument:: adjust
 104         A Boolean. Default is code::true::.
 105
 106 METHOD:: resizeWithMagnification
 107     Resizes the whole view, adjusts its contents.
 108
 109     argument:: size
 110         A Float.
 111
 112 METHOD:: fixedAspectRatio
 113     argument::
 114         A Boolean.
 115
 116
 117 EXAMPLES::
 118
 119 code::
 120 (
 121 w = Window("mov").front;
 122 b = Button(w, Rect(0, 0, 150, 20))
 123     .states_([["pick a file"]])
 124     .action_({ File.openDialog("", { |path| m.path_(path) }) });
 125 m = MovieView(w, Rect(0,20,360, 260));
 126 )
 127     // random-pick a tiff from the Help folder
 128 m.path_("Help/*/*/*.tiff".pathMatch.choose);
 129
 130     // or point it to a movie (you may have that one too):
 131 m.path_("/Library/Application\ Support/iDVD/Tutorial/Movies/Our\ First\ Snowman.mov");
 132
 133
 134 m.start;            // playback
 135 m.muted_(false);    // thank god
 136 m.stop;
 137
 138     //rate
 139 m.rate_(1);
 140     // backwards
 141 m.gotoEnd.rate_(-1).start;
 142
 143     // select a range on the controller and play it
 144 m.rate_(1).playSelectionOnly_(true).start;
 145
 146     // loopModes:
 147 m.loopMode_(1); // only one direction
 148 m.loopMode_(0).start;   // back and forth
 149
 150
 151
 152 m.stop;
 153 m.gotoBeginning;
 154
 155     // single steps
 156 m.stepForward;
 157
 158 10.do { m.stepForward; };
 159 m.stepBack;
 160
 161     // select with shift-drag, copy paste between movieviews or quicktime player
 162 m.editable_(true);
 163
 164
 165 m.showControllerAndAdjustSize(true, true);
 166     // resize compared to image size:
 167 m.resizeWithMagnification(0.25);
 168
 169     //goto time (in seconds)
 170 m.currentTime_(1);
 171
 172     // not there yet, but would be nice to have:
 173     // startFrame, length
 174 m.setSelection_(20, 15);
 175
 176
 177 m.frame_(frame);    // jump to frame
 178 m.frame.postln; // poll current frame pos
 179 ::