aboutsummaryrefslogtreecommitdiffstats
path: root/alsa-binding/Alsa-RegEvt.c
blob: a9cce2b437c0d542c54195aefea953c095142690 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
/*
 * AlsaLibMapping -- provide low level interface with ALSA lib (extracted from alsa-json-gateway code)
 * Copyright (C) 2015,2016,2017, Fulup Ar Foll fulup@iot.bzh
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.

 */

#define _GNU_SOURCE  // needed for vasprintf

#include <sys/inotify.h>

#include <afb-timer.h>

#include <wrap-json.h>

#include "Alsa-ApiHat.h"

// Defines for inotify events
#define INOTIFY_EVENT_SIZE      (sizeof(struct inotify_event))
#define INOTIFY_EVENT_BUF_LEN   (1024 * (INOTIFY_EVENT_SIZE + 16))

#define CARD_DIR_TO_WATCH       "/dev/snd/by-path"

#ifndef MAX_SND_HAL
#define MAX_SND_HAL 10
#endif

typedef enum {
    UNKNOWN_EVENT = 0,
    CARD_CONTROL_CHANGE_EVENTS = 1,
    CARD_MONITORING_EVENTS = 2
} EventTypeT;

typedef struct {
    int fd;
    int wd;
    sd_event_source *src;
    afb_event_t afbevt;
} sndCardEvtHandleT;

// generic sndctrl event handle hook to event callback when pooling
typedef struct {
    struct pollfd pfds;
    sd_event_source *src;
    snd_ctl_t *ctlDev;
    afb_event_t afbevt;
} ctrlEvtHandleT;

typedef struct {
    int available;
    ctrlEvtHandleT *evtHandle;
} sndHandleT;

typedef struct {
    sndHandleT sndHandles[MAX_SND_CARD];
    sndCardEvtHandleT *cardMonitoring;
    afb_api_t apiHandle;
} sndCardsT;

typedef struct {
    char *createdFileName;
    sndCardsT *sndCards;
} sndCardCardFileEventHandleT;

typedef struct {
    int  cardid;
    char *devid;
    char *apiprefix;
    char *drivername;
    char *shortname;
    char *longname;
} cardRegistryT;

cardRegistryT *cardRegistry[MAX_SND_HAL + 1];

STATIC int getHalIdxFromCardid (int cardid) {
    
    for (int idx = 0; idx < MAX_SND_HAL; idx++) {
        if (!cardRegistry[idx]) return -1;
        if (cardRegistry[idx]->cardid == cardid) return idx;
    }
    
    return -1;
}

STATIC EventTypeT alsaGetDevIdFromString(char *eventTypeString)
{
    if(! eventTypeString)
        return UNKNOWN_EVENT;

    if(! strcasecmp(eventTypeString, "controls"))
        return CARD_CONTROL_CHANGE_EVENTS;

    if(! strcasecmp(eventTypeString, "cards"))
        return CARD_MONITORING_EVENTS;

    return UNKNOWN_EVENT;
}

STATIC EventTypeT alsaGetEventTypeFromQuery(json_object *queryJ)
{
    char *eventTypeString = NULL;

    if(wrap_json_unpack(queryJ, "{s:s}", "event", &eventTypeString))
        return UNKNOWN_EVENT;

    if(! eventTypeString)
        return UNKNOWN_EVENT;

    return alsaGetDevIdFromString(eventTypeString);
}

PUBLIC char *alsaGetDevIdFromQuery(json_object *queryJ)
{
    char *devId = NULL;

    if(wrap_json_unpack(queryJ, "{s:s}", "devid", &devId))
        return NULL;

    return devId;
}

PUBLIC queryModeE alsaGetModeFromQuery(json_object *queryJ)
{
    queryModeE mode = QUERY_QUIET;

    if(wrap_json_unpack(queryJ, "{s:i}", "mode", &mode))
        return QUERY_QUIET;

   return mode;
}

STATIC void freeSndCardHandle(sndCardEvtHandleT **cardMonitoringHandle)
{
    sndCardEvtHandleT *cardMonitoringHandleToFree;

    if(! cardMonitoringHandle || ! *cardMonitoringHandle)
        return;

    cardMonitoringHandleToFree = *cardMonitoringHandle;

    if(cardMonitoringHandleToFree->src)
        sd_event_source_unref(cardMonitoringHandleToFree->src);

    if(afb_event_is_valid(cardMonitoringHandleToFree->afbevt))
        afb_event_unref(cardMonitoringHandleToFree->afbevt);

    if(cardMonitoringHandleToFree->fd != -1 && cardMonitoringHandleToFree->wd != -1)
        inotify_rm_watch(cardMonitoringHandleToFree->fd, cardMonitoringHandleToFree->wd);

    if(cardMonitoringHandleToFree->fd != -1)
        close(cardMonitoringHandleToFree->fd);

    free(cardMonitoringHandleToFree);

    *cardMonitoringHandle = NULL;
}

STATIC void freeCardAlsaControlHandle(ctrlEvtHandleT **cardControlHandle)
{
    ctrlEvtHandleT *cardControlHandleToFree;

    if(! cardControlHandle || ! *cardControlHandle)
        return;

    cardControlHandleToFree = *cardControlHandle;

    if(cardControlHandleToFree->src)
        sd_event_source_unref(cardControlHandleToFree->src);

    if(afb_event_is_valid(cardControlHandleToFree->afbevt))
        afb_event_unref(cardControlHandleToFree->afbevt);

    if(cardControlHandleToFree->ctlDev)
        snd_ctl_close(cardControlHandleToFree->ctlDev);

    free(cardControlHandleToFree);

    *cardControlHandle = NULL;
}

STATIC void updateSelectedAlsaCardsAvailabilityAndFireEvents(sndCardsT *sndCards, int first, int last)
{
    int idx, available, subscriberCount = -1;
    char *cardId;

    json_object *generatedEventJ = NULL;

    if(first < 0 || first >= MAX_SND_CARD)
        return;

    if(last < 0 || last >= MAX_SND_CARD)
        return;

    if(last < first)
        return;

    for(idx = first; idx < (last + 1); idx++) {
        available = snd_card_load(idx);
        if(available && ! sndCards->sndHandles[idx].available) {
           sndCards->sndHandles[idx].available = 1;

            if(sndCards->cardMonitoring &&
               ! wrap_json_pack(&generatedEventJ, "{s:o}", "cardAdded", getCardInfo(idx)))
                subscriberCount = afb_event_push(sndCards->cardMonitoring->afbevt, generatedEventJ);
        }
        else if(! available && sndCards->sndHandles[idx].available) {
            sndCards->sndHandles[idx].available = 0;

            if(sndCards->cardMonitoring &&
               (asprintf(&cardId, "hw:%i", idx) > 0) &&
               ! wrap_json_pack(&generatedEventJ, "{s:s}", "cardRemoved", cardId))
                subscriberCount = afb_event_push(sndCards->cardMonitoring->afbevt, generatedEventJ);

            if(sndCards->sndHandles[idx].evtHandle) {
                sd_event_source_unref(sndCards->sndHandles[idx].evtHandle->src);
                afb_event_unref(sndCards->sndHandles[idx].evtHandle->afbevt);
                snd_ctl_close(sndCards->sndHandles[idx].evtHandle->ctlDev);
                free(sndCards->sndHandles[idx].evtHandle);
                sndCards->sndHandles[idx].evtHandle = NULL;
            }
        }
    }

    if(! subscriberCount) {
        AFB_WARNING("Nobody listening for 'card-monitoring' events, stop monitoring from now on");
        freeSndCardHandle(&sndCards->cardMonitoring);
    }
}

STATIC void updateAllAlsaCardsAvailabilityAndFireEvents(sndCardsT *sndCards) {
    updateSelectedAlsaCardsAvailabilityAndFireEvents(sndCards, 0, (MAX_SND_CARD - 1));
}

// This routine is called every few microseconds to verify when the newly created sound card file will be openable (using timer event firing)
STATIC int sndCardTimerForCreatedFileCB(TimerHandleT *context)
{
    int createdFileCardNb;

    sndCardCardFileEventHandleT *createdFileHandle = (sndCardCardFileEventHandleT *) context->context;

    createdFileCardNb = getCardNbFromCardPath(createdFileHandle->createdFileName);
    if(createdFileCardNb < 0) {
        AFB_ERROR("Error %i happened when tried to get created card name file '%s' card nb",
                  createdFileCardNb,
                  createdFileHandle->createdFileName);
        return -1;
    }

    updateSelectedAlsaCardsAvailabilityAndFireEvents(createdFileHandle->sndCards, createdFileCardNb, createdFileCardNb);

    free(createdFileHandle->createdFileName);
    free(createdFileHandle);

    context->count = 1;

    return 1;
}

// This routine is called when sound cards are added/removed (when inotify '/dev/snd/by-path' events are fired)
STATIC int sndCardEventCB(sd_event_source* src, int fd, uint32_t revents, void* userData)
{
    ssize_t length, i = 0;
    char buffer[INOTIFY_EVENT_BUF_LEN];
    char *createdFile;

    struct inotify_event *event;

    sndCardCardFileEventHandleT *createdFileHandle;
    TimerHandleT *createdFileTimerHandle;

    sndCardsT *sndCards = (sndCardsT *) userData;

    if(revents & EPOLLERR) {
        AFB_ERROR("An error has been send by event loop polling, prevent new errors to be fired by deleting event src");
        freeSndCardHandle(&sndCards->cardMonitoring);
        return -1;
    }

    if(revents & EPOLLIN) {
        length = read(fd, buffer, INOTIFY_EVENT_BUF_LEN);
        if(length < 0) {
            AFB_ERROR("Nothing read using inotify");
            freeSndCardHandle(&sndCards->cardMonitoring);
            return -2;
        }

        while(i < length) {
            event = (struct inotify_event *) &buffer[i];

            i += INOTIFY_EVENT_SIZE + event->len;

            if(! event->len)
                continue;
            
            if((event->mask & IN_CREATE) &&
               ! (event->mask & IN_ISDIR) &&
                (asprintf(&createdFile, "%s/%s", CARD_DIR_TO_WATCH, event->name) > 0)) {
                createdFileHandle = calloc(1, sizeof(sndCardCardFileEventHandleT));
                createdFileHandle->createdFileName = strdup(createdFile);
                createdFileHandle->sndCards = sndCards;

                createdFileTimerHandle = calloc(1, sizeof(TimerHandleT));

                createdFileTimerHandle->uid = "sound card file creation delay";
                createdFileTimerHandle->count = 10;
                createdFileTimerHandle->delay = 2;

                TimerEvtStart(sndCards->apiHandle, createdFileTimerHandle, sndCardTimerForCreatedFileCB, (void *) createdFileHandle);
            }

            if((event->mask & IN_DELETE) && ! (event->mask & IN_ISDIR))
                updateAllAlsaCardsAvailabilityAndFireEvents(sndCards);
        }
    }

    return 0;
}

// This routine is called when ALSA control events are fired
STATIC int sndCtlEventCB(sd_event_source* src, int fd, uint32_t revents, void* userData)
{
    int err, ctlNumid, subscriberCount = -1;
    unsigned int mask;

    snd_ctl_elem_id_t *elemId;
    snd_ctl_event_t *eventId;

    sndHandleT *sndHandle = (sndHandleT *) userData;
    ctlRequestT ctlRequest;

    json_object *ctlEventJ, *ctlEventAdditionalInfoJ;

    if((revents & EPOLLERR) != 0) {
        AFB_ERROR("An error has been send by event loop polling, prevent new errors to be fired by deleting event src");
        freeCardAlsaControlHandle(&sndHandle->evtHandle);
        return -1;
    }

    if((revents & EPOLLHUP) != 0) {
        AFB_NOTICE("SndCtl hanghup [car disconnected]");
        return 0;
    }

    if((revents & EPOLLIN) != 0) {
        // initialise event structure on stack
        snd_ctl_event_alloca(&eventId);
        snd_ctl_elem_id_alloca(&elemId);

        err = snd_ctl_read(sndHandle->evtHandle->ctlDev, eventId);
        if(err < 0) {
            AFB_ERROR("Did not succeed to read control event");
            freeCardAlsaControlHandle(&sndHandle->evtHandle);
            return -2;
        }

        // we only process sndctrl element
        if(snd_ctl_event_get_type(eventId) != SND_CTL_EVENT_ELEM)
            return 0;

        // we only process value changed events
        mask = snd_ctl_event_elem_get_mask(eventId);
        if(! (mask & SND_CTL_EVENT_MASK_VALUE))
            return 0;

        snd_ctl_event_elem_get_id(eventId, elemId);

        err = alsaGetSingleCtl(sndHandle->evtHandle->ctlDev, elemId, &ctlRequest, QUERY_FULL);
        if(err) {
            AFB_ERROR("Did not succeed to get control info and values");
            freeCardAlsaControlHandle(&sndHandle->evtHandle);
            return -3;
        }

        // If CTL as a value use it as container for response
        if(ctlRequest.valuesJ) {
            ctlEventJ = ctlRequest.valuesJ;
        }
        else {
            ctlEventJ = json_object_new_object();
            ctlNumid = snd_ctl_event_elem_get_numid(eventId);
            json_object_object_add(ctlEventJ, "id", json_object_new_int(ctlNumid));
        }

        err = wrap_json_pack(&ctlEventAdditionalInfoJ,
                             "{s:s, s:i, s:i, s:i}",
                             "name", snd_ctl_event_elem_get_name(eventId),
                             "card", snd_ctl_event_elem_get_interface(eventId),
                             "dev", snd_ctl_event_elem_get_device(eventId),
                             "sub", snd_ctl_event_elem_get_subdevice(eventId));
        if(! err)
            wrap_json_object_add(ctlEventJ, ctlEventAdditionalInfoJ);

        AFB_DEBUG("sndCtlEventCB=%s", json_object_get_string(ctlEventJ));
        subscriberCount = afb_event_push(sndHandle->evtHandle->afbevt, ctlEventJ);
    }

    if(! subscriberCount) {
        AFB_WARNING("Nobody listening for card %i control events, stop monitoring from now on", snd_ctl_event_elem_get_interface(eventId));
        freeCardAlsaControlHandle(&sndHandle->evtHandle);
        return -4;
    }

    return 0;
}

// Subscribe to each time a sound card is added/removed (using inotify '/dev/snd/by-path' events)
STATIC afb_event_t alsaEvtSubscribeUnsubscribeSoundCardEvent(afb_req_t request,
                                                             sndCardsT *sndCards,
                                                             EventSubscribeUnsubscribeT subscriptionType)
{
    int err;

    if(sndCards->cardMonitoring)
        return sndCards->cardMonitoring->afbevt;
    else if(subscriptionType == EVENT_UNSUBSCRIBE)
        return NULL;

    updateAllAlsaCardsAvailabilityAndFireEvents(sndCards);

    sndCards->cardMonitoring = malloc(sizeof (sndCardEvtHandleT));
    if(! sndCards->cardMonitoring) {
        afb_req_fail(request, "card-monitoring-event", "Error while allocating card added monitoring handle");
        return NULL;
    }

    sndCards->cardMonitoring->fd = -1;
    sndCards->cardMonitoring->wd = -1;

    sndCards->cardMonitoring->fd = inotify_init();
    if(sndCards->cardMonitoring->fd < 0) {
        afb_req_fail_f(request, "inotify-init", "Error %s happened while getting file descriptor for inotify", strerror(errno));
        freeSndCardHandle(&sndCards->cardMonitoring);
        return NULL;
    }

    sndCards->cardMonitoring->wd = inotify_add_watch(sndCards->cardMonitoring->fd, CARD_DIR_TO_WATCH, IN_CREATE | IN_DELETE);
    if(sndCards->cardMonitoring->wd < 0) {
        afb_req_fail_f(request,
                       "inotify-watch",
                       "Error %s happened while setting watcher on '%s' directory using inotify",
                       strerror(errno),
                       CARD_DIR_TO_WATCH);
        freeSndCardHandle(&sndCards->cardMonitoring);
        return NULL;
    }

    sndCards->cardMonitoring->afbevt = afb_daemon_make_event("card-monitoring");
    if(! afb_event_is_valid(sndCards->cardMonitoring->afbevt)) {
        afb_req_fail_f(request, "card-monitoring-event", "Cannot register new binder card-monitoring event");
        freeSndCardHandle(&sndCards->cardMonitoring);
        return NULL;
    }

    // register sound event to binder main loop
    err = sd_event_add_io(afb_daemon_get_event_loop(),
                          &sndCards->cardMonitoring->src,
                          sndCards->cardMonitoring->fd,
                          EPOLLIN,
                          sndCardEventCB,
                          sndCards);
    if(err < 0) {
        afb_req_fail_f(request, "register-mainloop", "Cannot hook sound card events to mainloop err=%d", err);
        freeSndCardHandle(&sndCards->cardMonitoring);
        return NULL;
    }

    return sndCards->cardMonitoring->afbevt;
}

// Subscribe to every Alsa CtlEvent send by a given board
STATIC afb_event_t alsaEvtSubscribeUnsubscribeAlsaControlEvent(afb_req_t request,
                                                               sndCardsT *sndCards,
                                                               char* devId,
                                                               EventSubscribeUnsubscribeT subscriptionType)
{
    sndHandleT *currentSndHandle = NULL;
    snd_ctl_t *ctlDev = NULL;
    int err, cardId;
    snd_ctl_card_info_t *cardinfo;

    // open control interface for devid
    err = snd_ctl_open(&ctlDev, devId, SND_CTL_READONLY);
    if(err < 0) {
        afb_req_fail_f(request, "devid-unknown", "SndCard devid=%s Not Found err=%s", devId, snd_strerror(err));
        return NULL;
    }

    snd_ctl_card_info_alloca(&cardinfo);
    err = snd_ctl_card_info(ctlDev, cardinfo);
    if(err < 0) {
        afb_req_fail_f(request, "devid-invalid", "SndCard devid=%s Not Found err=%s", devId, snd_strerror(err));
        snd_ctl_close(ctlDev);
        return NULL;
    }

    cardId = snd_ctl_card_info_get_card(cardinfo);

    if(cardId < 0 || cardId >= MAX_SND_CARD) {
        afb_req_fail_f(request, "devid-invalid", "SndCard cardId=%i invalid", cardId);
        snd_ctl_close(ctlDev);
        return NULL;
    }

    currentSndHandle = &sndCards->sndHandles[cardId];

    if(currentSndHandle->evtHandle) {
        snd_ctl_close(ctlDev);
        return currentSndHandle->evtHandle->afbevt;
    }
    else if(subscriptionType == EVENT_UNSUBSCRIBE) {
        snd_ctl_close(ctlDev);
        return NULL;
    }

    currentSndHandle->evtHandle = malloc(sizeof (ctrlEvtHandleT));
    currentSndHandle->evtHandle->ctlDev = ctlDev;

    // subscribe for sndctl events attached to devid
    err = snd_ctl_subscribe_events(currentSndHandle->evtHandle->ctlDev, 1);
    if(err < 0) {
        afb_req_fail_f(request, "alsa-ctl-subscribe-fail", "Cannot subscribe events from devid=%s err=%d", devId, err);
        freeCardAlsaControlHandle(&currentSndHandle->evtHandle);
        return NULL;
    }

    // get pollfd attach to this sound board
    snd_ctl_poll_descriptors(currentSndHandle->evtHandle->ctlDev, &currentSndHandle->evtHandle->pfds, 1);

    // register sound event to binder main loop
    err = sd_event_add_io(afb_daemon_get_event_loop(),
                          &currentSndHandle->evtHandle->src,
                          currentSndHandle->evtHandle->pfds.fd,
                          EPOLLIN,
                          sndCtlEventCB,
                          currentSndHandle);
    if(err < 0) {
        afb_req_fail_f(request, "register-mainloop", "Cannot hook events to mainloop devid=%s err=%d", devId, err);
        freeCardAlsaControlHandle(&currentSndHandle->evtHandle);
        return NULL;
    }

    // create binder event attached to devid name
    currentSndHandle->evtHandle->afbevt = afb_daemon_make_event(devId);
    if(! afb_event_is_valid(currentSndHandle->evtHandle->afbevt)) {
        afb_req_fail_f(request, "register-event", "Cannot register new binder event name=%s", devId);
        freeCardAlsaControlHandle(&currentSndHandle->evtHandle);
        return NULL;
    }

    return currentSndHandle->evtHandle->afbevt;
}

// Subscribe to alsacore event
PUBLIC void alsaEvtSubscribeUnsubscribe(afb_req_t request, EventSubscribeUnsubscribeT subscriptionType)
{
    int err = -1;

    EventTypeT eventType;

    char *devId = NULL;

    static sndCardsT *sndCards = NULL;

    afb_event_t eventToSubscribeUnsubscribe;

    json_object *queryJ;

    if(! sndCards) {
        sndCards = calloc(1, sizeof(sndCardsT));
        sndCards->apiHandle = afb_req_get_api(request);
    }

    queryJ = afb_req_json(request);

    eventType = alsaGetEventTypeFromQuery(queryJ);
    switch(eventType) {
            case CARD_CONTROL_CHANGE_EVENTS:
                devId = alsaGetDevIdFromQuery(queryJ);
                if(! devId) {
                    afb_req_fail_f(request, "devid-missing", "Invalid query='%s'", json_object_get_string(queryJ));
                    return;
                }

                eventToSubscribeUnsubscribe = alsaEvtSubscribeUnsubscribeAlsaControlEvent(request, sndCards, devId, subscriptionType);
                break;

            case CARD_MONITORING_EVENTS:
                eventToSubscribeUnsubscribe = alsaEvtSubscribeUnsubscribeSoundCardEvent(request, sndCards, subscriptionType);
                break;

            case UNKNOWN_EVENT:
            default:
                afb_req_fail_f(request, "unknown-event", "Invalid query='%s'", json_object_get_string(queryJ));
                return;
    }

    if(! eventToSubscribeUnsubscribe)
        return;

    // subscribe/unsubscribe to binder event
    if(subscriptionType == EVENT_SUBSCRIBE)
        err = afb_req_subscribe(request, eventToSubscribeUnsubscribe);
    else if(subscriptionType == EVENT_UNSUBSCRIBE)
        err = afb_req_unsubscribe(request, eventToSubscribeUnsubscribe);

    if(err) {
        afb_req_fail_f(request,
                       "register-eventname",
                       "Cannot %s binder event",
                       (subscriptionType == EVENT_SUBSCRIBE) ? "subscribe" : "unsubscribe");
        return;
    }

    afb_req_success(request, NULL, NULL);
}

PUBLIC void alsaEvtSubscribe(afb_req_t request)
{
    alsaEvtSubscribeUnsubscribe(request, EVENT_SUBSCRIBE);
}

PUBLIC void alsaEvtUnsubscribe(afb_req_t request)
{
    alsaEvtSubscribeUnsubscribe(request, EVENT_UNSUBSCRIBE);
}

// Subscribe to every Alsa CtlEvent send by a given board

STATIC json_object *alsaProbeCardId(afb_req_t request) {
    char devid [32];
    const char *ctlName, *shortname, *longname, *mixername, *drivername;
    int done, mode, card, err, index, idx;
    json_object *responseJ, *tmpJ;
    snd_ctl_t *ctlDev;
    snd_ctl_card_info_t *cardinfo;

    json_object* queryJ = afb_req_json(request);
        
    done = json_object_object_get_ex(queryJ, "sndname", &tmpJ);
    if (!done || json_object_get_type(tmpJ) != json_type_string) {
        afb_req_fail_f(request, "argument-missing", "sndname=SndCardName missing");
        goto OnErrorExit;
    }
    const char *sndname = json_object_get_string(tmpJ);
    
    done = json_object_object_get_ex(queryJ, "mode", &tmpJ);
    if (!done) {
        mode = 0;
    } else {
        mode = json_object_get_int(tmpJ);        
    }
    

    // loop on potential card number
    snd_ctl_card_info_alloca(&cardinfo);
    char *driverId = NULL; // when not name match use drivername as backup plan
    for (card = 0; card < MAX_SND_CARD; card++) {

        // build card devid and probe it
        snprintf(devid, sizeof (devid), "hw:%i", card);

        // open control interface for devid
        err = snd_ctl_open(&ctlDev, devid, SND_CTL_READONLY);
        if (err < 0) continue;

        // extract sound card information
        snd_ctl_card_info(ctlDev, cardinfo);
        index = snd_ctl_card_info_get_card(cardinfo);
        ctlName = snd_ctl_card_info_get_id(cardinfo);
        shortname = snd_ctl_card_info_get_name(cardinfo);
        longname = snd_ctl_card_info_get_longname(cardinfo);
        mixername  = snd_ctl_card_info_get_mixername(cardinfo);
        drivername = snd_ctl_card_info_get_driver(cardinfo);

        snd_ctl_close(ctlDev);
        
        // check if short|long name match
        if (!strcasecmp(sndname, ctlName)) break;
        if (!strcasecmp(sndname, shortname)) break;
        
        // if name does not match search for a free HAL with driver name matching
        if (driverId==NULL && getHalIdxFromCardid(card)<0 && !strcasecmp(sndname, drivername)) driverId=strdup(devid);
    }

    if (card == MAX_SND_CARD) {
        if (!driverId) {
            afb_req_fail_f(request, "ctlDev-notfound", "Fail to find card with name=%s", sndname);
            goto OnErrorExit;
        } 
                
        // refresh devid and clean up driverId
        strncpy (devid, driverId, sizeof(devid));       
        free(driverId);
        
        err = snd_ctl_open(&ctlDev, devid, SND_CTL_READONLY);
        if (err < 0) {
            afb_req_fail_f(request, "ctlDev-notfound", "Fail to find card with name=%s devid=%s", sndname, devid);
            goto OnErrorExit;
        }

        // Sound not found by name, backup to driver name
        snd_ctl_card_info(ctlDev, cardinfo);
        index = snd_ctl_card_info_get_card(cardinfo);
        ctlName = snd_ctl_card_info_get_id(cardinfo);
        shortname = snd_ctl_card_info_get_name(cardinfo);
        longname = snd_ctl_card_info_get_longname(cardinfo);
        mixername  = snd_ctl_card_info_get_mixername(cardinfo);
        drivername = snd_ctl_card_info_get_driver(cardinfo);
        AFB_WARNING("alsaProbeCardId Fallback to HAL=%s ==> devid=%s name=%s long=%s\n ", drivername, devid, shortname, longname);
        snd_ctl_close(ctlDev);
    }

    // proxy ctlevent as a binder event
    responseJ = json_object_new_object();
    json_object_object_add(responseJ, "index", json_object_new_int(index));
    json_object_object_add(responseJ, "cardid", json_object_new_int(card));
    json_object_object_add(responseJ, "devid", json_object_new_string(devid));
    json_object_object_add(responseJ, "shortname", json_object_new_string(shortname));
    
    if (mode > 0) {
        json_object_object_add(responseJ, "longname", json_object_new_string(longname));
        json_object_object_add(responseJ, "mixername", json_object_new_string(mixername));
        json_object_object_add(responseJ, "drivername", json_object_new_string(drivername));
        
    }

    // search for a HAL binder card mapping name to api prefix
    for (idx = 0; (idx < MAX_SND_HAL && cardRegistry[idx]); idx++) {
        if (!strcmp(cardRegistry[idx]->shortname, shortname)) {
            json_object_object_add(responseJ, "halapi", json_object_new_string(cardRegistry[idx]->apiprefix));
            break;
        }
    }

    return responseJ;

OnErrorExit:
    return NULL;
}

// Make alsaProbeCardId compatible with AFB request

PUBLIC void alsaGetCardId(afb_req_t request) {

    json_object *responseJ = alsaProbeCardId(request);
    if (responseJ) afb_req_success(request, responseJ, NULL);
}


// Return HAL information about a given sound card ID

STATIC int getHalApiFromCardid(int cardid, json_object *responseJ) {

    
    int idx = getHalIdxFromCardid (cardid);
    if (idx < 0) goto OnErrorExit;
    
    json_object_object_add(responseJ, "api", json_object_new_string(cardRegistry[idx]->apiprefix));
    if (cardRegistry[idx]->shortname)json_object_object_add(responseJ, "shortname", json_object_new_string(cardRegistry[idx]->shortname));
    if (cardRegistry[idx]->longname) json_object_object_add(responseJ, "longname", json_object_new_string(cardRegistry[idx]->longname));

    return 0;

OnErrorExit:
    return -1;
}


// Return list of active resgistrated HAL with corresponding sndcard

PUBLIC void alsaActiveHal(afb_req_t request) {
    json_object *responseJ = json_object_new_array();

    for (int idx = 0; idx < MAX_SND_HAL; idx++) {
        if (!cardRegistry[idx]) break;

        json_object *haldevJ = json_object_new_object();
        json_object_object_add(haldevJ, "api", json_object_new_string(cardRegistry[idx]->apiprefix));
        if (cardRegistry[idx]->devid) json_object_object_add(haldevJ, "devid", json_object_new_string(cardRegistry[idx]->devid));
        if (cardRegistry[idx]->shortname)json_object_object_add(haldevJ, "shortname", json_object_new_string(cardRegistry[idx]->shortname));
        if (cardRegistry[idx]->drivername)json_object_object_add(haldevJ, "drivername", json_object_new_string(cardRegistry[idx]->drivername));
        if (cardRegistry[idx]->longname) json_object_object_add(haldevJ, "longname", json_object_new_string(cardRegistry[idx]->longname));
        json_object_array_add(responseJ, haldevJ);
    }

    afb_req_success(request, responseJ, NULL);
}


// Register loaded HAL with board Name and API prefix

PUBLIC void alsaRegisterHal(afb_req_t request) {
    static int index = 0;
    json_object *responseJ;
    const char *shortname, *apiPrefix;

    apiPrefix = afb_req_value(request, "prefix");
    if (apiPrefix == NULL) {
        afb_req_fail_f(request, "argument-missing", "prefix=BindingApiPrefix missing");
        goto OnErrorExit;
    }

    shortname = afb_req_value(request, "sndname");
    if (shortname == NULL) {
        afb_req_fail_f(request, "argument-missing", "sndname=SndCardName missing");
        goto OnErrorExit;
    }

    if (index == MAX_SND_HAL) {
        afb_req_fail_f(request, "alsahal-toomany", "Fail to register sndname=[%s]", shortname);
        goto OnErrorExit;
    }

    // alsaGetCardId should be check to register only valid card
    responseJ = alsaProbeCardId(request);
    if (responseJ) {
        json_object *tmpJ;
        int done;

        cardRegistry[index] = malloc(sizeof (cardRegistry));
        cardRegistry[index]->apiprefix = strdup(apiPrefix);
        cardRegistry[index]->shortname = strdup(shortname);
        
        json_object_object_get_ex(responseJ, "cardid", &tmpJ);
        cardRegistry[index]->cardid = json_object_get_int(tmpJ);

        done = json_object_object_get_ex(responseJ, "devid", &tmpJ);
        if (done) cardRegistry[index]->devid = strdup(json_object_get_string(tmpJ));
        else cardRegistry[index]->devid = NULL;

        done = json_object_object_get_ex(responseJ, "drivername", &tmpJ);
        if (done) cardRegistry[index]->drivername = strdup(json_object_get_string(tmpJ));
        else cardRegistry[index]->drivername = NULL;

        done = json_object_object_get_ex(responseJ, "longname", &tmpJ);
        if (done) cardRegistry[index]->longname = strdup(json_object_get_string(tmpJ));
        else cardRegistry[index]->longname = NULL;

        // make sure register close with a null value
        index++;
        cardRegistry[index] = NULL;

        afb_req_success(request, responseJ, NULL);
    }

    // If OK return sound card Alsa ID+Info
    return;

OnErrorExit:
    return;
}

PUBLIC void alsaPcmInfo (afb_req_t request) {
    int done, mode, err;
    json_object *tmpJ, *responseJ = NULL;
    snd_pcm_t *pcmHandle = NULL;
    snd_pcm_info_t * pcmInfo = NULL;
    
    json_object* queryJ = afb_req_json(request);
    
    done = json_object_object_get_ex(queryJ, "name", &tmpJ);
    if (!done || json_object_get_type(tmpJ) != json_type_string) {
        afb_req_fail_f(request, "name:invalid", "PCM 'name:xxx' missing or not a string query='%s'", json_object_get_string(queryJ));
        goto OnErrorExit;
    }
    const char *pcmName = json_object_get_string(tmpJ);
    
    done = json_object_object_get_ex(queryJ, "stream", &tmpJ);
    if (done && json_object_get_type(tmpJ) != json_type_int) {
        afb_req_fail_f(request, "stream:invalid", "PCM 'stream:SND_PCM_STREAM_PLAYBACK/SND_PCM_STREAM_CAPTURE' should be integer query='%s'", json_object_get_string(queryJ));
        goto OnErrorExit;
    }
    snd_pcm_stream_t pcmStream = json_object_get_int(tmpJ);
    
    done = json_object_object_get_ex(queryJ, "mode", &tmpJ);
    if (!done) {
        mode = 0;
    } else {
        mode = json_object_get_int(tmpJ);        
    }
    
    // open PCM from its name
    err= snd_pcm_open(&pcmHandle, pcmName, pcmStream, 0);
    if (err < 0) {
        afb_req_fail_f(request, "pcm:invalid", "PCM 'name:%s' does cannot open error=%s", pcmName, snd_strerror(err));
        goto OnErrorExit;
    }
    
    // get pcm info
    snd_pcm_info_alloca(&pcmInfo);      
    err = snd_pcm_info(pcmHandle,pcmInfo);
    if (err < 0)  {
        afb_req_fail_f(request, "pcm:error", "PCM 'name:%s' fail to retrieve info error=%s", pcmName, snd_strerror(err));
        goto OnErrorExit;
    }

    // get sub-device number
    int cardId = snd_pcm_info_get_card(pcmInfo);
    if (cardId < 0 )   {
        afb_req_fail_f(request, "pcm:error", "PCM 'name:%s' fail to retrieve sndcard device error=%s", pcmName, snd_strerror(cardId));
        goto OnErrorExit;
    }
    
    // prepare an object for response
    responseJ = json_object_new_object();
    
    err = getHalApiFromCardid (cardId, responseJ);
    if (err < 0 )   {
        afb_req_fail_f(request, "pcm:error", "PCM 'name:%s' snddev=hw:%d fail to retrieve hal API", pcmName, cardId);
        goto OnErrorExit;
    }

    json_object_object_add(responseJ, "type", json_object_new_int(snd_pcm_type(pcmHandle)));

    // in mode mode we return full info about PCM
    if (mode > 0) {
        json_object_object_add(responseJ, "stream", json_object_new_int(snd_pcm_info_get_stream (pcmInfo)));
        json_object_object_add(responseJ, "cardid", json_object_new_int(snd_pcm_info_get_card(pcmInfo)));      
        json_object_object_add(responseJ, "devid" , json_object_new_int(snd_pcm_info_get_device (pcmInfo)));     
        json_object_object_add(responseJ, "subid" , json_object_new_int(snd_pcm_info_get_subdevice (pcmInfo)));     
    }
    
    // in super mode we also return information about snd card
    if (mode > 1) {
        
        json_object_object_add(responseJ, "id"     , json_object_new_string(snd_pcm_info_get_id (pcmInfo)));
        json_object_object_add(responseJ, "name"   , json_object_new_string(snd_pcm_info_get_name (pcmInfo)));
        json_object_object_add(responseJ, "subdev" , json_object_new_string(snd_pcm_info_get_subdevice_name (pcmInfo)));       
    }
    
    afb_req_success(request, responseJ, NULL);
    snd_pcm_close (pcmHandle);
    return;
    
OnErrorExit:
    if (responseJ) json_object_put (responseJ);
    if (pcmHandle) snd_pcm_close (pcmHandle);
    return;
}