Update Radio plugin, Media plugin
[src/app-framework-binder.git] / plugins / radio / radio-api.c
index 02f6330..d3d04ae 100644 (file)
@@ -1,23 +1,30 @@
 /*
  * Copyright (C) 2015 "IoT.bzh"
+ * Author "Manuel Bachmann"
  *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ * 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
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 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-plugin.h"
+#include "afb-req-itf.h"
+
 /* ********************************************************
 
    FULUP integration proposal with client session context
 
 /* ------ LOCAL HELPER FUNCTIONS --------- */
 
+static pluginHandleT *the_radio = NULL;
+
 /* detect new radio devices */
-STATIC void updateRadioDevList(pluginHandleT *handle) {
+void updateRadioDevList(pluginHandleT *handle) {
 
   int idx;  
 
@@ -41,18 +50,16 @@ STATIC void updateRadioDevList(pluginHandleT *handle) {
 }
 
 /* global plugin context creation ; at loading time [radio devices might not be visible] */
-STATIC pluginHandleT* initRadioPlugin() {
+static void initRadioPlugin() {
 
-  pluginHandleT *handle;
+  pluginHandleT *handle = the_radio;
 
   handle = calloc (1, sizeof(pluginHandleT));
   updateRadioDevList (handle);
-
-  return handle;
 }
 
 /* private client context creation ; default values */
-STATIC radioCtxHandleT* initRadioCtx () {
+static radioCtxHandleT* initRadioCtx () {
 
     radioCtxHandleT *ctx;
 
@@ -68,15 +75,15 @@ STATIC radioCtxHandleT* initRadioCtx () {
 }
 
 /* reserve a radio device for requesting client, power it on */
-STATIC AFB_error reserveRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
-    int idx;
+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 AFB_FAIL;
+    return 0;
 
    found_radio:
     /* try to power it on, passing client context info such as frequency... */
@@ -90,46 +97,63 @@ STATIC AFB_error reserveRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
     ctx->radio = handle->radios[idx];
     ctx->idx = idx;
 
-    return AFB_SUCCESS;
+    return 1;
 }
 
 /* free a radio device from requesting client, power it off */
-STATIC AFB_error releaseRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
+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);
+    /* power it off */
+    _radio_off (ctx->idx);
 
-   /* globally mark it as free */
-   handle->radios[ctx->idx]->used = FALSE;
+    /* globally mark it as free */
+    handle->radios[ctx->idx]->used = FALSE;
 
-   /* clean client context */
-   ctx->radio = NULL;
-   ctx->idx = -1;
+    /* clean client context */
+    ctx->radio = NULL;
+    ctx->idx = -1;
 
-   return AFB_SUCCESS;
+    return 1;
 }
 
 /* called when client session dies [e.g. client quits for more than 15mns] */
-STATIC json_object* freeRadio (AFB_clientCtx *client) {
+static void freeRadio (void *context) {
 
-    releaseRadio (client->plugin->handle, client->ctx);
-    free (client->ctx);
-    
-    return jsonNewMessage (AFB_SUCCESS, "Released radio and client context");
+    releaseRadio (the_radio, context);
+    free (context);
 }
 
 
 /* ------ PUBLIC PLUGIN FUNCTIONS --------- */
 
-STATIC json_object* power (AFB_request *request) {      /* AFB_SESSION_CREATE */
-    
-    pluginHandleT *handle = request->client->plugin->handle; 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
-    const char *value = getQueryValue (request, "value");
+static void init (struct afb_req request) {        /* AFB_SESSION_CHECK */
+
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
     json_object *jresp;
 
-    /* create a private client context if needed */
-    if (!ctx) ctx = initRadioCtx();
+    /* 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 = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
+    json_object *jresp;
 
     /* no "?value=" parameter : return current state */
     if (!value) {
@@ -139,188 +163,179 @@ STATIC json_object* power (AFB_request *request) {      /* AFB_SESSION_CREATE */
           : json_object_object_add (jresp, "power", json_object_new_string ("off"));
     }
 
-    /* "?value=" parameter is "1" or "on" */
-    else if ( atoi(value) == 1 || !strcasecmp(value, "on") ) {
+    /* "?value=" parameter is "1" or "true" */
+    else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
         if (!ctx->radio) {
-            if (reserveRadio (handle, ctx) == AFB_FAIL) {
-                request->errcode = MHD_HTTP_SERVICE_UNAVAILABLE;
-                return (jsonNewMessage (AFB_FAIL, "No more radio devices available"));
+            if (!reserveRadio (handle, ctx)) {
+                afb_req_fail (request, "failed", "no more radio devices available");
+                       return;
             }
         }
         jresp = json_object_new_object();
         json_object_object_add (jresp, "power", json_object_new_string ("on"));
     }
 
-    /* "?value=" parameter is "0" or "off" */
-    else if ( atoi(value) == 0 || !strcasecmp(value, "off") ) {
+    /* "?value=" parameter is "0" or "false" */
+    else if ( atoi(value) == 0 || !strcasecmp(value, "false") ) {
         if (ctx->radio) {
-            if (releaseRadio (handle, ctx) == AFB_FAIL) {
-                request->errcode = MHD_HTTP_SERVICE_UNAVAILABLE;
-                return (jsonNewMessage (AFB_FAIL, "Unable to release radio device"));
+            if (!releaseRadio (handle, ctx)) {
+                afb_req_fail (request, "failed", "Unable to release radio device");
+                       return;
             }
         }
         jresp = json_object_new_object();
         json_object_object_add (jresp, "power", json_object_new_string ("off"));
     }
+    else
+        jresp = NULL;
 
-    return jresp;
+    afb_req_success (request, jresp, "Radio - Power set");
 }
 
-STATIC json_object* mode (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void mode (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
-    const char *value = getQueryValue (request, "value");
-    json_object *jresp;
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
+    json_object *jresp = json_object_new_object();
 
     /* no "?value=" parameter : return current state */
-    if (!value) {
-        jresp = json_object_new_object();
+    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 "on" */
+    /* "?value=" parameter is "1" or "AM" */
     else if ( atoi(value) == 1 || !strcasecmp(value, "AM") ) {
         ctx->mode = AM;
         _radio_set_mode (ctx->idx, ctx->mode);
-
-        jresp = json_object_new_object();
         json_object_object_add (jresp, "mode", json_object_new_string ("AM"));
     }
 
-    /* "?value=" parameter is "0" or "off" */
+    /* "?value=" parameter is "0" or "FM" */
     else if ( atoi(value) == 0 || !strcasecmp(value, "FM") ) {
         ctx->mode = FM;
         _radio_set_mode (ctx->idx, ctx->mode);
-
-        jresp = json_object_new_object();
         json_object_object_add (jresp, "mode", json_object_new_string ("FM"));
     }
-    
-    return jresp;
+
+    afb_req_success (request, jresp, "Radio - Mode set");
 }
 
-STATIC json_object* freq (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void freq (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
-    const char *value = getQueryValue (request, "value");
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
     json_object *jresp = json_object_new_object();
+    double freq;
     char freq_str[256];
 
     /* no "?value=" parameter : return current state */
-    if (!value) {
+    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 {
-        ctx->freq = strtof (value, NULL);
-        _radio_set_freq (ctx->idx, ctx->freq);
-        
+        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));
     }
-    
-    return jresp;
+
+    afb_req_success (request, jresp, "Radio - Frequency Set");
 }
 
-STATIC json_object* mute (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void mute (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
-    const char *value = getQueryValue (request, "value");
-    json_object *jresp;
-    char *mute_str;
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
+    json_object *jresp = json_object_new_object();
 
     /* no "?value=" parameter : return current state */
-    if (!value) {
+    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 "on" */
-    else if ( atoi(value) == 1 || !strcasecmp(value, "on") ) {
+    /* "?value=" parameter is "1" or "true" */
+    else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
         ctx->mute = 1;
         _radio_set_mute (ctx->idx, ctx->mute);
-        
-        jresp = json_object_new_object();
         json_object_object_add (jresp, "mute", json_object_new_string ("on"));
     }
 
-    /* "?value=" parameter is "0" or "off" */
+    /* "?value=" parameter is "0" or "false" */
     else if ( atoi(value) == 0 || !strcasecmp(value, "off") ) {
         ctx->mute = 0;
         _radio_set_mute (ctx->idx, ctx->mute);
-        
-        jresp = json_object_new_object();
         json_object_object_add (jresp, "mute", json_object_new_string ("off"));
     }
-    
-    return jresp;
+
+    afb_req_success (request, jresp, "Radio - Mute set"); 
 }
 
-STATIC json_object* play (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void play (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->client->ctx;
-    const char *value = getQueryValue (request, "value");
-    json_object *jresp;
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
+    json_object *jresp = json_object_new_object();
     
     /* no "?value=" parameter : return current state */
-    if (!value) {
+    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 "on" */
-    else if ( atoi(value) == 1 || !strcasecmp(value, "on") ) {
+    /* "?value=" parameter is "1" or "true" */
+    else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
         /* radio playback */
         ctx->is_playing = 1;
         _radio_play (ctx->idx);
-
-        jresp = json_object_new_object();
         json_object_object_add (jresp, "play", json_object_new_string ("on"));
     }
 
-    /* "?value=" parameter is "0" or "off" */
-    else if ( atoi(value) == 0 || !strcasecmp(value, "off") ) {
+    /* "?value=" parameter is "0" or "false" */
+    else if ( atoi(value) == 0 || !strcasecmp(value, "false") ) {
         /* radio stop */
         ctx->is_playing = 0;
         _radio_stop (ctx->idx);
-
-        jresp = json_object_new_object();
-        json_object_object_add (jresp, "play-on", json_object_new_string ("off"));
+        json_object_object_add (jresp, "play", json_object_new_string ("off"));
     }
 
-    return jresp;
+    afb_req_success (request, jresp, "Radio - Play succeeded");
 }
 
-STATIC json_object* status (AFB_request *request) {
-    return NULL;
+static void ping (struct afb_req request) {         /* AFB_SESSION_NONE */
+    afb_req_success (request, NULL, "Radio - Ping succeeded");
 }
 
 
-STATIC AFB_restapi pluginApis[]= {
-  {"power"  , AFB_SESSION_CREATE, (AFB_apiCB)power      , "Radio API - power"},
-  {"mode"   , AFB_SESSION_CHECK,  (AFB_apiCB)mode       , "Radio API - mode"},
-  {"freq"   , AFB_SESSION_CHECK,  (AFB_apiCB)freq       , "Radio API - freq"},
-  {"mute"   , AFB_SESSION_CHECK,  (AFB_apiCB)mute       , "Radio API - mute"},
-  {"play"   , AFB_SESSION_CHECK,  (AFB_apiCB)play       , "Radio API - play"},
-  {"status" , AFB_SESSION_RENEW,  (AFB_apiCB)status     , "Radio API - status"},
+static const struct AFB_restapi pluginApis[]= {
+  {"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}
 };
 
-PUBLIC AFB_plugin* radioRegister () {
-    AFB_plugin *plugin = malloc (sizeof(AFB_plugin));
-    plugin->type  = AFB_PLUGIN_JSON;
-    plugin->info  = "Application Framework Binder - Radio plugin";
-    plugin->prefix  = "radio";
-    plugin->apis  = pluginApis;
-
-    plugin->handle = initRadioPlugin();
-    plugin->freeCtxCB = freeRadio;
-
-    return (plugin);
+static const struct AFB_plugin pluginDesc = {
+    .type  = AFB_PLUGIN_JSON,
+    .info  = "Application Framework Binder - Radio plugin",
+    .prefix  = "radio",
+    .apis  = pluginApis
 };
+
+const struct AFB_plugin *pluginRegister (const struct AFB_interface *itf)
+{
+    initRadioPlugin();
+       return &pluginDesc;
+}