gammu-ringtone.h

Go to the documentation of this file.

#ifndef __gammu_ringtone_h
#define __gammu_ringtone_h

#ifdef  __cplusplus
extern "C" {
#endif

#include <gammu-types.h>
#include <gammu-error.h>
#include <gammu-limits.h>
#include <gammu-statemachine.h>

#include <stdio.h>

typedef enum {
        NaturalStyle = 0x00 << 6,
        ContinuousStyle = 0x01 << 6,
        StaccatoStyle = 0x02 << 6,

        INVALIDStyle
} GSM_RingNoteStyle;

typedef enum {
        Note_Pause = 0x00 << 4,
        Note_C = 0x01 << 4,
        Note_Cis = 0x02 << 4,
        Note_D = 0x03 << 4,
        Note_Dis = 0x04 << 4,
        Note_E = 0x05 << 4,
        Note_F = 0x06 << 4,
        Note_Fis = 0x07 << 4,
        Note_G = 0x08 << 4,
        Note_Gis = 0x09 << 4,
        Note_A = 0x0a << 4,
        Note_Ais = 0x0b << 4,
        Note_H = 0x0c << 4,

        Note_INVALID
} GSM_RingNoteNote;

typedef enum {
        Duration_Full = 0x00 << 5,
        Duration_1_2 = 0x01 << 5,
        Duration_1_4 = 0x02 << 5,
        Duration_1_8 = 0x03 << 5,
        Duration_1_16 = 0x04 << 5,
        Duration_1_32 = 0x05 << 5,

        Duration_INVALID
} GSM_RingNoteDuration;

typedef enum {
        NoSpecialDuration = 0x00 << 6,
        DottedNote = 0x01 << 6,
        DoubleDottedNote = 0x02 << 6,
        Length_2_3 = 0x03 << 6,

        DurationSpec_INVALID
} GSM_RingNoteDurationSpec;

typedef enum {
        Scale_55 = 1,
        Scale_110,
        Scale_220,
        Scale_440,
        Scale_880,
        Scale_1760,
        Scale_3520,
        Scale_7040,
        Scale_14080
} GSM_RingNoteScale;

typedef struct {
        GSM_RingNoteDuration Duration;
        GSM_RingNoteDurationSpec DurationSpec;
        GSM_RingNoteNote Note;
        GSM_RingNoteStyle Style;
        GSM_RingNoteScale Scale;
        int Tempo;
} GSM_RingNote;

typedef enum {
        RING_Note = 1,
        RING_EnableVibra,
        RING_DisableVibra,
        RING_EnableLight,
        RING_DisableLight,
        RING_EnableLED,
        RING_DisableLED,
        RING_Repeat
} GSM_RingCommandType;

typedef struct {
        GSM_RingCommandType Type;
        GSM_RingNote Note;
        unsigned char Value;
} GSM_RingCommand;

typedef struct {
        int NrCommands;
        gboolean AllNotesScale;
        GSM_RingCommand Commands[GSM_MAX_RINGTONE_NOTES];
} GSM_NoteRingtone;

/* FIXME: should use BinaryTone instead? */
/* Structure to hold Nokia binary ringtones. */
typedef struct {
        unsigned char Frame[50000];
        size_t Length;
} GSM_NokiaBinaryRingtone;

typedef struct {
        unsigned char *Buffer;
        size_t Length;
} GSM_BinaryTone;

typedef enum {
        RING_NOTETONE = 1,
        RING_NOKIABINARY,
        RING_MIDI,
        RING_MMF
} GSM_RingtoneFormat;

typedef struct {
        GSM_NokiaBinaryRingtone NokiaBinary;
        GSM_BinaryTone BinaryTone;
        GSM_NoteRingtone NoteTone;
        GSM_RingtoneFormat Format;
        unsigned char Name[(GSM_MAX_RINGTONE_NAME_LENGTH + 1) * 2];
        int Location;
} GSM_Ringtone;

typedef struct {
        int Group;
        int ID;
        unsigned char Name[30 * 2];
} GSM_RingtoneInfo;

typedef struct {
        int Number;
        GSM_RingtoneInfo *Ringtone;
} GSM_AllRingtonesInfo;

GSM_Error PHONE_RTTLPlayOneNote(GSM_StateMachine * s, GSM_RingNote note,
                                gboolean first);

GSM_Error PHONE_Beep(GSM_StateMachine * s);

GSM_Error GSM_GetRingtone(GSM_StateMachine * s, GSM_Ringtone * Ringtone,
                          gboolean PhoneRingtone);
GSM_Error GSM_SetRingtone(GSM_StateMachine * s, GSM_Ringtone * Ringtone,
                          int *maxlength);
GSM_Error GSM_GetRingtonesInfo(GSM_StateMachine * s,
                               GSM_AllRingtonesInfo * Info);
GSM_Error GSM_DeleteUserRingtones(GSM_StateMachine * s);

GSM_Error GSM_PlayTone(GSM_StateMachine * s, int Herz, unsigned char Volume,
                       gboolean start);

GSM_Error GSM_RingtoneConvert(GSM_Ringtone * dest, GSM_Ringtone * src,
                              GSM_RingtoneFormat Format);
GSM_Error GSM_ReadRingtoneFile(char *FileName, GSM_Ringtone * ringtone);

GSM_Error GSM_SaveRingtoneFile(char *FileName, GSM_Ringtone * ringtone);

GSM_Error GSM_SaveRingtoneOtt(FILE * file, GSM_Ringtone * ringtone);

GSM_Error GSM_SaveRingtoneMidi(FILE * file, GSM_Ringtone * ringtone);

GSM_Error GSM_SaveRingtoneIMelody(FILE * file, GSM_Ringtone * ringtone);

GSM_Error GSM_SaveRingtoneWav(FILE * file, GSM_Ringtone * ringtone);

GSM_Error GSM_SaveRingtoneRttl(FILE * file, GSM_Ringtone * ringtone);

const unsigned char *GSM_GetRingtoneName(const GSM_AllRingtonesInfo * Info, const int ID);

int GSM_RTTLGetTempo(int Beats);

#ifdef  __cplusplus
}
#endif
#endif

/* Editor configuration
 * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 */