oximedia-packager 0.1.8

Adaptive streaming packaging (HLS/DASH) for OxiMedia
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
//! DASH packaging implementation.

use crate::config::{PackagerConfig, SegmentFormat};
use crate::dash::cmaf::{CmafHeader, CmafTrack, TrackType};
use crate::dash::mpd::{
    representation_from_bitrate_entry, AdaptationSet, DashProfile, MpdBuilder, MpdType, Period,
    SegmentTemplate,
};
use crate::encryption::EncryptionHandler;
use crate::error::{PackagerError, PackagerResult};
use crate::ladder::{LadderGenerator, SourceInfo};
use crate::output::OutputManager;
use crate::segment::{SegmentGenerator, SegmentWriter};
use camino::Utf8Path;
use std::time::Duration;
use tracing::info;

/// DASH packager.
pub struct DashPackager {
    config: PackagerConfig,
    output_manager: OutputManager,
    encryption_handler: Option<EncryptionHandler>,
    segment_infos: Vec<(String, Vec<crate::segment::SegmentInfo>)>, // (representation_id, segments)
}

impl DashPackager {
    /// Create a new DASH packager.
    pub fn new(config: PackagerConfig) -> PackagerResult<Self> {
        config.validate()?;

        let output_manager = OutputManager::new(config.output.clone())?;

        let encryption_handler = if config.encryption.is_enabled() {
            Some(EncryptionHandler::new(config.encryption.method))
        } else {
            None
        };

        Ok(Self {
            config,
            output_manager,
            encryption_handler,
            segment_infos: Vec::new(),
        })
    }

    /// Package input to DASH output.
    pub async fn package(&mut self, input: &str) -> PackagerResult<()> {
        info!("Starting DASH packaging for: {}", input);

        // Initialize output structure
        self.output_manager.initialize().await?;

        // Generate or validate bitrate ladder
        let ladder = if self.config.ladder.auto_generate {
            self.generate_ladder_from_source(input).await?
        } else {
            self.config.ladder.clone()
        };

        info!(
            "Using bitrate ladder with {} variants",
            ladder.entries.len()
        );

        // Process each representation
        for (idx, entry) in ladder.entries.iter().enumerate() {
            let representation_id = format!("video_{idx}");

            info!(
                "Processing representation: {} ({}x{} @ {} bps)",
                representation_id, entry.width, entry.height, entry.bitrate
            );

            // Create representation directory
            let _repr_dir = self
                .output_manager
                .structure_mut()
                .add_variant(&representation_id, entry.bitrate);

            // Generate initialization segment
            self.generate_init_segment(&representation_id, entry)
                .await?;

            // Process and segment video
            let segments = self
                .process_representation(input, &representation_id, entry)
                .await?;

            self.segment_infos
                .push((representation_id.clone(), segments));
        }

        // Generate MPD manifest
        self.generate_mpd().await?;

        info!("DASH packaging completed");

        Ok(())
    }

    /// Generate bitrate ladder from source.
    async fn generate_ladder_from_source(
        &self,
        _input: &str,
    ) -> PackagerResult<crate::config::BitrateLadder> {
        // In a real implementation, this would analyze the input file
        let source = SourceInfo::new(1920, 1080, 30.0, "av1".to_string());

        let generator = LadderGenerator::new(source).with_codec("av1");

        generator.generate()
    }

    /// Generate initialization segment for a representation.
    async fn generate_init_segment(
        &self,
        representation_id: &str,
        entry: &crate::config::BitrateEntry,
    ) -> PackagerResult<()> {
        let track = CmafTrack::new(1, TrackType::Video, 90000, entry.codec.clone())
            .with_duration(Duration::from_secs(60));

        let header = CmafHeader::new(track);
        let init_data = header.generate_init_segment()?;

        // Write initialization segment
        let init_path = Utf8Path::new(representation_id).join("init.mp4");
        self.output_manager
            .write_file(&init_path, &init_data)
            .await?;

        info!(
            "Generated initialization segment for {}: {} bytes",
            representation_id,
            init_data.len()
        );

        Ok(())
    }

    /// Process a representation and generate segments.
    async fn process_representation(
        &self,
        _input: &str,
        representation_id: &str,
        _entry: &crate::config::BitrateEntry,
    ) -> PackagerResult<Vec<crate::segment::SegmentInfo>> {
        let repr_dir = self
            .output_manager
            .structure()
            .get_variant(representation_id)
            .ok_or_else(|| PackagerError::invalid_config("Representation directory not found"))?;

        let mut segment_config = self.config.segment.clone();
        segment_config.format = SegmentFormat::Cmaf;

        let mut segment_generator = SegmentGenerator::new(segment_config);
        let segment_writer = SegmentWriter::new(repr_dir.clone().into());

        let mut segments = Vec::new();

        // Create 10 sample segments
        for i in 0..10 {
            let timestamp = Duration::from_secs(i * 6);

            // Create sample frame data
            let frame_data = vec![0u8; 100_000];

            // Add frame (keyframe every 6 seconds)
            if let Some(segment_info) = segment_generator.add_frame(&frame_data, true, timestamp)? {
                // Encrypt if needed
                let segment_data = if let Some(handler) = &self.encryption_handler {
                    handler.encrypt(&frame_data)?
                } else {
                    frame_data
                };

                // Write segment
                segment_writer
                    .write_segment(&segment_info, &segment_data)
                    .await?;

                segments.push(segment_info);
            }
        }

        // Finalize last segment
        let final_timestamp = Duration::from_secs(60);
        let final_data = vec![0u8; 100_000];

        if let Some(segment_info) =
            segment_generator.add_frame(&final_data, true, final_timestamp)?
        {
            let segment_data = if let Some(handler) = &self.encryption_handler {
                handler.encrypt(&final_data)?
            } else {
                final_data
            };

            segment_writer
                .write_segment(&segment_info, &segment_data)
                .await?;
            segments.push(segment_info);
        }

        info!(
            "Created {} segments for representation {}",
            segments.len(),
            representation_id
        );

        Ok(segments)
    }

    /// Generate MPD manifest.
    async fn generate_mpd(&self) -> PackagerResult<()> {
        info!("Generating DASH MPD manifest");

        let mpd_type = MpdType::Static;
        let profile = DashProfile::OnDemand;

        let mut mpd_builder =
            MpdBuilder::new(mpd_type, profile).with_min_buffer_time(Duration::from_secs(2));

        if let Some(base_url) = self.output_manager.base_url() {
            mpd_builder = mpd_builder.with_base_url(base_url.to_string());
        }

        // Calculate total duration
        let total_duration = if let Some((_, segments)) = self.segment_infos.first() {
            segments.iter().map(|s| s.duration).sum()
        } else {
            Duration::ZERO
        };

        mpd_builder = mpd_builder.with_duration(total_duration);

        // Create period
        let mut period = Period::new("0".to_string()).with_duration(total_duration);

        // Create video adaptation set
        let mut video_set = AdaptationSet::new(0, "video".to_string(), "video/mp4".to_string());

        for (repr_id, _segments) in &self.segment_infos {
            // Find bitrate entry for this representation
            let idx: usize = repr_id
                .strip_prefix("video_")
                .and_then(|s| s.parse().ok())
                .unwrap_or(0);

            if let Some(entry) = self.config.ladder.entries.get(idx) {
                let mut repr = representation_from_bitrate_entry(entry, repr_id.clone())?;

                // Add segment template
                let segment_template = SegmentTemplate::new(
                    format!("{repr_id}/init.mp4"),
                    format!("{repr_id}/$Number$.m4s"),
                    self.config.segment.duration.as_secs() * 90000,
                    90000,
                );

                repr = repr.with_segment_template(segment_template);

                video_set.add_representation(repr);
            }
        }

        period.add_adaptation_set(video_set);
        mpd_builder.add_period(period);

        // Build MPD
        let mpd_xml = mpd_builder.build()?;

        // Write MPD
        let mpd_path = Utf8Path::new("manifest.mpd");
        self.output_manager
            .write_file(mpd_path, mpd_xml.as_bytes())
            .await?;

        info!("Generated MPD manifest: manifest.mpd");

        Ok(())
    }

    /// Package for live streaming.
    pub async fn package_live(&mut self, input: &str) -> PackagerResult<()> {
        info!("Starting DASH live packaging for: {}", input);

        self.output_manager.initialize().await?;

        tracing::warn!("Live packaging not fully implemented yet");

        Ok(())
    }

    /// Update MPD for live streaming.
    pub async fn update_live_mpd(&mut self) -> PackagerResult<()> {
        self.generate_mpd().await
    }

    /// Get output directory.
    #[must_use]
    pub fn output_directory(&self) -> &Utf8Path {
        &self.output_manager.structure().root
    }
}

/// DASH packager builder for easier configuration.
pub struct DashPackagerBuilder {
    config: PackagerConfig,
}

impl DashPackagerBuilder {
    /// Create a new DASH packager builder.
    #[must_use]
    pub fn new() -> Self {
        let mut config = PackagerConfig::default();
        config.format = crate::config::PackagingFormat::Dash;
        config.segment.format = SegmentFormat::Cmaf;

        Self { config }
    }

    /// Set segment duration.
    #[must_use]
    pub fn with_segment_duration(mut self, duration: Duration) -> Self {
        self.config.segment.duration = duration;
        self
    }

    /// Set output directory.
    #[must_use]
    pub fn with_output_directory(mut self, dir: std::path::PathBuf) -> Self {
        self.config.output.directory = dir;
        self
    }

    /// Set base URL.
    #[must_use]
    pub fn with_base_url(mut self, url: String) -> Self {
        self.config.output.base_url = Some(url);
        self
    }

    /// Enable encryption.
    #[must_use]
    pub fn with_encryption(mut self, method: crate::config::EncryptionMethod) -> Self {
        self.config.encryption.method = method;
        self
    }

    /// Set bitrate ladder.
    #[must_use]
    pub fn with_ladder(mut self, ladder: crate::config::BitrateLadder) -> Self {
        self.config.ladder = ladder;
        self
    }

    /// Enable low latency mode.
    #[must_use]
    pub fn with_low_latency(mut self, enabled: bool) -> Self {
        self.config.low_latency = enabled;
        self
    }

    /// Build the packager.
    pub fn build(self) -> PackagerResult<DashPackager> {
        DashPackager::new(self.config)
    }
}

impl Default for DashPackagerBuilder {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_dash_packager_builder() {
        let packager = DashPackagerBuilder::new()
            .with_segment_duration(Duration::from_secs(4))
            .with_output_directory(std::env::temp_dir().join("oximedia-packager-dash-out"))
            .build();

        assert!(packager.is_ok());
    }

    #[test]
    fn test_cmaf_segment_format() {
        let packager = DashPackagerBuilder::new()
            .build()
            .expect("should succeed in test");

        assert_eq!(packager.config.segment.format, SegmentFormat::Cmaf);
    }

    #[test]
    fn test_low_latency_mode() {
        let packager = DashPackagerBuilder::new()
            .with_low_latency(true)
            .build()
            .expect("should succeed in test");

        assert!(packager.config.low_latency);
    }
}