2011-02-17 21:48:12 +01:00
|
|
|
/*
|
2002-10-12 13:37:38 +02:00
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
2008-01-07 20:13:47 +01:00
|
|
|
* of the License, or (at your option) any later version.
|
2002-10-12 13:37:38 +02:00
|
|
|
*
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
2010-02-12 14:34:04 +01:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2002-10-12 13:37:38 +02:00
|
|
|
*
|
|
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
|
|
* All rights reserved.
|
|
|
|
*/
|
2019-02-17 22:08:12 +01:00
|
|
|
/** \file
|
|
|
|
* \ingroup DNA
|
2011-02-17 21:48:12 +01:00
|
|
|
*/
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#ifndef __DNA_SOUND_TYPES_H__
|
|
|
|
#define __DNA_SOUND_TYPES_H__
|
2011-12-30 08:25:49 +01:00
|
|
|
|
2002-10-12 13:37:38 +02:00
|
|
|
#include "DNA_ID.h"
|
2020-03-19 09:33:03 +01:00
|
|
|
#include "DNA_defs.h"
|
2002-10-12 13:37:38 +02:00
|
|
|
|
|
|
|
struct Ipo;
|
|
|
|
struct PackedFile;
|
|
|
|
|
|
|
|
typedef struct bSound {
|
2019-04-17 06:17:24 +02:00
|
|
|
ID id;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The path to the sound file.
|
|
|
|
*/
|
|
|
|
/** 1024 = FILE_MAX. */
|
2020-06-23 01:54:14 +02:00
|
|
|
char filepath[1024];
|
2019-04-17 06:17:24 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The packed file.
|
|
|
|
*/
|
|
|
|
struct PackedFile *packedfile;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The handle for audaspace.
|
|
|
|
*/
|
|
|
|
void *handle;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deprecated; used for loading pre 2.5 files.
|
|
|
|
*/
|
|
|
|
struct PackedFile *newpackedfile;
|
|
|
|
struct Ipo *ipo;
|
|
|
|
|
|
|
|
float volume;
|
|
|
|
float attenuation;
|
|
|
|
float pitch;
|
|
|
|
float min_gain;
|
|
|
|
float max_gain;
|
|
|
|
float distance;
|
|
|
|
short flags;
|
|
|
|
/** Runtime only, always reset in readfile. */
|
|
|
|
short tags;
|
|
|
|
char _pad[4];
|
|
|
|
|
|
|
|
/* unused currently
|
|
|
|
int type;
|
|
|
|
struct bSound *child_sound; */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The audaspace handle for cache.
|
|
|
|
*/
|
|
|
|
void *cache;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Waveform display data.
|
|
|
|
*/
|
|
|
|
void *waveform;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The audaspace handle that should actually be played back.
|
|
|
|
* Should be cache if cache != NULL; otherwise it's handle
|
|
|
|
*/
|
|
|
|
void *playback_handle;
|
|
|
|
|
2019-06-12 01:04:10 +02:00
|
|
|
/** Spin-lock for asynchronous loading of sounds. */
|
2019-04-17 06:17:24 +02:00
|
|
|
void *spinlock;
|
|
|
|
/* XXX unused currently (SOUND_TYPE_LIMITER) */
|
|
|
|
/* float start, end; */
|
2002-10-12 13:37:38 +02:00
|
|
|
} bSound;
|
|
|
|
|
2012-03-09 19:28:30 +01:00
|
|
|
/* XXX unused currently */
|
|
|
|
#if 0
|
2009-08-09 23:16:39 +02:00
|
|
|
typedef enum eSound_Type {
|
2019-04-17 06:17:24 +02:00
|
|
|
SOUND_TYPE_INVALID = -1,
|
|
|
|
SOUND_TYPE_FILE = 0,
|
|
|
|
SOUND_TYPE_BUFFER = 1,
|
|
|
|
SOUND_TYPE_LIMITER = 2,
|
2012-03-09 19:28:30 +01:00
|
|
|
} eSound_Type;
|
|
|
|
#endif
|
2009-08-09 23:16:39 +02:00
|
|
|
|
2020-03-29 11:32:45 +02:00
|
|
|
/** #bSound.flags */
|
2013-12-10 02:59:04 +01:00
|
|
|
enum {
|
2019-12-16 23:42:12 +01:00
|
|
|
#ifdef DNA_DEPRECATED_ALLOW
|
2019-04-17 06:17:24 +02:00
|
|
|
/* deprecated! used for sound actuator loading */
|
|
|
|
SOUND_FLAGS_3D = (1 << 3),
|
2015-07-10 07:58:08 +02:00
|
|
|
#endif
|
2019-04-17 06:17:24 +02:00
|
|
|
SOUND_FLAGS_CACHING = (1 << 4),
|
|
|
|
SOUND_FLAGS_MONO = (1 << 5),
|
2013-12-10 02:59:04 +01:00
|
|
|
};
|
|
|
|
|
2020-03-29 11:32:45 +02:00
|
|
|
/** #bSound.tags */
|
2018-07-20 12:01:38 +02:00
|
|
|
enum {
|
2019-04-17 06:17:24 +02:00
|
|
|
/* Do not free/reset waveform on sound load, only used by undo code. */
|
|
|
|
SOUND_TAGS_WAVEFORM_NO_RELOAD = 1 << 0,
|
|
|
|
SOUND_TAGS_WAVEFORM_LOADING = (1 << 6),
|
2018-07-20 12:01:38 +02:00
|
|
|
};
|
|
|
|
|
2020-03-29 11:32:45 +02:00
|
|
|
#endif /* __DNA_SOUND_TYPES_H__ */
|