rna_sound.c

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s): Campbell Barton, Roland Hess
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdlib.h>

#include "RNA_define.h"

#include "rna_internal.h"

#include "DNA_sound_types.h"
#include "DNA_property_types.h"

#ifdef RNA_RUNTIME

#include "BKE_sound.h"
#include "BKE_context.h"

static void rna_Sound_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
{
    sound_load(bmain, (bSound*)ptr->data);
}

static int rna_Sound_caching_get(PointerRNA *ptr)
{
    bSound *sound = (bSound*)(ptr->data);
    return (sound->flags & SOUND_FLAGS_CACHING) != 0;
}

static void rna_Sound_caching_set(PointerRNA *ptr, const int value)
{
    bSound *sound = (bSound*)(ptr->data);
    if(value)
        sound_cache(sound);
    else
        sound_delete_cache(sound);
}

static void rna_Sound_caching_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
{
    sound_update_sequencer(bmain, (bSound*)(ptr->data));
}

#else

static void rna_def_sound(BlenderRNA *brna)
{
    StructRNA *srna;
    PropertyRNA *prop;

    srna= RNA_def_struct(brna, "Sound", "ID");
    RNA_def_struct_sdna(srna, "bSound");
    RNA_def_struct_ui_text(srna, "Sound", "Sound datablock referencing an external or packed sound file");
    RNA_def_struct_ui_icon(srna, ICON_SOUND);

    //rna_def_ipo_common(srna);

    prop= RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
    RNA_def_property_string_sdna(prop, NULL, "name");
    RNA_def_property_ui_text(prop, "File Path", "Sound sample file used by this Sound datablock");
    RNA_def_property_update(prop, 0, "rna_Sound_update");

    prop= RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
    RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
    RNA_def_property_ui_text(prop, "Packed File", "");

    prop= RNA_def_property(srna, "use_memory_cache", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_funcs(prop, "rna_Sound_caching_get", "rna_Sound_caching_set");
    RNA_def_property_ui_text(prop, "Caching", "The sound file is decoded and loaded into RAM");
    RNA_def_property_update(prop, 0, "rna_Sound_caching_update");

    prop= RNA_def_property(srna, "use_mono", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "flags", SOUND_FLAGS_MONO);
    RNA_def_property_ui_text(prop, "Mono", "If the file contains multiple audio channels they are rendered to a single one");
    RNA_def_property_update(prop, 0, "rna_Sound_update");
}

void RNA_def_sound(BlenderRNA *brna)
{
    rna_def_sound(brna);
}

#endif