Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / speaker.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Jörg Müller.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/blenkernel/intern/speaker.c
24  *  \ingroup bke
25  */
26
27 #include "DNA_object_types.h"
28 #include "DNA_sound_types.h"
29 #include "DNA_speaker_types.h"
30
31 #include "BLI_math.h"
32 #include "BLI_utildefines.h"
33
34 #include "BKE_animsys.h"
35 #include "BKE_library.h"
36 #include "BKE_library_query.h"
37 #include "BKE_library_remap.h"
38 #include "BKE_main.h"
39 #include "BKE_speaker.h"
40
41 void BKE_speaker_init(Speaker *spk)
42 {
43         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(spk, id));
44
45         spk->attenuation = 1.0f;
46         spk->cone_angle_inner = 360.0f;
47         spk->cone_angle_outer = 360.0f;
48         spk->cone_volume_outer = 1.0f;
49         spk->distance_max = FLT_MAX;
50         spk->distance_reference = 1.0f;
51         spk->flag = 0;
52         spk->pitch = 1.0f;
53         spk->sound = NULL;
54         spk->volume = 1.0f;
55         spk->volume_max = 1.0f;
56         spk->volume_min = 0.0f;
57 }
58
59 void *BKE_speaker_add(Main *bmain, const char *name)
60 {
61         Speaker *spk;
62
63         spk =  BKE_libblock_alloc(bmain, ID_SPK, name, 0);
64
65         BKE_speaker_init(spk);
66
67         return spk;
68 }
69
70 /**
71  * Only copy internal data of Speaker ID from source to already allocated/initialized destination.
72  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
73  *
74  * WARNING! This function will not handle ID user count!
75  *
76  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
77  */
78 void BKE_speaker_copy_data(Main *UNUSED(bmain), Speaker *UNUSED(spk_dst), const Speaker *UNUSED(spk_src), const int UNUSED(flag))
79 {
80         /* Nothing to do! */
81 }
82
83 Speaker *BKE_speaker_copy(Main *bmain, const Speaker *spk)
84 {
85         Speaker *spk_copy;
86         BKE_id_copy_ex(bmain, &spk->id, (ID **)&spk_copy, 0, false);
87         return spk_copy;
88 }
89
90 void BKE_speaker_make_local(Main *bmain, Speaker *spk, const bool lib_local)
91 {
92         BKE_id_make_local_generic(bmain, &spk->id, true, lib_local);
93 }
94
95 void BKE_speaker_free(Speaker *spk)
96 {
97         BKE_animdata_free((ID *)spk, false);
98 }