src/daemon/client.h

   1 /*
   2  * Copyright (c) 2012, Intel Corporation
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *   * Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *   * Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  *   * Neither the name of Intel Corporation nor the names of its contributors
  14  *     may be used to endorse or promote products derived from this software
  15  *     without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __SRS_DAEMON_CLIENT_H__
  31 #define __SRS_DAEMON_CLIENT_H__
  32
  33 typedef struct srs_client_s srs_client_t;
  34
  35 #include "src/daemon/context.h"
  36 #include "src/daemon/resourceif.h"
  37
  38
  39 /*
  40  * client types
  41  */
  42
  43 typedef enum {
  44     SRS_CLIENT_TYPE_UNKNOWN = 0,
  45     SRS_CLIENT_TYPE_DBUS,                /* external D-BUS client */
  46     SRS_CLIENT_TYPE_BUILTIN,             /* builtin client */
  47 } srs_client_type_t;
  48
  49
  50 /*
  51  * voice focus types
  52  */
  53
  54 typedef enum {
  55     SRS_VOICE_FOCUS_NONE = 0,            /* focus released */
  56     SRS_VOICE_FOCUS_SHARED,              /* normal shared voice focus */
  57     SRS_VOICE_FOCUS_EXCLUSIVE,           /* exclusive voice focus */
  58 } srs_voice_focus_t;
  59
  60
  61 /*
  62  * client commands
  63  */
  64
  65 #define SRS_MAX_TOKENS 64
  66
  67 typedef struct {
  68     char **tokens;                       /* tokens of this command */
  69     int    ntoken;                       /* number of tokens */
  70 } srs_command_t;
  71
  72
  73 /*
  74  * special command tokens
  75  */
  76
  77 #define SRS_TOKEN_SWITCHDICT "__switch_dict__"
  78 #define SRS_TOKEN_PUSHDICT   "__push_dict__"
  79 #define SRS_TOKEN_POPDICT    "__pop_dict__"
  80 #define SRS_TOKEN_WILDCARD   "*"
  81
  82
  83 /* dictionary pseudo-commands */
  84 #define SRS_DICTCMD_SWITCH    "__switch_dict__"
  85 #define SRS_DICTCMD_PUSH      "__push_dict__"
  86 #define SRS_DICTCMD_POP       "__pop_dict__"
  87
  88 #define SRS_DICT_SWITCH(dict) SRS_DICTCMD_SWITCH"("dict")"
  89 #define SRS_DICT_PUSH(dict)   SRS_DICTCMD_PUSH"("dict")"
  90 #define SRS_DICT_POP()        SRS_DICTCMD_POP
  91
  92
  93 /*
  94  * special tokens
  95  */
  96
  97 #define SRS_TOKEN_SWITCHDICT "__switch_dict__"
  98 #define SRS_TOKEN_PUSHDICT   "__push_dict__"
  99 #define SRS_TOKEN_POPDICT    "__pop_dict__"
 100
 101 #define SRS_TOKEN_WILDCARD "*"           /* match till end of utterance */
 102
 103 /*
 104  * dictionary operations
 105  */
 106
 107 /* dictionary operations */
 108 typedef enum {
 109     SRS_DICT_OP_UNKNOWN = 0,
 110     SRS_DICT_OP_SWITCH,
 111     SRS_DICT_OP_PUSH,
 112     SRS_DICT_OP_POP
 113 } srs_dict_op_t;
 114
 115
 116 /*
 117  * connected clients
 118  */
 119
 120 typedef struct {
 121     int (*notify_focus)(srs_client_t *c, srs_voice_focus_t focus);
 122     int (*notify_command)(srs_client_t *c, int ntoken, char **tokens);
 123 } srs_client_ops_t;
 124
 125
 126 struct srs_client_s {
 127     mrp_list_hook_t         hook;        /* to list of clients */
 128     srs_client_type_t       type;        /* client type */
 129     char                   *name;        /* client name */
 130     char                   *appclass;    /* client application class */
 131     srs_command_t          *commands;    /* client command set */
 132     int                     ncommand;    /* number of commands */
 133     char                   *id;          /* client id */
 134     srs_context_t          *srs;         /* context back pointer */
 135     mrp_res_resource_set_t *rset;        /* resource set */
 136     srs_voice_focus_t       requested;   /* requested voice focus */
 137     srs_voice_focus_t       granted;     /* granted voice focus */
 138     srs_voice_focus_t       focus;       /* requested voice focus */
 139     int                     enabled : 1; /* interested in commands */
 140     int                     allowed : 1; /* has resource granted */
 141     srs_client_ops_t        ops;         /* client ops (notifications)  */
 142     void                   *user_data;   /* opaque client data */
 143 };
 144
 145
 146 /** Create a new client. */
 147 srs_client_t *client_create(srs_context_t *srs, srs_client_type_t type,
 148                             const char *name, const char *appclass,
 149                             char **commands, int ncommand,
 150                             const char *id, srs_client_ops_t *ops,
 151                             void *user_data);
 152
 153 /** Destroy a client. */
 154 void client_destroy(srs_client_t *c);
 155
 156 /** Look up a client by its id. */
 157 srs_client_t *client_lookup_by_id(srs_context_t *srs, const char *id);
 158
 159 /** Request client focus change. */
 160 int client_request_focus(srs_client_t *c, srs_voice_focus_t focus);
 161
 162 /** Create resources for all registered clients. */
 163 void client_create_resources(srs_context_t *srs);
 164
 165 /** Reset the resource sets of all clients. */
 166 void client_reset_resources(srs_context_t *srs);
 167
 168 /** Deliver a resource notification event to the client. */
 169 void client_resource_event(srs_client_t *c, srs_resset_event_t event);
 170
 171 /** Deliver a command notification event to the client. */
 172 void client_notify_command(srs_client_t *c, int index);
 173
 174 #endif /* __SRS_DAEMON_CLIENT_H__ */