Coin: SoVRMLAudioClip.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoVRMLAudioClip.h
1/**************************************************************************\
2 * Copyright (c) Kongsberg Oil & Gas Technologies AS
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31\**************************************************************************/
32
33#ifndef COIN_SOVRMLAUDIOCLIP_H
34#define COIN_SOVRMLAUDIOCLIP_H
35
36#include <Inventor/nodes/SoSubNode.h>
37#include <Inventor/nodes/SoNode.h>
38#include <Inventor/fields/SoSFString.h>
39#include <Inventor/fields/SoMFString.h>
40#include <Inventor/fields/SoSFBool.h>
41#include <Inventor/fields/SoSFFloat.h>
42#include <Inventor/fields/SoSFTime.h>
43#include <Inventor/lists/SbStringList.h>
44#include <Inventor/SbTime.h>
45
46class SoVRMLAudioClipP;
47
48 class COIN_DLL_API SoVRMLAudioClip : public SoNode
49{
50 typedef SoNode inherited;
51 SO_NODE_HEADER(SoVRMLAudioClip);
52
53public:
54 typedef void *open_func(const SbStringList &url,
55 SoVRMLAudioClip *clip, void *userdataptr);
56 typedef size_t read_func(void *datasource,
57 void *buffer, int numframes, int &channels,
58 SoVRMLAudioClip *clip, void *userdataptr);
59 typedef int seek_func(void *datasource, long offset, int whence,
60 SoVRMLAudioClip *clip, void *userdataptr);
61 typedef long tell_func(void *datasource,
62 SoVRMLAudioClip *clip, void *userdataptr);
63 typedef int close_func(void *datasource,
64 SoVRMLAudioClip *clip, void *userdataptr);
65
66 static void initClass(void);
67 SoVRMLAudioClip(void);
68
69 SoSFString description;
70 SoSFBool loop;
71 SoSFFloat pitch;
72 SoSFTime startTime;
73 SoSFTime stopTime;
74 SoMFString url;
75
76 static void setSubdirectories(const SbList<SbString> &subdirectories);
77 static const SbStringList & getSubdirectories();
78 static void setDefaultPauseBetweenTracks(SbTime pause);
79 static SbTime getDefaultPauseBetweenTracks();
80 static void setDefaultIntroPause(SbTime pause);
81 static SbTime getDefaultIntroPause();
82 static void setDefaultSampleRate(int samplerate);
83 static int getDefaultSampleRate();
84 static void setDefaultTimerInterval(SbTime interval);
85 static SbTime getDefaultTimerInterval();
86
87 int getSampleRate();
88
89 void * open(const SbStringList &url);
90 size_t read(void *datasource, void *buffer, int numframes, int &channels);
91 int seek(void *datasource, long offset, int whence);
92 long tell(void *datasource);
93 int close(void *datasource);
94
95 void setCallbacks(open_func *opencb, read_func *readcb, seek_func *seekcb,
96 tell_func *tellcb, close_func *closecb, void *userdataptr);
97
98protected:
99 virtual ~SoVRMLAudioClip();
100 SoSFTime duration_changed; // eventOut
101 SoSFBool isActive; // eventOut
102
103private:
104 SoVRMLAudioClipP *pimpl;
105 friend class SoVRMLAudioClipP;
106};
107
108#endif // ! COIN_SOVRMLAUDIOCLIP_H
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SbStringList
The SbStringList class is a container for pointers to SbString objects.
Definition SbStringList.h:40
SbTime
The SbTime class instances represents time values.
Definition SbTime.h:50
SoBase::read
static SbBool read(SoInput *input, SoBase *&base, SoType expectedtype)
Definition SoBase.cpp:1053
SoMFString
The SoMFString class is a container for SbString values.
Definition SoMFString.h:40
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoSFBool
The SoSFBool class is a container for an SbBool value.
Definition SoSFBool.h:39
SoSFFloat
The SoSFFloat class is a container for a floating point value.
Definition SoSFFloat.h:39
SoSFString
The SoSFString class is a container for an SbString.
Definition SoSFString.h:40
SoSFTime
The SoSFTime class is a container for an SbTime value.
Definition SoSFTime.h:40
SoVRMLAudioClip
The SoVRMLAudioClip class is used to load and store audio data.
Definition SoVRMLAudioClip.h:49
SoVRMLAudioClip::url
SoMFString url
Definition SoVRMLAudioClip.h:74
SoVRMLAudioClip::loop
SoSFBool loop
Definition SoVRMLAudioClip.h:70
SoVRMLAudioClip::duration_changed
SoSFTime duration_changed
Definition SoVRMLAudioClip.h:100
SoVRMLAudioClip::pitch
SoSFFloat pitch
Definition SoVRMLAudioClip.h:71
SoVRMLAudioClip::isActive
SoSFBool isActive
Definition SoVRMLAudioClip.h:101
SoVRMLAudioClip::description
SoSFString description
Definition SoVRMLAudioClip.h:69
SoVRMLAudioClip::stopTime
SoSFTime stopTime
Definition SoVRMLAudioClip.h:73
SoVRMLAudioClip::startTime
SoSFTime startTime
Definition SoVRMLAudioClip.h:72