Ringtone Tools

Ringtone Tools API Library Calls

Introduction

Ringtone Tools 3.00 and above provide a way for outside programs to call its conversion functions. These programs can be written in C, VB, C#, or whatever other languages that can access shared libraries on both Unix and Windows operating systems.

This page is under heavy construction. It should be ready in a few days.

Building the Library

On Windows systems, the ringtonetools.dll and ringtonetools.h files that are required come in the packaged .zip file on the download page and do not need to be built. On Unix systems the library can be built by simply typing:

make lib You can optionally install the library by typing make install. This will install ringtonetools.so in /usr/local/lib and the ringtonetools.h file in /usr/local/include. On Linux systems you then need to type: ldconfig to make the library useable.

CONSTANTS

#define RTT_TYPE_UNDEFINED 0
#define RTT_TYPE_RTTTL 1
#define RTT_TYPE_RTX 2
#define RTT_TYPE_EMELODY 3
#define RTT_TYPE_IMELODY 4
#define RTT_TYPE_MIDI 5
#define RTT_TYPE_KWS 6 /* Kyocera Keypress */
#define RTT_TYPE_SEO 7 /* Siemens */
#define RTT_TYPE_BMP 8
#define RTT_TYPE_NOKIA3210 9 /* Nokia 3210 Keypress */
#define RTT_TYPE_SCKL 10
#define RTT_TYPE_MORSECODE 11
#define RTT_TYPE_EMS 12
#define RTT_TYPE_NOL 13 /* Nokia Operator Logo */
#define RTT_TYPE_NGG 14 /* Nokia Graphic */
#define RTT_TYPE_WBMP 15
#define RTT_TYPE_ICO 16 /* Windows ICO File */
#define RTT_TYPE_GIF 17
#define RTT_TYPE_SAMSUNG1 18
#define RTT_TYPE_SAMSUNG2 19
#define RTT_TYPE_PDB 20
#define RTT_TYPE_WAV 21
#define RTT_TYPE_MOT 22 /* Motorola Monophonic */
#define RTT_TYPE_MOT_KEYPRESS 23 /* Motorola Keypress */
#define RTT_TYPE_OTT 24
#define RTT_TYPE_RNG 24
#define RTT_TYPE_DSP 25
#define RTT_TYPE_TEXT 26

#define RTT_NO_ERROR 0
#define RTT_UNSUPPORTED_OUTTYPE -10
#define RTT_UNSUPPORTED_INTYPE -11

#define RTT_HEADERS_NONE 0
#define RTT_HEADERS_DEFAULT 1
#define RTT_HEADERS_LESS 2
#define RTT_HEADERS_MOST 3
#define RTT_HEADERS_STD 4
#define RTT_HEADERS_FULL 5

RTT INFO STRUCTURE

This is the main structure that basically holds the context of the current conversion. It's entire structure is defined in ringtonetools.h. The contents of the structure should only be modified/read by the API function calls, however if needed for speed or such they can be accessed here.

struct rtt_info_t;

API FUNCTION CALLS

All Ringtone Tools API calls that are meant to be used by outside programs start with rtt_.

int rtt_info_alloc();
int rtt_init_info(struct rtt_info_t *rtt_info);
int rtt_info_free(struct rtt_info_t *rtt_info);

int rtt_set_filenames(struct rtt_info_t *rtt_info, char *input_filename, char *output_filename);
int rtt_add_extension_to_file(struct rtt_info_t *rtt_info);
int rtt_get_outtype(struct rtt_info_t *rtt_info, char *param);
int rtt_get_intype(struct rtt_info_t *rtt_info, char *param);

int rtt_set_logo_dims(struct rtt_info_t *rtt_info, int width, int height);
int rtt_set_types(struct rtt_info_t *rtt_info, int in_type, int out_type);
int rtt_set_tempo(struct rtt_info_t *rtt_info, int bpm);
int rtt_set_name(struct rtt_info_t *rtt_info, char *songname);
int rtt_set_pause(struct rtt_info_t *rtt_info, int pause);
int rtt_set_wav_options(struct rtt_info_t *rtt_info, int bits_per_sample, int sample_rate);
int rtt_set_mcc_mnc(struct rtt_info_t *rtt_info, int mcc, int mnc);
int rtt_transpose(struct rtt_info_t *rtt_info, int transpose);
int rtt_set_sms_size(struct rtt_info_t *rtt_info, int sms_size);
int rtt_set_volume(struct rtt_info_t *rtt_info, int volume);
int rtt_set_midi_options(struct rtt_info_t *rtt_info, int channel, int track);
int rtt_set_header_options(struct rtt_info_t *rtt_info, int header_option);
int rtt_convert(struct rtt_info_t *rtt_info);
int rtt_get_version(char *version_str);