doxygen: prevent GPL license block from being parsed as doxygen comment.
[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 #include <stdlib.h>
26
27 #include "RNA_define.h"
28
29 #include "rna_internal.h"
30
31 #include "DNA_sound_types.h"
32 #include "DNA_property_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 #include "BKE_sound.h"
37 #include "BKE_context.h"
38
39 static void rna_Sound_filepath_update(Main *bmain, Scene *scene, PointerRNA *ptr)
40 {
41         sound_load(bmain, (bSound*)ptr->data);
42 }
43
44 static int rna_Sound_caching_get(PointerRNA *ptr)
45 {
46         bSound *sound = (bSound*)(ptr->data);
47         return sound->cache != NULL;
48 }
49
50 static void rna_Sound_caching_set(PointerRNA *ptr, const int value)
51 {
52         bSound *sound = (bSound*)(ptr->data);
53         if(value)
54                 sound_cache(sound, 0);
55         else
56                 sound_delete_cache(sound);
57 }
58
59 #else
60
61 static void rna_def_sound(BlenderRNA *brna)
62 {
63         StructRNA *srna;
64         PropertyRNA *prop;
65
66         srna= RNA_def_struct(brna, "Sound", "ID");
67         RNA_def_struct_sdna(srna, "bSound");
68         RNA_def_struct_ui_text(srna, "Sound", "Sound datablock referencing an external or packed sound file");
69         RNA_def_struct_ui_icon(srna, ICON_SOUND);
70
71         //rna_def_ipo_common(srna);
72
73         prop= RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
74         RNA_def_property_string_sdna(prop, NULL, "name");
75         RNA_def_property_ui_text(prop, "File Path", "Sound sample file used by this Sound datablock");
76         RNA_def_property_update(prop, 0, "rna_Sound_filepath_update");
77
78         prop= RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
79         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
80         RNA_def_property_ui_text(prop, "Packed File", "");
81
82         prop= RNA_def_property(srna, "use_memory_cache", PROP_BOOLEAN, PROP_NONE);
83         RNA_def_property_boolean_funcs(prop, "rna_Sound_caching_get", "rna_Sound_caching_set");
84         RNA_def_property_ui_text(prop, "Caching", "The sound file is decoded and loaded into RAM");
85         RNA_def_property_update(prop, 0, "rna_Sound_filepath_update");
86 }
87
88 void RNA_def_sound(BlenderRNA *brna)
89 {
90         rna_def_sound(brna);
91 }
92
93 #endif
94
95