stream/stream.h

   1 /*
   2  * This file is part of MPlayer.
   3  *
   4  * MPlayer is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * MPlayer is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef MPLAYER_STREAM_H
  20 #define MPLAYER_STREAM_H
  21
  22 #include "config.h"
  23 #include "mp_msg.h"
  24 #include "url.h"
  25 #include <string.h>
  26 #include <inttypes.h>
  27 #include <sys/types.h>
  28 #include <fcntl.h>
  29
  30 #ifndef O_BINARY
  31 #define O_BINARY 0
  32 #endif
  33
  34 #define STREAMTYPE_DUMMY -1    // for placeholders, when the actual reading is handled in the demuxer
  35 #define STREAMTYPE_FILE 0      // read from seekable file
  36 #define STREAMTYPE_VCD  1      // raw mode-2 CDROM reading, 2324 bytes/sector
  37 #define STREAMTYPE_STREAM 2    // same as FILE but no seeking (for net/stdin)
  38 #define STREAMTYPE_DVD  3      // libdvdread
  39 #define STREAMTYPE_MEMORY  4   // read data from memory area
  40 #define STREAMTYPE_PLAYLIST 6  // FIXME!!! same as STREAMTYPE_FILE now
  41 #define STREAMTYPE_DS   8      // read from a demuxer stream
  42 #define STREAMTYPE_DVDNAV 9    // we cannot safely "seek" in this...
  43 #define STREAMTYPE_CDDA 10     // raw audio CD reader
  44 #define STREAMTYPE_SMB 11      // smb:// url, using libsmbclient (samba)
  45 #define STREAMTYPE_VCDBINCUE 12      // vcd directly from bin/cue files
  46 #define STREAMTYPE_DVB 13
  47 #define STREAMTYPE_VSTREAM 14
  48 #define STREAMTYPE_SDP 15
  49 #define STREAMTYPE_PVR 16
  50 #define STREAMTYPE_TV 17
  51 #define STREAMTYPE_MF 18
  52 #define STREAMTYPE_RADIO 19
  53
  54 #define STREAM_BUFFER_SIZE 2048
  55
  56 #define VCD_SECTOR_SIZE 2352
  57 #define VCD_SECTOR_OFFS 24
  58 #define VCD_SECTOR_DATA 2324
  59
  60 /// atm it will always use mode == STREAM_READ
  61 /// streams that use the new api should check the mode at open
  62 #define STREAM_READ  0
  63 #define STREAM_WRITE 1
  64 /// Seek flags, if not mannualy set and s->seek isn't NULL
  65 /// MP_STREAM_SEEK is automaticly set
  66 #define MP_STREAM_SEEK_BW  2
  67 #define MP_STREAM_SEEK_FW  4
  68 #define MP_STREAM_SEEK  (MP_STREAM_SEEK_BW|MP_STREAM_SEEK_FW)
  69 /** This is a HACK for live555 that does not respect the
  70     separation between stream an demuxer and thus is not
  71     actually a stream cache can not be used */
  72 #define STREAM_NON_CACHEABLE 8
  73
  74 //////////// Open return code
  75 #define STREAM_REDIRECTED -2
  76 /// This can't open the requested protocol (used by stream wich have a
  77 /// * protocol when they don't know the requested protocol)
  78 #define STREAM_UNSUPPORTED -1
  79 #define STREAM_ERROR 0
  80 #define STREAM_OK    1
  81
  82 #define MAX_STREAM_PROTOCOLS 10
  83
  84 #define STREAM_CTRL_RESET 0
  85 #define STREAM_CTRL_GET_TIME_LENGTH 1
  86 #define STREAM_CTRL_SEEK_TO_CHAPTER 2
  87 #define STREAM_CTRL_GET_CURRENT_CHAPTER 3
  88 #define STREAM_CTRL_GET_NUM_CHAPTERS 4
  89 #define STREAM_CTRL_GET_CURRENT_TIME 5
  90 #define STREAM_CTRL_SEEK_TO_TIME 6
  91 #define STREAM_CTRL_GET_SIZE 7
  92 #define STREAM_CTRL_GET_ASPECT_RATIO 8
  93 #define STREAM_CTRL_GET_NUM_ANGLES 9
  94 #define STREAM_CTRL_GET_ANGLE 10
  95 #define STREAM_CTRL_SET_ANGLE 11
  96
  97
  98 typedef enum {
  99         streaming_stopped_e,
 100         streaming_playing_e
 101 } streaming_status;
 102
 103 typedef struct streaming_control {
 104         URL_t *url;
 105         streaming_status status;
 106         int buffering;  // boolean
 107         unsigned int prebuffer_size;
 108         char *buffer;
 109         unsigned int buffer_size;
 110         unsigned int buffer_pos;
 111         unsigned int bandwidth; // The downstream available
 112         int (*streaming_read)( int fd, char *buffer, int buffer_size, struct streaming_control *stream_ctrl );
 113         int (*streaming_seek)( int fd, off_t pos, struct streaming_control *stream_ctrl );
 114         void *data;
 115 } streaming_ctrl_t;
 116
 117 struct stream;
 118 typedef struct stream_info_st {
 119   const char *info;
 120   const char *name;
 121   const char *author;
 122   const char *comment;
 123   /// mode isn't used atm (ie always READ) but it shouldn't be ignored
 124   /// opts is at least in it's defaults settings and may have been
 125   /// altered by url parsing if enabled and the options string parsing.
 126   int (*open)(struct stream* st, int mode, void* opts, int* file_format);
 127   const char* protocols[MAX_STREAM_PROTOCOLS];
 128   const void* opts;
 129   int opts_url; /* If this is 1 we will parse the url as an option string
 130                  * too. Otherwise options are only parsed from the
 131                  * options string given to open_stream_plugin */
 132 } stream_info_t;
 133
 134 typedef struct stream {
 135   // Read
 136   int (*fill_buffer)(struct stream *s, char* buffer, int max_len);
 137   // Write
 138   int (*write_buffer)(struct stream *s, char* buffer, int len);
 139   // Seek
 140   int (*seek)(struct stream *s,off_t pos);
 141   // Control
 142   // Will be later used to let streams like dvd and cdda report
 143   // their structure (ie tracks, chapters, etc)
 144   int (*control)(struct stream *s,int cmd,void* arg);
 145   // Close
 146   void (*close)(struct stream *s);
 147
 148   int fd;   // file descriptor, see man open(2)
 149   int type; // see STREAMTYPE_*
 150   int flags;
 151   int sector_size; // sector size (seek will be aligned on this size if non 0)
 152   unsigned int buf_pos,buf_len;
 153   off_t pos,start_pos,end_pos;
 154   int eof;
 155   int mode; //STREAM_READ or STREAM_WRITE
 156   unsigned int cache_pid;
 157   void* cache_data;
 158   void* priv; // used for DVD, TV, RTSP etc
 159   char* url;  // strdup() of filename/url
 160 #ifdef CONFIG_NETWORK
 161   streaming_ctrl_t *streaming_ctrl;
 162 #endif
 163   unsigned char buffer[STREAM_BUFFER_SIZE>VCD_SECTOR_SIZE?STREAM_BUFFER_SIZE:VCD_SECTOR_SIZE];
 164 } stream_t;
 165
 166 #ifdef CONFIG_NETWORK
 167 #include "network.h"
 168 #endif
 169
 170 int stream_fill_buffer(stream_t *s);
 171 int stream_seek_long(stream_t *s, off_t pos);
 172
 173 #ifdef CONFIG_STREAM_CACHE
 174 int stream_enable_cache(stream_t *stream,int size,int min,int prefill);
 175 int cache_stream_fill_buffer(stream_t *s);
 176 int cache_stream_seek_long(stream_t *s,off_t pos);
 177 #else
 178 // no cache, define wrappers:
 179 #define cache_stream_fill_buffer(x) stream_fill_buffer(x)
 180 #define cache_stream_seek_long(x,y) stream_seek_long(x,y)
 181 #define stream_enable_cache(x,y,z,w) 1
 182 #endif
 183 int stream_write_buffer(stream_t *s, unsigned char *buf, int len);
 184
 185 inline static int stream_read_char(stream_t *s){
 186   return (s->buf_pos<s->buf_len)?s->buffer[s->buf_pos++]:
 187     (cache_stream_fill_buffer(s)?s->buffer[s->buf_pos++]:-256);
 188 //  if(s->buf_pos<s->buf_len) return s->buffer[s->buf_pos++];
 189 //  stream_fill_buffer(s);
 190 //  if(s->buf_pos<s->buf_len) return s->buffer[s->buf_pos++];
 191 //  return 0; // EOF
 192 }
 193
 194 inline static unsigned int stream_read_word(stream_t *s){
 195   int x,y;
 196   x=stream_read_char(s);
 197   y=stream_read_char(s);
 198   return (x<<8)|y;
 199 }
 200
 201 inline static unsigned int stream_read_dword(stream_t *s){
 202   unsigned int y;
 203   y=stream_read_char(s);
 204   y=(y<<8)|stream_read_char(s);
 205   y=(y<<8)|stream_read_char(s);
 206   y=(y<<8)|stream_read_char(s);
 207   return y;
 208 }
 209
 210 #define stream_read_fourcc stream_read_dword_le
 211
 212 inline static unsigned int stream_read_word_le(stream_t *s){
 213   int x,y;
 214   x=stream_read_char(s);
 215   y=stream_read_char(s);
 216   return (y<<8)|x;
 217 }
 218
 219 inline static unsigned int stream_read_dword_le(stream_t *s){
 220   unsigned int y;
 221   y=stream_read_char(s);
 222   y|=stream_read_char(s)<<8;
 223   y|=stream_read_char(s)<<16;
 224   y|=stream_read_char(s)<<24;
 225   return y;
 226 }
 227
 228 inline static uint64_t stream_read_qword(stream_t *s){
 229   uint64_t y;
 230   y = stream_read_char(s);
 231   y=(y<<8)|stream_read_char(s);
 232   y=(y<<8)|stream_read_char(s);
 233   y=(y<<8)|stream_read_char(s);
 234   y=(y<<8)|stream_read_char(s);
 235   y=(y<<8)|stream_read_char(s);
 236   y=(y<<8)|stream_read_char(s);
 237   y=(y<<8)|stream_read_char(s);
 238   return y;
 239 }
 240
 241 inline static uint64_t stream_read_qword_le(stream_t *s){
 242   uint64_t y;
 243   y = stream_read_dword_le(s);
 244   y|=(uint64_t)stream_read_dword_le(s)<<32;
 245   return y;
 246 }
 247
 248 inline static unsigned int stream_read_int24(stream_t *s){
 249   unsigned int y;
 250   y = stream_read_char(s);
 251   y=(y<<8)|stream_read_char(s);
 252   y=(y<<8)|stream_read_char(s);
 253   return y;
 254 }
 255
 256 inline static int stream_read(stream_t *s,char* mem,int total){
 257   int len=total;
 258   while(len>0){
 259     int x;
 260     x=s->buf_len-s->buf_pos;
 261     if(x==0){
 262       if(!cache_stream_fill_buffer(s)) return total-len; // EOF
 263       x=s->buf_len-s->buf_pos;
 264     }
 265     if(s->buf_pos>s->buf_len) mp_msg(MSGT_DEMUX, MSGL_WARN, "stream_read: WARNING! s->buf_pos>s->buf_len\n");
 266     if(x>len) x=len;
 267     memcpy(mem,&s->buffer[s->buf_pos],x);
 268     s->buf_pos+=x; mem+=x; len-=x;
 269   }
 270   return total;
 271 }
 272
 273 unsigned char* stream_read_line(stream_t *s,unsigned char* mem, int max, int utf16);
 274
 275 inline static int stream_eof(stream_t *s){
 276   return s->eof;
 277 }
 278
 279 inline static off_t stream_tell(stream_t *s){
 280   return s->pos+s->buf_pos-s->buf_len;
 281 }
 282
 283 inline static int stream_seek(stream_t *s,off_t pos){
 284
 285   mp_dbg(MSGT_DEMUX, MSGL_DBG3, "seek to 0x%qX\n",(long long)pos);
 286
 287   if(s->eof)
 288     return 0;
 289   if(pos<s->pos){
 290     off_t x=pos-(s->pos-s->buf_len);
 291     if(x>=0){
 292       s->buf_pos=x;
 293 //      putchar('*');fflush(stdout);
 294       return 1;
 295     }
 296   }
 297
 298   return cache_stream_seek_long(s,pos);
 299 }
 300
 301 inline static int stream_skip(stream_t *s,off_t len){
 302   if( (len<0 && (s->flags & MP_STREAM_SEEK_BW)) || (len>2*STREAM_BUFFER_SIZE && (s->flags & MP_STREAM_SEEK_FW)) ) {
 303     // negative or big skip!
 304     return stream_seek(s,stream_tell(s)+len);
 305   }
 306   while(len>0){
 307     int x=s->buf_len-s->buf_pos;
 308     if(x==0){
 309       if(!cache_stream_fill_buffer(s)) return 0; // EOF
 310       x=s->buf_len-s->buf_pos;
 311     }
 312     if(x>len) x=len;
 313     //memcpy(mem,&s->buf[s->buf_pos],x);
 314     s->buf_pos+=x; len-=x;
 315   }
 316   return 1;
 317 }
 318
 319 void stream_reset(stream_t *s);
 320 int stream_control(stream_t *s, int cmd, void *arg);
 321 stream_t* new_stream(int fd,int type);
 322 void free_stream(stream_t *s);
 323 stream_t* new_memory_stream(unsigned char* data,int len);
 324 stream_t* open_stream(const char* filename,char** options,int* file_format);
 325 stream_t* open_stream_full(const char* filename,int mode, char** options, int* file_format);
 326 stream_t* open_output_stream(const char* filename,char** options);
 327 /// Set the callback to be used by libstream to check for user
 328 /// interruption during long blocking operations (cache filling, etc).
 329 void stream_set_interrupt_callback(int (*cb)(int));
 330 /// Call the interrupt checking callback if there is one.
 331 int stream_check_interrupt(int time);
 332
 333 extern int dvd_title;
 334 extern int dvd_chapter;
 335 extern int dvd_last_chapter;
 336 extern int dvd_angle;
 337
 338 extern char * audio_stream;
 339
 340 typedef struct {
 341  int id; // 0 - 31 mpeg; 128 - 159 ac3; 160 - 191 pcm
 342  int language;
 343  int type;
 344  int channels;
 345 } stream_language_t;
 346
 347 #endif /* MPLAYER_STREAM_H */