Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_sound.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): Campbell Barton, Roland Hess
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_sound.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_sound_types.h"
35 #include "DNA_property_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #include "BKE_sound.h"
40 #include "BKE_context.h"
41 #include "BKE_sequencer.h"
42
43 static void rna_Sound_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
44 {
45         BKE_sound_load(bmain, (bSound *)ptr->data);
46 }
47
48 static int rna_Sound_caching_get(PointerRNA *ptr)
49 {
50         bSound *sound = (bSound *)(ptr->data);
51         return (sound->flags & SOUND_FLAGS_CACHING) != 0;
52 }
53
54 static void rna_Sound_caching_set(PointerRNA *ptr, const int value)
55 {
56         bSound *sound = (bSound *)(ptr->data);
57         if (value)
58                 BKE_sound_cache(sound);
59         else
60                 BKE_sound_delete_cache(sound);
61 }
62
63 static void rna_Sound_caching_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
64 {
65         BKE_sequencer_update_sound(scene, (bSound *)(ptr->data));
66 }
67
68 #else
69
70 static void rna_def_sound(BlenderRNA *brna)
71 {
72         StructRNA *srna;
73         PropertyRNA *prop;
74
75         srna = RNA_def_struct(brna, "Sound", "ID");
76         RNA_def_struct_sdna(srna, "bSound");
77         RNA_def_struct_ui_text(srna, "Sound", "Sound data-block referencing an external or packed sound file");
78         RNA_def_struct_ui_icon(srna, ICON_SOUND);
79
80         /*rna_def_ipo_common(srna); */
81
82         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
83         RNA_def_property_string_sdna(prop, NULL, "name");
84         RNA_def_property_ui_text(prop, "File Path", "Sound sample file used by this Sound data-block");
85         RNA_def_property_update(prop, 0, "rna_Sound_update");
86
87         prop = RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
88         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
89         RNA_def_property_ui_text(prop, "Packed File", "");
90
91         prop = RNA_def_property(srna, "use_memory_cache", PROP_BOOLEAN, PROP_NONE);
92         RNA_def_property_boolean_funcs(prop, "rna_Sound_caching_get", "rna_Sound_caching_set");
93         RNA_def_property_ui_text(prop, "Caching", "The sound file is decoded and loaded into RAM");
94         RNA_def_property_update(prop, 0, "rna_Sound_caching_update");
95
96         prop = RNA_def_property(srna, "use_mono", PROP_BOOLEAN, PROP_NONE);
97         RNA_def_property_boolean_sdna(prop, NULL, "flags", SOUND_FLAGS_MONO);
98         RNA_def_property_ui_text(prop, "Mono",
99                                  "If the file contains multiple audio channels they are rendered to a single one");
100         RNA_def_property_update(prop, 0, "rna_Sound_update");
101
102         RNA_api_sound(srna);
103 }
104
105 void RNA_def_sound(BlenderRNA *brna)
106 {
107         rna_def_sound(brna);
108 }
109
110 #endif