FFmpeg
nut.h
Go to the documentation of this file.
1 /*
2  * "NUT" Container Format (de)muxer
3  * Copyright (c) 2006 Michael Niedermayer
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 #ifndef AVFORMAT_NUT_H
23 #define AVFORMAT_NUT_H
24 
25 #include "avformat.h"
26 #include "internal.h"
27 #include "metadata.h"
28 
29 #define MAIN_STARTCODE (0x7A561F5F04ADULL + (((uint64_t)('N'<<8) + 'M')<<48))
30 #define STREAM_STARTCODE (0x11405BF2F9DBULL + (((uint64_t)('N'<<8) + 'S')<<48))
31 #define SYNCPOINT_STARTCODE (0xE4ADEECA4569ULL + (((uint64_t)('N'<<8) + 'K')<<48))
32 #define INDEX_STARTCODE (0xDD672F23E64EULL + (((uint64_t)('N'<<8) + 'X')<<48))
33 #define INFO_STARTCODE (0xAB68B596BA78ULL + (((uint64_t)('N'<<8) + 'I')<<48))
34 
35 #define ID_STRING "nut/multimedia container\0"
36 
37 #define MAX_DISTANCE (1024*32-1)
38 
39 #define NUT_MAX_VERSION 4
40 #define NUT_STABLE_VERSION 3
41 #define NUT_MIN_VERSION 2
42 
43 typedef enum{
44  FLAG_KEY = 1, // if set, frame is keyframe
45  FLAG_EOR = 2, // if set, stream has no relevance on presentation. (EOR)
46  FLAG_CODED_PTS = 8, // if set, coded_pts is in the frame header
47  FLAG_STREAM_ID = 16, // if set, stream_id is coded in the frame header
48  FLAG_SIZE_MSB = 32, // if set, data_size_msb is at frame header, otherwise data_size_msb is 0
49  FLAG_CHECKSUM = 64, // if set, the frame header contains a checksum
50  FLAG_RESERVED = 128, // if set, reserved_count is coded in the frame header
51  FLAG_SM_DATA = 256, // if set, side / meta data is stored in the frame header.
52  FLAG_HEADER_IDX =1024, // If set, header_idx is coded in the frame header.
53  FLAG_MATCH_TIME =2048, // If set, match_time_delta is coded in the frame header
54  FLAG_CODED =4096, // if set, coded_flags are stored in the frame header
55  FLAG_INVALID =8192, // if set, frame_code is invalid
56 } Flag;
57 
58 typedef struct Syncpoint {
59  uint64_t pos;
60  uint64_t back_ptr;
61 // uint64_t global_key_pts;
62  int64_t ts;
63 } Syncpoint;
64 
65 typedef struct FrameCode {
66  uint16_t flags;
67  uint8_t stream_id;
68  uint16_t size_mul;
69  uint16_t size_lsb;
70  int16_t pts_delta;
71  uint8_t reserved_count;
72  uint8_t header_idx;
73 } FrameCode;
74 
75 typedef struct StreamContext {
78  int64_t last_pts;
83  int decode_delay; //FIXME duplicate of has_b_frames
84  int64_t *keyframe_pts;
86 
87 typedef struct ChapterContext {
90 
91 typedef struct NUTContext {
92  const AVClass *av_class;
94 // int written_packet_size;
95 // int64_t packet_start;
97  uint8_t header_len[128];
98  const uint8_t *header[128];
99  uint64_t next_startcode; // stores the next startcode if it has already been parsed but the stream is not seekable
102  unsigned int max_distance;
103  unsigned int time_base_count;
109  int sp_count;
111  int64_t max_pts;
113 #define NUT_BROADCAST 1 // use extended syncpoints
114 #define NUT_PIPE 2 // do not write syncpoints
115  int flags;
116  int version; // version currently in use
118 } NUTContext;
119 
120 extern const AVCodecTag ff_nut_subtitle_tags[];
121 extern const AVCodecTag ff_nut_video_tags[];
122 extern const AVCodecTag ff_nut_audio_tags[];
123 extern const AVCodecTag ff_nut_audio_extra_tags[];
124 extern const AVCodecTag ff_nut_data_tags[];
125 
126 extern const AVCodecTag * const ff_nut_codec_tags[];
127 
128 typedef struct Dispositions {
129  char str[9];
130  int flag;
131 } Dispositions;
132 
133 void ff_nut_reset_ts(NUTContext *nut, AVRational time_base, int64_t val);
134 int64_t ff_lsb2full(StreamContext *stream, int64_t lsb);
135 int ff_nut_sp_pos_cmp(const void *a, const void *b);
136 int ff_nut_sp_pts_cmp(const void *a, const void *b);
137 int ff_nut_add_sp(NUTContext *nut, int64_t pos, int64_t back_ptr, int64_t ts);
138 void ff_nut_free_sp(NUTContext *nut);
139 
140 extern const Dispositions ff_nut_dispositions[];
141 
142 extern const AVMetadataConv ff_nut_metadata_conv[];
143 
144 #endif /* AVFORMAT_NUT_H */
FrameCode::stream_id
uint8_t stream_id
Definition: nut.h:67
ff_nut_codec_tags
const AVCodecTag *const ff_nut_codec_tags[]
Definition: nut.c:250
ChapterContext
Definition: nut.h:87
StreamContext::last_flags
int last_flags
Definition: nut.h:76
NUTContext::time_base_count
unsigned int time_base_count
Definition: nut.h:103
NUTContext::minor_version
int minor_version
Definition: nut.h:117
NUTContext::max_distance
unsigned int max_distance
Definition: nut.h:102
ff_nut_dispositions
const Dispositions ff_nut_dispositions[]
Definition: nut.c:324
FLAG_RESERVED
@ FLAG_RESERVED
Definition: nut.h:50
NUTContext::write_index
int write_index
Definition: nut.h:110
NUTContext::last_syncpoint_pos
int64_t last_syncpoint_pos
Definition: nut.h:104
ff_nut_data_tags
const AVCodecTag ff_nut_data_tags[]
Definition: nut.c:38
b
#define b
Definition: input.c:41
NUTContext::header_len
uint8_t header_len[128]
Definition: nut.h:97
AVMetadataConv
Definition: metadata.h:34
StreamContext::decode_delay
int decode_delay
Definition: nut.h:83
FrameCode::size_lsb
uint16_t size_lsb
Definition: nut.h:69
Syncpoint
Definition: nut.h:58
ff_nut_free_sp
void ff_nut_free_sp(NUTContext *nut)
Definition: nut.c:316
NUTContext::last_resync_pos
int64_t last_resync_pos
Definition: nut.h:105
Syncpoint::back_ptr
uint64_t back_ptr
Definition: nut.h:60
StreamContext::time_base
AVRational * time_base
Definition: nut.h:80
NUTContext::avf
AVFormatContext * avf
Definition: nut.h:93
val
static double val(void *priv, double ch)
Definition: aeval.c:76
NUTContext::header
const uint8_t * header[128]
Definition: nut.h:98
Syncpoint::ts
int64_t ts
Definition: nut.h:62
NUTContext::sp_count
int sp_count
Definition: nut.h:109
NUTContext::header_count
int header_count
Definition: nut.h:106
NUTContext
Definition: nut.h:91
ChapterContext::time_base
AVRational * time_base
Definition: nut.h:88
AVCodecTag
Definition: internal.h:45
FrameCode::reserved_count
uint8_t reserved_count
Definition: nut.h:71
NUTContext::time_base
AVRational * time_base
Definition: nut.h:107
StreamContext::last_pts
int64_t last_pts
Definition: nut.h:78
FrameCode::size_mul
uint16_t size_mul
Definition: nut.h:68
FLAG_INVALID
@ FLAG_INVALID
Definition: nut.h:55
AVFormatContext
Format I/O context.
Definition: avformat.h:1097
internal.h
Dispositions::flag
int flag
Definition: nut.h:130
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
NUTContext::av_class
const AVClass * av_class
Definition: nut.h:92
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
ff_nut_subtitle_tags
const AVCodecTag ff_nut_subtitle_tags[]
Definition: nut.c:28
NUTContext::chapter
ChapterContext * chapter
Definition: nut.h:101
AVTreeNode
Definition: tree.c:26
FLAG_MATCH_TIME
@ FLAG_MATCH_TIME
Definition: nut.h:53
FLAG_CODED
@ FLAG_CODED
Definition: nut.h:54
StreamContext
Definition: transcoding.c:50
StreamContext::time_base_id
int time_base_id
Definition: nut.h:79
FLAG_SIZE_MSB
@ FLAG_SIZE_MSB
Definition: nut.h:48
FrameCode::pts_delta
int16_t pts_delta
Definition: nut.h:70
NUTContext::max_pts_tb
AVRational * max_pts_tb
Definition: nut.h:112
NUTContext::flags
int flags
Definition: nut.h:115
Flag
Flag
Definition: nut.h:43
NUTContext::stream
StreamContext * stream
Definition: nut.h:100
ff_nut_sp_pts_cmp
int ff_nut_sp_pts_cmp(const void *a, const void *b)
Definition: nut.c:279
FrameCode::flags
uint16_t flags
Definition: nut.h:66
a
The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a
Definition: undefined.txt:41
ff_nut_sp_pos_cmp
int ff_nut_sp_pos_cmp(const void *a, const void *b)
Definition: nut.c:273
ff_nut_video_tags
const AVCodecTag ff_nut_video_tags[]
Definition: nut.c:43
ff_nut_audio_tags
const AVCodecTag ff_nut_audio_tags[]
Definition: nut.c:221
NUTContext::version
int version
Definition: nut.h:116
StreamContext::msb_pts_shift
int msb_pts_shift
Definition: nut.h:81
NUTContext::syncpoints
struct AVTreeNode * syncpoints
Definition: nut.h:108
NUTContext::next_startcode
uint64_t next_startcode
Definition: nut.h:99
StreamContext::skip_until_key_frame
int skip_until_key_frame
Definition: nut.h:77
NUTContext::max_pts
int64_t max_pts
Definition: nut.h:111
Dispositions
Definition: nut.h:128
NUTContext::frame_code
FrameCode frame_code[256]
Definition: nut.h:96
StreamContext::keyframe_pts
int64_t * keyframe_pts
Definition: nut.h:84
ff_nut_metadata_conv
const AVMetadataConv ff_nut_metadata_conv[]
Definition: nut.c:334
FLAG_SM_DATA
@ FLAG_SM_DATA
Definition: nut.h:51
Syncpoint::pos
uint64_t pos
Definition: nut.h:59
FLAG_STREAM_ID
@ FLAG_STREAM_ID
Definition: nut.h:47
metadata.h
pos
unsigned int pos
Definition: spdifenc.c:412
avformat.h
FrameCode::header_idx
uint8_t header_idx
Definition: nut.h:72
FLAG_CHECKSUM
@ FLAG_CHECKSUM
Definition: nut.h:49
FLAG_KEY
@ FLAG_KEY
Definition: nut.h:44
Dispositions::str
char str[9]
Definition: nut.h:129
FLAG_HEADER_IDX
@ FLAG_HEADER_IDX
Definition: nut.h:52
ff_lsb2full
int64_t ff_lsb2full(StreamContext *stream, int64_t lsb)
Definition: nut.c:266
FLAG_EOR
@ FLAG_EOR
Definition: nut.h:45
FLAG_CODED_PTS
@ FLAG_CODED_PTS
Definition: nut.h:46
ff_nut_audio_extra_tags
const AVCodecTag ff_nut_audio_extra_tags[]
Definition: nut.c:211
FrameCode
Definition: nut.h:65
ff_nut_add_sp
int ff_nut_add_sp(NUTContext *nut, int64_t pos, int64_t back_ptr, int64_t ts)
Definition: nut.c:285
ff_nut_reset_ts
void ff_nut_reset_ts(NUTContext *nut, AVRational time_base, int64_t val)
Definition: nut.c:255
StreamContext::max_pts_distance
int max_pts_distance
Definition: nut.h:82