Serial-ATA / Serial-ATA/lofty-rs

Generic chapter representation

Open
#249 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
359
Forks
76
Avg merge
12h 54m
Merged PRs (30d)
11

Description

Similar to Picture, once chapters are supported in ID3v2 (#189), EBML, Vorbis Comments, and MP4, it may be worth creating a generic representation of chapters that can be converted to and from the concrete implementations.

Not yet sure if this would be easy (or possible) to accomplish, since there's a pretty big difference in available information between the formats.

The basic idea would be:

pub struct Chapter {
    pub name: String,
    pub start_time: u32,
    pub end_time: u32,
}

This seems to cover the bare minimum required information for chapters in all formats (It could be expanded with additional optional information).

However, with MP4 (at least in one of many chapter formats available) and Vorbis Comments, there is only a name and start time available. end_time may need to be optional, making the conversion between Chapter and the ID3v2/EBML chapters fallible.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the chapter-support work referenced in #189 and the concrete chapter formats named here: ID3v2, EBML, Vorbis Comments, and MP4. Compare which fields each format provides and whether a shared representation can support conversion in both directions. Done means the scope and conversion behavior are defined before implementation begins.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
audio-video-rtc
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.