diguySound.h

Go to the documentation of this file.

/*
 *  Copyright (C) 1992-2013 Boston Dynamics
 *  ALL RIGHTS RESERVED.
 *
 *  These coded instructions, statements, and computer programs
 *  contain unpublished proprietary information of Boston Dynamics
 *  and are protected by Copyright Laws of the United States.
 *  They may not be used, duplicated, or disclosed in any form, in
 *  whole or in part, without the prior written consent from Boston
 *  Dynamics.
 *
 *  RESTRICTED RIGHTS LEGEND
 *  Use, duplication, or disclosure by the government is subject
 *  to restrictions as set forth in FAR 52.227.19(c)(2) or
 *  subparagraph (c)(1)(ii) of the Rights in Technical Data and
 *  Computer Software clause at DFARS 252.227-7013 and/or in
 *  similar or successor clauses in the FAR, or the DOD or NASA
 *  FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
 *  Commercial Computer Software--Restricted Rights at 48 CFR
 *  52.227-19, as applicable.  Unpublished-rights reserved under
 *  the Copyright Laws of the United States.
 *  Contractor/Manufacturer is:
 *  Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
 */


/*********************************************************************
 **
 *t  diguySound
 **
 */

#ifndef __diguySound_H
#define __diguySound_H


#ifdef SWIG
%module diguySound
#else
#define CPLUSPLUS_ONLY
#endif

#ifdef CPLUSPLUS_ONLY
class bdiSound;
#endif


#include <declspec_diguy.h>

/****************************************************************************/
class BDI_DECLSPEC_diguy diguySound
{

public:

        /*l
         **
         *b  Returns:
         **
         **    name of this object
         */
        const char* get_name();

        /*l
         *b  Returns:
         **
         **    type name of the object; this value will never be NULL
         */
        const char* get_type_name();

        /*l
         *b  Description:
         **
         **    This function sets the name of the file that contains the waveform
         **    data for the sound.  The file should typically be located in the
         **    $(DIGUY)/sfx or $(DIGUY)/custom/sfx directory.
         **
         *b  Arguments:
         **
         *a    sound_filename - name of file containing waveform data
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_sound_filename(const char* sound_filename);

        /*l
         *b  Returns:
         **
         **    name of file containing waveform data for sound as set by
         **    set_sound_filename(); will never be NULL, but may be the empty
         **    string ""
         */
        const char* get_sound_filename();

        /*l
         *b  Description:
         **
         **    This function sets the name of the file that contains the phoneme
         **    data for the sound.  The file should typically be located in the
         **    same place as its waveform counterpart.
         **
         **    Phoneme files are optional.
         **
         *b  Arguments:
         **
         *a    phoneme_filename - name of file containing phoneme data
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_phoneme_filename(const char* phoneme_filename);

        /*l
         *b  Returns:
         **
         **    name of file containing phoneme data as set
         **    by set_phoneme_filename()
         */
        const char* get_phoneme_filename();

        /*l
         *b  Returns:
         **
         **    the length of the sound in seconds
         */
        float get_duration();

        /*l
         *b  Returns:
         **
         **    the number of samples per second
         */
        int get_samples_per_second();

        /*l
         *b  Returns:
         **
         **    the number of sound channels either 1 (mono) or 2 (stereo)
         */
        int get_number_of_channels();

        /*l
         *b  Returns:
         **
         **    the bit depth of a sound, either 8 or 16
         */
        int get_bit_depth();

#ifdef CPLUSPLUS_ONLY

        bdiSound* get_scripted_object() {return m_scripted_object;}

private:

        friend class bdiSound;

        /*l
         **    A private constructor.
         */
        diguySound(bdiSound* scripted_object);

        /*l
         **    A private destructor.
         */
        virtual ~diguySound();

        /*l
         **    A pointer to internal data.
         */
        bdiSound* m_scripted_object;

#endif

};


#endif /* __diguySound_H */


/*
 *  Copyright (C) 1992-2013 Boston Dynamics
 *  ALL RIGHTS RESERVED.
 *
 *  These coded instructions, statements, and computer programs
 *  contain unpublished proprietary information of Boston Dynamics
 *  and are protected by Copyright Laws of the United States.
 *  They may not be used, duplicated, or disclosed in any form, in
 *  whole or in part, without the prior written consent from Boston
 *  Dynamics.
 *
 *  RESTRICTED RIGHTS LEGEND
 *  Use, duplication, or disclosure by the government is subject
 *  to restrictions as set forth in FAR 52.227.19(c)(2) or
 *  subparagraph (c)(1)(ii) of the Rights in Technical Data and
 *  Computer Software clause at DFARS 252.227-7013 and/or in
 *  similar or successor clauses in the FAR, or the DOD or NASA
 *  FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
 *  Commercial Computer Software--Restricted Rights at 48 CFR
 *  52.227-19, as applicable.  Unpublished-rights reserved under
 *  the Copyright Laws of the United States.
 *  Contractor/Manufacturer is:
 *  Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
 */