FFmpeg
tak.h
Go to the documentation of this file.
1 /*
2  * TAK decoder/demuxer common code
3  * Copyright (c) 2012 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * TAK (Tom's lossless Audio Kompressor) decoder/demuxer common functions
25  */
26 
27 #ifndef AVCODEC_TAK_H
28 #define AVCODEC_TAK_H
29 
30 #include <stdint.h>
31 
32 #include "get_bits.h"
33 
34 #define TAK_FORMAT_DATA_TYPE_BITS 3
35 #define TAK_FORMAT_SAMPLE_RATE_BITS 18
36 #define TAK_FORMAT_BPS_BITS 5
37 #define TAK_FORMAT_CHANNEL_BITS 4
38 #define TAK_FORMAT_VALID_BITS 5
39 #define TAK_FORMAT_CH_LAYOUT_BITS 6
40 #define TAK_SIZE_FRAME_DURATION_BITS 4
41 #define TAK_SIZE_SAMPLES_NUM_BITS 35
42 #define TAK_LAST_FRAME_POS_BITS 40
43 #define TAK_LAST_FRAME_SIZE_BITS 24
44 #define TAK_ENCODER_CODEC_BITS 6
45 #define TAK_ENCODER_PROFILE_BITS 4
46 #define TAK_SAMPLE_RATE_MIN 6000
47 #define TAK_CHANNELS_MIN 1
48 #define TAK_BPS_MIN 8
49 #define TAK_FRAME_HEADER_FLAGS_BITS 3
50 #define TAK_FRAME_HEADER_SYNC_ID 0xA0FF
51 #define TAK_FRAME_HEADER_SYNC_ID_BITS 16
52 #define TAK_FRAME_HEADER_SAMPLE_COUNT_BITS 14
53 #define TAK_FRAME_HEADER_NO_BITS 21
54 #define TAK_FRAME_DURATION_QUANT_SHIFT 5
55 #define TAK_CRC24_BITS 24
56 
57 
58 #define TAK_FRAME_FLAG_IS_LAST 0x1
59 #define TAK_FRAME_FLAG_HAS_INFO 0x2
60 #define TAK_FRAME_FLAG_HAS_METADATA 0x4
61 
62 #define TAK_MAX_CHANNELS (1 << TAK_FORMAT_CHANNEL_BITS)
63 
64 #define TAK_MIN_FRAME_HEADER_BITS (TAK_FRAME_HEADER_SYNC_ID_BITS + \
65  TAK_FRAME_HEADER_FLAGS_BITS + \
66  TAK_FRAME_HEADER_NO_BITS + \
67  TAK_CRC24_BITS)
68 
69 #define TAK_MIN_FRAME_HEADER_LAST_BITS (TAK_MIN_FRAME_HEADER_BITS + 2 + \
70  TAK_FRAME_HEADER_SAMPLE_COUNT_BITS)
71 
72 #define TAK_ENCODER_BITS (TAK_ENCODER_CODEC_BITS + \
73  TAK_ENCODER_PROFILE_BITS)
74 
75 #define TAK_SIZE_BITS (TAK_SIZE_SAMPLES_NUM_BITS + \
76  TAK_SIZE_FRAME_DURATION_BITS)
77 
78 #define TAK_FORMAT_BITS (TAK_FORMAT_DATA_TYPE_BITS + \
79  TAK_FORMAT_SAMPLE_RATE_BITS + \
80  TAK_FORMAT_BPS_BITS + \
81  TAK_FORMAT_CHANNEL_BITS + 1 + \
82  TAK_FORMAT_VALID_BITS + 1 + \
83  TAK_FORMAT_CH_LAYOUT_BITS * \
84  TAK_MAX_CHANNELS)
85 
86 #define TAK_STREAMINFO_BITS (TAK_ENCODER_BITS + \
87  TAK_SIZE_BITS + \
88  TAK_FORMAT_BITS)
89 
90 #define TAK_MAX_FRAME_HEADER_BITS (TAK_MIN_FRAME_HEADER_LAST_BITS + \
91  TAK_STREAMINFO_BITS + 31)
92 
93 #define TAK_STREAMINFO_BYTES ((TAK_STREAMINFO_BITS + 7) / 8)
94 #define TAK_MAX_FRAME_HEADER_BYTES ((TAK_MAX_FRAME_HEADER_BITS + 7) / 8)
95 #define TAK_MIN_FRAME_HEADER_BYTES ((TAK_MIN_FRAME_HEADER_BITS + 7) / 8)
96 
100 };
101 
111 };
112 
124 };
125 
126 typedef struct TAKStreamInfo {
127  int flags;
131  int channels;
132  int bps;
136  uint64_t ch_layout;
137  int64_t samples;
138 } TAKStreamInfo;
139 
140 int ff_tak_check_crc(const uint8_t *buf, unsigned int buf_size);
141 
142 /**
143  * Parse the Streaminfo metadata block.
144  * @param[out] s storage for parsed information
145  * @param[in] buf input buffer
146  * @param[in] size size of input buffer in bytes
147  * @return non-zero on error, 0 if OK
148  */
149 int avpriv_tak_parse_streaminfo(TAKStreamInfo *s, const uint8_t *buf, int size);
150 
151 /**
152  * Validate and decode a frame header.
153  * @param logctx for use as av_log() context
154  * @param[in] gb GetBitContext from which to read frame header
155  * @param[out] s frame information
156  * @param log_level_offset log level offset, can be used to silence
157  * error messages.
158  * @return non-zero on error, 0 if OK
159  */
160 int ff_tak_decode_frame_header(void *logctx, GetBitContext *gb,
161  TAKStreamInfo *s, int log_level_offset);
162 #endif /* AVCODEC_TAK_H */
TAKCodecType
TAKCodecType
Definition: tak.h:97
TAK_METADATA_PADDING
@ TAK_METADATA_PADDING
Definition: tak.h:108
TAKStreamInfo::data_type
int data_type
Definition: tak.h:129
TAKStreamInfo::flags
int flags
Definition: tak.h:127
ff_tak_decode_frame_header
int ff_tak_decode_frame_header(void *logctx, GetBitContext *gb, TAKStreamInfo *s, int log_level_offset)
Validate and decode a frame header.
Definition: tak.c:147
TAKStreamInfo::last_frame_samples
int last_frame_samples
Definition: tak.h:135
ff_tak_check_crc
int ff_tak_check_crc(const uint8_t *buf, unsigned int buf_size)
Definition: tak.c:79
TAK_FST_4096
@ TAK_FST_4096
Definition: tak.h:118
TAKStreamInfo::channels
int channels
Definition: tak.h:131
TAK_METADATA_ENCODER
@ TAK_METADATA_ENCODER
Definition: tak.h:107
GetBitContext
Definition: get_bits.h:108
TAK_METADATA_SEEKTABLE
@ TAK_METADATA_SEEKTABLE
Definition: tak.h:105
TAK_FST_94ms
@ TAK_FST_94ms
Definition: tak.h:114
TAK_METADATA_SIMPLE_WAVE_DATA
@ TAK_METADATA_SIMPLE_WAVE_DATA
Definition: tak.h:106
s
#define s(width, name)
Definition: cbs_vp9.c:198
TAK_METADATA_END
@ TAK_METADATA_END
Definition: tak.h:103
get_bits.h
TAK_CODEC_MONO_STEREO
@ TAK_CODEC_MONO_STEREO
Definition: tak.h:98
TAKStreamInfo::samples
int64_t samples
Definition: tak.h:137
TAKStreamInfo::ch_layout
uint64_t ch_layout
Definition: tak.h:136
TAK_FST_16384
@ TAK_FST_16384
Definition: tak.h:120
TAKStreamInfo::frame_samples
int frame_samples
Definition: tak.h:134
TAKStreamInfo::frame_num
int frame_num
Definition: tak.h:133
TAK_FST_250ms
@ TAK_FST_250ms
Definition: tak.h:117
TAK_METADATA_LAST_FRAME
@ TAK_METADATA_LAST_FRAME
Definition: tak.h:110
TAK_FST_512
@ TAK_FST_512
Definition: tak.h:121
size
int size
Definition: twinvq_data.h:10344
TAK_METADATA_MD5
@ TAK_METADATA_MD5
Definition: tak.h:109
TAKStreamInfo::bps
int bps
Definition: tak.h:132
TAKStreamInfo::codec
enum TAKCodecType codec
Definition: tak.h:128
avpriv_tak_parse_streaminfo
int avpriv_tak_parse_streaminfo(TAKStreamInfo *s, const uint8_t *buf, int size)
Parse the Streaminfo metadata block.
Definition: tak.c:136
TAK_METADATA_STREAMINFO
@ TAK_METADATA_STREAMINFO
Definition: tak.h:104
TAKMetaDataType
TAKMetaDataType
Definition: tak.h:102
TAK_FST_8192
@ TAK_FST_8192
Definition: tak.h:119
TAK_FST_1024
@ TAK_FST_1024
Definition: tak.h:122
TAK_FST_188ms
@ TAK_FST_188ms
Definition: tak.h:116
TAKStreamInfo::sample_rate
int sample_rate
Definition: tak.h:130
TAKStreamInfo
Definition: tak.h:126
TAK_FST_2048
@ TAK_FST_2048
Definition: tak.h:123
TAKFrameSizeType
TAKFrameSizeType
Definition: tak.h:113
TAK_FST_125ms
@ TAK_FST_125ms
Definition: tak.h:115
TAK_CODEC_MULTICHANNEL
@ TAK_CODEC_MULTICHANNEL
Definition: tak.h:99