1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
// Copyright (c) 2018-2019, The rav1e contributors. All rights reserved // // This source code is subject to the terms of the BSD 2 Clause License and // the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License // was not distributed with this source code in the LICENSE file, you can // obtain it at www.aomedia.org/license/software. If the Alliance for Open // Media Patent License 1.0 was not distributed with this source code in the // PATENTS file, you can obtain it at www.aomedia.org/license/patent. #![deny(missing_docs)] use crate::api::color::*; use crate::api::config::*; use crate::api::internal::*; use crate::api::util::*; use bitstream_io::*; use crate::encoder::*; use crate::frame::*; use crate::util::Pixel; use std::io; /// The encoder context. /// /// Contains the encoding state. pub struct Context<T: Pixel> { pub(crate) inner: ContextInner<T>, pub(crate) config: EncoderConfig, pub(crate) pool: crate::rayon::ThreadPool, pub(crate) is_flushing: bool, } impl<T: Pixel> Context<T> { /// Allocates and returns a new frame. /// /// # Examples /// /// ``` /// use rav1e::prelude::*; /// /// # fn main() -> Result<(), InvalidConfig> { /// let cfg = Config::default(); /// let ctx: Context<u8> = cfg.new_context()?; /// let frame = ctx.new_frame(); /// # Ok(()) /// # } /// ``` #[inline] pub fn new_frame(&self) -> Frame<T> { Frame::new( self.config.width, self.config.height, self.config.chroma_sampling, ) } /// Sends the frame for encoding. /// /// This method adds the frame into the frame queue and runs the first passes /// of the look-ahead computation. /// /// Passing `None` is equivalent to calling [`flush`]. /// /// # Errors /// /// If this method is called with a frame after the encoder has been flushed /// or the encoder internal limit is hit (`std::i32::MAX` frames) the /// [`EncoderStatus::EnoughData`] error is returned. /// /// # Examples /// /// ``` /// use rav1e::prelude::*; /// /// # fn main() -> Result<(), Box<dyn std::error::Error>> { /// let cfg = Config::default(); /// let mut ctx: Context<u8> = cfg.new_context().unwrap(); /// let f1 = ctx.new_frame(); /// let f2 = f1.clone(); /// let info = FrameParameters { /// frame_type_override: FrameTypeOverride::Key /// }; /// /// // Send the plain frame data /// ctx.send_frame(f1)?; /// // Send the data and the per-frame parameters /// // In this case the frame is forced to be a keyframe. /// ctx.send_frame((f2, info))?; /// // Flush the encoder, it is equivalent to a call to `flush()` /// ctx.send_frame(None)?; /// # Ok(()) /// # } /// ``` /// /// [`flush`]: #method.flush /// [`EncoderStatus::EnoughData`]: enum.EncoderStatus.html#variant.EnoughData #[inline] pub fn send_frame<F>(&mut self, frame: F) -> Result<(), EncoderStatus> where F: IntoFrame<T>, { let (frame, params) = frame.into(); if frame.is_none() { if self.is_flushing { return Ok(()); } self.inner.limit = Some(self.inner.frame_count); self.is_flushing = true; } else if self.is_flushing { return Err(EncoderStatus::EnoughData); // The rate control can process at most std::i32::MAX frames } else if self.inner.frame_count == std::i32::MAX as u64 - 1 { self.inner.limit = Some(self.inner.frame_count); self.is_flushing = true; } let inner = &mut self.inner; let pool = &mut self.pool; pool.install(|| inner.send_frame(frame, params)) } /// Returns the first-pass data of a two-pass encode for the frame that was /// just encoded. /// /// This should be called BEFORE every call to [`receive_packet`] (including /// the very first one), even if no packet was produced by the last call to /// [`receive_packet`], if any (i.e., [`EncoderStatus::Encoded`] was /// returned). It needs to be called once more after /// [`EncoderStatus::LimitReached`] is returned, to retrieve the header that /// should be written to the front of the stats file (overwriting the /// placeholder header that was emitted at the start of encoding). /// /// It is still safe to call this function when [`receive_packet`] returns /// any other error. It will return `None` instead of returning a duplicate /// copy of the previous frame's data. /// /// [`receive_packet`]: #method.receive_packet /// [`EncoderStatus::Encoded`]: enum.EncoderStatus.html#variant.Encoded /// [`EncoderStatus::LimitReached`]: /// enum.EncoderStatus.html#variant.LimitReached #[inline] pub fn twopass_out(&mut self) -> Option<&[u8]> { let params = self .inner .rc_state .get_twopass_out_params(&self.inner, self.inner.output_frameno); self.inner.rc_state.twopass_out(params) } /// Returns the number of bytes of the stats file needed before the next /// frame of the second pass in a two-pass encode can be encoded. /// /// This is a lower bound (more might be required), but if `0` is returned, /// then encoding can proceed. This is just a hint to the application, and /// does not need to be called for encoding the second pass to work, so long /// as the application continues to provide more data to [`twopass_in`] in a /// loop until [`twopass_in`] returns `0`. /// /// [`twopass_in`]: #method.twopass_in #[inline] pub fn twopass_bytes_needed(&mut self) -> usize { self.inner.rc_state.twopass_in(None).unwrap_or(0) } /// Provides the stats data produced in the first pass of a two-pass encode /// to the second pass. /// /// On success this returns the number of bytes of the data which were /// consumed. When encoding the second pass of a two-pass encode, this should /// be called repeatedly in a loop before every call to [`receive_packet`] /// (including the very first one) until no bytes are consumed, or until /// [`twopass_bytes_needed`] returns `0`. /// /// [`receive_packet`]: #method.receive_packet /// [`twopass_bytes_needed`]: #method.twopass_bytes_needed #[inline] pub fn twopass_in(&mut self, buf: &[u8]) -> Result<usize, EncoderStatus> { self.inner.rc_state.twopass_in(Some(buf)).or(Err(EncoderStatus::Failure)) } /// Encodes the next frame and returns the encoded data. /// /// This method is where the main encoding work is done. /// /// # Examples /// /// Encoding a single frame: /// /// ``` /// use rav1e::prelude::*; /// /// # fn main() -> Result<(), Box<dyn std::error::Error>> { /// let cfg = Config::default(); /// let mut ctx: Context<u8> = cfg.new_context()?; /// let frame = ctx.new_frame(); /// /// ctx.send_frame(frame)?; /// ctx.flush(); /// /// loop { /// match ctx.receive_packet() { /// Ok(packet) => { /* Mux the packet. */ }, /// Err(EncoderStatus::Encoded) => (), /// Err(EncoderStatus::LimitReached) => break, /// Err(err) => Err(err)?, /// } /// } /// # Ok(()) /// # } /// ``` /// /// Encoding a sequence of frames: /// /// ``` /// use std::sync::Arc; /// use rav1e::prelude::*; /// /// fn encode_frames( /// ctx: &mut Context<u8>, /// mut frames: impl Iterator<Item=Frame<u8>> /// ) -> Result<(), EncoderStatus> { /// // This is a slightly contrived example, intended to showcase the /// // various statuses that can be returned from receive_packet(). /// // Assume that, for example, there are a lot of frames in the /// // iterator, which are produced lazily, so you don't want to send /// // them all in at once as to not exhaust the memory. /// loop { /// match ctx.receive_packet() { /// Ok(packet) => { /* Mux the packet. */ }, /// Err(EncoderStatus::Encoded) => { /// // A frame was encoded without emitting a packet. This is /// // normal, just proceed as usual. /// }, /// Err(EncoderStatus::LimitReached) => { /// // All frames have been encoded. Time to break out of the /// // loop. /// break; /// }, /// Err(EncoderStatus::NeedMoreData) => { /// // The encoder has requested additional frames. Push the /// // next frame in, or flush the encoder if there are no /// // frames left (on None). /// ctx.send_frame(frames.next().map(Arc::new))?; /// }, /// Err(EncoderStatus::EnoughData) => { /// // Since we aren't trying to push frames after flushing, /// // this should never happen in this example. /// unreachable!(); /// }, /// Err(EncoderStatus::NotReady) => { /// // We're not doing two-pass encoding, so this can never /// // occur. /// unreachable!(); /// }, /// Err(EncoderStatus::Failure) => { /// return Err(EncoderStatus::Failure); /// }, /// } /// } /// /// Ok(()) /// } /// # fn main() -> Result<(), Box<dyn std::error::Error>> { /// # let mut cfg = Config::default(); /// # // So it runs faster. /// # cfg.enc.width = 16; /// # cfg.enc.height = 16; /// # let mut ctx: Context<u8> = cfg.new_context()?; /// # /// # let frames = vec![ctx.new_frame(); 4].into_iter(); /// # encode_frames(&mut ctx, frames); /// # /// # Ok(()) /// # } /// ``` #[inline] pub fn receive_packet(&mut self) -> Result<Packet<T>, EncoderStatus> { let inner = &mut self.inner; let pool = &mut self.pool; pool.install(|| inner.receive_packet()) } /// Flushes the encoder. /// /// Flushing signals the end of the video. After the encoder has been /// flushed, no additional frames are accepted. #[inline] pub fn flush(&mut self) { self.send_frame(None).unwrap(); } /// Produces a sequence header matching the current encoding context. /// /// Its format is compatible with the AV1 Matroska and ISOBMFF specification. /// Note that the returned header does not include any config OBUs which are /// required for some uses. See [the specification]. /// /// [the specification]: /// https://aomediacodec.github.io/av1-isobmff/#av1codecconfigurationbox-section #[inline] pub fn container_sequence_header(&self) -> Vec<u8> { fn sequence_header_inner(seq: &Sequence) -> io::Result<Vec<u8>> { let mut buf = Vec::new(); { let mut bw = BitWriter::endian(&mut buf, BigEndian); bw.write_bit(true)?; // marker bw.write(7, 1)?; // version bw.write(3, seq.profile)?; bw.write(5, 31)?; // level bw.write_bit(false)?; // tier bw.write_bit(seq.bit_depth > 8)?; // high_bitdepth bw.write_bit(seq.bit_depth == 12)?; // twelve_bit bw.write_bit(seq.bit_depth == 1)?; // monochrome bw.write_bit(seq.chroma_sampling != ChromaSampling::Cs444)?; // chroma_subsampling_x bw.write_bit(seq.chroma_sampling == ChromaSampling::Cs420)?; // chroma_subsampling_y bw.write(2, 0)?; // sample_position bw.write(3, 0)?; // reserved bw.write_bit(false)?; // initial_presentation_delay_present bw.write(4, 0)?; // reserved } Ok(buf) } let seq = Sequence::new(&self.config); sequence_header_inner(&seq).unwrap() } }