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