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
  30 PA_C_DECL_BEGIN
  31
  32 /* Defined properties:
  33  *
  34  *    media.name                    "Guns'N'Roses: Civil War"
  35  *    media.title                   "Civil War"
  36  *    media.artist                  "Guns'N'Roses"
  37  *    media.language                "de_DE"
  38  *    media.filename
  39  *    media.icon                    Binary blob containing PNG icon data
  40  *    media.icon_name               Name from XDG icon naming spec
  41  *    media.role                    video, music, game, event, phone, production, filter, abstract, stream
  42  *    event.id                      Name from XDG sound naming spec
  43  *    event.description             "Button blabla clicked" for a11y
  44  *    event.mouse.x
  45  *    event.mouse.y
  46  *    event.mouse.hpos              Float formatted as string in range 0..1
  47  *    event.mouse.vpos              Float formatted as string in range 0..1
  48  *    event.mouse.button            Button number following X11 ordering
  49  *    window.name
  50  *    window.id                     "org.gnome.rhytmbox.MainWindow"
  51  *    window.icon                   Binary blob containing PNG icon data
  52  *    window.icon_name              Name from XDG icon naming spec
  53  *    window.x11.display
  54  *    window.x11.screen
  55  *    window.x11.monitor
  56  *    window.x11.xid
  57  *    application.name              "Rhythmbox Media Player"
  58  *    application.id                "org.gnome.rhythmbox"
  59  *    application.version
  60  *    application.icon              Binary blob containing PNG icon data
  61  *    application.icon_name         Name from XDG icon naming spec
  62  *    application.language
  63  *    application.process.id
  64  *    application.process.binary
  65  *    application.process.user
  66  *    application.process.host
  67  *    device.string
  68  *    device.api                    oss, alsa, sunaudio
  69  *    device.description
  70  *    device.bus_path
  71  *    device.serial
  72  *    device.vendor_product_id
  73  *    device.class                  sound, modem, monitor, filter, abstract
  74  *    device.form_factor            laptop-speakers, external-speakers, telephone, tv-capture, webcam-capture, microphone-capture, headset
  75  *    device.connector              isa, pci, usb, firewire, bluetooth
  76  *    device.access_mode            mmap, mmap_rewrite, serial
  77  *    device.master_device
  78  *    device.bufferin.buffer_size
  79  *    device.bufferin.fragment_size
  80  */
  81 #define PA_PROP_MEDIA_NAME                     "media.name"
  82 #define PA_PROP_MEDIA_TITLE                    "media.title"
  83 #define PA_PROP_MEDIA_ARTIST                   "media.artist"
  84 #define PA_PROP_MEDIA_LANGUAGE                 "media.language"
  85 #define PA_PROP_MEDIA_FILENAME                 "media.filename"
  86 #define PA_PROP_MEDIA_ICON                     "media.icon"
  87 #define PA_PROP_MEDIA_ICON_NAME                "media.icon_name"
  88 #define PA_PROP_MEDIA_ROLE                     "media.role"
  89 #define PA_PROP_EVENT_ID                       "event.id"
  90 #define PA_PROP_EVENT_DESCRIPTION              "event.description"
  91 #define PA_PROP_EVENT_MOUSE_X                  "event.mouse.x"
  92 #define PA_PROP_EVENT_MOUSE_Y                  "event.mouse.y"
  93 #define PA_PROP_EVENT_MOUSE_HPOS               "event.mouse.hpos"
  94 #define PA_PROP_EVENT_MOUSE_VPOS               "event.mouse.vpos"
  95 #define PA_PROP_EVENT_MOUSE_BUTTON             "event.mouse.button"
  96 #define PA_PROP_WINDOW_NAME                    "window.name"
  97 #define PA_PROP_WINDOW_ID                      "window.id"
  98 #define PA_PROP_WINDOW_ICON                    "window.icon"
  99 #define PA_PROP_WINDOW_ICON_NAME               "window.icon_name"
 100 #define PA_PROP_WINDOW_X11_DISPLAY             "window.x11.display"
 101 #define PA_PROP_WINDOW_X11_SCREEN              "window.x11.screen"
 102 #define PA_PROP_WINDOW_X11_MONITOR             "window.x11.monitor"
 103 #define PA_PROP_WINDOW_X11_XID                 "window.x11.xid"
 104 #define PA_PROP_APPLICATION_NAME               "application.name"
 105 #define PA_PROP_APPLICATION_ID                 "application.id"
 106 #define PA_PROP_APPLICATION_VERSION            "application.version"
 107 #define PA_PROP_APPLICATION_ICON               "application.icon"
 108 #define PA_PROP_APPLICATION_ICON_NAME          "application.icon_name"
 109 #define PA_PROP_APPLICATION_LANGUAGE           "application.language"
 110 #define PA_PROP_APPLICATION_PROCESS_ID         "application.process.id"
 111 #define PA_PROP_APPLICATION_PROCESS_BINARY     "application.process.binary"
 112 #define PA_PROP_APPLICATION_PROCESS_USER       "application.process.user"
 113 #define PA_PROP_APPLICATION_PROCESS_HOST       "application.process.host"
 114 #define PA_PROP_DEVICE_STRING                  "device.string"
 115 #define PA_PROP_DEVICE_API                     "device.api"
 116 #define PA_PROP_DEVICE_DESCRIPTION             "device.description"
 117 #define PA_PROP_DEVICE_BUS_PATH                "device.bus_path"
 118 #define PA_PROP_DEVICE_SERIAL                  "device.serial"
 119 #define PA_PROP_DEVICE_VENDOR_PRODUCT_ID       "device.vendor_product_id"
 120 #define PA_PROP_DEVICE_CLASS                   "device.class"
 121 #define PA_PROP_DEVICE_FORM_FACTOR             "device.form_factor"
 122 #define PA_PROP_DEVICE_CONNECTOR               "device.connector"
 123 #define PA_PROP_DEVICE_ACCESS_MODE             "device.access_mode"
 124 #define PA_PROP_DEVICE_MASTER_DEVICE           "device.master_device"
 125 #define PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE   "device.buffering.buffer_size"
 126 #define PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE "device.buffering.fragment_size"
 127
 128 /** A property list object. Basically a dictionary with UTF-8 strings
 129  * as keys and arbitrary data as values. \since 0.9.11 */
 130 typedef struct pa_proplist pa_proplist;
 131
 132 /** Allocate a property list. \since 0.9.11 */
 133 pa_proplist* pa_proplist_new(void);
 134
 135 /** Free the property list. \since 0.9.11 */
 136 void pa_proplist_free(pa_proplist* p);
 137
 138 /** Append a new string entry to the property list, possibly
 139  * overwriting an already existing entry with the same key. An
 140  * internal copy of the data passed is made. Will accept only valid
 141  * UTF-8. \since 0.9.11 */
 142 int pa_proplist_sets(pa_proplist *p, const char *key, const char *value);
 143
 144 /** Append a new string entry to the property list, possibly
 145  * overwriting an already existing entry with the same key. An
 146  * internal copy of the data passed is made. Will accept only valid
 147  * UTF-8. The data can be passed as printf()-style format string with
 148  * arguments. \since 0.9.11 */
 149 int pa_proplist_setf(pa_proplist *p, const char *key, const char *format, ...) PA_GCC_PRINTF_ATTR(3,4);
 150
 151 /** Append a new arbitrary data entry to the property list, possibly
 152  * overwriting an already existing entry with the same key. An
 153  * internal copy of the data passed is made. \since 0.9.11 */
 154 int pa_proplist_set(pa_proplist *p, const char *key, const void *data, size_t nbytes);
 155
 156 /* Return a string entry for the specified key. Will return NULL if
 157  * the data is not valid UTF-8. Will return a NUL-terminated string in
 158  * an internally allocated buffer. The caller should make a copy of
 159  * the data before accessing the property list again. \since 0.9.11 */
 160 const char *pa_proplist_gets(pa_proplist *p, const char *key);
 161
 162 /** Return the the value for the specified key. Will return a
 163  * NUL-terminated string for string entries. The pointer returned will
 164  * point to an internally allocated buffer. The caller should make a
 165  * copy of the data before the property list is accessed again. \since
 166  * 0.9.11 */
 167 int pa_proplist_get(pa_proplist *p, const char *key, const void **data, size_t *nbytes);
 168
 169 /** Update mode enum for pa_proplist_update(). \since 0.9.11 */
 170 typedef enum pa_update_mode {
 171     PA_UPDATE_SET,
 172     /*< Replace the entirey property list with the new one. Don't keep
 173      *  any of the old data around */
 174
 175     PA_UPDATE_MERGE,
 176     /*< Merge new property list into the existing one, not replacing
 177      *  any old entries if they share a common key with the new
 178      *  property list. */
 179
 180     PA_UPDATE_REPLACE
 181     /*< Merge new property list into the existing one, replacing all
 182      *  old entries that share a common key with the new property
 183      *  list. */
 184 } pa_update_mode_t;
 185
 186 /** Merge property list "other" into "p", adhering the merge mode as
 187  * specified in "mode". \since 0.9.11 */
 188 void pa_proplist_update(pa_proplist *p, pa_update_mode_t mode, pa_proplist *other);
 189
 190 /** Removes a single entry from the property list, identified be the
 191  * specified key name. \since 0.9.11 */
 192 int pa_proplist_unset(pa_proplist *p, const char *key);
 193
 194 /** Similar to pa_proplist_remove() but takes an array of keys to
 195  * remove. The array should be terminated by a NULL pointer. Return -1
 196  * on failure, otherwise the number of entries actually removed (which
 197  * might even be 0, if there where no matching entries to
 198  * remove). \since 0.9.11 */
 199 int pa_proplist_unset_many(pa_proplist *p, const char * const keys[]);
 200
 201 /** Iterate through the property list. The user should allocate a
 202  * state variable of type void* and initialize it with NULL. A pointer
 203  * to this variable should then be passed to pa_proplist_iterate()
 204  * which should be called in a loop until it returns NULL which
 205  * signifies EOL. The property list should not be modified during
 206  * iteration through the list -- except for deleting the current
 207  * looked at entry. On each invication this function will return the
 208  * key string for the next entry. The keys in the property list do not
 209  * have any particular order. \since 0.9.11 */
 210 const char *pa_proplist_iterate(pa_proplist *p, void **state);
 211
 212 /** Format the property list nicely as a human readable string. Call pa_xfree() on the result. \since
 213  * 0.9.11 */
 214 char *pa_proplist_to_string(pa_proplist *p);
 215
 216 /** Returns 1 if an entry for the specified key is existant in the
 217  * property list. \since 0.9.11 */
 218 int pa_proplist_contains(pa_proplist *p, const char *key);
 219
 220 /** Remove all entries from the property list object. \since 0.9.11 */
 221 void pa_proplist_clear(pa_proplist *p);
 222
 223 /** Allocate a new property list and copy over every single entry from
 224  * the specific list. \since 0.9.11 */
 225 pa_proplist* pa_proplist_copy(pa_proplist *t);
 226
 227 PA_C_DECL_END
 228
 229 #endif