make new rna variables more consistant with existing names.
[blender.git] / source / blender / makesrna / intern / rna_sound.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton, Roland Hess
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/makesrna/intern/rna_sound.c
26  *  \ingroup RNA
27  */
28
29
30 #include <stdlib.h>
31
32 #include "RNA_define.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_sound_types.h"
37 #include "DNA_property_types.h"
38
39 #ifdef RNA_RUNTIME
40
41 #include "BKE_sound.h"
42 #include "BKE_context.h"
43
44 static void rna_Sound_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
45 {
46         sound_load(bmain, (bSound*)ptr->data);
47 }
48
49 static int rna_Sound_caching_get(PointerRNA *ptr)
50 {
51         bSound *sound = (bSound*)(ptr->data);
52         return (sound->flags & SOUND_FLAGS_CACHING) != 0;
53 }
54
55 static void rna_Sound_caching_set(PointerRNA *ptr, const int value)
56 {
57         bSound *sound = (bSound*)(ptr->data);
58         if(value)
59                 sound_cache(sound);
60         else
61                 sound_delete_cache(sound);
62 }
63
64 static void rna_Sound_caching_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
65 {
66         sound_update_sequencer(bmain, (bSound*)(ptr->data));
67 }
68
69 #else
70
71 static void rna_def_sound(BlenderRNA *brna)
72 {
73         StructRNA *srna;
74         PropertyRNA *prop;
75
76         srna= RNA_def_struct(brna, "Sound", "ID");
77         RNA_def_struct_sdna(srna, "bSound");
78         RNA_def_struct_ui_text(srna, "Sound", "Sound datablock referencing an external or packed sound file");
79         RNA_def_struct_ui_icon(srna, ICON_SOUND);
80
81         //rna_def_ipo_common(srna);
82
83         prop= RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
84         RNA_def_property_string_sdna(prop, NULL, "name");
85         RNA_def_property_ui_text(prop, "File Path", "Sound sample file used by this Sound datablock");
86         RNA_def_property_update(prop, 0, "rna_Sound_update");
87
88         prop= RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
89         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
90         RNA_def_property_ui_text(prop, "Packed File", "");
91
92         prop= RNA_def_property(srna, "use_memory_cache", PROP_BOOLEAN, PROP_NONE);
93         RNA_def_property_boolean_funcs(prop, "rna_Sound_caching_get", "rna_Sound_caching_set");
94         RNA_def_property_ui_text(prop, "Caching", "The sound file is decoded and loaded into RAM");
95         RNA_def_property_update(prop, 0, "rna_Sound_caching_update");
96
97         prop= RNA_def_property(srna, "use_mono", PROP_BOOLEAN, PROP_NONE);
98         RNA_def_property_boolean_sdna(prop, NULL, "flags", SOUND_FLAGS_MONO);
99         RNA_def_property_ui_text(prop, "Mono", "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
103 void RNA_def_sound(BlenderRNA *brna)
104 {
105         rna_def_sound(brna);
106 }
107
108 #endif
109
110