Cosmetics (use PES_EXTENDED_STREAM_ID)
[vlc.git] / modules / mux / mpeg / pes.c
1 /*****************************************************************************
2  * pes.c: PES packetizer used by the MPEG multiplexers
3  *****************************************************************************
4  * Copyright (C) 2001, 2002 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Eric Petit <titer@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <sys/types.h>
34 #include <sys/stat.h>
35 #include <errno.h>
36 #include <fcntl.h>
37
38 #include <vlc_common.h>
39 #include <vlc_sout.h>
40 #include <vlc_block.h>
41
42 #ifdef HAVE_UNISTD_H
43 #   include <unistd.h>
44 #endif
45
46 #include <vlc_codecs.h>
47 #include "pes.h"
48 #include "bits.h"
49
50 /** PESHeader, write a pes header
51  * \param i_es_size length of payload data. (Must be < PES_PAYLOAD_SIZE_MAX
52  *                  unless the conditions for unbounded PES packets are met)
53  * \param i_stream_id stream id as follows:
54  *                     - 0x00   - 0xff   : normal stream_id as per Table 2-18
55  *                     - 0xfd00 - 0xfd7f : stream_id_extension = low 7 bits
56  *                                         (stream_id = PES_EXTENDED_STREAM_ID)
57  *                     - 0xbd00 - 0xbdff : private_id = low 8 bits
58  *                                         (stream_id = PES_PRIVATE_STREAM)
59  * \param i_header_size length of padding data to insert into PES packet
60  *                      header in bytes.
61  */
62 static inline int PESHeader( uint8_t *p_hdr, mtime_t i_pts, mtime_t i_dts,
63                              int i_es_size, es_format_t *p_fmt,
64                              int i_stream_id, bool b_mpeg2,
65                              bool b_data_alignment, int i_header_size )
66 {
67     bits_buffer_t bits;
68     int     i_extra = 0;
69     int i_private_id = -1;
70     int i_stream_id_extension = 0;
71
72     /* HACK for private stream 1 in ps */
73     if( ( i_stream_id >> 8 ) == PES_PRIVATE_STREAM_1 )
74     {
75         i_private_id = i_stream_id & 0xff;
76         i_stream_id = PES_PRIVATE_STREAM_1;
77         /* For PES_PRIVATE_STREAM_1 there is an extra header after the
78            pes header */
79         /* i_private_id != -1 because TS use 0xbd without private_id */
80         i_extra = 1;
81         if( ( i_private_id & 0xf0 ) == 0x80 )
82             i_extra += 3;
83     }
84     else if( ( i_stream_id >> 8 ) == PES_EXTENDED_STREAM_ID )
85     {
86         /* Enable support for extended_stream_id as defined in
87          * ISO/IEC 13818-1:2000/Amd.2:2003 */
88         /* NB, i_extended_stream_id is limited to 7 bits */
89         i_stream_id_extension = i_stream_id & 0x7f;
90         i_stream_id = PES_EXTENDED_STREAM_ID;
91     }
92
93     bits_initwrite( &bits, 50, p_hdr );
94
95     /* add start code */
96     bits_write( &bits, 24, 0x01 );
97     bits_write( &bits, 8, i_stream_id );
98     switch( i_stream_id )
99     {
100         case PES_PROGRAM_STREAM_MAP:
101         case PES_PADDING:
102         case PES_PRIVATE_STREAM_2:
103         case PES_ECM:
104         case PES_EMM:
105         case PES_PROGRAM_STREAM_DIRECTORY:
106         case PES_DSMCC_STREAM:
107         case PES_ITU_T_H222_1_TYPE_E_STREAM:
108             /* add pes data size  */
109             bits_write( &bits, 16, i_es_size );
110             bits_align( &bits );
111             return( bits.i_data );
112
113         default:
114             /* arg, a little more difficult */
115             if( b_mpeg2 )
116             {
117                 int i_pts_dts;
118                 bool b_pes_extension_flag = false;
119
120                 if( i_pts > 0 && i_dts > 0 &&
121                     ( i_pts != i_dts || ( p_fmt->i_cat == VIDEO_ES &&
122                       p_fmt->i_codec != VLC_FOURCC('m','p','g','v') ) ) )
123                 {
124                     i_pts_dts = 0x03;
125                     if ( !i_header_size ) i_header_size = 0xa;
126                 }
127                 else if( i_pts > 0 )
128                 {
129                     i_pts_dts = 0x02;
130                     if ( !i_header_size ) i_header_size = 0x5;
131                 }
132                 else
133                 {
134                     i_pts_dts = 0x00;
135                     if ( !i_header_size ) i_header_size = 0x0;
136                 }
137
138                 if( i_stream_id == PES_EXTENDED_STREAM_ID )
139                 {
140                     b_pes_extension_flag = true;
141                     i_header_size += 1 + 1;
142                 }
143
144                 if( b_pes_extension_flag )
145                 {
146                     i_header_size += 1;
147                 }
148
149                 /* Unbounded streams are only allowed in TS (not PS) and only
150                  * for some ES, eg. MPEG* Video ES or Dirac ES. */
151                 if( i_es_size > PES_PAYLOAD_SIZE_MAX )
152                     bits_write( &bits, 16, 0 ); // size unbounded
153                 else
154                     bits_write( &bits, 16, i_es_size + i_extra + 3
155                                  + i_header_size ); // size
156                 bits_write( &bits, 2, 0x02 ); // mpeg2 id
157                 bits_write( &bits, 2, 0x00 ); // pes scrambling control
158                 bits_write( &bits, 1, 0x00 ); // pes priority
159                 bits_write( &bits, 1, b_data_alignment ); // data alignement indicator
160                 bits_write( &bits, 1, 0x00 ); // copyright
161                 bits_write( &bits, 1, 0x00 ); // original or copy
162
163                 bits_write( &bits, 2, i_pts_dts ); // pts_dts flags
164                 bits_write( &bits, 1, 0x00 ); // escr flags
165                 bits_write( &bits, 1, 0x00 ); // es rate flag
166                 bits_write( &bits, 1, 0x00 ); // dsm trick mode flag
167                 bits_write( &bits, 1, 0x00 ); // additional copy info flag
168                 bits_write( &bits, 1, 0x00 ); // pes crc flag
169                 bits_write( &bits, 1, b_pes_extension_flag );
170                 bits_write( &bits, 8, i_header_size );
171
172                 /* write pts */
173                 if( i_pts_dts & 0x02 )
174                 {
175                     bits_write( &bits, 4, i_pts_dts ); // '0010' or '0011'
176                     bits_write( &bits, 3, i_pts >> 30 );
177                     bits_write( &bits, 1, 0x01 ); // marker
178                     bits_write( &bits, 15, i_pts >> 15 );
179                     bits_write( &bits, 1, 0x01 ); // marker
180                     bits_write( &bits, 15, i_pts );
181                     bits_write( &bits, 1, 0x01 ); // marker
182                     i_header_size -= 0x5;
183                 }
184                 /* write i_dts */
185                 if( i_pts_dts & 0x01 )
186                 {
187                     bits_write( &bits, 4, 0x01 ); // '0001'
188                     bits_write( &bits, 3, i_dts >> 30 );
189                     bits_write( &bits, 1, 0x01 ); // marker
190                     bits_write( &bits, 15, i_dts >> 15 );
191                     bits_write( &bits, 1, 0x01 ); // marker
192                     bits_write( &bits, 15, i_dts );
193                     bits_write( &bits, 1, 0x01 ); // marker
194                     i_header_size -= 0x5;
195                 }
196                 if( b_pes_extension_flag )
197                 {
198                     bits_write( &bits, 1, 0x00 ); // PES_private_data_flag
199                     bits_write( &bits, 1, 0x00 ); // pack_header_field_flag
200                     bits_write( &bits, 1, 0x00 ); // program_packet_sequence_counter_flag
201                     bits_write( &bits, 1, 0x00 ); // P-STD_buffer_flag
202                     bits_write( &bits, 3, 0x07 ); // reserved
203                     bits_write( &bits, 1, 0x01 ); // PES_extension_flag_2
204                     /* skipping unsupported parts: */
205                     /*   PES_private_data */
206                     /*   pack_header */
207                     /*   program_packet_sequence_counter */
208                     /*   P-STD_buffer_flag */
209                     if( i_stream_id == PES_EXTENDED_STREAM_ID )
210                     {
211                         /* PES_extension_2 */
212                         bits_write( &bits, 1, 0x01 ); // marker
213                         bits_write( &bits, 7, 0x01 ); // PES_extension_field_length
214                         bits_write( &bits, 1, 0x01 ); // stream_id_extension_flag
215                         bits_write( &bits, 7, i_stream_id_extension );
216                         i_header_size -= 0x2;
217                     }
218                     i_header_size -= 0x1;
219                 }
220                 while ( i_header_size )
221                 {
222                     bits_write( &bits, 8, 0xff );
223                     i_header_size--;
224                 }
225             }
226             else /* MPEG1 */
227             {
228                 int i_pts_dts;
229
230                 if( i_pts > 0 && i_dts > 0 &&
231                     ( i_pts != i_dts || p_fmt->i_cat == VIDEO_ES ) )
232                 {
233                     bits_write( &bits, 16, i_es_size + i_extra + 10 /* + stuffing */ );
234                     i_pts_dts = 0x03;
235                 }
236                 else if( i_pts > 0 )
237                 {
238                     bits_write( &bits, 16, i_es_size + i_extra + 5 /* + stuffing */ );
239                     i_pts_dts = 0x02;
240                 }
241                 else
242                 {
243                     bits_write( &bits, 16, i_es_size + i_extra + 1 /* + stuffing */);
244                     i_pts_dts = 0x00;
245                 }
246
247                 /* FIXME: Now should be stuffing */
248
249                 /* No STD_buffer_scale and STD_buffer_size */
250
251                 /* write pts */
252                 if( i_pts_dts & 0x02 )
253                 {
254                     bits_write( &bits, 4, i_pts_dts ); // '0010' or '0011'
255                     bits_write( &bits, 3, i_pts >> 30 );
256                     bits_write( &bits, 1, 0x01 ); // marker
257                     bits_write( &bits, 15, i_pts >> 15 );
258                     bits_write( &bits, 1, 0x01 ); // marker
259                     bits_write( &bits, 15, i_pts );
260                     bits_write( &bits, 1, 0x01 ); // marker
261                 }
262                 /* write i_dts */
263                 if( i_pts_dts & 0x01 )
264                 {
265                     bits_write( &bits, 4, 0x01 ); // '0001'
266                     bits_write( &bits, 3, i_dts >> 30 );
267                     bits_write( &bits, 1, 0x01 ); // marker
268                     bits_write( &bits, 15, i_dts >> 15 );
269                     bits_write( &bits, 1, 0x01 ); // marker
270                     bits_write( &bits, 15, i_dts );
271                     bits_write( &bits, 1, 0x01 ); // marker
272                 }
273                 if( !i_pts_dts )
274                 {
275                     bits_write( &bits, 8, 0x0F );
276                 }
277
278             }
279
280             /* now should be stuffing */
281             /* and then pes data */
282
283             bits_align( &bits );
284             if( i_stream_id == PES_PRIVATE_STREAM_1 && i_private_id != -1 )
285             {
286                 bits_write( &bits, 8, i_private_id );
287                 if( ( i_private_id&0xf0 ) == 0x80 )
288                 {
289                     bits_write( &bits, 24, 0 ); // ac3
290                 }
291             }
292             bits_align( &bits );
293             return( bits.i_data );
294     }
295 }
296
297 /** EStoPES, encapsulate an elementary stream block into PES packet(s)
298  * each with a maximal payload size of @i_max_pes_size@.
299  *
300  * In some circumstances, unbounded PES packets are allowed:
301  *  - Transport streams only (NOT programme streams)
302  *  - Only some types of elementary streams (eg MPEG2 video)
303  * It is the responsibility of the caller to enforce these constraints.
304  *
305  * EStoPES will only produce an unbounded PES packet if:
306  *  - ES is VIDEO_ES
307  *  - i_max_pes_size > PES_PAYLOAD_SIZE_MAX
308  *  - length of p_es > PES_PAYLOAD_SIZE_MAX
309  * If the last condition is not met, a single PES packet is produced
310  * which is not unbounded in length.
311  *
312  * \param i_stream_id stream id as follows:
313  *                     - 0x00   - 0xff   : normal stream_id as per Table 2-18
314  *                     - 0xfd00 - 0xfd7f : stream_id_extension = low 7 bits
315  *                                         (stream_id = PES_EXTENDED_STREAM_ID)
316  *                     - 0xbd00 - 0xbdff : private_id = low 8 bits
317  *                                         (stream_id = PES_PRIVATE_STREAM)
318  * \param i_header_size length of padding data to insert into PES packet
319  *                      header in bytes.
320  * \param i_max_pes_size maximum length of each pes packet payload.
321  *                       if zero, uses default maximum.
322  *                       To allow unbounded PES packets in transport stream
323  *                       VIDEO_ES, set to INT_MAX.
324  */
325 int  EStoPES ( sout_instance_t *p_sout, block_t **pp_pes, block_t *p_es,
326                    es_format_t *p_fmt, int i_stream_id,
327                    int b_mpeg2, int b_data_alignment, int i_header_size,
328                    int i_max_pes_size )
329 {
330     block_t *p_pes;
331     mtime_t i_pts, i_dts, i_length;
332
333     uint8_t *p_data;
334     int     i_size;
335
336     uint8_t header[50];     // PES header + extra < 50 (more like 17)
337     int     i_pes_payload;
338     int     i_pes_header;
339
340     int     i_pes_count = 1;
341
342     assert( i_max_pes_size >= 0 );
343     assert( i_header_size >= 0 );
344
345     /* NB, Only video ES may have unbounded length */
346     if( !i_max_pes_size ||
347         ( p_fmt->i_cat != VIDEO_ES && i_max_pes_size > PES_PAYLOAD_SIZE_MAX ) )
348     {
349         i_max_pes_size = PES_PAYLOAD_SIZE_MAX;
350     }
351
352     if( p_fmt->i_codec == VLC_FOURCC( 'm', 'p','4', 'v' ) &&
353         p_es->i_flags & BLOCK_FLAG_TYPE_I )
354     {
355         /* For MPEG4 video, add VOL before I-frames */
356         p_es = block_Realloc( p_es, p_fmt->i_extra, p_es->i_buffer );
357
358         memcpy( p_es->p_buffer, p_fmt->p_extra, p_fmt->i_extra );
359     }
360
361     i_pts = p_es->i_pts <= 0 ? 0 : p_es->i_pts * 9 / 100; // 90000 units clock
362     i_dts = p_es->i_dts <= 0 ? 0 : p_es->i_dts * 9 / 100; // 90000 units clock
363
364     i_size = p_es->i_buffer;
365     p_data = p_es->p_buffer;
366
367     *pp_pes = p_pes = NULL;
368
369 #ifndef NDEBUG
370     memset( header, 0, 50 );
371 #endif
372
373     do
374     {
375         i_pes_payload = __MIN( i_size, i_max_pes_size );
376         i_pes_header  = PESHeader( header, i_pts, i_dts, i_pes_payload,
377                                    p_fmt, i_stream_id, b_mpeg2,
378                                    b_data_alignment, i_header_size );
379         i_dts = 0; // only first PES has a dts/pts
380         i_pts = 0;
381
382         if( p_es )
383         {
384             p_es = block_Realloc( p_es, i_pes_header, p_es->i_buffer );
385             p_data = p_es->p_buffer+i_pes_header;
386             /* reuse p_es for first frame */
387             *pp_pes = p_pes = p_es;
388             /* don't touch i_dts, i_pts, i_length as are already set :) */
389             p_es = NULL;
390         }
391         else
392         {
393             p_pes->p_next = block_New( p_sout, i_pes_header + i_pes_payload );
394             p_pes = p_pes->p_next;
395
396             p_pes->i_dts    = 0;
397             p_pes->i_pts    = 0;
398             p_pes->i_length = 0;
399             if( i_pes_payload > 0 )
400             {
401                 vlc_memcpy( p_pes->p_buffer + i_pes_header, p_data,
402                             i_pes_payload );
403             }
404             i_pes_count++;
405         }
406
407         /* copy header */
408         memcpy( p_pes->p_buffer, header, i_pes_header );
409
410         i_size -= i_pes_payload;
411         p_data += i_pes_payload;
412         p_pes->i_buffer =  i_pes_header + i_pes_payload;
413
414     } while( i_size > 0 );
415
416     /* Now redate all pes */
417     i_dts    = (*pp_pes)->i_dts;
418     i_length = (*pp_pes)->i_length / i_pes_count;
419     for( p_pes = *pp_pes; p_pes != NULL; p_pes = p_pes->p_next )
420     {
421         p_pes->i_dts = i_dts;
422         p_pes->i_length = i_length;
423
424         i_dts += i_length;
425     }
426
427     return 0;
428 }