include/libmkv.h

   1 /*****************************************************************************
   2  * libmkv.h:
   3  *****************************************************************************
   4  * Copyright (C) 2005 x264 project
   5  *
   6  * Authors: Mike Matsnev
   7  *          Nathan Caldwell
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23 #ifndef _LIBMKV_H
  24 #define _LIBMKV_H 1
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif                                                  /* __cplusplus */
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33
  34 #ifdef HAVE_STDINT_H
  35 #include <stdint.h>
  36 #else
  37 #include <inttypes.h>
  38 #endif
  39
  40 /* Video codecs */
  41 #define MK_VCODEC_RAW      "V_UNCOMPRESSED"
  42 #define MK_VCODEC_MPEG1    "V_MPEG1"
  43 #define MK_VCODEC_MPEG2    "V_MPEG2"
  44 #define MK_VCODEC_THEORA   "V_THEORA"
  45 #define MK_VCODEC_SNOW     "V_SNOW"
  46 #define MK_VCODEC_MP4SP    "V_MPEG4/ISO/SP"
  47 #define MK_VCODEC_MP4ASP   "V_MPEG4/ISO/ASP"
  48 #define MK_VCODEC_MP4AP    "V_MPEG4/ISO/AP"
  49 #define MK_VCODEC_MP4AVC   "V_MPEG4/ISO/AVC"
  50 #define MK_VCODEC_MSVCM    "V_MS/VFW/FOURCC"
  51 #define MK_VCODEC_MSMP4V3  "V_MPEG4/MS/V3"
  52 #define MK_VCODEC_REAL     "V_REAL"
  53 #define MK_VCODEC_REAL10   MK_VCODEC_REAL "/RV10"
  54 #define MK_VCODEC_REAL20   MK_VCODEC_REAL "/RV20"
  55 #define MK_VCODEC_REAL30   MK_VCODEC_REAL "/RV30"
  56 #define MK_VCODEC_REAL40   MK_VCODEC_REAL "/RV40"
  57 #define MK_VCODEC_QUICKTIME "V_QUICKTIME"
  58
  59 /* Audio codecs */
  60 #define MK_ACODEC_AC3      "A_AC3"
  61 #define MK_ACODEC_AC3BSID9 "A_AC3/BSID9"
  62 #define MK_ACODEC_AC3BSID10 "A_AC3/BSID10"
  63 #define MK_ACODEC_MP3      "A_MPEG/L3"
  64 #define MK_ACODEC_MP2      "A_MPEG/L2"
  65 #define MK_ACODEC_MP1      "A_MPEG/L1"
  66 #define MK_ACODEC_DTS      "A_DTS"
  67 #define MK_ACODEC_PCMINTLE "A_PCM/INT/LIT"
  68 #define MK_ACODEC_PCMINTBE "A_PCM/INT/BIG"
  69 #define MK_ACODEC_PCMFLTLE "A_PCM/FLOAT/IEEE"
  70 #define MK_ACODEC_TTA1     "A_TTA1"
  71 #define MK_ACODEC_WAVPACK  "A_WAVPACK4"
  72 #define MK_ACODEC_VORBIS   "A_VORBIS"
  73 #define MK_ACODEC_FLAC     "A_FLAC"
  74 #define MK_ACODEC_AAC      "A_AAC"
  75 #define MK_ACODEC_MPC      "A_MPC"
  76 #define MK_ACODEC_REAL1    "A_REAL/14_4"
  77 #define MK_ACODEC_REAL2    "A_REAL/28_8"
  78 #define MK_ACODEC_REALCOOK "A_REAL/COOK"
  79 #define MK_ACODEC_REALSIPR "A_REAL/SIPR"
  80 #define MK_ACODEC_REALRALF "A_REAL/RALF"
  81 #define MK_ACODEC_REALATRC "A_REAL/ATRC"
  82 #define MK_ACODEC_MSACM    "A_MS/ACM"
  83 #define MK_ACODEC_QUICKTIME "A_QUICKTIME"
  84 #define MK_ACODEC_QDMC     MK_ACODEC_QUICKTIME "/QDMC"
  85 #define MK_ACODEC_QDM2     MK_ACODEC_QUICKTIME "/QDM2"
  86 #define MK_ACODEC_TTA1     "A_TTA1"
  87 #define MK_ACODEC_WAVPACK4 "A_WAVEPACK4"
  88
  89 /* Subtitles */
  90 #define MK_SUBTITLE_ASCII  "S_TEXT/ASCII"
  91 #define MK_SUBTITLE_UTF8   "S_TEXT/UTF8"
  92 #define MK_SUBTITLE_SSA    "S_TEXT/SSA"
  93 #define MK_SUBTITLE_ASS    "S_TEXT/ASS"
  94 #define MK_SUBTITLE_USF    "S_TEXT/USF"
  95 #define MK_SUBTITLE_VOBSUB "S_VOBSUB"
  96 #define MK_SUBTITLE_BMP    "S_IMAGE/BMP"
  97
  98 typedef enum {
  99         MK_TRACK_VIDEO = 0x01,
 100         MK_TRACK_AUDIO = 0x02,
 101         MK_TRACK_COMPLEX = 0x03,
 102         MK_TRACK_LOGO = 0x10,
 103         MK_TRACK_SUBTITLE = 0x11,
 104         MK_TRACK_BUTTONS = 0x12,
 105         MK_TRACK_CONTROL = 0x20
 106 } mk_TrackType;
 107
 108 typedef enum {
 109         MK_LACING_NONE = 0x00,
 110         MK_LACING_XIPH,
 111         MK_LACING_FIXED,
 112         MK_LACING_EBML
 113 } mk_LacingType;
 114
 115 typedef enum {
 116         MK_ASPECTRATIO_FREE = 0x00,
 117         MK_ASPECTRATIO_KEEP,
 118         MK_ASPECTRATIO_FIXED
 119 } mk_AspectType;
 120
 121 typedef struct mk_Writer_s mk_Writer;
 122 typedef struct mk_Track_s mk_Track;
 123 typedef struct mk_TrackConfig_s mk_TrackConfig;
 124
 125 struct mk_TrackConfig_s {
 126         uint64_t trackUID;                      /* Optional: Unique identifier for the track. */
 127         mk_TrackType trackType;         /* Required: 1 = Video, 2 = Audio. */
 128         int8_t flagEnabled;                     /* Required: Set 1 if the track is used,
 129                                                                  *                       0 if unused. (Default: enabled)
 130                                                                  */
 131         int8_t flagDefault;                     /* Required: Set 1 if this track is default,
 132                                                                  *                       0 if not default, -1 is undefined.
 133                                                                  */
 134         int8_t flagForced;                      /* Optional: Set 1 if the track MUST be shown during playback
 135                                                                  *                       (Default: disabled)
 136                                                                  */
 137         int8_t flagLacing;                      /* Required: Set 1 if the track may contain blocks using lacing. */
 138         uint8_t minCache;                       /* Optional: See Matroska spec. (Default: cache disabled) */
 139         uint8_t maxCache;
 140         int64_t defaultDuration;        /* Optional: Number of nanoseconds per frame. */
 141         char *name;
 142         char *language;
 143         char *codecID;                          /* Required: See codecs above. */
 144         void *codecPrivate;
 145         unsigned codecPrivateSize;
 146         char *codecName;
 147         union {
 148                 struct {
 149                         char flagInterlaced;
 150                         unsigned pixelWidth;    /* Pixel width */
 151                         unsigned pixelHeight;   /* Pixel height */
 152                         unsigned pixelCrop[4];  /* Pixel crop - 0 = bottom, 1 = top, 2 = left, 3 = right */
 153                         unsigned displayWidth;  /* Display width */
 154                         unsigned displayHeight; /* Display height */
 155                         char displayUnit;               /* Display Units - 0 = pixels, 1 = cm, 2 = in */
 156                         mk_AspectType aspectRatioType;  /* Specifies the allowed
 157                                                                                          * modifications to the aspect ratio
 158                                                                                          */
 159                 } video;
 160                 struct {
 161                         float samplingFreq;     /* Sampling Frequency in Hz */
 162                         unsigned channels;      /* Number of channels for this track */
 163                         unsigned bitDepth;      /* Bits per sample (PCM) */
 164                 } audio;
 165         } extra;
 166 };
 167
 168 /* vlc_compat writes the Seek entries at the top of the file because VLC
 169  * stops parsing once it finds the first cluster. However, this creates
 170  * extra overhead in the file.
 171  */
 172 mk_Writer *mk_createWriter(const char *filename, int64_t timescale,
 173                                                    uint8_t vlc_compat);
 174 mk_Track *mk_createTrack(mk_Writer *w, mk_TrackConfig *tc);
 175 int mk_writeHeader(mk_Writer *w, const char *writingApp);
 176 int mk_startFrame(mk_Writer *w, mk_Track *track);
 177 int mk_addFrameData(mk_Writer * w, mk_Track *track, const void *data,
 178                                         unsigned size);
 179 int mk_setFrameFlags(mk_Writer * w, mk_Track *track, int64_t timestamp,
 180                                          unsigned keyframe);
 181 int mk_setFrameLacing(mk_Writer *w, mk_Track * track,
 182                                           mk_LacingType lacing, uint8_t num_frames,
 183                                           uint64_t sizes[]);
 184 int mk_createChapterSimple(mk_Writer *w, uint64_t start, uint64_t end,
 185                                                    char *name);
 186 int mk_close(mk_Writer *w);
 187
 188 char *mk_laceXiph(uint64_t *sizes, uint8_t num_frames,
 189                                   uint64_t *output_size);
 190
 191 #ifdef __cplusplus
 192 }
 193 #endif                                                  /* __cplusplus */
 194
 195 #endif                                                  /* _LIBMKV_H */