1
0
forked from 0ad/0ad
0ad/source/sound/JSI_Sound.h
janwas c0ed950657 had to remove uint and ulong from lib/types.h due to conflict with other library.
this snowballed into a massive search+destroy of the hodgepodge of
mostly equivalent types we had in use (int, uint, unsigned, unsigned
int, i32, u32, ulong, uintN).

it is more efficient to use 64-bit types in 64-bit mode, so the
preferred default is size_t (for anything remotely resembling a size or
index). tile coordinates are ssize_t to allow more efficient conversion
to/from floating point. flags are int because we almost never need more
than 15 distinct bits, bit test/set is not slower and int is fastest to
type. finally, some data that is pretty much directly passed to OpenGL
is now typed accordingly.

after several hours, the code now requires fewer casts and less
guesswork.

other changes:
- unit and player IDs now have an "invalid id" constant in the
respective class to avoid casting and -1
- fix some endian/64-bit bugs in the map (un)packing. added a
convenience function to write/read a size_t.
- ia32: change CPUID interface to allow passing in ecx (required for
cache topology detection, which I need at work). remove some unneeded
functions from asm, replace with intrinsics where possible.

This was SVN commit r5942.
2008-05-11 18:48:32 +00:00

65 lines
1.9 KiB
C++

// JS sound binding
// interface rationale:
// - can't just expose fire and forget playSound to script code:
// we sometimes need to loop until a certain condition is met
// (e.g. building is complete) => need means of access (Handle) to sound.
//
// - the current 64-bit Handle can't be stored as-is by JS code;
// we could make it 32 bit, but that limits its usefulness
// (barely enough tag bits).
//
// - instead, we provide a thin class wrapper (using scriptableobject.h)
// on top of the snd API that encapsulates the Handle.
#ifndef INCLUDED_JSI_SOUND
#define INCLUDED_JSI_SOUND
#include "scripting/ScriptableObject.h"
#include "lib/res/handle.h"
class JSI_Sound : public CJSObject<JSI_Sound>
{
public:
Handle m_Handle;
// note: filename is stored by handle manager; no need to keep a copy here.
JSI_Sound(const CStr& Filename);
~JSI_Sound();
// Script-bound functions
CStr ToString( JSContext* cx, uintN argc, jsval* argv );
// start playing the sound (one-shot).
// it will automatically be freed when done.
bool Play( JSContext* cx, uintN argc, jsval* argv );
// request the sound be played until free() is called. returns immediately.
bool Loop( JSContext* cx, uintN argc, jsval* argv );
// stop sound if currently playing and free resources.
// doesn't need to be called unless played via loop() -
// sounds are freed automatically when done playing.
bool Free( JSContext* cx, uintN argc, jsval* argv );
bool SetGain( JSContext* cx, uintN argc, jsval* argv );
bool SetPitch( JSContext* cx, uintN argc, jsval* argv );
bool SetPosition( JSContext* cx, uintN argc, jsval* argv );
bool Fade ( JSContext* cx, uintN argc, jsval* argv );
static JSBool Construct( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval );
static void ScriptingInit();
private:
bool m_SoundDisabled; // see constructor and JSI_Sound::Construct
};
#endif // #ifndef INCLUDED_JSI_SOUND