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
  30 struct MPOpts;
  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 0x8000000  // 128 MiB
  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 #define SEEK_FORWARD  (1 << 2)
 118 #define SEEK_BACKWARD (1 << 3)
 119
 120 #define MP_INPUT_BUFFER_PADDING_SIZE 8
 121
 122 // Holds one packet/frame/whatever
 123 typedef struct demux_packet {
 124   int len;
 125   double pts;
 126   double endpts;
 127   double stream_pts;
 128   off_t pos;  // position in index (AVI) or file (MPG)
 129   unsigned char* buffer;
 130   int flags; // keyframe, etc
 131   int refcount;   //refcounter for the master packet, if 0, buffer can be free()d
 132   struct demux_packet *master; //pointer to the master packet if this one is a cloned one
 133   struct demux_packet *next;
 134 } demux_packet_t;
 135
 136 typedef struct demux_stream {
 137   int buffer_pos;          // current buffer position
 138   int buffer_size;         // current buffer size
 139   unsigned char* buffer;   // current buffer, never free() it, always use free_demux_packet(buffer_ref);
 140   double pts;              // current buffer's pts
 141   int pts_bytes;           // number of bytes read after last pts stamp
 142   int eof;                 // end of demuxed stream? (true if all buffer empty)
 143   off_t pos;                 // position in the input stream (file)
 144   off_t dpos;                // position in the demuxed stream
 145   int pack_no;             // serial number of packet
 146   int flags;               // flags of current packet (keyframe etc)
 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 *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 {
 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;
 177
 178 /**
 179  * Demuxer description structure
 180  */
 181 typedef struct demuxer_desc {
 182   const char *info; ///< What is it (long name and/or description)
 183   const char *name; ///< Demuxer name, used with -demuxer switch
 184   const char *shortdesc; ///< Description printed at demuxer detection
 185   const char *author; ///< Demuxer author(s)
 186   const char *comment; ///< Comment, printed with -demuxer help
 187
 188   int type; ///< DEMUXER_TYPE_xxx
 189   int safe_check; ///< If 1 detection is safe and fast, do it before file extension check
 190
 191   /// Check if can demux the file, return DEMUXER_TYPE_xxx on success
 192   int (*check_file)(struct demuxer *demuxer); ///< Mandatory if safe_check == 1, else optional
 193   /// Get packets from file, return 0 on eof
 194   int (*fill_buffer)(struct demuxer *demuxer, demux_stream_t *ds); ///< Mandatory
 195   /// Open the demuxer, return demuxer on success, NULL on failure
 196   struct demuxer* (*open)(struct demuxer *demuxer); ///< Optional
 197   /// Close the demuxer
 198   void (*close)(struct demuxer *demuxer); ///< Optional
 199   // Seek
 200   void (*seek)(struct demuxer *demuxer, float rel_seek_secs, float audio_delay, int flags); ///< Optional
 201   // Control
 202   int (*control)(struct demuxer *demuxer, int cmd, void *arg); ///< Optional
 203 } demuxer_desc_t;
 204
 205 typedef struct demux_chapter
 206 {
 207   uint64_t start, end;
 208   char* name;
 209 } demux_chapter_t;
 210
 211 struct matroska_data {
 212     unsigned char segment_uid[16];
 213     // Ordered chapter information if any
 214     struct matroska_chapter {
 215         uint64_t start;
 216         uint64_t end;
 217         bool has_segment_uid;
 218         unsigned char segment_uid[16];
 219         char *name;
 220     } *ordered_chapters;
 221     int num_ordered_chapters;
 222 };
 223
 224 typedef struct demux_attachment
 225 {
 226   char* name;
 227   char* type;
 228   void* data;
 229   unsigned int data_size;
 230 } demux_attachment_t;
 231
 232 typedef struct demuxer {
 233   const demuxer_desc_t *desc;  ///< Demuxer description structure
 234   off_t filepos; // input stream current pos.
 235   off_t movi_start;
 236   off_t movi_end;
 237   stream_t *stream;
 238   double stream_pts;       // current stream pts, if applicable (e.g. dvd)
 239   double reference_clock;
 240   char *filename; ///< Needed by avs_check_file
 241   int synced;  // stream synced (used by mpeg)
 242   int type;    // demuxer type: mpeg PS, mpeg ES, avi, avi-ni, avi-nini, asf
 243   int file_format;  // file format: mpeg/avi/asf
 244   int seekable;  // flag
 245     /* Set if using absolute seeks for small movements is OK (no pts resets
 246      * that would make pts ambigious, preferably supports back/forward flags */
 247     bool accurate_seek;
 248   //
 249   demux_stream_t *audio; // audio buffer/demuxer
 250   demux_stream_t *video; // video buffer/demuxer
 251   demux_stream_t *sub;   // dvd subtitle buffer/demuxer
 252
 253   // stream headers:
 254   struct sh_audio *a_streams[MAX_A_STREAMS];
 255   struct sh_video *v_streams[MAX_V_STREAMS];
 256   struct sh_sub   *s_streams[MAX_S_STREAMS];
 257
 258   demux_chapter_t* chapters;
 259   int num_chapters;
 260
 261   demux_attachment_t* attachments;
 262   int num_attachments;
 263
 264     struct matroska_data matroska_data;
 265
 266   void* priv;  // fileformat-dependent data
 267   char** info;
 268   struct MPOpts *opts;
 269 } demuxer_t;
 270
 271 typedef struct {
 272   int progid;        //program id
 273   int aid, vid, sid; //audio, video and subtitle id
 274 } demux_program_t;
 275
 276 static inline demux_packet_t* new_demux_packet(int len){
 277   demux_packet_t* dp=(demux_packet_t*)malloc(sizeof(demux_packet_t));
 278   dp->len=len;
 279   dp->next=NULL;
 280   dp->pts=MP_NOPTS_VALUE;
 281   dp->endpts=MP_NOPTS_VALUE;
 282   dp->stream_pts = MP_NOPTS_VALUE;
 283   dp->pos=0;
 284   dp->flags=0;
 285   dp->refcount=1;
 286   dp->master=NULL;
 287   dp->buffer=NULL;
 288   if (len > 0 && (dp->buffer = (unsigned char *)malloc(len + MP_INPUT_BUFFER_PADDING_SIZE)))
 289     memset(dp->buffer + len, 0, 8);
 290   else
 291     dp->len = 0;
 292   return dp;
 293 }
 294
 295 static inline void resize_demux_packet(demux_packet_t* dp, int len)
 296 {
 297   if(len > 0)
 298   {
 299      dp->buffer=(unsigned char *)realloc(dp->buffer,len+8);
 300   }
 301   else
 302   {
 303      if(dp->buffer) free(dp->buffer);
 304      dp->buffer=NULL;
 305   }
 306   dp->len=len;
 307   if (dp->buffer)
 308      memset(dp->buffer + len, 0, 8);
 309   else
 310      dp->len = 0;
 311 }
 312
 313 static inline demux_packet_t* clone_demux_packet(demux_packet_t* pack){
 314   demux_packet_t* dp=(demux_packet_t*)malloc(sizeof(demux_packet_t));
 315   while(pack->master) pack=pack->master; // find the master
 316   memcpy(dp,pack,sizeof(demux_packet_t));
 317   dp->next=NULL;
 318   dp->refcount=0;
 319   dp->master=pack;
 320   pack->refcount++;
 321   return dp;
 322 }
 323
 324 static inline void free_demux_packet(demux_packet_t* dp){
 325   if (dp->master==NULL){  //dp is a master packet
 326     dp->refcount--;
 327     if (dp->refcount==0){
 328       if (dp->buffer) free(dp->buffer);
 329       free(dp);
 330     }
 331     return;
 332   }
 333   // dp is a clone:
 334   free_demux_packet(dp->master);
 335   free(dp);
 336 }
 337
 338 #ifndef SIZE_MAX
 339 #define SIZE_MAX ((size_t)-1)
 340 #endif
 341
 342 static inline void *realloc_struct(void *ptr, size_t nmemb, size_t size) {
 343   if (nmemb > SIZE_MAX / size) {
 344     free(ptr);
 345     return NULL;
 346   }
 347   return realloc(ptr, nmemb * size);
 348 }
 349
 350 demux_stream_t* new_demuxer_stream(struct demuxer *demuxer,int id);
 351 demuxer_t* new_demuxer(struct MPOpts *opts, stream_t *stream,int type,int a_id,int v_id,int s_id,char *filename);
 352 void free_demuxer_stream(demux_stream_t *ds);
 353 void free_demuxer(demuxer_t *demuxer);
 354
 355 void ds_add_packet(demux_stream_t *ds,demux_packet_t* dp);
 356 void ds_read_packet(demux_stream_t *ds, stream_t *stream, int len, double pts, off_t pos, int flags);
 357
 358 int demux_fill_buffer(demuxer_t *demux,demux_stream_t *ds);
 359 int ds_fill_buffer(demux_stream_t *ds);
 360
 361 static inline off_t ds_tell(demux_stream_t *ds){
 362   return (ds->dpos-ds->buffer_size)+ds->buffer_pos;
 363 }
 364
 365 static inline int ds_tell_pts(demux_stream_t *ds){
 366   return (ds->pts_bytes-ds->buffer_size)+ds->buffer_pos;
 367 }
 368
 369 int demux_read_data(demux_stream_t *ds,unsigned char* mem,int len);
 370 int demux_pattern_3(demux_stream_t *ds, unsigned char *mem, int maxlen,
 371                     int *read, uint32_t pattern);
 372
 373 #define demux_peekc(ds) (\
 374      (likely(ds->buffer_pos<ds->buffer_size)) ? ds->buffer[ds->buffer_pos] \
 375      :((unlikely(!ds_fill_buffer(ds)))? (-1) : ds->buffer[ds->buffer_pos] ) )
 376 #if 1
 377 #define demux_getc(ds) (\
 378      (likely(ds->buffer_pos<ds->buffer_size)) ? ds->buffer[ds->buffer_pos++] \
 379      :((unlikely(!ds_fill_buffer(ds)))? (-1) : ds->buffer[ds->buffer_pos++] ) )
 380 #else
 381 static inline int demux_getc(demux_stream_t *ds){
 382   if(ds->buffer_pos>=ds->buffer_size){
 383     if(!ds_fill_buffer(ds)){
 384 //      printf("DEMUX_GETC: EOF reached!\n");
 385       return -1; // EOF
 386     }
 387   }
 388 //  printf("[%02X]",ds->buffer[ds->buffer_pos]);
 389   return ds->buffer[ds->buffer_pos++];
 390 }
 391 #endif
 392
 393 void ds_free_packs(demux_stream_t *ds);
 394 int ds_get_packet(demux_stream_t *ds,unsigned char **start);
 395 int ds_get_packet_pts(demux_stream_t *ds, unsigned char **start, double *pts);
 396 int ds_get_packet_sub(demux_stream_t *ds,unsigned char **start);
 397 double ds_get_next_pts(demux_stream_t *ds);
 398
 399 // This is defined here because demux_stream_t ins't defined in stream.h
 400 stream_t* new_ds_stream(demux_stream_t *ds);
 401
 402 static inline int avi_stream_id(unsigned int id){
 403   unsigned char *p=(unsigned char *)&id;
 404   unsigned char a,b;
 405 #if HAVE_BIGENDIAN
 406   a=p[3]-'0'; b=p[2]-'0';
 407 #else
 408   a=p[0]-'0'; b=p[1]-'0';
 409 #endif
 410   if(a>9 || b>9) return 100; // invalid ID
 411   return a*10+b;
 412 }
 413
 414 demuxer_t* demux_open(struct MPOpts *opts, stream_t *stream,int file_format,int aid,int vid,int sid,char* filename);
 415 void demux_flush(demuxer_t *demuxer);
 416 int demux_seek(demuxer_t *demuxer,float rel_seek_secs,float audio_delay,int flags);
 417 demuxer_t*  new_demuxers_demuxer(demuxer_t* vd, demuxer_t* ad, demuxer_t* sd);
 418
 419 // AVI demuxer params:
 420 extern int index_mode;  // -1=untouched  0=don't use index  1=use (geneate) index
 421 extern char *index_file_save, *index_file_load;
 422 extern int force_ni;
 423 extern int pts_from_bps;
 424
 425 extern int extension_parsing;
 426
 427 int demux_info_add(demuxer_t *demuxer, const char *opt, const char *param);
 428 char* demux_info_get(demuxer_t *demuxer, const char *opt);
 429 int demux_info_print(demuxer_t *demuxer);
 430 int demux_control(demuxer_t *demuxer, int cmd, void *arg);
 431
 432 #ifdef CONFIG_OGGVORBIS
 433 /* Found in demux_ogg.c */
 434 int demux_ogg_num_subs(demuxer_t *demuxer);
 435 int demux_ogg_sub_id(demuxer_t *demuxer, int index);
 436 #endif
 437
 438 int demuxer_get_current_time(demuxer_t *demuxer);
 439 double demuxer_get_time_length(demuxer_t *demuxer);
 440 int demuxer_get_percent_pos(demuxer_t *demuxer);
 441 int demuxer_switch_audio(demuxer_t *demuxer, int index);
 442 int demuxer_switch_video(demuxer_t *demuxer, int index);
 443
 444 int demuxer_type_by_filename(char* filename);
 445
 446 void demuxer_help(void);
 447 int get_demuxer_type_from_name(char *demuxer_name, int *force);
 448
 449 int demuxer_add_attachment(demuxer_t* demuxer, const char* name,
 450                            const char* type, const void* data, size_t size);
 451
 452 int demuxer_add_chapter(demuxer_t* demuxer, const char* name, uint64_t start, uint64_t end);
 453 int demuxer_seek_chapter(demuxer_t *demuxer, int chapter, double *seek_pts,
 454                          char **chapter_name);
 455
 456 /// Get current chapter index if available.
 457 int demuxer_get_current_chapter(demuxer_t *demuxer);
 458 /// Get chapter name by index if available.
 459 char *demuxer_chapter_name(demuxer_t *demuxer, int chapter);
 460 /// Get chapter display name by index.
 461 char *demuxer_chapter_display_name(demuxer_t *demuxer, int chapter);
 462 /// Get chapter start time and end time by index if available.
 463 float demuxer_chapter_time(demuxer_t *demuxer, int chapter, float *end);
 464 /// Get total chapter number.
 465 int demuxer_chapter_count(demuxer_t *demuxer);
 466 /// Get current angle index.
 467 int demuxer_get_current_angle(demuxer_t *demuxer);
 468 /// Set angle.
 469 int demuxer_set_angle(demuxer_t *demuxer, int angle);
 470 /// Get number of angles.
 471 int demuxer_angles_count(demuxer_t *demuxer);
 472
 473 // get the index of a track
 474 // lang is a comma-separated list
 475 int demuxer_audio_track_by_lang(demuxer_t* demuxer, char* lang);
 476 int demuxer_sub_track_by_lang(demuxer_t* demuxer, char* lang);
 477
 478 // find the default track
 479 // for subtitles, it is the first track with default attribute
 480 // for audio, additionally, the first track is selected if no track has default attribute set
 481 int demuxer_default_audio_track(demuxer_t* d);
 482 int demuxer_default_sub_track(demuxer_t* d);
 483
 484 #endif /* MPLAYER_DEMUXER_H */