Split project into two crates mp4parse and mp4parse_capi (fixes #18)

Author: nox

.gitignore

@@ -1,7 +1,7 @@
-/target
-/Cargo.lock
+target
+Cargo.lock
 *.o
 libmp4parse.a*
 mp4parse.d
 examples/test
-include/mp4parse.h
+mp4parse_capi/include/mp4parse.h

.travis.yml

@@ -15,13 +15,13 @@ env:
     - CXX=g++-5
 
 script:
-  - cargo build --verbose
-  - cargo test --verbose
-  - make -C examples
-  - cargo doc
+  - (cd mp4parse && cargo test --verbose)
+  - (cd mp4parse_capi && cargo test --verbose)
+  - make -C mp4parse_capi/examples
+  - (cd mp4parse_capi && cargo doc)
 
 deploy:
   provider: surge
-  project: ./target/doc/
+  project: ./mp4parse_capi/target/doc/
   domain: mp4parse-docs.surge.sh
   skip_cleanup: true

Cargo.toml renamed to mp4parse/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mp4parse"
-version = "0.4.1"
+version = "0.5.0"
 authors = [
   "Ralph Giles <[email protected]>",
   "Matthew Gregan <[email protected]>",
@@ -12,14 +12,6 @@ license = "MPL-2.0"
 
 repository = "https://github.com/mozilla/mp4parse-rust"
 
-# Cargo includes random files from the working directory
-# by default! Avoid bloating the package with test files.
-exclude = [
-  "*.mp4",
-]
-
-build = "build.rs"
-
 [dependencies]
 byteorder = "0.5.0"
 afl = { version = "0.1.1", optional = true }
@@ -29,9 +21,6 @@ abort_on_panic = { version = "1.0.0", optional = true }
 [dev-dependencies]
 test-assembler = "0.1.2"
 
-[build-dependencies]
-rusty-cheddar = "0.3.2"
-
 [features]
 fuzz = ["afl", "afl-plugin", "abort_on_panic"]
 

src/boxes.rs renamed to mp4parse/src/boxes.rs

@@ -13,10 +13,6 @@ use byteorder::ReadBytesExt;
 use std::io::{Read, Take};
 use std::cmp;
 
-// Expose C api wrapper.
-pub mod capi;
-pub use capi::*;
-
 mod boxes;
 use boxes::BoxType;
 
@@ -109,7 +105,7 @@ struct FileTypeBox {
 /// Movie header box 'mvhd'.
 #[derive(Debug)]
 struct MovieHeaderBox {
-    timescale: u32,
+    pub timescale: u32,
     duration: u64,
 }
 
@@ -217,7 +213,7 @@ pub enum AudioCodecSpecific {
 #[derive(Debug, Clone)]
 pub struct AudioSampleEntry {
     data_reference_index: u16,
-    channelcount: u16,
+    pub channelcount: u16,
     pub samplesize: u16,
     pub samplerate: u32,
     pub codec_specific: AudioCodecSpecific,
@@ -318,7 +314,7 @@ pub struct Track {
     pub media_time: Option<TrackScaledTime>,
     pub timescale: Option<TrackTimeScale>,
     pub duration: Option<TrackScaledTime>,
-    track_id: Option<u32>,
+    pub track_id: Option<u32>,
     pub mime_type: String,
     pub data: Option<SampleEntry>,
     pub tkhd: Option<TrackHeaderBox>, // TODO(kinetik): find a nicer way to export this.

src/lib.rs renamed to mp4parse/src/lib.rs

@@ -0,0 +1,34 @@
+[package]
+name = "mp4parse_capi"
+version = "0.5.0"
+authors = [
+  "Ralph Giles <[email protected]>",
+  "Matthew Gregan <[email protected]>",
+]
+
+description = "Parser for ISO base media file format (mp4)"
+documentation = "https://mp4parse-docs.surge.sh/mp4parse/"
+license = "MPL-2.0"
+
+repository = "https://github.com/mozilla/mp4parse-rust"
+
+# Cargo includes random files from the working directory
+# by default! Avoid bloating the package with test files.
+exclude = [
+  "*.mp4",
+]
+
+build = "build.rs"
+
+[dependencies]
+"mp4parse" = {path = "../mp4parse"}
+
+[build-dependencies]
+rusty-cheddar = "0.3.2"
+
+[features]
+fuzz = ["mp4parse/fuzz"]
+
+# Somewhat heavy-handed, but we want at least -Z force-overflow-checks=on.
+[profile.release]
+debug-assertions = true

src/tests.rs renamed to mp4parse/src/tests.rs

@@ -3,7 +3,6 @@ extern crate cheddar;
 fn main() {
     // Generate mp4parse.h.
     cheddar::Cheddar::new().expect("could not read manifest")
-        .module("capi").expect("invalid module path")
         .insert_code("// THIS FILE IS AUTOGENERATED BY mp4parse-rust/build.rs - DO NOT EDIT\n\n")
         .insert_code("// This Source Code Form is subject to the terms of the Mozilla Public\n")
         .insert_code("// License, v. 2.0. If a copy of the MPL was not distributed with this\n")

tests/afl.rs renamed to mp4parse/tests/afl.rs

@@ -1,6 +1,6 @@
-extern crate mp4parse;
+extern crate mp4parse_capi;
 
-use mp4parse::*;
+use mp4parse_capi::*;
 
 #[cfg(feature = "fuzz")]
 #[macro_use]

mp4parse_capi/Cargo.toml

@@ -5,7 +5,7 @@
 //! # Examples
 //!
 //! ```rust
-//! extern crate mp4parse;
+//! extern crate mp4parse_capi;
 //! use std::io::Read;
 //!
 //! extern fn buf_read(buf: *mut u8, size: usize, userdata: *mut std::os::raw::c_void) -> isize {
@@ -18,37 +18,40 @@
 //! }
 //!
 //! let mut file = std::fs::File::open("examples/minimal.mp4").unwrap();
-//! let io = mp4parse::mp4parse_io { read: buf_read,
-//!                                  userdata: &mut file as *mut _ as *mut std::os::raw::c_void };
+//! let io = mp4parse_capi::mp4parse_io {
+//!     read: buf_read,
+//!     userdata: &mut file as *mut _ as *mut std::os::raw::c_void
+//! };
 //! unsafe {
-//!     let parser = mp4parse::mp4parse_new(&io);
-//!     let rv = mp4parse::mp4parse_read(parser);
-//!     assert_eq!(rv, mp4parse::mp4parse_error::MP4PARSE_OK);
-//!     mp4parse::mp4parse_free(parser);
+//!     let parser = mp4parse_capi::mp4parse_new(&io);
+//!     let rv = mp4parse_capi::mp4parse_read(parser);
+//!     assert_eq!(rv, mp4parse_capi::mp4parse_error::MP4PARSE_OK);
+//!     mp4parse_capi::mp4parse_free(parser);
 //! }
 //! ```
 
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use std;
+extern crate mp4parse;
+
 use std::io::Read;
 use std::collections::HashMap;
 
 // Symbols we need from our rust api.
-use MediaContext;
-use TrackType;
-use read_mp4;
-use Error;
-use SampleEntry;
-use AudioCodecSpecific;
-use VideoCodecSpecific;
-use MediaTimeScale;
-use MediaScaledTime;
-use TrackTimeScale;
-use TrackScaledTime;
-use serialize_opus_header;
+use mp4parse::MediaContext;
+use mp4parse::TrackType;
+use mp4parse::read_mp4;
+use mp4parse::Error;
+use mp4parse::SampleEntry;
+use mp4parse::AudioCodecSpecific;
+use mp4parse::VideoCodecSpecific;
+use mp4parse::MediaTimeScale;
+use mp4parse::MediaScaledTime;
+use mp4parse::TrackTimeScale;
+use mp4parse::TrackScaledTime;
+use mp4parse::serialize_opus_header;
 
 // rusty-cheddar's C enum generation doesn't namespace enum members by
 // prefixing them, so we're forced to do it in our member names until