I. Problem/Value Statement
Problem Statement
Part of the DRS Futures project consists of optimizing the data pipelines that feed the LTS delivery services and creating deliverable images that are separate from their archival and production masters, using a format that is optimized for delivery rather than for long-time preservation. This, combined with an extensive remediation of images that are currently undeliverable or very inefficient because of the way they were originally generated, should result in a drastic reduction of error rates and resource consumption of media delivery services.
Strictly related to improving existing substandard images is resolving their root cause, which is the workflows with which these images were produced and introduced into DRS. Many of these images were produced by individual departments with ad-hoc developed or outsourced tools, without a central oversight on the quality of the resulting derivatives. A central service for creating derivatives specifically for delivery using community best practices and standards would drastically improve both the overall published media quality and Harvard staff's content production workflows.
Business Value
Creating images specifically for delivery would have several advantages:
a. Derivatives can be optimized for delivery, resulting in more consistent, and overall much more efficient delivery;
b. Archival and production master images would have a clearly defined purpose and their quality control would be in the content managers' hands, while the quality of delivery images would be guaranteed by LTS.
c. If a better encoding for non-archival images were found in the future, delivery images could be recreated from their masters, without the need to change the latter.
Moreover, campus-wide adoption of an LTS-managed, centralized image conversion tool to consistently produce high quality images at high speed would remove the need for individual department to come up with their own bespoke solution for conversion, and would make it possible to completely automate the derivative generation, further relieving HL staff from repetitive and error-prone work.
II. Vision and Approach
We have identified a format into which we want to convert all the still images in DRS, starting from the most problematic ones. This format is High Throughput JPEG2000 (HTJ2K), a quite recent standard that is supported by a few encoding and decoding tools. (Note: this conversion would leave the archival images in DRS unchanged, it would only replace the delivery images.)
Our vision aligns with the following Harvard Library multi-year goals and objectives (MYGOs):
- MYGO #8: Focus technical services on effective workflows and metadata that matter the most
- By offering a centralized service for efficient, high-quality, and scalable processing of highly visible (public) images that can be used across campus we would encourage discontinuing one-off solutions that individual departments have been developing for lack of a better alternative, incurring in additional maintenance costs and inconsistent, often substandard output quality.
- MYGO #10: Focus on space as a service, considering the most cost-effective approaches to user interests, collections security and preservation, and staff needs in HL and HCL facilities
- HTJ2K is the most space- and computationally efficient format for Web quality images today. By converting existing lossless DRS images into HTJ2K we would significantly reduce storage, computing and I/O usage on the most traffic-heavy (and expensive) tier of our infrastructure.
- MYGO #14: Minimize the environmental impact of collections, services, and spaces
- As described in MYGO #10, the goal of this project is to save computing resources, thus reducing the environmental footprint of our services.
Our vision aligns with the following HUIT objectives and key results (OKRs):
- Develop a plan for automation in each service area for critical, frequently used or heavily manual workflows
- This project seeks to optimize one of the most critical and frequently used workflows in the content production chain.
III. In Scope/Out of Scope
In Scope
- Developing a plug-in for the Vips image library that uses Kakadu for reading and writing JPEG2000 images.
- Integrating the plug-in into the currently developed imgconv project.
- Maintaining the plug-in up to speed with future Vips upgrades
- Documentation and tests for the developed code
Note that this project is limited to still images. Other media may need a different workflow and approach.
Out of Scope
The following items are out of scope because they are achievable without this project; however, an optimized HTJ2K converter would significantly improve their quality:
- Development of a microservice for converting images based on configurable profiles (imgconv)
- Integration of imgconv into an automation framework for large scale processing (drs-pipelines)
- Conversion of defective and/or substandard delivery images into delivery-optmized HTJ2K
IV. Deliverables and Work Products
- Code, documentation and tests for a Kakadu plugin for Vips in a Git repository.
Definition of Done
This project will be considered done once:
- The Vips Kakadu plugin code is completed and committed to a Harvard-owned Git repository
- We are consistently able to compile and run the plugin
- Comprehensive tests are written for the key functions
- All tests pass
- Exhaustive relevant documentation is provided
- We are able to integrate the delivered code into our imgconv project and verify that the features and options satisfy our needs.
V. Stakeholders
Stakeholder | Title | Participation |
---|---|---|
Stu Snydman | Associate University Librarian and Managing Director, Library Technology | Executive Sponsor, Business Owner |
VI. Project Team
Project Role | Team member(s) |
---|---|
Technical Product Owner / LTSLT Owner | Stefano Cossu (LTS) |
Software engineers | John Cupitt (independent contractor - development), Pierre-Anthony Lemieux (independent contractor - consulting)*, Brian Hoffman (LTS - integration), JJ Chen (LTS - integration) |
QA | Stefano Cossu, Brian Hoffman |
Functional documentation | John Cupitt |
Scrum Master | Stefano Cossu |
Project Manager | Vitaly Zakuta (LTS) |
* Pierre-Anthony Lemieux deferred to John Cupitt for carrying out the development, remaining available for advising on Kakadu-specific topics. We have not yet established whether such consulting will be pro bono or for a fee. In the latter case, we should request a cost estimate, but ideally we would like to have one contractor billing for the whole project.
VII. Estimated Schedule (tentative)
Phase | Phase Start | Phase End | Completion Milestone |
---|---|---|---|
Development & Release | 11/27/2023 | 12/04/2023 | Develop code |
Development & Release | 12/05/2023 | 12/08/2023 | Unit and integration tests |
Development & Release | 12/11/2023 | 12/15/2023 | Complete & validate documentation |
Development & Release | 12/11/2023 | 12/22/2023 | imgconv integration and release |
VIII. Assumptions, Constraints, Dependencies, and Risks
Project Assumptions
- The code delivered by the contractor will be agnostic to external integrations.
- Integration with imgconv and DRS pipelines, including deployment infrastructure and long-term maintenence, will be the DRS Futures engineering team.
- Stakeholders will be available to participate in project activities and to complete tasks as requested.
- The Executive Sponsor and other stakeholders are empowered to make the decisions required for the project to be a success.
- The code delivered by the contractor will be agnostic to external integrations.
Project Constraints
- Contractor availability
- DRS Futures team availability
- Scope
- Time
- Budget
Project Dependencies
- The plugin developer will be need a Kakadu SDK license to perform development, testing, and long-term maintenance of the requested software. Kakadu Software has agreed to provide John Cupitt a free and renewable Kakadu SDK license. The handing-off of that license is underway.
Project Risks
Description | Plan | Impact | Owner |
---|---|---|---|
IX. Acceptance
Accepted by [ TODO ]
Prepared by Stefano Cossu
Effective Date: [ TODO ]