murphy/utils.c

   1 /*
   2  * module-murphy-ivi -- PulseAudio module for providing audio routing support
   3  * Copyright (c) 2012, Intel Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU Lesser General Public License,
   7  * version 2.1, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.
  12  * See the GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this program; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St - Fifth Floor, Boston,
  17  * MA 02110-1301 USA.
  18  *
  19  */
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <sys/stat.h>
  23 #include <stdio.h>
  24 #include <errno.h>
  25 #include <string.h>
  26 #include <fcntl.h>
  27 #include <unistd.h>
  28 #include <limits.h>
  29
  30 #include <sys/types.h>
  31 #include <sys/socket.h>
  32
  33 #include <pulsecore/pulsecore-config.h>
  34
  35 #include <pulsecore/core-util.h>
  36 #include <pulsecore/sink.h>
  37 #include <pulsecore/card.h>
  38 #include <pulsecore/source.h>
  39 #include <pulsecore/sink-input.h>
  40 #include <pulsecore/source-output.h>
  41
  42 #include "userdata.h"
  43 #include "utils.h"
  44 #include "node.h"
  45
  46
  47 #define DEFAULT_NULL_SINK_NAME "null.mir"
  48
  49 struct pa_null_sink {
  50     char      *name;
  51     uint32_t   module_index;
  52     uint32_t   sink_index;
  53 };
  54
  55
  56 static uint32_t stamp;
  57
  58 static char *stream_name(pa_proplist *);
  59 static bool get_unsigned_property(pa_proplist *, const char *,uint32_t *);
  60
  61
  62 pa_null_sink *pa_utils_create_null_sink(struct userdata *u, const char *name)
  63 {
  64     pa_core      *core;
  65     pa_module    *module;
  66     pa_null_sink *ns;
  67     pa_sink      *sink;
  68     pa_sink      *s;
  69     uint32_t      idx;
  70     char          args[256];
  71
  72     pa_assert(u);
  73     pa_assert_se((core = u->core));
  74
  75
  76     if (!name)
  77         name = DEFAULT_NULL_SINK_NAME;
  78
  79
  80     snprintf(args, sizeof(args), "sink_name=\"%s\" channels=2", name);
  81     module = pa_module_load(core, "module-null-sink", args);
  82     sink = NULL;
  83
  84     if (!module)
  85         pa_log("failed to load null sink '%s'", name);
  86     else {
  87         PA_IDXSET_FOREACH(s, core->sinks, idx) {
  88             if (s->module && s->module == module) {
  89                 sink = s;
  90                 pa_log_info("mir null sink is '%s'", name);
  91                 break;
  92             }
  93         }
  94     }
  95
  96     ns = pa_xnew0(pa_null_sink, 1);
  97     ns->name = pa_xstrdup(name);
  98     ns->module_index = module ? module->index : PA_IDXSET_INVALID;
  99     ns->sink_index = sink ? sink->index : PA_IDXSET_INVALID;
 100
 101     return ns;
 102 }
 103
 104 void pa_utils_destroy_null_sink(struct userdata *u)
 105 {
 106     pa_core      *core;
 107     pa_module    *module;
 108     pa_null_sink *ns;
 109
 110     if (u && (ns = u->nullsink) && (core = u->core)) {
 111         if ((module = pa_idxset_get_by_index(core->modules,ns->module_index))){
 112             pa_log_info("unloading null sink '%s'", ns->name);
 113             pa_module_unload(core, module, false);
 114         }
 115
 116         pa_xfree(ns->name);
 117         pa_xfree(ns);
 118     }
 119 }
 120
 121 pa_sink *pa_utils_get_null_sink(struct userdata *u)
 122 {
 123     pa_core *core;
 124     pa_null_sink *ns;
 125
 126     pa_assert(u);
 127     pa_assert_se((core = u->core));
 128     pa_assert_se((ns = u->nullsink));
 129
 130     return pa_idxset_get_by_index(core->sinks, ns->sink_index);
 131 }
 132
 133 pa_source *pa_utils_get_null_source(struct userdata *u)
 134 {
 135     pa_sink *ns = pa_utils_get_null_sink(u);
 136
 137     return ns ? ns->monitor_source : NULL;
 138 }
 139
 140
 141
 142 char *pa_utils_get_card_name(pa_card *card)
 143 {
 144     return (card && card->name) ? card->name : "<unknown>";
 145 }
 146
 147 char *pa_utils_get_card_bus(pa_card *card)
 148 {
 149     const char *bus = NULL;
 150     char       *name;
 151
 152     if (card && !(bus = pa_proplist_gets(card->proplist,PA_PROP_DEVICE_BUS))) {
 153         name = pa_utils_get_card_name(card);
 154         if (!strncmp(name, "alsa_card.", 10)) {
 155             if (!strncmp(name + 10, "pci-", 4))
 156                 bus = "pci";
 157             else if (!strncmp(name + 10, "platform-", 9))
 158                 bus = "platform";
 159             else if (!strncmp(name + 10, "usb-", 4))
 160                 bus = "usb";
 161         }
 162     }
 163
 164     return (char *)bus;
 165 }
 166
 167 char *pa_utils_get_sink_name(pa_sink *sink)
 168 {
 169     return (sink && sink->name) ? sink->name : "<unknown>";
 170 }
 171
 172 char *pa_utils_get_source_name(pa_source *source)
 173 {
 174     return (source && source->name) ? source->name : "<unknown>";
 175 }
 176
 177 char *pa_utils_get_sink_input_name(pa_sink_input *sinp)
 178 {
 179     char *name;
 180
 181     if (sinp && sinp->proplist && (name = stream_name(sinp->proplist)))
 182         return name;
 183
 184     return "<unknown>";
 185 }
 186
 187 char *pa_utils_get_sink_input_name_from_data(pa_sink_input_new_data *data)
 188 {
 189     char *name;
 190
 191     if (data && (name = stream_name(data->proplist)))
 192         return name;
 193
 194     return "<unknown>";
 195 }
 196
 197
 198 char *pa_utils_get_source_output_name(pa_source_output *sout)
 199 {
 200     char *name;
 201
 202     if (sout && sout->proplist && (name = stream_name(sout->proplist)))
 203         return name;
 204
 205     return "<unknown>";
 206 }
 207
 208 char *pa_utils_get_source_output_name_from_data(pa_source_output_new_data*data)
 209 {
 210     char *name;
 211
 212     if (data && (name = stream_name(data->proplist)))
 213         return name;
 214
 215     return "<unknown>";
 216 }
 217
 218 char *pa_utils_get_zone(pa_proplist *pl)
 219 {
 220     const char *zone;
 221
 222     pa_assert(pl);
 223
 224     if (!(zone = pa_proplist_gets(pl, PA_PROP_ZONE_NAME)))
 225         zone = PA_ZONE_NAME_DEFAULT;
 226
 227     return (char *)zone;
 228 }
 229
 230 bool pa_utils_set_stream_routing_properties(pa_proplist *pl,
 231                                                  int          styp,
 232                                                  void        *target)
 233 {
 234     const char    *clnam;
 235     const char    *method;
 236     char           clid[32];
 237
 238     pa_assert(pl);
 239     pa_assert(styp >= 0);
 240
 241     snprintf(clid, sizeof(clid), "%d", styp);
 242     clnam  = mir_node_type_str(styp);
 243     method = target ? PA_ROUTING_EXPLICIT : PA_ROUTING_DEFAULT;
 244
 245     if (pa_proplist_sets(pl, PA_PROP_ROUTING_CLASS_NAME, clnam ) < 0 ||
 246         pa_proplist_sets(pl, PA_PROP_ROUTING_CLASS_ID  , clid  ) < 0 ||
 247         pa_proplist_sets(pl, PA_PROP_ROUTING_METHOD    , method) < 0  )
 248     {
 249         pa_log("failed to set some stream property");
 250         return false;
 251     }
 252
 253     return true;
 254 }
 255
 256 bool pa_utils_unset_stream_routing_properties(pa_proplist *pl)
 257 {
 258     pa_assert(pl);
 259
 260     if (pa_proplist_unset(pl, PA_PROP_ROUTING_CLASS_NAME) < 0 ||
 261         pa_proplist_unset(pl, PA_PROP_ROUTING_CLASS_ID  ) < 0 ||
 262         pa_proplist_unset(pl, PA_PROP_ROUTING_METHOD    ) < 0  )
 263     {
 264         pa_log("failed to unset some stream property");
 265         return false;
 266     }
 267
 268     return true;
 269 }
 270
 271 void pa_utils_set_stream_routing_method_property(pa_proplist *pl,
 272                                                  bool explicit)
 273 {
 274     const char *method = explicit ? PA_ROUTING_EXPLICIT : PA_ROUTING_DEFAULT;
 275
 276     pa_assert(pl);
 277
 278     if (pa_proplist_sets(pl, PA_PROP_ROUTING_METHOD, method) < 0) {
 279         pa_log("failed to set routing method property on sink-input");
 280     }
 281 }
 282
 283 bool pa_utils_stream_has_default_route(pa_proplist *pl)
 284 {
 285     const char *method;
 286
 287     pa_assert(pl);
 288
 289     method = pa_proplist_gets(pl, PA_PROP_ROUTING_METHOD);
 290
 291     if (method && pa_streq(method, PA_ROUTING_DEFAULT))
 292         return true;
 293
 294     return false;
 295 }
 296
 297 int pa_utils_get_stream_class(pa_proplist *pl)
 298 {
 299     const char *clid_str;
 300     char *e;
 301     unsigned long int clid = 0;
 302
 303     pa_assert(pl);
 304
 305     if ((clid_str = pa_proplist_gets(pl, PA_PROP_ROUTING_CLASS_ID))) {
 306         clid = strtoul(clid_str, &e, 10);
 307
 308         if (*e)
 309             clid = 0;
 310     }
 311
 312     return (int)clid;
 313 }
 314
 315
 316 bool pa_utils_set_resource_properties(pa_proplist *pl,
 317                                            pa_nodeset_resdef *resdef)
 318 {
 319     char priority[32];
 320     char rsetflags[32];
 321     char audioflags[32];
 322
 323     pa_assert(pl);
 324
 325     if (!resdef)
 326         return false;
 327
 328     snprintf(priority  , sizeof(priority)  , "%d", resdef->priority   );
 329     snprintf(rsetflags , sizeof(rsetflags) , "%d", resdef->flags.rset );
 330     snprintf(audioflags, sizeof(audioflags), "%d", resdef->flags.audio);
 331
 332     if (pa_proplist_sets(pl, PA_PROP_RESOURCE_PRIORITY   , priority  ) < 0 ||
 333         pa_proplist_sets(pl, PA_PROP_RESOURCE_SET_FLAGS  , rsetflags ) < 0 ||
 334         pa_proplist_sets(pl, PA_PROP_RESOURCE_AUDIO_FLAGS, audioflags) < 0  )
 335     {
 336         pa_log("failed to set some resource property");
 337         return false;
 338     }
 339
 340     return true;
 341 }
 342
 343 bool pa_utils_unset_resource_properties(pa_proplist *pl)
 344 {
 345     pa_assert(pl);
 346
 347     if (pa_proplist_unset(pl, PA_PROP_RESOURCE_PRIORITY   ) < 0 ||
 348         pa_proplist_unset(pl, PA_PROP_RESOURCE_SET_FLAGS  ) < 0 ||
 349         pa_proplist_unset(pl, PA_PROP_RESOURCE_AUDIO_FLAGS) < 0  )
 350     {
 351         pa_log("failed to unset some resource property");
 352         return false;
 353     }
 354
 355     return true;
 356 }
 357
 358 pa_nodeset_resdef *pa_utils_get_resource_properties(pa_proplist *pl,
 359                                                     pa_nodeset_resdef *rd)
 360 {
 361     pa_assert(pl);
 362     pa_assert(rd);
 363
 364     int success;
 365
 366     memset(rd, 0, sizeof(pa_nodeset_resdef));
 367
 368     success  = get_unsigned_property(pl, PA_PROP_RESOURCE_PRIORITY,
 369                                      &rd->priority);
 370     success |= get_unsigned_property(pl, PA_PROP_RESOURCE_SET_FLAGS,
 371                                      &rd->flags.rset);
 372     success |= get_unsigned_property(pl, PA_PROP_RESOURCE_AUDIO_FLAGS,
 373                                      &rd->flags.audio);
 374
 375     return success ? rd : NULL;
 376 }
 377
 378
 379 static bool get_unsigned_property(pa_proplist *pl,
 380                                        const char *name,
 381                                        uint32_t *value)
 382 {
 383     const char *str;
 384     char *e;
 385
 386     pa_assert(pl);
 387     pa_assert(name);
 388     pa_assert(value);
 389
 390     if (!(str = pa_proplist_gets(pl, name))) {
 391         *value = 0;
 392         return false;
 393     }
 394
 395     *value = strtoul(str, &e, 10);
 396
 397     if (e == str || *e) {
 398         *value = 0;
 399         return false;
 400     }
 401
 402     return true;
 403 }
 404
 405
 406 void pa_utils_set_port_properties(pa_device_port *port, mir_node *node)
 407 {
 408     const char *profile;
 409     char propnam[512];
 410     char nodeidx[256];
 411
 412     pa_assert(port);
 413     pa_assert(port->proplist);
 414     pa_assert(node);
 415     pa_assert_se((profile = node->pacard.profile));
 416
 417     snprintf(propnam, sizeof(propnam), "%s.%s", PA_PROP_NODE_INDEX, profile);
 418     snprintf(nodeidx, sizeof(nodeidx), "%u", node->index);
 419
 420     pa_proplist_sets(port->proplist, propnam, nodeidx);
 421 }
 422
 423 mir_node *pa_utils_get_node_from_port(struct userdata *u,
 424                                       pa_device_port *port,
 425                                       void **state)
 426 {
 427     const char *name;
 428     const char *value;
 429     char *e;
 430     uint32_t index = PA_IDXSET_INVALID;
 431     mir_node *node = NULL;
 432
 433     pa_assert(u);
 434     pa_assert(port);
 435     pa_assert(port->proplist);
 436
 437     while ((name = pa_proplist_iterate(port->proplist, state))) {
 438         if (!strncmp(name, PA_PROP_NODE_INDEX, sizeof(PA_PROP_NODE_INDEX)-1)) {
 439             if ((value = pa_proplist_gets(port->proplist, name))) {
 440                 index = strtoul(value, &e, 10);
 441                 node = NULL;
 442
 443                 if (value[0] && !e[0])
 444                     node = mir_node_find_by_index(u, index);
 445
 446                 if (node)
 447                     return node;
 448
 449                 pa_log("Can't find node %u for port %s", index, port->name);
 450             }
 451         }
 452     }
 453
 454     return NULL;
 455 }
 456
 457 mir_node *pa_utils_get_node_from_stream(struct userdata *u,
 458                                         mir_direction    type,
 459                                         void            *ptr)
 460 {
 461     pa_sink_input    *sinp;
 462     pa_source_output *sout;
 463     pa_proplist      *pl;
 464     mir_node         *node;
 465     const char       *index_str;
 466     uint32_t          index = PA_IDXSET_INVALID;
 467     char             *e;
 468     char              name[256];
 469
 470     pa_assert(u);
 471     pa_assert(ptr);
 472     pa_assert(type == mir_input || type == mir_output);
 473
 474     if (type == mir_input) {
 475         sinp = (pa_sink_input *)ptr;
 476         pl = sinp->proplist;
 477         snprintf(name, sizeof(name), "sink-input.%u", sinp->index);
 478     }
 479     else {
 480         sout = (pa_source_output *)ptr;
 481         pl = sout->proplist;
 482         snprintf(name, sizeof(name), "source-output.%u", sout->index);
 483     }
 484
 485
 486     if ((index_str = pa_proplist_gets(pl, PA_PROP_NODE_INDEX))) {
 487         index = strtoul(index_str, &e, 10);
 488         if (e != index_str && *e == '\0') {
 489             if ((node = mir_node_find_by_index(u, index)))
 490                 return node;
 491
 492             pa_log_debug("can't find find node for %s", name);
 493         }
 494     }
 495
 496     return NULL;
 497 }
 498
 499 mir_node *pa_utils_get_node_from_data(struct userdata *u,
 500                                       mir_direction    type,
 501                                       void            *ptr)
 502 {
 503     pa_sink_input_new_data *sinp;
 504     pa_source_output_new_data *sout;
 505     pa_proplist  *pl;
 506     mir_node     *node;
 507     const char   *index_str;
 508     uint32_t      index = PA_IDXSET_INVALID;
 509     char         *e;
 510     char          name[256];
 511
 512     pa_assert(u);
 513     pa_assert(ptr);
 514     pa_assert(type == mir_input || type == mir_output);
 515
 516     if (type == mir_input) {
 517         sinp = (pa_sink_input_new_data *)ptr;
 518         pl = sinp->proplist;
 519         snprintf(name, sizeof(name), "sink-input");
 520     }
 521     else {
 522         sout = (pa_source_output_new_data *)ptr;
 523         pl = sout->proplist;
 524         snprintf(name, sizeof(name), "source-output");
 525     }
 526
 527
 528     if ((index_str = pa_proplist_gets(pl, PA_PROP_NODE_INDEX))) {
 529         index = strtoul(index_str, &e, 10);
 530         if (e != index_str && *e == '\0') {
 531             if ((node = mir_node_find_by_index(u, index)))
 532                 return node;
 533
 534             pa_log_debug("can't find find node for %s", name);
 535         }
 536     }
 537
 538     return NULL;
 539 }
 540
 541 static char *stream_name(pa_proplist *pl)
 542 {
 543     const char  *appnam;
 544     const char  *binnam;
 545
 546     if ((appnam = pa_proplist_gets(pl, PA_PROP_APPLICATION_NAME)))
 547         return (char *)appnam;
 548
 549     if ((binnam = pa_proplist_gets(pl, PA_PROP_APPLICATION_PROCESS_BINARY)))
 550         return (char *)binnam;
 551
 552     return NULL;
 553 }
 554
 555
 556 const char *pa_utils_file_path(const char *dir, const char *file,
 557                                char *buf, size_t len)
 558 {
 559     pa_assert(file);
 560     pa_assert(buf);
 561     pa_assert(len > 0);
 562
 563     snprintf(buf, len, "%s/%s", dir, file);
 564
 565     return buf;
 566 }
 567
 568
 569 uint32_t pa_utils_new_stamp(void)
 570 {
 571     return ++stamp;
 572 }
 573
 574 uint32_t pa_utils_get_stamp(void)
 575 {
 576     return stamp;
 577 }
 578
 579
 580
 581 /*
 582  * Local Variables:
 583  * c-basic-offset: 4
 584  * indent-tabs-mode: nil
 585  * End:
 586  *
 587  */
 588
 589