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