Blender V4.3
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)
 
void * BKE_sound_get_device (void)
 
void BKE_sound_init (struct Main *bmain)
 
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 *bmain, 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 *bmain, 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)
 
void * BKE_sound_scene_add_scene_sound (struct Scene *scene, struct Sequence *sequence, int startframe, int endframe, int frameskip)
 
void * BKE_sound_scene_add_scene_sound_defaults (struct Scene *scene, struct Sequence *sequence)
 
void * BKE_sound_add_scene_sound (struct Scene *scene, struct Sequence *sequence, int startframe, int endframe, int frameskip)
 
void * BKE_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, bool 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_update_sequence_handle (void *handle, void *sound_handle)
 
void BKE_sound_set_scene_volume (struct Scene *scene, float volume)
 
void BKE_sound_set_scene_sound_volume_at_frame (void *handle, int frame, float volume, char animated)
 
void BKE_sound_set_scene_sound_pitch_at_frame (void *handle, int frame, float pitch, char animated)
 
void BKE_sound_set_scene_sound_pitch_constant_range (void *handle, int frame_start, int frame_end, float pitch)
 
void BKE_sound_set_scene_sound_pan_at_frame (void *handle, int frame, 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, bool *stop)
 
void BKE_sound_update_scene (struct Depsgraph *depsgraph, struct Scene *scene)
 
void * BKE_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 14 of file BKE_sound.h.

Referenced by draw_seq_waveform_overlay().

Typedef Documentation

◆ eSoundChannels

◆ SoundInfo

typedef struct SoundInfo SoundInfo

◆ SoundJackSyncCallback

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

Definition at line 197 of file BKE_sound.h.

◆ SoundStreamInfo

typedef struct SoundStreamInfo 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 68 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 )

Definition at line 1365 of file blenkernel/intern/sound.cc.

◆ BKE_sound_add_scene_sound_defaults()

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

Definition at line 1373 of file blenkernel/intern/sound.cc.

Referenced by seq_update_mix_sounds(), and sequencer_swap_data_exec().

◆ BKE_sound_cache()

void BKE_sound_cache ( struct bSound * sound)

Definition at line 1344 of file blenkernel/intern/sound.cc.

◆ BKE_sound_create_scene()

void BKE_sound_create_scene ( struct Scene * scene)

Definition at line 1347 of file blenkernel/intern/sound.cc.

Referenced by BKE_sound_ensure_scene().

◆ BKE_sound_delete_cache()

void BKE_sound_delete_cache ( struct bSound * sound)

Definition at line 1345 of file blenkernel/intern/sound.cc.

◆ BKE_sound_destroy_scene()

void BKE_sound_destroy_scene ( struct Scene * scene)

Definition at line 1348 of file blenkernel/intern/sound.cc.

Referenced by BKE_scene_duplicate(), and scene_free_data().

◆ BKE_sound_ensure_loaded()

void BKE_sound_ensure_loaded ( struct Main * bmain,
struct bSound * sound )

Definition at line 1486 of file blenkernel/intern/sound.cc.

References BKE_sound_load(), and bSound::cache.

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 1342 of file blenkernel/intern/sound.cc.

Referenced by WM_exit_ex().

◆ BKE_sound_exit_once()

void BKE_sound_exit_once ( void )

Definition at line 1343 of file blenkernel/intern/sound.cc.

◆ BKE_sound_force_device()

void BKE_sound_force_device ( const char * device)

◆ BKE_sound_free_waveform()

void BKE_sound_free_waveform ( struct bSound * sound)

Definition at line 1447 of file blenkernel/intern/sound.cc.

Referenced by sound_free_data().

◆ 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 1441 of file blenkernel/intern/sound.cc.

◆ 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 )

Definition at line 1437 of file blenkernel/intern/sound.cc.

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 )

Definition at line 1449 of file blenkernel/intern/sound.cc.

Referenced by BKE_nla_add_soundstrip(), and BKE_sound_new_file().

◆ BKE_sound_init()

void BKE_sound_init ( struct Main * bmain)

Definition at line 1341 of file blenkernel/intern/sound.cc.

Referenced by wm_init_userdef().

◆ BKE_sound_init_main()

void BKE_sound_init_main ( struct Main * bmain)

Definition at line 1406 of file blenkernel/intern/sound.cc.

Referenced by CTX_data_main_set().

◆ BKE_sound_init_once()

void BKE_sound_init_once ( void )

Definition at line 1340 of file blenkernel/intern/sound.cc.

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 1494 of file blenkernel/intern/sound.cc.

References callback, sound_jack_sync_callback(), and UNUSED_VARS.

Referenced by WM_init().

◆ BKE_sound_load()

void BKE_sound_load ( struct Main * bmain,
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 )

Definition at line 1387 of file blenkernel/intern/sound.cc.

Referenced by SEQ_sound_update_bounds().

◆ BKE_sound_mute_scene()

void BKE_sound_mute_scene ( struct Scene * scene,
int muted )

Definition at line 1352 of file blenkernel/intern/sound.cc.

Referenced by BKE_scene_update_sound().

◆ BKE_sound_mute_scene_sound()

void BKE_sound_mute_scene_sound ( void * handle,
bool mute )

Definition at line 1378 of file blenkernel/intern/sound.cc.

Referenced by seq_update_muting_recursive().

◆ BKE_sound_new_file()

◆ 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.cc.

References BKE_sound_new_file_exists_ex().

◆ 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,
bool * stop )

Definition at line 1399 of file blenkernel/intern/sound.cc.

References UNUSED_VARS.

Referenced by execute_read_sound_waveform_task().

◆ 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 1480 of file blenkernel/intern/sound.cc.

References bSound::cache, 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)

Definition at line 1351 of file blenkernel/intern/sound.cc.

Referenced by RE_RenderAnim(), and sound_mixdown_exec().

◆ 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 )

Definition at line 1353 of file blenkernel/intern/sound.cc.

◆ BKE_sound_scene_add_scene_sound_defaults()

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

Definition at line 1361 of file blenkernel/intern/sound.cc.

Referenced by seq_dupli(), and seq_update_mix_sounds().

◆ BKE_sound_scene_playing()

int BKE_sound_scene_playing ( struct Scene * scene)

Definition at line 1395 of file blenkernel/intern/sound.cc.

Referenced by wm_event_do_handlers().

◆ BKE_sound_seek_scene()

void BKE_sound_seek_scene ( struct Main * bmain,
struct Scene * scene )

Definition at line 1390 of file blenkernel/intern/sound.cc.

Referenced by BKE_scene_update_sound().

◆ BKE_sound_set_scene_sound_pan_at_frame()

void BKE_sound_set_scene_sound_pan_at_frame ( void * handle,
int frame,
float pan,
char animated )

Definition at line 1418 of file blenkernel/intern/sound.cc.

Referenced by seq_update_sound_properties().

◆ BKE_sound_set_scene_sound_pitch_at_frame()

void BKE_sound_set_scene_sound_pitch_at_frame ( void * handle,
int frame,
float pitch,
char animated )

Definition at line 1425 of file blenkernel/intern/sound.cc.

Referenced by SEQ_retiming_sound_animation_data_set().

◆ BKE_sound_set_scene_sound_pitch_constant_range()

void BKE_sound_set_scene_sound_pitch_constant_range ( void * handle,
int frame_start,
int frame_end,
float pitch )

Definition at line 1431 of file blenkernel/intern/sound.cc.

Referenced by SEQ_retiming_sound_animation_data_set().

◆ BKE_sound_set_scene_sound_volume_at_frame()

void BKE_sound_set_scene_sound_volume_at_frame ( void * handle,
int frame,
float volume,
char animated )

Definition at line 1412 of file blenkernel/intern/sound.cc.

Referenced by seq_update_sound_properties().

◆ 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 )

Definition at line 1454 of file blenkernel/intern/sound.cc.

◆ BKE_sound_sync_scene()

double BKE_sound_sync_scene ( struct Scene * scene)

Definition at line 1391 of file blenkernel/intern/sound.cc.

References NAN_FLT.

Referenced by screen_animation_step_invoke(), and wm_event_do_handlers().

◆ BKE_sound_unlock()

void BKE_sound_unlock ( void )

◆ BKE_sound_update_fps()

void BKE_sound_update_fps ( struct Main * bmain,
struct Scene * scene )

Definition at line 1411 of file blenkernel/intern/sound.cc.

Referenced by BKE_scene_update_sound().

◆ BKE_sound_update_scene()

void BKE_sound_update_scene ( struct Depsgraph * depsgraph,
struct Scene * scene )

Definition at line 1408 of file blenkernel/intern/sound.cc.

Referenced by BKE_scene_update_sound().

◆ BKE_sound_update_scene_listener()

void BKE_sound_update_scene_listener ( struct Scene * scene)

Definition at line 1410 of file blenkernel/intern/sound.cc.

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_sequence_handle()

void BKE_sound_update_sequence_handle ( void * handle,
void * sound_handle )

Definition at line 816 of file blenkernel/intern/sound.cc.

References UNUSED_VARS.

Referenced by seq_update_sound_modifiers().

◆ BKE_sound_update_sequencer()

void BKE_sound_update_sequencer ( struct Main * main,
struct bSound * sound )

Definition at line 1407 of file blenkernel/intern/sound.cc.