3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_NULLDevice.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * Audaspace is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/intern/AUD_NULLDevice.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_NULLDEVICE
33 #define AUD_NULLDEVICE
34
35 #include "AUD_IReader.h"
36 #include "AUD_IDevice.h"
37 #include "AUD_IHandle.h"
38
39 /**
40  * This device plays nothing.
41  */
42 class AUD_NULLDevice : public AUD_IDevice
43 {
44 private:
45         class AUD_NULLHandle : public AUD_IHandle
46         {
47         public:
48
49                 AUD_NULLHandle();
50
51                 virtual ~AUD_NULLHandle() {}
52                 virtual bool pause();
53                 virtual bool resume();
54                 virtual bool stop();
55                 virtual bool getKeep();
56                 virtual bool setKeep(bool keep);
57                 virtual bool seek(float position);
58                 virtual float getPosition();
59                 virtual AUD_Status getStatus();
60                 virtual float getVolume();
61                 virtual bool setVolume(float volume);
62                 virtual float getPitch();
63                 virtual bool setPitch(float pitch);
64                 virtual int getLoopCount();
65                 virtual bool setLoopCount(int count);
66                 virtual bool setStopCallback(stopCallback callback = 0, void* data = 0);
67         };
68 public:
69         /**
70          * Creates a new NULL device.
71          */
72         AUD_NULLDevice();
73
74         virtual ~AUD_NULLDevice();
75
76         virtual AUD_DeviceSpecs getSpecs() const;
77         virtual AUD_Reference<AUD_IHandle> play(AUD_Reference<AUD_IReader> reader, bool keep = false);
78         virtual AUD_Reference<AUD_IHandle> play(AUD_Reference<AUD_IFactory> factory, bool keep = false);
79         virtual void lock();
80         virtual void unlock();
81         virtual float getVolume() const;
82         virtual void setVolume(float volume);
83 };
84
85 #endif //AUD_NULLDEVICE