]>
Commit | Line | Data |
---|---|---|
1 | //! Demuxer definitions. | |
2 | pub use crate::frame::*; | |
3 | pub use crate::io::byteio::*; | |
4 | pub use crate::options::*; | |
5 | ||
6 | /// A list specifying general demuxing errors. | |
7 | #[derive(Debug,Clone,Copy,PartialEq)] | |
8 | #[allow(dead_code)] | |
9 | pub enum DemuxerError { | |
10 | /// Reader got to end of stream. | |
11 | EOF, | |
12 | /// Demuxer encountered empty container. | |
13 | NoSuchInput, | |
14 | /// Demuxer encountered invalid input data. | |
15 | InvalidData, | |
16 | /// Data reading error. | |
17 | IOError, | |
18 | /// Feature is not implemented. | |
19 | NotImplemented, | |
20 | /// Allocation failed. | |
21 | MemoryError, | |
22 | /// The operation should be repeated. | |
23 | TryAgain, | |
24 | /// Seeking failed. | |
25 | SeekError, | |
26 | /// Operation cannot succeed in principle (e.g. seeking in a format not supporting seeking). | |
27 | NotPossible, | |
28 | } | |
29 | ||
30 | /// A specialised `Result` type for demuxing operations. | |
31 | pub type DemuxerResult<T> = Result<T, DemuxerError>; | |
32 | ||
33 | /// A trait for demuxing operations. | |
34 | pub trait DemuxCore<'a>: NAOptionHandler { | |
35 | /// Opens the input stream, reads required headers and prepares everything for packet demuxing. | |
36 | fn open(&mut self, strmgr: &mut StreamManager, seek_idx: &mut SeekIndex) -> DemuxerResult<()>; | |
37 | /// Demuxes a packet. | |
38 | fn get_frame(&mut self, strmgr: &mut StreamManager) -> DemuxerResult<NAPacket>; | |
39 | /// Seeks to the requested time. | |
40 | fn seek(&mut self, time: NATimePoint, seek_idx: &SeekIndex) -> DemuxerResult<()>; | |
41 | } | |
42 | ||
43 | /// An auxiliary trait to make bytestream reader read packet data. | |
44 | pub trait NAPacketReader { | |
45 | /// Reads input and constructs a packet containing it. | |
46 | fn read_packet(&mut self, str: NAStreamRef, ts: NATimeInfo, keyframe: bool, size: usize) -> DemuxerResult<NAPacket>; | |
47 | /// Reads input into already existing packet. | |
48 | fn fill_packet(&mut self, pkt: &mut NAPacket) -> DemuxerResult<()>; | |
49 | } | |
50 | ||
51 | impl<'a> NAPacketReader for ByteReader<'a> { | |
52 | fn read_packet(&mut self, str: NAStreamRef, ts: NATimeInfo, kf: bool, size: usize) -> DemuxerResult<NAPacket> { | |
53 | let mut buf: Vec<u8> = Vec::with_capacity(size); | |
54 | if buf.capacity() < size { return Err(DemuxerError::MemoryError); } | |
55 | buf.resize(size, 0); | |
56 | self.read_buf(buf.as_mut_slice())?; | |
57 | let pkt = NAPacket::new(str, ts, kf, buf); | |
58 | Ok(pkt) | |
59 | } | |
60 | fn fill_packet(&mut self, pkt: &mut NAPacket) -> DemuxerResult<()> { | |
61 | let mut refbuf = pkt.get_buffer(); | |
62 | let buf = refbuf.as_mut().unwrap(); | |
63 | self.read_buf(buf.as_mut_slice())?; | |
64 | Ok(()) | |
65 | } | |
66 | } | |
67 | ||
68 | /// An auxiliary structure for operations with individual streams inside the container. | |
69 | #[derive(Default)] | |
70 | pub struct StreamManager { | |
71 | streams: Vec<NAStreamRef>, | |
72 | ignored: Vec<bool>, | |
73 | no_ign: bool, | |
74 | } | |
75 | ||
76 | impl StreamManager { | |
77 | /// Constructs a new instance of `StreamManager`. | |
78 | pub fn new() -> Self { | |
79 | StreamManager { | |
80 | streams: Vec::new(), | |
81 | ignored: Vec::new(), | |
82 | no_ign: true, | |
83 | } | |
84 | } | |
85 | /// Returns stream iterator. | |
86 | pub fn iter(&self) -> StreamIter { StreamIter::new(&self.streams) } | |
87 | ||
88 | /// Adds a new stream. | |
89 | pub fn add_stream(&mut self, stream: NAStream) -> Option<usize> { | |
90 | let stream_num = self.streams.len(); | |
91 | let mut str = stream.clone(); | |
92 | str.set_num(stream_num); | |
93 | self.streams.push(str.into_ref()); | |
94 | self.ignored.push(false); | |
95 | Some(stream_num) | |
96 | } | |
97 | /// Adds a new stream from reference-counted object. | |
98 | pub fn add_stream_ref(&mut self, stream: NAStreamRef) -> Option<usize> { | |
99 | let stream_num = self.streams.len(); | |
100 | self.streams.push(stream); | |
101 | self.ignored.push(false); | |
102 | Some(stream_num) | |
103 | } | |
104 | /// Returns stream with the requested index. | |
105 | pub fn get_stream(&self, idx: usize) -> Option<NAStreamRef> { | |
106 | if idx < self.streams.len() { | |
107 | Some(self.streams[idx].clone()) | |
108 | } else { | |
109 | None | |
110 | } | |
111 | } | |
112 | /// Returns stream with the requested stream ID. | |
113 | pub fn get_stream_by_id(&self, id: u32) -> Option<NAStreamRef> { | |
114 | for i in 0..self.streams.len() { | |
115 | if self.streams[i].get_id() == id { | |
116 | return Some(self.streams[i].clone()); | |
117 | } | |
118 | } | |
119 | None | |
120 | } | |
121 | /// Returns the number of known streams. | |
122 | pub fn get_num_streams(&self) -> usize { self.streams.len() } | |
123 | /// Reports whether the stream is marked as ignored. | |
124 | pub fn is_ignored(&self, idx: usize) -> bool { | |
125 | if self.no_ign { | |
126 | true | |
127 | } else if idx < self.ignored.len() { | |
128 | self.ignored[idx] | |
129 | } else { | |
130 | false | |
131 | } | |
132 | } | |
133 | /// Reports whether the stream with certain ID is marked as ignored. | |
134 | pub fn is_ignored_id(&self, id: u32) -> bool { | |
135 | for i in 0..self.streams.len() { | |
136 | if self.streams[i].get_id() == id { | |
137 | return self.ignored[i]; | |
138 | } | |
139 | } | |
140 | false | |
141 | } | |
142 | /// Marks requested stream as ignored. | |
143 | pub fn set_ignored(&mut self, idx: usize) { | |
144 | if idx < self.ignored.len() { | |
145 | self.ignored[idx] = true; | |
146 | self.no_ign = false; | |
147 | } | |
148 | } | |
149 | /// Clears the ignored mark for the requested stream. | |
150 | pub fn set_unignored(&mut self, idx: usize) { | |
151 | if idx < self.ignored.len() { | |
152 | self.ignored[idx] = false; | |
153 | } | |
154 | } | |
155 | } | |
156 | ||
157 | /// Stream iterator. | |
158 | pub struct StreamIter<'a> { | |
159 | streams: &'a [NAStreamRef], | |
160 | pos: usize, | |
161 | } | |
162 | ||
163 | impl<'a> StreamIter<'a> { | |
164 | /// Constructs a new instance of `StreamIter`. | |
165 | pub fn new(streams: &'a [NAStreamRef]) -> Self { | |
166 | StreamIter { streams, pos: 0 } | |
167 | } | |
168 | } | |
169 | ||
170 | impl<'a> Iterator for StreamIter<'a> { | |
171 | type Item = NAStreamRef; | |
172 | ||
173 | fn next(&mut self) -> Option<Self::Item> { | |
174 | if self.pos >= self.streams.len() { return None; } | |
175 | let ret = self.streams[self.pos].clone(); | |
176 | self.pos += 1; | |
177 | Some(ret) | |
178 | } | |
179 | } | |
180 | ||
181 | /// Seeking modes. | |
182 | #[derive(Clone,Copy,PartialEq)] | |
183 | pub enum SeekIndexMode { | |
184 | /// No seeking index present. | |
185 | None, | |
186 | /// Seeking index is present. | |
187 | Present, | |
188 | /// Seeking index should be constructed by the demuxer if possible. | |
189 | Automatic, | |
190 | } | |
191 | ||
192 | impl Default for SeekIndexMode { | |
193 | fn default() -> Self { SeekIndexMode::None } | |
194 | } | |
195 | ||
196 | /// A structure holding seeking information. | |
197 | #[derive(Clone,Copy,Default)] | |
198 | pub struct SeekEntry { | |
199 | /// Time in milliseconds. | |
200 | pub time: u64, | |
201 | /// PTS | |
202 | pub pts: u64, | |
203 | /// Position in file. | |
204 | pub pos: u64, | |
205 | } | |
206 | ||
207 | /// Seeking information for individual streams. | |
208 | #[derive(Clone)] | |
209 | pub struct StreamSeekInfo { | |
210 | /// Stream ID. | |
211 | pub id: u32, | |
212 | /// Index is present. | |
213 | pub filled: bool, | |
214 | /// Packet seeking information. | |
215 | pub entries: Vec<SeekEntry>, | |
216 | } | |
217 | ||
218 | impl StreamSeekInfo { | |
219 | /// Constructs a new `StreamSeekInfo` instance. | |
220 | pub fn new(id: u32) -> Self { | |
221 | Self { | |
222 | id, | |
223 | filled: false, | |
224 | entries: Vec::new(), | |
225 | } | |
226 | } | |
227 | /// Adds new seeking point. | |
228 | pub fn add_entry(&mut self, entry: SeekEntry) { | |
229 | self.entries.push(entry); | |
230 | } | |
231 | /// Searches for an appropriate seek position before requested time. | |
232 | pub fn find_pos(&self, time: NATimePoint) -> Option<SeekEntry> { | |
233 | if time == NATimePoint::None { | |
234 | return None; | |
235 | } | |
236 | if !self.entries.is_empty() { | |
237 | // todo something faster like binary search | |
238 | let mut cand = None; | |
239 | for entry in self.entries.iter() { | |
240 | match time { | |
241 | NATimePoint::Milliseconds(ms) => { | |
242 | if entry.time <= ms { | |
243 | cand = Some(*entry); | |
244 | } else { | |
245 | break; | |
246 | } | |
247 | }, | |
248 | NATimePoint::PTS(pts) => { | |
249 | if entry.pts <= pts { | |
250 | cand = Some(*entry); | |
251 | } else { | |
252 | break; | |
253 | } | |
254 | }, | |
255 | NATimePoint::None => unreachable!(), | |
256 | }; | |
257 | } | |
258 | cand | |
259 | } else { | |
260 | None | |
261 | } | |
262 | } | |
263 | } | |
264 | ||
265 | /// Structure for holding seeking point search results. | |
266 | #[derive(Clone,Copy,Default)] | |
267 | pub struct SeekIndexResult { | |
268 | /// Packet PTS. | |
269 | pub pts: u64, | |
270 | /// Position in file. | |
271 | pub pos: u64, | |
272 | /// Stream ID. | |
273 | pub str_id: u32, | |
274 | } | |
275 | ||
276 | /// Seek information for the whole container. | |
277 | #[derive(Default)] | |
278 | pub struct SeekIndex { | |
279 | /// Seek information for individual streams. | |
280 | pub seek_info: Vec<StreamSeekInfo>, | |
281 | /// Seeking index mode. | |
282 | pub mode: SeekIndexMode, | |
283 | /// Ignore index flag. | |
284 | pub skip_index: bool, | |
285 | } | |
286 | ||
287 | impl SeekIndex { | |
288 | /// Constructs a new `SeekIndex` instance. | |
289 | pub fn new() -> Self { Self::default() } | |
290 | pub fn add_stream(&mut self, id: u32) -> usize { | |
291 | let ret = self.stream_id_to_index(id); | |
292 | if ret.is_none() { | |
293 | self.seek_info.push(StreamSeekInfo::new(id)); | |
294 | self.seek_info.len() - 1 | |
295 | } else { | |
296 | ret.unwrap() | |
297 | } | |
298 | } | |
299 | /// Adds a new stream to the index. | |
300 | pub fn stream_id_to_index(&self, id: u32) -> Option<usize> { | |
301 | for (idx, str) in self.seek_info.iter().enumerate() { | |
302 | if str.id == id { | |
303 | return Some(idx); | |
304 | } | |
305 | } | |
306 | None | |
307 | } | |
308 | /// Returns stream reference for provided stream ID. | |
309 | pub fn get_stream_index(&mut self, id: u32) -> Option<&mut StreamSeekInfo> { | |
310 | for str in self.seek_info.iter_mut() { | |
311 | if str.id == id { | |
312 | return Some(str); | |
313 | } | |
314 | } | |
315 | None | |
316 | } | |
317 | /// Adds seeking information to the index. | |
318 | pub fn add_entry(&mut self, id: u32, entry: SeekEntry) { | |
319 | let mut idx = self.stream_id_to_index(id); | |
320 | if idx.is_none() { | |
321 | idx = Some(self.add_stream(id)); | |
322 | } | |
323 | self.seek_info[idx.unwrap()].add_entry(entry); | |
324 | self.seek_info[idx.unwrap()].filled = true; | |
325 | } | |
326 | /// Searches for a seek position before requested time. | |
327 | pub fn find_pos(&self, time: NATimePoint) -> Option<SeekIndexResult> { | |
328 | let mut cand = None; | |
329 | for str in self.seek_info.iter() { | |
330 | if !str.filled { continue; } | |
331 | let res = str.find_pos(time); | |
332 | if res.is_none() { continue; } | |
333 | let res = res.unwrap(); | |
334 | if cand.is_none() { | |
335 | cand = Some(SeekIndexResult { pts: res.pts, pos: res.pos, str_id: str.id }); | |
336 | } else if let Some(entry) = cand { | |
337 | if res.pos < entry.pos { | |
338 | cand = Some(SeekIndexResult { pts: res.pts, pos: res.pos, str_id: str.id }); | |
339 | } | |
340 | } | |
341 | } | |
342 | cand | |
343 | } | |
344 | } | |
345 | ||
346 | /// Demuxer structure with auxiliary data. | |
347 | pub struct Demuxer<'a> { | |
348 | dmx: Box<dyn DemuxCore<'a> + 'a>, | |
349 | streams: StreamManager, | |
350 | seek_idx: SeekIndex, | |
351 | } | |
352 | ||
353 | impl<'a> Demuxer<'a> { | |
354 | /// Constructs a new `Demuxer` instance. | |
355 | fn new(dmx: Box<dyn DemuxCore<'a> + 'a>, str: StreamManager, seek_idx: SeekIndex) -> Self { | |
356 | Demuxer { | |
357 | dmx, | |
358 | streams: str, | |
359 | seek_idx, | |
360 | } | |
361 | } | |
362 | /// Returns a stream reference by its number. | |
363 | pub fn get_stream(&self, idx: usize) -> Option<NAStreamRef> { | |
364 | self.streams.get_stream(idx) | |
365 | } | |
366 | /// Returns a stream reference by its ID. | |
367 | pub fn get_stream_by_id(&self, id: u32) -> Option<NAStreamRef> { | |
368 | self.streams.get_stream_by_id(id) | |
369 | } | |
370 | /// Reports the total number of streams. | |
371 | pub fn get_num_streams(&self) -> usize { | |
372 | self.streams.get_num_streams() | |
373 | } | |
374 | /// Returns a reference to the internal stream manager. | |
375 | pub fn get_stream_manager(&self) -> &StreamManager { | |
376 | &self.streams | |
377 | } | |
378 | /// Returns an iterator over streams. | |
379 | pub fn get_streams(&self) -> StreamIter { | |
380 | self.streams.iter() | |
381 | } | |
382 | /// Returns 'ignored' marker for requested stream. | |
383 | pub fn is_ignored_stream(&self, idx: usize) -> bool { | |
384 | self.streams.is_ignored(idx) | |
385 | } | |
386 | /// Sets 'ignored' marker for requested stream. | |
387 | pub fn set_ignored_stream(&mut self, idx: usize) { | |
388 | self.streams.set_ignored(idx) | |
389 | } | |
390 | /// Clears 'ignored' marker for requested stream. | |
391 | pub fn set_unignored_stream(&mut self, idx: usize) { | |
392 | self.streams.set_unignored(idx) | |
393 | } | |
394 | ||
395 | /// Demuxes a new packet from the container. | |
396 | pub fn get_frame(&mut self) -> DemuxerResult<NAPacket> { | |
397 | loop { | |
398 | let res = self.dmx.get_frame(&mut self.streams); | |
399 | if self.streams.no_ign || res.is_err() { return res; } | |
400 | let res = res.unwrap(); | |
401 | let idx = res.get_stream().get_num(); | |
402 | if !self.is_ignored_stream(idx) { | |
403 | return Ok(res); | |
404 | } | |
405 | } | |
406 | } | |
407 | /// Seeks to the requested time if possible. | |
408 | pub fn seek(&mut self, time: NATimePoint) -> DemuxerResult<()> { | |
409 | if self.seek_idx.skip_index { | |
410 | return Err(DemuxerError::NotPossible); | |
411 | } | |
412 | self.dmx.seek(time, &self.seek_idx) | |
413 | } | |
414 | /// Returns internal seek index. | |
415 | pub fn get_seek_index(&self) -> &SeekIndex { | |
416 | &self.seek_idx | |
417 | } | |
418 | } | |
419 | ||
420 | impl<'a> NAOptionHandler for Demuxer<'a> { | |
421 | fn get_supported_options(&self) -> &[NAOptionDefinition] { | |
422 | self.dmx.get_supported_options() | |
423 | } | |
424 | fn set_options(&mut self, options: &[NAOption]) { | |
425 | self.dmx.set_options(options); | |
426 | } | |
427 | fn query_option_value(&self, name: &str) -> Option<NAValue> { | |
428 | self.dmx.query_option_value(name) | |
429 | } | |
430 | } | |
431 | ||
432 | impl From<ByteIOError> for DemuxerError { | |
433 | fn from(_: ByteIOError) -> Self { DemuxerError::IOError } | |
434 | } | |
435 | ||
436 | /// The trait for creating demuxers. | |
437 | pub trait DemuxerCreator { | |
438 | /// Creates new demuxer instance that will use `ByteReader` source as an input. | |
439 | fn new_demuxer<'a>(&self, br: &'a mut ByteReader<'a>) -> Box<dyn DemuxCore<'a> + 'a>; | |
440 | /// Returns the name of current demuxer creator (equal to the container name it can demux). | |
441 | fn get_name(&self) -> &'static str; | |
442 | } | |
443 | ||
444 | /// Creates demuxer for a provided bytestream. | |
445 | pub fn create_demuxer<'a>(dmxcr: &DemuxerCreator, br: &'a mut ByteReader<'a>) -> DemuxerResult<Demuxer<'a>> { | |
446 | let mut dmx = dmxcr.new_demuxer(br); | |
447 | let mut str = StreamManager::new(); | |
448 | let mut seek_idx = SeekIndex::new(); | |
449 | dmx.open(&mut str, &mut seek_idx)?; | |
450 | Ok(Demuxer::new(dmx, str, seek_idx)) | |
451 | } | |
452 | ||
453 | /// List of registered demuxers. | |
454 | #[derive(Default)] | |
455 | pub struct RegisteredDemuxers { | |
456 | dmxs: Vec<&'static DemuxerCreator>, | |
457 | } | |
458 | ||
459 | impl RegisteredDemuxers { | |
460 | /// Constructs a new `RegisteredDemuxers` instance. | |
461 | pub fn new() -> Self { | |
462 | Self { dmxs: Vec::new() } | |
463 | } | |
464 | /// Registers a new demuxer. | |
465 | pub fn add_demuxer(&mut self, dmx: &'static DemuxerCreator) { | |
466 | self.dmxs.push(dmx); | |
467 | } | |
468 | /// Searches for a demuxer that supports requested container format. | |
469 | pub fn find_demuxer(&self, name: &str) -> Option<&DemuxerCreator> { | |
470 | for &dmx in self.dmxs.iter() { | |
471 | if dmx.get_name() == name { | |
472 | return Some(dmx); | |
473 | } | |
474 | } | |
475 | None | |
476 | } | |
477 | /// Provides an iterator over currently registered demuxers. | |
478 | pub fn iter(&self) -> std::slice::Iter<&DemuxerCreator> { | |
479 | self.dmxs.iter() | |
480 | } | |
481 | } |