lavc: export DV profile API used by muxer/demuxer as public
[libav.git] / libavcodec / dv_profile.h
CommitLineData
520c1ec6
DB
1/*
2 * This file is part of Libav.
3 *
4 * Libav is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * Libav is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with Libav; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19#ifndef AVCODEC_DV_PROFILE_H
20#define AVCODEC_DV_PROFILE_H
21
22#include <stdint.h>
23
24#include "libavutil/pixfmt.h"
25#include "libavutil/rational.h"
26#include "avcodec.h"
27
520c1ec6 28/*
f6ee61fb 29 * AVDVProfile is used to express the differences between various
520c1ec6
DB
30 * DV flavors. For now it's primarily used for differentiating
31 * 525/60 and 625/50, but the plans are to use it for various
32 * DV specs as well (e.g. SMPTE314M vs. IEC 61834).
33 */
f6ee61fb 34typedef struct AVDVProfile {
520c1ec6
DB
35 int dsf; /* value of the dsf in the DV header */
36 int video_stype; /* stype for VAUX source pack */
37 int frame_size; /* total size of one frame in bytes */
38 int difseg_size; /* number of DIF segments per DIF channel */
39 int n_difchan; /* number of DIF channels per frame */
40 AVRational time_base; /* 1/framerate */
41 int ltc_divisor; /* FPS from the LTS standpoint */
42 int height; /* picture height in pixels */
43 int width; /* picture width in pixels */
44 AVRational sar[2]; /* sample aspect ratios for 4:3 and 16:9 */
716d413c 45 enum AVPixelFormat pix_fmt; /* picture pixel format */
520c1ec6
DB
46 int bpm; /* blocks per macroblock */
47 const uint8_t *block_sizes; /* AC block sizes, in bits */
48 int audio_stride; /* size of audio_shuffle table */
49 int audio_min_samples[3]; /* min amount of audio samples */
50 /* for 48kHz, 44.1kHz and 32kHz */
51 int audio_samples_dist[5]; /* how many samples are supposed to be */
52 /* in each frame in a 5 frames window */
53 const uint8_t (*audio_shuffle)[9]; /* PCM shuffling table */
f6ee61fb 54} AVDVProfile;
520c1ec6 55
f6ee61fb
AK
56#if LIBAVCODEC_VERSION_MAJOR < 56
57const AVDVProfile *avpriv_dv_frame_profile(const AVDVProfile *sys,
58 const uint8_t* frame, unsigned buf_size);
59const AVDVProfile *avpriv_dv_codec_profile(AVCodecContext* codec);
60#endif
520c1ec6
DB
61
62/**
f6ee61fb
AK
63 * Get a DV profile for the provided compressed frame.
64 *
65 * @param sys the profile used for the previous frame, may be NULL
66 * @param frame the compressed data buffer
67 * @param buf_size size of the buffer in bytes
68 * @return the DV profile for the supplied data or NULL on failure
69 */
70const AVDVProfile *av_dv_frame_profile(const AVDVProfile *sys,
71 const uint8_t *frame, unsigned buf_size);
72
73/**
74 * Get a DV profile for the provided stream parameters.
520c1ec6 75 */
f6ee61fb 76const AVDVProfile *av_dv_codec_profile(int width, int height, enum AVPixelFormat pix_fmt);
520c1ec6
DB
77
78#endif /* AVCODEC_DV_PROFILE_H */