summaryrefslogtreecommitdiffstats
path: root/libsoundmanager/libsoundmanager.cpp
blob: c61f9d2af8547fc3d9b2042538db7fc6183276b8 (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
/*
 * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
 *
 * 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.
 */

#include <stdarg.h>
#include <sys/socket.h>
#include <iostream>
#include <algorithm>
#include <thread>
#include <errno.h>
#include <libsoundmanager.hpp>

#define ELOG(args,...) _ELOG(__FUNCTION__,__LINE__,args,##__VA_ARGS__)
#ifdef DEBUGMODE
 #define DLOG(args,...) _DLOG(__FUNCTION__,__LINE__,args,##__VA_ARGS__)
#else
 #define DLOG(args,...)
#endif
static void _DLOG(const char* func, const int line, const char* log, ...);
static void _ELOG(const char* func, const int line, const char* log, ...);

using namespace std;

static bool has_verb(const std::string& verb);
static const char API[] = "soundmanager";

static const std::vector<std::string> api_list{
	std::string("connect"),
    std::string("disconnect"),
	std::string("setVolume"),
	std::string("volumeStep"),
	std::string("setSinkMuteState"),
	std::string("getListMainConnections"),
    std::string("ackConnect"),
	std::string("ackDisconnect"),
    std::string("ackSetSourceState"),    
	std::string("registerSource"),
	std::string("deregisterSource"),
    std::string("subscribe"),
    std::string("unsubscribe")
};

static const std::vector<std::string> event_list{
    std::string("newMainConnection"),
    std::string("volumeChanged"),
	std::string("removedMainConnection"),
	std::string("sinkMuteStateChanged"),
	std::string("mainConnectionStateChanged"),
	std::string("setRoutingReady"),
	std::string("setRoutingRundown"),
	std::string("asyncConnect"),
	std::string("asyncSetSourceState")
};

static void _on_hangup_static(void *closure, struct afb_wsj1 *wsj)
{
	static_cast<LibSoundmanager*>(closure)->on_hangup(NULL,wsj);
}

static void _on_call_static(void *closure, const char *api, const char *verb, struct afb_wsj1_msg *msg)
{
	/* LibSoundmanager is not called from other process */
}

static void _on_event_static(void* closure, const char* event, struct afb_wsj1_msg *msg)
{
	static_cast<LibSoundmanager*>(closure)->on_event(NULL,event,msg);
}

static void _on_reply_static(void *closure, struct afb_wsj1_msg *msg)
{
	static_cast<LibSoundmanager*>(closure)->on_reply(NULL,msg);		
}

static void *event_loop_run(void *args)
{
	struct sd_event* loop = (struct sd_event*)(args);
	DLOG("start eventloop");
	for(;;)
		sd_event_run(loop, 30000000);
}

LibSoundmanager::LibSoundmanager()
{
}

LibSoundmanager::~LibSoundmanager()
{
	if(mploop)
	{
		sd_event_unref(mploop);
	}
	if(sp_websock != NULL)
	{
		afb_wsj1_unref(sp_websock);
	}
}


/**
 * This function is initialization function
 * 
 * #### Parameters
 * - port  [in] : This argument should be specified to the port number to be used for websocket
 * - token [in] : This argument should be specified to the token to be used for websocket
 *
 * #### Rreturn
 * Returns 0 on success or -1 in case of error.
 *
 * #### Note
 *
 */
int LibSoundmanager::init(int port, const string& token)
{
	int ret;
	if(port > 0 && token.size() > 0)
	{
		mport = port;
		mtoken = token;
	}
	else
	{
		ELOG("port and token should be > 0, Initial port and token uses.");
		return -1;
	}

	ret = initialize_websocket();
	if(ret != 0 )
	{
		ELOG("Failed to initialize websocket");
		return -1;
	}
	ret = init_event();
	if(ret != 0 )
	{
		ELOG("Failed to initialize websocket");
		return -1;
	}
	ret = run_eventloop();
	if(ret == -1){
		ELOG("Failed to create thread");
		return -1;
	}
	return 0;
}

int LibSoundmanager::initialize_websocket()
{
	mploop = NULL;
	onEvent = nullptr;
	onReply = nullptr;
	int ret = sd_event_default(&mploop);
	if(ret < 0)
	{
		ELOG("Failed to create event loop");
		goto END;
	}
	/* Initialize interface from websocket */
	{
	minterface.on_hangup = _on_hangup_static;
	minterface.on_call = _on_call_static;
	minterface.on_event = _on_event_static;
	string muri = "ws://localhost:" + to_string(mport) + "/api?token=" + mtoken;
	sp_websock = afb_ws_client_connect_wsj1(mploop, muri.c_str(), &minterface, this);
	}
	if(sp_websock == NULL)
	{
		ELOG("Failed to create websocket connection");
		goto END;
	}

	return 0;
END:
	if(mploop)
	{
		sd_event_unref(mploop);
	}
	return -1;
}

int LibSoundmanager::init_event(){
	/* subscribe most important event for sound right */
	return subscribe(string("asyncSetSourceState"));
}

/**
 * This function register callback function for reply/event message from sound manager
 * 
 * #### Parameters
 * - event_cb [in] : This argument should be specified to the callback for subscribed event
 * - reply_cb [in] : This argument should be specified to the reply callback for call function
 *
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * Event callback is invoked by sound manager for event you subscribed.
 * If you would like to get event, please call subscribe function before/after this function
 */
void LibSoundmanager::register_callback(
	void (*event_cb)(const string& event, struct json_object* event_contents), 
	void (*reply_cb)(struct json_object* reply_contents),
	void (*hangup_cb)(void))
{
	onEvent = event_cb;
	onReply = reply_cb;
	onHangup = hangup_cb;
}

void LibSoundmanager::register_callback(
	void (*reply_cb)(struct json_object* reply_contents),
	void (*hangup_cb)(void))
{
	onReply = reply_cb;
	onHangup = hangup_cb;
}

int LibSoundmanager::run_eventloop()
{
	if(mploop && sp_websock)
	{
		pthread_t thread_id;
	    int ret = pthread_create(&thread_id, NULL, event_loop_run, mploop);
		if(ret != 0)
		{
			ELOG("Cannot run eventloop due to error:%d", errno);
			return -1;
		}
		else
			return 0;
	}
	else
	{
		ELOG("Connecting is not established yet");
		return -1;
	}
}

/**
 * This function calls registerSource of Audio Manager via WebSocket
 * registerSource is registration as source for policy management
 * 
 * #### Parameters
 * - sourceName [in] : This argument should be specified to the source name (e.g. "MediaPlayer")
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * This function must be called to get source ID
 * mainConnectionID is returned by async reply function
 *
 */
int LibSoundmanager::registerSource(const string& sourceName)
{
	if(!sp_websock)
	{
		return -1;
	}
	struct json_object* j_obj = json_object_new_object();
	struct json_object* jsn = json_object_new_string(sourceName.c_str());
	json_object_object_add(j_obj, "appname", jsn);
	return this->call(__FUNCTION__, j_obj);
}

/**
 * This function calls connect of Audio Manager via WebSocket
 * connect is to get sound right
 * 
 * #### Parameters
 * - sourceID [in] : This argument should be specified to the sourceID as int. This parameter is returned value of registerSource
 * - sinkID   [in] : This argument should be specified to the sinkID as int. ID is specified by AudioManager
 *
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * This function must be called to get source right
 * connectionID is  
 *
 */
int LibSoundmanager::connect(int sourceID, int sinkID)
{
	if(!sp_websock)
	{
		return -1;
	}
	struct json_object* j_obj = json_object_new_object();
	struct json_object* jsource = json_object_new_int(sourceID);
	struct json_object* jsink = json_object_new_int(sinkID);
	json_object_object_add(j_obj, "sourceID", jsource);
	json_object_object_add(j_obj, "sinkID", jsink);
	return this->call(__FUNCTION__, j_obj);
}

/**
 * This function calls the connect of Audio Manager via WebSocket
 * 
 * #### Parameters
 * - sourceID   [in] : This argument should be specified to the sourceID as int. This parameter is returned value of registerSource
 * - sinkName   [in] : This argument should be specified to the sinkID as int. ID is aliased by SoundManager (e.g: "default")
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * For now, aliase(hardware abstraction) like "DriverZone:Speaker" is undier hard consideration
 * Just "default" is usable. "default" parameter is set by soundmanager
 *
 */
int LibSoundmanager::connect(int sourceID, const string& sinkName)
{
	if(!sp_websock)
	{
		return -1;
	}
	struct json_object* j_obj = json_object_new_object();
	struct json_object* jsource = json_object_new_int(sourceID);
	//struct json_object* jsink = json_object_new_int(1);
	struct json_object* jsink = json_object_new_string(sinkName.c_str());
	json_object_object_add(j_obj, "sourceID", jsource);
	json_object_object_add(j_obj, "sinkID", jsink);
	return this->call(__FUNCTION__, j_obj);
}

/**
 * This function calls the disconnect of Audio Manager via WebSocket
 * 
 * #### Parameters
 * - connectionID  [in] : This parameter is returned value of connect
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * 
 *
 */
int LibSoundmanager::disconnect(int connectionID)
{
	if(!sp_websock)
	{
		return -1;
	}
	struct json_object* j_obj = json_object_new_object();
	struct json_object* jconnection = json_object_new_int(connectionID);
	json_object_object_add(j_obj, "mainConnectionID", jconnection);
	return this->call(__FUNCTION__, j_obj);
}

/**
 * This function calls the ackSetSourceState of Audio Manager via WebSocket
 * 
 * #### Parameters
 * - sourceID  [in] : This parameter is returned value of ackSetSourceState
 * - handle    [in] : This parameter is returned value of ackSetSourceState
 * - errno     [in] : If you have some errors, input ohter than 0. 0 means acknowledge
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * This function must be called when application get asyncSetSourceState event
 * Input handle number attached in asyncSetSourceState and error number(0 is acknowledge)
 */
int LibSoundmanager::ackSetSourceState(int handle, int error)
{
	if(!sp_websock)
	{
		return -1;
	}
	struct json_object* j_obj = json_object_new_object();
	struct json_object* jhandle = json_object_new_int(handle);
	struct json_object* jerrno = json_object_new_int(error);
	json_object_object_add(j_obj, "handle", jhandle);
	json_object_object_add(j_obj, "error", jerrno);
	return this->call(__FUNCTION__, j_obj);
}

/**
 * This function calls the API of Audio Manager via WebSocket
 * 
 * #### Parameters
 * - verb [in] : This argument should be specified to the API name (e.g. "connect")
 * - arg  [in] : This argument should be specified to the argument of API. And this argument expects JSON object
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * To call Audio Manager's APIs, the application should set its function name, arguments to JSON format.
 *
 */
int LibSoundmanager::call(const string& verb, struct json_object* arg)
{
	int ret;
	if(!sp_websock)
	{
		return -1;
	}
	if (!has_verb(verb))
	{
		ELOG("verb doesn't exit");
		return -1;
	}
	ret = afb_wsj1_call_j(sp_websock, API, verb.c_str(), arg, _on_reply_static, this);
	if (ret < 0) {
		ELOG("Failed to call verb:%s",verb.c_str());
	}
	return ret;
}

/**
 * This function calls the API of Audio Manager via WebSocket
 * This function is overload function of "call"
 * 
 * #### Parameters
 * - verb [in] : This argument should be specified to the API name (e.g. "connect")
 * - arg  [in] : This argument should be specified to the argument of API. And this argument expects JSON object
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * To call Audio Manager's APIs, the application should set its function name, arguments to JSON format.
 * 
 */
int LibSoundmanager::call(const char* verb, struct json_object* arg)
{
	int ret;
	if(!sp_websock)
	{
		return -1;
	}
	if (!has_verb(string(verb)))
	{
		ELOG("verb doesn't exit");
		return -1;
	}
	ret = afb_wsj1_call_j(sp_websock, API, verb, arg, _on_reply_static, this);
	if (ret < 0) {
		ELOG("Failed to call verb:%s",verb);
	}
	return ret;
}

/**
 * Register callback function for each event
 * 
 * #### Parameters
 * - event_name [in] : This argument should be specified to the event name
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * This function enables to get an event to your callback function. 
 * Regarding the list of event name, please refer to CommandSender API and RountingSender API.
 *
 */
int LibSoundmanager::subscribe(const string& event_name)
{
	if(!sp_websock)
	{
		return -1;
	}
	struct json_object* j_obj = json_object_new_object();
	json_object_object_add(j_obj, "event", json_object_new_string(event_name.c_str()));

	int ret = afb_wsj1_call_j(sp_websock, API, "subscribe", j_obj, _on_reply_static, this);
	if (ret < 0) {
		ELOG("Failed to call verb:%s",__FUNCTION__);
	}
	return ret;
}

/**
 * Unregister callback function for each event
 * 
 * #### Parameters
 * - event_name [in] : This argument should be specified to the event name
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * This function disables to get an event to your callback function. 
 *
 */
int LibSoundmanager::unsubscribe(const string& event_name)
{
	if(!sp_websock)
	{
		return -1;
	}
	struct json_object* j_obj = json_object_new_object();
	json_object_object_add(j_obj, "event", json_object_new_string(event_name.c_str()));

	int ret = afb_wsj1_call_j(sp_websock, API, "unsubscribe", j_obj, _on_reply_static, this);
	if (ret < 0) {
		ELOG("Failed to call verb:%s",__FUNCTION__);
	}
	return ret;
}

/**
 * This function calls the ackSetSourceState of Audio Manager via WebSocket
 * 
 * #### Parameters
 * - EventType_AsyncSetSourceState     [in] : This parameter is EventType of soundmanager
 * - handler_func  [in] : This parameter is callback function
 *	
 * #### Rreturn
 * - Returns 0 on success or -1 in case of error.
 *
 * #### Note
 * This function must be called when application get asyncSetSourceState event
 * Input handle number attached in asyncSetSourceState and error number(0 is acknowledge)
 */
void LibSoundmanager::set_event_handler(enum EventType_AsyncSetSourceState et, handler_asyncSetSourceState f)
{
	if (et >= 1 && et <= 3) {
		this->handlers[et] = std::move(f);
	}
}


/************* Callback Function *************/

void LibSoundmanager::on_hangup(void *closure, struct afb_wsj1 *wsj)
{
	DLOG("%s called", __FUNCTION__);
	if(onHangup != nullptr)
	{
		onHangup();
	}
}

void LibSoundmanager::on_call(void *closure, const char *api, const char *verb, struct afb_wsj1_msg *msg)
{
}

/*
* event is like "soundmanager/newMainConnection"
* msg is like {"event":"soundmanager\/newMainConnection","data":{"mainConnectionID":3,"sourceID":101,"sinkID":100,"delay":0,"connectionState":4},"jtype":"afb-event"})}
*               ^key^   ^^^^^^^^^^^^ value ^^^^^^^^^^^^
* so you can get 
	event name : struct json_object obj = json_object_object_get(msg,"event")
*/ 
void LibSoundmanager::on_event(void *closure, const char *event, struct afb_wsj1_msg *msg)
{
	/* check event is for us */
	string ev = string(event);
	if (ev.find(API) == string::npos) {
		/* It's not us */
		return;
	}
	struct json_object* ev_contents = afb_wsj1_msg_object_j(msg);
	if((onEvent != nullptr))
	{
		onEvent(ev, ev_contents);
	}
	
	if(ev.find("asyncSetSourceState") != string::npos){
		// check sourceID is indicated to me
		struct json_object *json_data, *jSourceID, *jsourceState, *jhandle;
		json_object_object_get_ex(ev_contents, "data", &json_data);
		json_object_object_get_ex(json_data, "sourceID", &jSourceID);
		int sourceID = json_object_get_int(jSourceID);		
        /* This is not supported yet because application may have some sourceID.
		   Application has to check sourceID
		if(find( msourceIDs.begin(),msourceIDs.end(), sourceID) != msourceIDs.end()){
			json_object_put(ev_contents);
			return;
		}*/
		json_object_object_get_ex(json_data, "sourceState", &jsourceState);		
		json_object_object_get_ex(json_data, "handle", &jhandle);		
		string sourceState = string(json_object_get_string(jsourceState));
		int handle = json_object_get_int(jhandle);
		dispatch_asyncSetSourceState(sourceID, handle, sourceState);
		json_object_put(json_data);
		json_object_put(jSourceID);
		json_object_put(jsourceState);
		json_object_put(jhandle);
	}
	json_object_put(ev_contents);
}

void LibSoundmanager::on_reply(void *closure, struct afb_wsj1_msg *msg)
{
	struct json_object* reply = afb_wsj1_msg_object_j(msg);
	/*struct json_object *json_data = json_object_object_get(reply, "response");
	struct json_object *jverb = json_object_object_get(json_data, "verb");
	const char* cverb = json_object_get_string(jverb);
	DLOG("cverb is %s",cverb);
	string verb = string(cverb);
	DLOG("verb is %s",verb.c_str());
	
	if(verb == "registerSource"){
		struct json_object *jsourceID = json_object_object_get(json_data, "sourceID");
		int sourceID = json_object_get_int(jsourceID);
		msourceIDs.push_back(sourceID);
		DLOG("my sourceID is created: %d", sourceID);
	}*/
	if(onReply != nullptr)
	{
		onReply(reply);
	}
	json_object_put(reply);	
}

int LibSoundmanager::dispatch_asyncSetSourceState(int sourceID, int handle, const string& sourceState){
	//dipatch event
	EventType_AsyncSetSourceState x;
	if(sourceState == "on"){
		x = Event_AsyncSetSourceState_On;
	}else if(sourceState == "off"){
		x = Event_AsyncSetSourceState_Off;
	}else if(sourceState == "pause"){
		x = Event_AsyncSetSourceState_Pause;
	}
	auto i = this->handlers.find(x);
	if(i != handlers.end()){
		i->second(sourceID, handle);
		return 0;
	}
	else{
		return -1;
	}
}

/* Internal Function in libsoundmanager */

static void _ELOG(const char* func, const int line, const char* log, ...)
{
	char *message;
	va_list args;
	va_start(args, log);
	if (log == NULL || vasprintf(&message, log, args) < 0)
		message = NULL;
	cout << "[ERROR: soundmanager]" << func << "(" << line << "):" << message << endl; 
	va_end(args);
	free(message);
}

static void _DLOG(const char* func, const int line, const char* log, ...)
{
	char *message;
	va_list args;
	va_start(args, log);
	if (log == NULL || vasprintf(&message, log, args) < 0)
		message = NULL;
	cout << "[DEBUG: soundmanager]" << func << "(" << line << "):" << message << endl; 
	va_end(args);
	free(message);
}

static bool has_verb(const string& verb)
{
	if(find(api_list.begin(), api_list.end(), verb) != api_list.end())
		return true;
	else
		return false;
}