plugins/radio/radio-api.c

   1 /*
   2  * Copyright (C) 2015 "IoT.bzh"
   3  * Author "Manuel Bachmann"
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "radio-api.h"
  20 #include "radio-rtlsdr.h"
  21
  22 /* ********************************************************
  23
  24    FULUP integration proposal with client session context
  25
  26    ******************************************************** */
  27
  28 /* ------ LOCAL HELPER FUNCTIONS --------- */
  29
  30 /* detect new radio devices */
  31 STATIC void updateRadioDevList(pluginHandleT *handle) {
  32
  33   int idx;
  34
  35   // loop on existing radio if any
  36   for (idx = 0; idx < _radio_dev_count(); idx++) {
  37       if (idx == MAX_RADIO) break;
  38       handle->radios[idx] = calloc(1, sizeof(radioDevT)); /* use calloc to set used to FALSE */
  39       handle->radios[idx]->name = (char *) _radio_dev_name(idx);
  40   }
  41   handle->devCount = _radio_dev_count();
  42 }
  43
  44 /* global plugin context creation ; at loading time [radio devices might not be visible] */
  45 STATIC pluginHandleT* initRadioPlugin() {
  46
  47   pluginHandleT *handle;
  48
  49   handle = calloc (1, sizeof(pluginHandleT));
  50   updateRadioDevList (handle);
  51
  52   return handle;
  53 }
  54
  55 /* private client context creation ; default values */
  56 STATIC radioCtxHandleT* initRadioCtx () {
  57
  58     radioCtxHandleT *ctx;
  59
  60     ctx = malloc (sizeof(radioCtxHandleT));
  61     ctx->radio = NULL;
  62     ctx->idx = -1;
  63     ctx->mode = FM;
  64     ctx->freq = 100.0;
  65     ctx->mute = 0;
  66     ctx->is_playing = 0;
  67
  68     return ctx;
  69 }
  70
  71 /* reserve a radio device for requesting client, power it on */
  72 STATIC AFB_error reserveRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
  73     int idx;
  74
  75     /* loop on all devices, find an unused one */
  76     for (idx = 0; idx < _radio_dev_count(); idx++) {
  77         if (idx == MAX_RADIO) break;
  78         if (handle->radios[idx]->used == FALSE) goto found_radio; /* found one */
  79     }
  80     return AFB_FAIL;
  81
  82    found_radio:
  83     /* try to power it on, passing client context info such as frequency... */
  84     _radio_on (idx, ctx);
  85     /* TODO : try to re-iterate from the next ones if it failed ! */
  86
  87     /* globally mark it as reserved */
  88     handle->radios[idx]->used = TRUE;
  89
  90     /* store relevant info to client context (direct pointer, index) */
  91     ctx->radio = handle->radios[idx];
  92     ctx->idx = idx;
  93
  94     return AFB_SUCCESS;
  95 }
  96
  97 /* free a radio device from requesting client, power it off */
  98 STATIC AFB_error releaseRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
  99
 100     /* stop playing if it was doing this (blocks otherwise) */
 101     if (ctx->is_playing) {
 102         ctx->is_playing = 0;
 103         _radio_stop (ctx->idx);
 104     }
 105
 106     /* power it off */
 107     _radio_off (ctx->idx);
 108
 109     /* globally mark it as free */
 110     handle->radios[ctx->idx]->used = FALSE;
 111
 112     /* clean client context */
 113     ctx->radio = NULL;
 114     ctx->idx = -1;
 115
 116     return AFB_SUCCESS;
 117 }
 118
 119 /* called when client session dies [e.g. client quits for more than 15mns] */
 120 STATIC json_object* freeRadio (AFB_clientCtx *client) {
 121
 122     releaseRadio (client->plugin->handle, client->ctx);
 123     free (client->ctx);
 124
 125     return jsonNewMessage (AFB_SUCCESS, "Released radio and client context");
 126 }
 127
 128
 129 /* ------ PUBLIC PLUGIN FUNCTIONS --------- */
 130
 131 STATIC json_object* init (AFB_request *request) {       /* AFB_SESSION_CREATE */
 132
 133     radioCtxHandleT *ctx;
 134     json_object *jresp;
 135
 136     /* create a private client context */
 137     ctx = initRadioCtx();
 138     request->client->ctx = (radioCtxHandleT*)ctx;
 139
 140     jresp = json_object_new_object();
 141     json_object_object_add(jresp, "token", json_object_new_string (request->client->token));
 142     return jresp;
 143 }
 144
 145 STATIC json_object* power (AFB_request *request) {       /* AFB_SESSION_CHECK */
 146
 147     pluginHandleT *handle = request->client->plugin->handle;
 148     radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
 149     const char *value = getQueryValue (request, "value");
 150     json_object *jresp;
 151
 152     /* no "?value=" parameter : return current state */
 153     if (!value) {
 154         jresp = json_object_new_object();
 155         ctx->radio ?
 156             json_object_object_add (jresp, "power", json_object_new_string ("on"))
 157           : json_object_object_add (jresp, "power", json_object_new_string ("off"));
 158     }
 159
 160     /* "?value=" parameter is "1" or "true" */
 161     else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
 162         if (!ctx->radio) {
 163             if (reserveRadio (handle, ctx) == AFB_FAIL) {
 164                 request->errcode = MHD_HTTP_SERVICE_UNAVAILABLE;
 165                 return (jsonNewMessage (AFB_FAIL, "No more radio devices available"));
 166             }
 167         }
 168         jresp = json_object_new_object();
 169         json_object_object_add (jresp, "power", json_object_new_string ("on"));
 170     }
 171
 172     /* "?value=" parameter is "0" or "false" */
 173     else if ( atoi(value) == 0 || !strcasecmp(value, "false") ) {
 174         if (ctx->radio) {
 175             if (releaseRadio (handle, ctx) == AFB_FAIL) {
 176                 request->errcode = MHD_HTTP_SERVICE_UNAVAILABLE;
 177                 return (jsonNewMessage (AFB_FAIL, "Unable to release radio device"));
 178             }
 179         }
 180         jresp = json_object_new_object();
 181         json_object_object_add (jresp, "power", json_object_new_string ("off"));
 182     }
 183
 184     return jresp;
 185 }
 186
 187 STATIC json_object* mode (AFB_request *request) {        /* AFB_SESSION_CHECK */
 188
 189     radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
 190     const char *value = getQueryValue (request, "value");
 191     json_object *jresp = json_object_new_object();
 192
 193     /* no "?value=" parameter : return current state */
 194     if (!value || !ctx->radio) {
 195         ctx->mode ?
 196             json_object_object_add (jresp, "mode", json_object_new_string ("AM"))
 197           : json_object_object_add (jresp, "mode", json_object_new_string ("FM"));
 198     }
 199
 200     /* "?value=" parameter is "1" or "AM" */
 201     else if ( atoi(value) == 1 || !strcasecmp(value, "AM") ) {
 202         ctx->mode = AM;
 203         _radio_set_mode (ctx->idx, ctx->mode);
 204         json_object_object_add (jresp, "mode", json_object_new_string ("AM"));
 205     }
 206
 207     /* "?value=" parameter is "0" or "FM" */
 208     else if ( atoi(value) == 0 || !strcasecmp(value, "FM") ) {
 209         ctx->mode = FM;
 210         _radio_set_mode (ctx->idx, ctx->mode);
 211         json_object_object_add (jresp, "mode", json_object_new_string ("FM"));
 212     }
 213
 214     return jresp;
 215 }
 216
 217 STATIC json_object* freq (AFB_request *request) {        /* AFB_SESSION_CHECK */
 218
 219     radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
 220     const char *value = getQueryValue (request, "value");
 221     json_object *jresp = json_object_new_object();
 222     char freq_str[256];
 223
 224     /* no "?value=" parameter : return current state */
 225     if (!value || !ctx->radio) {
 226         snprintf (freq_str, sizeof(freq_str), "%f", ctx->freq);
 227         json_object_object_add (jresp, "freq", json_object_new_string (freq_str));
 228     }
 229
 230     /* "?value=" parameter, set frequency */
 231     else {
 232         ctx->freq = strtof (value, NULL);
 233         _radio_set_freq (ctx->idx, ctx->freq);
 234
 235         snprintf (freq_str, sizeof(freq_str), "%f", ctx->freq);
 236         json_object_object_add (jresp, "freq", json_object_new_string (freq_str));
 237     }
 238
 239     return jresp;
 240 }
 241
 242 STATIC json_object* mute (AFB_request *request) {        /* AFB_SESSION_CHECK */
 243
 244     radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
 245     const char *value = getQueryValue (request, "value");
 246     json_object *jresp = json_object_new_object();
 247     char *mute_str;
 248
 249     /* no "?value=" parameter : return current state */
 250     if (!value || !ctx->radio) {
 251         ctx->mute ?
 252             json_object_object_add (jresp, "mute", json_object_new_string ("on"))
 253           : json_object_object_add (jresp, "mute", json_object_new_string ("off"));
 254     }
 255
 256     /* "?value=" parameter is "1" or "true" */
 257     else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
 258         ctx->mute = 1;
 259         _radio_set_mute (ctx->idx, ctx->mute);
 260         json_object_object_add (jresp, "mute", json_object_new_string ("on"));
 261     }
 262
 263     /* "?value=" parameter is "0" or "false" */
 264     else if ( atoi(value) == 0 || !strcasecmp(value, "off") ) {
 265         ctx->mute = 0;
 266         _radio_set_mute (ctx->idx, ctx->mute);
 267         json_object_object_add (jresp, "mute", json_object_new_string ("off"));
 268     }
 269
 270     return jresp;
 271 }
 272
 273 STATIC json_object* play (AFB_request *request) {        /* AFB_SESSION_CHECK */
 274
 275     radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
 276     const char *value = getQueryValue (request, "value");
 277     json_object *jresp = json_object_new_object();
 278
 279     /* no "?value=" parameter : return current state */
 280     if (!value || !ctx->radio) {
 281         ctx->is_playing ?
 282             json_object_object_add (jresp, "play", json_object_new_string ("on"))
 283           : json_object_object_add (jresp, "play", json_object_new_string ("off"));
 284     }
 285
 286     /* "?value=" parameter is "1" or "true" */
 287     else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
 288         /* radio playback */
 289         ctx->is_playing = 1;
 290         _radio_play (ctx->idx);
 291         json_object_object_add (jresp, "play", json_object_new_string ("on"));
 292     }
 293
 294     /* "?value=" parameter is "0" or "false" */
 295     else if ( atoi(value) == 0 || !strcasecmp(value, "false") ) {
 296         /* radio stop */
 297         ctx->is_playing = 0;
 298         _radio_stop (ctx->idx);
 299         json_object_object_add (jresp, "play", json_object_new_string ("off"));
 300     }
 301
 302     return jresp;
 303 }
 304
 305 STATIC json_object* refresh (AFB_request *request) {     /* AFB_SESSION_RENEW */
 306     json_object *jresp = json_object_new_object();
 307     json_object_object_add(jresp, "token", json_object_new_string (request->client->token));
 308     return jresp;
 309 }
 310
 311 STATIC json_object* ping (AFB_request *request) {         /* AFB_SESSION_NONE */
 312     return jsonNewMessage(AFB_SUCCESS, "Ping Binder Daemon - Radio API");
 313 }
 314
 315
 316 STATIC AFB_restapi pluginApis[]= {
 317   {"init"   , AFB_SESSION_CREATE, (AFB_apiCB)init       , "Radio API - init"},
 318   {"power"  , AFB_SESSION_CHECK,  (AFB_apiCB)power      , "Radio API - power"},
 319   {"mode"   , AFB_SESSION_CHECK,  (AFB_apiCB)mode       , "Radio API - mode"},
 320   {"freq"   , AFB_SESSION_CHECK,  (AFB_apiCB)freq       , "Radio API - freq"},
 321   {"mute"   , AFB_SESSION_CHECK,  (AFB_apiCB)mute       , "Radio API - mute"},
 322   {"play"   , AFB_SESSION_CHECK,  (AFB_apiCB)play       , "Radio API - play"},
 323   {"refresh", AFB_SESSION_RENEW,  (AFB_apiCB)refresh    , "Radio API - refresh"},
 324   {"ping"   , AFB_SESSION_NONE,   (AFB_apiCB)ping       , "Radio API - ping"},
 325   {NULL}
 326 };
 327
 328 PUBLIC AFB_plugin* radioRegister () {
 329     AFB_plugin *plugin = malloc (sizeof(AFB_plugin));
 330     plugin->type  = AFB_PLUGIN_JSON;
 331     plugin->info  = "Application Framework Binder - Radio plugin";
 332     plugin->prefix  = "radio";
 333     plugin->apis  = pluginApis;
 334
 335     plugin->handle = initRadioPlugin();
 336     plugin->freeCtxCB = freeRadio;
 337
 338     return (plugin);
 339 };