vlc_block.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:11k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * vlc_block.h: Data blocks management functions
  3.  *****************************************************************************
  4.  * Copyright (C) 2003 the VideoLAN team
  5.  * $Id: aa49c65228306e04b734695938b93bad64c8c175 $
  6.  *
  7.  * Authors: Laurent Aimar <fenrir@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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23. #ifndef VLC_BLOCK_H
  24. #define VLC_BLOCK_H 1
  25. /**
  26.  * file
  27.  * This file implements functions and structures to handle blocks of data in vlc
  28.  *
  29.  */
  30. /****************************************************************************
  31.  * block:
  32.  ****************************************************************************
  33.  * - block_sys_t is opaque and thus block_t->p_sys is PRIVATE
  34.  * - i_flags may not always be set (ie could be 0, even for a key frame
  35.  *      it depends where you receive the buffer (before/after a packetizer
  36.  *      and the demux/packetizer implementations.
  37.  * - i_dts/i_pts could be VLC_TS_INVALID, it means no pts/dts
  38.  * - i_length: length in microseond of the packet, can be null except in the
  39.  *      sout where it is mandatory.
  40.  * - i_rate 0 or a valid input rate, look at vlc_input.h
  41.  *
  42.  * - i_buffer number of valid data pointed by p_buffer
  43.  *      you can freely decrease it but never increase it yourself
  44.  *      (use block_Realloc)
  45.  * - p_buffer: pointer over datas. You should never overwrite it, you can
  46.  *   only incremment it to skip datas, in others cases use block_Realloc
  47.  *   (don't duplicate yourself in a bigger buffer, block_Realloc is
  48.  *   optimised for prehader/postdatas increase)
  49.  ****************************************************************************/
  50. typedef struct block_sys_t block_sys_t;
  51. /** The content doesn't follow the last block, or is probably broken */
  52. #define BLOCK_FLAG_DISCONTINUITY 0x0001
  53. /** Intra frame */
  54. #define BLOCK_FLAG_TYPE_I        0x0002
  55. /** Inter frame with backward reference only */
  56. #define BLOCK_FLAG_TYPE_P        0x0004
  57. /** Inter frame with backward and forward reference */
  58. #define BLOCK_FLAG_TYPE_B        0x0008
  59. /** For inter frame when you don't know the real type */
  60. #define BLOCK_FLAG_TYPE_PB       0x0010
  61. /** Warn that this block is a header one */
  62. #define BLOCK_FLAG_HEADER        0x0020
  63. /** This is the last block of the frame */
  64. #define BLOCK_FLAG_END_OF_FRAME  0x0040
  65. /** This is not a key frame for bitrate shaping */
  66. #define BLOCK_FLAG_NO_KEYFRAME   0x0080
  67. /** This block contains the last part of a sequence  */
  68. #define BLOCK_FLAG_END_OF_SEQUENCE 0x0100
  69. /** This block contains a clock reference */
  70. #define BLOCK_FLAG_CLOCK         0x0200
  71. /** This block is scrambled */
  72. #define BLOCK_FLAG_SCRAMBLED     0x0400
  73. /** This block has to be decoded but not be displayed */
  74. #define BLOCK_FLAG_PREROLL       0x0800
  75. /** This block is corrupted and/or there is data loss  */
  76. #define BLOCK_FLAG_CORRUPTED     0x1000
  77. #define BLOCK_FLAG_TYPE_MASK 
  78.     (BLOCK_FLAG_TYPE_I|BLOCK_FLAG_TYPE_P|BLOCK_FLAG_TYPE_B|BLOCK_FLAG_TYPE_PB)
  79. /* These are for input core private usage only */
  80. #define BLOCK_FLAG_CORE_PRIVATE_MASK  0x00ff0000
  81. #define BLOCK_FLAG_CORE_PRIVATE_SHIFT 16
  82. /* These are for module private usage only */
  83. #define BLOCK_FLAG_PRIVATE_MASK  0xff000000
  84. #define BLOCK_FLAG_PRIVATE_SHIFT 24
  85. typedef void (*block_free_t) (block_t *);
  86. struct block_t
  87. {
  88.     block_t     *p_next;
  89.     uint32_t    i_flags;
  90.     mtime_t     i_pts;
  91.     mtime_t     i_dts;
  92.     mtime_t     i_length;
  93.     int         i_samples; /* Used for audio */
  94.     int         i_rate;
  95.     size_t      i_buffer;
  96.     uint8_t     *p_buffer;
  97.     /* Rudimentary support for overloading block (de)allocation. */
  98.     block_free_t pf_release;
  99. };
  100. /****************************************************************************
  101.  * Blocks functions:
  102.  ****************************************************************************
  103.  * - block_Alloc : create a new block with the requested size ( >= 0 ), return
  104.  *      NULL for failure.
  105.  * - block_Release : release a block allocated with block_Alloc.
  106.  * - block_Realloc : realloc a block,
  107.  *      i_pre: how many bytes to insert before body if > 0, else how many
  108.  *      bytes of body to skip (the latter can be done without using
  109.  *      block_Realloc i_buffer -= -i_pre, p_buffer += -i_pre as i_pre < 0)
  110.  *      i_body (>= 0): the final size of the body (decreasing it can directly
  111.  *      be done with i_buffer = i_body).
  112.  *      with preheader and or body (increase
  113.  *      and decrease are supported). Use it as it is optimised.
  114.  * - block_Duplicate : create a copy of a block.
  115.  ****************************************************************************/
  116. VLC_EXPORT( void,      block_Init,    ( block_t *, void *, size_t ) );
  117. VLC_EXPORT( block_t *, block_Alloc,   ( size_t ) LIBVLC_USED );
  118. VLC_EXPORT( block_t *, block_Realloc, ( block_t *, ssize_t i_pre, size_t i_body ) LIBVLC_USED );
  119. #define block_New( dummy, size ) block_Alloc(size)
  120. LIBVLC_USED
  121. static inline block_t *block_Duplicate( block_t *p_block )
  122. {
  123.     block_t *p_dup = block_Alloc( p_block->i_buffer );
  124.     if( p_dup == NULL )
  125.         return NULL;
  126.     p_dup->i_dts     = p_block->i_dts;
  127.     p_dup->i_pts     = p_block->i_pts;
  128.     p_dup->i_flags   = p_block->i_flags;
  129.     p_dup->i_length  = p_block->i_length;
  130.     p_dup->i_rate    = p_block->i_rate;
  131.     p_dup->i_samples = p_block->i_samples;
  132.     memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
  133.     return p_dup;
  134. }
  135. static inline void block_Release( block_t *p_block )
  136. {
  137.     p_block->pf_release( p_block );
  138. }
  139. VLC_EXPORT( block_t *, block_mmap_Alloc, (void *addr, size_t length) LIBVLC_USED );
  140. VLC_EXPORT( block_t *, block_File, (int fd) LIBVLC_USED );
  141. static inline void block_Cleanup (void *block)
  142. {
  143.     block_Release ((block_t *)block);
  144. }
  145. #define block_cleanup_push( block ) vlc_cleanup_push (block_Cleanup, block)
  146. /****************************************************************************
  147.  * Chains of blocks functions helper
  148.  ****************************************************************************
  149.  * - block_ChainAppend : append a block to the last block of a chain. Try to
  150.  *      avoid using with a lot of data as it's really slow, prefer
  151.  *      block_ChainLastAppend
  152.  * - block_ChainLastAppend : use a pointer over a pointer to the next blocks,
  153.  *      and update it.
  154.  * - block_ChainRelease : release a chain of block
  155.  * - block_ChainExtract : extract data from a chain, return real bytes counts
  156.  * - block_ChainGather : gather a chain, free it and return one block.
  157.  ****************************************************************************/
  158. static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
  159. {
  160.     if( *pp_list == NULL )
  161.     {
  162.         *pp_list = p_block;
  163.     }
  164.     else
  165.     {
  166.         block_t *p = *pp_list;
  167.         while( p->p_next ) p = p->p_next;
  168.         p->p_next = p_block;
  169.     }
  170. }
  171. static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block )
  172. {
  173.     block_t *p_last = p_block;
  174.     **ppp_last = p_block;
  175.     while( p_last->p_next ) p_last = p_last->p_next;
  176.     *ppp_last = &p_last->p_next;
  177. }
  178. static inline void block_ChainRelease( block_t *p_block )
  179. {
  180.     while( p_block )
  181.     {
  182.         block_t *p_next = p_block->p_next;
  183.         block_Release( p_block );
  184.         p_block = p_next;
  185.     }
  186. }
  187. static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max )
  188. {
  189.     size_t  i_total = 0;
  190.     uint8_t *p = (uint8_t*)p_data;
  191.     while( p_list && i_max )
  192.     {
  193.         size_t i_copy = __MIN( i_max, p_list->i_buffer );
  194.         memcpy( p, p_list->p_buffer, i_copy );
  195.         i_max   -= i_copy;
  196.         i_total += i_copy;
  197.         p       += i_copy;
  198.         p_list = p_list->p_next;
  199.     }
  200.     return i_total;
  201. }
  202. static inline void block_ChainProperties( block_t *p_list, int *pi_count, size_t *pi_size, mtime_t *pi_length )
  203. {
  204.     size_t i_size = 0;
  205.     mtime_t i_length = 0;
  206.     int i_count = 0;
  207.     while( p_list )
  208.     {
  209.         i_size += p_list->i_buffer;
  210.         i_length += p_list->i_length;
  211.         i_count++;
  212.         p_list = p_list->p_next;
  213.     }
  214.     if( pi_size )
  215.         *pi_size = i_size;
  216.     if( pi_length )
  217.         *pi_length = i_length;
  218.     if( pi_count )
  219.         *pi_count = i_count;
  220. }
  221. static inline block_t *block_ChainGather( block_t *p_list )
  222. {
  223.     size_t  i_total = 0;
  224.     mtime_t i_length = 0;
  225.     block_t *g;
  226.     if( p_list->p_next == NULL )
  227.         return p_list;  /* Already gathered */
  228.     block_ChainProperties( p_list, NULL, &i_total, &i_length );
  229.     g = block_Alloc( i_total );
  230.     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
  231.     g->i_flags = p_list->i_flags;
  232.     g->i_pts   = p_list->i_pts;
  233.     g->i_dts   = p_list->i_dts;
  234.     g->i_length = i_length;
  235.     /* free p_list */
  236.     block_ChainRelease( p_list );
  237.     return g;
  238. }
  239. /****************************************************************************
  240.  * Fifos of blocks.
  241.  ****************************************************************************
  242.  * - block_FifoNew : create and init a new fifo
  243.  * - block_FifoRelease : destroy a fifo and free all blocks in it.
  244.  * - block_FifoEmpty : free all blocks in a fifo
  245.  * - block_FifoPut : put a block
  246.  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
  247.  * - block_FifoShow : show the first packet of the fifo (and wait if
  248.  *      needed), be carefull, you can use it ONLY if you are sure to be the
  249.  *      only one getting data from the fifo.
  250.  * - block_FifoCount : how many packets are waiting in the fifo
  251.  * - block_FifoWake : wake ups a thread with block_FifoGet() = NULL
  252.  *   (this is used to wakeup a thread when there is no data to queue)
  253.  *
  254.  * block_FifoGet and block_FifoShow are cancellation points.
  255.  ****************************************************************************/
  256. VLC_EXPORT( block_fifo_t *, block_FifoNew,      ( void ) LIBVLC_USED );
  257. VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
  258. /* TODO: do we need to export this? */
  259. void block_FifoPace (block_fifo_t *fifo, size_t max_depth, size_t max_size);
  260. VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
  261. VLC_EXPORT( size_t,         block_FifoPut,      ( block_fifo_t *, block_t * ) );
  262. VLC_EXPORT( void,           block_FifoWake,     ( block_fifo_t * ) );
  263. VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) LIBVLC_USED );
  264. VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
  265. size_t block_FifoSize( const block_fifo_t *p_fifo ) LIBVLC_USED;
  266. VLC_EXPORT( size_t,         block_FifoCount,    ( const block_fifo_t *p_fifo ) LIBVLC_USED );
  267. #endif /* VLC_BLOCK_H */