quicktime/qtprivate.h

   1 #ifndef PRIVATE_H
   2 #define PRIVATE_H
   3
   4 /* ================================= structures */
   5
   6 /* Version used internally.  You need to query it with the C functions */
   7 #define QUICKTIME_MAJOR 2
   8 #define QUICKTIME_MINOR 2
   9 #define QUICKTIME_RELEASE 0
  10
  11
  12 #define HEADER_LENGTH 8
  13 #define MAXTRACKS 1024
  14
  15 /* Crazy Mich R. Soft constants */
  16 #define AVI_HASINDEX       0x00000010  // Index at end of file?
  17 #define AVI_MUSTUSEINDEX   0x00000020
  18 #define AVI_ISINTERLEAVED  0x00000100
  19 #define AVI_TRUSTCKTYPE    0x00000800  // Use CKType to find key frames?
  20 #define AVI_WASCAPTUREFILE 0x00010000
  21 #define AVI_COPYRIGHTED    0x00020000
  22 #define AVIF_WASCAPTUREFILE     0x00010000
  23 #define AVI_KEYFRAME       0x10
  24 #define AVI_INDEX_OF_CHUNKS 0x01
  25 #define AVI_INDEX_OF_INDEXES 0x00
  26
  27 #define AVI_FRAME_RATE_BASE 10000
  28 #define MAX_RIFFS  0x100
  29
  30 #include <stdio.h>
  31 #include <stdint.h>
  32 #include <stdlib.h>
  33
  34
  35
  36
  37 #define FTELL ftello64
  38 #define FSEEK fseeko64
  39
  40
  41 // ffmpeg requires global variable initialization
  42 // These are defined in mpeg4.c
  43 extern int ffmpeg_initialized;
  44 extern pthread_mutex_t ffmpeg_lock;
  45
  46
  47
  48 // Utility functions for vbr audio.  This is accessed through quicktime_audio_map_t.
  49 typedef struct
  50 {
  51 // End of the output buffer in the file in samples
  52         int64_t buffer_end;
  53 // Number of samples in output buffer before end
  54         int buffer_size;
  55 // Position in output buffer of buffer_end
  56         int buffer_ptr;
  57 // Output buffer, linear for each channel.
  58         double **output_buffer;
  59 // Copy of channel count for deletion
  60         int channels;
  61 // Input buffer for temporary compressed data
  62         int input_size;
  63         int input_allocation;
  64         unsigned char *input_buffer;
  65 // Entry in sample size table of next frame of audio to read
  66         int sample_size_entry;
  67 // Next sample/frame to read
  68         int64_t sample;
  69 } quicktime_vbr_t;
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79 typedef struct
  80 {
  81 /* for AVI it's the end of the 8 byte header in the file */
  82 /* for Quicktime it's the start of the 8 byte header in the file */
  83         int64_t start;
  84         int64_t end;        /* byte endpoint in file */
  85         int64_t size;       /* byte size for writing */
  86         int use_64;         /* Use 64 bit header */
  87         unsigned char type[5];
  88 } quicktime_atom_t;
  89
  90 typedef struct
  91 {
  92         float values[9];
  93 } quicktime_matrix_t;
  94
  95
  96 typedef struct
  97 {
  98         int version;
  99         long flags;
 100         unsigned long creation_time;
 101         unsigned long modification_time;
 102         int track_id;
 103         long reserved1;
 104         long duration;
 105         char reserved2[8];
 106         int layer;
 107         int alternate_group;
 108         float volume;
 109         long reserved3;
 110         quicktime_matrix_t matrix;
 111         float track_width;
 112         float track_height;
 113 } quicktime_tkhd_t;
 114
 115
 116 typedef struct
 117 {
 118         long seed;
 119         long flags;
 120         long size;
 121         short int *alpha;
 122         short int *red;
 123         short int *green;
 124         short int *blue;
 125 } quicktime_ctab_t;
 126
 127
 128
 129 /* ===================== sample table ======================== // */
 130
 131
 132
 133 /* sample description */
 134
 135 typedef struct
 136 {
 137         int motion_jpeg_quantization_table;
 138 } quicktime_mjqt_t;
 139
 140
 141 typedef struct
 142 {
 143         int motion_jpeg_huffman_table;
 144 } quicktime_mjht_t;
 145
 146
 147 typedef struct
 148 {
 149         char *mpeg4_header;
 150         int mpeg4_header_size;
 151 } quicktime_esds_t;
 152
 153 typedef struct
 154 {
 155         char *data;
 156         int data_size;
 157 } quicktime_avcc_t;
 158
 159 typedef struct
 160 {
 161         char format[4];
 162         char reserved[6];
 163         int data_reference;
 164
 165 /* common to audio and video */
 166         int version;
 167         int revision;
 168         char vendor[4];
 169
 170 /* video description */
 171         long temporal_quality;
 172         long spatial_quality;
 173         int width;
 174         int height;
 175         float dpi_horizontal;
 176         float dpi_vertical;
 177         int64_t data_size;
 178         int frames_per_sample;
 179         char compressor_name[32];
 180         int depth;
 181         int ctab_id;
 182         quicktime_ctab_t ctab;
 183         float gamma;
 184 /* 0, 1, or 2 */
 185         int fields;
 186 /* 0 - unknown     1 - top first     2 - bottom first */
 187         int field_dominance;
 188         quicktime_mjqt_t mjqt;
 189         quicktime_mjht_t mjht;
 190
 191 /* audio description */
 192         int channels;
 193         int sample_size;
 194         int compression_id;
 195         int packet_size;
 196         float sample_rate;
 197
 198 /* Version 1 of audio description */
 199         int samples_per_packet;
 200         int bytes_per_packet;
 201         int bytes_per_frame;
 202         int bytes_per_sample;
 203
 204         quicktime_esds_t esds;
 205         quicktime_avcc_t avcc;
 206
 207         int extradata_size;
 208         char *extradata;
 209 } quicktime_stsd_table_t;
 210
 211
 212 typedef struct
 213 {
 214         int version;
 215         long flags;
 216         long total_entries;
 217         quicktime_stsd_table_t *table;
 218 } quicktime_stsd_t;
 219
 220
 221 /* time to sample */
 222 typedef struct
 223 {
 224         long sample_count;
 225         long sample_duration;
 226 } quicktime_stts_table_t;
 227
 228 typedef struct
 229 {
 230         int version;
 231         long flags;
 232         long total_entries;
 233         int is_vbr;
 234         quicktime_stts_table_t *table;
 235 } quicktime_stts_t;
 236
 237
 238 /* sync sample */
 239 typedef struct
 240 {
 241         int64_t sample;
 242 } quicktime_stss_table_t;
 243
 244 typedef struct
 245 {
 246         int version;
 247         long flags;
 248         long total_entries;
 249         long entries_allocated;
 250         quicktime_stss_table_t *table;
 251 } quicktime_stss_t;
 252
 253
 254 /* sample to chunk */
 255 typedef struct
 256 {
 257         long chunk;
 258         long samples;
 259         long id;
 260 } quicktime_stsc_table_t;
 261
 262 typedef struct
 263 {
 264         int version;
 265         long flags;
 266         long total_entries;
 267
 268         long entries_allocated;
 269         quicktime_stsc_table_t *table;
 270 } quicktime_stsc_t;
 271
 272
 273 /* sample size */
 274 typedef struct
 275 {
 276         int64_t size;
 277 } quicktime_stsz_table_t;
 278
 279 typedef struct
 280 {
 281         int version;
 282         long flags;
 283         int64_t sample_size;
 284         long total_entries;
 285
 286         long entries_allocated;    /* used by the library for allocating a table */
 287         quicktime_stsz_table_t *table;
 288 } quicktime_stsz_t;
 289
 290
 291 /* chunk offset */
 292 typedef struct
 293 {
 294         int64_t offset;
 295 } quicktime_stco_table_t;
 296
 297 typedef struct
 298 {
 299         int version;
 300         long flags;
 301         long total_entries;
 302
 303         long entries_allocated;    /* used by the library for allocating a table */
 304         quicktime_stco_table_t *table;
 305 } quicktime_stco_t;
 306
 307
 308 /* sample table */
 309 typedef struct
 310 {
 311         int version;
 312         long flags;
 313         quicktime_stsd_t stsd;
 314         quicktime_stts_t stts;
 315         quicktime_stss_t stss;
 316         quicktime_stsc_t stsc;
 317         quicktime_stsz_t stsz;
 318         quicktime_stco_t stco;
 319 } quicktime_stbl_t;
 320
 321 /* data reference */
 322
 323 typedef struct
 324 {
 325         int64_t size;
 326         char type[4];
 327         int version;
 328         long flags;
 329         char *data_reference;
 330 } quicktime_dref_table_t;
 331
 332 typedef struct
 333 {
 334         int version;
 335         long flags;
 336         long total_entries;
 337         quicktime_dref_table_t *table;
 338 } quicktime_dref_t;
 339
 340 /* data information */
 341
 342 typedef struct
 343 {
 344         quicktime_dref_t dref;
 345 } quicktime_dinf_t;
 346
 347 /* video media header */
 348
 349 typedef struct
 350 {
 351         int version;
 352         long flags;
 353         int graphics_mode;
 354         int opcolor[3];
 355 } quicktime_vmhd_t;
 356
 357
 358 /* sound media header */
 359
 360 typedef struct
 361 {
 362         int version;
 363         long flags;
 364         int balance;
 365         int reserved;
 366 } quicktime_smhd_t;
 367
 368 /* handler reference */
 369
 370 typedef struct
 371 {
 372         int version;
 373         long flags;
 374         char component_type[4];
 375         char component_subtype[4];
 376         long component_manufacturer;
 377         long component_flags;
 378         long component_flag_mask;
 379         char component_name[256];
 380 } quicktime_hdlr_t;
 381
 382 /* media information */
 383
 384 typedef struct
 385 {
 386         int is_video;
 387         int is_audio;
 388         quicktime_vmhd_t vmhd;
 389         quicktime_smhd_t smhd;
 390         quicktime_stbl_t stbl;
 391         quicktime_hdlr_t hdlr;
 392         quicktime_dinf_t dinf;
 393 } quicktime_minf_t;
 394
 395
 396 /* media header */
 397
 398 typedef struct
 399 {
 400         int version;
 401         long flags;
 402         unsigned long creation_time;
 403         unsigned long modification_time;
 404         long time_scale;
 405         long duration;
 406         int language;
 407         int quality;
 408 } quicktime_mdhd_t;
 409
 410
 411 /* media */
 412
 413 typedef struct
 414 {
 415         quicktime_mdhd_t mdhd;
 416         quicktime_minf_t minf;
 417         quicktime_hdlr_t hdlr;
 418 } quicktime_mdia_t;
 419
 420 /* edit list */
 421 typedef struct
 422 {
 423         long duration;
 424         long time;
 425         float rate;
 426 } quicktime_elst_table_t;
 427
 428 typedef struct
 429 {
 430         int version;
 431         long flags;
 432         long total_entries;
 433
 434         quicktime_elst_table_t *table;
 435 } quicktime_elst_t;
 436
 437 typedef struct
 438 {
 439         quicktime_elst_t elst;
 440 } quicktime_edts_t;
 441
 442
 443
 444
 445 typedef struct
 446 {
 447         quicktime_tkhd_t tkhd;
 448         quicktime_mdia_t mdia;
 449         quicktime_edts_t edts;
 450 } quicktime_trak_t;
 451
 452
 453 typedef struct
 454 {
 455         int version;
 456         long flags;
 457         unsigned long creation_time;
 458         unsigned long modification_time;
 459         long time_scale;
 460         long duration;
 461         float preferred_rate;
 462         float preferred_volume;
 463         char reserved[10];
 464         quicktime_matrix_t matrix;
 465         long preview_time;
 466         long preview_duration;
 467         long poster_time;
 468         long selection_time;
 469         long selection_duration;
 470         long current_time;
 471         long next_track_id;
 472 } quicktime_mvhd_t;
 473
 474 typedef struct
 475 {
 476         char *copyright;
 477         int copyright_len;
 478         char *name;
 479         int name_len;
 480         char *info;
 481         int info_len;
 482         char *require;
 483         int require_len;
 484         char *encoder;
 485         int encoder_len;
 486 } quicktime_udta_t;
 487
 488
 489 typedef struct
 490 {
 491         int total_tracks;
 492
 493         quicktime_mvhd_t mvhd;
 494         quicktime_trak_t *trak[MAXTRACKS];
 495         quicktime_udta_t udta;
 496         quicktime_ctab_t ctab;
 497 } quicktime_moov_t;
 498
 499 typedef struct
 500 {
 501         quicktime_atom_t atom;
 502 } quicktime_mdat_t;
 503
 504 typedef struct
 505 {
 506 /* Offset of end of 8 byte chunk header relative to ix->base_offset */
 507         int relative_offset;
 508 /* size of data without 8 byte header */
 509         int size;
 510 } quicktime_ixtable_t;
 511
 512 typedef struct
 513 {
 514         quicktime_atom_t atom;
 515         quicktime_ixtable_t *table;
 516         int table_size;
 517         int table_allocation;
 518         int longs_per_entry;
 519         int index_type;
 520 /* ixtable relative_offset is relative to this */
 521         int64_t base_offset;
 522 /* ix atom title */
 523         char tag[5];
 524 /* corresponding chunk id */
 525         char chunk_id[5];
 526 } quicktime_ix_t;
 527
 528
 529 typedef struct
 530 {
 531         quicktime_atom_t atom;
 532
 533 /* Partial index */
 534 /* For writing only, there are multiple movi objects with multiple ix tables. */
 535 /* This is not used for reading.  Instead an ix_t object in indx_t is used. */
 536         quicktime_ix_t *ix[MAXTRACKS];
 537 } quicktime_movi_t;
 538
 539 typedef struct
 540 {
 541 /* Start of start of corresponding ix## header */
 542         int64_t index_offset;
 543 /* Size not including 8 byte header */
 544         int index_size;
 545 /* duration in "ticks" */
 546         int duration;
 547
 548 /* Partial index for reading only. */
 549         quicktime_ix_t *ix;
 550 } quicktime_indxtable_t;
 551
 552 typedef struct
 553 {
 554         quicktime_atom_t atom;
 555         int longs_per_entry;
 556         int index_subtype;
 557         int index_type;
 558 /* corresponding chunk id: 00wb, 00dc */
 559         char chunk_id[5];
 560
 561 /* Number of partial indexes here */
 562         int table_size;
 563         int table_allocation;
 564         quicktime_indxtable_t *table;
 565 } quicktime_indx_t;
 566
 567 typedef struct
 568 {
 569         quicktime_atom_t atom;
 570 /* Super index for reading */
 571         quicktime_indx_t indx;
 572 /* AVI needs header placeholders before anything else is written */
 573         int64_t length_offset;
 574         int64_t samples_per_chunk_offset;
 575         int64_t sample_size_offset;
 576 /* Start of indx header for later writing */
 577         int64_t indx_offset;
 578 /* Size of JUNK without 8 byte header which is to be replaced by indx */
 579         int64_t padding_size;
 580 /* Tag for writer with NULL termination: 00wb, 00dc   Not available in reader.*/
 581         char tag[5];
 582 /* Flags for reader.  Not available in writer. */
 583         int is_audio;
 584         int is_video;
 585 /* Notify reader the super indexes are valid */
 586         int have_indx;
 587 } quicktime_strl_t;
 588
 589 typedef struct
 590 {
 591         quicktime_atom_t atom;
 592         int64_t frames_offset;
 593         int64_t bitrate_offset;
 594 /* Offsets to be written during file closure */
 595         int64_t total_frames_offset;
 596
 597 /* AVI equivalent for each trak.  Use file->moov.total_tracks */
 598 /* Need it for super indexes during reading. */
 599         quicktime_strl_t *strl[MAXTRACKS];
 600 } quicktime_hdrl_t;
 601
 602 typedef struct
 603 {
 604         char tag[5];
 605         uint32_t flags;
 606 /* Start of 8 byte chunk header relative to start of the 'movi' string */
 607         int32_t offset;
 608 /* Size of chunk less the 8 byte header */
 609         int32_t size;
 610 } quicktime_idx1table_t;
 611
 612 typedef struct
 613 {
 614         quicktime_atom_t atom;
 615         quicktime_idx1table_t *table;
 616         int table_size;
 617         int table_allocation;
 618 } quicktime_idx1_t;
 619
 620 typedef struct
 621 {
 622         quicktime_atom_t atom;
 623         quicktime_movi_t movi;
 624         quicktime_hdrl_t hdrl;
 625
 626 /* Full index */
 627         quicktime_idx1_t idx1;
 628 /* Notify reader the idx1 table is valid */
 629         int have_idx1;
 630         int have_hdrl;
 631 } quicktime_riff_t;
 632
 633 typedef struct
 634 {
 635         unsigned char *y, *u, *v;
 636         int y_size;
 637         int u_size;
 638         int v_size;
 639         int64_t frame_number;
 640 } quicktime_cacheframe_t;
 641
 642 typedef struct
 643 {
 644         quicktime_cacheframe_t *frames;
 645         int total;
 646         int allocation;
 647 } quicktime_cache_t;
 648
 649 /* table of pointers to every track */
 650 typedef struct
 651 {
 652         quicktime_trak_t *track; /* real quicktime track corresponding to this table */
 653         int channels;            /* number of audio channels in the track */
 654         int64_t current_position;   /* current sample in output file */
 655         int64_t current_chunk;      /* current chunk in output file */
 656         quicktime_vbr_t vbr;     /* Stores for vbr codecs */
 657
 658         void *codec;
 659 } quicktime_audio_map_t;
 660
 661 typedef struct
 662 {
 663         quicktime_trak_t *track;
 664         int64_t current_position;   /* current frame in output file */
 665         int64_t current_chunk;      /* current chunk in output file */
 666 // Cache for the current GOP after a seek.
 667         quicktime_cache_t *frame_cache;
 668
 669         void *codec;
 670 } quicktime_video_map_t;
 671
 672 /* file descriptor passed to all routines */
 673 typedef struct
 674 {
 675         FILE *stream;
 676         int64_t total_length;
 677         quicktime_mdat_t mdat;
 678         quicktime_moov_t moov;
 679         int rd;
 680         int wr;
 681
 682 /* If the moov atom is compressed */
 683         int compressed_moov;
 684         unsigned char *moov_data;
 685 /*
 686  * Temporary storage of compressed sizes.  If the file length is shorter than the
 687  * uncompressed sizes, it won't work.
 688  */
 689         int64_t moov_end;
 690         int64_t moov_size;
 691         int64_t old_preload_size;
 692         char *old_preload_buffer;
 693         int64_t old_preload_start;
 694         int64_t old_preload_end;
 695         int64_t old_preload_ptr;
 696
 697
 698 /* ASF section */
 699         int use_asf;
 700
 701
 702
 703
 704 /* AVI section */
 705         int use_avi;
 706 /* AVI tree */
 707         quicktime_riff_t *riff[MAX_RIFFS];
 708         int total_riffs;
 709 /* is odml version of AVI */
 710         int is_odml;
 711
 712
 713
 714
 715
 716 /* for begining and ending frame writes where the user wants to write the  */
 717 /* file descriptor directly */
 718         int64_t offset;
 719
 720 /* I/O */
 721 /* Current position of virtual file descriptor */
 722         int64_t file_position;
 723
 724 /* Work around a bug in glibc where ftello returns only 32 bits by maintaining */
 725 /* our own position */
 726         int64_t ftell_position;
 727
 728 /* Read ahead buffer */
 729         int64_t preload_size;      /* Enables preload when nonzero. */
 730         char *preload_buffer;
 731         int64_t preload_start;     /* Start of preload_buffer in file */
 732         int64_t preload_end;       /* End of preload buffer in file */
 733         int64_t preload_ptr;       /* Offset of preload_start in preload_buffer */
 734
 735 /* Write ahead buffer */
 736 /* Amount of data in presave buffer */
 737         int64_t presave_size;
 738 /* Next presave byte's position in file */
 739         int64_t presave_position;
 740         char *presave_buffer;
 741 /* Presave doesn't matter a whole lot, so its size is fixed */
 742 #define QUICKTIME_PRESAVE 0x100000
 743         int use_presave;
 744
 745 /* mapping of audio channels to movie tracks */
 746 /* one audio map entry exists for each channel */
 747         int total_atracks;
 748         quicktime_audio_map_t *atracks;
 749
 750 /* mapping of video tracks to movie tracks */
 751         int total_vtracks;
 752         quicktime_video_map_t *vtracks;
 753
 754 /* Number of processors at our disposal */
 755         int cpus;
 756
 757 /* Parameters for frame currently being decoded */
 758         int do_scaling;
 759         int in_x, in_y, in_w, in_h, out_w, out_h;
 760         int color_model, row_span;
 761
 762 /* Adjustable timecode frame number */
 763         int64_t current_frame;
 764
 765 } quicktime_t;
 766
 767
 768 /* Structure created in track_map to describe the codec */
 769 typedef struct
 770 {
 771         int (*delete_vcodec)(quicktime_video_map_t *vtrack);
 772         int (*delete_acodec)(quicktime_audio_map_t *atrack);
 773 /* Decode a single frame */
 774         int (*decode_video)(quicktime_t *file,
 775                                 unsigned char **row_pointers,
 776                                 int track);
 777 /* Encode a single frame */
 778         int (*encode_video)(quicktime_t *file,
 779                                 unsigned char **row_pointers,
 780                                 int track);
 781 /* Decode a certain number of samples */
 782         int (*decode_audio)(quicktime_t *file,
 783                                 int16_t *output_i,
 784                                 float *output_f,
 785                                 long samples,
 786                                 int track,
 787                                 int channel);
 788 /* Encode a chunk of audio */
 789         int (*encode_audio)(quicktime_t *file,
 790                                 int16_t **input_i,
 791                                 float **input_f,
 792                                 int track,
 793                                 long samples);
 794         int (*reads_colormodel)(quicktime_t *file,
 795                 int colormodel,
 796                 int track);
 797         int (*writes_colormodel)(quicktime_t *file,
 798                 int colormodel,
 799                 int track);
 800
 801         int (*set_parameter)(quicktime_t *file,
 802                 int track,
 803                 char *key,
 804                 void *value);
 805         void (*flush)(quicktime_t *file,
 806                 int track);
 807
 808 /* AVI codec ID for audio.  AVI codec ID's are based on WAV files, by the way. */
 809         int wav_id;
 810
 811 /* Pointer to static character code for identifying the codec. */
 812         char *fourcc;
 813
 814 /* English title of codec.  Optional. */
 815         char *title;
 816
 817 /* English description of codec.  Optional. */
 818         char *desc;
 819
 820 /* Frame cache for seeking only. */
 821
 822
 823 /* Proprietary data for the codec to allocate and delete. */
 824         void *priv;
 825 } quicktime_codec_t;
 826
 827
 828
 829 /* Structure tabulated in plugin.c to search the codecs */
 830 typedef struct
 831 {
 832         void (*init_vcodec)(quicktime_video_map_t *);
 833         void (*init_acodec)(quicktime_audio_map_t *);
 834 } quicktime_codectable_t;
 835
 836
 837
 838
 839 #endif