git.sesse.net Git - vlc/blob - modules/codec/spudec/spudec.h

   1 /*****************************************************************************
   2  * spudec.h : sub picture unit decoder thread interface
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000 VideoLAN
   5  * $Id: spudec.h,v 1.1 2002/08/04 17:23:42 sam Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   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
  24 struct subpicture_sys_t
  25 {
  26     mtime_t i_pts;                                 /* presentation timestamp */
  27
  28     int   pi_offset[2];                              /* byte offsets to data */
  29     void *p_data;
  30
  31     /* Color information */
  32     vlc_bool_t b_palette;
  33     u8    pi_alpha[4];
  34     u8    pi_yuv[4][3];
  35 };
  36
  37 /*****************************************************************************
  38  * spudec_thread_t : sub picture unit decoder thread descriptor
  39  *****************************************************************************/
  40 typedef struct spudec_thread_t
  41 {
  42     /*
  43      * Thread properties and locks
  44      */
  45     vlc_thread_t        thread_id;                /* id for thread functions */
  46
  47     /*
  48      * Input properties
  49      */
  50     decoder_fifo_t *    p_fifo;                /* stores the PES stream data */
  51     /* The bit stream structure handles the PES stream at the bit level */
  52     bit_stream_t        bit_stream;
  53
  54     /*
  55      * Output properties
  56      */
  57     vout_thread_t *     p_vout;          /* needed to create the spu objects */
  58
  59     /*
  60      * Private properties
  61      */
  62     int                 i_spu_size;            /* size of current SPU packet */
  63     int                 i_rle_size;                  /* size of the RLE part */
  64
  65 } spudec_thread_t;
  66
  67 /*****************************************************************************
  68  * Amount of bytes we GetChunk() in one go
  69  *****************************************************************************/
  70 #define SPU_CHUNK_SIZE              0x200
  71
  72 /*****************************************************************************
  73  * SPU commands
  74  *****************************************************************************/
  75 #define SPU_CMD_FORCE_DISPLAY       0x00
  76 #define SPU_CMD_START_DISPLAY       0x01
  77 #define SPU_CMD_STOP_DISPLAY        0x02
  78 #define SPU_CMD_SET_PALETTE         0x03
  79 #define SPU_CMD_SET_ALPHACHANNEL    0x04
  80 #define SPU_CMD_SET_COORDINATES     0x05
  81 #define SPU_CMD_SET_OFFSETS         0x06
  82 #define SPU_CMD_END                 0xff
  83
  84 /*****************************************************************************
  85  * AddNibble: read a nibble from a source packet and add it to our integer.
  86  *****************************************************************************/
  87 static inline unsigned int AddNibble( unsigned int i_code,
  88                                       u8 *p_src, int *pi_index )
  89 {
  90     if( *pi_index & 0x1 )
  91     {
  92         return( i_code << 4 | ( p_src[(*pi_index)++ >> 1] & 0xf ) );
  93     }
  94     else
  95     {
  96         return( i_code << 4 | p_src[(*pi_index)++ >> 1] >> 4 );
  97     }
  98 }
  99
 100 /*****************************************************************************
 101  * Prototypes
 102  *****************************************************************************/
 103 vlc_thread_t       spudec_CreateThread( decoder_fifo_t * p_fifo );
 104