keys: define Print and Pause keys
[vlc.git] / include / vlc_block_helper.h
index 404033c..fdd5fdb 100644 (file)
@@ -1,83 +1,93 @@
 /*****************************************************************************
  * vlc_block_helper.h: Helper functions for data blocks management.
  *****************************************************************************
- * Copyright (C) 2003 the VideoLAN team
+ * Copyright (C) 2003 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Gildas Bazin <gbazin@netcourrier.com>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#ifndef _VLC_BLOCK_HELPER_H
-#define _VLC_BLOCK_HELPER_H 1
+#ifndef VLC_BLOCK_HELPER_H
+#define VLC_BLOCK_HELPER_H 1
+
+#include <vlc_block.h>
 
 typedef struct block_bytestream_t
 {
-    block_t             *p_chain;
-    block_t             *p_block;
-    int                 i_offset;
-
+    block_t *p_chain;  /**< byte stream head block */
+    block_t *p_block;  /**< byte stream read pointer block */
+    size_t   i_offset; /**< byte stream read pointer offset within block */
+    /* TODO? add tail pointer for faster push? */
 } block_bytestream_t;
 
-#define block_BytestreamInit( a ) __block_BytestreamInit( VLC_OBJECT(a) )
-
 /*****************************************************************************
  * block_bytestream_t management
  *****************************************************************************/
-static inline block_bytestream_t __block_BytestreamInit( vlc_object_t *p_obj )
+static inline void block_BytestreamInit( block_bytestream_t *p_bytestream )
 {
-    block_bytestream_t bytestream;
-
-    bytestream.i_offset = 0;
-    bytestream.p_chain = bytestream.p_block = NULL;
-
-    return bytestream;
+    p_bytestream->p_chain = p_bytestream->p_block = NULL;
+    p_bytestream->i_offset = 0;
 }
 
 static inline void block_BytestreamRelease( block_bytestream_t *p_bytestream )
 {
-    while( p_bytestream->p_chain )
+    for( block_t *block = p_bytestream->p_chain; block != NULL; )
     {
-        block_t *p_next;
-        p_next = p_bytestream->p_chain->p_next;
-        p_bytestream->p_chain->pf_release( p_bytestream->p_chain );
-        p_bytestream->p_chain = p_next;
+        block_t *p_next = block->p_next;
+
+        block_Release( block );
+        block = p_next;
     }
-    p_bytestream->i_offset = 0;
-    p_bytestream->p_chain = p_bytestream->p_block = NULL;
 }
 
+/**
+ * It flush all data (read and unread) from a block_bytestream_t.
+ */
+static inline void block_BytestreamEmpty( block_bytestream_t *p_bytestream )
+{
+    block_BytestreamRelease( p_bytestream );
+    block_BytestreamInit( p_bytestream );
+}
+
+/**
+ * It flushes all already read data from a block_bytestream_t.
+ */
 static inline void block_BytestreamFlush( block_bytestream_t *p_bytestream )
 {
-    while( p_bytestream->p_chain != p_bytestream->p_block )
+    block_t *block = p_bytestream->p_chain;
+
+    while( block != p_bytestream->p_block )
     {
-        block_t *p_next;
-        p_next = p_bytestream->p_chain->p_next;
-        p_bytestream->p_chain->pf_release( p_bytestream->p_chain );
-        p_bytestream->p_chain = p_next;
+        block_t *p_next = block->p_next;
+
+        block_Release( block );
+        block = p_next;
     }
-    while( p_bytestream->p_block &&
-           (p_bytestream->p_block->i_buffer - p_bytestream->i_offset) == 0 )
+
+    while( block != NULL && block->i_buffer == p_bytestream->i_offset )
     {
-        block_t *p_next;
-        p_next = p_bytestream->p_chain->p_next;
-        p_bytestream->p_chain->pf_release( p_bytestream->p_chain );
-        p_bytestream->p_chain = p_bytestream->p_block = p_next;
+        block_t *p_next = block->p_next;
+
+        block_Release( block );
+        block = p_next;
         p_bytestream->i_offset = 0;
     }
+
+    p_bytestream->p_chain = p_bytestream->p_block = block;
 }
 
 static inline void block_BytestreamPush( block_bytestream_t *p_bytestream,
@@ -87,6 +97,7 @@ static inline void block_BytestreamPush( block_bytestream_t *p_bytestream,
     if( !p_bytestream->p_block ) p_bytestream->p_block = p_block;
 }
 
+VLC_USED
 static inline block_t *block_BytestreamPop( block_bytestream_t *p_bytestream )
 {
     block_t *p_block;
@@ -110,11 +121,9 @@ static inline block_t *block_BytestreamPop( block_bytestream_t *p_bytestream )
     while( p_block->p_next && p_block->p_next->p_next )
         p_block = p_block->p_next;
 
-    {
-        block_t *p_block_old = p_block;
-        p_block = p_block->p_next;
-        p_block_old->p_next = NULL;
-    }
+    block_t *p_block_old = p_block;
+    p_block = p_block->p_next;
+    p_block_old->p_next = NULL;
 
     return p_block;
 }
@@ -210,10 +219,10 @@ static inline int block_GetByte( block_bytestream_t *p_bytestream,
 }
 
 static inline int block_WaitBytes( block_bytestream_t *p_bytestream,
-                                   int i_data )
+                                   size_t i_data )
 {
     block_t *p_block;
-    int i_offset, i_copy, i_size;
+    size_t i_offset, i_copy, i_size;
 
     /* Check we have that much data */
     i_offset = p_bytestream->i_offset;
@@ -238,10 +247,10 @@ static inline int block_WaitBytes( block_bytestream_t *p_bytestream,
 }
 
 static inline int block_SkipBytes( block_bytestream_t *p_bytestream,
-                                   int i_data )
+                                   size_t i_data )
 {
     block_t *p_block;
-    int i_offset, i_copy;
+    size_t i_offset, i_copy;
 
     /* Check we have that much data */
     i_offset = p_bytestream->i_offset;
@@ -269,10 +278,10 @@ static inline int block_SkipBytes( block_bytestream_t *p_bytestream,
 }
 
 static inline int block_PeekBytes( block_bytestream_t *p_bytestream,
-                                   uint8_t *p_data, int i_data )
+                                   uint8_t *p_data, size_t i_data )
 {
     block_t *p_block;
-    int i_offset, i_copy, i_size;
+    size_t i_offset, i_copy, i_size;
 
     /* Check we have that much data */
     i_offset = p_bytestream->i_offset;
@@ -319,10 +328,10 @@ static inline int block_PeekBytes( block_bytestream_t *p_bytestream,
 }
 
 static inline int block_GetBytes( block_bytestream_t *p_bytestream,
-                                  uint8_t *p_data, int i_data )
+                                  uint8_t *p_data, size_t i_data )
 {
     block_t *p_block;
-    int i_offset, i_copy, i_size;
+    size_t i_offset, i_copy, i_size;
 
     /* Check we have that much data */
     i_offset = p_bytestream->i_offset;
@@ -365,7 +374,6 @@ static inline int block_GetBytes( block_bytestream_t *p_bytestream,
         i_offset = 0;
     }
 
-    /* No buffer given, just skip the data */
     p_bytestream->p_block = p_block;
     p_bytestream->i_offset = i_offset + i_copy;
 
@@ -373,10 +381,10 @@ static inline int block_GetBytes( block_bytestream_t *p_bytestream,
 }
 
 static inline int block_PeekOffsetBytes( block_bytestream_t *p_bytestream,
-    int i_peek_offset, uint8_t *p_data, int i_data )
+    size_t i_peek_offset, uint8_t *p_data, size_t i_data )
 {
     block_t *p_block;
-    int i_offset, i_copy, i_size;
+    size_t i_offset, i_copy, i_size;
 
     /* Check we have that much data */
     i_offset = p_bytestream->i_offset;
@@ -437,11 +445,12 @@ static inline int block_PeekOffsetBytes( block_bytestream_t *p_bytestream,
 }
 
 static inline int block_FindStartcodeFromOffset(
-    block_bytestream_t *p_bytestream, int *pi_offset,
-    uint8_t *p_startcode, int i_startcode_length )
+    block_bytestream_t *p_bytestream, size_t *pi_offset,
+    const uint8_t *p_startcode, int i_startcode_length )
 {
     block_t *p_block, *p_block_backup = 0;
-    int i_size, i_offset, i_offset_backup = 0;
+    int i_size = 0;
+    size_t i_offset, i_offset_backup = 0;
     int i_caller_offset_backup = 0, i_match;
 
     /* Find the right place */
@@ -462,7 +471,7 @@ static inline int block_FindStartcodeFromOffset(
     /* Begin the search.
      * We first look for an occurrence of the 1st startcode byte and
      * if found, we do a more thorough check. */
-    i_size = p_block->i_buffer + i_size;
+    i_size += p_block->i_buffer;
     *pi_offset -= i_size;
     i_match = 0;
     for( ; p_block != NULL; p_block = p_block->p_next )