libquicktime
quicktime.h
Go to the documentation of this file.
1/*******************************************************************************
2 quicktime.h
3
4 libquicktime - A library for reading and writing quicktime/avi/mp4 files.
5 http://libquicktime.sourceforge.net
6
7 Copyright (C) 2002 Heroine Virtual Ltd.
8 Copyright (C) 2002-2011 Members of the libquicktime project.
9
10 This library is free software; you can redistribute it and/or modify it under
11 the terms of the GNU Lesser General Public License as published by the Free
12 Software Foundation; either version 2.1 of the License, or (at your option)
13 any later version.
14
15 This library is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
18 details.
19
20 You should have received a copy of the GNU Lesser General Public License along
21 with this library; if not, write to the Free Software Foundation, Inc., 51
22 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23*******************************************************************************/
24
25#ifndef QUICKTIME_H
26#define QUICKTIME_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <inttypes.h>
33#include <stddef.h>
34
35#ifdef __GNUC__
36#pragma GCC visibility push(default)
37#endif
38
39/* Some public enums needed by most subsequent headers */
40
41typedef struct lqt_codec_info_s lqt_codec_info_t;
42
43
48
52
56
57
61
76
98
121
125
126typedef enum
127 {
128 LQT_LOG_ERROR = (1<<0),
129 LQT_LOG_WARNING = (1<<1),
130 LQT_LOG_INFO = (1<<2),
131 LQT_LOG_DEBUG = (1<<3),
133
141
143 const char * domain,
144 const char * message,
145 void * data);
146
147
153
154typedef enum
155 {
158 LQT_FILE_QT = (1<<1),
159 LQT_FILE_AVI = (1<<2),
161 LQT_FILE_MP4 = (1<<4),
162 LQT_FILE_M4A = (1<<5),
163 LQT_FILE_3GP = (1<<6),
165
166
176
177typedef enum
178 {
179 LQT_CHANNEL_UNKNOWN,
180 LQT_CHANNEL_FRONT_LEFT,
181 LQT_CHANNEL_FRONT_RIGHT,
182 LQT_CHANNEL_FRONT_CENTER,
183 LQT_CHANNEL_FRONT_CENTER_LEFT,
184 LQT_CHANNEL_FRONT_CENTER_RIGHT,
185 LQT_CHANNEL_BACK_CENTER,
186 LQT_CHANNEL_BACK_LEFT,
187 LQT_CHANNEL_BACK_RIGHT,
188 LQT_CHANNEL_SIDE_LEFT,
189 LQT_CHANNEL_SIDE_RIGHT,
190 LQT_CHANNEL_LFE,
191 LQT_CHANNEL_Ls, /* Rear Surround Left (7.1 systems) */
192 LQT_CHANNEL_Rs, /* Rear Surround Right (7.1 systems) */
193 LQT_CHANNEL_MONO,
194 LQT_CHANNEL_Lt, /* Prologic (matrixed) Left Total */
195 LQT_CHANNEL_Rt /* Prologic (matrixed) Right Total */
197
198
202
231
254
261
268
277
284
293
304
312
313typedef struct quicktime_s quicktime_t;
314
315/* This is the reference for all your library entry points. */
316
317/* ===== compression formats for which codecs exist ====== */
318
331
337
338#define QUICKTIME_DIVX "DIVX"
339
345
346#define QUICKTIME_DIV3 "DIV3"
347
353
354#define QUICKTIME_DV "dvc "
355/* AVID DV codec can be processed with libdv as well */
356
362
363#define QUICKTIME_DV_AVID "AVdv"
364
370
371#define QUICKTIME_DV_AVID_A "dvcp"
372
379
380/* RGB uncompressed. Allows alpha */
381#define QUICKTIME_RAW "raw "
382
388
389/* Jpeg Photo */
390#define QUICKTIME_JPEG "jpeg"
391
392/* Concatenated png images. Allows alpha */
393
400
401#define QUICKTIME_PNG "png "
402
409
410#define QUICKTIME_MJPA "mjpa"
411
417
418#define QUICKTIME_YUV2 "yuv2"
419
425
426#define QUICKTIME_YUV4 "yuv4"
427
434
435#define QUICKTIME_YUV420 "yv12"
436
442
443#define QUICKTIME_2VUY "2vuy"
444
450
451#define QUICKTIME_YUVS "yuvs"
452
453
459
460#define QUICKTIME_V308 "v308"
461
467
468#define QUICKTIME_V408 "v408"
469
475
476#define QUICKTIME_V210 "v210"
477
483
484#define QUICKTIME_V410 "v410"
485
486/* =================== Audio formats ======================= */
487
500
506
507#define QUICKTIME_RAWAUDIO "raw "
508
514
515#define QUICKTIME_IMA4 "ima4"
516
522
523#define QUICKTIME_TWOS "twos"
524
530
531#define QUICKTIME_ULAW "ulaw"
532
540
541#define QUICKTIME_VORBIS "OggS"
542
549
550#define QUICKTIME_MP3 ".mp3"
551
552/* =========================== public interface ========================= // */
553
561
562 /* Get version information */
564
573
581
583
594
595int quicktime_check_sig(char *path);
596
606
607quicktime_t* quicktime_open(const char *filename, int rd, int wr);
608
620
621int quicktime_make_streamable(char *in_path, char *out_path);
622
629
635
636void quicktime_set_copyright(quicktime_t *file, char *string);
637
643
644void quicktime_set_name(quicktime_t *file, char *string);
645
651
652void quicktime_set_info(quicktime_t *file, char *string);
653
659
660
662
668
669
671
677
679
680
695
697 int channels,
698 long sample_rate,
699 int bits,
700 char *compressor);
701
711
712void quicktime_set_framerate(quicktime_t *file, double framerate);
713
728
730 int tracks,
731 int frame_w,
732 int frame_h,
733 double frame_rate,
734 char *compressor);
735
748
749void quicktime_set_jpeg(quicktime_t *file, int quality, int use_float);
750
764
765void quicktime_set_parameter(quicktime_t *file, char *key, void *value);
766
778 int depth,
779 int track);
780
789
790void quicktime_set_cmodel(quicktime_t *file, int colormodel);
791
801
802void quicktime_set_row_span(quicktime_t *file, int row_span);
803
808
810
811/* get length information */
812/* channel numbers start on 1 for audio and video */
813
820
821
822long quicktime_audio_length(quicktime_t *file, int track);
823
834
835long quicktime_video_length(quicktime_t *file, int track);
836
843
844 /* get position information */
846
855
857
863
864/* get file information */
866
872
874
880
882
889
890long quicktime_sample_rate(quicktime_t *file, int track);
891
905
906int quicktime_audio_bits(quicktime_t *file, int track);
907
914
916
928
930
936
938
945
946int quicktime_video_width(quicktime_t *file, int track);
947
954
956
971int quicktime_video_depth(quicktime_t *file, int track);
972
986
987double quicktime_frame_rate(quicktime_t *file, int track);
988
998
1000
1001/* number of bytes of raw data in this frame */
1002
1012
1013
1014long quicktime_frame_size(quicktime_t *file, long frame, int track);
1015
1024
1025int quicktime_channel_location(quicktime_t *file, int *quicktime_track, int *quicktime_channel, int channel);
1026
1027/* file positioning */
1028/* Remove these and see what happens :) */
1029
1030// int quicktime_seek_end(quicktime_t *file);
1031
1039
1041
1042/* set position of file descriptor relative to a track */
1043
1052int quicktime_set_audio_position(quicktime_t *file, int64_t sample, int track);
1053
1063
1064int quicktime_set_video_position(quicktime_t *file, int64_t frame, int track);
1065
1066/* ========================== Access to raw data follows. */
1067/* write data for one quicktime track */
1068/* the user must handle conversion to the channels in this track */
1069int quicktime_write_audio(quicktime_t *file, uint8_t *audio_buffer, long samples, int track);
1070
1085
1086int quicktime_write_frame(quicktime_t *file, uint8_t *video_buffer, int64_t bytes, int track);
1087
1102
1103long quicktime_read_frame(quicktime_t *file, unsigned char *video_buffer, int track);
1104
1105/* for reading frame using a library that needs a file descriptor */
1106/* Frame caching doesn't work here. */
1107int quicktime_read_frame_init(quicktime_t *file, int track);
1108int quicktime_read_frame_end(quicktime_t *file, int track);
1109
1110/* One keyframe table for each track */
1111long quicktime_get_keyframe_before(quicktime_t *file, long frame, int track);
1112long quicktime_get_partial_keyframe_before(quicktime_t *file, long frame, int track);
1113void quicktime_insert_keyframe(quicktime_t *file, long frame, int track);
1114void quicktime_insert_partial_keyframe(quicktime_t *file, long frame, int track);
1115/* Track has keyframes */
1116int quicktime_has_keyframes(quicktime_t *file, int track);
1117
1118/* Sample dependencies for long-GOP formats. */
1119void quicktime_insert_sdtp_entry(quicktime_t *file, long frame, int track, uint8_t flags);
1120
1121/* ===================== Access to built in codecs follows. */
1122
1123/* If the codec for this track is supported in the library return 1. */
1124
1131
1133
1140
1142
1153
1155 int colormodel,
1156 int track);
1157
1168
1170 int colormodel,
1171 int track);
1172
1173
1174/* Hacks for temporal codec */
1175int quicktime_divx_is_key(unsigned char *data, long size);
1176int quicktime_divx_write_vol(unsigned char *data_start,
1177 int vol_width,
1178 int vol_height,
1179 int time_increment_resolution,
1180 double frame_rate);
1181int quicktime_divx_has_vol(unsigned char *data);
1182
1183int quicktime_div3_is_key(unsigned char *data, long size);
1184
1194
1196 unsigned char **row_pointers,
1197 int track);
1198
1208
1210 unsigned char **row_pointers,
1211 int track);
1212
1232
1234 int in_x, /* Location of input frame to take picture */
1235 int in_y,
1236 int in_w,
1237 int in_h,
1238 int out_w, /* Dimensions of output frame */
1239 int out_h,
1240 int color_model, /* One of the color models defined above */
1241 unsigned char **row_pointers,
1242 int track);
1243
1244/* Decode or encode audio for a single channel into the buffer. */
1245/* Pass a buffer for the _i or the _f argument if you want int16 or float data. */
1246/* Notice that encoding requires an array of pointers to each channel. */
1247
1264
1265int quicktime_decode_audio(quicktime_t *file, int16_t *output_i, float *output_f, long samples, int channel);
1266
1278
1279int quicktime_encode_audio(quicktime_t *file, int16_t **input_i, float **input_f, long samples);
1280
1287
1289
1290/* Specify the number of cpus to utilize. */
1291
1300
1301
1302int quicktime_set_cpus(quicktime_t *file, int cpus);
1303
1304/* Specify whether to read contiguously or not. */
1305/* preload is the number of bytes to read ahead. */
1306/* This is no longer functional to the end user but is used to accelerate */
1307/* reading the header internally. */
1308void quicktime_set_preload(quicktime_t *file, int64_t preload);
1309
1310int64_t quicktime_byte_position(quicktime_t *file);
1311
1319
1320void quicktime_set_avi(quicktime_t *file, int value);
1321
1322#ifdef __GNUC__
1323#pragma GCC visibility pop
1324#endif
1325
1326
1327#ifdef __cplusplus
1328}
1329#endif
1330
1331#endif
int quicktime_channel_location(quicktime_t *file, int *quicktime_track, int *quicktime_channel, int channel)
int quicktime_audio_bits(quicktime_t *file, int track)
Get the bits per sample of an audio track.
long quicktime_sample_rate(quicktime_t *file, int track)
Get the samplerate of an audio track.
int quicktime_supported_audio(quicktime_t *file, int track)
Check if an audio track is supported by libquicktime.
int quicktime_track_channels(quicktime_t *file, int track)
Get the number of channels of an audio track.
int quicktime_set_audio_position(quicktime_t *file, int64_t sample, int track)
Seek to a specific audio position.
int quicktime_audio_tracks(quicktime_t *file)
Get the number of audio tracks.
long quicktime_audio_length(quicktime_t *file, int track)
Get the audio length.
char * quicktime_audio_compressor(quicktime_t *file, int track)
Get the four character code of an audio track.
int quicktime_decode_audio(quicktime_t *file, int16_t *output_i, float *output_f, long samples, int channel)
Decode a number of audio samples of a single channel.
int quicktime_has_audio(quicktime_t *file)
Check if a file has at least one audio track.
long quicktime_audio_position(quicktime_t *file, int track)
Get the audio position.
int quicktime_encode_audio(quicktime_t *file, int16_t **input_i, float **input_f, long samples)
Encode a number of audio samples for the first track.
int quicktime_set_audio(quicktime_t *file, int channels, long sample_rate, int bits, char *compressor)
Set up tracks in a new file after opening and before writing.
lqt_sample_format_t
Sample format definitions for audio.
Definition quicktime.h:295
@ LQT_SAMPLE_INT8
Definition quicktime.h:297
@ LQT_SAMPLE_INT16
Definition quicktime.h:299
@ LQT_SAMPLE_INT32
Definition quicktime.h:300
@ LQT_SAMPLE_DOUBLE
Definition quicktime.h:302
@ LQT_SAMPLE_FLOAT
Definition quicktime.h:301
@ LQT_SAMPLE_UNDEFINED
Definition quicktime.h:296
@ LQT_SAMPLE_UINT8
Definition quicktime.h:298
int quicktime_release()
Get the quicktime4linux release number.
int quicktime_minor()
Get the quicktime4linux minor version.
int quicktime_set_cpus(quicktime_t *file, int cpus)
Set the number of CPUs.
quicktime_t * quicktime_open(const char *filename, int rd, int wr)
Open a file.
int quicktime_major()
Get the quicktime4linux major version.
void quicktime_set_avi(quicktime_t *file, int value)
Write an AVI file instead of quicktime.
int quicktime_check_sig(char *path)
Test file compatibility.
int quicktime_dump(quicktime_t *file)
Dump the file structures to stdout.
int quicktime_make_streamable(char *in_path, char *out_path)
Make a file streamable.
int quicktime_close(quicktime_t *file)
Close a quicktime handle and free all associated memory.
struct quicktime_s quicktime_t
Quicktime handle.
Definition quicktime.h:313
void(* lqt_log_callback_t)(lqt_log_level_t level, const char *domain, const char *message, void *data)
Log callback.
Definition quicktime.h:142
lqt_log_level_t
Log level.
Definition quicktime.h:127
void quicktime_set_copyright(quicktime_t *file, char *string)
Set the copyright info for the file.
void quicktime_set_name(quicktime_t *file, char *string)
Set the name for the file.
char * quicktime_get_name(quicktime_t *file)
Get the name from the file.
char * quicktime_get_copyright(quicktime_t *file)
Get the copyright info from the file.
void quicktime_set_info(quicktime_t *file, char *string)
Set info for the file.
char * quicktime_get_info(quicktime_t *file)
Get the info string from the file.
lqt_channel_t
Channel definitions.
Definition quicktime.h:178
double quicktime_frame_rate(quicktime_t *file, int track)
Get the framerate of a video track.
long quicktime_frame_size(quicktime_t *file, long frame, int track)
Get the compressed size of frame in a video track.
long quicktime_decode_scaled(quicktime_t *file, int in_x, int in_y, int in_w, int in_h, int out_w, int out_h, int color_model, unsigned char **row_pointers, int track)
Decode aand optionally scale a video frame.
int quicktime_video_tracks(quicktime_t *file)
Get the number of video tracks.
int quicktime_decode_video(quicktime_t *file, unsigned char **row_pointers, int track)
Decode a video frame in BC_RGB888.
long quicktime_video_length(quicktime_t *file, int track)
Get the video length.
int quicktime_video_depth(quicktime_t *file, int track)
Get the depth of a video track.
int quicktime_video_width(quicktime_t *file, int track)
Get the width of a video track.
char * quicktime_video_compressor(quicktime_t *file, int track)
Get the four character code of a video track.
long quicktime_video_position(quicktime_t *file, int track)
Get the video position.
int quicktime_has_video(quicktime_t *file)
Check if a file has at least one video track.
int quicktime_video_height(quicktime_t *file, int track)
Get the height of a video track.
int quicktime_supported_video(quicktime_t *file, int track)
Check if a video track is supported by libquicktime.
int quicktime_reads_cmodel(quicktime_t *file, int colormodel, int track)
Check if a colormodel is supported for decoding.
int quicktime_set_video_position(quicktime_t *file, int64_t frame, int track)
Seek to a specific video frame.
long quicktime_read_frame(quicktime_t *file, unsigned char *video_buffer, int track)
Read a compressed video frame.
void quicktime_set_depth(quicktime_t *file, int depth, int track)
Set the depth of a video track.
int quicktime_writes_cmodel(quicktime_t *file, int colormodel, int track)
Check if a colormodel is supported for encoding.
void quicktime_set_parameter(quicktime_t *file, char *key, void *value)
Set a codec parameter.
void quicktime_set_framerate(quicktime_t *file, double framerate)
Set the framerate for encoding.
int quicktime_encode_video(quicktime_t *file, unsigned char **row_pointers, int track)
Encode a video frame.
int quicktime_write_frame(quicktime_t *file, uint8_t *video_buffer, int64_t bytes, int track)
Write a compressed video frame.
int quicktime_set_video(quicktime_t *file, int tracks, int frame_w, int frame_h, double frame_rate, char *compressor)
Set up video tracks for encoding.
void quicktime_set_jpeg(quicktime_t *file, int quality, int use_float)
Set jpeg encoding quality.
lqt_chroma_placement_t
Chroma placement.
Definition quicktime.h:279
void quicktime_set_row_span(quicktime_t *file, int row_span)
Set the row_span for en-/decoding.
lqt_interlace_mode_t
interlace modes
Definition quicktime.h:263
void quicktime_set_cmodel(quicktime_t *file, int colormodel)
Set the colormodel for en-/decoding.
@ LQT_CHROMA_PLACEMENT_DVPAL
Definition quicktime.h:282
@ LQT_CHROMA_PLACEMENT_DEFAULT
Definition quicktime.h:280
@ LQT_CHROMA_PLACEMENT_MPEG2
Definition quicktime.h:281
@ LQT_INTERLACE_TOP_FIRST
Definition quicktime.h:265
@ LQT_INTERLACE_NONE
Definition quicktime.h:264
@ LQT_INTERLACE_BOTTOM_FIRST
Definition quicktime.h:266
lqt_file_type_t
File types.
Definition quicktime.h:155
@ LQT_FILE_QT_OLD
Definition quicktime.h:157
@ LQT_FILE_MP4
Definition quicktime.h:161
@ LQT_FILE_3GP
Definition quicktime.h:163
@ LQT_FILE_M4A
Definition quicktime.h:162
@ LQT_FILE_AVI_ODML
Definition quicktime.h:160
@ LQT_FILE_NONE
Definition quicktime.h:156
@ LQT_FILE_AVI
Definition quicktime.h:159
@ LQT_FILE_QT
Definition quicktime.h:158
int quicktime_seek_start(quicktime_t *file)
Reposition all tracks to the very beginning.
Structure describing a codec.
Definition lqt_codecinfo.h:190