triseratops 0.0.3

The robust, in-depth Serato Parser & Serializer.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

// Copyright (c) 2023 Jan Holthuis <jan.holthuis@rub.de>
//
// 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
// http://mozilla.org/MPL/2.0/.
//
// SPDX-License-Identifier: MPL-2.0

//! The `Serato RelVolAd` tag stores the analysis version.

use super::format::{enveloped, flac, mp4, Tag};
use super::generic::Version;
use super::util::{take_version, write_version};
use crate::error::Error;
use crate::util::Res;
use std::io;

/// Represents the  `Serato RelVolAd` tag.
///
/// **Note:** This tag has not been reverse-engineered yet. Judging from the name it contains
/// information about relative volume adjustments, but at this point that is just speculation.
///
/// # Example
///
/// ```
/// use triseratops::tag::{RelVolAd, format::flac::FLACTag};
///
/// // First, read the tag data from the FLAC VORBIS_COMMENT (the tag name can be accessed using the
/// // RelVolAd::FLAC_TAG), then parse the data like this:
/// fn parse(data: &[u8]) {
///     let content = RelVolAd::parse_flac(data).expect("Failed to parse data!");
///     println!("{:?}", content);
/// }
/// ```
#[derive(Debug)]
pub struct RelVolAd {
    /// The `RelVolAd` version.
    pub version: Version,
    /// The data (not reverse-engineered yet)
    pub data: Vec<u8>,
}

impl Tag for RelVolAd {
    const NAME: &'static str = "Serato RelVolAd";

    fn parse(input: &[u8]) -> Result<Self, Error> {
        let (_, overview) = nom::combinator::all_consuming(take_relvolad)(input)?;
        Ok(overview)
    }

    fn write(&self, writer: &mut impl io::Write) -> Result<usize, Error> {
        write_relvolad(writer, self)
    }
}

impl enveloped::EnvelopedTag for RelVolAd {}
impl flac::FLACTag for RelVolAd {
    const FLAC_COMMENT: &'static str = "SERATO_RELVOL";
}
impl mp4::MP4Tag for RelVolAd {
    const MP4_ATOM_FREEFORM_NAME: &'static str = "relvol";
}

fn take_relvolad(input: &[u8]) -> Res<&[u8], RelVolAd> {
    let (input, version) = take_version(input)?;
    let (input, data) = nom::combinator::rest(input)?;
    let data = data.to_owned();

    let relvolad = RelVolAd { version, data };
    Ok((input, relvolad))
}

fn write_relvolad(writer: &mut impl io::Write, relvolad: &RelVolAd) -> Result<usize, Error> {
    let mut bytes_written = write_version(writer, relvolad.version)?;
    bytes_written += writer.write(relvolad.data.as_slice())?;
    Ok(bytes_written)
}