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