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 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc/vlc.h>
  32 #include "vlc_block.h"
  33
  34 /*****************************************************************************
  35  * Block functions.
  36  *****************************************************************************/
  37 /* private */
  38 struct block_sys_t
  39 {
  40     block_t     self;
  41     size_t      i_allocated_buffer;
  42     uint8_t     p_allocated_buffer[0];
  43 };
  44
  45 #ifndef NDEBUG
  46 static void BlockNoRelease( block_t *b )
  47 {
  48     fprintf( stderr, "block %p has no release callback! This is a bug!\n", b );
  49     abort();
  50 }
  51 #endif
  52
  53 void block_Init( block_t *restrict b, void *buf, size_t size )
  54 {
  55     /* Fill all fields to their default */
  56     b->p_next = b->p_prev = NULL;
  57     b->i_flags = 0;
  58     b->i_pts = b->i_dts = b->i_length = 0;
  59     b->i_rate = 0;
  60     b->p_buffer = buf;
  61     b->i_buffer = size;
  62 #ifndef NDEBUG
  63     b->pf_release = BlockNoRelease;
  64 #endif
  65 }
  66
  67 static void BlockRelease( block_t *p_block )
  68 {
  69     free( p_block );
  70 }
  71
  72 /* Memory alignment */
  73 #define BLOCK_ALIGN        16
  74 /* Initial size of reserved header and footer */
  75 #define BLOCK_PADDING_SIZE 32
  76 /* Maximum size of reserved footer before we release with realloc() */
  77 #define BLOCK_WASTE_SIZE   2048
  78
  79 block_t *block_Alloc( size_t i_size )
  80 {
  81     /* We do only one malloc
  82      * TODO: bench if doing 2 malloc but keeping a pool of buffer is better
  83      * TODO: use memalign
  84      * 16 -> align on 16
  85      * 2 * BLOCK_PADDING_SIZE -> pre + post padding
  86      */
  87     const size_t i_alloc = i_size + 2 * BLOCK_PADDING_SIZE + BLOCK_ALIGN;
  88     block_sys_t *p_sys = malloc( sizeof( *p_sys ) + i_alloc );
  89
  90     if( p_sys == NULL )
  91         return NULL;
  92
  93     /* Fill opaque data */
  94     p_sys->i_allocated_buffer = i_alloc;
  95
  96     block_Init( &p_sys->self, p_sys->p_allocated_buffer + BLOCK_PADDING_SIZE
  97                 + BLOCK_ALIGN
  98                 - ((uintptr_t)p_sys->p_allocated_buffer % BLOCK_ALIGN),
  99                 i_size );
 100     p_sys->self.pf_release    = BlockRelease;
 101
 102     return &p_sys->self;
 103 }
 104
 105 block_t *block_Realloc( block_t *p_block, ssize_t i_prebody, size_t i_body )
 106 {
 107     block_sys_t *p_sys = (block_sys_t *)p_block;
 108     ssize_t i_buffer_size;
 109
 110     if( p_block->pf_release != BlockRelease )
 111     {
 112         /* Special case when pf_release if overloaded
 113          * TODO if used one day, then implement it in a smarter way */
 114         block_t *p_dup = block_Duplicate( p_block );
 115         block_Release( p_block );
 116         if( !p_dup )
 117             return NULL;
 118
 119         p_block = p_dup;
 120     }
 121
 122     i_buffer_size = i_prebody + i_body;
 123
 124     if( i_buffer_size <= 0 )
 125     {
 126         block_Release( p_block );
 127         return NULL;
 128     }
 129
 130     /* Adjust reserved header if there is enough room */
 131     if( p_block->p_buffer - i_prebody > p_sys->p_allocated_buffer &&
 132         p_block->p_buffer - i_prebody < p_sys->p_allocated_buffer +
 133         p_sys->i_allocated_buffer )
 134     {
 135         p_block->p_buffer -= i_prebody;
 136         p_block->i_buffer += i_prebody;
 137         i_prebody = 0;
 138     }
 139
 140     /* Adjust payload size if there is enough room */
 141     if( p_block->p_buffer + i_body < p_sys->p_allocated_buffer +
 142         p_sys->i_allocated_buffer )
 143     {
 144         p_block->i_buffer = i_buffer_size;
 145         i_body = 0;
 146     }
 147
 148     /* Not enough room, reallocate the buffer */
 149     if( i_body > 0 || i_prebody > 0 )
 150     {
 151         /* FIXME: this is really dumb, we should use realloc() */
 152         block_t *p_rea = block_New( NULL, i_buffer_size );
 153
 154         if( p_rea )
 155         {
 156             p_rea->i_dts     = p_block->i_dts;
 157             p_rea->i_pts     = p_block->i_pts;
 158             p_rea->i_flags   = p_block->i_flags;
 159             p_rea->i_length  = p_block->i_length;
 160             p_rea->i_rate    = p_block->i_rate;
 161             p_rea->i_samples = p_block->i_samples;
 162
 163             memcpy( p_rea->p_buffer + i_prebody, p_block->p_buffer,
 164                     __MIN( p_block->i_buffer, p_rea->i_buffer - i_prebody ) );
 165         }
 166
 167         block_Release( p_block );
 168
 169         return p_rea;
 170     }
 171
 172     /* We have a very large reserved footer now? Release some of it. */
 173     if ((p_sys->p_allocated_buffer + p_sys->i_allocated_buffer) -
 174         (p_block->p_buffer + p_block->i_buffer) > BLOCK_WASTE_SIZE)
 175     {
 176         const size_t news = p_block->i_buffer + 2 * BLOCK_PADDING_SIZE + 16;
 177         block_sys_t *newb = realloc (p_sys, sizeof (*p_sys) + news);
 178
 179         if (newb != NULL)
 180         {
 181             p_sys = newb;
 182             p_sys->i_allocated_buffer = news;
 183             p_block = &p_sys->self;
 184             p_block->p_buffer = p_sys->p_allocated_buffer + BLOCK_PADDING_SIZE
 185                 + BLOCK_ALIGN
 186                 - ((uintptr_t)p_sys->p_allocated_buffer % BLOCK_ALIGN);
 187         }
 188     }
 189
 190     return p_block;
 191 }
 192
 193 #ifdef HAVE_MMAP
 194 # include <sys/mman.h>
 195
 196 typedef struct block_mmap_t
 197 {
 198     block_t     self;
 199     void       *base_addr;
 200     size_t      length;
 201 } block_mmap_t;
 202
 203 static void block_mmap_Release (block_t *block)
 204 {
 205     block_mmap_t *p_sys = (block_mmap_t *)block;
 206
 207     munmap (p_sys->base_addr, p_sys->length);
 208     free (p_sys);
 209 }
 210
 211 block_t *block_mmap_Alloc (void *addr, size_t length)
 212 {
 213     if (addr == MAP_FAILED)
 214         return NULL;
 215
 216     block_mmap_t *block = malloc (sizeof (*block));
 217     if (block == NULL)
 218     {
 219         munmap (addr, length);
 220         return NULL;
 221     }
 222
 223     block_Init (&block->self, (uint8_t *)addr, length);
 224     block->self.pf_release = block_mmap_Release;
 225     block->base_addr = addr;
 226     block->length = length;
 227     return &block->self;
 228 }
 229 #endif
 230
 231 #ifdef WIN32
 232 static
 233 ssize_t pread (int fd, void *buf, size_t count, off_t offset)
 234 {
 235     HANDLE handle = (HANDLE)(intptr_t)_get_osfhandle (fd);
 236     if (handle == INVALID_HANDLE_VALUE)
 237         return -1;
 238
 239     OVERLAPPED olap = { .Offset = offset, .OffsetHigh = (offset >> 32), };
 240     DWORD written;
 241     /* This braindead API will override the file pointer even if we specify
 242      * an explicit read offset... So do not expect this to mix well with
 243      * regular read() calls. */
 244     if (ReadFile (handle, buf, count, &written, &olap))
 245         return written;
 246     return -1;
 247 }
 248 #endif
 249
 250 /*****************************************************************************
 251  * block_fifo_t management
 252  *****************************************************************************/
 253 struct block_fifo_t
 254 {
 255     vlc_mutex_t         lock;                         /* fifo data lock */
 256     vlc_cond_t          wait;         /* fifo data conditional variable */
 257
 258     block_t             *p_first;
 259     block_t             **pp_last;
 260     size_t              i_depth;
 261     size_t              i_size;
 262     bool          b_force_wake;
 263 };
 264
 265 block_fifo_t *block_FifoNew( void )
 266 {
 267     block_fifo_t *p_fifo = malloc( sizeof( block_fifo_t ) );
 268     if( !p_fifo )
 269         return NULL;
 270
 271     vlc_mutex_init( &p_fifo->lock );
 272     vlc_cond_init( NULL, &p_fifo->wait );
 273     p_fifo->p_first = NULL;
 274     p_fifo->pp_last = &p_fifo->p_first;
 275     p_fifo->i_depth = p_fifo->i_size = 0;
 276     p_fifo->b_force_wake = false;
 277
 278     return p_fifo;
 279 }
 280
 281 void block_FifoRelease( block_fifo_t *p_fifo )
 282 {
 283     block_FifoEmpty( p_fifo );
 284     vlc_cond_destroy( &p_fifo->wait );
 285     vlc_mutex_destroy( &p_fifo->lock );
 286     free( p_fifo );
 287 }
 288
 289 void block_FifoEmpty( block_fifo_t *p_fifo )
 290 {
 291     block_t *b;
 292
 293     vlc_mutex_lock( &p_fifo->lock );
 294     for( b = p_fifo->p_first; b != NULL; )
 295     {
 296         block_t *p_next;
 297
 298         p_next = b->p_next;
 299         block_Release( b );
 300         b = p_next;
 301     }
 302
 303     p_fifo->i_depth = p_fifo->i_size = 0;
 304     p_fifo->p_first = NULL;
 305     p_fifo->pp_last = &p_fifo->p_first;
 306     vlc_mutex_unlock( &p_fifo->lock );
 307 }
 308
 309 size_t block_FifoPut( block_fifo_t *p_fifo, block_t *p_block )
 310 {
 311     size_t i_size = 0;
 312     vlc_mutex_lock( &p_fifo->lock );
 313
 314     do
 315     {
 316         i_size += p_block->i_buffer;
 317
 318         *p_fifo->pp_last = p_block;
 319         p_fifo->pp_last = &p_block->p_next;
 320         p_fifo->i_depth++;
 321         p_fifo->i_size += p_block->i_buffer;
 322
 323         p_block = p_block->p_next;
 324
 325     } while( p_block );
 326
 327     /* warn there is data in this fifo */
 328     vlc_cond_signal( &p_fifo->wait );
 329     vlc_mutex_unlock( &p_fifo->lock );
 330
 331     return i_size;
 332 }
 333
 334 void block_FifoWake( block_fifo_t *p_fifo )
 335 {
 336     vlc_mutex_lock( &p_fifo->lock );
 337     if( p_fifo->p_first == NULL )
 338         p_fifo->b_force_wake = true;
 339     vlc_cond_signal( &p_fifo->wait );
 340     vlc_mutex_unlock( &p_fifo->lock );
 341 }
 342
 343 block_t *block_FifoGet( block_fifo_t *p_fifo )
 344 {
 345     block_t *b;
 346
 347     vlc_mutex_lock( &p_fifo->lock );
 348
 349     /* Remember vlc_cond_wait() may cause spurious wakeups
 350      * (on both Win32 and POSIX) */
 351     while( ( p_fifo->p_first == NULL ) && !p_fifo->b_force_wake )
 352     {
 353         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
 354     }
 355
 356     b = p_fifo->p_first;
 357
 358     p_fifo->b_force_wake = false;
 359     if( b == NULL )
 360     {
 361         /* Forced wakeup */
 362         vlc_mutex_unlock( &p_fifo->lock );
 363         return NULL;
 364     }
 365
 366     p_fifo->p_first = b->p_next;
 367     p_fifo->i_depth--;
 368     p_fifo->i_size -= b->i_buffer;
 369
 370     if( p_fifo->p_first == NULL )
 371     {
 372         p_fifo->pp_last = &p_fifo->p_first;
 373     }
 374
 375     vlc_mutex_unlock( &p_fifo->lock );
 376
 377     b->p_next = NULL;
 378     return b;
 379 }
 380
 381 block_t *block_FifoShow( block_fifo_t *p_fifo )
 382 {
 383     block_t *b;
 384
 385     vlc_mutex_lock( &p_fifo->lock );
 386
 387     if( p_fifo->p_first == NULL )
 388     {
 389         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
 390     }
 391
 392     b = p_fifo->p_first;
 393
 394     vlc_mutex_unlock( &p_fifo->lock );
 395
 396     return( b );
 397 }
 398
 399 size_t block_FifoSize( const block_fifo_t *p_fifo )
 400 {
 401     return p_fifo->i_size;
 402 }
 403
 404 size_t block_FifoCount( const block_fifo_t *p_fifo )
 405 {
 406     return p_fifo->i_depth;
 407 }