summaryrefslogtreecommitdiffstats
path: root/plugins/radio/radio-api.h
blob: f126fc088021e5e5b66e4b73125267c4dc731f8b (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
/*
 * 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.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef RADIO_API_H
#define RADIO_API_H

/* -------------- PLUGIN DEFINITIONS ----------------- */

#define MAX_RADIO 10
typedef enum { FM, AM } Mode;

/* structure holding one radio device with current usage status */
typedef struct {
    int   idx;
    char *name;
    int  used;
} radioDevT;

/* global plugin handle, should store everything we may need */
typedef struct {
  radioDevT *radios[MAX_RADIO];  // pointer to existing radio
  unsigned int devCount;
} pluginHandleT;

/* private client context [will be destroyed when client leaves] */
typedef struct {
    radioDevT *radio;         /* pointer to client radio            */
    unsigned int idx;         /* radio index within global array    */
    Mode mode;                /* radio mode: AM/FM                  */
    float freq;               /* radio frequency (Mhz)              */
    unsigned char mute;       /* radio muted: 0(false)/1(true)      */
    unsigned char is_playing; /* radio is playing: 0(false)/1(true) */
} radioCtxHandleT;

#endif /* RADIO_API_H */