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     // hacks for asf
 116     int *audio_id_ptr;
 117     int *video_id_ptr;
 118 } streaming_ctrl_t;
 119
 120 struct stream;
 121 typedef struct stream_info_st {
 122   const char *info;
 123   const char *name;
 124   const char *author;
 125   const char *comment;
 126   /// mode isn't used atm (ie always READ) but it shouldn't be ignored
 127   /// opts is at least in it's defaults settings and may have been
 128   /// altered by url parsing if enabled and the options string parsing.
 129   int (*open)(struct stream* st, int mode, void* opts, int* file_format);
 130   const char* protocols[MAX_STREAM_PROTOCOLS];
 131   const void* opts;
 132   int opts_url; /* If this is 1 we will parse the url as an option string
 133                  * too. Otherwise options are only parsed from the
 134                  * options string given to open_stream_plugin */
 135 } stream_info_t;
 136
 137 typedef struct stream {
 138   // Read
 139   int (*fill_buffer)(struct stream *s, char* buffer, int max_len);
 140   // Write
 141   int (*write_buffer)(struct stream *s, char* buffer, int len);
 142   // Seek
 143   int (*seek)(struct stream *s,off_t pos);
 144   // Control
 145   // Will be later used to let streams like dvd and cdda report
 146   // their structure (ie tracks, chapters, etc)
 147   int (*control)(struct stream *s,int cmd,void* arg);
 148   // Close
 149   void (*close)(struct stream *s);
 150
 151   int fd;   // file descriptor, see man open(2)
 152   int type; // see STREAMTYPE_*
 153   int flags;
 154   int sector_size; // sector size (seek will be aligned on this size if non 0)
 155   unsigned int buf_pos,buf_len;
 156   off_t pos,start_pos,end_pos;
 157   int eof;
 158   int mode; //STREAM_READ or STREAM_WRITE
 159   unsigned int cache_pid;
 160   void* cache_data;
 161   void* priv; // used for DVD, TV, RTSP etc
 162   char* url;  // strdup() of filename/url
 163   struct MPOpts *opts;
 164 #ifdef CONFIG_NETWORK
 165   streaming_ctrl_t *streaming_ctrl;
 166 #endif
 167   unsigned char buffer[STREAM_BUFFER_SIZE>VCD_SECTOR_SIZE?STREAM_BUFFER_SIZE:VCD_SECTOR_SIZE];
 168 } stream_t;
 169
 170 #ifdef CONFIG_NETWORK
 171 #include "network.h"
 172 #endif
 173
 174 int stream_fill_buffer(stream_t *s);
 175 int stream_seek_long(stream_t *s, off_t pos);
 176
 177 #ifdef CONFIG_STREAM_CACHE
 178 int stream_enable_cache(stream_t *stream,int size,int min,int prefill);
 179 int cache_stream_fill_buffer(stream_t *s);
 180 int cache_stream_seek_long(stream_t *s,off_t pos);
 181 #else
 182 // no cache, define wrappers:
 183 #define cache_stream_fill_buffer(x) stream_fill_buffer(x)
 184 #define cache_stream_seek_long(x,y) stream_seek_long(x,y)
 185 #define stream_enable_cache(x,y,z,w) 1
 186 #endif
 187 int stream_write_buffer(stream_t *s, unsigned char *buf, int len);
 188
 189 inline static int stream_read_char(stream_t *s){
 190   return (s->buf_pos<s->buf_len)?s->buffer[s->buf_pos++]:
 191     (cache_stream_fill_buffer(s)?s->buffer[s->buf_pos++]:-256);
 192 //  if(s->buf_pos<s->buf_len) return s->buffer[s->buf_pos++];
 193 //  stream_fill_buffer(s);
 194 //  if(s->buf_pos<s->buf_len) return s->buffer[s->buf_pos++];
 195 //  return 0; // EOF
 196 }
 197
 198 inline static unsigned int stream_read_word(stream_t *s){
 199   int x,y;
 200   x=stream_read_char(s);
 201   y=stream_read_char(s);
 202   return (x<<8)|y;
 203 }
 204
 205 inline static unsigned int stream_read_dword(stream_t *s){
 206   unsigned int y;
 207   y=stream_read_char(s);
 208   y=(y<<8)|stream_read_char(s);
 209   y=(y<<8)|stream_read_char(s);
 210   y=(y<<8)|stream_read_char(s);
 211   return y;
 212 }
 213
 214 #define stream_read_fourcc stream_read_dword_le
 215
 216 inline static unsigned int stream_read_word_le(stream_t *s){
 217   int x,y;
 218   x=stream_read_char(s);
 219   y=stream_read_char(s);
 220   return (y<<8)|x;
 221 }
 222
 223 inline static unsigned int stream_read_dword_le(stream_t *s){
 224   unsigned int y;
 225   y=stream_read_char(s);
 226   y|=stream_read_char(s)<<8;
 227   y|=stream_read_char(s)<<16;
 228   y|=stream_read_char(s)<<24;
 229   return y;
 230 }
 231
 232 inline static uint64_t stream_read_qword(stream_t *s){
 233   uint64_t y;
 234   y = 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   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   return y;
 243 }
 244
 245 inline static uint64_t stream_read_qword_le(stream_t *s){
 246   uint64_t y;
 247   y = stream_read_dword_le(s);
 248   y|=(uint64_t)stream_read_dword_le(s)<<32;
 249   return y;
 250 }
 251
 252 inline static unsigned int stream_read_int24(stream_t *s){
 253   unsigned int y;
 254   y = stream_read_char(s);
 255   y=(y<<8)|stream_read_char(s);
 256   y=(y<<8)|stream_read_char(s);
 257   return y;
 258 }
 259
 260 inline static int stream_read(stream_t *s,char* mem,int total){
 261   int len=total;
 262   while(len>0){
 263     int x;
 264     x=s->buf_len-s->buf_pos;
 265     if(x==0){
 266       if(!cache_stream_fill_buffer(s)) return total-len; // EOF
 267       x=s->buf_len-s->buf_pos;
 268     }
 269     if(s->buf_pos>s->buf_len) mp_msg(MSGT_DEMUX, MSGL_WARN, "stream_read: WARNING! s->buf_pos>s->buf_len\n");
 270     if(x>len) x=len;
 271     memcpy(mem,&s->buffer[s->buf_pos],x);
 272     s->buf_pos+=x; mem+=x; len-=x;
 273   }
 274   return total;
 275 }
 276
 277 unsigned char* stream_read_line(stream_t *s,unsigned char* mem, int max, int utf16);
 278
 279 inline static int stream_eof(stream_t *s){
 280   return s->eof;
 281 }
 282
 283 inline static off_t stream_tell(stream_t *s){
 284   return s->pos+s->buf_pos-s->buf_len;
 285 }
 286
 287 inline static int stream_seek(stream_t *s,off_t pos){
 288
 289   mp_dbg(MSGT_DEMUX, MSGL_DBG3, "seek to 0x%qX\n",(long long)pos);
 290
 291   if(s->eof)
 292     return 0;
 293   if(pos<s->pos){
 294     off_t x=pos-(s->pos-s->buf_len);
 295     if(x>=0){
 296       s->buf_pos=x;
 297       s->eof = 0;
 298 //      putchar('*');fflush(stdout);
 299       return 1;
 300     }
 301   }
 302
 303   return cache_stream_seek_long(s,pos);
 304 }
 305
 306 inline static int stream_skip(stream_t *s,off_t len){
 307   if( (len<0 && (s->flags & MP_STREAM_SEEK_BW)) || (len>2*STREAM_BUFFER_SIZE && (s->flags & MP_STREAM_SEEK_FW)) ) {
 308     // negative or big skip!
 309     return stream_seek(s,stream_tell(s)+len);
 310   }
 311   while(len>0){
 312     int x=s->buf_len-s->buf_pos;
 313     if(x==0){
 314       if(!cache_stream_fill_buffer(s)) return 0; // EOF
 315       x=s->buf_len-s->buf_pos;
 316     }
 317     if(x>len) x=len;
 318     //memcpy(mem,&s->buf[s->buf_pos],x);
 319     s->buf_pos+=x; len-=x;
 320   }
 321   return 1;
 322 }
 323
 324 struct MPOpts;
 325 void stream_reset(stream_t *s);
 326 int stream_control(stream_t *s, int cmd, void *arg);
 327 stream_t* new_stream(int fd,int type);
 328 void free_stream(stream_t *s);
 329 stream_t* new_memory_stream(unsigned char* data,int len);
 330 stream_t *open_stream(const char *filename, struct MPOpts *options,
 331                       int *file_format);
 332 stream_t *open_stream_full(const char *filename,int mode,
 333                            struct MPOpts *options, int *file_format);
 334 stream_t *open_output_stream(const char *filename, struct MPOpts *options);
 335 /// Set the callback to be used by libstream to check for user
 336 /// interruption during long blocking operations (cache filling, etc).
 337 struct input_ctx;
 338 void stream_set_interrupt_callback(int (*cb)(struct input_ctx*, int),
 339                                    struct input_ctx *ctx);
 340 /// Call the interrupt checking callback if there is one.
 341 int stream_check_interrupt(int time);
 342
 343 extern int dvd_title;
 344 extern int dvd_chapter;
 345 extern int dvd_last_chapter;
 346 extern int dvd_angle;
 347
 348 extern char * audio_stream;
 349
 350 typedef struct {
 351  int id; // 0 - 31 mpeg; 128 - 159 ac3; 160 - 191 pcm
 352  int language;
 353  int type;
 354  int channels;
 355 } stream_language_t;
 356
 357 #endif /* MPLAYER_STREAM_H */