grib 0.15.3

GRIB format parser & writer for Rust
Documentation
use std::iter::{self, Take};

use num::ToPrimitive;

pub(crate) use self::diff::SpatialDifferencingDecodeIterator;
use self::{
    diff::{
        FirstOrderSpatialDifferencingDecodeIterator, SecondOrderSpatialDifferencingDecodeIterator,
    },
    missing::DecodedValue::{self, Missing1, Missing2, Normal},
};
use crate::{
    Grib2GpvUnpack,
    codetables::grib2::Table5_6,
    decoder::{
        DecodeError, Grib2SubmessageDecoder,
        simple::*,
        stream::{BitStream, NBitwiseIterator},
    },
    def::grib2::template::param_set,
    helpers::GribInt,
};

pub(crate) struct Complex<'d>(
    pub(crate) &'d Grib2SubmessageDecoder,
    pub(crate) &'d crate::def::grib2::template::Template5_2,
);

impl<'d> Grib2GpvUnpack for Complex<'d> {
    type Iter<'a>
        = SimplePackingDecoder<ComplexPackingDecoded<'d>>
    where
        Self: 'a;

    fn iter<'a>(&'a self) -> Result<Self::Iter<'d>, DecodeError> {
        let Self(target, template) = self;
        super::orig_field_type_is_supported(template.orig_field_type)?;

        if template.complex.group_splitting_method != 1 {
            return Err(DecodeError::NotSupported(
                "GRIB2 code table 5.4 (group splitting method)",
                template.complex.group_splitting_method.into(),
            ));
        }

        if template.complex.missing_value_management > 2 {
            return Err(DecodeError::NotSupported(
                "GRIB2 code table 5.5 (missing value management for complex packing)",
                template.complex.missing_value_management.into(),
            ));
        }

        let sect7_data = target.sect7_payload();

        let unpacked_data = decode_complex_packing(
            &template.complex,
            sect7_data,
            0,
            template.simple.num_bits,
            0,
        );
        let decoder = NonZeroSimplePackingDecoder::new(unpacked_data, &template.simple);
        let decoder = SimplePackingDecoder::NonZeroLength(decoder);
        Ok(decoder)
    }
}

pub(crate) struct ComplexSpatial<'d>(
    pub(crate) &'d Grib2SubmessageDecoder,
    pub(crate) &'d crate::def::grib2::template::Template5_3,
);

impl<'d> Grib2GpvUnpack for ComplexSpatial<'d> {
    type Iter<'a>
        = SimplePackingDecoder<
        SpatialDifferencingDecodeIterator<ComplexPackingDecoded<'d>, std::vec::IntoIter<i32>>,
    >
    where
        Self: 'a;

    fn iter<'a>(&'a self) -> Result<Self::Iter<'d>, DecodeError> {
        let Self(target, template) = self;
        super::orig_field_type_is_supported(template.orig_field_type)?;

        let spdiff_order = Table5_6::try_from(template.spatial_diff_order).map_err(|e| {
            DecodeError::NotSupported(
                "GRIB2 code table 5.6 (order of spatial differencing)",
                e.number.into(),
            )
        })?;

        if template.complex.group_splitting_method != 1 {
            return Err(DecodeError::NotSupported(
                "GRIB2 code table 5.4 (group splitting method)",
                template.complex.group_splitting_method.into(),
            ));
        }

        if template.complex.missing_value_management > 2 {
            return Err(DecodeError::NotSupported(
                "GRIB2 code table 5.5 (missing value management for complex packing)",
                template.complex.missing_value_management.into(),
            ));
        }

        let sect7_data = target.sect7_payload();
        let sect7_params = diff::SpatialDifferencingExtraDescriptors::new(
            template.spatial_diff_order,
            template.num_extra_desc_octets,
            sect7_data,
        )?;

        let unpacked_data = decode_complex_packing(
            &template.complex,
            sect7_data,
            sect7_params.len(),
            template.simple.num_bits,
            sect7_params.minimum(),
        );
        let first_values = sect7_params.first_values();
        let first_values = first_values.collect::<Vec<_>>().into_iter();
        let spdiff_unpacked = match spdiff_order {
            Table5_6::FirstOrderSpatialDifferencing => {
                SpatialDifferencingDecodeIterator::FirstOrder(
                    FirstOrderSpatialDifferencingDecodeIterator::new(unpacked_data, first_values),
                )
            }
            Table5_6::SecondOrderSpatialDifferencing => {
                SpatialDifferencingDecodeIterator::SecondOrder(
                    SecondOrderSpatialDifferencingDecodeIterator::new(unpacked_data, first_values),
                )
            }
            Table5_6::Missing => unreachable!(),
        };
        let decoder = NonZeroSimplePackingDecoder::new(spdiff_unpacked, &template.simple);
        let decoder = SimplePackingDecoder::NonZeroLength(decoder);
        Ok(decoder)
    }
}

pub(crate) type ComplexPackingDecoded<'d> = iter::Flatten<
    ComplexPackingValueDecodeIterator<
        Take<BitStream<&'d [u8]>>,
        Take<WithOffset<&'d [u8]>>,
        iter::Chain<Take<WithOffset<&'d [u8]>>, iter::Once<u32>>,
    >,
>;

fn decode_complex_packing<'a>(
    complex_param: &'a param_set::ComplexPacking,
    sect7_data: &'a [u8],
    sect7_offset: usize,
    num_bits: u8,
    z_min: i32,
) -> ComplexPackingDecoded<'a> {
    fn get_octet_length(num_bits: u8, num_groups: u32) -> usize {
        super::helpers::num_octets((num_groups * u32::from(num_bits)) as usize)
    }

    let params_end_octet = sect7_offset;
    let group_refs_end_octet =
        params_end_octet + get_octet_length(num_bits, complex_param.num_groups);
    let group_widths_end_octet = group_refs_end_octet
        + get_octet_length(complex_param.num_group_width_bits, complex_param.num_groups);
    let group_lens_end_octet = group_widths_end_octet
        + get_octet_length(complex_param.num_group_len_bits, complex_param.num_groups);

    let group_refs_iter = BitStream::new(
        &sect7_data[params_end_octet..group_refs_end_octet],
        usize::from(num_bits),
        complex_param.num_groups as usize,
    );
    let group_refs_iter = group_refs_iter.take(complex_param.num_groups as usize);

    let group_widths_iter = WithOffset::new(
        BitStream::new(
            &sect7_data[group_refs_end_octet..group_widths_end_octet],
            usize::from(complex_param.num_group_width_bits),
            complex_param.num_groups as usize,
        ),
        u32::from(complex_param.group_width_ref),
        1,
    )
    .take(complex_param.num_groups as usize);

    let group_lens_iter = WithOffset::new(
        BitStream::new(
            &sect7_data[group_widths_end_octet..group_lens_end_octet],
            usize::from(complex_param.num_group_len_bits),
            (complex_param.num_groups - 1) as usize,
        ),
        complex_param.group_len_ref,
        u32::from(complex_param.group_len_inc),
    )
    .take((complex_param.num_groups - 1) as usize)
    .chain(iter::once(complex_param.group_len_last));

    ComplexPackingValueDecodeIterator::new(
        group_refs_iter,
        group_widths_iter,
        group_lens_iter,
        complex_param.missing_value_management,
        num_bits,
        z_min,
        sect7_data[group_lens_end_octet..].to_vec(),
    )
    .flatten()
}

// Types of closures with captures cannot be denoted.
// Waiting for `type_alias_impl_trait` (TAIT) getting into stable.
pub(crate) struct WithOffset<T> {
    stream: BitStream<T>,
    offset: u32,
    inc: u32,
}

impl<T> WithOffset<T> {
    fn new(stream: BitStream<T>, offset: u32, inc: u32) -> Self {
        Self {
            stream,
            offset,
            inc,
        }
    }
}

impl<T> Iterator for WithOffset<T>
where
    T: AsRef<[u8]>,
{
    type Item = u32;

    fn next(&mut self) -> Option<Self::Item> {
        self.stream.next().map(|v| v * self.inc + self.offset)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.stream.size_hint()
    }
}

#[derive(Clone)]
pub(crate) struct ComplexPackingValueDecodeIterator<I, J, K> {
    ref_iter: I,
    width_iter: J,
    length_iter: K,
    missing_value_management: u8,
    num_bits: u8,
    z_min: i32,
    data: Vec<u8>,
    pos: usize,
    start_offset_bits: usize,
}

impl<I, J, K> ComplexPackingValueDecodeIterator<I, J, K> {
    pub(crate) fn new(
        ref_iter: I,
        width_iter: J,
        length_iter: K,
        missing_value_management: u8,
        num_bits: u8,
        z_min: i32,
        data: Vec<u8>,
    ) -> Self {
        Self {
            ref_iter,
            width_iter,
            length_iter,
            missing_value_management,
            num_bits,
            z_min,
            data,
            pos: 0,
            start_offset_bits: 0,
        }
    }
}

impl<I, J, K, N, O, P> Iterator for ComplexPackingValueDecodeIterator<I, J, K>
where
    I: Iterator<Item = N>,
    J: Iterator<Item = O>,
    K: Iterator<Item = P>,
    N: ToPrimitive,
    O: ToPrimitive,
    P: ToPrimitive,
{
    type Item = Vec<DecodedValue<i32>>;

    fn next(&mut self) -> Option<Self::Item> {
        match (
            self.ref_iter.next(),
            self.width_iter.next(),
            self.length_iter.next(),
        ) {
            (Some(_ref), Some(width), Some(length)) if width.to_usize().unwrap() == 0 => {
                // The specification states as follows: "For groups with a constant value,
                // associated field width is 0, and no incremental data are physically present."
                let _ref = _ref.to_i32().unwrap();
                let length = length.to_usize().unwrap();
                let missing1 = (1 << self.num_bits) - 1;
                let missing2 = missing1 - 1;

                if self.missing_value_management > 0 && _ref == missing1 {
                    Some(vec![Missing1; length])
                } else if self.missing_value_management == 2 && _ref == missing2 {
                    Some(vec![Missing2; length])
                } else {
                    Some(vec![Normal(_ref + self.z_min); length])
                }
            }
            (Some(_ref), Some(width), Some(length)) => {
                let (_ref, width, length) = (
                    _ref.to_i32().unwrap(),
                    width.to_usize().unwrap(),
                    length.to_usize().unwrap(),
                );
                let bits = self.start_offset_bits + width * length;
                let (pos_end, offset_bits) = (self.pos + bits / 8, bits % 8);
                let offset_byte = usize::from(offset_bits > 0);
                let missing1 = (1 << width) - 1;
                let missing2 = missing1 - 1;
                let group_values =
                    NBitwiseIterator::new(&self.data[self.pos..pos_end + offset_byte], width)
                        .with_offset(self.start_offset_bits)
                        .take(length)
                        .map(|v| {
                            if self.missing_value_management > 0 && v == missing1 {
                                Missing1
                            } else if self.missing_value_management == 2 && v == missing2 {
                                Missing2
                            } else {
                                Normal(v.as_grib_int() + _ref + self.z_min)
                            }
                        })
                        .collect::<Vec<_>>();
                self.pos = pos_end;
                self.start_offset_bits = offset_bits;
                Some(group_values)
            }
            _ => None,
        }
    }
}

mod diff;
mod missing;