]> git.sesse.net Git - vlc/blobdiff - include/vlc_block.h
Sort the plugin list
[vlc] / include / vlc_block.h
index 831f37269c23ee2aaa4095241c8a6f7c2bc633f2..673414c43841d0b3471b4a01f32e34634acf3eba 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * vlc_block.h: Data blocks management functions
  *****************************************************************************
- * Copyright (C) 2003 VideoLAN
+ * Copyright (C) 2003 the VideoLAN team
  * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
@@ -18,7 +18,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 #ifndef _VLC_BLOCK_H
@@ -56,25 +56,30 @@ typedef struct block_sys_t block_sys_t;
 #define BLOCK_FLAG_TYPE_B        0x0008
 /** For inter frame when you don't know the real type */
 #define BLOCK_FLAG_TYPE_PB       0x0010
-/** Warm that this block is a header one */
+/** Warn that this block is a header one */
 #define BLOCK_FLAG_HEADER        0x0020
 /** This is the last block of the frame */
 #define BLOCK_FLAG_END_OF_FRAME  0x0040
 /** This is not a key frame for bitrate shaping */
 #define BLOCK_FLAG_NO_KEYFRAME   0x0080
-/** This is the last block of the GOP */
-#define BLOCK_FLAG_END_OF_GOP    0x0100
 /** This block contains a clock reference */
 #define BLOCK_FLAG_CLOCK         0x0200
 /** This block is scrambled */
 #define BLOCK_FLAG_SCRAMBLED     0x0400
+/** This block has to be decoded but not be displayed */
+#define BLOCK_FLAG_PREROLL       0x0800
+/** 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
 
+typedef void (*block_free_t) (block_t *);
+
 struct block_t
 {
     block_t     *p_next;
+    block_t     *p_prev;
 
     uint32_t    i_flags;
 
@@ -85,30 +90,19 @@ struct block_t
     int         i_samples; /* Used for audio */
     int         i_rate;
 
-    int         i_buffer;
+    size_t      i_buffer;
     uint8_t     *p_buffer;
 
-    /* This way the block_Release can be overloaded
-     * Don't mess with it now, if you need it the ask on ML
-     */
-    void        (*pf_release)   ( block_t * );
-
-    /* It's an object that should be valid as long as the block_t is valid */
-    /* It should become a true block manager to reduce malloc/free */
-    vlc_object_t    *p_manager;
-
-    /* Following fields are private, user should never touch it */
-    /* XXX never touch that OK !!! the first that access that will
-     * have cvs account removed ;) XXX */
-    block_sys_t *p_sys;
+    /* Rudimentary support for overloading block (de)allocation. */
+    block_free_t pf_release;
 };
 
 /****************************************************************************
  * Blocks functions:
  ****************************************************************************
- * - block_New : create a new block with the requested size ( >= 0 ), return
+ * - block_Alloc : create a new block with the requested size ( >= 0 ), return
  *      NULL for failure.
- * - block_Release : release a block allocated with block_New.
+ * - block_Release : release a block allocated with block_Alloc.
  * - block_Realloc : realloc a block,
  *      i_pre: how many bytes to insert before body if > 0, else how many
  *      bytes of body to skip (the latter can be done without using
@@ -119,13 +113,17 @@ struct block_t
  *      and decrease are supported). Use it as it is optimised.
  * - block_Duplicate : create a copy of a block.
  ****************************************************************************/
-#define block_New( a, b ) __block_New( VLC_OBJECT(a), b )
-VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, int ) );
-VLC_EXPORT( block_t *, block_Realloc,       ( block_t *, int i_pre, int i_body ) );
+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 ) );
+
+#define block_New( dummy, size ) block_Alloc(size)
 
 static inline block_t *block_Duplicate( block_t *p_block )
 {
-    block_t *p_dup = block_New( p_block->p_manager, p_block->i_buffer );
+    block_t *p_dup = block_Alloc( p_block->i_buffer );
+    if( p_dup == NULL )
+        return NULL;
 
     p_dup->i_dts     = p_block->i_dts;
     p_dup->i_pts     = p_block->i_pts;
@@ -133,9 +131,7 @@ static inline block_t *block_Duplicate( block_t *p_block )
     p_dup->i_length  = p_block->i_length;
     p_dup->i_rate    = p_block->i_rate;
     p_dup->i_samples = p_block->i_samples;
-
-    if( p_dup && p_block->i_buffer > 0 )
-        memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
+    memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
 
     return p_dup;
 }
@@ -144,6 +140,9 @@ 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) );
+
 /****************************************************************************
  * Chains of blocks functions helper
  ****************************************************************************
@@ -190,46 +189,47 @@ static inline void block_ChainRelease( block_t *p_block )
         p_block = p_next;
     }
 }
-static int block_ChainExtract( block_t *p_list, void *p_data, int i_max )
+
+static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max )
 {
-    block_t *b;
-    int     i_total = 0;
+    size_t  i_total = 0;
     uint8_t *p = (uint8_t*)p_data;
 
-    for( b = p_list; b != NULL; b = b->p_next )
+    while( p_list && i_max )
     {
-        int i_copy = __MIN( i_max, b->i_buffer );
-        if( i_copy > 0 )
-        {
-            memcpy( p, b->p_buffer, i_copy );
-            i_max   -= i_copy;
-            i_total += i_copy;
-            p       += i_copy;
-
-            if( i_max == 0 )
-                return i_total;
-        }
+        size_t i_copy = __MIN( i_max, p_list->i_buffer );
+        memcpy( p, p_list->p_buffer, i_copy );
+        i_max   -= i_copy;
+        i_total += i_copy;
+        p       += i_copy;
+
+        p_list = p_list->p_next;
     }
     return i_total;
 }
 
 static inline block_t *block_ChainGather( block_t *p_list )
 {
-    int     i_total = 0;
+    size_t  i_total = 0;
+    mtime_t i_length = 0;
     block_t *b, *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;
+    }
 
-    g = block_New( p_list->p_manager, i_total );
+    g = block_Alloc( i_total );
     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
 
     g->i_flags = p_list->i_flags;
     g->i_pts   = p_list->i_pts;
     g->i_dts   = p_list->i_dts;
+    g->i_length = i_length;
 
     /* free p_list */
     block_ChainRelease( p_list );
@@ -240,35 +240,28 @@ static inline block_t *block_ChainGather( block_t *p_list )
 /****************************************************************************
  * Fifos of blocks.
  ****************************************************************************
- * Avoid touching block_fifo_t unless you really know what you are doing.
- * ( Some race conditions has to be correctly handled, like in win32 ;)
  * - block_FifoNew : create and init a new fifo
  * - block_FifoRelease : destroy a fifo and free all blocks in it.
  * - block_FifoEmpty : free all blocks in a fifo
  * - block_FifoPut : put a block
  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
  * - block_FifoShow : show the first packet of the fifo (and wait if
- *      needed), becarefull, you can use it ONLY if you are sure to be the
+ *      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)
  ****************************************************************************/
-struct block_fifo_t
-{
-    vlc_mutex_t         lock;                         /* fifo data lock */
-    vlc_cond_t          wait;         /* fifo data conditional variable */
-
-    int                 i_depth;
-    block_t             *p_first;
-    block_t             **pp_last;
-    int                 i_size;
-};
-
 
-#define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
-VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
+VLC_EXPORT( block_fifo_t *, block_FifoNew,      ( void ) );
 VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
 VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
-VLC_EXPORT( int,            block_FifoPut,      ( block_fifo_t *, block_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_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 ) );
 
 #endif /* VLC_BLOCK_H */