]> git.sesse.net Git - vlc/blobdiff - include/vlc_block_helper.h
decoder: reorder to avoid forward declation, no functional changes
[vlc] / include / vlc_block_helper.h
index d7b2763cd384f17858bf191e414e11330ba7b5f1..ef4d752c6b5c2f9b240ff407f2fa48664aae9654 100644 (file)
@@ -1,24 +1,24 @@
 /*****************************************************************************
  * 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
 
 typedef struct block_bytestream_t
 {
-    block_t             *p_chain;
-    block_t             *p_block;
-    size_t              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;
 
 /*****************************************************************************
  * block_bytestream_t management
  *****************************************************************************/
-VLC_USED
-static inline block_bytestream_t block_BytestreamInit( void )
+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;
 }
 
 /**
@@ -67,8 +60,7 @@ static inline void block_BytestreamRelease( block_bytestream_t *p_bytestream )
 static inline void block_BytestreamEmpty( block_bytestream_t *p_bytestream )
 {
     block_BytestreamRelease( p_bytestream );
-
-    *p_bytestream = block_BytestreamInit();
+    block_BytestreamInit( p_bytestream );
 }
 
 /**
@@ -76,22 +68,26 @@ static inline void block_BytestreamEmpty( block_bytestream_t *p_bytestream )
  */
 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,
@@ -109,7 +105,7 @@ static inline block_t *block_BytestreamPop( block_bytestream_t *p_bytestream )
     block_BytestreamFlush( p_bytestream );
 
     p_block = p_bytestream->p_block;
-    if( p_block == NULL )
+    if( unlikely( p_block == NULL ) )
     {
         return NULL;
     }
@@ -125,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;
 }
@@ -137,7 +131,7 @@ static inline block_t *block_BytestreamPop( block_bytestream_t *p_bytestream )
 static inline int block_SkipByte( block_bytestream_t *p_bytestream )
 {
     /* Most common case first */
-    if( p_bytestream->p_block->i_buffer - p_bytestream->i_offset )
+    if( likely( p_bytestream->p_block->i_buffer - p_bytestream->i_offset ) )
     {
         p_bytestream->i_offset++;
         return VLC_SUCCESS;
@@ -167,7 +161,7 @@ static inline int block_PeekByte( block_bytestream_t *p_bytestream,
                                   uint8_t *p_data )
 {
     /* Most common case first */
-    if( p_bytestream->p_block->i_buffer - p_bytestream->i_offset )
+    if( likely( p_bytestream->p_block->i_buffer - p_bytestream->i_offset ) )
     {
         *p_data = p_bytestream->p_block->p_buffer[p_bytestream->i_offset];
         return VLC_SUCCESS;
@@ -196,7 +190,7 @@ static inline int block_GetByte( block_bytestream_t *p_bytestream,
                                  uint8_t *p_data )
 {
     /* Most common case first */
-    if( p_bytestream->p_block->i_buffer - p_bytestream->i_offset )
+    if( likely( p_bytestream->p_block->i_buffer - p_bytestream->i_offset ) )
     {
         *p_data = p_bytestream->p_block->p_buffer[p_bytestream->i_offset];
         p_bytestream->i_offset++;
@@ -380,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;
 
@@ -469,7 +462,7 @@ static inline int block_FindStartcodeFromOffset(
         if( i_size < 0 ) break;
     }
 
-    if( i_size >= 0 )
+    if( unlikely( i_size >= 0 ) )
     {
         /* Not enough data, bail out */
         return VLC_EGENERIC;