vlc_block.h
上传用户:riyaled888
上传日期:2009-03-27
资源大小:7338k
文件大小:10k
源码类别:

多媒体

开发平台:

MultiPlatform

  1. /*****************************************************************************
  2.  * vlc_block.h: Data blocks management functions
  3.  *****************************************************************************
  4.  * Copyright (C) 2003 VideoLAN
  5.  * $Id: vlc_block.h 9043 2004-10-22 18:34:38Z gbazin $
  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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22.  *****************************************************************************/
  23. #ifndef _VLC_BLOCK_H
  24. #define _VLC_BLOCK_H 1
  25. /****************************************************************************
  26.  * block:
  27.  ****************************************************************************
  28.  * - block_sys_t is opaque and thus block_t->p_sys is PRIVATE
  29.  * - i_flags may not always be set (ie could be 0, even for a key frame
  30.  *      it depends where you receive the buffer (before/after a packetizer
  31.  *      and the demux/packetizer implementations.
  32.  * - i_dts/i_pts could be 0, it means no pts
  33.  * - i_length: length in microseond of the packet, can be null except in the
  34.  *      sout where it is mandatory.
  35.  * - i_rate 0 or a valid input rate, look at vlc_input.h
  36.  *
  37.  * - i_buffer number of valid data pointed by p_buffer
  38.  *      you can freely decrease it but never increase it yourself
  39.  *      (use block_Realloc)
  40.  * - p_buffer: pointer over datas. You should never overwrite it, you can
  41.  *   only incremment it to skip datas, in others cases use block_Realloc
  42.  *   (don't duplicate yourself in a bigger buffer, block_Realloc is
  43.  *   optimised for prehader/postdatas increase)
  44.  ****************************************************************************/
  45. typedef struct block_sys_t block_sys_t;
  46. /** The content doesn't follow the last block, or is probably broken */
  47. #define BLOCK_FLAG_DISCONTINUITY 0x0001
  48. /** Intra frame */
  49. #define BLOCK_FLAG_TYPE_I        0x0002
  50. /** Inter frame with backward reference only */
  51. #define BLOCK_FLAG_TYPE_P        0x0004
  52. /** Inter frame with backward and forward reference */
  53. #define BLOCK_FLAG_TYPE_B        0x0008
  54. /** For inter frame when you don't know the real type */
  55. #define BLOCK_FLAG_TYPE_PB       0x0010
  56. /** Warm that this block is a header one */
  57. #define BLOCK_FLAG_HEADER        0x0020
  58. /** This is the last block of the frame */
  59. #define BLOCK_FLAG_END_OF_FRAME  0x0040
  60. /** No keyframes present */
  61. #define BLOCK_FLAG_NO_KEYFRAME   0x0080
  62. #define BLOCK_FLAG_PRIVATE_MASK  0xffff0000
  63. #define BLOCK_FLAG_PRIVATE_SHIFT 16
  64. struct block_t
  65. {
  66.     block_t     *p_next;
  67.     uint32_t    i_flags;
  68.     mtime_t     i_pts;
  69.     mtime_t     i_dts;
  70.     mtime_t     i_length;
  71.     int         i_samples; /* Used for audio */
  72.     int         i_rate;
  73.     int         i_buffer;
  74.     uint8_t     *p_buffer;
  75.     /* This way the block_Release can be overloaded
  76.      * Don't mess with it now, if you need it the ask on ML
  77.      */
  78.     void        (*pf_release)   ( block_t * );
  79.     /* It's an object that should be valid as long as the block_t is valid */
  80.     /* It should become a true block manager to reduce malloc/free */
  81.     vlc_object_t    *p_manager;
  82.     /* Following fields are private, user should never touch it */
  83.     /* XXX never touch that OK !!! the first that access that will
  84.      * have cvs account removed ;) XXX */
  85.     block_sys_t *p_sys;
  86. };
  87. /****************************************************************************
  88.  * Blocks functions:
  89.  ****************************************************************************
  90.  * - block_New : create a new block with the requested size ( >= 0 ), return
  91.  *      NULL for failure.
  92.  * - block_Release : release a block allocated with block_New.
  93.  * - block_Realloc : realloc a block,
  94.  *      i_pre: how many bytes to insert before body if > 0, else how many
  95.  *      bytes of body to skip (the latter can be done without using
  96.  *      block_Realloc i_buffer -= -i_pre, p_buffer += -i_pre as i_pre < 0)
  97.  *      i_body (>= 0): the final size of the body (decreasing it can directly
  98.  *      be done with i_buffer = i_body).
  99.  *      with preheader and or body (increase
  100.  *      and decrease are supported). Use it as it is optimised.
  101.  * - block_Duplicate : create a copy of a block.
  102.  ****************************************************************************/
  103. #define block_New( a, b ) __block_New( VLC_OBJECT(a), b )
  104. VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, int ) );
  105. VLC_EXPORT( block_t *, block_Realloc,       ( block_t *, int i_pre, int i_body ) );
  106. static inline block_t *block_Duplicate( block_t *p_block )
  107. {
  108.     block_t *p_dup = block_New( p_block->p_manager, p_block->i_buffer );
  109.     p_dup->i_dts     = p_block->i_dts;
  110.     p_dup->i_pts     = p_block->i_pts;
  111.     p_dup->i_flags   = p_block->i_flags;
  112.     p_dup->i_length  = p_block->i_length;
  113.     p_dup->i_rate    = p_block->i_rate;
  114.     p_dup->i_samples = p_block->i_samples;
  115.     if( p_dup && p_block->i_buffer > 0 )
  116.         memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
  117.     return p_dup;
  118. }
  119. static inline void block_Release( block_t *p_block )
  120. {
  121.     p_block->pf_release( p_block );
  122. }
  123. /****************************************************************************
  124.  * Chains of blocks functions helper
  125.  ****************************************************************************
  126.  * - block_ChainAppend : append a block the the last block of a chain. Try to
  127.  *      avoid using with a lot of data as it's really slow, prefer
  128.  *      block_ChainLastAppend
  129.  * - block_ChainLastAppend : use a pointer over a pointer to the next blocks,
  130.  *      and update it.
  131.  * - block_ChainRelease : release a chain of block
  132.  * - block_ChainExtract : extract data from a chain, return real bytes counts
  133.  * - block_ChainGather : gather a chain, free it and return a block.
  134.  ****************************************************************************/
  135. static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
  136. {
  137.     if( *pp_list == NULL )
  138.     {
  139.         *pp_list = p_block;
  140.     }
  141.     else
  142.     {
  143.         block_t *p = *pp_list;
  144.         while( p->p_next ) p = p->p_next;
  145.         p->p_next = p_block;
  146.     }
  147. }
  148. static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block  )
  149. {
  150.     block_t *p_last = p_block;
  151.     **ppp_last = p_block;
  152.     while( p_last->p_next ) p_last = p_last->p_next;
  153.     *ppp_last = &p_last->p_next;
  154. }
  155. static inline void block_ChainRelease( block_t *p_block )
  156. {
  157.     while( p_block )
  158.     {
  159.         block_t *p_next = p_block->p_next;
  160.         block_Release( p_block );
  161.         p_block = p_next;
  162.     }
  163. }
  164. static int block_ChainExtract( block_t *p_list, void *p_data, int i_max )
  165. {
  166.     block_t *b;
  167.     int     i_total = 0;
  168.     uint8_t *p = (uint8_t*)p_data;
  169.     for( b = p_list; b != NULL; b = b->p_next )
  170.     {
  171.         int i_copy = __MIN( i_max, b->i_buffer );
  172.         if( i_copy > 0 )
  173.         {
  174.             memcpy( p, b->p_buffer, i_copy );
  175.             i_max   -= i_copy;
  176.             i_total += i_copy;
  177.             p       += i_copy;
  178.             if( i_max == 0 )
  179.                 return i_total;
  180.         }
  181.     }
  182.     return i_total;
  183. }
  184. static inline block_t *block_ChainGather( block_t *p_list )
  185. {
  186.     int     i_total = 0;
  187.     block_t *b, *g;
  188.     if( p_list->p_next == NULL )
  189.         return p_list;  /* Already gathered */
  190.     for( b = p_list; b != NULL; b = b->p_next )
  191.         i_total += b->i_buffer;
  192.     g = block_New( p_list->p_manager, i_total );
  193.     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
  194.     g->i_flags = p_list->i_flags;
  195.     g->i_pts   = p_list->i_pts;
  196.     g->i_dts   = p_list->i_dts;
  197.     /* free p_list */
  198.     block_ChainRelease( p_list );
  199.     return g;
  200. }
  201. /****************************************************************************
  202.  * Fifos of blocks.
  203.  ****************************************************************************
  204.  * Avoid touching block_fifo_t unless you really know what you are doing.
  205.  * ( Some race conditions has to be correctly handled, like in win32 ;)
  206.  * - block_FifoNew : create and init a new fifo
  207.  * - block_FifoRelease : destroy a fifo and free all blocks in it.
  208.  * - block_FifoEmpty : free all blocks in a fifo
  209.  * - block_FifoPut : put a block
  210.  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
  211.  * - block_FifoShow : show the first packet of the fifo (and wait if
  212.  *      needed), becarefull, you can use it ONLY if you are sure to be the
  213.  *      only one getting data from the fifo.
  214.  ****************************************************************************/
  215. struct block_fifo_t
  216. {
  217.     vlc_mutex_t         lock;                         /* fifo data lock */
  218.     vlc_cond_t          wait;         /* fifo data conditional variable */
  219.     int                 i_depth;
  220.     block_t             *p_first;
  221.     block_t             **pp_last;
  222.     int                 i_size;
  223. };
  224. #define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
  225. VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
  226. VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
  227. VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
  228. VLC_EXPORT( int,            block_FifoPut,      ( block_fifo_t *, block_t * ) );
  229. VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) );
  230. VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
  231. #endif /* VLC_BLOCK_H */