avformat/dashenc: Added comments
[ffmpeg.git] / libavformat / mms.h
1 /*
2  * MMS protocol common definitions.
3  * Copyright (c) 2010 Zhentan Feng <spyfeng at gmail dot com>
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 #ifndef AVFORMAT_MMS_H
22 #define AVFORMAT_MMS_H
23
24 #include "url.h"
25
26 typedef struct MMSStream {
27     int id;
28 }MMSStream;
29
30 typedef struct MMSContext {
31     URLContext *mms_hd;                  ///< TCP connection handle
32     MMSStream *streams;
33
34     /** Buffer for outgoing packets. */
35     /*@{*/
36     uint8_t *write_out_ptr;              ///< Pointer for writing the buffer.
37     uint8_t out_buffer[512];            ///< Buffer for outgoing packet.
38     /*@}*/
39
40     /** Buffer for incoming packets. */
41     /*@{*/
42     uint8_t in_buffer[65536];            ///< Buffer for incoming packets.
43     uint8_t *read_in_ptr;                ///< Pointer for reading from incoming buffer.
44     int remaining_in_len;                ///< Reading length from incoming buffer.
45     /*@}*/
46
47     /** Internal handling of the ASF header */
48     /*@{*/
49     uint8_t *asf_header;                 ///< Stored ASF header.
50     int asf_header_size;                 ///< Size of stored ASF header.
51     int header_parsed;                   ///< The header has been received and parsed.
52     int asf_packet_len;
53     int asf_header_read_size;
54     /*@}*/
55
56     int stream_num;                      ///< stream numbers.
57     unsigned int nb_streams_allocated;   ///< allocated size of streams
58 } MMSContext;
59
60 int ff_mms_asf_header_parser(MMSContext * mms);
61 int ff_mms_read_data(MMSContext *mms, uint8_t *buf, const int size);
62 int ff_mms_read_header(MMSContext * mms, uint8_t * buf, const int size);
63
64 #endif /* AVFORMAT_MMS_H */