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: localized media copyright string if applicable, formatted as UTF-8. e.g. "Evil Record Corp." */
  43 #define PA_PROP_MEDIA_COPYRIGHT                "media.copyright"
  44
  45 /** For streams: localized media generator software string if applicable, formatted as UTF-8. e.g. "Foocrop AudioFrobnicator" */
  46 #define PA_PROP_MEDIA_SOFTWARE                 "media.software"
  47
  48 /** For streams: media language if applicable, in standard POSIX format. e.g. "de_DE" */
  49 #define PA_PROP_MEDIA_LANGUAGE                 "media.language"
  50
  51 /** For streams: source filename if applicable, in URI format or local path. e.g. "/home/lennart/music/foobar.ogg" */
  52 #define PA_PROP_MEDIA_FILENAME                 "media.filename"
  53
  54 /** \cond fulldocs */
  55 /** For streams: icon for the media. A binary blob containing PNG image data */
  56 #define PA_PROP_MEDIA_ICON                     "media.icon"
  57 /** \endcond */
  58
  59 /** For streams: an XDG icon name for the media. e.g. "audio-x-mp3" */
  60 #define PA_PROP_MEDIA_ICON_NAME                "media.icon_name"
  61
  62 /** For streams: logic role of this media. One of the strings "video", "music", "game", "event", "phone", "animation", "production", "a11y" */
  63 #define PA_PROP_MEDIA_ROLE                     "media.role"
  64
  65 /** For event sound streams: XDG event sound name. e.g. "message-new-email" (Event sound streams are those with media.role set to "event") */
  66 #define PA_PROP_EVENT_ID                       "event.id"
  67
  68 /** 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." */
  69 #define PA_PROP_EVENT_DESCRIPTION              "event.description"
  70
  71 /** 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" */
  72 #define PA_PROP_EVENT_MOUSE_X                  "event.mouse.x"
  73
  74 /** 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" */
  75 #define PA_PROP_EVENT_MOUSE_Y                  "event.mouse.y"
  76
  77 /** 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" */
  78 #define PA_PROP_EVENT_MOUSE_HPOS               "event.mouse.hpos"
  79
  80 /** 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" */
  81 #define PA_PROP_EVENT_MOUSE_VPOS               "event.mouse.vpos"
  82
  83 /** 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" */
  84 #define PA_PROP_EVENT_MOUSE_BUTTON             "event.mouse.button"
  85
  86 /** For streams that belong to a window on the screen: localized window title. e.g. "Totem Music Player" */
  87 #define PA_PROP_WINDOW_NAME                    "window.name"
  88
  89 /** For streams that belong to a window on the screen: a textual id for identifying a window logically. e.g. "org.gnome.Totem.MainWindow" */
  90 #define PA_PROP_WINDOW_ID                      "window.id"
  91
  92 /** \cond fulldocs */
  93 /** For streams that belong to a window on the screen: window icon. A binary blob containing PNG image data */
  94 #define PA_PROP_WINDOW_ICON                    "window.icon"
  95 /** \endcond */
  96
  97 /** For streams that belong to a window on the screen: an XDG icon name for the window. e.g. "totem" */
  98 #define PA_PROP_WINDOW_ICON_NAME               "window.icon_name"
  99
 100 /** For streams that belong to a window on the screen: absolute horizontal window position on the screen, integer formatted as text string. e.g. "865". \since 0.9.17 */
 101 #define PA_PROP_WINDOW_X                       "window.x"
 102
 103 /** For streams that belong to a window on the screen: absolute vertical window position on the screen, integer formatted as text string. e.g. "343". \since 0.9.17 */
 104 #define PA_PROP_WINDOW_Y                       "window.y"
 105
 106 /** For streams that belong to a window on the screen: window width on the screen, integer formatted as text string. e.g. "365". \since 0.9.17 */
 107 #define PA_PROP_WINDOW_WIDTH                   "window.width"
 108
 109 /** For streams that belong to a window on the screen: window height on the screen, integer formatted as text string. e.g. "643". \since 0.9.17 */
 110 #define PA_PROP_WINDOW_HEIGHT                  "window.height"
 111
 112 /** For streams that belong to a window on the screen: relative position of the window center on the screen, 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". \since 0.9.17 */
 113 #define PA_PROP_WINDOW_HPOS                    "window.hpos"
 114
 115 /** For streams that belong to a window on the screen: relative position of the window center on the screen, float formatted as text string, ranging from 0.0 (top of the screen) to 1.0 (bottom of the screen). e.g. "0.43". \since 0.9.17 */
 116 #define PA_PROP_WINDOW_VPOS                    "window.vpos"
 117
 118 /** For streams that belong to an X11 window on the screen: the X11 display string. e.g. ":0.0" */
 119 #define PA_PROP_WINDOW_X11_DISPLAY             "window.x11.display"
 120
 121 /** 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" */
 122 #define PA_PROP_WINDOW_X11_SCREEN              "window.x11.screen"
 123
 124 /** 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" */
 125 #define PA_PROP_WINDOW_X11_MONITOR             "window.x11.monitor"
 126
 127 /** For streams that belong to an X11 window on the screen: the window XID, an integer formatted as string. e.g. "25632" */
 128 #define PA_PROP_WINDOW_X11_XID                 "window.x11.xid"
 129
 130 /** For clients/streams: localized human readable application name. e.g. "Totem Music Player" */
 131 #define PA_PROP_APPLICATION_NAME               "application.name"
 132
 133 /** For clients/streams: a textual id for identifying an application logically. e.g. "org.gnome.Totem" */
 134 #define PA_PROP_APPLICATION_ID                 "application.id"
 135
 136 /** For clients/streams: a version string e.g. "0.6.88" */
 137 #define PA_PROP_APPLICATION_VERSION            "application.version"
 138
 139 /** \cond fulldocs */
 140 /** For clients/streams: application icon. A binary blob containing PNG image data */
 141 #define PA_PROP_APPLICATION_ICON               "application.icon"
 142 /** \endcond */
 143
 144 /** For clients/streams: an XDG icon name for the application. e.g. "totem" */
 145 #define PA_PROP_APPLICATION_ICON_NAME          "application.icon_name"
 146
 147 /** For clients/streams: application language if applicable, in standard POSIX format. e.g. "de_DE" */
 148 #define PA_PROP_APPLICATION_LANGUAGE           "application.language"
 149
 150 /** For clients/streams on UNIX: application process PID, an integer formatted as string. e.g. "4711" */
 151 #define PA_PROP_APPLICATION_PROCESS_ID         "application.process.id"
 152
 153 /** For clients/streams: application process name. e.g. "totem" */
 154 #define PA_PROP_APPLICATION_PROCESS_BINARY     "application.process.binary"
 155
 156 /** For clients/streams: application user name. e.g. "lennart" */
 157 #define PA_PROP_APPLICATION_PROCESS_USER       "application.process.user"
 158
 159 /** For clients/streams: host name the application runs on. e.g. "omega" */
 160 #define PA_PROP_APPLICATION_PROCESS_HOST       "application.process.host"
 161
 162 /** For clients/streams: the D-Bus host id the application runs on. e.g. "543679e7b01393ed3e3e650047d78f6e" */
 163 #define PA_PROP_APPLICATION_PROCESS_MACHINE_ID "application.process.machine_id"
 164
 165 /** 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" */
 166 #define PA_PROP_APPLICATION_PROCESS_SESSION_ID "application.process.session_id"
 167
 168 /** For devices: device string in the underlying audio layer's format. e.g. "surround51:0" */
 169 #define PA_PROP_DEVICE_STRING                  "device.string"
 170
 171 /** For devices: API this device is access with. e.g. "alsa" */
 172 #define PA_PROP_DEVICE_API                     "device.api"
 173
 174 /** For devices: localized human readable device one-line description, e.g. "Foobar Industries USB Headset 2000+ Ultra" */
 175 #define PA_PROP_DEVICE_DESCRIPTION             "device.description"
 176
 177 /** For devices: bus path to the device in the OS' format. e.g. "/sys/bus/pci/devices/0000:00:1f.2" */
 178 #define PA_PROP_DEVICE_BUS_PATH                "device.bus_path"
 179
 180 /** For devices: serial number if applicable. e.g. "4711-0815-1234" */
 181 #define PA_PROP_DEVICE_SERIAL                  "device.serial"
 182
 183 /** For devices: vendor ID if applicable. e.g. 1274 */
 184 #define PA_PROP_DEVICE_VENDOR_ID               "device.vendor.id"
 185
 186 /** For devices: vendor name if applicable. e.g. "Foocorp Heavy Industries" */
 187 #define PA_PROP_DEVICE_VENDOR_NAME             "device.vendor.name"
 188
 189 /** For devices: product ID if applicable. e.g. 4565 */
 190 #define PA_PROP_DEVICE_PRODUCT_ID              "device.product.id"
 191
 192 /** For devices: product name if applicable. e.g. "SuperSpeakers 2000 Pro" */
 193 #define PA_PROP_DEVICE_PRODUCT_NAME            "device.product.name"
 194
 195 /** For devices: device class. One of "sound", "modem", "monitor", "filter" */
 196 #define PA_PROP_DEVICE_CLASS                   "device.class"
 197
 198 /** For devices: form factor if applicable. One of "internal", "speaker", "handset", "tv", "webcam", "microphone", "headset", "headphone", "hands-free", "car", "hifi", "computer", "portable" */
 199 #define PA_PROP_DEVICE_FORM_FACTOR             "device.form_factor"
 200
 201 /** For devices: bus of the device if applicable. One of "isa", "pci", "usb", "firewire", "bluetooth" */
 202 #define PA_PROP_DEVICE_BUS                     "device.bus"
 203
 204 /** \cond fulldocs */
 205 /** For devices: icon for the device. A binary blob containing PNG image data */
 206 #define PA_PROP_DEVICE_ICON                    "device.icon"
 207 /** \endcond */
 208
 209 /** For devices: an XDG icon name for the device. e.g. "sound-card-speakers-usb" */
 210 #define PA_PROP_DEVICE_ICON_NAME               "device.icon_name"
 211
 212 /** For devices: access mode of the device if applicable. One of "mmap", "mmap_rewrite", "serial" */
 213 #define PA_PROP_DEVICE_ACCESS_MODE             "device.access_mode"
 214
 215 /** For filter devices: master device id if applicable. */
 216 #define PA_PROP_DEVICE_MASTER_DEVICE           "device.master_device"
 217
 218 /** For devices: buffer size in bytes, integer formatted as string. */
 219 #define PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE   "device.buffering.buffer_size"
 220
 221 /** For devices: fragment size in bytes, integer formatted as string. */
 222 #define PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE "device.buffering.fragment_size"
 223
 224 /** For devices: profile identifier for the profile this devices is in. e.g. "analog-stereo", "analog-surround-40", "iec958-stereo", ...*/
 225 #define PA_PROP_DEVICE_PROFILE_NAME            "device.profile.name"
 226
 227 /** For devices: intended use. A comma seperated list of roles (see PA_PROP_MEDIA_ROLE) this device is particularly well suited for, due to latency, quality or form factor. \since 0.9.16 */
 228 #define PA_PROP_DEVICE_INTENDED_ROLES          "device.intended_roles"
 229
 230 /** For devices: human readable one-line description of the profile this device is in. e.g. "Analog Stereo", ... */
 231 #define PA_PROP_DEVICE_PROFILE_DESCRIPTION     "device.profile.description"
 232
 233 /** For modules: the author's name, formatted as UTF-8 string. e.g. "Lennart Poettering" */
 234 #define PA_PROP_MODULE_AUTHOR                  "module.author"
 235
 236 /** 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" */
 237 #define PA_PROP_MODULE_DESCRIPTION             "module.description"
 238
 239 /** For modules: a human readable usage description of the module's arguments formatted as UTF-8. */
 240 #define PA_PROP_MODULE_USAGE                   "module.usage"
 241
 242 /** For modules: a version string for the module. e.g. "0.9.15" */
 243 #define PA_PROP_MODULE_VERSION                 "module.version"
 244
 245 /** A property list object. Basically a dictionary with ASCII strings
 246  * as keys and arbitrary data as values. \since 0.9.11 */
 247 typedef struct pa_proplist pa_proplist;
 248
 249 /** Allocate a property list. \since 0.9.11 */
 250 pa_proplist* pa_proplist_new(void);
 251
 252 /** Free the property list. \since 0.9.11 */
 253 void pa_proplist_free(pa_proplist* p);
 254
 255 /** Append a new string entry to the property list, possibly
 256  * overwriting an already existing entry with the same key. An
 257  * internal copy of the data passed is made. Will accept only valid
 258  * UTF-8. \since 0.9.11 */
 259 int pa_proplist_sets(pa_proplist *p, const char *key, const char *value);
 260
 261 /** Append a new string entry to the property list, possibly
 262  * overwriting an already existing entry with the same key. An
 263  * internal copy of the data passed is made. Will accept only valid
 264  * UTF-8. The string passed in must contain a '='. Left hand side of
 265  * the '=' is used as key name, the right hand side as string
 266  * data. \since 0.9.16 */
 267 int pa_proplist_setp(pa_proplist *p, const char *pair);
 268
 269 /** Append a new string entry to the property list, possibly
 270  * overwriting an already existing entry with the same key. An
 271  * internal copy of the data passed is made. Will accept only valid
 272  * UTF-8. The data can be passed as printf()-style format string with
 273  * arguments. \since 0.9.11 */
 274 int pa_proplist_setf(pa_proplist *p, const char *key, const char *format, ...) PA_GCC_PRINTF_ATTR(3,4);
 275
 276 /** Append a new arbitrary data entry to the property list, possibly
 277  * overwriting an already existing entry with the same key. An
 278  * internal copy of the data passed is made. \since 0.9.11 */
 279 int pa_proplist_set(pa_proplist *p, const char *key, const void *data, size_t nbytes);
 280
 281 /** Return a string entry for the specified key. Will return NULL if
 282  * the data is not valid UTF-8. Will return a NUL-terminated string in
 283  * an internally allocated buffer. The caller should make a copy of
 284  * the data before accessing the property list again. \since 0.9.11 */
 285 const char *pa_proplist_gets(pa_proplist *p, const char *key);
 286
 287 /** Return the the value for the specified key. Will return a
 288  * NUL-terminated string for string entries. The pointer returned will
 289  * point to an internally allocated buffer. The caller should make a
 290  * copy of the data before the property list is accessed again. \since
 291  * 0.9.11 */
 292 int pa_proplist_get(pa_proplist *p, const char *key, const void **data, size_t *nbytes);
 293
 294 /** Update mode enum for pa_proplist_update(). \since 0.9.11 */
 295 typedef enum pa_update_mode {
 296     PA_UPDATE_SET
 297     /**< Replace the entire property list with the new one. Don't keep
 298      *  any of the old data around */,
 299
 300     PA_UPDATE_MERGE
 301     /**< Merge new property list into the existing one, not replacing
 302      *  any old entries if they share a common key with the new
 303      *  property list. */,
 304
 305     PA_UPDATE_REPLACE
 306     /**< Merge new property list into the existing one, replacing all
 307      *  old entries that share a common key with the new property
 308      *  list. */
 309 } pa_update_mode_t;
 310
 311 /** \cond fulldocs */
 312 #define PA_UPDATE_SET PA_UPDATE_SET
 313 #define PA_UPDATE_MERGE PA_UPDATE_MERGE
 314 #define PA_UPDATE_REPLACE PA_UPDATE_REPLACE
 315 /** \endcond */
 316
 317 /** Merge property list "other" into "p", adhering the merge mode as
 318  * specified in "mode". \since 0.9.11 */
 319 void pa_proplist_update(pa_proplist *p, pa_update_mode_t mode, pa_proplist *other);
 320
 321 /** Removes a single entry from the property list, identified be the
 322  * specified key name. \since 0.9.11 */
 323 int pa_proplist_unset(pa_proplist *p, const char *key);
 324
 325 /** Similar to pa_proplist_remove() but takes an array of keys to
 326  * remove. The array should be terminated by a NULL pointer. Return -1
 327  * on failure, otherwise the number of entries actually removed (which
 328  * might even be 0, if there where no matching entries to
 329  * remove). \since 0.9.11 */
 330 int pa_proplist_unset_many(pa_proplist *p, const char * const keys[]);
 331
 332 /** Iterate through the property list. The user should allocate a
 333  * state variable of type void* and initialize it with NULL. A pointer
 334  * to this variable should then be passed to pa_proplist_iterate()
 335  * which should be called in a loop until it returns NULL which
 336  * signifies EOL. The property list should not be modified during
 337  * iteration through the list -- except for deleting the current
 338  * looked at entry. On each invication this function will return the
 339  * key string for the next entry. The keys in the property list do not
 340  * have any particular order. \since 0.9.11 */
 341 const char *pa_proplist_iterate(pa_proplist *p, void **state);
 342
 343 /** Format the property list nicely as a human readable string. This
 344  * works very much like pa_proplist_to_string_sep() and uses a newline
 345  * as seperator and appends one final one. Call pa_xfree() on the
 346  * result. \since 0.9.11 */
 347 char *pa_proplist_to_string(pa_proplist *p);
 348
 349 /** Format the property list nicely as a human readable string and
 350  * choose the seperator. Call pa_xfree() on the result. \since
 351  * 0.9.15 */
 352 char *pa_proplist_to_string_sep(pa_proplist *p, const char *sep);
 353
 354 /** Allocate a new property list and assign key/value from a human
 355  * readable string. \since 0.9.15 */
 356 pa_proplist *pa_proplist_from_string(const char *str);
 357
 358   /** Returns 1 if an entry for the specified key is existant in the
 359  * property list. \since 0.9.11 */
 360 int pa_proplist_contains(pa_proplist *p, const char *key);
 361
 362 /** Remove all entries from the property list object. \since 0.9.11 */
 363 void pa_proplist_clear(pa_proplist *p);
 364
 365 /** Allocate a new property list and copy over every single entry from
 366  * the specific list. \since 0.9.11 */
 367 pa_proplist* pa_proplist_copy(pa_proplist *t);
 368
 369 /** Return the number of entries on the property list. \since 0.9.15 */
 370 unsigned pa_proplist_size(pa_proplist *t);
 371
 372 /** Returns 0 when the proplist is empty, positive otherwise \since 0.9.15 */
 373 int pa_proplist_isempty(pa_proplist *t);
 374
 375 PA_C_DECL_END
 376
 377 #endif