GroovX: src/visx/sound.h Source File

00001 
00003 
00004 //
00005 // Copyright (c) 1999-2004 California Institute of Technology
00006 // Copyright (c) 2004-2007 University of Southern California
00007 // Rob Peters <rjpeters at usc dot edu>
00008 //
00009 // created: Thu Jul  8 11:43:07 1999
00010 // commit: $Id: sound.h 10065 2007-04-12 05:54:56Z rjpeters $
00011 // $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/visx/sound.h $
00012 //
00013 // --------------------------------------------------------------------
00014 //
00015 // This file is part of GroovX.
00016 //   [http://ilab.usc.edu/rjpeters/groovx/]
00017 //
00018 // GroovX is free software; you can redistribute it and/or modify it
00019 // under the terms of the GNU General Public License as published by
00020 // the Free Software Foundation; either version 2 of the License, or
00021 // (at your option) any later version.
00022 //
00023 // GroovX is distributed in the hope that it will be useful, but
00024 // WITHOUT ANY WARRANTY; without even the implied warranty of
00025 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00026 // General Public License for more details.
00027 //
00028 // You should have received a copy of the GNU General Public License
00029 // along with GroovX; if not, write to the Free Software Foundation,
00030 // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
00031 //
00033 
00034 #ifndef GROOVX_VISX_SOUND_H_UTC20050626084016_DEFINED
00035 #define GROOVX_VISX_SOUND_H_UTC20050626084016_DEFINED
00036 
00037 #include "io/io.h"
00038 
00039 #include "rutz/fstring.h"
00040 #include "rutz/shared_ptr.h"
00041 
00042 namespace media
00043 {
00044   class sound_rep;
00045 }
00046 
00047 namespace nub
00048 {
00049   template <class T> class ref;
00050 }
00051 
00053 class Sound : public io::serializable
00054 {
00055 public:
00057 
00058   static Sound* make();
00059 
00061 
00063   static Sound* makeFrom(const char* filename);
00064 
00065   static void setOkSound(nub::ref<Sound> ok_sound);
00066   static void setErrSound(nub::ref<Sound> err_sound);
00067   static nub::ref<Sound> getOkSound();
00068   static nub::ref<Sound> getErrSound();
00069 
00071   Sound(const char* filename = 0);
00072 
00073   virtual ~Sound() throw();
00074 
00075   virtual void read_from(io::reader& reader);
00076   virtual void write_to(io::writer& writer) const;
00077 
00079 
00082   void play();
00083 
00085   void forceLoad();
00086 
00088   void setFile(const char* filename);
00089 
00091   const char* getFile() const;
00092 
00093 private:
00094   rutz::fstring itsFilename;
00095   rutz::shared_ptr<media::sound_rep> itsRep;
00096 };
00097 
00098 static const char __attribute__((used)) vcid_groovx_visx_sound_h_utc20050626084016[] = "$Id: sound.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
00099 #endif // !GROOVX_VISX_SOUND_H_UTC20050626084016_DEFINED