Blender  V3.3
Classes | Macros | Typedefs | Enumerations | Functions
BKE_sound.h File Reference

Go to the source code of this file.

Classes

struct  SoundWaveform
 
struct  SoundInfo
 
struct  SoundStreamInfo
 

Macros

#define SOUND_WAVE_SAMPLES_PER_SECOND   250
 

Typedefs

typedef struct SoundWaveform SoundWaveform
 
typedef enum eSoundChannels eSoundChannels
 
typedef struct SoundInfo SoundInfo
 
typedef struct SoundStreamInfo SoundStreamInfo
 
typedef void(* SoundJackSyncCallback) (struct Main *bmain, int mode, double time)
 

Enumerations

enum  eSoundChannels {
  SOUND_CHANNELS_INVALID = 0 , SOUND_CHANNELS_MONO = 1 , SOUND_CHANNELS_STEREO = 2 , SOUND_CHANNELS_STEREO_LFE = 3 ,
  SOUND_CHANNELS_SURROUND4 = 4 , SOUND_CHANNELS_SURROUND5 = 5 , SOUND_CHANNELS_SURROUND51 = 6 , SOUND_CHANNELS_SURROUND61 = 7 ,
  SOUND_CHANNELS_SURROUND71 = 8
}
 

Functions

void BKE_sound_init_once (void)
 
void BKE_sound_exit_once (void)
 
voidBKE_sound_get_device (void)
 
void BKE_sound_init (struct Main *main)
 
void BKE_sound_init_main (struct Main *bmain)
 
void BKE_sound_exit (void)
 
void BKE_sound_force_device (const char *device)
 
struct bSoundBKE_sound_new_file (struct Main *main, const char *filepath)
 
struct bSoundBKE_sound_new_file_exists_ex (struct Main *bmain, const char *filepath, bool *r_exists)
 
struct bSoundBKE_sound_new_file_exists (struct Main *bmain, const char *filepath)
 
void BKE_sound_cache (struct bSound *sound)
 
void BKE_sound_delete_cache (struct bSound *sound)
 
void BKE_sound_reset_runtime (struct bSound *sound)
 
void BKE_sound_load (struct Main *main, struct bSound *sound)
 
void BKE_sound_ensure_loaded (struct Main *bmain, struct bSound *sound)
 
bool BKE_sound_info_get (struct Main *main, struct bSound *sound, SoundInfo *sound_info)
 
bool BKE_sound_stream_info_get (struct Main *main, const char *filepath, int stream, SoundStreamInfo *sound_info)
 
void BKE_sound_reset_scene_runtime (struct Scene *scene)
 
void BKE_sound_create_scene (struct Scene *scene)
 
void BKE_sound_ensure_scene (struct Scene *scene)
 
void BKE_sound_destroy_scene (struct Scene *scene)
 
void BKE_sound_lock (void)
 
void BKE_sound_unlock (void)
 
void BKE_sound_reset_scene_specs (struct Scene *scene)
 
void BKE_sound_mute_scene (struct Scene *scene, int muted)
 
void BKE_sound_update_fps (struct Main *bmain, struct Scene *scene)
 
void BKE_sound_update_scene_listener (struct Scene *scene)
 
voidBKE_sound_scene_add_scene_sound (struct Scene *scene, struct Sequence *sequence, int startframe, int endframe, int frameskip)
 
voidBKE_sound_scene_add_scene_sound_defaults (struct Scene *scene, struct Sequence *sequence)
 
voidBKE_sound_add_scene_sound (struct Scene *scene, struct Sequence *sequence, int startframe, int endframe, int frameskip)
 
voidBKE_sound_add_scene_sound_defaults (struct Scene *scene, struct Sequence *sequence)
 
void BKE_sound_remove_scene_sound (struct Scene *scene, void *handle)
 
void BKE_sound_mute_scene_sound (void *handle, char mute)
 
void BKE_sound_move_scene_sound (const struct Scene *scene, void *handle, int startframe, int endframe, int frameskip, double audio_offset)
 
void BKE_sound_move_scene_sound_defaults (struct Scene *scene, struct Sequence *sequence)
 
void BKE_sound_update_scene_sound (void *handle, struct bSound *sound)
 
void BKE_sound_set_cfra (int cfra)
 
void BKE_sound_set_scene_volume (struct Scene *scene, float volume)
 
void BKE_sound_set_scene_sound_volume (void *handle, float volume, char animated)
 
void BKE_sound_set_scene_sound_pitch (void *handle, float pitch, char animated)
 
void BKE_sound_set_scene_sound_pan (void *handle, float pan, char animated)
 
void BKE_sound_update_sequencer (struct Main *main, struct bSound *sound)
 
void BKE_sound_play_scene (struct Scene *scene)
 
void BKE_sound_stop_scene (struct Scene *scene)
 
void BKE_sound_seek_scene (struct Main *bmain, struct Scene *scene)
 
double BKE_sound_sync_scene (struct Scene *scene)
 
int BKE_sound_scene_playing (struct Scene *scene)
 
void BKE_sound_free_waveform (struct bSound *sound)
 
void BKE_sound_read_waveform (struct Main *bmain, struct bSound *sound, short *stop)
 
void BKE_sound_update_scene (struct Depsgraph *depsgraph, struct Scene *scene)
 
voidBKE_sound_get_factory (void *sound)
 
float BKE_sound_get_length (struct Main *bmain, struct bSound *sound)
 
char ** BKE_sound_get_device_names (void)
 
void BKE_sound_jack_sync_callback_set (SoundJackSyncCallback callback)
 
void BKE_sound_jack_scene_update (struct Scene *scene, int mode, double time)
 
void BKE_sound_evaluate (struct Depsgraph *depsgraph, struct Main *bmain, struct bSound *sound)
 

Macro Definition Documentation

◆ SOUND_WAVE_SAMPLES_PER_SECOND

#define SOUND_WAVE_SAMPLES_PER_SECOND   250

Definition at line 13 of file BKE_sound.h.

Typedef Documentation

◆ eSoundChannels

◆ SoundInfo

typedef struct SoundInfo SoundInfo

◆ SoundJackSyncCallback

typedef void(* SoundJackSyncCallback) (struct Main *bmain, int mode, double time)

Definition at line 183 of file BKE_sound.h.

◆ SoundStreamInfo

◆ SoundWaveform

typedef struct SoundWaveform SoundWaveform

Enumeration Type Documentation

◆ eSoundChannels

Enumerator
SOUND_CHANNELS_INVALID 
SOUND_CHANNELS_MONO 
SOUND_CHANNELS_STEREO 
SOUND_CHANNELS_STEREO_LFE 
SOUND_CHANNELS_SURROUND4 
SOUND_CHANNELS_SURROUND5 
SOUND_CHANNELS_SURROUND51 
SOUND_CHANNELS_SURROUND61 
SOUND_CHANNELS_SURROUND71 

Definition at line 67 of file BKE_sound.h.

Function Documentation

◆ BKE_sound_add_scene_sound()

void* BKE_sound_add_scene_sound ( struct Scene scene,
struct Sequence sequence,
int  startframe,
int  endframe,
int  frameskip 
)

◆ BKE_sound_add_scene_sound_defaults()

void* BKE_sound_add_scene_sound_defaults ( struct Scene scene,
struct Sequence sequence 
)

◆ BKE_sound_cache()

void BKE_sound_cache ( struct bSound sound)

◆ BKE_sound_create_scene()

void BKE_sound_create_scene ( struct Scene scene)

◆ BKE_sound_delete_cache()

void BKE_sound_delete_cache ( struct bSound sound)

◆ BKE_sound_destroy_scene()

void BKE_sound_destroy_scene ( struct Scene scene)

◆ BKE_sound_ensure_loaded()

void BKE_sound_ensure_loaded ( struct Main bmain,
struct bSound sound 
)

Definition at line 1477 of file blenkernel/intern/sound.c.

References BKE_sound_load(), bSound::cache, and NULL.

Referenced by BKE_sound_evaluate().

◆ BKE_sound_ensure_scene()

void BKE_sound_ensure_scene ( struct Scene scene)

◆ BKE_sound_evaluate()

void BKE_sound_evaluate ( struct Depsgraph depsgraph,
struct Main bmain,
struct bSound sound 
)

◆ BKE_sound_exit()

void BKE_sound_exit ( void  )

Definition at line 1289 of file blenkernel/intern/sound.c.

Referenced by WM_exit_ex().

◆ BKE_sound_exit_once()

void BKE_sound_exit_once ( void  )

Definition at line 1292 of file blenkernel/intern/sound.c.

◆ BKE_sound_force_device()

void BKE_sound_force_device ( const char *  device)

◆ BKE_sound_free_waveform()

void BKE_sound_free_waveform ( struct bSound sound)

◆ BKE_sound_get_device()

void* BKE_sound_get_device ( void  )

◆ BKE_sound_get_device_names()

char** BKE_sound_get_device_names ( void  )

Definition at line 1428 of file blenkernel/intern/sound.c.

References names, and NULL.

◆ BKE_sound_get_factory()

void* BKE_sound_get_factory ( void sound)

◆ BKE_sound_get_length()

float BKE_sound_get_length ( struct Main bmain,
struct bSound sound 
)

Referenced by SEQ_add_reload_new_file().

◆ BKE_sound_info_get()

bool BKE_sound_info_get ( struct Main main,
struct bSound sound,
SoundInfo sound_info 
)

Referenced by BKE_nla_add_soundstrip().

◆ BKE_sound_init()

void BKE_sound_init ( struct Main main)

Referenced by wm_init_userdef().

◆ BKE_sound_init_main()

void BKE_sound_init_main ( struct Main bmain)

Referenced by CTX_data_main_set().

◆ BKE_sound_init_once()

void BKE_sound_init_once ( void  )

Definition at line 1283 of file blenkernel/intern/sound.c.

Referenced by main().

◆ BKE_sound_jack_scene_update()

void BKE_sound_jack_scene_update ( struct Scene scene,
int  mode,
double  time 
)

◆ BKE_sound_jack_sync_callback_set()

void BKE_sound_jack_sync_callback_set ( SoundJackSyncCallback  callback)

Definition at line 1485 of file blenkernel/intern/sound.c.

References callback, sound_jack_sync_callback(), and UNUSED_VARS.

Referenced by WM_init().

◆ BKE_sound_load()

void BKE_sound_load ( struct Main main,
struct bSound sound 
)

◆ BKE_sound_lock()

void BKE_sound_lock ( void  )

◆ BKE_sound_move_scene_sound()

void BKE_sound_move_scene_sound ( const struct Scene scene,
void handle,
int  startframe,
int  endframe,
int  frameskip,
double  audio_offset 
)

◆ BKE_sound_move_scene_sound_defaults()

void BKE_sound_move_scene_sound_defaults ( struct Scene scene,
struct Sequence sequence 
)

Referenced by SEQ_sound_update_bounds().

◆ BKE_sound_mute_scene()

void BKE_sound_mute_scene ( struct Scene scene,
int  muted 
)

Referenced by BKE_scene_update_sound().

◆ BKE_sound_mute_scene_sound()

void BKE_sound_mute_scene_sound ( void handle,
char  mute 
)

◆ BKE_sound_new_file()

struct bSound* BKE_sound_new_file ( struct Main main,
const char *  filepath 
)

◆ BKE_sound_new_file_exists()

struct bSound* BKE_sound_new_file_exists ( struct Main bmain,
const char *  filepath 
)

Definition at line 312 of file blenkernel/intern/sound.c.

References BKE_sound_new_file_exists_ex(), and NULL.

◆ BKE_sound_new_file_exists_ex()

struct bSound* BKE_sound_new_file_exists_ex ( struct Main bmain,
const char *  filepath,
bool r_exists 
)

◆ BKE_sound_play_scene()

void BKE_sound_play_scene ( struct Scene scene)

◆ BKE_sound_read_waveform()

void BKE_sound_read_waveform ( struct Main bmain,
struct bSound sound,
short *  stop 
)

Definition at line 1380 of file blenkernel/intern/sound.c.

References UNUSED_VARS.

Referenced by preview_startjob().

◆ BKE_sound_remove_scene_sound()

void BKE_sound_remove_scene_sound ( struct Scene scene,
void handle 
)

◆ BKE_sound_reset_runtime()

void BKE_sound_reset_runtime ( struct bSound sound)

Definition at line 1471 of file blenkernel/intern/sound.c.

References bSound::cache, NULL, and bSound::playback_handle.

Referenced by BKE_sound_new_file(), and sound_copy_data().

◆ BKE_sound_reset_scene_runtime()

void BKE_sound_reset_scene_runtime ( struct Scene scene)

◆ BKE_sound_reset_scene_specs()

void BKE_sound_reset_scene_specs ( struct Scene scene)

◆ BKE_sound_scene_add_scene_sound()

void* BKE_sound_scene_add_scene_sound ( struct Scene scene,
struct Sequence sequence,
int  startframe,
int  endframe,
int  frameskip 
)

◆ BKE_sound_scene_add_scene_sound_defaults()

void* BKE_sound_scene_add_scene_sound_defaults ( struct Scene scene,
struct Sequence sequence 
)

Referenced by seq_dupli(), and seq_update_seq_cb().

◆ BKE_sound_scene_playing()

int BKE_sound_scene_playing ( struct Scene scene)

Referenced by wm_event_do_handlers().

◆ BKE_sound_seek_scene()

void BKE_sound_seek_scene ( struct Main bmain,
struct Scene scene 
)

Referenced by BKE_scene_update_sound().

◆ BKE_sound_set_cfra()

void BKE_sound_set_cfra ( int  cfra)

◆ BKE_sound_set_scene_sound_pan()

void BKE_sound_set_scene_sound_pan ( void handle,
float  pan,
char  animated 
)

Referenced by seq_update_seq_cb().

◆ BKE_sound_set_scene_sound_pitch()

void BKE_sound_set_scene_sound_pitch ( void handle,
float  pitch,
char  animated 
)

Referenced by seq_update_seq_cb().

◆ BKE_sound_set_scene_sound_volume()

void BKE_sound_set_scene_sound_volume ( void handle,
float  volume,
char  animated 
)

Referenced by seq_update_seq_cb().

◆ BKE_sound_set_scene_volume()

void BKE_sound_set_scene_volume ( struct Scene scene,
float  volume 
)

◆ BKE_sound_stop_scene()

void BKE_sound_stop_scene ( struct Scene scene)

◆ BKE_sound_stream_info_get()

bool BKE_sound_stream_info_get ( struct Main main,
const char *  filepath,
int  stream,
SoundStreamInfo sound_info 
)

◆ BKE_sound_sync_scene()

double BKE_sound_sync_scene ( struct Scene scene)

◆ BKE_sound_unlock()

void BKE_sound_unlock ( void  )

◆ BKE_sound_update_fps()

void BKE_sound_update_fps ( struct Main bmain,
struct Scene scene 
)

Referenced by BKE_scene_update_sound().

◆ BKE_sound_update_scene()

void BKE_sound_update_scene ( struct Depsgraph depsgraph,
struct Scene scene 
)

Referenced by BKE_scene_update_sound().

◆ BKE_sound_update_scene_listener()

void BKE_sound_update_scene_listener ( struct Scene scene)

Referenced by BKE_scene_update_sound().

◆ BKE_sound_update_scene_sound()

void BKE_sound_update_scene_sound ( void handle,
struct bSound sound 
)

◆ BKE_sound_update_sequencer()

void BKE_sound_update_sequencer ( struct Main main,
struct bSound sound 
)