home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_block.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  10.2 KB  |  281 lines

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