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 it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * 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 <vlc_vout.h>
  30 #include "vout_internal.h"
  31
  32 /* */
  33 void vout_control_cmd_Init(vout_control_cmd_t *cmd, int type)
  34 {
  35     memset(cmd, 0, sizeof(*cmd));
  36     cmd->type = type;
  37 }
  38
  39 void vout_control_cmd_Clean(vout_control_cmd_t *cmd)
  40 {
  41     switch (cmd->type) {
  42     case VOUT_CONTROL_SUBPICTURE:
  43         if (cmd->subpicture)
  44             subpicture_Delete(cmd->subpicture);
  45         break;
  46     case VOUT_CONTROL_CHANGE_FILTERS:
  47         free(cmd->string);
  48         break;
  49     default:
  50         break;
  51     }
  52 }
  53
  54 /* */
  55 void vout_control_Init(vout_control_t *ctrl)
  56 {
  57     vlc_mutex_init(&ctrl->lock);
  58     vlc_cond_init(&ctrl->wait_request);
  59     vlc_cond_init(&ctrl->wait_acknowledge);
  60
  61     ctrl->is_dead = false;
  62     ctrl->can_sleep = true;
  63     ctrl->is_processing = true;
  64     ARRAY_INIT(ctrl->cmd);
  65 }
  66
  67 void vout_control_Clean(vout_control_t *ctrl)
  68 {
  69     /* */
  70     for (int i = 0; i < ctrl->cmd.i_size; i++) {
  71         vout_control_cmd_t cmd = ARRAY_VAL(ctrl->cmd, i);
  72         vout_control_cmd_Clean(&cmd);
  73     }
  74     ARRAY_RESET(ctrl->cmd);
  75
  76     vlc_mutex_destroy(&ctrl->lock);
  77     vlc_cond_destroy(&ctrl->wait_request);
  78     vlc_cond_destroy(&ctrl->wait_acknowledge);
  79 }
  80
  81 void vout_control_Dead(vout_control_t *ctrl)
  82 {
  83     vlc_mutex_lock(&ctrl->lock);
  84     ctrl->is_dead = true;
  85     vlc_cond_broadcast(&ctrl->wait_acknowledge);
  86     vlc_mutex_unlock(&ctrl->lock);
  87
  88 }
  89
  90 void vout_control_WaitEmpty(vout_control_t *ctrl)
  91 {
  92     vlc_mutex_lock(&ctrl->lock);
  93     while ((ctrl->cmd.i_size > 0 || ctrl->is_processing) && !ctrl->is_dead)
  94         vlc_cond_wait(&ctrl->wait_acknowledge, &ctrl->lock);
  95     vlc_mutex_unlock(&ctrl->lock);
  96 }
  97
  98 void vout_control_Push(vout_control_t *ctrl, vout_control_cmd_t *cmd)
  99 {
 100     vlc_mutex_lock(&ctrl->lock);
 101     if (!ctrl->is_dead) {
 102         ARRAY_APPEND(ctrl->cmd, *cmd);
 103         vlc_cond_signal(&ctrl->wait_request);
 104     } else {
 105         vout_control_cmd_Clean(cmd);
 106     }
 107     vlc_mutex_unlock(&ctrl->lock);
 108 }
 109
 110 void vout_control_Wake(vout_control_t *ctrl)
 111 {
 112     vlc_mutex_lock(&ctrl->lock);
 113     ctrl->can_sleep = false;
 114     vlc_cond_signal(&ctrl->wait_request);
 115     vlc_mutex_unlock(&ctrl->lock);
 116 }
 117
 118 void vout_control_PushVoid(vout_control_t *ctrl, int type)
 119 {
 120     vout_control_cmd_t cmd;
 121
 122     vout_control_cmd_Init(&cmd, type);
 123     vout_control_Push(ctrl, &cmd);
 124 }
 125 void vout_control_PushBool(vout_control_t *ctrl, int type, bool boolean)
 126 {
 127     vout_control_cmd_t cmd;
 128
 129     vout_control_cmd_Init(&cmd, type);
 130     cmd.boolean = boolean;
 131     vout_control_Push(ctrl, &cmd);
 132 }
 133 void vout_control_PushInteger(vout_control_t *ctrl, int type, int integer)
 134 {
 135     vout_control_cmd_t cmd;
 136
 137     vout_control_cmd_Init(&cmd, type);
 138     cmd.integer = integer;
 139     vout_control_Push(ctrl, &cmd);
 140 }
 141 void vout_control_PushTime(vout_control_t *ctrl, int type, vlc_tick_t time)
 142 {
 143     vout_control_cmd_t cmd;
 144
 145     vout_control_cmd_Init(&cmd, type);
 146     cmd.time = time;
 147     vout_control_Push(ctrl, &cmd);
 148 }
 149 void vout_control_PushPair(vout_control_t *ctrl, int type, int a, int b)
 150 {
 151     vout_control_cmd_t cmd;
 152
 153     vout_control_cmd_Init(&cmd, type);
 154     cmd.pair.a = a;
 155     cmd.pair.b = b;
 156     vout_control_Push(ctrl, &cmd);
 157 }
 158 void vout_control_PushString(vout_control_t *ctrl, int type, const char *string)
 159 {
 160     vout_control_cmd_t cmd;
 161
 162     vout_control_cmd_Init(&cmd, type);
 163     cmd.string = string ? strdup(string) : NULL;
 164     vout_control_Push(ctrl, &cmd);
 165 }
 166
 167 int vout_control_Pop(vout_control_t *ctrl, vout_control_cmd_t *cmd,
 168                      vlc_tick_t deadline)
 169 {
 170     vlc_mutex_lock(&ctrl->lock);
 171     if (ctrl->cmd.i_size <= 0) {
 172         ctrl->is_processing = false;
 173         vlc_cond_broadcast(&ctrl->wait_acknowledge);
 174
 175         /* Spurious wakeups are perfectly fine */
 176         if (deadline != VLC_TICK_INVALID && ctrl->can_sleep)
 177             vlc_cond_timedwait(&ctrl->wait_request, &ctrl->lock, deadline);
 178     }
 179
 180     bool has_cmd;
 181     if (ctrl->cmd.i_size > 0) {
 182         has_cmd = true;
 183         *cmd = ARRAY_VAL(ctrl->cmd, 0);
 184         ARRAY_REMOVE(ctrl->cmd, 0);
 185
 186         ctrl->is_processing = true;
 187     } else {
 188         has_cmd = false;
 189         ctrl->can_sleep = true;
 190     }
 191     vlc_mutex_unlock(&ctrl->lock);
 192
 193     return has_cmd ? VLC_SUCCESS : VLC_EGENERIC;
 194 }
 195