code.delx.au - pulseaudio/blob - src/pulse/proplist.h

   1 #ifndef foopulseproplisthfoo
   2 #define foopulseproplisthfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2007 Lennart Poettering
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as
  11   published by the Free Software Foundation; either version 2.1 of the
  12   License, or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public
  20   License along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <sys/types.h>
  26
  27 #include <pulse/cdecl.h>
  28 #include <pulse/gccmacro.h>
  29 #include <pulse/version.h>
  30
  31 PA_C_DECL_BEGIN
  32
  33 /** For streams: localized media name, formatted as UTF-8. e.g. "Guns'N'Roses: Civil War".*/
  34 #define PA_PROP_MEDIA_NAME                     "media.name"
  35
  36 /** For streams: localized media title if applicable, formatted as UTF-8. e.g. "Civil War" */
  37 #define PA_PROP_MEDIA_TITLE                    "media.title"
  38
  39 /** For streams: localized media artist if applicable, formatted as UTF-8. e.g. "Guns'N'Roses" */
  40 #define PA_PROP_MEDIA_ARTIST                   "media.artist"
  41
  42 /** For streams: media language if applicable, in standard POSIX format. e.g. "de_DE" */
  43 #define PA_PROP_MEDIA_LANGUAGE                 "media.language"
  44
  45 /** For streams: source filename if applicable, in URI format or local path. e.g. "/home/lennart/music/foobar.ogg" */
  46 #define PA_PROP_MEDIA_FILENAME                 "media.filename"
  47
  48 /** \cond fulldocs */
  49 /** For streams: icon for the media. A binary blob containing PNG image data */
  50 #define PA_PROP_MEDIA_ICON                     "media.icon"
  51 /** \endcond */
  52
  53 /** For streams: an XDG icon name for the media. e.g. "audio-x-mp3" */
  54 #define PA_PROP_MEDIA_ICON_NAME                "media.icon_name"
  55
  56 /** For streams: logic role of this media. One of the strings "video", "music", "game", "event", "phone", "animation", "production", "a11y" */
  57 #define PA_PROP_MEDIA_ROLE                     "media.role"
  58
  59 /** For event sound streams: XDG event sound name. e.g. "message-new-email" (Event sound streams are those with media.role set to "event") */
  60 #define PA_PROP_EVENT_ID                       "event.id"
  61
  62 /** For event sound streams: localized human readable one-line description of the event, formatted as UTF-8. e.g. "Email from lennart@example.com received." */
  63 #define PA_PROP_EVENT_DESCRIPTION              "event.description"
  64
  65 /** For event sound streams: absolute horizontal mouse position on the screen if the event sound was triggered by a mouse click, integer formatted as text string. e.g. "865" */
  66 #define PA_PROP_EVENT_MOUSE_X                  "event.mouse.x"
  67
  68 /** For event sound streams: absolute vertical mouse position on the screen if the event sound was triggered by a mouse click, integer formatted as text string. e.g. "432" */
  69 #define PA_PROP_EVENT_MOUSE_Y                  "event.mouse.y"
  70
  71 /** For event sound streams: relative horizontal mouse position on the screen if the event sound was triggered by a mouse click, float formatted as text string, ranging from 0.0 (left side of the screen) to 1.0 (right side of the screen). e.g. "0.65" */
  72 #define PA_PROP_EVENT_MOUSE_HPOS               "event.mouse.hpos"
  73
  74 /** For event sound streams: relative vertical mouse position on the screen if the event sound was triggered by a mouse click, float formatted as text string, ranging from 0.0 (top of the screen) to 1.0 (bottom of the screen). e.g. "0.43" */
  75 #define PA_PROP_EVENT_MOUSE_VPOS               "event.mouse.vpos"
  76
  77 /** For event sound streams: mouse button that triggered the event if applicable, integer formatted as string with 0=left, 1=middle, 2=right. e.g. "0" */
  78 #define PA_PROP_EVENT_MOUSE_BUTTON             "event.mouse.button"
  79
  80 /** For streams that belong to a window on the screen: localized window title. e.g. "Totem Music Player" */
  81 #define PA_PROP_WINDOW_NAME                    "window.name"
  82
  83 /** For streams that belong to a window on the screen: a textual id for identifying a window logically. e.g. "org.gnome.Totem.MainWindow" */
  84 #define PA_PROP_WINDOW_ID                      "window.id"
  85
  86 /** \cond fulldocs */
  87 /** For streams that belong to a window on the screen: window icon. A binary blob containing PNG image data */
  88 #define PA_PROP_WINDOW_ICON                    "window.icon"
  89 /** \endcond */
  90
  91 /** For streams that belong to a window on the screen: an XDG icon name for the window. e.g. "totem" */
  92 #define PA_PROP_WINDOW_ICON_NAME               "window.icon_name"
  93
  94 /** For streams that belong to an X11 window on the screen: the X11 display string. e.g. ":0.0" */
  95 #define PA_PROP_WINDOW_X11_DISPLAY             "window.x11.display"
  96
  97 /** For streams that belong to an X11 window on the screen: the X11 screen the window is on, an integer formatted as string. e.g. "0" */
  98 #define PA_PROP_WINDOW_X11_SCREEN              "window.x11.screen"
  99
 100 /** For streams that belong to an X11 window on the screen: the X11 monitor the window is on, an integer formatted as string. e.g. "0" */
 101 #define PA_PROP_WINDOW_X11_MONITOR             "window.x11.monitor"
 102
 103 /** For streams that belong to an X11 window on the screen: the window XID, an integer formatted as string. e.g. "25632" */
 104 #define PA_PROP_WINDOW_X11_XID                 "window.x11.xid"
 105
 106 /** For clients/streams: localized human readable application name. e.g. "Totem Music Player" */
 107 #define PA_PROP_APPLICATION_NAME               "application.name"
 108
 109 /** For clients/streams: a textual id for identifying an application logically. e.g. "org.gnome.Totem" */
 110 #define PA_PROP_APPLICATION_ID                 "application.id"
 111
 112 /** For clients/streams: a version string e.g. "0.6.88" */
 113 #define PA_PROP_APPLICATION_VERSION            "application.version"
 114
 115 /** \cond fulldocs */
 116 /** For clients/streams: application icon. A binary blob containing PNG image data */
 117 #define PA_PROP_APPLICATION_ICON               "application.icon"
 118 /** \endcond */
 119
 120 /** For clients/streams: an XDG icon name for the application. e.g. "totem" */
 121 #define PA_PROP_APPLICATION_ICON_NAME          "application.icon_name"
 122
 123 /** For clients/streams: application language if applicable, in standard POSIX format. e.g. "de_DE" */
 124 #define PA_PROP_APPLICATION_LANGUAGE           "application.language"
 125
 126 /** For clients/streams on UNIX: application process PID, an integer formatted as string. e.g. "4711" */
 127 #define PA_PROP_APPLICATION_PROCESS_ID         "application.process.id"
 128
 129 /** For clients/streams: application process name. e.g. "totem" */
 130 #define PA_PROP_APPLICATION_PROCESS_BINARY     "application.process.binary"
 131
 132 /** For clients/streams: application user name. e.g. "lennart" */
 133 #define PA_PROP_APPLICATION_PROCESS_USER       "application.process.user"
 134
 135 /** For clients/streams: host name the application runs on. e.g. "omega" */
 136 #define PA_PROP_APPLICATION_PROCESS_HOST       "application.process.host"
 137
 138 /** For clients/streams: the D-Bus host id the application runs on. e.g. "543679e7b01393ed3e3e650047d78f6e" */
 139 #define PA_PROP_APPLICATION_PROCESS_MACHINE_ID "application.process.machine_id"
 140
 141 /** For clients/streams: an id for the login session the application runs in. On Unix the value of $XDG_SESSION_COOKIE. e.g. "543679e7b01393ed3e3e650047d78f6e-1235159798.76193-190367717" */
 142 #define PA_PROP_APPLICATION_PROCESS_SESSION_ID "application.process.session_id"
 143
 144 /** For devices: device string in the underlying audio layer's format. e.g. "surround51:0" */
 145 #define PA_PROP_DEVICE_STRING                  "device.string"
 146
 147 /** For devices: API this device is access with. e.g. "alsa" */
 148 #define PA_PROP_DEVICE_API                     "device.api"
 149
 150 /** For devices: localized human readable device one-line description, e.g. "Foobar Industries USB Headset 2000+ Ultra" */
 151 #define PA_PROP_DEVICE_DESCRIPTION             "device.description"
 152
 153 /** For devices: bus path to the device in the OS' format. e.g. "/sys/bus/pci/devices/0000:00:1f.2" */
 154 #define PA_PROP_DEVICE_BUS_PATH                "device.bus_path"
 155
 156 /** For devices: serial number if applicable. e.g. "4711-0815-1234" */
 157 #define PA_PROP_DEVICE_SERIAL                  "device.serial"
 158
 159 /** For devices: vendor ID if applicable. e.g. 1274 */
 160 #define PA_PROP_DEVICE_VENDOR_ID               "device.vendor.id"
 161
 162 /** For devices: vendor name if applicable. e.g. "Foocorp Heavy Industries" */
 163 #define PA_PROP_DEVICE_VENDOR_NAME             "device.vendor.name"
 164
 165 /** For devices: product ID if applicable. e.g. 4565 */
 166 #define PA_PROP_DEVICE_PRODUCT_ID              "device.product.id"
 167
 168 /** For devices: product name if applicable. e.g. "SuperSpeakers 2000 Pro" */
 169 #define PA_PROP_DEVICE_PRODUCT_NAME            "device.product.name"
 170
 171 /** For devices: device class. One of "sound", "modem", "monitor", "filter" */
 172 #define PA_PROP_DEVICE_CLASS                   "device.class"
 173
 174 /** For devices: form factor if applicable. One of "internal", "speaker", "handset", "tv", "webcam", "microphone", "headset", "headphone", "hands-free", "car", "hifi", "computer", "portable" */
 175 #define PA_PROP_DEVICE_FORM_FACTOR             "device.form_factor"
 176
 177 /** For devices: bus of the device if applicable. One of "isa", "pci", "usb", "firewire", "bluetooth" */
 178 #define PA_PROP_DEVICE_BUS                     "device.bus"
 179
 180 /** \cond fulldocs */
 181 /** For devices: icon for the device. A binary blob containing PNG image data */
 182 #define PA_PROP_DEVICE_ICON                    "device.icon"
 183 /** \endcond */
 184
 185 /** For devices: an XDG icon name for the device. e.g. "sound-card-speakers-usb" */
 186 #define PA_PROP_DEVICE_ICON_NAME               "device.icon_name"
 187
 188 /** For devices: access mode of the device if applicable. One of "mmap", "mmap_rewrite", "serial" */
 189 #define PA_PROP_DEVICE_ACCESS_MODE             "device.access_mode"
 190
 191 /** For filter devices: master device id if applicable. */
 192 #define PA_PROP_DEVICE_MASTER_DEVICE           "device.master_device"
 193
 194 /** For devices: buffer size in bytes, integer formatted as string.. */
 195 #define PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE   "device.buffering.buffer_size"
 196
 197 /** For devices: fragment size in bytes, integer formatted as string. */
 198 #define PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE "device.buffering.fragment_size"
 199
 200 /** For devices: profile identifier for the profile this devices is in. e.g. "analog-stereo", "analog-surround-40", "iec958-stereo", ...*/
 201 #define PA_PROP_DEVICE_PROFILE_NAME            "device.profile.name"
 202
 203 /** For devices: human readable one-line description of the profile this device is in. e.g. "Analog Stereo", ... */
 204 #define PA_PROP_DEVICE_PROFILE_DESCRIPTION     "device.profile.description"
 205
 206 /** For modules: the author's name, formatted as UTF-8 string. e.g. "Lennart Poettering" */
 207 #define PA_PROP_MODULE_AUTHOR                  "module.author"
 208
 209 /** For modules: a human readable one-line description of the module's purpose formatted as UTF-8. e.g. "Frobnicate sounds with a flux compensator" */
 210 #define PA_PROP_MODULE_DESCRIPTION             "module.description"
 211
 212 /** For modules: a human readable usage description of the module's arguments formatted as UTF-8. */
 213 #define PA_PROP_MODULE_USAGE                   "module.usage"
 214
 215 /** For modules: a version string for the module. e.g. "0.9.15" */
 216 #define PA_PROP_MODULE_VERSION                 "module.version"
 217
 218 /** A property list object. Basically a dictionary with ASCII strings
 219  * as keys and arbitrary data as values. \since 0.9.11 */
 220 typedef struct pa_proplist pa_proplist;
 221
 222 /** Allocate a property list. \since 0.9.11 */
 223 pa_proplist* pa_proplist_new(void);
 224
 225 /** Free the property list. \since 0.9.11 */
 226 void pa_proplist_free(pa_proplist* p);
 227
 228 /** Append a new string entry to the property list, possibly
 229  * overwriting an already existing entry with the same key. An
 230  * internal copy of the data passed is made. Will accept only valid
 231  * UTF-8. \since 0.9.11 */
 232 int pa_proplist_sets(pa_proplist *p, const char *key, const char *value);
 233
 234 /** Append a new string entry to the property list, possibly
 235  * overwriting an already existing entry with the same key. An
 236  * internal copy of the data passed is made. Will accept only valid
 237  * UTF-8. The data can be passed as printf()-style format string with
 238  * arguments. \since 0.9.11 */
 239 int pa_proplist_setf(pa_proplist *p, const char *key, const char *format, ...) PA_GCC_PRINTF_ATTR(3,4);
 240
 241 /** Append a new arbitrary data entry to the property list, possibly
 242  * overwriting an already existing entry with the same key. An
 243  * internal copy of the data passed is made. \since 0.9.11 */
 244 int pa_proplist_set(pa_proplist *p, const char *key, const void *data, size_t nbytes);
 245
 246 /** Return a string entry for the specified key. Will return NULL if
 247  * the data is not valid UTF-8. Will return a NUL-terminated string in
 248  * an internally allocated buffer. The caller should make a copy of
 249  * the data before accessing the property list again. \since 0.9.11 */
 250 const char *pa_proplist_gets(pa_proplist *p, const char *key);
 251
 252 /** Return the the value for the specified key. Will return a
 253  * NUL-terminated string for string entries. The pointer returned will
 254  * point to an internally allocated buffer. The caller should make a
 255  * copy of the data before the property list is accessed again. \since
 256  * 0.9.11 */
 257 int pa_proplist_get(pa_proplist *p, const char *key, const void **data, size_t *nbytes);
 258
 259 /** Update mode enum for pa_proplist_update(). \since 0.9.11 */
 260 typedef enum pa_update_mode {
 261     PA_UPDATE_SET
 262     /**< Replace the entirey property list with the new one. Don't keep
 263      *  any of the old data around */,
 264
 265     PA_UPDATE_MERGE
 266     /**< Merge new property list into the existing one, not replacing
 267      *  any old entries if they share a common key with the new
 268      *  property list. */,
 269
 270     PA_UPDATE_REPLACE
 271     /**< Merge new property list into the existing one, replacing all
 272      *  old entries that share a common key with the new property
 273      *  list. */
 274 } pa_update_mode_t;
 275
 276 /** \cond fulldocs */
 277 #define PA_UPDATE_SET PA_UPDATE_SET
 278 #define PA_UPDATE_MERGE PA_UPDATE_MERGE
 279 #define PA_UPDATE_REPLACE PA_UPDATE_REPLACE
 280 /** \endcond */
 281
 282 /** Merge property list "other" into "p", adhering the merge mode as
 283  * specified in "mode". \since 0.9.11 */
 284 void pa_proplist_update(pa_proplist *p, pa_update_mode_t mode, pa_proplist *other);
 285
 286 /** Removes a single entry from the property list, identified be the
 287  * specified key name. \since 0.9.11 */
 288 int pa_proplist_unset(pa_proplist *p, const char *key);
 289
 290 /** Similar to pa_proplist_remove() but takes an array of keys to
 291  * remove. The array should be terminated by a NULL pointer. Return -1
 292  * on failure, otherwise the number of entries actually removed (which
 293  * might even be 0, if there where no matching entries to
 294  * remove). \since 0.9.11 */
 295 int pa_proplist_unset_many(pa_proplist *p, const char * const keys[]);
 296
 297 /** Iterate through the property list. The user should allocate a
 298  * state variable of type void* and initialize it with NULL. A pointer
 299  * to this variable should then be passed to pa_proplist_iterate()
 300  * which should be called in a loop until it returns NULL which
 301  * signifies EOL. The property list should not be modified during
 302  * iteration through the list -- except for deleting the current
 303  * looked at entry. On each invication this function will return the
 304  * key string for the next entry. The keys in the property list do not
 305  * have any particular order. \since 0.9.11 */
 306 const char *pa_proplist_iterate(pa_proplist *p, void **state);
 307
 308 /** Format the property list nicely as a human readable string. This
 309  * works very much like pa_proplist_to_string_sep() and uses a newline
 310  * as seperator and appends one final one. Call pa_xfree() on the
 311  * result. \since 0.9.11 */
 312 char *pa_proplist_to_string(pa_proplist *p);
 313
 314 /** Format the property list nicely as a human readable string and
 315  * choose the seperator. Call pa_xfree() on the result. \since
 316  * 0.9.15 */
 317 char *pa_proplist_to_string_sep(pa_proplist *p, const char *sep);
 318
 319 /** Allocate a new property list and assign key/value from a human
 320  * readable string. \since 0.9.15 */
 321 pa_proplist *pa_proplist_from_string(const char *str);
 322
 323   /** Returns 1 if an entry for the specified key is existant in the
 324  * property list. \since 0.9.11 */
 325 int pa_proplist_contains(pa_proplist *p, const char *key);
 326
 327 /** Remove all entries from the property list object. \since 0.9.11 */
 328 void pa_proplist_clear(pa_proplist *p);
 329
 330 /** Allocate a new property list and copy over every single entry from
 331  * the specific list. \since 0.9.11 */
 332 pa_proplist* pa_proplist_copy(pa_proplist *t);
 333
 334 /** Return the number of entries on the property list. \since 0.9.15 */
 335 unsigned pa_proplist_size(pa_proplist *t);
 336
 337 /** Returns 0 when the proplist is empty, positive otherwise \since 0.9.15 */
 338 int pa_proplist_isempty(pa_proplist *t);
 339
 340 PA_C_DECL_END
 341
 342 #endif