icy-metadata 0.6.0

use std::io::{Cursor, Read, Seek, SeekFrom};
use std::num::NonZeroUsize;
use std::sync::{Arc, RwLock};

use http::HeaderMap;
use icy_metadata::error::{EmptyMetadataError, MetadataParseError};
use icy_metadata::{IcyHeaders, IcyMetadata, IcyMetadataReader, add_icy_metadata_header};
use rstest::rstest;

#[test]
fn read_headers() {
    let mut headers = HeaderMap::new();
    headers.append("Icy-Br", "128".parse().unwrap());
    headers.append("Icy-Sr", "44100".parse().unwrap());
    headers.append("Icy-Genre", "genre".parse().unwrap());
    headers.append("Icy-Name", "name".parse().unwrap());
    headers.append("Icy-Url", "url".parse().unwrap());
    headers.append("Icy-Pub", "1".parse().unwrap());
    headers.append("Icy-Metaint", "16000".parse().unwrap());
    headers.append("Icy-Description", "description".parse().unwrap());
    headers.append("Icy-Notice1", "notice1".parse().unwrap());
    headers.append("Icy-Notice2", "notice2".parse().unwrap());
    headers.append("X-Loudness", "-1.0".parse().unwrap());
    headers.append(
        "Icy-Logo",
        "http://my.super.logo/file.jpeg".parse().unwrap(),
    );
    headers.append("Icy-Main-Stream-Url", "http://stream.url".parse().unwrap());
    headers.append("Icy-Version", "2".parse().unwrap());
    headers.append("Icy-Index-Metadata", "1".parse().unwrap());
    headers.append("Icy-Country-Code", "DE".parse().unwrap());
    headers.append("Icy-Country-Subdivision-Code", "AM-ER".parse().unwrap());
    headers.append("Icy-Language-Codes", "en".parse().unwrap());
    headers.append("Icy-Geo-lat-long", "40.23,-20.86".parse().unwrap());
    headers.append("Icy-Do-Not-Index", "1".parse().unwrap());
    headers.append(
        "Ice-Audio-Info",
        "ice-samplerate=44100;ice-bitrate=128;ice-channels=2;custom=yes;ice-quality=10%2e0"
            .parse()
            .unwrap(),
    );

    let icy_headers = IcyHeaders::parse_from_headers(&headers);
    assert_eq!(icy_headers.bitrate().unwrap(), 128);
    assert_eq!(icy_headers.sample_rate().unwrap(), 44100);
    assert_eq!(icy_headers.genre().first().unwrap(), "genre");
    assert_eq!(icy_headers.name().unwrap(), "name");
    assert_eq!(icy_headers.station_url().unwrap(), "url");
    assert!(icy_headers.public().unwrap());
    assert_eq!(icy_headers.metadata_interval().unwrap().get(), 16000);
    assert_eq!(icy_headers.description().unwrap(), "description");
    assert_eq!(icy_headers.notice1().unwrap(), "notice1");
    assert_eq!(icy_headers.notice2().unwrap(), "notice2");
    assert_eq!(icy_headers.loudness(), Some(-1.0));
    assert_eq!(icy_headers.channels().unwrap(), 2);
    assert_eq!(icy_headers.quality().unwrap(), "10.0");
    assert_eq!(
        icy_headers.logo_url().unwrap(),
        "http://my.super.logo/file.jpeg"
    );
    assert_eq!(icy_headers.main_stream_url().unwrap(), "http://stream.url");
    assert_eq!(icy_headers.version().unwrap(), 2);
    assert!(icy_headers.index_metadata().unwrap());
    assert_eq!(icy_headers.country_code().unwrap(), "DE");
    assert_eq!(icy_headers.country_subdivision_code().unwrap(), "AM-ER");
    assert_eq!(icy_headers.language_codes().first().unwrap(), "en");
    assert_eq!(icy_headers.geo_lat_long().unwrap(), [40.23, -20.86]);
    assert!(icy_headers.do_not_index().unwrap());

    assert_eq!(icy_headers.custom().get("custom").unwrap(), "yes");
}

#[test]
fn multiple_keys() {
    let mut headers = HeaderMap::new();
    headers.append("Icy-Genre", "genre1,genre2".parse().unwrap());
    headers.append("Icy-Br", "128,256".parse().unwrap());
    headers.append("Icy-Language-Codes", "en,es".parse().unwrap());

    let icy_headers = IcyHeaders::parse_from_headers(&headers);
    assert_eq!(icy_headers.bitrate().unwrap(), 128);
    assert_eq!(
        icy_headers.genre(),
        &["genre1".to_string(), "genre2".to_string()]
    );
    assert_eq!(
        icy_headers.language_codes(),
        &["en".to_string(), "es".to_string()]
    );
}

#[test]
fn read_no_headers() {
    let headers = HeaderMap::new();
    let icy_headers = IcyHeaders::parse_from_headers(&headers);
    assert_eq!(IcyHeaders::default(), icy_headers);
}

#[test]
fn add_metadata_header() {
    let mut map = HeaderMap::new();
    add_icy_metadata_header(&mut map);
    assert_eq!(map.get("Icy-Metadata").unwrap().to_str().unwrap(), "1");
}

#[rstest]
fn read_stream_title(
    #[values("StreamTitle='stream-title{}';")] meta_bytes: &str,
    #[values((1,0), (5,0), (5,4))] byte_lens: (usize, usize),
    #[values(1, 2)] iters: usize,
) {
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) =
        setup_data_template(meta_bytes, meta_int, &mut data, iters, trailing_bytes);

    let mut buf = Vec::with_capacity(meta_int * iters + trailing_bytes);
    reader.read_to_end(&mut buf).unwrap();

    assert_eq!(buf, vec![1; buf.len()]);
    let metadata = metadata.read().unwrap();
    for i in 0..iters {
        assert_eq!(
            metadata[i].clone().unwrap().stream_title().unwrap(),
            format!("stream-title{i}")
        );
    }
}

#[rstest]
fn read_stream_url(
    #[values("StreamUrl='stream-url{}';")] meta_bytes: &str,
    #[values((1,0), (5,0), (5,4))] byte_lens: (usize, usize),
    #[values(1, 2)] iters: usize,
) {
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) =
        setup_data_template(meta_bytes, meta_int, &mut data, iters, trailing_bytes);

    let mut buf = Vec::with_capacity(meta_int * iters + trailing_bytes);
    reader.read_to_end(&mut buf).unwrap();

    assert_eq!(buf, vec![1; buf.len()]);
    let metadata = metadata.read().unwrap();
    for i in 0..iters {
        assert_eq!(
            metadata[i].clone().unwrap().stream_url().unwrap(),
            format!("stream-url{i}")
        );
    }
}

#[rstest]
fn all_stream_properties(
    #[values(
        "StreamTitle='stream-title{}';StreamUrl='stream-url{}';CustomVal='custom{}';",
        "StreamTitle='stream-title{}';StreamUrl='stream-url{}';CustomVal='custom{}';",
        "StreamTitle='stream-title{}';StreamUrl='stream-url{}';CustomVal='custom{}'"
    )]
    meta_bytes: &str,
    #[values((1,0), (5,0), (5,4))] byte_lens: (usize, usize),
    #[values(1, 2)] iters: usize,
) {
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) =
        setup_data_template(meta_bytes, meta_int, &mut data, iters, trailing_bytes);

    let mut buf = Vec::with_capacity(meta_int * iters + trailing_bytes);
    reader.read_to_end(&mut buf).unwrap();

    let metadata = metadata.read().unwrap();
    assert_eq!(buf, vec![1; buf.len()]);
    for i in 0..iters {
        assert_eq!(
            metadata[i].clone().unwrap().stream_url().unwrap(),
            format!("stream-url{i}")
        );
        assert_eq!(
            metadata[i].clone().unwrap().stream_title().unwrap(),
            format!("stream-title{i}")
        );
        assert_eq!(
            metadata[i]
                .clone()
                .unwrap()
                .custom_fields()
                .get("CustomVal")
                .unwrap(),
            &format!("custom{i}")
        );
    }
}

#[rstest]
// cspell:disable
#[case("StreamTitle='stream-t;itle';", Some("stream-t;itle"), None)]
#[case("StreamTitle=';stream-title';", Some(";stream-title"), None)]
#[case("StreamTitle=';stream-title;';", Some(";stream-title;"), None)]
#[case("StreamTitle=';stream-;title;';", Some(";stream-;title;"), None)]
#[case("StreamTitle=';stre'am-;title;';", Some(";stre'am-;title;"), None)]
#[case("StreamUrl=';stre'am-;url;';", None, Some(";stre'am-;url;"))]
#[case(
    "StreamTitle=';stre'am-;title;';StreamUrl='stre'am=url';",
    Some(";stre'am-;title;"),
    Some("stre'am=url")
)]
#[case(
    "StreamTitle=';stre'am-;title;';StreamUrl='stre;am=url';",
    Some(";stre'am-;title;"),
    Some("stre;am=url")
)]
#[case(
    "StreamUrl='stre;am=url';StreamTitle=';stre'am-;title;';",
    Some(";stre'am-;title;"),
    Some("stre;am=url")
)]
#[case(
    "StreamTitle='streamtitle';StreamUrl='stre;am=url';",
    Some("streamtitle"),
    Some("stre;am=url")
)]
#[case(
    "StreamTitle=';stre'am-;title;';StreamUrl='stre;am=url'",
    Some(";stre'am-;title;"),
    Some("stre;am=url")
)]
#[case(
    "ExtraField=extra;StreamTitle=';stre'am-;title;';StreamUrl='stre'am=url';",
    Some(";stre'am-;title;"),
    Some("stre'am=url")
)]
// cspell:enable
fn handle_unescaped_values(
    #[case] meta_bytes: &str,
    #[case] expected_title: Option<&str>,
    #[case] expected_url: Option<&str>,
) {
    let meta_int = 5;
    let trailing_bytes = 4;
    let mut data = Vec::new();
    let (mut reader, metadata) =
        setup_data_template(meta_bytes, meta_int, &mut data, 1, trailing_bytes);

    let mut buf = Vec::with_capacity(meta_int + trailing_bytes);
    reader.read_to_end(&mut buf).unwrap();

    let metadata = metadata.read().unwrap();
    assert_eq!(buf, vec![1; buf.len()]);
    assert_eq!(metadata[0].clone().unwrap().stream_title(), expected_title);
    assert_eq!(metadata[0].clone().unwrap().stream_url(), expected_url);
}

type MetadataLock = Arc<RwLock<Vec<Result<IcyMetadata, MetadataParseError>>>>;

#[rstest]
fn read_larger_than_stream_size(
    #[values("StreamUrl='stream-url{}';")] meta_bytes: &str,
    #[values((10,5))] byte_lens: (usize, usize),
    #[values(1, 2)] iters: usize,
) {
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) =
        setup_data_template(meta_bytes, meta_int, &mut data, iters, trailing_bytes);

    let stream_size = meta_int * iters + trailing_bytes;
    let mut buf = vec![0; stream_size + 1];
    let read_amount = reader.read(&mut buf).unwrap();
    assert_eq!(read_amount, stream_size);
    assert_eq!(buf[..read_amount], vec![1; read_amount]);

    let metadata = metadata.read().unwrap();
    for i in 0..iters {
        assert_eq!(
            metadata[i].clone().unwrap().stream_url().unwrap(),
            format!("stream-url{i}")
        );
    }
}

#[rstest]
fn small_reads(
    #[values("StreamUrl='stream-url{}';")] meta_bytes: &str,
    #[values((10,5))] byte_lens: (usize, usize),
    #[values(1, 2)] iters: usize,
) {
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) =
        setup_data_template(meta_bytes, meta_int, &mut data, iters, trailing_bytes);

    let stream_size = meta_int * iters + trailing_bytes;
    let mut buf = vec![0; stream_size];

    let mut read_amount = 0;
    while read_amount < buf.len() {
        read_amount += reader.read(&mut buf[read_amount..read_amount + 1]).unwrap();
    }
    assert_eq!(read_amount, stream_size);
    assert_eq!(buf[..read_amount], vec![1; read_amount]);

    let metadata = metadata.read().unwrap();
    for i in 0..iters {
        assert_eq!(
            metadata[i].clone().unwrap().stream_url().unwrap(),
            format!("stream-url{i}")
        );
    }
}

#[rstest]
fn empty_metadata(
    #[values("")] meta_bytes: &str,
    #[values((1,0), (5,0), (5,4))] byte_lens: (usize, usize),
    #[values(1, 2)] iters: usize,
) {
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) =
        setup_data_template(meta_bytes, meta_int, &mut data, iters, trailing_bytes);

    let mut buf = Vec::with_capacity(meta_int * iters + trailing_bytes);
    reader.read_to_end(&mut buf).unwrap();

    assert_eq!(buf, vec![1; buf.len()]);
    let metadata = metadata.read().unwrap();
    for i in 0..iters {
        assert_eq!(
            metadata[i],
            Err(MetadataParseError::Empty(EmptyMetadataError(
                "".to_string()
            )))
        );
    }
}

#[rstest]
// cspell:disable
#[case(
    vec!["StreamUrl='stream-url0';","StreamUrl='stream-urlabc1235678';","StreamUrl='stream-url123';"], 
    vec!["stream-url0", "stream-urlabc1235678", "stream-url123","stream-url0", "stream-urlabc1235678", "stream-url123"],
    0
)]
#[case(
    vec!["StreamUrl='stream-url0';","StreamUrl='stream-urlabc1235678';","StreamUrl='stream-url123';"], 
    vec!["stream-url0", "stream-urlabc1235678", "stream-url123", "stream-urlabc1235678", "stream-url123"],
    10
)]
#[case(
    vec!["StreamUrl='stream-url0';","StreamUrl='stream-urlabc1235678';","StreamUrl='stream-url123';"], 
    vec!["stream-url0", "stream-urlabc1235678", "stream-url123","stream-url0", "stream-urlabc1235678", "stream-url123"],
    5
)]
#[case(
    vec!["StreamUrl='stream-url0';","StreamUrl='stream-urlabc1235678';","StreamUrl='stream-url123';"], 
    vec!["stream-url0", "stream-urlabc1235678", "stream-url123","stream-urlabc1235678", "stream-url123"],
    15
)]
// cspell:enable
fn seek_from_start(
    #[case] metadata_in: Vec<&str>,
    #[case] metadata_out: Vec<&str>,
    #[values((10,5))] byte_lens: (usize, usize),
    #[case] seek_pos: usize,
) {
    let meta_length = metadata_in.len();
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) = setup_data_list(metadata_in, meta_int, &mut data, trailing_bytes);

    let buf_len = meta_int * meta_length + trailing_bytes;
    let mut buf = vec![0; buf_len];

    let _ = reader.read(&mut buf).unwrap();
    reader.seek(SeekFrom::Start(seek_pos as u64)).unwrap();
    let _ = reader.read(&mut buf[seek_pos..buf_len]).unwrap();
    assert_eq!(buf, vec![1; buf_len]);

    let metadata = metadata.read().unwrap();
    for (i, out) in metadata_out.iter().enumerate() {
        assert_eq!(metadata[i].clone().unwrap().stream_url().unwrap(), *out);
    }
}

#[rstest]
#[case(20)]
#[case(5)]
#[case(10)]
#[case(15)]
fn seek_from_start_to_future(
    // cspell:disable
    #[values( vec!["StreamUrl='stream-url0';","StreamUrl='stream-urlabc1235678';","StreamUrl='stream-url123';"])]
    metadata_in: Vec<&str>,
    #[values(vec!["stream-url0","stream-urlabc1235678","stream-url123"])] metadata_out: Vec<&str>,
    // cspell:enable
    #[values((10,5))] byte_lens: (usize, usize),
    #[case] seek_pos: usize,
) {
    let meta_length = metadata_in.len();
    let (meta_int, trailing_bytes) = byte_lens;
    let mut data = Vec::new();
    let (mut reader, metadata) = setup_data_list(metadata_in, meta_int, &mut data, trailing_bytes);

    let buf_len = meta_int * meta_length + trailing_bytes;
    let mut buf = vec![0; buf_len];

    reader.seek(SeekFrom::Start(seek_pos as u64)).unwrap();
    let _ = reader.read(&mut buf[seek_pos..]).unwrap();
    assert_eq!(buf[seek_pos..], vec![1; buf_len - seek_pos]);

    let metadata = metadata.read().unwrap();
    for (i, out) in metadata_out.iter().enumerate() {
        assert_eq!(metadata[i].clone().unwrap().stream_url().unwrap(), *out);
    }
}

enum MetadataSetup<'a> {
    Template { val: &'a str, iters: usize },
    List(Vec<&'a str>),
}

fn setup_data_template<'a>(
    val: &'a str,
    meta_int: usize,
    data: &'a mut Vec<u8>,
    iters: usize,
    trailing_bytes: usize,
) -> (IcyMetadataReader<Cursor<&'a [u8]>>, MetadataLock) {
    setup_data(
        MetadataSetup::Template { val, iters },
        meta_int,
        data,
        trailing_bytes,
    )
}

fn setup_data_list<'a>(
    vals: Vec<&'a str>,
    meta_int: usize,
    data: &'a mut Vec<u8>,
    trailing_bytes: usize,
) -> (IcyMetadataReader<Cursor<&'a [u8]>>, MetadataLock) {
    setup_data(MetadataSetup::List(vals), meta_int, data, trailing_bytes)
}

fn setup_data<'a>(
    metadata_setup: MetadataSetup<'a>,
    meta_int: usize,
    data: &'a mut Vec<u8>,
    trailing_bytes: usize,
) -> (IcyMetadataReader<Cursor<&'a [u8]>>, MetadataLock) {
    let mut add_data = |meta_bytes: &str| {
        let meta_bytes = meta_bytes.as_bytes();
        let meta_byte = meta_bytes.len() / 16 + 1;

        data.extend_from_slice(vec![1; meta_int].as_slice());
        data.push(meta_byte as u8);
        data.extend_from_slice(meta_bytes);
        let padding = vec![0; meta_byte * 16 - meta_bytes.len()];

        data.extend_from_slice(&padding);
    };
    match metadata_setup {
        MetadataSetup::Template { val, iters } => {
            for i in 0..iters {
                let meta_bytes = val.replace("{}", &i.to_string());
                add_data(&meta_bytes);
            }
        }
        MetadataSetup::List(vals) => {
            for val in vals {
                add_data(val);
            }
        }
    }

    data.extend_from_slice(&vec![1; trailing_bytes]);

    let metadata = Arc::new(RwLock::new(vec![]));
    let reader = {
        let metadata = metadata.clone();
        IcyMetadataReader::new(
            Cursor::new(data.as_slice()),
            NonZeroUsize::new(meta_int),
            move |meta| {
                metadata.write().unwrap().push(meta);
            },
        )
    };
    (reader, metadata)
}