DNA_sound_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_defs.h"
 
struct Ipo;
struct PackedFile;
 
typedef struct bSound {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_SO;
#endif
 
  ID id;

  char filepath[/*FILE_MAX*/ 1024];

  struct PackedFile *packedfile;

  void *handle;

  struct PackedFile *newpackedfile;
  struct Ipo *ipo;
 
  float volume;
  float attenuation;
  float pitch;
  float min_gain;
  float max_gain;
  float distance;
  short flags;
  short tags;
  char _pad[4];
  double offset_time;
 
  /* Unused currently. */
  // int type;
  // struct bSound *child_sound;

  void *cache;

  void *waveform;

  void *playback_handle;

  void *spinlock;
  /* XXX unused currently (SOUND_TYPE_LIMITER) */
  // float start, end;
 
  /* Description of Audio channels, as of #eSoundChannels. */
  int audio_channels;
 
  int samplerate;
 
} bSound;
 
/* XXX unused currently */
#if 0
typedef enum eSound_Type {
  SOUND_TYPE_INVALID = -1,
  SOUND_TYPE_FILE = 0,
  SOUND_TYPE_BUFFER = 1,
  SOUND_TYPE_LIMITER = 2,
} eSound_Type;
#endif

enum {
#ifdef DNA_DEPRECATED_ALLOW
  /* deprecated! used for sound actuator loading */
  SOUND_FLAGS_3D = (1 << 3),
#endif
  SOUND_FLAGS_CACHING = (1 << 4),
  SOUND_FLAGS_MONO = (1 << 5),
};

enum {
  /* 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),
};