buffer.h

Go to the documentation of this file.

/*
 * Copyright (C) 2000-2017 the xine project
 *
 * This file is part of xine, a free video player.
 *
 * xine 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
 * (at your option) any later version.
 *
 * xine 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.
 *
 * 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, USA
 *
 *
 * contents:
 *
 * buffer_entry structure - serves as a transport encapsulation
 *   of the mpeg audio/video data through xine
 *
 * free buffer pool management routines
 *
 * FIFO buffer structures/routines
 */

#ifndef HAVE_BUFFER_H
#define HAVE_BUFFER_H

#ifdef __cplusplus
extern "C" {
#endif

#include <string.h>
#include <stdio.h>
#include <pthread.h>
#include <sys/types.h>

#include <xine/os_types.h>
#include <xine/attributes.h>

#define BUF_MAX_CALLBACKS 5


#define BUF_MAJOR_MASK       0xFF000000
#define BUF_DECODER_MASK     0x00FF0000

#define BUF_CONTROL_BASE            0x01000000
#define BUF_CONTROL_START           0x01000000
#define BUF_CONTROL_END             0x01010000
#define BUF_CONTROL_QUIT            0x01020000
#define BUF_CONTROL_DISCONTINUITY   0x01030000 
#define BUF_CONTROL_NOP             0x01040000
#define BUF_CONTROL_AUDIO_CHANNEL   0x01050000
#define BUF_CONTROL_SPU_CHANNEL     0x01060000
#define BUF_CONTROL_NEWPTS          0x01070000
#define BUF_CONTROL_RESET_DECODER   0x01080000
#define BUF_CONTROL_HEADERS_DONE    0x01090000
#define BUF_CONTROL_FLUSH_DECODER   0x010a0000
#define BUF_CONTROL_RESET_TRACK_MAP 0x010b0000

#define BUF_VIDEO_BASE          0x02000000
#define BUF_VIDEO_UNKNOWN       0x02ff0000 
#define BUF_VIDEO_MPEG          0x02000000
#define BUF_VIDEO_MPEG4         0x02010000
#define BUF_VIDEO_CINEPAK       0x02020000
#define BUF_VIDEO_SORENSON_V1   0x02030000
#define BUF_VIDEO_MSMPEG4_V2    0x02040000
#define BUF_VIDEO_MSMPEG4_V3    0x02050000
#define BUF_VIDEO_MJPEG         0x02060000
#define BUF_VIDEO_IV50          0x02070000
#define BUF_VIDEO_IV41          0x02080000
#define BUF_VIDEO_IV32          0x02090000
#define BUF_VIDEO_IV31          0x020a0000
#define BUF_VIDEO_ATIVCR1       0x020b0000
#define BUF_VIDEO_ATIVCR2       0x020c0000
#define BUF_VIDEO_I263          0x020d0000
#define BUF_VIDEO_RV10          0x020e0000
#define BUF_VIDEO_RGB           0x02100000
#define BUF_VIDEO_YUY2          0x02110000
#define BUF_VIDEO_JPEG          0x02120000
#define BUF_VIDEO_WMV7          0x02130000
#define BUF_VIDEO_WMV8          0x02140000
#define BUF_VIDEO_MSVC          0x02150000
#define BUF_VIDEO_DV            0x02160000
#define BUF_VIDEO_REAL  0x02170000
#define BUF_VIDEO_VP31          0x02180000
#define BUF_VIDEO_H263          0x02190000
#define BUF_VIDEO_3IVX          0x021A0000
#define BUF_VIDEO_CYUV          0x021B0000
#define BUF_VIDEO_DIVX5         0x021C0000
#define BUF_VIDEO_XVID          0x021D0000
#define BUF_VIDEO_SMC           0x021E0000
#define BUF_VIDEO_RPZA          0x021F0000
#define BUF_VIDEO_QTRLE         0x02200000
#define BUF_VIDEO_MSRLE         0x02210000
#define BUF_VIDEO_DUCKTM1       0x02220000
#define BUF_VIDEO_FLI           0x02230000
#define BUF_VIDEO_ROQ           0x02240000
#define BUF_VIDEO_SORENSON_V3   0x02250000
#define BUF_VIDEO_MSMPEG4_V1    0x02260000
#define BUF_VIDEO_MSS1          0x02270000
#define BUF_VIDEO_IDCIN         0x02280000
#define BUF_VIDEO_PGVV          0x02290000
#define BUF_VIDEO_ZYGO          0x022A0000
#define BUF_VIDEO_TSCC          0x022B0000
#define BUF_VIDEO_YVU9          0x022C0000
#define BUF_VIDEO_VQA           0x022D0000
#define BUF_VIDEO_GREY          0x022E0000
#define BUF_VIDEO_XXAN          0x022F0000
#define BUF_VIDEO_WC3           0x02300000
#define BUF_VIDEO_YV12          0x02310000
#define BUF_VIDEO_SEGA          0x02320000
#define BUF_VIDEO_RV20          0x02330000
#define BUF_VIDEO_RV30          0x02340000
#define BUF_VIDEO_MVI2          0x02350000
#define BUF_VIDEO_UCOD          0x02360000
#define BUF_VIDEO_WMV9          0x02370000
#define BUF_VIDEO_INTERPLAY     0x02380000
#define BUF_VIDEO_RV40          0x02390000
#define BUF_VIDEO_PSX_MDEC      0x023A0000
#define BUF_VIDEO_YUV_FRAMES    0x023B0000 
#define BUF_VIDEO_HUFFYUV       0x023C0000
#define BUF_VIDEO_IMAGE         0x023D0000
#define BUF_VIDEO_THEORA        0x023E0000
#define BUF_VIDEO_4XM           0x023F0000
#define BUF_VIDEO_I420          0x02400000
#define BUF_VIDEO_VP4           0x02410000
#define BUF_VIDEO_VP5           0x02420000
#define BUF_VIDEO_VP6           0x02430000
#define BUF_VIDEO_VMD           0x02440000
#define BUF_VIDEO_MSZH          0x02450000
#define BUF_VIDEO_ZLIB          0x02460000
#define BUF_VIDEO_8BPS          0x02470000
#define BUF_VIDEO_ASV1          0x02480000
#define BUF_VIDEO_ASV2          0x02490000
#define BUF_VIDEO_BITPLANE      0x024A0000 
#define BUF_VIDEO_BITPLANE_BR1  0x024B0000 
#define BUF_VIDEO_FLV1          0x024C0000
#define BUF_VIDEO_H264          0x024D0000
#define BUF_VIDEO_MJPEG_B       0x024E0000
#define BUF_VIDEO_H261          0x024F0000
#define BUF_VIDEO_AASC          0x02500000
#define BUF_VIDEO_LOCO          0x02510000
#define BUF_VIDEO_QDRW          0x02520000
#define BUF_VIDEO_QPEG          0x02530000
#define BUF_VIDEO_ULTI          0x02540000
#define BUF_VIDEO_WNV1          0x02550000
#define BUF_VIDEO_XL            0x02560000
#define BUF_VIDEO_RT21          0x02570000
#define BUF_VIDEO_FPS1          0x02580000
#define BUF_VIDEO_DUCKTM2       0x02590000
#define BUF_VIDEO_CSCD          0x025A0000
#define BUF_VIDEO_ALGMM         0x025B0000
#define BUF_VIDEO_ZMBV          0x025C0000
#define BUF_VIDEO_AVS           0x025D0000
#define BUF_VIDEO_SMACKER       0x025E0000
#define BUF_VIDEO_NUV           0x025F0000
#define BUF_VIDEO_KMVC          0x02600000
#define BUF_VIDEO_FLASHSV       0x02610000
#define BUF_VIDEO_CAVS          0x02620000
#define BUF_VIDEO_VP6F          0x02630000
#define BUF_VIDEO_THEORA_RAW    0x02640000
#define BUF_VIDEO_VC1           0x02650000
#define BUF_VIDEO_VMNC          0x02660000
#define BUF_VIDEO_SNOW          0x02670000
#define BUF_VIDEO_VP8           0x02680000
#define BUF_VIDEO_VP9           0x02690000
#define BUF_VIDEO_HEVC          0x026A0000

#define BUF_AUDIO_BASE          0x03000000
#define BUF_AUDIO_UNKNOWN       0x03ff0000 
#define BUF_AUDIO_A52           0x03000000
#define BUF_AUDIO_MPEG          0x03010000
#define BUF_AUDIO_LPCM_BE       0x03020000
#define BUF_AUDIO_LPCM_LE       0x03030000
#define BUF_AUDIO_WMAV1         0x03040000
#define BUF_AUDIO_DTS           0x03050000
#define BUF_AUDIO_MSADPCM       0x03060000
#define BUF_AUDIO_MSIMAADPCM    0x03070000
#define BUF_AUDIO_MSGSM         0x03080000
#define BUF_AUDIO_VORBIS        0x03090000
#define BUF_AUDIO_IMC           0x030a0000
#define BUF_AUDIO_LH            0x030b0000
#define BUF_AUDIO_VOXWARE       0x030c0000
#define BUF_AUDIO_ACELPNET      0x030d0000
#define BUF_AUDIO_AAC           0x030e0000
#define BUF_AUDIO_DNET  0x030f0000
#define BUF_AUDIO_VIVOG723      0x03100000
#define BUF_AUDIO_DK3ADPCM      0x03110000
#define BUF_AUDIO_DK4ADPCM      0x03120000
#define BUF_AUDIO_ROQ           0x03130000
#define BUF_AUDIO_QTIMAADPCM    0x03140000
#define BUF_AUDIO_MAC3          0x03150000
#define BUF_AUDIO_MAC6          0x03160000
#define BUF_AUDIO_QDESIGN1      0x03170000
#define BUF_AUDIO_QDESIGN2      0x03180000
#define BUF_AUDIO_QCLP          0x03190000
#define BUF_AUDIO_SMJPEG_IMA    0x031A0000
#define BUF_AUDIO_VQA_IMA       0x031B0000
#define BUF_AUDIO_MULAW         0x031C0000
#define BUF_AUDIO_ALAW          0x031D0000
#define BUF_AUDIO_GSM610        0x031E0000
#define BUF_AUDIO_EA_ADPCM      0x031F0000
#define BUF_AUDIO_WMAV2         0x03200000
#define BUF_AUDIO_COOK          0x03210000
#define BUF_AUDIO_ATRK          0x03220000
#define BUF_AUDIO_14_4          0x03230000
#define BUF_AUDIO_28_8          0x03240000
#define BUF_AUDIO_SIPRO         0x03250000
#define BUF_AUDIO_WMAPRO        0x03260000
#define BUF_AUDIO_WMAV3 BUF_AUDIO_WMAPRO
#define BUF_AUDIO_INTERPLAY     0x03270000
#define BUF_AUDIO_XA_ADPCM      0x03280000
#define BUF_AUDIO_WESTWOOD      0x03290000
#define BUF_AUDIO_DIALOGIC_IMA  0x032A0000
#define BUF_AUDIO_NSF           0x032B0000
#define BUF_AUDIO_FLAC          0x032C0000
#define BUF_AUDIO_DV            0x032D0000
#define BUF_AUDIO_WMAV          0x032E0000
#define BUF_AUDIO_SPEEX         0x032F0000
#define BUF_AUDIO_RAWPCM        0x03300000
#define BUF_AUDIO_4X_ADPCM      0x03310000
#define BUF_AUDIO_VMD           0x03320000
#define BUF_AUDIO_XAN_DPCM      0x03330000
#define BUF_AUDIO_ALAC          0x03340000
#define BUF_AUDIO_MPC           0x03350000
#define BUF_AUDIO_SHORTEN       0x03360000
#define BUF_AUDIO_WESTWOOD_SND1 0x03370000
#define BUF_AUDIO_WMALL         0x03380000
#define BUF_AUDIO_TRUESPEECH    0x03390000
#define BUF_AUDIO_TTA           0x033A0000
#define BUF_AUDIO_SMACKER       0x033B0000
#define BUF_AUDIO_FLVADPCM      0x033C0000
#define BUF_AUDIO_WAVPACK       0x033D0000
#define BUF_AUDIO_MP3ADU        0x033E0000
#define BUF_AUDIO_AMR_NB        0x033F0000
#define BUF_AUDIO_AMR_WB        0x03400000
#define BUF_AUDIO_EAC3          0x03410000
#define BUF_AUDIO_AAC_LATM      0x03420000
#define BUF_AUDIO_ADPCM_G726    0x03430000
#define BUF_AUDIO_OPUS          0x03440000
#define BUF_AUDIO_TRUEHD        0x03450000

#define BUF_SPU_BASE            0x04000000
#define BUF_SPU_DVD             0x04000000
#define BUF_SPU_TEXT            0x04010000
#define BUF_SPU_CC              0x04020000
#define BUF_SPU_DVB             0x04030000
#define BUF_SPU_SVCD            0x04040000
#define BUF_SPU_CVD             0x04050000
#define BUF_SPU_OGM             0x04060000
#define BUF_SPU_CMML            0x04070000
#define BUF_SPU_HDMV            0x04080000

#define BUF_DEMUX_BLOCK         0x05000000


typedef struct extra_info_s extra_info_t;

struct extra_info_s {

  int                   input_normpos; 
  int                   input_time;    
  uint32_t              frame_number;  
  int                   seek_count;    
  int64_t               vpts;          
  int                   invalid;       
  int                   total_time;    
};


#define BUF_NUM_DEC_INFO 5

typedef struct buf_element_s buf_element_t;
struct buf_element_s {
  buf_element_t        *next;

  unsigned char        *mem;
  unsigned char        *content;   
  int32_t               size ;     
  int32_t               max_size;  
  int64_t               pts;       
  int64_t               disc_off;  
  extra_info_t         *extra_info; 
  uint32_t              decoder_flags; 
  uint32_t              decoder_info[BUF_NUM_DEC_INFO];
  void                 *decoder_info_ptr[BUF_NUM_DEC_INFO];

  void (*free_buffer) (buf_element_t *buf);

  void                 *source;   
  uint32_t              type;
} ;

#define BUF_FLAG_KEYFRAME    0x0001

#define BUF_FLAG_FRAME_START 0x0002
#define BUF_FLAG_FRAME_END   0x0004

#define BUF_FLAG_HEADER      0x0008

#define BUF_FLAG_PREVIEW     0x0010

#define BUF_FLAG_END_USER    0x0020

#define BUF_FLAG_END_STREAM  0x0040

#define BUF_FLAG_FRAMERATE   0x0080

#define BUF_FLAG_SEEK        0x0100

#define BUF_FLAG_SPECIAL     0x0200

#define BUF_FLAG_STDHEADER   0x0400

#define BUF_FLAG_ASPECT      0x0800

/* represent the state of gapless_switch at the time buf was enqueued */
#define BUF_FLAG_GAPLESS_SW  0x1000

/* Amount of audio padding added by encoder (mp3, aac). These empty
 * audio frames are causing a gap when switching between mp3 files.
 * decoder_info[1] carries amount of audio frames padded at the
 * beginning of the buffer
 * decoder_info[2] carries amount of audio frames padded at the end of
 * the buffer                                                         */
#define BUF_FLAG_AUDIO_PADDING 0x2000

#define BUF_FLAG_COLOR_MATRIX 0x4000

#define BUF_FLAG_MERGE 0x8000


#define BUF_SPECIAL_PALETTE  1


/* special buffer type 2 used to be defined but is now available for use */


#define BUF_SPECIAL_ASPECT  3

#define BUF_SPECIAL_DECODER_CONFIG  4

#define BUF_SPECIAL_STSD_ATOM  5

#define BUF_SPECIAL_LPCM_CONFIG 6

#define BUF_SPECIAL_CHARSET_ENCODING 7


#define BUF_SPECIAL_SPU_DVD_SUBTYPE 8


#define SPU_DVD_SUBTYPE_CLUT            1
#define SPU_DVD_SUBTYPE_PACKAGE         2
#define SPU_DVD_SUBTYPE_VOBSUB_PACKAGE  3
#define SPU_DVD_SUBTYPE_NAV             4

#define BUF_SPECIAL_SPU_DVB_DESCRIPTOR 9

#define BUF_SPECIAL_RV_CHUNK_TABLE 10

typedef struct spu_dvb_descriptor_s spu_dvb_descriptor_t;
struct spu_dvb_descriptor_s
{
  char lang[4];
  long comp_page_id;
  long aux_page_id;
} ;

typedef struct palette_entry_s palette_entry_t;
struct palette_entry_s
{
  unsigned char r, g, b;
} ;

typedef struct fifo_buffer_s fifo_buffer_t;
struct fifo_buffer_s
{
  buf_element_t  *first, *last;

  int             fifo_size;
  uint32_t        fifo_data_size;
  void            *fifo_empty_cb_data;

  pthread_mutex_t mutex;
  pthread_cond_t  not_empty;

  /*
   * functions to access this fifo:
   */

  void (*put) (fifo_buffer_t *fifo, buf_element_t *buf);

  buf_element_t *(*get) (fifo_buffer_t *fifo);

  void (*clear) (fifo_buffer_t *fifo) ;

  int (*size) (fifo_buffer_t *fifo);

  int (*num_free) (fifo_buffer_t *fifo);

  uint32_t (*data_size) (fifo_buffer_t *fifo);

  void (*dispose) (fifo_buffer_t *fifo);

  /*
   * alloc buffer for this fifo from global buf pool
   * you don't have to use this function to allocate a buffer,
   * an input plugin can decide to implement it's own
   * buffer allocation functions
   */

  buf_element_t *(*buffer_pool_alloc) (fifo_buffer_t *self);


  /*
   * special functions, not used by demuxers
   */

  /* the same as buffer_pool_alloc but may fail if none is available */
  buf_element_t *(*buffer_pool_try_alloc) (fifo_buffer_t *self);

  /* the same as put but insert at the head of the fifo */
  void (*insert) (fifo_buffer_t *fifo, buf_element_t *buf);

  /* callbacks */
  void (*register_alloc_cb) (fifo_buffer_t *fifo, void (*cb)(fifo_buffer_t *fifo, void *), void *cb_data);
  void (*register_put_cb) (fifo_buffer_t *fifo, void (*cb)(fifo_buffer_t *fifo, buf_element_t *buf, void *), void *cb_data);
  void (*register_get_cb) (fifo_buffer_t *fifo, void (*cb)(fifo_buffer_t *fifo, buf_element_t *buf, void *), void *cb_data);
  void (*unregister_alloc_cb) (fifo_buffer_t *fifo, void (*cb)(fifo_buffer_t *fifo, void *));
  void (*unregister_put_cb) (fifo_buffer_t *fifo, void (*cb)(fifo_buffer_t *fifo, buf_element_t *buf, void *));
  void (*unregister_get_cb) (fifo_buffer_t *fifo, void (*cb)(fifo_buffer_t *fifo, buf_element_t *buf, void *));

  /*
   * private variables for buffer pool management
   */
  buf_element_t   *buffer_pool_top;    /* a heap actually */
  pthread_mutex_t  buffer_pool_mutex;
  pthread_cond_t   buffer_pool_cond_not_empty;
  int              buffer_pool_num_free;
  int              buffer_pool_capacity;
  int              buffer_pool_buf_size;
  void            *buffer_pool_base; /*used to free mem chunk */
  void           (*alloc_cb[BUF_MAX_CALLBACKS])(fifo_buffer_t *fifo, void *data_cb);
  void           (*put_cb[BUF_MAX_CALLBACKS])(fifo_buffer_t *fifo, buf_element_t *buf, void *data_cb);
  void           (*get_cb[BUF_MAX_CALLBACKS])(fifo_buffer_t *fifo, buf_element_t *buf, void *data_cb);
  void            *alloc_cb_data[BUF_MAX_CALLBACKS];
  void            *put_cb_data[BUF_MAX_CALLBACKS];
  void            *get_cb_data[BUF_MAX_CALLBACKS];

  /* get a buffer large enough for given byte size.
   * result may still be smaller, do check buf->max_size.
   */
  buf_element_t *(*buffer_pool_size_alloc) (fifo_buffer_t *self, size_t size);

  /* private */
  int              buffer_pool_num_waiters;
  int              buffer_pool_large_wait;
  int              fifo_num_waiters;
} ;

fifo_buffer_t *_x_fifo_buffer_new (int num_buffers, uint32_t buf_size) XINE_PROTECTED;

fifo_buffer_t *_x_dummy_fifo_buffer_new (int num_buffers, uint32_t buf_size);


uint32_t _x_fourcc_to_buf_video( uint32_t fourcc_int ) XINE_PROTECTED;

const char * _x_buf_video_name( uint32_t buf_type ) XINE_PROTECTED;

uint32_t _x_formattag_to_buf_audio( uint32_t formattag ) XINE_PROTECTED;

const char * _x_buf_audio_name( uint32_t buf_type ) XINE_PROTECTED;


typedef struct XINE_PACKED {
    int32_t        biSize;
    int32_t        biWidth;
    int32_t        biHeight;
    int16_t        biPlanes;
    int16_t        biBitCount;
    uint32_t       biCompression;
    int32_t        biSizeImage;
    int32_t        biXPelsPerMeter;
    int32_t        biYPelsPerMeter;
    int32_t        biClrUsed;
    int32_t        biClrImportant;
} xine_bmiheader;

typedef struct XINE_PACKED {
  int16_t   wFormatTag;
  int16_t   nChannels;
  int32_t   nSamplesPerSec;
  int32_t   nAvgBytesPerSec;
  int16_t   nBlockAlign;
  int16_t   wBitsPerSample;
  int16_t   cbSize;
} xine_waveformatex;

void _x_bmiheader_le2me( xine_bmiheader *bih ) XINE_PROTECTED;

void _x_waveformatex_le2me( xine_waveformatex *wavex ) XINE_PROTECTED;

static __inline int _x_is_fourcc(const void *ptr, const void *tag) {
  return memcmp(ptr, tag, 4) == 0;
}

#ifdef __cplusplus
}
#endif

#endif