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