An initial pass at synchronizing with zmwangx's work

.github/workflows/build.yml

@@ -0,0 +1,107 @@
+name: build
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+jobs:
+  build-test-lint-linux:
+    name: Linux - FFmpeg ${{ matrix.ffmpeg_version }} - build, test and lint
+    runs-on: ubuntu-latest
+    container: jrottenberg/ffmpeg:${{ matrix.ffmpeg_version }}-ubuntu
+    strategy:
+      matrix:
+        ffmpeg_version: ["3.4", "4.0", "4.1", "4.2", "4.3"]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: |
+          apt update
+          apt install -y --no-install-recommends clang curl pkg-config
+      - name: Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+      - name: Build
+        run: |
+          cargo build --examples
+      - name: Test
+        run: |
+          cargo test --examples
+      - name: Lint
+        run: |
+          cargo clippy --examples -- -D warnings
+      - name: Check format
+        run: |
+          cargo fmt -- --check
+
+  build-test-lint-macos:
+    name: macOS - FFmpeg latest - build, test and lint
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: |
+          brew install ffmpeg pkg-config
+      - name: Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+      - name: Build
+        run: |
+          cargo build --examples
+      - name: Test
+        run: |
+          cargo test --examples
+      - name: Lint
+        run: |
+          cargo clippy --examples -- -D warnings
+      - name: Check format
+        run: |
+          cargo fmt -- --check
+
+  build-test-lint-windows:
+    name: Windows - FFmpeg ${{ matrix.ffmpeg_version }} - build, test and lint
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        include:
+          - ffmpeg_version: latest
+            ffmpeg_download_url: https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-full-shared.7z
+      fail-fast: false
+    env:
+      FFMPEG_DOWNLOAD_URL: ${{ matrix.ffmpeg_download_url }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: |
+          $VCINSTALLDIR = $(& "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe" -latest -property installationPath)
+          Add-Content $env:GITHUB_ENV "LIBCLANG_PATH=${VCINSTALLDIR}\VC\Tools\LLVM\x64\bin`n"
+          Invoke-WebRequest "${env:FFMPEG_DOWNLOAD_URL}" -OutFile ffmpeg-release-full-shared.7z
+          7z x ffmpeg-release-full-shared.7z
+          mkdir ffmpeg
+          mv ffmpeg-*/* ffmpeg/
+          Add-Content $env:GITHUB_ENV "FFMPEG_DIR=${pwd}\ffmpeg`n"
+      - name: Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+      - name: Build
+        run: |
+          cargo build --examples
+      - name: Test
+        run: |
+          cargo test --examples
+      - name: Lint
+        run: |
+          cargo clippy --examples -- -D warnings
+      - name: Check format
+        run: |
+          cargo fmt -- --check

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: create release
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  release:
+    name: Create release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Generate release notes
+        run: |
+          cat >release_notes.md <<EOF
+          See [CHANGELOG.md](https://github.com/zmwangx/rust-ffmpeg/blob/${GITHUB_REF##*/}/CHANGELOG.md) for changes.
+          EOF
+      - name: Create release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body_path: release_notes.md
+          draft: false
+          prerelease: false

.rustfmt.toml

@@ -0,0 +1,20 @@
+unstable_features = true
+
+max_width = 100
+#hard_tabs = true
+#tab_spaces = 2
+
+merge_derives = false
+merge_imports = true
+
+normalize_comments = true
+normalize_doc_attributes = true
+
+reorder_impl_items = true
+group_imports = "StdExternalCrate"
+
+overflow_delimited_expr = true
+control_brace_style = "ClosingNextLine"
+use_field_init_shorthand = true
+use_try_shorthand = true
+wrap_comments = true

CHANGELOG.md

@@ -0,0 +1,34 @@
+4.4.0 (planned)
+---------------
+
+- crate: `ffmpeg43` feature flag (noop since 4.3.4) has been dropped from default features.
+
+- codec: deprecate APIs based on deprecated (since FFmpeg 3.1) `avcodec_decode_video2()` / `avcodec_decode_audio4()` / `avcodec_encode_video2()` /`avcodec_encode_audio2()` -- `decoder::Video::decode()`, `decode::Audio::decode()`, `encoder::Video::encode()` and `encoder::Audio::decode()`. Users should migrate to `send_packet()` / `send_eof()`, `receive_frame()`, `send_frame()` / `send_eof()`, and `receive_packet()` APIs instead, which are based on the modern send/receive APIs. See [documentation in `libavcodec/avcodec.h`](https://github.com/FFmpeg/FFmpeg/blob/n4.3.1/libavcodec/avcodec.h#L84-L196) for details. (#28)
+
+- codec: fix signature of `Packet::write_interleaved`; previously `Result<bool, Error>`, now `Result<(), Error>`. (#25)
+
+4.3.7
+-----
+
+- codec:  fix codec description potential null ptr issue. (#36)
+
+4.3.6
+-----
+
+- util: fix Windows compatibility due to unavailable errnos. (#30)
+
+4.3.5
+-----
+
+- util: add `util::log` module to expose FFmpeg's logging facilities.
+
+- filter: add method `Source::close()` to expose `av_buffersrc_close`. (#23)
+
+- codec: add new encoding/decoding APIs `send_frame()` / `send_eof()`, `receive_packet()` to `encoder::{Audio, Video}` and `send_packet()` / `send_eof()`, `receive_frame()` to `decoder::{Audio, Video}` based on modern send/receive APIs (instead of `avcodec_decode_video2()` / `avcodec_decode_audio4()` / `avcodec_encode_video2()` /`avcodec_encode_audio2()` which have been deprecated since FFmpeg 3.1). Users should consider switching to the new APIs. See [documentation in `libavcodec/avcodec.h`](https://github.com/FFmpeg/FFmpeg/blob/n4.3.1/libavcodec/avcodec.h#L84-L196) for details. (#28)
+
+- util: introduce new `Error` variant `Error::Other { errno }` for wrapped POSIX error codes (see the `AVERROR` macro in `libavutil/error.h`), and reexport common POSIX error codes under `util::error`. (#24)
+
+4.3.4
+-----
+
+- crate: FFmpeg version detection is now automatic, obseleting feature flags `ffmpeg4`, `ffmpeg41`, `ffmpeg42` and `ffmpeg43`. The flags are kept as noop for now, will be removed in 5.0.

Cargo.toml

@@ -1,19 +1,34 @@
 [package]
-name    = "ffmpeg"
-version = "0.2.0-alpha.2"
+name    = "ffmpeg-next"
+version = "4.4.0-dev"
 build   = "build.rs"
+edition = "2018"
 
-authors = ["meh. <[email protected]>"]
+authors = ["meh. <[email protected]>", "Zhiming Wang <[email protected]>"]
 license = "WTFPL"
 
-description = "Safe FFmpeg wrapper"
-repository  = "https://github.com/meh/rust-ffmpeg"
-keywords    = ["audio", "video"]
+description   = "Safe FFmpeg wrapper (FFmpeg 4 compatible fork of the ffmpeg crate)"
+documentation = "https://docs.rs/ffmpeg-next"
+homepage      = "https://github.com/zmwangx/rust-ffmpeg#readme"
+repository    = "https://github.com/zmwangx/rust-ffmpeg"
+readme        = "README.md"
+keywords      = ["ffmpeg", "multimedia", "video", "audio"]
+categories    = ["multimedia"]
 
 [features]
-default = ["codec", "device", "filter", "format", "resampling", "software-resampling", "software-scaling"]
+default = ["codec", "device", "filter", "format", "software-resampling", "software-scaling"]
+
+# ffmpeg<xy> are obsolete features kept for backward compatibility purposes and
+# don't do anything anymore (equivalents are automatically specified through
+# compile-time detection in ffmpeg-sys). Deprecation plan: all these
+# features will be removed come 5.0.
+ffmpeg43 = []
+ffmpeg42 = []
+ffmpeg41 = []
+ffmpeg4 = []
 
 static = ["ffmpeg-sys/static"]
+# Currently the version built by ffmpeg-sys is 4.1
 build  = ["static", "ffmpeg-sys/build"]
 
 # licensing
@@ -86,14 +101,26 @@ postprocessing      = ["ffmpeg-sys/postproc"]
 software-resampling = ["ffmpeg-sys/swresample"]
 software-scaling    = ["ffmpeg-sys/swscale", "codec"]
 
+# platforms
+rpi = []
+
 [dependencies]
 libc     = "0.2"
-bitflags = "0.9"
+bitflags = "1.2"
+thiserror = "1"
+
+[dependencies.serde]
+version = "1.0.0"
+optional = true
+features = ["derive"]
 
 [dependencies.image]
 version  = "0.12"
 optional = true
 
 [dependencies.ffmpeg-sys]
-version = "3.3"
+version = "4.3.5"
 default-features = false
+
+[patch.crates-io]
+ffmpeg-sys = { path = "../rust-ffmpeg-sys" }

README.md

@@ -0,0 +1,25 @@
+[![crates.io](https://img.shields.io/crates/v/ffmpeg-next.svg)](https://crates.io/crates/ffmpeg-next)
+[![docs.rs](https://docs.rs/ffmpeg-next/badge.svg)](https://docs.rs/ffmpeg-next/)
+[![build](https://github.com/zmwangx/rust-ffmpeg/workflows/build/badge.svg)](https://github.com/zmwangx/rust-ffmpeg/actions)
+
+This is a fork of the abandoned [ffmpeg](https://crates.io/crates/ffmpeg) crate by [meh.](https://github.com/meh/rust-ffmpeg).
+
+Currently supported FFmpeg versions: 3.4.x through 4.3.x.
+
+Build instructions can be found on the [wiki](https://github.com/zmwangx/rust-ffmpeg/wiki/Notes-on-building).
+
+Documentation:
+
+- [docs.rs](https://docs.rs/ffmpeg-next/);
+- [FFmpeg user manual](https://ffmpeg.org/ffmpeg-all.html);
+- [FFmpeg Doxygen](https://ffmpeg.org/doxygen/trunk/).
+
+*Note on upgrading to v4.3.4 or later: v4.3.4 introduced automatic FFmpeg version detection, obsoleting feature flags `ffmpeg4`, `ffmpeg41`, `ffmpeg42` and `ffmpeg43`. If you manually specify any of these features, now is the time to remove them; if you use `ffmpeg43` through the `default` feature, it's still on for backward-compatibility but it has turned into a no-op, and you don't need to do anything. Deprecation plan: `ffmpeg43` will be dropped from default features come 4.4, and all these features will be removed come 5.0.*
+
+*See [CHANGELOG.md](CHANGELOG.md) for other information on version upgrades.*
+
+A word on versioning: major and minor versions of this crate track major and minor versions of FFmpeg, e.g. 4.2.x of this crate has been updated to support the 4.2.x series of FFmpeg. Patch level is reserved for changes to this crate and does not track FFmpeg patch versions. Since we can only freely bump the patch level, versioning of this crate differs from semver: minor versions may behave like semver major versions and introduce backward-incompatible changes; patch versions may behave like semver minor versions and introduce new APIs. Please peg the version you use accordingly.
+
+**Please realize that this crate is in maintenance-only mode for the most part.** Which means I'll try my best to ensure the crate compiles against all release branches of FFmpeg 3.4 and later (only the latest patch release of each release branch is officially supported) and fix reported bugs, but if a new FFmpeg version brings new APIs that require significant effort to port to Rust, you might have to send me a PR (and just to be clear, I can't really guarantee I'll have the time to review). Any PR to improve existing API is unlikely to be merged, unfortunately.
+
+🤝 **If you have significant, demonstrable experience in Rust and multimedia-related programming, please let me know, I'll be more than happy to invite you as a collaborator.** 🤝

examples/chapters.rs

@@ -1,4 +1,4 @@
-extern crate ffmpeg;
+extern crate ffmpeg_next as ffmpeg;
 
 use std::env;