XMMS2
src/include/xmms/xmms_medialib.h
Go to the documentation of this file.
00001 /*  XMMS2 - X Music Multiplexer System
00002  *  Copyright (C) 2003-2011 XMMS2 Team
00003  *
00004  *  PLUGINS ARE NOT CONSIDERED TO BE DERIVED WORK !!!
00005  *
00006  *  This library is free software; you can redistribute it and/or
00007  *  modify it under the terms of the GNU Lesser General Public
00008  *  License as published by the Free Software Foundation; either
00009  *  version 2.1 of the License, or (at your option) any later version.
00010  *
00011  *  This library is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014  *  Lesser General Public License for more details.
00015  */
00016 
00017 
00018 
00019 
00020 #ifndef __XMMS_MEDIALIB_H__
00021 #define __XMMS_MEDIALIB_H__
00022 
00023 
00024 #include <glib.h>
00025 #include <xmms/xmms_object.h>
00026 
00027 #define XMMS_MEDIALIB_ENTRY_PROPERTY_MIME "mime"
00028 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ID "id"
00029 #define XMMS_MEDIALIB_ENTRY_PROPERTY_URL "url"
00030 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ARTIST "artist"
00031 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ALBUM "album"
00032 #define XMMS_MEDIALIB_ENTRY_PROPERTY_TITLE "title"
00033 #define XMMS_MEDIALIB_ENTRY_PROPERTY_YEAR "date"
00034 #define XMMS_MEDIALIB_ENTRY_PROPERTY_TRACKNR "tracknr"
00035 #define XMMS_MEDIALIB_ENTRY_PROPERTY_GENRE "genre"
00036 #define XMMS_MEDIALIB_ENTRY_PROPERTY_BITRATE "bitrate"
00037 #define XMMS_MEDIALIB_ENTRY_PROPERTY_COMMENT "comment"
00038 #define XMMS_MEDIALIB_ENTRY_PROPERTY_COMMENT_LANG "commentlang"
00039 #define XMMS_MEDIALIB_ENTRY_PROPERTY_DURATION "duration"
00040 #define XMMS_MEDIALIB_ENTRY_PROPERTY_CHANNEL "channel"
00041 #define XMMS_MEDIALIB_ENTRY_PROPERTY_CHANNELS "channels"
00042 #define XMMS_MEDIALIB_ENTRY_PROPERTY_SAMPLE_FMT "sample_format"
00043 #define XMMS_MEDIALIB_ENTRY_PROPERTY_SAMPLERATE "samplerate"
00044 #define XMMS_MEDIALIB_ENTRY_PROPERTY_LMOD "lmod"
00045 #define XMMS_MEDIALIB_ENTRY_PROPERTY_GAIN_TRACK "gain_track"
00046 #define XMMS_MEDIALIB_ENTRY_PROPERTY_GAIN_ALBUM "gain_album"
00047 #define XMMS_MEDIALIB_ENTRY_PROPERTY_PEAK_TRACK "peak_track"
00048 #define XMMS_MEDIALIB_ENTRY_PROPERTY_PEAK_ALBUM "peak_album"
00049 /** Indicates that this album is a compilation */
00050 #define XMMS_MEDIALIB_ENTRY_PROPERTY_COMPILATION "compilation"
00051 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ALBUM_ID "album_id"
00052 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ARTIST_ID "artist_id"
00053 #define XMMS_MEDIALIB_ENTRY_PROPERTY_TRACK_ID "track_id"
00054 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ADDED "added"
00055 #define XMMS_MEDIALIB_ENTRY_PROPERTY_BPM "bpm"
00056 #define XMMS_MEDIALIB_ENTRY_PROPERTY_LASTSTARTED "laststarted"
00057 #define XMMS_MEDIALIB_ENTRY_PROPERTY_SIZE "size"
00058 #define XMMS_MEDIALIB_ENTRY_PROPERTY_IS_VBR "isvbr"
00059 #define XMMS_MEDIALIB_ENTRY_PROPERTY_SUBTUNES "subtunes"
00060 #define XMMS_MEDIALIB_ENTRY_PROPERTY_CHAIN "chain"
00061 #define XMMS_MEDIALIB_ENTRY_PROPERTY_TIMESPLAYED "timesplayed"
00062 #define XMMS_MEDIALIB_ENTRY_PROPERTY_PARTOFSET "partofset"
00063 #define XMMS_MEDIALIB_ENTRY_PROPERTY_PICTURE_FRONT "picture_front"
00064 #define XMMS_MEDIALIB_ENTRY_PROPERTY_PICTURE_FRONT_MIME "picture_front_mime"
00065 #define XMMS_MEDIALIB_ENTRY_PROPERTY_STARTMS "startms"
00066 #define XMMS_MEDIALIB_ENTRY_PROPERTY_STOPMS "stopms"
00067 #define XMMS_MEDIALIB_ENTRY_PROPERTY_STATUS "status"
00068 #define XMMS_MEDIALIB_ENTRY_PROPERTY_DESCRIPTION "description"
00069 #define XMMS_MEDIALIB_ENTRY_PROPERTY_GROUPING "grouping"
00070 #define XMMS_MEDIALIB_ENTRY_PROPERTY_PERFORMER "performer"
00071 #define XMMS_MEDIALIB_ENTRY_PROPERTY_CONDUCTOR "conductor"
00072 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ARRANGER "arranger"
00073 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ORIGINAL_ARTIST "original_artist"
00074 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ALBUM_ARTIST "album_artist"
00075 #define XMMS_MEDIALIB_ENTRY_PROPERTY_PUBLISHER "publisher"
00076 #define XMMS_MEDIALIB_ENTRY_PROPERTY_COMPOSER "composer"
00077 #define XMMS_MEDIALIB_ENTRY_PROPERTY_ASIN "asin"
00078 #define XMMS_MEDIALIB_ENTRY_PROPERTY_COPYRIGHT "copyright"
00079 #define XMMS_MEDIALIB_ENTRY_PROPERTY_WEBSITE_ARTIST "website_artist"
00080 #define XMMS_MEDIALIB_ENTRY_PROPERTY_WEBSITE_FILE "website_file"
00081 #define XMMS_MEDIALIB_ENTRY_PROPERTY_WEBSITE_PUBLISHER "website_publisher"
00082 #define XMMS_MEDIALIB_ENTRY_PROPERTY_WEBSITE_COPYRIGHT "website_copyright"
00083 
00084 G_BEGIN_DECLS
00085 
00086 typedef gint32 xmms_medialib_entry_t;
00087 typedef struct xmms_medialib_session_St xmms_medialib_session_t;
00088 
00089 xmms_medialib_entry_t xmms_medialib_entry_new (xmms_medialib_session_t *session, const char *url, xmms_error_t *error);
00090 
00091 xmmsv_t *xmms_medialib_entry_property_get_value (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property);
00092 gchar *xmms_medialib_entry_property_get_str (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property);
00093 gint xmms_medialib_entry_property_get_int (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property);
00094 gboolean xmms_medialib_entry_property_set_str (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property, const gchar *value);
00095 gboolean xmms_medialib_entry_property_set_int (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property, gint value);
00096 void xmms_medialib_entry_send_added (xmms_medialib_entry_t entry);
00097 void xmms_medialib_entry_send_update (xmms_medialib_entry_t entry);
00098 gchar *xmms_medialib_url_encode (const gchar *path);
00099 
00100 #define xmms_medialib_begin() _xmms_medialib_begin(FALSE, __FILE__, __LINE__)
00101 #define xmms_medialib_begin_write() _xmms_medialib_begin(TRUE, __FILE__, __LINE__)
00102 
00103 xmms_medialib_session_t * _xmms_medialib_begin (gboolean write, const char *file, int line);
00104 void xmms_medialib_end (xmms_medialib_session_t *session);
00105 
00106 #define xmms_medialib_entry_status_set(session, e, st) xmms_medialib_entry_property_set_int_source(session, e, XMMS_MEDIALIB_ENTRY_PROPERTY_STATUS, st, 1) /** @todo: hardcoded server id might be bad? */
00107 
00108 G_END_DECLS
00109 
00110 #endif /* __XMMS_MEDIALIB_H__ */