juce/source/src/gui/graphics/imaging/juce_CameraDevice.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_CAMERADEVICE_JUCEHEADER__
  27 #define __JUCE_CAMERADEVICE_JUCEHEADER__
  28
  29 #if JUCE_USE_CAMERA || DOXYGEN
  30
  31
  32 //==============================================================================
  33 /**
  34     Controls any video capture devices that might be available.
  35
  36     Use getAvailableDevices() to list the devices that are attached to the
  37     system, then call openDevice to open one for use. Once you have a CameraDevice
  38     object, you can get a viewer component from it, and use its methods to
  39     stream to a file or capture still-frames.
  40 */
  41 class JUCE_API  CameraDevice
  42 {
  43 public:
  44     /** Destructor. */
  45     virtual ~CameraDevice();
  46
  47     //==============================================================================
  48     /** Returns a list of the available cameras on this machine.
  49
  50         You can open one of these devices by calling openDevice().
  51     */
  52     static StringArray getAvailableDevices();
  53
  54     /** Opens a camera device.
  55
  56         The index parameter indicates which of the items returned by getAvailableDevices()
  57         to open.
  58
  59         The size constraints allow the method to choose between different resolutions if
  60         the camera supports this. If the resolution cam't be specified (e.g. on the Mac)
  61         then these will be ignored.
  62     */
  63     static CameraDevice* openDevice (int deviceIndex,
  64                                      int minWidth = 128, int minHeight = 64,
  65                                      int maxWidth = 1024, int maxHeight = 768);
  66
  67     //==============================================================================
  68     /** Returns the name of this device */
  69     String getName() const                { return name; }
  70
  71     /** Creates a component that can be used to display a preview of the
  72         video from this camera.
  73     */
  74     Component* createViewerComponent();
  75
  76     //==============================================================================
  77     /** Starts recording video to the specified file.
  78
  79         You should use getFileExtension() to find out the correct extension to
  80         use for your filename.
  81
  82         If the file exists, it will be deleted before the recording starts.
  83
  84         This method may not start recording instantly, so if you need to know the
  85         exact time at which the file begins, you can call getTimeOfFirstRecordedFrame()
  86         after the recording has finished.
  87
  88         The quality parameter can be 0, 1, or 2, to indicate low, medium, or high. It may
  89         or may not be used, depending on the driver.
  90     */
  91     void startRecordingToFile (const File& file, int quality = 2);
  92
  93     /** Stops recording, after a call to startRecordingToFile().
  94     */
  95     void stopRecording();
  96
  97     /** Returns the file extension that should be used for the files
  98         that you pass to startRecordingToFile().
  99
 100         This may be platform-specific, e.g. ".mov" or ".avi".
 101     */
 102     static String getFileExtension();
 103
 104     /** After calling stopRecording(), this method can be called to return the timestamp
 105         of the first frame that was written to the file.
 106     */
 107     Time getTimeOfFirstRecordedFrame() const;
 108
 109     //==============================================================================
 110     /**
 111         Receives callbacks with images from a CameraDevice.
 112
 113         @see CameraDevice::addListener
 114     */
 115     class JUCE_API  Listener
 116     {
 117     public:
 118         Listener() {}
 119         virtual ~Listener() {}
 120
 121         /** This method is called when a new image arrives.
 122
 123             This may be called by any thread, so be careful about thread-safety,
 124             and make sure that you process the data as quickly as possible to
 125             avoid glitching!
 126         */
 127         virtual void imageReceived (const Image& image) = 0;
 128     };
 129
 130     /** Adds a listener to receive images from the camera.
 131
 132         Be very careful not to delete the listener without first removing it by calling
 133         removeListener().
 134     */
 135     void addListener (Listener* listenerToAdd);
 136
 137     /** Removes a listener that was previously added with addListener().
 138     */
 139     void removeListener (Listener* listenerToRemove);
 140
 141
 142 protected:
 143    #ifndef DOXYGEN
 144     CameraDevice (const String& name, int index);
 145    #endif
 146
 147 private:
 148     void* internal;
 149     bool isRecording;
 150     String name;
 151
 152     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (CameraDevice);
 153 };
 154
 155 /** This typedef is just for compatibility with old code - newer code should use the CameraDevice::Listener class directly. */
 156 typedef CameraDevice::Listener CameraImageListener;
 157
 158
 159 #endif
 160 #endif   // __JUCE_CAMERADEVICE_JUCEHEADER__