commit 61484db6c7605923285c707392f6558cd967087f Author: jazzfool Date: Wed Aug 19 23:09:24 2020 +1000 initial code diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..96ef6c0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..b6c757b --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "iced_video_player" +version = "0.1.0" +authors = ["jazzfool"] +edition = "2018" + +[dependencies] +iced = { git = "https://github.com/hecrj/iced", features = ["image", "tokio"] } +ffmpeg-next = "4" +tokio = { version = "0.2", features = ["rt-threaded", "macros"] } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..a7e77cb --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..468cd79 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..da19e20 --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# Iced Video Player + +Composable component to play videos in Iced applications. + +## Overview + +Features: +- Load video files from any file path **or URL** (support for streaming over network). +- Non-blocking (off-thread) automatic buffering. +- Programmatic play/pause/jump. +- Small (around 250 lines). + +Limitations (to be hopefully fixed): +- Cannot load in-memory video data. +- Audio playback is not supported. +- Buffering does not support seeking arbitrarily - you can only seek to buffered frame. +- FFmpeg is a heavy dependency and overkill (please recommend similar *cross-platform* Rust libraries). + +The player **does not** come with any surrounding GUI controls, but they should be quite easy to implement should you need them; +- Play/pause/stop can just be buttons. +- Seeking can be a slider with an overlay of the thumbnail at the seek time. +Specifically, the player exposes the buffered frames as images which can be used as thumbnails. +Through the same API, you can show the user the portions of the video have been buffered. + +## Example Usage + +```rust +use iced_video_player::{VideoPlayerMessage, VideoPlayer}; +use iced::{executor, Application, Command, Element, Subscription}; + +fn main() { + App::run(Default::default()); +} + +#[derive(Debug)] +enum Message { + VideoPlayerMessage(VideoPlayerMessage), +} + +struct App { + video: VideoPlayer, +} + +impl Application for App { + type Executor = executor::Default; + type Message = Message; + type Flags = (); + + fn new(_flags: ()) -> (Self, Command) { + ( + App { + video: VideoPlayer::new(&"my_video.mp4").unwrap(), + }, + Command::none(), + ) + } + + fn title(&self) -> String { + String::from("Video Player") + } + + fn update(&mut self, message: Message) -> Command { + match message { + Message::VideoPlayerMessage(msg) => self.video.update(msg).map(Message::VideoPlayerMessage), + } + } + + fn subscription(&self) -> Subscription { + self.video.subscription().map(Message::VideoPlayerMessage) + } + + fn view(&mut self) -> Element { + self.video.view() + } +} +``` + +## License + +Licensed under either + +- [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) +- [MIT](http://opensource.org/licenses/MIT) + +at your option. diff --git a/examples/minimal.rs b/examples/minimal.rs new file mode 100644 index 0000000..a23955c --- /dev/null +++ b/examples/minimal.rs @@ -0,0 +1,70 @@ +use iced::{button, executor, Application, Button, Column, Command, Element, Subscription, Text}; +use iced_video_player::{VideoPlayer, VideoPlayerMessage}; + +fn main() { + App::run(Default::default()); +} + +#[derive(Clone, Debug)] +enum Message { + TogglePause, + VideoPlayerMessage(VideoPlayerMessage), +} + +struct App { + video: VideoPlayer, + pause_btn: button::State, +} + +impl Application for App { + type Executor = executor::Default; + type Message = Message; + type Flags = (); + + fn new(_flags: ()) -> (Self, Command) { + ( + App { + video: VideoPlayer::new( + &std::path::PathBuf::from(file!()) + .parent() + .unwrap() + .join("test.mp4"), + ) + .unwrap(), + pause_btn: Default::default(), + }, + Command::none(), + ) + } + + fn title(&self) -> String { + String::from("Video Player") + } + + fn update(&mut self, message: Message) -> Command { + match message { + Message::TogglePause => { + self.video.paused = !self.video.paused; + + Command::none() + } + Message::VideoPlayerMessage(msg) => { + self.video.update(msg).map(Message::VideoPlayerMessage) + } + } + } + + fn subscription(&self) -> Subscription { + self.video.subscription().map(Message::VideoPlayerMessage) + } + + fn view(&mut self) -> Element { + Column::new() + .push(self.video.view()) + .push( + Button::new(&mut self.pause_btn, Text::new("Toggle Pause")) + .on_press(Message::TogglePause), + ) + .into() + } +} diff --git a/examples/test.mp4 b/examples/test.mp4 new file mode 100644 index 0000000..f5b4b4e Binary files /dev/null and b/examples/test.mp4 differ diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..6eb8b6b --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,247 @@ +use ffmpeg_next as ffmpeg; +use iced::{image, time, Command, Image, Subscription}; +use std::sync::{Arc, Mutex}; +use std::time::Duration; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum VideoPlayerMessage { + NextFrame, + BufferingComplete { + fully_buffered: bool, + packet_count: usize, + }, +} + +/// Video player component which can playback videos from files or URLs. +pub struct VideoPlayer { + /// When the number of remaining buffered frames goes below this number, buffering automatically begins. Default is 100. + pub buffer_threshold: usize, + /// Number of packets (not frames) to read on each buffer. Default is 1000. + pub buffer_size: usize, + /// Whether the video is paused or not. + pub paused: bool, + + frame: Option, + path: std::path::PathBuf, + buffered: Arc>>, + buffering: bool, + fully_buffered: bool, + current_frame: usize, + packet_count: usize, + + framerate: f32, +} + +impl VideoPlayer { + pub fn new>(path: &P) -> Result { + let video_data = VideoData::new(path)?; + let framerate = video_data + .decoder + .frame_rate() + .expect("failed to get framerate"); + + let buffered = Vec::new(); + + Ok(VideoPlayer { + buffer_threshold: 100, + buffer_size: 1000, + paused: false, + + frame: None, + path: path.as_ref().to_owned(), + buffered: Arc::new(Mutex::new(buffered)), + buffering: false, + fully_buffered: false, + current_frame: 0, + packet_count: 0, + + framerate: framerate.0 as f32 / framerate.1 as f32, + }) + } + + fn buffer(&mut self) -> Command { + assert!(self.buffer_size > 0); + + if !self.fully_buffered && !self.buffering { + self.buffering = true; + let path = self.path.clone(); + let buffered = Arc::clone(&self.buffered); + let buffer_size = self.buffer_size; + let prev_packet_count = self.packet_count; + Command::perform( + tokio::spawn(async move { + let mut video_data = + VideoData::new(&path).expect("failed to initialize decoder"); + + let mut packet_count = 0; + for (stream, packet) in video_data.ictx.packets().skip(prev_packet_count) { + if packet_count >= buffer_size { + return (false, prev_packet_count + packet_count - 1); + } + + if stream.index() == video_data.video_stream_index { + video_data.decoder.send_packet(&packet).unwrap(); + let mut decoded = ffmpeg::util::frame::Video::empty(); + while video_data.decoder.receive_frame(&mut decoded).is_ok() { + let mut rgb = ffmpeg::util::frame::Video::empty(); + video_data + .scaler + .run(&decoded, &mut rgb) + .expect("failed to convert frame color space"); + buffered + .lock() + .expect("failed to unlock buffered frames for buffering") + .push(image::Handle::from_pixels( + rgb.width(), + rgb.height(), + rgb.data(0).to_owned(), + )); + } + } + packet_count += 1; + } + + (true, prev_packet_count + packet_count - 1) + }), + |o| { + let (fully_buffered, packet_count) = o.expect("async error"); + VideoPlayerMessage::BufferingComplete { + fully_buffered, + packet_count, + } + }, + ) + } else { + Command::none() + } + } + + /// Whether buffering is currently taking place in another thread. + pub fn is_buffering(&self) -> bool { + self.buffering + } + + /// Returns the number of buffered frames. + pub fn buffered_frames_len(&self) -> usize { + self.buffered + .lock() + .expect("failed to lock buffered frames") + .len() + } + + /// Returns a list of all the buffered frames as Iced image handles. + /// + /// This may block if buffering is occurring. + pub fn buffered_frames(&self) -> Vec { + self.buffered + .lock() + .expect("failed to lock buffered frames") + .clone() // image::Handle data is stored in Arc, so this isn't heavy + } + + /// Seeks to a specified frame number. + /// + /// Panics if `frame >= buffered_frames_len()` + pub fn seek(&mut self, frame: usize) { + assert!(frame < self.buffered_frames_len()); + self.current_frame = frame; + } + + pub fn update(&mut self, message: VideoPlayerMessage) -> Command { + match message { + VideoPlayerMessage::NextFrame => { + if self.paused { + return Command::none(); + } + + let (next_frame, len) = { + let buffered = self + .buffered + .lock() + .expect("failed to unlock buffered frames"); + (buffered.get(self.current_frame).cloned(), buffered.len()) + }; + + if let Some(img) = next_frame { + self.frame = Some(img.clone()); + + if self.current_frame < len - 1 { + self.current_frame += 1; + if len - self.current_frame < self.buffer_threshold { + self.buffer() + } else { + Command::none() + } + } else { + Command::none() + } + } else { + // no more frames + self.buffer() + } + } + VideoPlayerMessage::BufferingComplete { + fully_buffered, + packet_count, + } => { + self.buffering = false; + self.fully_buffered = fully_buffered; + self.packet_count = packet_count; + Command::none() + } + } + } + + pub fn subscription(&self) -> Subscription { + if !self.paused { + time::every(Duration::from_secs_f32(1.0 / self.framerate)) + .map(|_| VideoPlayerMessage::NextFrame) + } else { + Subscription::none() + } + } + + pub fn view(&mut self) -> Image { + Image::new( + self.frame + .clone() + .unwrap_or_else(|| image::Handle::from_pixels(0, 0, vec![])), + ) + .into() + } +} + +struct VideoData { + ictx: ffmpeg::format::context::Input, + video_stream_index: usize, + decoder: ffmpeg::codec::decoder::Video, + scaler: ffmpeg::software::scaling::Context, +} + +impl VideoData { + fn new>(path: &P) -> Result { + ffmpeg::init()?; + + let ictx = ffmpeg::format::input(path)?; + let input = ictx.streams().best(ffmpeg::media::Type::Video).unwrap(); + let video_stream_index = input.index(); + let decoder = input.codec().decoder().video()?; + + let scaler = ffmpeg::software::scaling::Context::get( + decoder.format(), + decoder.width(), + decoder.height(), + ffmpeg::format::Pixel::BGRA, + decoder.width(), + decoder.height(), + ffmpeg::software::scaling::Flags::BILINEAR, + )?; + + Ok(VideoData { + ictx, + video_stream_index, + decoder, + scaler, + }) + } +}