aboutsummaryrefslogtreecommitdiffstats
path: root/bindings/radio/radio-api.c
blob: 9c1fef6ce2357baeffd4b3408f6b20149d487f2e (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
/*
 * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
 * Author "Manuel Bachmann"
 *
 * 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
#include <strings.h>
#include <json-c/json.h>

#include "radio-api.h"
#include "radio-rtlsdr.h"

#include <afb/afb-binding.h>
#include <afb/afb-req-itf.h>

/* ********************************************************

   FULUP integration proposal with client session context

   ******************************************************** */

/* ------ LOCAL HELPER FUNCTIONS --------- */

static pluginHandleT *the_radio = NULL;

/* detect new radio devices */
void updateRadioDevList(pluginHandleT *handle) {

  int idx;

  // loop on existing radio if any
  for (idx = 0; idx < _radio_dev_count(); idx++) {
      if (idx == MAX_RADIO) break;
      handle->radios[idx] = calloc(1, sizeof(radioDevT)); /* use calloc to set "used" to FALSE */
      handle->radios[idx]->name = (char *) _radio_dev_name(idx);
  }
  handle->devCount = _radio_dev_count();
}

/* global plugin context creation ; at loading time [radio devices might not be visible] */
static void initRadioPlugin() {

  pluginHandleT *handle;

  handle = calloc (1, sizeof(pluginHandleT));
  updateRadioDevList (handle);
  the_radio = handle;
}

/* private client context creation ; default values */
static radioCtxHandleT* initRadioCtx () {

    radioCtxHandleT *ctx;

    ctx = malloc (sizeof(radioCtxHandleT));
    ctx->radio = NULL;
    ctx->idx = -1;
    ctx->mode = FM;
    ctx->freq = 100.0;
    ctx->mute = 0;
    ctx->is_playing = 0;

    return ctx;
}

/* reserve a radio device for requesting client, power it on */
unsigned char reserveRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {

    unsigned int idx;

    /* loop on all devices, find an unused one */
    for (idx = 0; idx < _radio_dev_count(); idx++) {
        if (idx == MAX_RADIO) break;
        if (handle->radios[idx]->used == FALSE) goto found_radio; /* found one */
    }
    return 0;

  found_radio:
    /* try to power it on, passing client context info such as frequency... */

    _radio_on (idx, ctx);
    /* TODO : try to re-iterate from the next ones if it failed ! */

    /* globally mark it as reserved */
    handle->radios[idx]->used = TRUE;

    /* store relevant info to client context (direct pointer, index) */
    ctx->radio = handle->radios[idx];
    ctx->idx = idx;

    return 1;
}

/* free a radio device from requesting client, power it off */
unsigned char releaseRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {

    /* stop playing if it was doing this (blocks otherwise) */
    if (ctx->is_playing) {
        ctx->is_playing = 0;
        _radio_stop (ctx->idx);
    }

    /* power it off */
    _radio_off (ctx->idx);

    /* globally mark it as free */
    handle->radios[ctx->idx]->used = FALSE;

    /* clean client context */
    ctx->radio = NULL;
    ctx->idx = -1;

    return 1;
}

/* called when client session dies [e.g. client quits for more than 15mns] */
static void freeRadio (void *context) {

    releaseRadio (the_radio, context);
    free (context);
}


/* ------ PUBLIC PLUGIN FUNCTIONS --------- */

static void init (struct afb_req request) {        /* AFB_SESSION_CHECK */

    radioCtxHandleT *ctx = afb_req_context_get (request);
    json_object *jresp;

    /* create a global plugin handle */
    if (!the_radio)
        initRadioPlugin();

    /* create a private client context */
    if (!ctx) {
        ctx = initRadioCtx();
        afb_req_context_set (request, ctx, free);
    }

    jresp = json_object_new_object();
    json_object_object_add(jresp, "init", json_object_new_string ("success"));
    afb_req_success (request, jresp, "Radio initialized");
}

static void power (struct afb_req request) {       /* AFB_SESSION_CHECK */

    pluginHandleT *handle = the_radio;
    radioCtxHandleT *ctx = afb_req_context_get (request);
    const char *value = afb_req_value (request, "value");
    json_object *jresp;

	if (!ctx) {
        afb_req_fail (request, "failed", "you must call 'init' first");
        return;
    }
    jresp = json_object_new_object();

    /* no "?value=" parameter : return current state */
    if (!value) {
        ctx->radio ?
            json_object_object_add (jresp, "power", json_object_new_string ("on"))
          : json_object_object_add (jresp, "power", json_object_new_string ("off"));
        afb_req_success (request, jresp, "Radio - Power status obtained");
        return;
    }

    /* "?value=" parameter is "1" or "true" */
    else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
        if (!ctx->radio) {
            if (!reserveRadio (handle, ctx)) {
                afb_req_fail (request, "failed", "no more radio devices available");
		        return;
            }
        }
        json_object_object_add (jresp, "power", json_object_new_string ("on"));
    }

    /* "?value=" parameter is "0" or "false" */
    else if ( atoi(value) == 0 || !strcasecmp(value, "false") ) {
        if (ctx->radio) {
            if (!releaseRadio (handle, ctx)) {
                afb_req_fail (request, "failed", "Unable to release radio device");
		        return;
            }
        }
        json_object_object_add (jresp, "power", json_object_new_string ("off"));
    }
    else
        jresp = NULL;

    afb_req_success (request, jresp, "Radio - Power set");
}

static void mode (struct afb_req request) {        /* AFB_SESSION_CHECK */

    radioCtxHandleT *ctx = afb_req_context_get (request);
    const char *value = afb_req_value (request, "value");
    json_object *jresp;

	if (!ctx) {
        afb_req_fail (request, "failed", "you must call 'init' first");
        return;
    }
    jresp = json_object_new_object();

    /* no "?value=" parameter : return current state */
    if (!value || !ctx->radio) {
        ctx->mode ?
            json_object_object_add (jresp, "mode", json_object_new_string ("AM"))
          : json_object_object_add (jresp, "mode", json_object_new_string ("FM"));
    }

    /* "?value=" parameter is "1" or "AM" */
    else if ( atoi(value) == 1 || !strcasecmp(value, "AM") ) {
        ctx->mode = AM;
        _radio_set_mode (ctx->idx, ctx->mode);
        json_object_object_add (jresp, "mode", json_object_new_string ("AM"));
    }

    /* "?value=" parameter is "0" or "FM" */
    else if ( atoi(value) == 0 || !strcasecmp(value, "FM") ) {
        ctx->mode = FM;
        _radio_set_mode (ctx->idx, ctx->mode);
        json_object_object_add (jresp, "mode", json_object_new_string ("FM"));
    }

    afb_req_success (request, jresp, "Radio - Mode set");
}

static void freq (struct afb_req request) {        /* AFB_SESSION_CHECK */

    radioCtxHandleT *ctx = afb_req_context_get (request);
    const char *value = afb_req_value (request, "value");
    json_object *jresp;
    double freq;
    char freq_str[256];

	if (!ctx) {
        afb_req_fail (request, "failed", "you must call 'init' first");
        return;
    }
    jresp = json_object_new_object();

    /* no "?value=" parameter : return current state */
    if (!value || !ctx->radio) {
        snprintf (freq_str, sizeof(freq_str), "%f", ctx->freq);
        json_object_object_add (jresp, "freq", json_object_new_string (freq_str));
    }

    /* "?value=" parameter, set frequency */
    else {
        freq = strtod (value, NULL);
        _radio_set_freq (ctx->idx, freq);
        ctx->freq = (float)freq;

        snprintf (freq_str, sizeof(freq_str), "%f", ctx->freq);
        json_object_object_add (jresp, "freq", json_object_new_string (freq_str));
    }

    afb_req_success (request, jresp, "Radio - Frequency Set");
}

static void mute (struct afb_req request) {        /* AFB_SESSION_CHECK */

    radioCtxHandleT *ctx = afb_req_context_get (request);
    const char *value = afb_req_value (request, "value");
    json_object *jresp = json_object_new_object();

	if (!ctx) {
        afb_req_fail (request, "failed", "you must call 'init' first");
        return;
    }

    /* no "?value=" parameter : return current state */
    if (!value || !ctx->radio) {
        ctx->mute ?
            json_object_object_add (jresp, "mute", json_object_new_string ("on"))
          : json_object_object_add (jresp, "mute", json_object_new_string ("off"));
    }

    /* "?value=" parameter is "1" or "true" */
    else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
        ctx->mute = 1;
        _radio_set_mute (ctx->idx, ctx->mute);
        json_object_object_add (jresp, "mute", json_object_new_string ("on"));
    }

    /* "?value=" parameter is "0" or "false" */
    else if ( atoi(value) == 0 || !strcasecmp(value, "off") ) {
        ctx->mute = 0;
        _radio_set_mute (ctx->idx, ctx->mute);
        json_object_object_add (jresp, "mute", json_object_new_string ("off"));
    }

    afb_req_success (request, jresp, "Radio - Mute set");
}

static void play (struct afb_req request) {        /* AFB_SESSION_CHECK */

    radioCtxHandleT *ctx = afb_req_context_get (request);
    const char *value = afb_req_value (request, "value");
    json_object *jresp = json_object_new_object();

	if (!ctx) {
        afb_req_fail (request, "failed", "you must call 'init' first");
        return;
    }

    /* no "?value=" parameter : return current state */
    if (!value || !ctx->radio) {
        ctx->is_playing ?
            json_object_object_add (jresp, "play", json_object_new_string ("on"))
          : json_object_object_add (jresp, "play", json_object_new_string ("off"));
    }

    /* "?value=" parameter is "1" or "true" */
    else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
        /* radio playback */
        ctx->is_playing = 1;
        _radio_play (ctx->idx);
        json_object_object_add (jresp, "play", json_object_new_string ("on"));
    }

    /* "?value=" parameter is "0" or "false" */
    else if ( atoi(value) == 0 || !strcasecmp(value, "false") ) {
        /* radio stop */
        ctx->is_playing = 0;
        _radio_stop (ctx->idx);
        json_object_object_add (jresp, "play", json_object_new_string ("off"));
    }

    afb_req_success (request, jresp, "Radio - Play succeeded");
}

static void ping (struct afb_req request) {         /* AFB_SESSION_NONE */
    afb_req_success (request, NULL, "Radio - Ping succeeded");
}


static const struct afb_verb_desc_v1 verbs[] = {
  {"init"   , AFB_SESSION_CHECK,  init       , "Radio API - init"},
  {"power"  , AFB_SESSION_CHECK,  power      , "Radio API - power"},
  {"mode"   , AFB_SESSION_CHECK,  mode       , "Radio API - mode"},
  {"freq"   , AFB_SESSION_CHECK,  freq       , "Radio API - freq"},
  {"mute"   , AFB_SESSION_CHECK,  mute       , "Radio API - mute"},
  {"play"   , AFB_SESSION_CHECK,  play       , "Radio API - play"},
  {"ping"   , AFB_SESSION_NONE,   ping       , "Radio API - ping"},
  {NULL}
};

static const struct afb_binding pluginDesc = {
    .type  = AFB_BINDING_VERSION_1,
    .v1 = {
        .info  = "Application Framework Binder - Radio plugin",
        .prefix  = "radio",
        .verbs  = verbs
    }
};

const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *itf)
{
	return &pluginDesc;
}