plugins/mpeg_vdec/vpar_pool.c

   1 /*****************************************************************************
   2  * vpar_pool.c : management of the pool of decoder threads
   3  *****************************************************************************
   4  * Copyright (C) 2001 VideoLAN
   5  * $Id: vpar_pool.c,v 1.8 2002/04/25 21:52:42 sam Exp $
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <string.h>                                    /* memcpy(), memset() */
  28 #include <stdlib.h>                                             /* realloc() */
  29
  30 #include <videolan/vlc.h>
  31
  32 #include "video.h"
  33 #include "video_output.h"
  34
  35 #include "stream_control.h"
  36 #include "input_ext-dec.h"
  37
  38 #include "vdec_ext-plugins.h"
  39 #include "vpar_pool.h"
  40 #include "video_parser.h"
  41 #include "video_decoder.h"
  42
  43 /*
  44  * Local prototypes
  45  */
  46 static void WaitDummy( vdec_pool_t * p_pool );
  47 static void WaitPool( vdec_pool_t * p_pool );
  48 static void FreeMacroblockDummy( vdec_pool_t * p_pool, macroblock_t * p_mb );
  49 static void FreeMacroblockPool( vdec_pool_t * p_pool, macroblock_t * p_mb );
  50 static macroblock_t * NewMacroblockDummy( vdec_pool_t * p_pool );
  51 static macroblock_t * NewMacroblockPool( vdec_pool_t * p_pool );
  52 static void DecodeMacroblockDummy( vdec_pool_t * p_pool, macroblock_t * p_mb );
  53 static void DecodeMacroblockPool( vdec_pool_t * p_pool, macroblock_t * p_mb );
  54
  55 /*****************************************************************************
  56  * vpar_InitPool: Initializes the pool structure
  57  *****************************************************************************/
  58 void vpar_InitPool( vpar_thread_t * p_vpar )
  59 {
  60     int j;
  61
  62     /* Initialize mutex and cond. */
  63     vlc_mutex_init( &p_vpar->pool.lock );
  64     vlc_cond_init( &p_vpar->pool.wait_empty );
  65     vlc_cond_init( &p_vpar->pool.wait_undecoded );
  66
  67     /* Spawn optional video decoder threads. */
  68     p_vpar->pool.i_smp = 0;
  69     p_vpar->pool.pp_vdec = NULL;
  70     p_vpar->pool.p_macroblocks = NULL;
  71     p_vpar->pool.pp_empty_macroblocks = NULL;
  72     p_vpar->pool.pp_new_macroblocks = NULL;
  73     p_vpar->pool.p_vpar = p_vpar;
  74     vpar_SpawnPool( p_vpar );
  75
  76     /* Initialize fake video decoder structure (used when
  77      * decoder == parser). */
  78     if ( (p_vpar->pool.p_vdec =
  79                 (vdec_thread_t *)malloc( sizeof(vdec_thread_t) )) == NULL )
  80     {
  81         intf_ErrMsg("vdec error: not enough memory for vdec_CreateThread() to create the new thread");
  82         p_vpar->p_fifo->b_error = 1;
  83         return;
  84     }
  85     p_vpar->pool.p_vdec->b_die = 0;
  86     p_vpar->pool.p_vdec->p_pool = &p_vpar->pool;
  87     vdec_InitThread( p_vpar->pool.p_vdec );
  88
  89     for( j = 0; j < 12; j++ )
  90     {
  91         p_vpar->pool.mb.p_idcts[j].pi_block =
  92             vlc_memalign( &p_vpar->pool.mb.p_idcts[j].pi_block_orig,
  93                           16, 64 * sizeof(dctelem_t) );
  94     }
  95 }
  96
  97 /*****************************************************************************
  98  * vpar_SpawnPool: Create and cancel video decoder threads at any time
  99  *****************************************************************************
 100  * This function is called on startup, and everytime the user changes the
 101  * number of threads to launch. Please note that *all* decoder threads must
 102  * be idle during this operation, which only happens at the end of
 103  * PictureHeader().
 104  *****************************************************************************/
 105 void vpar_SpawnPool( vpar_thread_t * p_vpar )
 106 {
 107     int                 i_new_smp;
 108     stream_ctrl_t *     p_control;
 109
 110     p_control = p_vpar->p_config->p_stream_ctrl;
 111     vlc_mutex_lock( &p_control->control_lock );
 112     i_new_smp = p_control->i_smp;
 113     vlc_mutex_unlock( &p_control->control_lock );
 114
 115     /* FIXME: No error check because I'm tired. Come back later... */
 116
 117     /* No need to lock p_vpar->pool, since decoders MUST be idle here. */
 118     if( p_vpar->pool.i_smp != i_new_smp )
 119     {
 120         int i;
 121
 122         if( p_vpar->pool.i_smp > i_new_smp )
 123         {
 124             /* The user reduces the number of threads. */
 125
 126             for( i = p_vpar->pool.i_smp - 1; i >= i_new_smp; i-- )
 127             {
 128                 int j;
 129
 130                 vdec_DestroyThread( p_vpar->pool.pp_vdec[i] );
 131
 132                 for( j = 0; j < 12; j++ )
 133                 {
 134                     free( p_vpar->pool.p_macroblocks[i].p_idcts[j].pi_block_orig );
 135                 }
 136             }
 137
 138             p_vpar->pool.pp_vdec = realloc( p_vpar->pool.pp_vdec,
 139                                             i_new_smp * sizeof(vdec_thread_t *) );
 140             p_vpar->pool.p_macroblocks = realloc( p_vpar->pool.p_macroblocks,
 141                                             i_new_smp * sizeof(macroblock_t) );
 142             p_vpar->pool.pp_empty_macroblocks = realloc( p_vpar->pool.pp_empty_macroblocks,
 143                                             i_new_smp * sizeof(macroblock_t *) );
 144             p_vpar->pool.i_index_empty = i_new_smp;
 145             p_vpar->pool.pp_new_macroblocks = realloc( p_vpar->pool.pp_new_macroblocks,
 146                                             i_new_smp * sizeof(macroblock_t *) );
 147             p_vpar->pool.i_index_new = 0;
 148         }
 149         else
 150         {
 151             /* The user raises the number of threads. */
 152
 153             p_vpar->pool.pp_vdec = realloc( p_vpar->pool.pp_vdec,
 154                                             i_new_smp * sizeof(vdec_thread_t *) );
 155             p_vpar->pool.p_macroblocks = realloc( p_vpar->pool.p_macroblocks,
 156                                             i_new_smp * sizeof(macroblock_t) );
 157             p_vpar->pool.pp_empty_macroblocks = realloc( p_vpar->pool.pp_empty_macroblocks,
 158                                             i_new_smp * sizeof(macroblock_t *) );
 159             p_vpar->pool.i_index_empty = i_new_smp;
 160             p_vpar->pool.pp_new_macroblocks = realloc( p_vpar->pool.pp_new_macroblocks,
 161                                             i_new_smp * sizeof(macroblock_t *) );
 162             p_vpar->pool.i_index_new = 0;
 163
 164             for( i = p_vpar->pool.i_smp; i < i_new_smp ; i++ )
 165             {
 166                 int j;
 167
 168                 for( j = 0; j < 12; j++ )
 169                 {
 170                     p_vpar->pool.p_macroblocks[i].p_idcts[j].pi_block =
 171                         vlc_memalign( &p_vpar->pool.p_macroblocks[i].p_idcts[j].pi_block_orig,
 172                                       16, 64 * sizeof(dctelem_t) );
 173                 }
 174
 175                 p_vpar->pool.pp_vdec[i] = vdec_CreateThread( &p_vpar->pool );
 176             }
 177
 178         }
 179         for( i = 0; i < i_new_smp; i++ )
 180         {
 181             p_vpar->pool.pp_empty_macroblocks[i] =
 182                                     &p_vpar->pool.p_macroblocks[i];
 183         }
 184         p_vpar->pool.i_smp = i_new_smp;
 185     }
 186
 187     if( i_new_smp )
 188     {
 189         /* We have at least one decoder thread. */
 190         p_vpar->pool.pf_wait_pool = WaitPool;
 191         p_vpar->pool.pf_new_mb = NewMacroblockPool;
 192         p_vpar->pool.pf_free_mb = FreeMacroblockPool;
 193         p_vpar->pool.pf_decode_mb = DecodeMacroblockPool;
 194     }
 195     else
 196     {
 197         /* No decoder pool. */
 198         p_vpar->pool.pf_wait_pool = WaitDummy;
 199         p_vpar->pool.pf_new_mb = NewMacroblockDummy;
 200         p_vpar->pool.pf_free_mb = FreeMacroblockDummy;
 201         p_vpar->pool.pf_decode_mb = DecodeMacroblockDummy;
 202     }
 203 }
 204
 205 /*****************************************************************************
 206  * vpar_EndPool: Releases the pool structure
 207  *****************************************************************************/
 208 void vpar_EndPool( vpar_thread_t * p_vpar )
 209 {
 210     int i;
 211
 212     for( i = 0; i < 12; i++ )
 213     {
 214         free( p_vpar->pool.mb.p_idcts[i].pi_block_orig );
 215     }
 216
 217     for( i = 0; i < p_vpar->pool.i_smp; i++ )
 218     {
 219         int j;
 220
 221         vdec_DestroyThread( p_vpar->pool.pp_vdec[i] );
 222
 223         for( j = 0; j < 12; j++ )
 224         {
 225             free( p_vpar->pool.p_macroblocks[i].p_idcts[j].pi_block_orig );
 226         }
 227     }
 228
 229     if( p_vpar->pool.i_smp )
 230     {
 231         free( p_vpar->pool.pp_vdec );
 232         free( p_vpar->pool.p_macroblocks );
 233         free( p_vpar->pool.pp_new_macroblocks );
 234     }
 235
 236     /* Free fake video decoder (used when parser == decoder). */
 237     vdec_EndThread( p_vpar->pool.p_vdec );
 238
 239     /* Destroy lock and cond. */
 240     vlc_mutex_destroy( &p_vpar->pool.lock );
 241     vlc_cond_destroy( &p_vpar->pool.wait_empty );
 242     vlc_cond_destroy( &p_vpar->pool.wait_undecoded );
 243 }
 244
 245 /*****************************************************************************
 246  * WaitPool: Wait until all decoders are idle
 247  *****************************************************************************/
 248 static void WaitPool( vdec_pool_t * p_pool )
 249 {
 250     vlc_mutex_lock( &p_pool->lock );
 251     while( p_pool->i_index_empty != p_pool->i_smp )
 252     {
 253         vlc_cond_wait( &p_pool->wait_empty, &p_pool->lock );
 254     }
 255     vlc_mutex_unlock( &p_pool->lock );
 256 }
 257
 258 /*****************************************************************************
 259  * WaitDummy: Placeholder used when parser == decoder
 260  *****************************************************************************/
 261 static void WaitDummy( vdec_pool_t * p_pool )
 262 {
 263 }
 264
 265 /*****************************************************************************
 266  * NewMacroblockPool: Get an empty macroblock from the decoder pool
 267  *****************************************************************************/
 268 static macroblock_t * NewMacroblockPool( vdec_pool_t * p_pool )
 269 {
 270     macroblock_t *  p_mb;
 271
 272     vlc_mutex_lock( &p_pool->lock );
 273     while( p_pool->i_index_empty == 0 )
 274     {
 275         vlc_cond_wait( &p_pool->wait_empty, &p_pool->lock );
 276     }
 277     p_mb = p_pool->pp_empty_macroblocks[ --p_pool->i_index_empty ];
 278     vlc_mutex_unlock( &p_pool->lock );
 279     return( p_mb );
 280 }
 281
 282 /*****************************************************************************
 283  * NewMacroblockDummy: Placeholder used when parser == decoder
 284  *****************************************************************************/
 285 static macroblock_t * NewMacroblockDummy( vdec_pool_t * p_pool )
 286 {
 287     return( &p_pool->mb );
 288 }
 289
 290 /*****************************************************************************
 291  * FreeMacroblockPool: Free a macroblock
 292  *****************************************************************************/
 293 static void FreeMacroblockPool( vdec_pool_t * p_pool, macroblock_t * p_mb )
 294 {
 295     vlc_mutex_lock( &p_pool->lock );
 296     p_pool->pp_empty_macroblocks[ p_pool->i_index_empty++ ] = p_mb;
 297     vlc_cond_signal( &p_pool->wait_empty );
 298     vlc_mutex_unlock( &p_pool->lock );
 299 }
 300
 301 /*****************************************************************************
 302  * FreeMacroblockDummy: Placeholder used when parser == decoder
 303  *****************************************************************************/
 304 static void FreeMacroblockDummy( vdec_pool_t * p_pool, macroblock_t * p_mb )
 305 {
 306 }
 307
 308 /*****************************************************************************
 309  * DecodeMacroblockPool: Send a macroblock to a vdec thread
 310  *****************************************************************************/
 311 static void DecodeMacroblockPool( vdec_pool_t * p_pool, macroblock_t * p_mb )
 312 {
 313     vlc_mutex_lock( &p_pool->lock );
 314     /* The undecoded macroblock LIFO cannot be full, because
 315      * #macroblocks == size of the LIFO */
 316     p_pool->pp_new_macroblocks[ p_pool->i_index_new++ ] = p_mb;
 317     vlc_cond_signal( &p_pool->wait_undecoded );
 318     vlc_mutex_unlock( &p_pool->lock );
 319 }
 320
 321 /*****************************************************************************
 322  * DecodeMacroblockDummy: Placeholder used when parser == decoder
 323  *****************************************************************************/
 324 static void DecodeMacroblockDummy( vdec_pool_t * p_pool, macroblock_t * p_mb )
 325 {
 326     p_pool->pf_vdec_decode( p_pool->p_vdec, p_mb );
 327 }
 328