s/IEC958/IEC 61937 - IEC958 is a lower level format.
[ffmpeg.git] / libavformat / spdifenc.c
1 /*
2  * IEC 61937 muxer
3  * Copyright (c) 2009 Bartlomiej Wolowiec
4  * Copyright (c) 2010 Anssi Hannula
5  * Copyright (c) 2010 Carl Eugen Hoyos
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 /**
25  * @file
26  * IEC-61937 encapsulation of various formats, used by S/PDIF
27  * @author Bartlomiej Wolowiec
28  * @author Anssi Hannula
29  * @author Carl Eugen Hoyos
30  */
31
32 /*
33  * Terminology used in specification:
34  * data-burst - IEC61937 frame, contains header and encapsuled frame
35  * burst-preambule - IEC61937 frame header, contains 16-bits words named Pa, Pb, Pc and Pd
36  * burst-payload - encapsuled frame
37  * Pa, Pb - syncword - 0xF872, 0x4E1F
38  * Pc - burst-info, contains data-type (bits 0-6), error flag (bit 7), data-type-dependent info (bits 8-12)
39  *      and bitstream number (bits 13-15)
40  * data-type - determines type of encapsuled frames
41  * Pd - length code (number of bits or bytes of encapsuled frame - according to data_type)
42  *
43  * IEC 61937 frames at normal usage start every specific count of bytes,
44  *      dependent from data-type (spaces between packets are filled by zeros)
45  */
46
47 #include "avformat.h"
48 #include "spdif.h"
49 #include "libavcodec/ac3.h"
50 #include "libavcodec/dca.h"
51 #include "libavcodec/aacadtsdec.h"
52
53 typedef struct IEC61937Context {
54     enum IEC61937DataType data_type;///< burst info - reference to type of payload of the data-burst
55     int length_code;                ///< length code in bits or bytes, depending on data type
56     int pkt_offset;                 ///< data burst repetition period in bytes
57     uint8_t *buffer;                ///< allocated buffer, used for swap bytes
58     int buffer_size;                ///< size of allocated buffer
59
60     uint8_t *out_buf;               ///< pointer to the outgoing data before byte-swapping
61     int out_bytes;                  ///< amount of outgoing bytes
62
63     int extra_bswap;                ///< extra bswap for payload (for LE DTS => standard BE DTS)
64
65     uint8_t *hd_buf;                ///< allocated buffer to concatenate hd audio frames
66     int hd_buf_size;                ///< size of the hd audio buffer
67     int hd_buf_count;               ///< number of frames in the hd audio buffer
68     int hd_buf_filled;              ///< amount of bytes in the hd audio buffer
69
70     /// function, which generates codec dependent header information.
71     /// Sets data_type and pkt_offset, and length_code, out_bytes, out_buf if necessary
72     int (*header_info) (AVFormatContext *s, AVPacket *pkt);
73 } IEC61937Context;
74
75
76 static int spdif_header_ac3(AVFormatContext *s, AVPacket *pkt)
77 {
78     IEC61937Context *ctx = s->priv_data;
79     int bitstream_mode = pkt->data[5] & 0x7;
80
81     ctx->data_type  = IEC61937_AC3 | (bitstream_mode << 8);
82     ctx->pkt_offset = AC3_FRAME_SIZE << 2;
83     return 0;
84 }
85
86 static int spdif_header_eac3(AVFormatContext *s, AVPacket *pkt)
87 {
88     IEC61937Context *ctx = s->priv_data;
89     static const uint8_t eac3_repeat[4] = {6, 3, 2, 1};
90     int repeat = 1;
91
92     if ((pkt->data[4] & 0xc0) != 0xc0) /* fscod */
93         repeat = eac3_repeat[(pkt->data[4] & 0x30) >> 4]; /* numblkscod */
94
95     ctx->hd_buf = av_fast_realloc(ctx->hd_buf, &ctx->hd_buf_size, ctx->hd_buf_filled + pkt->size);
96     if (!ctx->hd_buf)
97         return AVERROR(ENOMEM);
98
99     memcpy(&ctx->hd_buf[ctx->hd_buf_filled], pkt->data, pkt->size);
100
101     ctx->hd_buf_filled += pkt->size;
102     if (++ctx->hd_buf_count < repeat){
103         ctx->pkt_offset = 0;
104         return 0;
105     }
106     ctx->data_type   = IEC61937_EAC3;
107     ctx->pkt_offset  = 24576;
108     ctx->out_buf     = ctx->hd_buf;
109     ctx->out_bytes   = ctx->hd_buf_filled;
110     ctx->length_code = ctx->hd_buf_filled;
111
112     ctx->hd_buf_count  = 0;
113     ctx->hd_buf_filled = 0;
114     return 0;
115 }
116
117 static int spdif_header_dts(AVFormatContext *s, AVPacket *pkt)
118 {
119     IEC61937Context *ctx = s->priv_data;
120     uint32_t syncword_dts = AV_RB32(pkt->data);
121     int blocks;
122
123     switch (syncword_dts) {
124     case DCA_MARKER_RAW_BE:
125         blocks = (AV_RB16(pkt->data + 4) >> 2) & 0x7f;
126         break;
127     case DCA_MARKER_RAW_LE:
128         blocks = (AV_RL16(pkt->data + 4) >> 2) & 0x7f;
129         ctx->extra_bswap = 1;
130         break;
131     case DCA_MARKER_14B_BE:
132         blocks =
133             (((pkt->data[5] & 0x07) << 4) | ((pkt->data[6] & 0x3f) >> 2));
134         break;
135     case DCA_MARKER_14B_LE:
136         blocks =
137             (((pkt->data[4] & 0x07) << 4) | ((pkt->data[7] & 0x3f) >> 2));
138         ctx->extra_bswap = 1;
139         break;
140     default:
141         av_log(s, AV_LOG_ERROR, "bad DTS syncword 0x%x\n", syncword_dts);
142         return AVERROR_INVALIDDATA;
143     }
144     blocks++;
145     switch (blocks) {
146     case  512 >> 5: ctx->data_type = IEC61937_DTS1; break;
147     case 1024 >> 5: ctx->data_type = IEC61937_DTS2; break;
148     case 2048 >> 5: ctx->data_type = IEC61937_DTS3; break;
149     default:
150         av_log(s, AV_LOG_ERROR, "%i samples in DTS frame not supported\n",
151                blocks << 5);
152         return AVERROR(ENOSYS);
153     }
154     ctx->pkt_offset = blocks << 7;
155
156     return 0;
157 }
158
159 static const enum IEC61937DataType mpeg_data_type[2][3] = {
160     //     LAYER1                      LAYER2                  LAYER3
161     { IEC61937_MPEG2_LAYER1_LSF, IEC61937_MPEG2_LAYER2_LSF, IEC61937_MPEG2_LAYER3_LSF },//MPEG2 LSF
162     { IEC61937_MPEG1_LAYER1,     IEC61937_MPEG1_LAYER23,    IEC61937_MPEG1_LAYER23 },   //MPEG1
163 };
164
165 static int spdif_header_mpeg(AVFormatContext *s, AVPacket *pkt)
166 {
167     IEC61937Context *ctx = s->priv_data;
168     int version =      (pkt->data[1] >> 3) & 3;
169     int layer   = 3 - ((pkt->data[1] >> 1) & 3);
170     int extension = pkt->data[2] & 1;
171
172     if (layer == 3 || version == 1) {
173         av_log(s, AV_LOG_ERROR, "Wrong MPEG file format\n");
174         return AVERROR_INVALIDDATA;
175     }
176     av_log(s, AV_LOG_DEBUG, "version: %i layer: %i extension: %i\n", version, layer, extension);
177     if (version == 2 && extension) {
178         ctx->data_type  = IEC61937_MPEG2_EXT;
179         ctx->pkt_offset = 4608;
180     } else {
181         ctx->data_type  = mpeg_data_type [version & 1][layer];
182         ctx->pkt_offset = spdif_mpeg_pkt_offset[version & 1][layer];
183     }
184     // TODO Data type dependant info (normal/karaoke, dynamic range control)
185     return 0;
186 }
187
188 static int spdif_header_aac(AVFormatContext *s, AVPacket *pkt)
189 {
190     IEC61937Context *ctx = s->priv_data;
191     AACADTSHeaderInfo hdr;
192     GetBitContext gbc;
193     int ret;
194
195     init_get_bits(&gbc, pkt->data, AAC_ADTS_HEADER_SIZE * 8);
196     ret = ff_aac_parse_header(&gbc, &hdr);
197     if (ret < 0) {
198         av_log(s, AV_LOG_ERROR, "Wrong AAC file format\n");
199         return AVERROR_INVALIDDATA;
200     }
201
202     ctx->pkt_offset = hdr.samples << 2;
203     switch (hdr.num_aac_frames) {
204     case 1:
205         ctx->data_type = IEC61937_MPEG2_AAC;
206         break;
207     case 2:
208         ctx->data_type = IEC61937_MPEG2_AAC_LSF_2048;
209         break;
210     case 4:
211         ctx->data_type = IEC61937_MPEG2_AAC_LSF_4096;
212         break;
213     default:
214         av_log(s, AV_LOG_ERROR, "%i samples in AAC frame not supported\n",
215                hdr.samples);
216         return AVERROR(EINVAL);
217     }
218     //TODO Data type dependent info (LC profile/SBR)
219     return 0;
220 }
221
222
223 /*
224  * It seems Dolby TrueHD frames have to be encapsulated in MAT frames before
225  * they can be encapsulated in IEC 61937.
226  * Here we encapsulate 24 TrueHD frames in a single MAT frame, padding them
227  * to achieve constant rate.
228  * The actual format of a MAT frame is unknown, but the below seems to work.
229  * However, it seems it is not actually necessary for the 24 TrueHD frames to
230  * be in an exact alignment with the MAT frame.
231  */
232 #define MAT_FRAME_SIZE          61424
233 #define TRUEHD_FRAME_OFFSET     2560
234 #define MAT_MIDDLE_CODE_OFFSET  -4
235
236 static int spdif_header_truehd(AVFormatContext *s, AVPacket *pkt)
237 {
238     IEC61937Context *ctx = s->priv_data;
239     int mat_code_length = 0;
240     const char mat_end_code[16] = { 0xC3, 0xC2, 0xC0, 0xC4, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x97, 0x11 };
241
242     if (!ctx->hd_buf_count) {
243         const char mat_start_code[20] = { 0x07, 0x9E, 0x00, 0x03, 0x84, 0x01, 0x01, 0x01, 0x80, 0x00, 0x56, 0xA5, 0x3B, 0xF4, 0x81, 0x83, 0x49, 0x80, 0x77, 0xE0 };
244         mat_code_length = sizeof(mat_start_code) + BURST_HEADER_SIZE;
245         memcpy(ctx->hd_buf, mat_start_code, sizeof(mat_start_code));
246
247     } else if (ctx->hd_buf_count == 12) {
248         const char mat_middle_code[12] = { 0xC3, 0xC1, 0x42, 0x49, 0x3B, 0xFA, 0x82, 0x83, 0x49, 0x80, 0x77, 0xE0 };
249         mat_code_length = sizeof(mat_middle_code) + MAT_MIDDLE_CODE_OFFSET;
250         memcpy(&ctx->hd_buf[12 * TRUEHD_FRAME_OFFSET - BURST_HEADER_SIZE + MAT_MIDDLE_CODE_OFFSET],
251                mat_middle_code, sizeof(mat_middle_code));
252     }
253
254     if (pkt->size > TRUEHD_FRAME_OFFSET - mat_code_length) {
255         /* if such frames exist, we'd need some more complex logic to
256          * distribute the TrueHD frames in the MAT frame */
257         av_log(s, AV_LOG_ERROR, "TrueHD frame too big, %d bytes\n", pkt->size);
258         av_log_ask_for_sample(s, NULL);
259         return AVERROR_INVALIDDATA;
260     }
261
262     memcpy(&ctx->hd_buf[ctx->hd_buf_count * TRUEHD_FRAME_OFFSET - BURST_HEADER_SIZE + mat_code_length],
263            pkt->data, pkt->size);
264     memset(&ctx->hd_buf[ctx->hd_buf_count * TRUEHD_FRAME_OFFSET - BURST_HEADER_SIZE + mat_code_length + pkt->size],
265            0, TRUEHD_FRAME_OFFSET - pkt->size - mat_code_length);
266
267     if (++ctx->hd_buf_count < 24){
268         ctx->pkt_offset = 0;
269         return 0;
270     }
271     memcpy(&ctx->hd_buf[MAT_FRAME_SIZE - sizeof(mat_end_code)], mat_end_code, sizeof(mat_end_code));
272     ctx->hd_buf_count = 0;
273
274     ctx->data_type   = IEC61937_TRUEHD;
275     ctx->pkt_offset  = 61440;
276     ctx->out_buf     = ctx->hd_buf;
277     ctx->out_bytes   = MAT_FRAME_SIZE;
278     ctx->length_code = MAT_FRAME_SIZE;
279     return 0;
280 }
281
282 static int spdif_write_header(AVFormatContext *s)
283 {
284     IEC61937Context *ctx = s->priv_data;
285
286     switch (s->streams[0]->codec->codec_id) {
287     case CODEC_ID_AC3:
288         ctx->header_info = spdif_header_ac3;
289         break;
290     case CODEC_ID_EAC3:
291         ctx->header_info = spdif_header_eac3;
292         break;
293     case CODEC_ID_MP1:
294     case CODEC_ID_MP2:
295     case CODEC_ID_MP3:
296         ctx->header_info = spdif_header_mpeg;
297         break;
298     case CODEC_ID_DTS:
299         ctx->header_info = spdif_header_dts;
300         break;
301     case CODEC_ID_AAC:
302         ctx->header_info = spdif_header_aac;
303         break;
304     case CODEC_ID_TRUEHD:
305         ctx->header_info = spdif_header_truehd;
306         ctx->hd_buf = av_malloc(MAT_FRAME_SIZE);
307         if (!ctx->hd_buf)
308             return AVERROR(ENOMEM);
309         break;
310     default:
311         av_log(s, AV_LOG_ERROR, "codec not supported\n");
312         return AVERROR_PATCHWELCOME;
313     }
314     return 0;
315 }
316
317 static int spdif_write_trailer(AVFormatContext *s)
318 {
319     IEC61937Context *ctx = s->priv_data;
320     av_freep(&ctx->buffer);
321     av_freep(&ctx->hd_buf);
322     return 0;
323 }
324
325 static int spdif_write_packet(struct AVFormatContext *s, AVPacket *pkt)
326 {
327     IEC61937Context *ctx = s->priv_data;
328     int ret, padding;
329
330     ctx->out_buf = pkt->data;
331     ctx->out_bytes = pkt->size;
332     ctx->length_code = FFALIGN(pkt->size, 2) << 3;
333     ctx->extra_bswap = 0;
334
335     ret = ctx->header_info(s, pkt);
336     if (ret < 0)
337         return ret;
338     if (!ctx->pkt_offset)
339         return 0;
340
341     padding = (ctx->pkt_offset - BURST_HEADER_SIZE - ctx->out_bytes) >> 1;
342     if (padding < 0) {
343         av_log(s, AV_LOG_ERROR, "bitrate is too high\n");
344         return AVERROR(EINVAL);
345     }
346
347     put_le16(s->pb, SYNCWORD1);      //Pa
348     put_le16(s->pb, SYNCWORD2);      //Pb
349     put_le16(s->pb, ctx->data_type); //Pc
350     put_le16(s->pb, ctx->length_code);//Pd
351
352     if (HAVE_BIGENDIAN ^ ctx->extra_bswap) {
353     put_buffer(s->pb, ctx->out_buf, ctx->out_bytes & ~1);
354     } else {
355     av_fast_malloc(&ctx->buffer, &ctx->buffer_size, ctx->out_bytes + FF_INPUT_BUFFER_PADDING_SIZE);
356     if (!ctx->buffer)
357         return AVERROR(ENOMEM);
358     ff_spdif_bswap_buf16((uint16_t *)ctx->buffer, (uint16_t *)ctx->out_buf, ctx->out_bytes >> 1);
359     put_buffer(s->pb, ctx->buffer, ctx->out_bytes & ~1);
360     }
361
362     if (ctx->out_bytes & 1)
363         put_be16(s->pb, ctx->out_buf[ctx->out_bytes - 1]);
364
365     for (; padding > 0; padding--)
366         put_be16(s->pb, 0);
367
368     av_log(s, AV_LOG_DEBUG, "type=%x len=%i pkt_offset=%i\n",
369            ctx->data_type, ctx->out_bytes, ctx->pkt_offset);
370
371     put_flush_packet(s->pb);
372     return 0;
373 }
374
375 AVOutputFormat spdif_muxer = {
376     "spdif",
377     NULL_IF_CONFIG_SMALL("IEC 61937 (used on S/PDIF - IEC958)"),
378     NULL,
379     "spdif",
380     sizeof(IEC61937Context),
381     CODEC_ID_AC3,
382     CODEC_ID_NONE,
383     spdif_write_header,
384     spdif_write_packet,
385     spdif_write_trailer,
386 };