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