poccariswet / apng Goto Github PK

View Code? Open in Web Editor NEW

29.0 4.0 11.0 113 KB

animated png encoder 🦀

License: MIT License

Rust 100.00%

rust rust-lang apng apng-encoder animated-png

apng's Introduction

apng

apng is animated png encoder for Rust, and made in pure Rust.

Example usage

use apng::{Encoder, Frame, PNGImage};
use std::fs::File;
use std::io::BufWriter;
use std::path::Path;

fn main() {
    let files = vec![
        "rust_logo1.png",
        "rust_logo2.png",
        "rust_logo3.png",
        "rust_logo4.png",
        "rust_logo5.png",
        "rust_logo6.png",
    ];

    let mut png_images: Vec<PNGImage> = Vec::new();
    for f in files.iter() {
        png_images.push(apng::load_png(f).unwrap());
    }

    let path = Path::new(r"sample/out.png");
    let mut out = BufWriter::new(File::create(path).unwrap());

    let config = apng::create_config(&png_images, None).unwrap();
    let mut encoder = Encoder::new(&mut out, config).unwrap();
    let frame = Frame {
        delay_num: Some(1),
        delay_den: Some(2),
        ..Default::default()
    };

    match encoder.encode_all(png_images, Some(&frame)) {
        Ok(_n) => println!("success"),
        Err(err) => eprintln!("{}", err),
    }
}

Customize each frame speed

    let mut i = 1;
    for image in png_images.iter() {
        i += 1;
        let frame = Frame {
            delay_num: Some(1),
            delay_den: Some(i), // 2, 3, 4, 5, 6, 7
            ..Default::default()
        };
        encoder.write_frame(image, frame).unwrap();
    }

Sample code is here.

License

MIT

Reference

apng's People

Contributors

Stargazers

Watchers

Forkers

tt-bot-dev marius851000 orhun palladinium chandlerswift phoekz szabgab doridoridoriand mitoma jeekdong mokurin000

apng's Issues

modify examples file

[[example]]
name = "sample1"
path = "examples/***.rs"

[[example]]
name = "sample2"
path = "examples/***.rs"
...

inter-frame compression?

Hi there! I was just wondering if this crate supports inter-frame compression. Lovely library you have here!

suggestion: re-export `png` or `png::{ColorType, FilterType, BitDepth}`

Without re-exporting these type, if a user want to construct an apng::Config manually, they must import png crate with the same minor version. (for 0.x.x crates, cargo allows different micro version of them exist simultaneously.)

validate input png file's height, width

test error

New release (0.3.0?)

There is quite a few changes since the last release:

https://github.com/poccariswet/apng/compare/v0.2.0..master

I think it would be nice to release a new version of apng, preferably 0.3.0.

I would like to coordinate/push this release since I'm a member of this repository now. (Thanks for the invite BTW!)

@poccariswet what do you think?

require APNG structure?

本当に必要かどうか考える、
create_configを、別にもたせばよさそう

`errors` module is private

Hi!

I'm trying to wrap APNGError in my application like this:

/* Custom error implementation */
#[derive(Debug, ThisError)]
pub enum AppError {
    // ...
    #[error("APNG error: `{0}`")]
    Apng(#[from] apng::errors::APNGError),
    // ...
}

But I get the following errors:

error[E0603]: module `errors` is private
  --> src/app.rs:51:21
   |
51 |     Apng(#[from] apng::errors::APNGError),
   |                        ^^^^^^ private module
   |
note: the module `errors` is defined here
  --> /home/orhun/.cargo/registry/src/github.com-1ecc6299db9ec823/apng-0.2.0/src/lib.rs:2:1
   |
2  | mod errors;
   | ^^^^^^^^^^^

error[E0599]: the method `as_dyn_error` exists for reference `&apng::errors::APNGError`, but its trait bounds were not satisfied
  --> src/app.rs:50:10
   |
50 |     #[error("APNG error: `{0}`")]
   |             ^^^^^^^^^^^^^^^^^^^ method cannot be called on `&apng::errors::APNGError` due to unsatisfied trait bounds
   | 
  ::: /home/orhun/.cargo/registry/src/github.com-1ecc6299db9ec823/apng-0.2.0/src/errors.rs:7:1
   |
7  | pub enum APNGError {
   | ------------------
   | |
   | doesn't satisfy `apng::errors::APNGError: AsDynError`
   | doesn't satisfy `apng::errors::APNGError: std::error::Error`
   |
   = note: the following trait bounds were not satisfied:
           `apng::errors::APNGError: std::error::Error`
           which is required by `apng::errors::APNGError: AsDynError`
           `&apng::errors::APNGError: std::error::Error`
           which is required by `&apng::errors::APNGError: AsDynError`

error: aborting due to 2 previous errors

First error is due to errors module being private. Applying the following diff solves the issue:

diff --git a/src/lib.rs b/src/lib.rs
index e0cb98b..ef3a84f 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,5 @@
 mod apng;
-mod errors;
+pub mod errors;
 mod png;
 
 pub use crate::apng::*;

Second error is caused by the failure crate. It's fixed in #21

My question is: can we make errors module public? Or at least make APNGError public? I think it's important to expose these error types for use cases like mine.

What do you think? I'd like to provide a PR about this.