pixelsrc 0.2.0

Pixelsrc - GenAI-native pixel art format and compiler
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
//! libGDX engine export format.
//!
//! Exports atlas metadata to libGDX TextureAtlas format (.atlas files).
//! This is the standard format used by libGDX's TexturePacker and TextureAtlas classes.
//!
//! # Output Format
//!
//! The libGDX exporter generates a text-based .atlas file:
//!
//! ```text
//! atlas.png
//! size: 256, 256
//! format: RGBA8888
//! filter: Nearest, Nearest
//! repeat: none
//! player_idle
//!   rotate: false
//!   xy: 0, 0
//!   size: 32, 32
//!   orig: 32, 32
//!   offset: 0, 0
//!   index: -1
//! player_walk
//!   rotate: false
//!   xy: 32, 0
//!   size: 32, 32
//!   orig: 32, 32
//!   offset: 0, 0
//!   index: 0
//! ```
//!
//! This format is directly loadable by libGDX's `TextureAtlas` class.

use crate::atlas::AtlasMetadata;
use crate::export::{ExportError, ExportOptions, Exporter};
use std::fs::File;
use std::io::Write;
use std::path::Path;

/// libGDX texture filter mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum LibGdxFilterMode {
    /// Nearest neighbor filtering - pixel perfect
    #[default]
    Nearest,
    /// Linear filtering - smooth
    Linear,
    /// Mipmap with nearest filtering
    MipMapNearestNearest,
    /// Mipmap with linear filtering
    MipMapLinearLinear,
}

impl LibGdxFilterMode {
    /// Get the libGDX format string for this filter mode.
    pub fn as_str(&self) -> &'static str {
        match self {
            LibGdxFilterMode::Nearest => "Nearest",
            LibGdxFilterMode::Linear => "Linear",
            LibGdxFilterMode::MipMapNearestNearest => "MipMapNearestNearest",
            LibGdxFilterMode::MipMapLinearLinear => "MipMapLinearLinear",
        }
    }
}

/// libGDX texture repeat mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum LibGdxRepeatMode {
    /// No repeat (clamp to edge)
    #[default]
    None,
    /// Repeat in X direction
    X,
    /// Repeat in Y direction
    Y,
    /// Repeat in both directions
    XY,
}

impl LibGdxRepeatMode {
    /// Get the libGDX format string for this repeat mode.
    pub fn as_str(&self) -> &'static str {
        match self {
            LibGdxRepeatMode::None => "none",
            LibGdxRepeatMode::X => "x",
            LibGdxRepeatMode::Y => "y",
            LibGdxRepeatMode::XY => "xy",
        }
    }
}

/// libGDX export configuration options.
#[derive(Debug, Clone)]
pub struct LibGdxExportOptions {
    /// Base export options
    pub base: ExportOptions,
    /// Texture filter mode (minification, magnification)
    pub filter: (LibGdxFilterMode, LibGdxFilterMode),
    /// Texture repeat mode
    pub repeat: LibGdxRepeatMode,
    /// Pixel format (e.g., "RGBA8888", "RGB888", "RGBA4444")
    pub format: String,
}

impl Default for LibGdxExportOptions {
    fn default() -> Self {
        Self {
            base: ExportOptions::default(),
            filter: (LibGdxFilterMode::Nearest, LibGdxFilterMode::Nearest),
            repeat: LibGdxRepeatMode::None,
            format: "RGBA8888".to_string(),
        }
    }
}

/// libGDX format exporter.
///
/// Exports atlas metadata to libGDX TextureAtlas (.atlas) format.
#[derive(Debug)]
pub struct LibGdxExporter {
    /// Minification filter
    min_filter: LibGdxFilterMode,
    /// Magnification filter
    mag_filter: LibGdxFilterMode,
    /// Repeat mode
    repeat: LibGdxRepeatMode,
    /// Pixel format
    format: String,
}

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

impl LibGdxExporter {
    /// Create a new libGDX exporter with default settings.
    pub fn new() -> Self {
        Self {
            min_filter: LibGdxFilterMode::Nearest,
            mag_filter: LibGdxFilterMode::Nearest,
            repeat: LibGdxRepeatMode::None,
            format: "RGBA8888".to_string(),
        }
    }

    /// Set the minification filter.
    pub fn with_min_filter(mut self, filter: LibGdxFilterMode) -> Self {
        self.min_filter = filter;
        self
    }

    /// Set the magnification filter.
    pub fn with_mag_filter(mut self, filter: LibGdxFilterMode) -> Self {
        self.mag_filter = filter;
        self
    }

    /// Set both filters to the same mode.
    pub fn with_filter(mut self, filter: LibGdxFilterMode) -> Self {
        self.min_filter = filter;
        self.mag_filter = filter;
        self
    }

    /// Set the repeat mode.
    pub fn with_repeat(mut self, repeat: LibGdxRepeatMode) -> Self {
        self.repeat = repeat;
        self
    }

    /// Set the pixel format.
    pub fn with_format(mut self, format: impl Into<String>) -> Self {
        self.format = format.into();
        self
    }

    /// Export atlas metadata to libGDX format.
    pub fn export_libgdx(
        &self,
        metadata: &AtlasMetadata,
        output_path: &Path,
        _options: &LibGdxExportOptions,
    ) -> Result<(), ExportError> {
        let content = self.generate_atlas_content(metadata);

        if let Some(parent) = output_path.parent() {
            if !parent.exists() {
                std::fs::create_dir_all(parent)?;
            }
        }

        let mut file = File::create(output_path)?;
        file.write_all(content.as_bytes())?;

        Ok(())
    }

    /// Generate the atlas file content as a string.
    pub fn export_to_string(&self, metadata: &AtlasMetadata) -> String {
        self.generate_atlas_content(metadata)
    }

    /// Generate the libGDX TextureAtlas content.
    fn generate_atlas_content(&self, metadata: &AtlasMetadata) -> String {
        let mut content = String::new();

        // Header: image filename
        content.push_str(&metadata.image);
        content.push('\n');

        // Atlas properties
        content.push_str(&format!("size: {}, {}\n", metadata.size[0], metadata.size[1]));
        content.push_str(&format!("format: {}\n", self.format));
        content.push_str(&format!(
            "filter: {}, {}\n",
            self.min_filter.as_str(),
            self.mag_filter.as_str()
        ));
        content.push_str(&format!("repeat: {}\n", self.repeat.as_str()));

        // Collect and sort frame names for deterministic output
        let mut frame_names: Vec<&String> = metadata.frames.keys().collect();
        frame_names.sort();

        // Build animation frame indices map
        let animation_indices = self.build_animation_indices(metadata);

        // Write each frame/region
        for name in frame_names {
            if let Some(frame) = metadata.frames.get(name) {
                content.push_str(name);
                content.push('\n');

                // Region properties (indented with 2 spaces)
                content.push_str("  rotate: false\n");
                content.push_str(&format!("  xy: {}, {}\n", frame.x, frame.y));
                content.push_str(&format!("  size: {}, {}\n", frame.w, frame.h));
                content.push_str(&format!("  orig: {}, {}\n", frame.w, frame.h));

                // Calculate offset from origin if present
                let (offset_x, offset_y) =
                    if let Some(origin) = &frame.origin { (origin[0], origin[1]) } else { (0, 0) };
                content.push_str(&format!("  offset: {}, {}\n", offset_x, offset_y));

                // Index for animation sequences (-1 means not part of sequence)
                let index = animation_indices.get(name.as_str()).copied().unwrap_or(-1);
                content.push_str(&format!("  index: {}\n", index));
            }
        }

        content
    }

    /// Build a map of frame names to their animation sequence indices.
    fn build_animation_indices<'a>(
        &self,
        metadata: &'a AtlasMetadata,
    ) -> std::collections::HashMap<&'a str, i32> {
        let mut indices = std::collections::HashMap::new();

        for animation in metadata.animations.values() {
            for (i, frame_name) in animation.frames.iter().enumerate() {
                indices.insert(frame_name.as_str(), i as i32);
            }
        }

        indices
    }
}

impl Exporter for LibGdxExporter {
    fn export(
        &self,
        metadata: &AtlasMetadata,
        output_path: &Path,
        options: &ExportOptions,
    ) -> Result<(), ExportError> {
        let libgdx_options = LibGdxExportOptions { base: options.clone(), ..Default::default() };
        self.export_libgdx(metadata, output_path, &libgdx_options)
    }

    fn format_name(&self) -> &'static str {
        "libGDX TextureAtlas"
    }

    fn extension(&self) -> &'static str {
        "atlas"
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::atlas::{AtlasAnimation, AtlasFrame};
    use std::collections::HashMap;
    use tempfile::tempdir;

    fn create_test_metadata() -> AtlasMetadata {
        let mut frames = HashMap::new();
        frames.insert(
            "player_idle".to_string(),
            AtlasFrame { x: 0, y: 0, w: 32, h: 32, origin: None, boxes: None },
        );
        frames.insert(
            "player_walk_1".to_string(),
            AtlasFrame { x: 32, y: 0, w: 32, h: 32, origin: Some([16, 32]), boxes: None },
        );
        frames.insert(
            "player_walk_2".to_string(),
            AtlasFrame { x: 64, y: 0, w: 32, h: 32, origin: Some([16, 32]), boxes: None },
        );

        let mut animations = HashMap::new();
        animations.insert(
            "walk".to_string(),
            AtlasAnimation {
                frames: vec!["player_walk_1".to_string(), "player_walk_2".to_string()],
                fps: 10,
                tags: None,
            },
        );

        AtlasMetadata { image: "atlas.png".to_string(), size: [128, 64], frames, animations }
    }

    #[test]
    fn test_libgdx_exporter_new() {
        let exporter = LibGdxExporter::new();
        assert_eq!(exporter.min_filter, LibGdxFilterMode::Nearest);
        assert_eq!(exporter.mag_filter, LibGdxFilterMode::Nearest);
        assert_eq!(exporter.repeat, LibGdxRepeatMode::None);
        assert_eq!(exporter.format, "RGBA8888");
    }

    #[test]
    fn test_libgdx_exporter_with_options() {
        let exporter = LibGdxExporter::new()
            .with_min_filter(LibGdxFilterMode::Linear)
            .with_mag_filter(LibGdxFilterMode::MipMapLinearLinear)
            .with_repeat(LibGdxRepeatMode::XY)
            .with_format("RGB888");

        assert_eq!(exporter.min_filter, LibGdxFilterMode::Linear);
        assert_eq!(exporter.mag_filter, LibGdxFilterMode::MipMapLinearLinear);
        assert_eq!(exporter.repeat, LibGdxRepeatMode::XY);
        assert_eq!(exporter.format, "RGB888");
    }

    #[test]
    fn test_libgdx_export_options_default() {
        let options = LibGdxExportOptions::default();
        assert_eq!(options.filter.0, LibGdxFilterMode::Nearest);
        assert_eq!(options.filter.1, LibGdxFilterMode::Nearest);
        assert_eq!(options.repeat, LibGdxRepeatMode::None);
        assert_eq!(options.format, "RGBA8888");
    }

    #[test]
    fn test_filter_mode_as_str() {
        assert_eq!(LibGdxFilterMode::Nearest.as_str(), "Nearest");
        assert_eq!(LibGdxFilterMode::Linear.as_str(), "Linear");
        assert_eq!(LibGdxFilterMode::MipMapNearestNearest.as_str(), "MipMapNearestNearest");
        assert_eq!(LibGdxFilterMode::MipMapLinearLinear.as_str(), "MipMapLinearLinear");
    }

    #[test]
    fn test_repeat_mode_as_str() {
        assert_eq!(LibGdxRepeatMode::None.as_str(), "none");
        assert_eq!(LibGdxRepeatMode::X.as_str(), "x");
        assert_eq!(LibGdxRepeatMode::Y.as_str(), "y");
        assert_eq!(LibGdxRepeatMode::XY.as_str(), "xy");
    }

    #[test]
    fn test_export_to_string_header() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        assert!(content.starts_with("atlas.png\n"));
        assert!(content.contains("size: 128, 64\n"));
        assert!(content.contains("format: RGBA8888\n"));
        assert!(content.contains("filter: Nearest, Nearest\n"));
        assert!(content.contains("repeat: none\n"));
    }

    #[test]
    fn test_export_to_string_frames() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        // Check player_idle frame
        assert!(content.contains("player_idle\n"));
        assert!(content.contains("  xy: 0, 0\n"));
        assert!(content.contains("  size: 32, 32\n"));

        // Check player_walk_1 frame
        assert!(content.contains("player_walk_1\n"));
        assert!(content.contains("  xy: 32, 0\n"));
    }

    #[test]
    fn test_export_frame_with_origin() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        // player_walk_1 has origin [16, 32]
        // The offset should reflect this
        assert!(content.contains("  offset: 16, 32\n"));
    }

    #[test]
    fn test_export_frame_without_origin() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        // player_idle has no origin, should default to 0, 0
        // Need to check the specific frame's offset
        let lines: Vec<&str> = content.lines().collect();
        let idle_idx = lines.iter().position(|l| *l == "player_idle").unwrap();
        let offset_line = lines[idle_idx + 5]; // offset is 5 lines after frame name
        assert_eq!(offset_line, "  offset: 0, 0");
    }

    #[test]
    fn test_export_animation_indices() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        // player_walk_1 should have index 0, player_walk_2 should have index 1
        let lines: Vec<&str> = content.lines().collect();

        // Find player_walk_1 and check its index
        let walk1_idx = lines.iter().position(|l| *l == "player_walk_1").unwrap();
        let index1_line = lines[walk1_idx + 6]; // index is 6 lines after frame name
        assert_eq!(index1_line, "  index: 0");

        // Find player_walk_2 and check its index
        let walk2_idx = lines.iter().position(|l| *l == "player_walk_2").unwrap();
        let index2_line = lines[walk2_idx + 6];
        assert_eq!(index2_line, "  index: 1");

        // player_idle should have index -1 (not in animation)
        let idle_idx = lines.iter().position(|l| *l == "player_idle").unwrap();
        let index_idle_line = lines[idle_idx + 6];
        assert_eq!(index_idle_line, "  index: -1");
    }

    #[test]
    fn test_export_creates_file() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let options = LibGdxExportOptions::default();

        let dir = tempdir().unwrap();
        let output_path = dir.path().join("test.atlas");

        exporter.export_libgdx(&metadata, &output_path, &options).unwrap();

        assert!(output_path.exists());

        let content = std::fs::read_to_string(&output_path).unwrap();
        assert!(content.starts_with("atlas.png\n"));
    }

    #[test]
    fn test_export_creates_directories() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let options = LibGdxExportOptions::default();

        let dir = tempdir().unwrap();
        let output_path = dir.path().join("nested").join("dir").join("test.atlas");

        exporter.export_libgdx(&metadata, &output_path, &options).unwrap();

        assert!(output_path.exists());
    }

    #[test]
    fn test_export_via_trait() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let options = ExportOptions::default();

        let dir = tempdir().unwrap();
        let output_path = dir.path().join("test.atlas");

        exporter.export(&metadata, &output_path, &options).unwrap();

        assert!(output_path.exists());
    }

    #[test]
    fn test_format_name() {
        let exporter = LibGdxExporter::new();
        assert_eq!(exporter.format_name(), "libGDX TextureAtlas");
    }

    #[test]
    fn test_extension() {
        let exporter = LibGdxExporter::new();
        assert_eq!(exporter.extension(), "atlas");
    }

    #[test]
    fn test_export_with_linear_filter() {
        let exporter = LibGdxExporter::new().with_filter(LibGdxFilterMode::Linear);
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        assert!(content.contains("filter: Linear, Linear\n"));
    }

    #[test]
    fn test_export_with_repeat() {
        let exporter = LibGdxExporter::new().with_repeat(LibGdxRepeatMode::XY);
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        assert!(content.contains("repeat: xy\n"));
    }

    #[test]
    fn test_frames_sorted_alphabetically() {
        let exporter = LibGdxExporter::new();
        let metadata = create_test_metadata();
        let content = exporter.export_to_string(&metadata);

        let lines: Vec<&str> = content.lines().collect();

        // Find frame name lines (lines that don't start with whitespace after header)
        let frame_lines: Vec<&str> = lines
            .iter()
            .skip(5) // Skip header lines
            .filter(|l| !l.starts_with(' ') && !l.is_empty())
            .copied()
            .collect();

        assert_eq!(frame_lines, vec!["player_idle", "player_walk_1", "player_walk_2"]);
    }

    #[test]
    fn test_export_empty_animations() {
        let exporter = LibGdxExporter::new();

        let mut frames = HashMap::new();
        frames.insert(
            "sprite".to_string(),
            AtlasFrame { x: 0, y: 0, w: 16, h: 16, origin: None, boxes: None },
        );

        let metadata = AtlasMetadata {
            image: "test.png".to_string(),
            size: [16, 16],
            frames,
            animations: HashMap::new(),
        };

        let content = exporter.export_to_string(&metadata);

        // With no animations, all frames should have index -1
        assert!(content.contains("  index: -1\n"));
    }
}