File: filestream.h

package info (click to toggle)
openalpp-cvs 20041206-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,796 kB
  • ctags: 549
  • sloc: cpp: 3,891; makefile: 154; ansic: 56; sh: 5
file content (72 lines) | stat: -rw-r--r-- 2,170 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/**
 * OpenAL++ - an object oriented toolkit for spatial sound
 * Copyright (C) 2002 VRlab, Ume University
 *
 * OpenAL++ was created using the libraries:
 *                 OpenAL (http://www.openal.org), 
 *              PortAudio (http://www.portaudio.com/), and
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */

#ifndef FILESTREAM_H_INCLUDED
#define FILESTREAM_H_INCLUDED

#include "openalpp/stream.h"
#include "openalpp/export.h"

namespace openalpp {

/**
 * Class for streaming audio data from a file. Presently it supports Ogg
 * Vorbis files (http://www.vorbis.com/).
 */
class OPENALPP_API  FileStream : public Stream {
 public:
  /**
   * Constructor. A FileError will be thrown if the file can't be opened or
   * isn't recognized.
   * @param filename is the name of the file to try to open.
   * @param buffersize is an optional parameter specifying how large the
   * buffer should be (in samples per second).
   */
   FileStream(const std::string& filename,const int buffersize=65536) 
    throw (NameError,InitError,FileError);

  /**
   * Copy constructor.
   */
  FileStream(const FileStream &stream);


  FileStream &operator=(const FileStream &stream);

  /**
   * Turn on/off looping.
   * @param loop is true if the stream should loop, false otherwise.
   */
  void setLooping(bool loop = true);
protected:
    /**
   * Destructor.
   */
  virtual ~FileStream();

};


}

#endif