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 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30
  31 #ifdef HAVE_STDINT_H
  32 #include <stdint.h>
  33 #else
  34 #include <inttypes.h>
  35 #endif
  36
  37 /* Video codecs */
  38 #define MK_VCODEC_MPEG1    "V_MPEG1"
  39 #define MK_VCODEC_MPEG2    "V_MPEG2"
  40 #define MK_VCODEC_THEORA   "V_THEORA"
  41 #define MK_VCODEC_SNOW     "V_SNOW"
  42 #define MK_VCODEC_MP4ASP   "V_MPEG4/ISO/ASP"
  43 #define MK_VCODEC_MP4AVC   "V_MPEG4/ISO/AVC"
  44
  45 /* Audio codecs */
  46 #define MK_ACODEC_AC3      "A_AC3"
  47 #define MK_ACODEC_MP3      "A_MPEG/L3"
  48 #define MK_ACODEC_MP2      "A_MPEG/L2"
  49 #define MK_ACODEC_MP1      "A_MPEG/L1"
  50 #define MK_ACODEC_DTS      "A_DTS"
  51 #define MK_ACODEC_PCMINTLE "A_PCM/INT/LIT"
  52 #define MK_ACODEC_PCMFLTLE "A_PCM/FLOAT/IEEE"
  53 #define MK_ACODEC_TTA1     "A_TTA1"
  54 #define MK_ACODEC_WAVPACK  "A_WAVPACK4"
  55 #define MK_ACODEC_VORBIS   "A_VORBIS"
  56 #define MK_ACODEC_FLAC     "A_FLAC"
  57 #define MK_ACODEC_AAC      "A_AAC"
  58
  59 /* Subtitles */
  60 #define MK_SUBTITLE_ASCII  "S_TEXT/ASCII"
  61 #define MK_SUBTITLE_UTF8   "S_TEXT/UTF8"
  62 #define MK_SUBTITLE_SSA    "S_TEXT/SSA"
  63 #define MK_SUBTITLE_ASS    "S_TEXT/ASS"
  64 #define MK_SUBTITLE_USF    "S_TEXT/USF"
  65 #define MK_SUBTITLE_VOBSUB "S_VOBSUB"
  66
  67 #define MK_TRACK_VIDEO     0x01
  68 #define MK_TRACK_AUDIO     0x02
  69 #define MK_TRACK_COMPLEX   0x03
  70 #define MK_TRACK_LOGO      0x10
  71 #define MK_TRACK_SUBTITLE  0x11
  72 #define MK_TRACK_BUTTONS   0x12
  73 #define MK_TRACK_CONTROL   0x20
  74
  75 typedef enum mk_LacingTypesEnum {
  76     MK_LACING_NONE = 0x00,
  77     MK_LACING_XIPH,
  78     MK_LACING_FIXED,
  79     MK_LACING_EBML
  80 } mk_LacingTypes;
  81
  82 #ifdef __cplusplus
  83 extern "C" {
  84 #endif
  85
  86 typedef struct mk_Writer_s mk_Writer;
  87 typedef struct mk_Track_s mk_Track;
  88 typedef struct mk_TrackConfig_s mk_TrackConfig;
  89
  90 struct mk_TrackConfig_s {
  91   uint64_t    trackUID;            // Optional: Unique identifier for the track.
  92   uint8_t     trackType;           // Required: 1 = Video, 2 = Audio.
  93   int8_t      flagEnabled;         // Required: Set 1 if the track is used, 0 if unused. (Default: enabled)
  94   int8_t      flagDefault;         // Required: Set 1 if this track is default, 0 if not default, -1 is undefined.
  95   int8_t      flagForced;          // Optional: Set 1 if the track MUST be shown during playback (Default: disabled)
  96   int8_t      flagLacing;          // Required: Set 1 if the track may contain blocks using lacing.
  97   uint8_t     minCache;            // Optional: See Matroska spec. (Default: cache disabled)
  98   uint8_t     maxCache;
  99   int64_t     defaultDuration;     // Optional: Number of nanoseconds per frame.
 100   char        *name;
 101   char        *language;
 102   char        *codecID;            // Required: See codecs above.
 103   void        *codecPrivate;
 104   unsigned    codecPrivateSize;
 105   char        *codecName;
 106   union {
 107     struct {
 108       char      flagInterlaced;
 109       unsigned  pixelWidth;            // Pixel width
 110       unsigned  pixelHeight;           // Pixel height
 111       unsigned  pixelCrop[4];          // Pixel crop - 0 = bottom, 1 = top, 2 = left, 3 = right
 112       unsigned  displayWidth;          // Display width
 113       unsigned  displayHeight;         // Display height
 114       char      displayUnit;           // Display Units - 0 = pixels, 1 = cm, 2 = in
 115     } video;
 116     struct {
 117       float   samplingFreq;            // Sampling Frequency in Hz
 118       unsigned    channels;            // Number of channels for this track
 119       unsigned    bitDepth;            // Bits per sample (PCM)
 120     } audio;
 121   } extra;
 122 };
 123
 124 mk_Writer *mk_createWriter(const char *filename, int64_t timescale, uint8_t vlc_compat);
 125     /* vlc_compat writes the Seek entries at the top of the file because VLC stops parsing  *
 126      * once it finds the first cluster. However, this creates extra overhead in the file.   */
 127 mk_Track *mk_createTrack(mk_Writer *w, mk_TrackConfig *tc);
 128 int  mk_writeHeader(mk_Writer *w, const char *writingApp);
 129 int  mk_startFrame( mk_Writer *w, mk_Track *track );
 130 int  mk_addFrameData(mk_Writer *w, mk_Track *track, const void *data, unsigned size);
 131 int  mk_setFrameFlags(mk_Writer *w, mk_Track *track, int64_t timestamp, unsigned keyframe);
 132 int  mk_setFrameLacing(mk_Writer *w, mk_Track *track, mk_LacingTypes lacing, uint8_t num_frames, uint64_t sizes[]);
 133 int  mk_createChapterSimple(mk_Writer *w, uint64_t start, uint64_t end, char *name);
 134 int  mk_close( mk_Writer *w );
 135
 136 char  *mk_laceXiph(uint64_t *sizes, uint8_t num_frames, uint64_t *output_size);
 137
 138 #ifdef __cplusplus
 139 }
 140 #endif
 141
 142 #endif