AudioGrabber.H

Go to the documentation of this file.
00001 /*!@file Devices/AudioGrabber.H Grab audio samples from /dev/dsp */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 by the //
00005 // University of Southern California (USC) and the iLab at USC.         //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Laurent Itti <itti@usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Devices/AudioGrabber.H $
00035 // $Id: AudioGrabber.H 14682 2011-04-05 01:11:05Z farhan $
00036 //
00037 
00038 #ifndef AUDIOGRABBER_H_DEFINED
00039 #define AUDIOGRABBER_H_DEFINED
00040 
00041 #include "Component/ModelComponent.H"
00042 #include "Component/ModelParam.H"
00043 #include "Util/Types.H"
00044 #include "Audio/AudioBuffer.H"
00045 
00046 //! Class to grab audio samples from an audio device
00047 /*! For now, grabbing is done using a blocking read() onto the DSP device.*/
00048 
00049 class AudioGrabber : public ModelComponent
00050 {
00051 public:
00052   //! Constructor
00053   AudioGrabber(OptionManager& mgr,
00054                const std::string& descrName = "Audio Grabber Driver",
00055                const std::string& tagName = "AudioGrabber");
00056 
00057   //! Destructor
00058   ~AudioGrabber();
00059 
00060   //! Grab a buffer
00061   /* A fatal error will arise if T has a different number of bits than
00062      itsBits. Typically, T should be byte, int16, etc. If buf was not
00063      empty its contents will be destroyed. */
00064   template <class T>
00065   void grab(AudioBuffer<T>& buf) const;
00066 
00067 protected:
00068   OModelParam<std::string> itsDevName;    //!< audio device name
00069   OModelParam<uint>        itsBits;       //!< bits per sample (8 or 16)
00070   OModelParam<uint>        itsFreq;       //!< sampling frequency (Hz)
00071   OModelParam<uint>        itsBufsamples; //!< samples per buffer
00072   OModelParam<uint>        itsChans;     //!<  number of channels 
00073   OModelParam<bool>        itsInterleaved; //!< channel data interleaved?
00074 
00075   //! get started (see ModelComponent.H)
00076   void start2();
00077 
00078   //! get stopped (see ModelComponent.H)
00079   void stop1();
00080 
00081 private:
00082   int itsFd;                               // file descriptor for device
00083 };
00084 
00085 // ######################################################################
00086 /* So things look consistent in everyone's emacs... */
00087 /* Local Variables: */
00088 /* indent-tabs-mode: nil */
00089 /* End: */
00090 
00091 #endif
Generated on Sun May 8 08:04:44 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3