Robust/src/Benchmarks/SSJava/EyeTracking/ICaptureDevice.java

   1 /*\r
   2  * Copyright 2009 (c) Florian Frankenberger (darkblue.de)\r
   3  * \r
   4  * This file is part of LEA.\r
   5  * \r
   6  * LEA is free software: you can redistribute it and/or modify it under the\r
   7  * terms of the GNU Lesser General Public License as published by the Free\r
   8  * Software Foundation, either version 3 of the License, or (at your option) any\r
   9  * later version.\r
  10  * \r
  11  * LEA is distributed in the hope that it will be useful, but WITHOUT ANY\r
  12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR\r
  13  * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more\r
  14  * details.\r
  15  * \r
  16  * You should have received a copy of the GNU Lesser General Public License\r
  17  * along with LEA. If not, see <http://www.gnu.org/licenses/>.\r
  18  */\r
  19 \r
  20 \r
  21 import java.awt.image.BufferedImage;\r
  22 \r
  23 /**\r
  24  * Describes a capture device. For now it is only tested\r
  25  * with images in <code>640x480</code> at <code>RGB</code> or <code>YUV</code> color space.\r
  26  * \r
  27  * @author Florian Frankenberger\r
  28  */\r
  29 public interface ICaptureDevice {\r
  30 \r
  31         /**\r
  32          * Returns the frame rate of the image source per second\r
  33          * \r
  34          * @return the frame rate (e.g. 15 = 15 frames per second)\r
  35          */\r
  36         public int getFrameRate();\r
  37 \r
  38         /**\r
  39          * Will be called a maximum of getFrameRate()-times in a second and returns\r
  40          * the actual image of the capture device\r
  41          *  \r
  42          * @return the actual image of the capture device \r
  43          */\r
  44         public BufferedImage getImage();\r
  45         \r
  46         /**\r
  47          * LEA calls this when it cleans up. You should put your own cleanup code in here.\r
  48          */\r
  49         public void close();\r
  50         \r
  51         \r
  52 }\r