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