AVI_avi.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
 
#pragma once
 
#include "BLI_sys_types.h"
#include <stdio.h> /* for FILE */
 
typedef struct _AviChunk {
  int fcc;
  int size;
} AviChunk;
 
typedef struct _AviList {
  int fcc;
  int size;
  int ids;
} AviList;
 
typedef struct _AviMainHeader {
  int fcc;
  int size;
  int MicroSecPerFrame; /* MicroSecPerFrame - timing between frames */
  int MaxBytesPerSec;   /* MaxBytesPerSec - approx bps system must handle */
  int PaddingGranularity;
  int Flags;
 
#define AVIF_HASINDEX 0x00000010
#define AVIF_MUSTUSEINDEX 0x00000020
#define AVIF_ISINTERLEAVED 0x00000100
#define AVIF_TRUSTCKTYPE 0x00000800
#define AVIF_WASCAPTUREFILE 0x00010000
#define AVIF_COPYRIGHTED 0x00020000
 
  int TotalFrames;
  int InitialFrames; /* InitialFrames - initial frame before interleaving */
  int Streams;
  int SuggestedBufferSize;
  int Width;
  int Height;
  int Reserved[4];
} AviMainHeader;
 
typedef struct _AviStreamHeader {
  int fcc;
  int size;
  int Type;
#define AVIST_VIDEO FCC("vids")
#define AVIST_AUDIO FCC("auds")
#define AVIST_MIDI FCC("mids")
#define AVIST_TEXT FCC("txts")
 
  int Handler;
  int Flags;
#define AVISF_DISABLED 0x00000001
#define AVISF_VIDEO_PALCHANGES 0x00010000
 
  short Priority;
  short Language;
  int InitialFrames;
  int Scale;
  int Rate;
  int Start;
  int Length;
  int SuggestedBufferSize;
  int Quality;
  int SampleSize;
  short left;
  short top;
  short right;
  short bottom;
} AviStreamHeader;
 
typedef struct _AviBitmapInfoHeader {
  int fcc;
  int size;
  int Size;
  int Width;
  int Height;
  short Planes;
  short BitCount;
  int Compression;
  int SizeImage;
  int XPelsPerMeter;
  int YPelsPerMeter;
  int ClrUsed;
  int ClrImportant;
} AviBitmapInfoHeader;
 
typedef struct _AviMJPEGUnknown {
  int a;
  int b;
  int c;
  int d;
  int e;
  int f;
  int g;
} AviMJPEGUnknown;
 
typedef struct _AviIndexEntry {
  int ChunkId;
  int Flags;
#define AVIIF_LIST 0x00000001
#define AVIIF_KEYFRAME 0x00000010
#define AVIIF_NO_TIME 0x00000100
#define AVIIF_COMPRESSOR 0x0FFF0000
  int Offset;
  int Size;
} AviIndexEntry;
 
typedef struct _AviIndex {
  int fcc;
  int size;
  AviIndexEntry *entrys;
} AviIndex;
 
typedef enum {
  AVI_FORMAT_RGB24,
  AVI_FORMAT_RGB32,
  AVI_FORMAT_AVI_RGB,
  AVI_FORMAT_MJPEG,
} AviFormat;
 
typedef struct _AviStreamRec {
  AviStreamHeader sh;
  void *sf;
  int sf_size;
  AviFormat format;
} AviStreamRec;
 
typedef struct _AviMovie {
  FILE *fp;
 
  int type;
#define AVI_MOVIE_READ 0
#define AVI_MOVIE_WRITE 1
 
  int64_t size;
 
  AviMainHeader *header;
  AviStreamRec *streams;
  AviIndexEntry *entries;
  int index_entries;
 
  int64_t movi_offset;
  int64_t read_offset;
  int64_t *offset_table;
 
  /* Local data goes here */
  int interlace;
  int odd_fields;
} AviMovie;
 
typedef enum {
  AVI_ERROR_NONE = 0,
  AVI_ERROR_COMPRESSION,
  AVI_ERROR_OPEN,
  AVI_ERROR_READING,
  AVI_ERROR_WRITING,
  AVI_ERROR_FORMAT,
  AVI_ERROR_ALLOC,
  AVI_ERROR_FOUND,
  AVI_ERROR_OPTION,
} AviError;
 
/* belongs to the option-setting function. */
typedef enum {
  AVI_OPTION_WIDTH = 0,
  AVI_OPTION_HEIGHT,
  AVI_OPTION_QUALITY,
  AVI_OPTION_FRAMERATE,
} AviOption;
 
/* The offsets that will always stay the same in AVI files we
 * write... used to seek around to the places where we need to write
 * the sizes */
 
#define AVI_RIFF_SOFF 4L
#define AVI_HDRL_SOFF 16L
 
#define FCC(ch4) (ch4[0] | ch4[1] << 8 | ch4[2] << 16 | ch4[3] << 24)
 
bool AVI_is_avi(const char *name);
 
AviError AVI_open_compress(char *name, AviMovie *movie, int streams, ...);
 
AviError AVI_close_compress(AviMovie *movie);
 
AviError AVI_set_compress_option(
    AviMovie *movie, int option_type, int stream, AviOption option, void *opt_data);
/* Hmmm... there should be some explanation about what these mean */
#define AVI_OPTION_TYPE_MAIN 0
#define AVI_OPTION_TYPE_STRH 1
#define AVI_OPTION_TYPE_STRF 2
 
int AVI_get_stream(AviMovie *movie, int avist_type, int stream_num);
 
AviError AVI_open_movie(const char *name, AviMovie *movie);
 
void *AVI_read_frame(AviMovie *movie, AviFormat format, int frame, int stream);
AviError AVI_close(AviMovie *movie);
 
AviError AVI_write_frame(AviMovie *movie, int frame_num, ...);
 
AviError AVI_print_error(AviError error);