include/libmkv.h

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