git.sesse.net Git - vlc/blob - src/misc/block.c

   1 /*****************************************************************************
   2  * block.c: Data blocks management functions
   3  *****************************************************************************
   4  * Copyright (C) 2003-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@videolan.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 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <vlc/vlc.h>
  28 #include "vlc_block.h"
  29
  30 /*****************************************************************************
  31  * Block functions.
  32  *****************************************************************************/
  33 /* private */
  34 struct block_sys_t
  35 {
  36     block_t     self;
  37     size_t      i_allocated_buffer;
  38     uint8_t     p_allocated_buffer[0];
  39 };
  40
  41 #ifndef NDEBUG
  42 static void BlockNoRelease( block_t *b )
  43 {
  44     fprintf( stderr, "block %p has no release callback! This is a bug!\n", b );
  45     abort();
  46 }
  47 #endif
  48
  49 void block_Init( block_t *restrict b, void *buf, size_t size )
  50 {
  51     /* Fill all fields to their default */
  52     b->p_next = b->p_prev = NULL;
  53     b->i_flags = 0;
  54     b->i_pts = b->i_dts = b->i_length = 0;
  55     b->i_rate = 0;
  56     b->p_buffer = buf;
  57     b->i_buffer = size;
  58 #ifndef NDEBUG
  59     b->pf_release = BlockNoRelease;
  60 #endif
  61 }
  62
  63 static void BlockRelease( block_t *p_block )
  64 {
  65     free( p_block );
  66 }
  67
  68 #define BLOCK_PADDING_SIZE 32
  69
  70 block_t *block_Alloc( size_t i_size )
  71 {
  72     /* We do only one malloc
  73      * TODO bench if doing 2 malloc but keeping a pool of buffer is better
  74      * 16 -> align on 16
  75      * 2 * BLOCK_PADDING_SIZE -> pre + post padding
  76      */
  77     const size_t i_alloc = i_size + 2 * BLOCK_PADDING_SIZE + 16;
  78     block_sys_t *p_sys = malloc( sizeof( *p_sys ) + i_alloc );
  79
  80     if( p_sys == NULL )
  81         return NULL;
  82
  83     /* Fill opaque data */
  84     p_sys->i_allocated_buffer = i_alloc;
  85
  86     block_Init( &p_sys->self, p_sys->p_allocated_buffer + BLOCK_PADDING_SIZE
  87                 + 16 - ((uintptr_t)p_sys->p_allocated_buffer % 16 ), i_size );
  88     p_sys->self.pf_release    = BlockRelease;
  89
  90     return &p_sys->self;
  91 }
  92
  93 block_t *block_Realloc( block_t *p_block, ssize_t i_prebody, size_t i_body )
  94 {
  95     block_sys_t *p_sys = (block_sys_t *)p_block;
  96     ssize_t i_buffer_size;
  97
  98     if( p_block->pf_release != BlockRelease )
  99     {
 100         /* Special case when pf_release if overloaded
 101          * TODO if used one day, them implement it in a smarter way */
 102         block_t *p_dup = block_Duplicate( p_block );
 103         block_Release( p_block );
 104         if( !p_dup )
 105             return NULL;
 106
 107         p_block = p_dup;
 108     }
 109
 110     i_buffer_size = i_prebody + i_body;
 111
 112     if( i_buffer_size <= 0 )
 113     {
 114         block_Release( p_block );
 115         return NULL;
 116     }
 117
 118     if( p_block->p_buffer - i_prebody > p_sys->p_allocated_buffer &&
 119         p_block->p_buffer - i_prebody < p_sys->p_allocated_buffer +
 120         p_sys->i_allocated_buffer )
 121     {
 122         p_block->p_buffer -= i_prebody;
 123         p_block->i_buffer += i_prebody;
 124         i_prebody = 0;
 125     }
 126     if( p_block->p_buffer + i_body < p_sys->p_allocated_buffer +
 127         p_sys->i_allocated_buffer )
 128     {
 129         p_block->i_buffer = i_buffer_size;
 130         i_body = 0;
 131     }
 132
 133     if( i_body > 0 || i_prebody > 0 )
 134     {
 135         block_t *p_rea = block_New( NULL, i_buffer_size );
 136
 137         if( p_rea )
 138         {
 139             p_rea->i_dts     = p_block->i_dts;
 140             p_rea->i_pts     = p_block->i_pts;
 141             p_rea->i_flags   = p_block->i_flags;
 142             p_rea->i_length  = p_block->i_length;
 143             p_rea->i_rate    = p_block->i_rate;
 144             p_rea->i_samples = p_block->i_samples;
 145
 146             memcpy( p_rea->p_buffer + i_prebody, p_block->p_buffer,
 147                     __MIN( p_block->i_buffer, p_rea->i_buffer - i_prebody ) );
 148         }
 149
 150         block_Release( p_block );
 151
 152         return p_rea;
 153     }
 154
 155     return p_block;
 156 }
 157
 158 /*****************************************************************************
 159  * block_fifo_t management
 160  *****************************************************************************/
 161 struct block_fifo_t
 162 {
 163     vlc_mutex_t         lock;                         /* fifo data lock */
 164     vlc_cond_t          wait;         /* fifo data conditional variable */
 165
 166     block_t             *p_first;
 167     block_t             **pp_last;
 168     size_t              i_depth;
 169     size_t              i_size;
 170     vlc_bool_t          b_force_wake;
 171 };
 172
 173 block_fifo_t *__block_FifoNew( vlc_object_t *p_obj )
 174 {
 175     block_fifo_t *p_fifo;
 176
 177     p_fifo = malloc( sizeof( block_fifo_t ) );
 178     if( !p_fifo ) return NULL;
 179     vlc_mutex_init( p_obj, &p_fifo->lock );
 180     vlc_cond_init( p_obj, &p_fifo->wait );
 181     p_fifo->p_first = NULL;
 182     p_fifo->pp_last = &p_fifo->p_first;
 183     p_fifo->i_depth = p_fifo->i_size = 0;
 184     p_fifo->b_force_wake = VLC_FALSE;
 185
 186     return p_fifo;
 187 }
 188
 189 void block_FifoRelease( block_fifo_t *p_fifo )
 190 {
 191     block_FifoEmpty( p_fifo );
 192     vlc_cond_destroy( &p_fifo->wait );
 193     vlc_mutex_destroy( &p_fifo->lock );
 194     free( p_fifo );
 195 }
 196
 197 void block_FifoEmpty( block_fifo_t *p_fifo )
 198 {
 199     block_t *b;
 200
 201     vlc_mutex_lock( &p_fifo->lock );
 202     for( b = p_fifo->p_first; b != NULL; )
 203     {
 204         block_t *p_next;
 205
 206         p_next = b->p_next;
 207         block_Release( b );
 208         b = p_next;
 209     }
 210
 211     p_fifo->i_depth = p_fifo->i_size = 0;
 212     p_fifo->p_first = NULL;
 213     p_fifo->pp_last = &p_fifo->p_first;
 214     vlc_mutex_unlock( &p_fifo->lock );
 215 }
 216
 217 size_t block_FifoPut( block_fifo_t *p_fifo, block_t *p_block )
 218 {
 219     size_t i_size = 0;
 220     vlc_mutex_lock( &p_fifo->lock );
 221
 222     do
 223     {
 224         i_size += p_block->i_buffer;
 225
 226         *p_fifo->pp_last = p_block;
 227         p_fifo->pp_last = &p_block->p_next;
 228         p_fifo->i_depth++;
 229         p_fifo->i_size += p_block->i_buffer;
 230
 231         p_block = p_block->p_next;
 232
 233     } while( p_block );
 234
 235     /* warn there is data in this fifo */
 236     vlc_cond_signal( &p_fifo->wait );
 237     vlc_mutex_unlock( &p_fifo->lock );
 238
 239     return i_size;
 240 }
 241
 242 void block_FifoWake( block_fifo_t *p_fifo )
 243 {
 244     vlc_mutex_lock( &p_fifo->lock );
 245     if( p_fifo->p_first == NULL )
 246         p_fifo->b_force_wake = VLC_TRUE;
 247     vlc_cond_signal( &p_fifo->wait );
 248     vlc_mutex_unlock( &p_fifo->lock );
 249 }
 250
 251 block_t *block_FifoGet( block_fifo_t *p_fifo )
 252 {
 253     block_t *b;
 254
 255     vlc_mutex_lock( &p_fifo->lock );
 256
 257     /* Remember vlc_cond_wait() may cause spurious wakeups
 258      * (on both Win32 and POSIX) */
 259     while( ( p_fifo->p_first == NULL ) && !p_fifo->b_force_wake )
 260     {
 261         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
 262     }
 263
 264     b = p_fifo->p_first;
 265
 266     p_fifo->b_force_wake = VLC_FALSE;
 267     if( b == NULL )
 268     {
 269         /* Forced wakeup */
 270         vlc_mutex_unlock( &p_fifo->lock );
 271         return NULL;
 272     }
 273
 274     p_fifo->p_first = b->p_next;
 275     p_fifo->i_depth--;
 276     p_fifo->i_size -= b->i_buffer;
 277
 278     if( p_fifo->p_first == NULL )
 279     {
 280         p_fifo->pp_last = &p_fifo->p_first;
 281     }
 282
 283     vlc_mutex_unlock( &p_fifo->lock );
 284
 285     b->p_next = NULL;
 286     return b;
 287 }
 288
 289 block_t *block_FifoShow( block_fifo_t *p_fifo )
 290 {
 291     block_t *b;
 292
 293     vlc_mutex_lock( &p_fifo->lock );
 294
 295     if( p_fifo->p_first == NULL )
 296     {
 297         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
 298     }
 299
 300     b = p_fifo->p_first;
 301
 302     vlc_mutex_unlock( &p_fifo->lock );
 303
 304     return( b );
 305 }
 306
 307 size_t block_FifoSize( const block_fifo_t *p_fifo )
 308 {
 309     return p_fifo->i_size;
 310 }
 311
 312 size_t block_FifoCount( const block_fifo_t *p_fifo )
 313 {
 314     return p_fifo->i_depth;
 315 }