plugins/radio/radio-api.h

   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 #ifndef RADIO_API_H
  20 #define RADIO_API_H
  21
  22 /* -------------- PLUGIN DEFINITIONS ----------------- */
  23
  24 #define MAX_RADIO 10
  25 typedef enum { FM, AM } Mode;
  26
  27 /* structure holding one radio device with current usage status */
  28 typedef struct {
  29     int   idx;
  30     char *name;
  31     int  used;
  32 } radioDevT;
  33
  34 /* global plugin handle, should store everything we may need */
  35 typedef struct {
  36   radioDevT *radios[MAX_RADIO];  // pointer to existing radio
  37   unsigned int devCount;
  38 } pluginHandleT;
  39
  40 /* private client context [will be destroyed when client leaves] */
  41 typedef struct {
  42     radioDevT *radio;         /* pointer to client radio            */
  43     unsigned int idx;         /* radio index within global array    */
  44     Mode mode;                /* radio mode: AM/FM                  */
  45     float freq;               /* radio frequency (Mhz)              */
  46     unsigned char mute;       /* radio muted: 0(false)/1(true)      */
  47     unsigned char is_playing; /* radio is playing: 0(false)/1(true) */
  48 } radioCtxHandleT;
  49
  50 #endif /* RADIO_API_H */