X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_block.h;h=37d21badf027d34ab1a83db9f847a6dbe674e774;hb=202a87b60c22375a5fd9c094bd10f2751e506d7c;hp=673414c43841d0b3471b4a01f32e34634acf3eba;hpb=a5d6fe0341f72612b7ca6be13d52fb2fca581f5d;p=vlc diff --git a/include/vlc_block.h b/include/vlc_block.h index 673414c438..37d21badf0 100644 --- a/include/vlc_block.h +++ b/include/vlc_block.h @@ -21,8 +21,14 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#ifndef _VLC_BLOCK_H -#define _VLC_BLOCK_H 1 +#ifndef VLC_BLOCK_H +#define VLC_BLOCK_H 1 + +/** + * \file + * This file implements functions and structures to handle blocks of data in vlc + * + */ /**************************************************************************** * block: @@ -31,7 +37,7 @@ * - i_flags may not always be set (ie could be 0, even for a key frame * it depends where you receive the buffer (before/after a packetizer * and the demux/packetizer implementations. - * - i_dts/i_pts could be 0, it means no pts + * - i_dts/i_pts could be BLOCK_TS_INVALID, it means no pts/dts * - i_length: length in microseond of the packet, can be null except in the * sout where it is mandatory. * - i_rate 0 or a valid input rate, look at vlc_input.h @@ -62,6 +68,8 @@ typedef struct block_sys_t block_sys_t; #define BLOCK_FLAG_END_OF_FRAME 0x0040 /** This is not a key frame for bitrate shaping */ #define BLOCK_FLAG_NO_KEYFRAME 0x0080 +/** This block contains the last part of a sequence */ +#define BLOCK_FLAG_END_OF_SEQUENCE 0x0100 /** This block contains a clock reference */ #define BLOCK_FLAG_CLOCK 0x0200 /** This block is scrambled */ @@ -71,15 +79,26 @@ typedef struct block_sys_t block_sys_t; /** This block is corrupted and/or there is data loss */ #define BLOCK_FLAG_CORRUPTED 0x1000 -#define BLOCK_FLAG_PRIVATE_MASK 0xffff0000 -#define BLOCK_FLAG_PRIVATE_SHIFT 16 +#define BLOCK_FLAG_TYPE_MASK \ + (BLOCK_FLAG_TYPE_I|BLOCK_FLAG_TYPE_P|BLOCK_FLAG_TYPE_B|BLOCK_FLAG_TYPE_PB) + +/* These are for input core private usage only */ +#define BLOCK_FLAG_CORE_PRIVATE_MASK 0x00ff0000 +#define BLOCK_FLAG_CORE_PRIVATE_SHIFT 16 + +/* These are for module private usage only */ +#define BLOCK_FLAG_PRIVATE_MASK 0xff000000 +#define BLOCK_FLAG_PRIVATE_SHIFT 24 + +/* All timestamp below or equal to this define are invalid/unset + * XXX the numerical value is 0 because of historical reason and will change.*/ +#define BLOCK_TS_INVALID (0) typedef void (*block_free_t) (block_t *); struct block_t { block_t *p_next; - block_t *p_prev; uint32_t i_flags; @@ -114,11 +133,12 @@ struct block_t * - block_Duplicate : create a copy of a block. ****************************************************************************/ VLC_EXPORT( void, block_Init, ( block_t *, void *, size_t ) ); -VLC_EXPORT( block_t *, block_Alloc, ( size_t ) ); -VLC_EXPORT( block_t *, block_Realloc, ( block_t *, ssize_t i_pre, size_t i_body ) ); +VLC_EXPORT( block_t *, block_Alloc, ( size_t ) LIBVLC_USED ); +VLC_EXPORT( block_t *, block_Realloc, ( block_t *, ssize_t i_pre, size_t i_body ) LIBVLC_USED ); #define block_New( dummy, size ) block_Alloc(size) +LIBVLC_USED static inline block_t *block_Duplicate( block_t *p_block ) { block_t *p_dup = block_Alloc( p_block->i_buffer ); @@ -135,25 +155,32 @@ static inline block_t *block_Duplicate( block_t *p_block ) return p_dup; } + static inline void block_Release( block_t *p_block ) { p_block->pf_release( p_block ); } -VLC_EXPORT( block_t *, block_mmap_Alloc, (void *addr, size_t length) ); -VLC_EXPORT( block_t *, block_File, (int fd) ); +VLC_EXPORT( block_t *, block_mmap_Alloc, (void *addr, size_t length) LIBVLC_USED ); +VLC_EXPORT( block_t *, block_File, (int fd) LIBVLC_USED ); + +static inline void block_Cleanup (void *block) +{ + block_Release ((block_t *)block); +} +#define block_cleanup_push( block ) vlc_cleanup_push (block_Cleanup, block) /**************************************************************************** * Chains of blocks functions helper **************************************************************************** - * - block_ChainAppend : append a block the the last block of a chain. Try to + * - block_ChainAppend : append a block to the last block of a chain. Try to * avoid using with a lot of data as it's really slow, prefer * block_ChainLastAppend * - block_ChainLastAppend : use a pointer over a pointer to the next blocks, * and update it. * - block_ChainRelease : release a chain of block * - block_ChainExtract : extract data from a chain, return real bytes counts - * - block_ChainGather : gather a chain, free it and return a block. + * - block_ChainGather : gather a chain, free it and return one block. ****************************************************************************/ static inline void block_ChainAppend( block_t **pp_list, block_t *p_block ) { @@ -170,7 +197,7 @@ static inline void block_ChainAppend( block_t **pp_list, block_t *p_block ) } } -static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block ) +static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block ) { block_t *p_last = p_block; @@ -208,20 +235,39 @@ static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max ) return i_total; } +static inline void block_ChainProperties( block_t *p_list, int *pi_count, size_t *pi_size, mtime_t *pi_length ) +{ + size_t i_size = 0; + mtime_t i_length = 0; + int i_count = 0; + + while( p_list ) + { + i_size += p_list->i_buffer; + i_length += p_list->i_length; + i_count++; + + p_list = p_list->p_next; + } + + if( pi_size ) + *pi_size = i_size; + if( pi_length ) + *pi_length = i_length; + if( pi_count ) + *pi_count = i_count; +} + static inline block_t *block_ChainGather( block_t *p_list ) { size_t i_total = 0; mtime_t i_length = 0; - block_t *b, *g; + block_t *g; if( p_list->p_next == NULL ) return p_list; /* Already gathered */ - for( b = p_list; b != NULL; b = b->p_next ) - { - i_total += b->i_buffer; - i_length += b->i_length; - } + block_ChainProperties( p_list, NULL, &i_total, &i_length ); g = block_Alloc( i_total ); block_ChainExtract( p_list, g->p_buffer, g->i_buffer ); @@ -236,7 +282,6 @@ static inline block_t *block_ChainGather( block_t *p_list ) return g; } - /**************************************************************************** * Fifos of blocks. **************************************************************************** @@ -249,19 +294,22 @@ static inline block_t *block_ChainGather( block_t *p_list ) * needed), be carefull, you can use it ONLY if you are sure to be the * only one getting data from the fifo. * - block_FifoCount : how many packets are waiting in the fifo - * - block_FifoSize : how many cumulated bytes are waiting in the fifo * - block_FifoWake : wake ups a thread with block_FifoGet() = NULL * (this is used to wakeup a thread when there is no data to queue) + * + * block_FifoGet and block_FifoShow are cancellation points. ****************************************************************************/ -VLC_EXPORT( block_fifo_t *, block_FifoNew, ( void ) ); +VLC_EXPORT( block_fifo_t *, block_FifoNew, ( void ) LIBVLC_USED ); VLC_EXPORT( void, block_FifoRelease, ( block_fifo_t * ) ); +/* TODO: do we need to export this? */ +void block_FifoPace (block_fifo_t *fifo, size_t max_depth, size_t max_size); VLC_EXPORT( void, block_FifoEmpty, ( block_fifo_t * ) ); VLC_EXPORT( size_t, block_FifoPut, ( block_fifo_t *, block_t * ) ); VLC_EXPORT( void, block_FifoWake, ( block_fifo_t * ) ); -VLC_EXPORT( block_t *, block_FifoGet, ( block_fifo_t * ) ); +VLC_EXPORT( block_t *, block_FifoGet, ( block_fifo_t * ) LIBVLC_USED ); VLC_EXPORT( block_t *, block_FifoShow, ( block_fifo_t * ) ); -VLC_EXPORT( size_t, block_FifoSize, ( const block_fifo_t *p_fifo ) ); -VLC_EXPORT( size_t, block_FifoCount, ( const block_fifo_t *p_fifo ) ); +size_t block_FifoSize( const block_fifo_t *p_fifo ) LIBVLC_USED; +VLC_EXPORT( size_t, block_FifoCount, ( const block_fifo_t *p_fifo ) LIBVLC_USED ); #endif /* VLC_BLOCK_H */