libmpdemux/demuxer.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_DEMUXER_H
  20 #define MPLAYER_DEMUXER_H
  21
  22 #include <sys/types.h>
  23 #include <stdint.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "stream/stream.h"
  28 #ifdef CONFIG_ASS
  29 #include "libass/ass_mp.h"
  30 #endif
  31
  32 #ifdef HAVE_BUILTIN_EXPECT
  33 #define likely(x) __builtin_expect ((x) != 0, 1)
  34 #define unlikely(x) __builtin_expect ((x) != 0, 0)
  35 #else
  36 #define likely(x) (x)
  37 #define unlikely(x) (x)
  38 #endif
  39
  40 #define MAX_PACKS 4096
  41 #define MAX_PACK_BYTES 0x2000000
  42
  43 #define DEMUXER_TYPE_UNKNOWN 0
  44 #define DEMUXER_TYPE_MPEG_ES 1
  45 #define DEMUXER_TYPE_MPEG_PS 2
  46 #define DEMUXER_TYPE_AVI 3
  47 #define DEMUXER_TYPE_AVI_NI 4
  48 #define DEMUXER_TYPE_AVI_NINI 5
  49 #define DEMUXER_TYPE_ASF 6
  50 #define DEMUXER_TYPE_MOV 7
  51 #define DEMUXER_TYPE_VIVO 8
  52 #define DEMUXER_TYPE_TV 9
  53 #define DEMUXER_TYPE_FLI 10
  54 #define DEMUXER_TYPE_REAL 11
  55 #define DEMUXER_TYPE_Y4M 12
  56 #define DEMUXER_TYPE_FILM 14
  57 #define DEMUXER_TYPE_ROQ 15
  58 #define DEMUXER_TYPE_MF 16
  59 #define DEMUXER_TYPE_AUDIO 17
  60 #define DEMUXER_TYPE_OGG 18
  61 #define DEMUXER_TYPE_RAWAUDIO 20
  62 #define DEMUXER_TYPE_RTP 21
  63 #define DEMUXER_TYPE_RAWDV 22
  64 #define DEMUXER_TYPE_PVA 23
  65 #define DEMUXER_TYPE_SMJPEG 24
  66 #define DEMUXER_TYPE_XMMS 25
  67 #define DEMUXER_TYPE_RAWVIDEO 26
  68 #define DEMUXER_TYPE_MPEG4_ES 27
  69 #define DEMUXER_TYPE_GIF 28
  70 #define DEMUXER_TYPE_MPEG_TS 29
  71 #define DEMUXER_TYPE_H264_ES 30
  72 #define DEMUXER_TYPE_MATROSKA 31
  73 #define DEMUXER_TYPE_REALAUDIO 32
  74 #define DEMUXER_TYPE_MPEG_TY 33
  75 #define DEMUXER_TYPE_LMLM4 34
  76 #define DEMUXER_TYPE_LAVF 35
  77 #define DEMUXER_TYPE_NSV 36
  78 #define DEMUXER_TYPE_VQF 37
  79 #define DEMUXER_TYPE_AVS 38
  80 #define DEMUXER_TYPE_AAC 39
  81 #define DEMUXER_TYPE_MPC 40
  82 #define DEMUXER_TYPE_MPEG_PES 41
  83 #define DEMUXER_TYPE_MPEG_GXF 42
  84 #define DEMUXER_TYPE_NUT 43
  85 #define DEMUXER_TYPE_LAVF_PREFERRED 44
  86 #define DEMUXER_TYPE_RTP_NEMESI 45
  87 #define DEMUXER_TYPE_MNG 46
  88
  89 // This should always match the higest demuxer type number.
  90 // Unless you want to disallow users to force the demuxer to some types
  91 #define DEMUXER_TYPE_MIN 0
  92 #define DEMUXER_TYPE_MAX 46
  93
  94 #define DEMUXER_TYPE_DEMUXERS (1<<16)
  95 // A virtual demuxer type for the network code
  96 #define DEMUXER_TYPE_PLAYLIST (2<<16)
  97
  98
  99 #define MP_NOPTS_VALUE (-1LL<<63) //both int64_t and double should be able to represent this exactly
 100
 101
 102 // DEMUXER control commands/answers
 103 #define DEMUXER_CTRL_NOTIMPL -1
 104 #define DEMUXER_CTRL_DONTKNOW 0
 105 #define DEMUXER_CTRL_OK 1
 106 #define DEMUXER_CTRL_GUESS 2
 107 #define DEMUXER_CTRL_GET_TIME_LENGTH 10
 108 #define DEMUXER_CTRL_GET_PERCENT_POS 11
 109 #define DEMUXER_CTRL_SWITCH_AUDIO 12
 110 #define DEMUXER_CTRL_RESYNC 13
 111 #define DEMUXER_CTRL_SWITCH_VIDEO 14
 112 #define DEMUXER_CTRL_IDENTIFY_PROGRAM 15
 113 #define DEMUXER_CTRL_CORRECT_PTS 16
 114
 115 #define SEEK_ABSOLUTE (1 << 0)
 116 #define SEEK_FACTOR   (1 << 1)
 117
 118 #define MP_INPUT_BUFFER_PADDING_SIZE 8
 119
 120 // Holds one packet/frame/whatever
 121 typedef struct demux_packet_st {
 122   int len;
 123   double pts;
 124   double endpts;
 125   double stream_pts;
 126   off_t pos;  // position in index (AVI) or file (MPG)
 127   unsigned char* buffer;
 128   int flags; // keyframe, etc
 129   int refcount;   //refcounter for the master packet, if 0, buffer can be free()d
 130   struct demux_packet_st* master; //pointer to the master packet if this one is a cloned one
 131   struct demux_packet_st* next;
 132 } demux_packet_t;
 133
 134 typedef struct {
 135   int buffer_pos;          // current buffer position
 136   int buffer_size;         // current buffer size
 137   unsigned char* buffer;   // current buffer, never free() it, always use free_demux_packet(buffer_ref);
 138   double pts;              // current buffer's pts
 139   int pts_bytes;           // number of bytes read after last pts stamp
 140   int eof;                 // end of demuxed stream? (true if all buffer empty)
 141   off_t pos;                 // position in the input stream (file)
 142   off_t dpos;                // position in the demuxed stream
 143   int pack_no;             // serial number of packet
 144   int flags;               // flags of current packet (keyframe etc)
 145   int non_interleaved;     // 1 if this stream is not properly interleaved,
 146                            // so e.g. subtitle handling must do explicit reads.
 147 //---------------
 148   int packs;              // number of packets in buffer
 149   int bytes;              // total bytes of packets in buffer
 150   demux_packet_t *first;  // read to current buffer from here
 151   demux_packet_t *last;   // append new packets from input stream to here
 152   demux_packet_t *current;// needed for refcounting of the buffer
 153   int id;                 // stream ID  (for multiple audio/video streams)
 154   struct demuxer_st *demuxer; // parent demuxer structure (stream handler)
 155 // ---- asf -----
 156   demux_packet_t *asf_packet;  // read asf fragments here
 157   int asf_seq;
 158 // ---- mov -----
 159   unsigned int ss_mul,ss_div;
 160 // ---- stream header ----
 161   void* sh;
 162 } demux_stream_t;
 163
 164 typedef struct demuxer_info_st {
 165   char *name;
 166   char *author;
 167   char *encoder;
 168   char *comments;
 169   char *copyright;
 170 } demuxer_info_t;
 171
 172 #define MAX_A_STREAMS 256
 173 #define MAX_V_STREAMS 256
 174 #define MAX_S_STREAMS 256
 175
 176 struct demuxer_st;
 177
 178 extern int correct_pts;
 179 extern int user_correct_pts;
 180
 181 /**
 182  * Demuxer description structure
 183  */
 184 typedef struct demuxers_desc_st {
 185   const char *info; ///< What is it (long name and/or description)
 186   const char *name; ///< Demuxer name, used with -demuxer switch
 187   const char *shortdesc; ///< Description printed at demuxer detection
 188   const char *author; ///< Demuxer author(s)
 189   const char *comment; ///< Comment, printed with -demuxer help
 190
 191   int type; ///< DEMUXER_TYPE_xxx
 192   int safe_check; ///< If 1 detection is safe and fast, do it before file extension check
 193
 194   /// Check if can demux the file, return DEMUXER_TYPE_xxx on success
 195   int (*check_file)(struct demuxer_st *demuxer); ///< Mandatory if safe_check == 1, else optional
 196   /// Get packets from file, return 0 on eof
 197   int (*fill_buffer)(struct demuxer_st *demuxer, demux_stream_t *ds); ///< Mandatory
 198   /// Open the demuxer, return demuxer on success, NULL on failure
 199   struct demuxer_st* (*open)(struct demuxer_st *demuxer); ///< Optional
 200   /// Close the demuxer
 201   void (*close)(struct demuxer_st *demuxer); ///< Optional
 202   // Seek
 203   void (*seek)(struct demuxer_st *demuxer, float rel_seek_secs, float audio_delay, int flags); ///< Optional
 204   // Control
 205   int (*control)(struct demuxer_st *demuxer, int cmd, void *arg); ///< Optional
 206 } demuxer_desc_t;
 207
 208 typedef struct demux_chapter_s
 209 {
 210   uint64_t start, end;
 211   char* name;
 212 } demux_chapter_t;
 213
 214 typedef struct demux_attachment_s
 215 {
 216   char* name;
 217   char* type;
 218   void* data;
 219   unsigned int data_size;
 220 } demux_attachment_t;
 221
 222 typedef struct demuxer_st {
 223   const demuxer_desc_t *desc;  ///< Demuxer description structure
 224   off_t filepos; // input stream current pos.
 225   off_t movi_start;
 226   off_t movi_end;
 227   stream_t *stream;
 228   double stream_pts;       // current stream pts, if applicable (e.g. dvd)
 229   double reference_clock;
 230   char *filename; ///< Needed by avs_check_file
 231   int synced;  // stream synced (used by mpeg)
 232   int type;    // demuxer type: mpeg PS, mpeg ES, avi, avi-ni, avi-nini, asf
 233   int file_format;  // file format: mpeg/avi/asf
 234   int seekable;  // flag
 235   //
 236   demux_stream_t *audio; // audio buffer/demuxer
 237   demux_stream_t *video; // video buffer/demuxer
 238   demux_stream_t *sub;   // dvd subtitle buffer/demuxer
 239
 240   // stream headers:
 241   void* a_streams[MAX_A_STREAMS]; // audio streams (sh_audio_t)
 242   void* v_streams[MAX_V_STREAMS]; // video sterams (sh_video_t)
 243   void *s_streams[MAX_S_STREAMS];   // dvd subtitles (flag)
 244
 245   // pointer to teletext decoder private data, if demuxer stream contains teletext
 246   void *teletext;
 247
 248   demux_chapter_t* chapters;
 249   int num_chapters;
 250
 251   demux_attachment_t* attachments;
 252   int num_attachments;
 253
 254   void* priv;  // fileformat-dependent data
 255   char** info;
 256 } demuxer_t;
 257
 258 typedef struct {
 259   int progid;        //program id
 260   int aid, vid, sid; //audio, video and subtitle id
 261 } demux_program_t;
 262
 263 static inline demux_packet_t* new_demux_packet(int len){
 264   demux_packet_t* dp=(demux_packet_t*)malloc(sizeof(demux_packet_t));
 265   dp->len=len;
 266   dp->next=NULL;
 267   dp->pts=MP_NOPTS_VALUE;
 268   dp->endpts=MP_NOPTS_VALUE;
 269   dp->stream_pts = MP_NOPTS_VALUE;
 270   dp->pos=0;
 271   dp->flags=0;
 272   dp->refcount=1;
 273   dp->master=NULL;
 274   dp->buffer=NULL;
 275   if (len > 0 && (dp->buffer = (unsigned char *)malloc(len + MP_INPUT_BUFFER_PADDING_SIZE)))
 276     memset(dp->buffer + len, 0, 8);
 277   else
 278     dp->len = 0;
 279   return dp;
 280 }
 281
 282 static inline void resize_demux_packet(demux_packet_t* dp, int len)
 283 {
 284   if(len > 0)
 285   {
 286      dp->buffer=(unsigned char *)realloc(dp->buffer,len+8);
 287   }
 288   else
 289   {
 290      if(dp->buffer) free(dp->buffer);
 291      dp->buffer=NULL;
 292   }
 293   dp->len=len;
 294   if (dp->buffer)
 295      memset(dp->buffer + len, 0, 8);
 296   else
 297      dp->len = 0;
 298 }
 299
 300 static inline demux_packet_t* clone_demux_packet(demux_packet_t* pack){
 301   demux_packet_t* dp=(demux_packet_t*)malloc(sizeof(demux_packet_t));
 302   while(pack->master) pack=pack->master; // find the master
 303   memcpy(dp,pack,sizeof(demux_packet_t));
 304   dp->next=NULL;
 305   dp->refcount=0;
 306   dp->master=pack;
 307   pack->refcount++;
 308   return dp;
 309 }
 310
 311 static inline void free_demux_packet(demux_packet_t* dp){
 312   if (dp->master==NULL){  //dp is a master packet
 313     dp->refcount--;
 314     if (dp->refcount==0){
 315       if (dp->buffer) free(dp->buffer);
 316       free(dp);
 317     }
 318     return;
 319   }
 320   // dp is a clone:
 321   free_demux_packet(dp->master);
 322   free(dp);
 323 }
 324
 325 #ifndef SIZE_MAX
 326 #define SIZE_MAX ((size_t)-1)
 327 #endif
 328
 329 static inline void *realloc_struct(void *ptr, size_t nmemb, size_t size) {
 330   if (nmemb > SIZE_MAX / size) {
 331     free(ptr);
 332     return NULL;
 333   }
 334   return realloc(ptr, nmemb * size);
 335 }
 336
 337 demux_stream_t* new_demuxer_stream(struct demuxer_st *demuxer,int id);
 338 demuxer_t* new_demuxer(stream_t *stream,int type,int a_id,int v_id,int s_id,char *filename);
 339 void free_demuxer_stream(demux_stream_t *ds);
 340 void free_demuxer(demuxer_t *demuxer);
 341
 342 void ds_add_packet(demux_stream_t *ds,demux_packet_t* dp);
 343 void ds_read_packet(demux_stream_t *ds, stream_t *stream, int len, double pts, off_t pos, int flags);
 344
 345 int demux_fill_buffer(demuxer_t *demux,demux_stream_t *ds);
 346 int ds_fill_buffer(demux_stream_t *ds);
 347
 348 static inline off_t ds_tell(demux_stream_t *ds){
 349   return (ds->dpos-ds->buffer_size)+ds->buffer_pos;
 350 }
 351
 352 static inline int ds_tell_pts(demux_stream_t *ds){
 353   return (ds->pts_bytes-ds->buffer_size)+ds->buffer_pos;
 354 }
 355
 356 int demux_read_data(demux_stream_t *ds,unsigned char* mem,int len);
 357 int demux_pattern_3(demux_stream_t *ds, unsigned char *mem, int maxlen,
 358                     int *read, uint32_t pattern);
 359
 360 #define demux_peekc(ds) (\
 361      (likely(ds->buffer_pos<ds->buffer_size)) ? ds->buffer[ds->buffer_pos] \
 362      :((unlikely(!ds_fill_buffer(ds)))? (-1) : ds->buffer[ds->buffer_pos] ) )
 363 #if 1
 364 #define demux_getc(ds) (\
 365      (likely(ds->buffer_pos<ds->buffer_size)) ? ds->buffer[ds->buffer_pos++] \
 366      :((unlikely(!ds_fill_buffer(ds)))? (-1) : ds->buffer[ds->buffer_pos++] ) )
 367 #else
 368 static inline int demux_getc(demux_stream_t *ds){
 369   if(ds->buffer_pos>=ds->buffer_size){
 370     if(!ds_fill_buffer(ds)){
 371 //      printf("DEMUX_GETC: EOF reached!\n");
 372       return -1; // EOF
 373     }
 374   }
 375 //  printf("[%02X]",ds->buffer[ds->buffer_pos]);
 376   return ds->buffer[ds->buffer_pos++];
 377 }
 378 #endif
 379
 380 void ds_free_packs(demux_stream_t *ds);
 381 int ds_get_packet(demux_stream_t *ds,unsigned char **start);
 382 int ds_get_packet_pts(demux_stream_t *ds, unsigned char **start, double *pts);
 383 int ds_get_packet_sub(demux_stream_t *ds,unsigned char **start);
 384 double ds_get_next_pts(demux_stream_t *ds);
 385
 386 // This is defined here because demux_stream_t ins't defined in stream.h
 387 stream_t* new_ds_stream(demux_stream_t *ds);
 388
 389 static inline int avi_stream_id(unsigned int id){
 390   unsigned char *p=(unsigned char *)&id;
 391   unsigned char a,b;
 392 #if HAVE_BIGENDIAN
 393   a=p[3]-'0'; b=p[2]-'0';
 394 #else
 395   a=p[0]-'0'; b=p[1]-'0';
 396 #endif
 397   if(a>9 || b>9) return 100; // invalid ID
 398   return a*10+b;
 399 }
 400
 401 demuxer_t* demux_open(stream_t *stream,int file_format,int aid,int vid,int sid,char* filename);
 402 void demux_flush(demuxer_t *demuxer);
 403 int demux_seek(demuxer_t *demuxer,float rel_seek_secs,float audio_delay,int flags);
 404 demuxer_t*  new_demuxers_demuxer(demuxer_t* vd, demuxer_t* ad, demuxer_t* sd);
 405
 406 // AVI demuxer params:
 407 extern int index_mode;  // -1=untouched  0=don't use index  1=use (geneate) index
 408 extern char *index_file_save, *index_file_load;
 409 extern int force_ni;
 410 extern int pts_from_bps;
 411
 412 extern int extension_parsing;
 413
 414 int demux_info_add(demuxer_t *demuxer, const char *opt, const char *param);
 415 char* demux_info_get(demuxer_t *demuxer, const char *opt);
 416 int demux_info_print(demuxer_t *demuxer);
 417 int demux_control(demuxer_t *demuxer, int cmd, void *arg);
 418
 419 #ifdef CONFIG_OGGVORBIS
 420 /* Found in demux_ogg.c */
 421 int demux_ogg_num_subs(demuxer_t *demuxer);
 422 int demux_ogg_sub_id(demuxer_t *demuxer, int index);
 423 #endif
 424
 425 int demuxer_get_current_time(demuxer_t *demuxer);
 426 double demuxer_get_time_length(demuxer_t *demuxer);
 427 int demuxer_get_percent_pos(demuxer_t *demuxer);
 428 int demuxer_switch_audio(demuxer_t *demuxer, int index);
 429 int demuxer_switch_video(demuxer_t *demuxer, int index);
 430
 431 int demuxer_type_by_filename(char* filename);
 432
 433 void demuxer_help(void);
 434 int get_demuxer_type_from_name(char *demuxer_name, int *force);
 435
 436 int demuxer_add_attachment(demuxer_t* demuxer, const char* name,
 437                            const char* type, const void* data, size_t size);
 438
 439 int demuxer_add_chapter(demuxer_t* demuxer, const char* name, uint64_t start, uint64_t end);
 440 int demuxer_seek_chapter(demuxer_t *demuxer, int chapter, int mode, float *seek_pts, int *num_chapters, char **chapter_name);
 441
 442 /// Get current chapter index if available.
 443 int demuxer_get_current_chapter(demuxer_t *demuxer);
 444 /// Get chapter name by index if available.
 445 char *demuxer_chapter_name(demuxer_t *demuxer, int chapter);
 446 /// Get chapter display name by index.
 447 char *demuxer_chapter_display_name(demuxer_t *demuxer, int chapter);
 448 /// Get chapter start time and end time by index if available.
 449 float demuxer_chapter_time(demuxer_t *demuxer, int chapter, float *end);
 450 /// Get total chapter number.
 451 int demuxer_chapter_count(demuxer_t *demuxer);
 452 /// Get current angle index.
 453 int demuxer_get_current_angle(demuxer_t *demuxer);
 454 /// Set angle.
 455 int demuxer_set_angle(demuxer_t *demuxer, int angle);
 456 /// Get number of angles.
 457 int demuxer_angles_count(demuxer_t *demuxer);
 458
 459 // get the index of a track
 460 // lang is a comma-separated list
 461 int demuxer_audio_track_by_lang(demuxer_t* demuxer, char* lang);
 462 int demuxer_sub_track_by_lang(demuxer_t* demuxer, char* lang);
 463
 464 // find the default track
 465 // for subtitles, it is the first track with default attribute
 466 // for audio, additionally, the first track is selected if no track has default attribute set
 467 int demuxer_default_audio_track(demuxer_t* d);
 468 int demuxer_default_sub_track(demuxer_t* d);
 469
 470 #endif /* MPLAYER_DEMUXER_H */