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