libmpd.h

Go to the documentation of this file.

/* libmpd (high level libmpdclient library)
 * Copyright (C) 2004-2009 Qball Cow <qball@sarine.nl>
 * Project homepage: http://gmpcwiki.sarine.nl/
 
 * 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.
*/


#ifdef __cplusplus
extern "C" {
#endif

#ifndef __MPD_LIB__
#define __MPD_LIB__
#ifdef WIN32
#define __REGEX_IMPORT__ 1
#define __W32API_USE_DLLIMPORT__ 1
#endif

#include "libmpdclient.h"

#ifndef TRUE

#define TRUE 1
#endif

#ifndef FALSE

#define FALSE 0
#endif
#include "libmpd-version.h"
extern char *libmpd_version;

typedef enum {
        MPD_OK = 0,
        MPD_ARGS_ERROR = -5,
        MPD_NOT_CONNECTED = -10,
        MPD_STATUS_FAILED  = -20,
        MPD_LOCK_FAILED  = -30,
        MPD_STATS_FAILED = -40,
        MPD_SERVER_ERROR = -50,
        MPD_SERVER_NOT_SUPPORTED = -51,
        
        MPD_DATABASE_PLAYLIST_EXIST  = -60,
        MPD_PLAYLIST_EMPTY = -70,
        MPD_PLAYLIST_QUEUE_EMPTY = -75,
        MPD_PLAYER_NOT_PLAYING = -80,

        MPD_TAG_NOT_FOUND = -90,

    /* MPD_PLALIST_LOAD_FAILED */
    MPD_PLAYLIST_LOAD_FAILED = -100,
        
        MPD_FATAL_ERROR = -1000
}MpdError;



typedef struct _MpdObj MpdObj;

typedef enum {
        MPD_SERVER_COMMAND_ALLOWED = TRUE,
        MPD_SERVER_COMMAND_NOT_ALLOWED = FALSE,
        MPD_SERVER_COMMAND_NOT_SUPPORTED = -1,
        MPD_SERVER_COMMAND_ERROR = -2
} MpdServerCommand;


typedef enum {
        MPD_DATA_TYPE_NONE,
        MPD_DATA_TYPE_TAG,
        MPD_DATA_TYPE_DIRECTORY,
        MPD_DATA_TYPE_SONG,
        MPD_DATA_TYPE_PLAYLIST,
        MPD_DATA_TYPE_OUTPUT_DEV
} MpdDataType;

typedef struct _MpdData {
        MpdDataType type;
        union {
                struct {
                        int tag_type;
                        char *tag;
                };
                char *directory;
                mpd_PlaylistFile *playlist;
                mpd_Song *song;
                mpd_OutputEntity *output_dev;
        };

    void *userdata;
    void (*freefunc)(void *userdata);
} MpdData;


#include "libmpd-player.h"
#include "libmpd-status.h"
#include "libmpd-database.h"
#include "libmpd-playlist.h"
#include "libmpd-strfsong.h"
#include "libmpd-sticker.h"



MpdObj *mpd_new_default();



MpdObj *mpd_new(char *hostname, int port, char *password);


        
int mpd_set_hostname(MpdObj * mi, char *hostname);

const char * mpd_get_hostname(MpdObj *mi);
        
int mpd_set_password(MpdObj * mi,const char *password);
        
        
int mpd_set_port(MpdObj * mi, int port);



        
int mpd_set_connection_timeout(MpdObj * mi, float timeout);


int mpd_connect_real(MpdObj *mi,mpd_Connection *connection);
int mpd_connect(MpdObj * mi);

        
int mpd_disconnect(MpdObj * mi);

        
        
int mpd_check_connected(MpdObj * mi);

        
        
int mpd_check_error(MpdObj * mi);


        
void mpd_free(MpdObj * mi);


        
int mpd_send_password(MpdObj * mi);

        

/*
 * signals
 */

typedef enum {
        MPD_CST_PLAYLIST      = 0x0001,
        MPD_CST_SONGPOS       = 0x0002,
        MPD_CST_SONGID        = 0x0004,
        MPD_CST_DATABASE      = 0x0008,
        MPD_CST_UPDATING      = 0x0010,
        MPD_CST_VOLUME        = 0x0020,
        MPD_CST_TOTAL_TIME    = 0x0040,
        MPD_CST_ELAPSED_TIME  = 0x0080,
        MPD_CST_CROSSFADE     = 0x0100,
        MPD_CST_RANDOM        = 0x0200,
        MPD_CST_REPEAT        = 0x0400,
        MPD_CST_AUDIO         = 0x0800,
        MPD_CST_STATE         = 0x1000,
        MPD_CST_PERMISSION    = 0x2000,
        MPD_CST_BITRATE       = 0x4000,
        MPD_CST_AUDIOFORMAT   = 0x8000,
        MPD_CST_STORED_PLAYLIST           = 0x20000,
    MPD_CST_SERVER_ERROR        = 0x40000,
    MPD_CST_OUTPUT              = 0x80000,
    MPD_CST_STICKER             = 0x100000,
    MPD_CST_NEXTSONG            = 0x200000,
    MPD_CST_SINGLE_MODE         = 0x400000,
    MPD_CST_CONSUME_MODE        = 0x800000,
    MPD_CST_REPLAYGAIN          = 0x1000000
} ChangedStatusType;


/* callback typedef's */
typedef void (*StatusChangedCallback) (MpdObj * mi, ChangedStatusType what, void *userdata);



        
typedef int (*ErrorCallback) (MpdObj * mi, int id, char *msg, void *userdata);


        
typedef void (*ConnectionChangedCallback) (MpdObj * mi, int connect, void *userdata);



/* new style signal connectors */
void mpd_signal_connect_status_changed(MpdObj * mi, StatusChangedCallback status_changed,
                                               void *userdata);



void mpd_signal_connect_error(MpdObj * mi, ErrorCallback error, void *userdata);


        
void mpd_signal_connect_connection_changed(MpdObj * mi,
                                                   ConnectionChangedCallback connection_changed,
                                                   void *userdata);


int mpd_data_is_last(MpdData const *data);


void mpd_data_free(MpdData * data);


        
MpdData *mpd_data_get_next(MpdData * data);


        

MpdData *mpd_data_get_first(MpdData const *data);


        
MpdData *mpd_data_delete_item(MpdData * data);


        

        
MpdData *mpd_server_get_output_devices(MpdObj * mi);


        
int mpd_server_set_output_device(MpdObj * mi, int device_id, int state);


        
long unsigned mpd_server_get_database_update_time(MpdObj * mi);


        
int mpd_server_check_version(MpdObj * mi, int major, int minor, int micro);

char *mpd_server_get_version(MpdObj *mi);
int mpd_server_check_command_allowed(MpdObj * mi, const char *command);



char ** mpd_server_get_url_handlers(MpdObj *mi);

char ** mpd_server_get_tag_types(MpdObj *mi);

int mpd_misc_get_tag_by_name(char *name);

int mpd_server_has_idle(MpdObj *mi);

int mpd_server_tag_supported(MpdObj *mi, int tag);


typedef enum {
    MPD_SERVER_REPLAYGAIN_MODE_OFF = 0,
    MPD_SERVER_REPLAYGAIN_MODE_TRACK = 1,
    MPD_SERVER_REPLAYGAIN_MODE_ALBUM = 2
}MpdServerReplaygainMode;

MpdServerReplaygainMode mpd_server_get_replaygain_mode(MpdObj *mi);

int mpd_server_set_replaygain_mode(MpdObj *mi, MpdServerReplaygainMode mode);

#endif

#ifdef __cplusplus
}
#endif