git.sesse.net Git - vlc/blob - src/video_output/control.c

   1 /*****************************************************************************
   2  * control.c : vout internal control
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include "control.h"
  30
  31 /* */
  32 void vout_control_cmd_Init(vout_control_cmd_t *cmd, int type)
  33 {
  34     memset(cmd, 0, sizeof(*cmd));
  35     cmd->type = type;
  36 }
  37
  38 void vout_control_cmd_Clean(vout_control_cmd_t *cmd)
  39 {
  40     switch (cmd->type) {
  41     case VOUT_CONTROL_OSD_TITLE:
  42     case VOUT_CONTROL_CHANGE_FILTERS:
  43         free(cmd->u.string);
  44         break;
  45     default:
  46         break;
  47     }
  48 }
  49
  50 /* */
  51 void vout_control_Init(vout_control_t *ctrl)
  52 {
  53     vlc_mutex_init(&ctrl->lock);
  54     vlc_cond_init(&ctrl->wait_request);
  55     vlc_cond_init(&ctrl->wait_acknowledge);
  56
  57     ctrl->is_dead = false;
  58     ctrl->is_sleeping = false;
  59     ctrl->can_sleep = true;
  60     ctrl->is_processing = false;
  61     ARRAY_INIT(ctrl->cmd);
  62 }
  63
  64 void vout_control_Clean(vout_control_t *ctrl)
  65 {
  66     /* */
  67     for (int i = 0; i < ctrl->cmd.i_size; i++) {
  68         vout_control_cmd_t cmd = ARRAY_VAL(ctrl->cmd, i);
  69         vout_control_cmd_Clean(&cmd);
  70     }
  71     ARRAY_RESET(ctrl->cmd);
  72
  73     vlc_mutex_destroy(&ctrl->lock);
  74     vlc_cond_destroy(&ctrl->wait_request);
  75     vlc_cond_destroy(&ctrl->wait_acknowledge);
  76 }
  77
  78 void vout_control_Dead(vout_control_t *ctrl)
  79 {
  80     vlc_mutex_lock(&ctrl->lock);
  81     ctrl->is_dead = true;
  82     vlc_cond_broadcast(&ctrl->wait_acknowledge);
  83     vlc_mutex_unlock(&ctrl->lock);
  84
  85 }
  86
  87 void vout_control_WaitEmpty(vout_control_t *ctrl)
  88 {
  89     vlc_mutex_lock(&ctrl->lock);
  90     while ((ctrl->cmd.i_size > 0 || ctrl->is_processing) && !ctrl->is_dead)
  91         vlc_cond_wait(&ctrl->wait_acknowledge, &ctrl->lock);
  92     vlc_mutex_unlock(&ctrl->lock);
  93 }
  94
  95 void vout_control_Push(vout_control_t *ctrl, vout_control_cmd_t *cmd)
  96 {
  97     vlc_mutex_lock(&ctrl->lock);
  98     if (!ctrl->is_dead) {
  99         ARRAY_APPEND(ctrl->cmd, *cmd);
 100         vlc_cond_signal(&ctrl->wait_request);
 101     } else {
 102         vout_control_cmd_Clean(cmd);
 103     }
 104     vlc_mutex_unlock(&ctrl->lock);
 105 }
 106
 107 void vout_control_Wake(vout_control_t *ctrl)
 108 {
 109     vlc_mutex_lock(&ctrl->lock);
 110     ctrl->can_sleep = false;
 111     if (ctrl->is_sleeping)
 112         vlc_cond_signal(&ctrl->wait_request);
 113     vlc_mutex_unlock(&ctrl->lock);
 114 }
 115
 116 void vout_control_PushVoid(vout_control_t *ctrl, int type)
 117 {
 118     vout_control_cmd_t cmd;
 119
 120     vout_control_cmd_Init(&cmd, type);
 121     vout_control_Push(ctrl, &cmd);
 122 }
 123 void vout_control_PushBool(vout_control_t *ctrl, int type, bool boolean)
 124 {
 125     vout_control_cmd_t cmd;
 126
 127     vout_control_cmd_Init(&cmd, type);
 128     cmd.u.boolean = boolean;
 129     vout_control_Push(ctrl, &cmd);
 130 }
 131 void vout_control_PushTime(vout_control_t *ctrl, int type, mtime_t time)
 132 {
 133     vout_control_cmd_t cmd;
 134
 135     vout_control_cmd_Init(&cmd, type);
 136     cmd.u.time = time;
 137     vout_control_Push(ctrl, &cmd);
 138 }
 139 void vout_control_PushMessage(vout_control_t *ctrl, int type, int channel, const char *string)
 140 {
 141     vout_control_cmd_t cmd;
 142
 143     vout_control_cmd_Init(&cmd, type);
 144     cmd.u.message.channel = channel;
 145     cmd.u.message.string = strdup(string);
 146     vout_control_Push(ctrl, &cmd);
 147 }
 148 void vout_control_PushPair(vout_control_t *ctrl, int type, int a, int b)
 149 {
 150     vout_control_cmd_t cmd;
 151
 152     vout_control_cmd_Init(&cmd, type);
 153     cmd.u.pair.a = a;
 154     cmd.u.pair.b = b;
 155     vout_control_Push(ctrl, &cmd);
 156 }
 157 void vout_control_PushString(vout_control_t *ctrl, int type, const char *string)
 158 {
 159     vout_control_cmd_t cmd;
 160
 161     vout_control_cmd_Init(&cmd, type);
 162     cmd.u.string = strdup(string);
 163     vout_control_Push(ctrl, &cmd);
 164 }
 165
 166 int vout_control_Pop(vout_control_t *ctrl, vout_control_cmd_t *cmd,
 167                      mtime_t deadline, mtime_t timeout)
 168 {
 169     vlc_mutex_lock(&ctrl->lock);
 170     if (ctrl->cmd.i_size <= 0) {
 171         ctrl->is_processing = false;
 172         vlc_cond_broadcast(&ctrl->wait_acknowledge);
 173
 174         const mtime_t max_deadline = mdate() + timeout;
 175
 176         /* Supurious wake up are perfectly fine */
 177         if (deadline <= VLC_TS_INVALID) {
 178             ctrl->is_sleeping = true;
 179             if (ctrl->can_sleep)
 180                 vlc_cond_timedwait(&ctrl->wait_request, &ctrl->lock, max_deadline);
 181             ctrl->is_sleeping = false;
 182         } else {
 183             vlc_cond_timedwait(&ctrl->wait_request, &ctrl->lock, __MIN(deadline, max_deadline));
 184         }
 185     }
 186
 187     bool has_cmd;
 188     if (ctrl->cmd.i_size > 0) {
 189         has_cmd = true;
 190         *cmd = ARRAY_VAL(ctrl->cmd, 0);
 191         ARRAY_REMOVE(ctrl->cmd, 0);
 192
 193         ctrl->is_processing = true;
 194     } else {
 195         has_cmd = false;
 196         ctrl->can_sleep = true;
 197     }
 198     vlc_mutex_unlock(&ctrl->lock);
 199
 200     return has_cmd ? VLC_SUCCESS : VLC_EGENERIC;
 201 }
 202