cir 0.1.4

Linux Infrared Tooling
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
#[cfg(target_os = "linux")]
use super::keymap::{find_devices, Purpose};
use crate::get_irp_protocols;
#[cfg(target_os = "linux")]
use cir::lirc::Lirc;
use cir::{
    keymap::{Keymap, LINUX_PROTOCOLS},
    lircd_conf::parse,
};
use irp::{Decoder, InfraredData, Irp, Message, Options};
use itertools::Itertools;
use log::{error, info};
use std::{fs, path::Path};

pub fn decode(global: &crate::App, decode: &crate::Decode) {
    let mut irp_protocols_xml = &Vec::new();

    #[allow(unused_mut)]
    let mut abs_tolerance = decode.options.aeps.unwrap_or(100);
    let rel_tolerance = decode.options.eps.unwrap_or(3);
    #[allow(unused_mut)]
    let mut max_gap = 100000;

    let mut lircd_remotes = Vec::new();
    let mut rc_keymaps = Vec::new();
    let mut irps: Vec<(&str, &str, Irp, Option<usize>)> = Vec::new();

    for irp_arg in &decode.irp {
        match get_irp_protocols(&global.irp_protocols) {
            Ok(res) => {
                irp_protocols_xml = res;
            }
            Err(e) => {
                log::error!("{}: {e}", &global.irp_protocols.display());
            }
        }

        let irp_notation = match irp_protocols_xml
            .iter()
            .find(|e| e.decodable && (&e.name == irp_arg || e.alt_name.contains(irp_arg)))
        {
            Some(e) => &e.irp,
            None => irp_arg,
        };

        log::debug!("decoding IRP: {irp_notation}");

        let irp = match Irp::parse(irp_notation) {
            Ok(m) => m,
            Err(s) => {
                eprintln!("unable to parse irp ‘{irp_notation}’: {s}");
                std::process::exit(2);
            }
        };

        irps.push((irp_arg, irp_notation, irp, None));
    }

    for path in &decode.keymap {
        if path.to_string_lossy().ends_with(".lircd.conf") {
            match parse(path) {
                Ok(r) => lircd_remotes.push((r, path)),
                Err(_) => std::process::exit(2),
            }
        } else {
            match Keymap::parse_file(path) {
                Ok(r) => rc_keymaps.push((r, path)),
                Err(e) => {
                    log::error!("{e}");
                    std::process::exit(2);
                }
            }
        }
    }

    if decode.linux_kernel {
        for protocol in LINUX_PROTOCOLS {
            if let Some(irp_notation) = protocol.irp {
                log::debug!("decoding kernel {}: {}", protocol.name, irp_notation);

                let irp = match Irp::parse(irp_notation) {
                    Ok(m) => m,
                    Err(s) => {
                        eprintln!("unable to parse irp ‘{}’: {s}", irp_notation);
                        std::process::exit(2);
                    }
                };

                irps.push((protocol.name, irp_notation, irp, None));
            }
        }
    }

    if !decode.linux_kernel && decode.irp.is_empty() && decode.keymap.is_empty() {
        match get_irp_protocols(&global.irp_protocols) {
            Ok(res) => {
                irp_protocols_xml = res;
            }
            Err(e) => {
                log::error!("{}: {e}", &global.irp_protocols.display());
                std::process::exit(2);
            }
        }

        for (protocol_no, protocol) in irp_protocols_xml
            .iter()
            .enumerate()
            .filter(|(_, e)| e.decodable)
        {
            log::debug!("decoding IRP: {} {}", protocol.name, protocol.irp);

            let irp = match Irp::parse(&protocol.irp) {
                Ok(m) => m,
                Err(s) => {
                    eprintln!("unable to parse irp ‘{}’: {s}", protocol.irp);
                    std::process::exit(2);
                }
            };

            irps.push((&protocol.name, &protocol.irp, irp, Some(protocol_no)));
        }
    }

    let input_on_cli = !decode.file.is_empty() || !decode.rawir.is_empty();

    #[cfg(target_os = "linux")]
    let lircdev = open_lirc(input_on_cli, decode, Some(&mut abs_tolerance), &mut max_gap);

    #[cfg(not(target_os = "linux"))]
    if !input_on_cli {
        eprintln!("no infrared input provided");
        std::process::exit(2);
    }

    let mut rc_keymap_decoders = Vec::new();

    for (keymaps, path) in &rc_keymaps {
        rc_keymap_decoders.extend(keymaps.iter().map(|keymap| {
            let mut options = Options {
                name: &keymap.name,
                max_gap,
                aeps: abs_tolerance,
                eps: rel_tolerance,
                ..Default::default()
            };

            options.nfa = decode.options.save_nfa;
            options.dfa = decode.options.save_dfa;

            match keymap.decoder(options) {
                Ok(decoder) => decoder,
                Err(e) => {
                    log::error!("{}: {e}", path.display());
                    std::process::exit(2);
                }
            }
        }));
    }

    let mut irp_decoders = Vec::new();

    for (name, irp_notation, irp, protocol) in irps {
        let mut options = Options {
            name,
            aeps: abs_tolerance,
            eps: rel_tolerance,
            max_gap,
            ..Default::default()
        };

        options.nfa = decode.options.save_nfa;
        options.dfa = decode.options.save_dfa;
        let dfa = match irp.compile(&options) {
            Ok(dfa) => dfa,
            Err(s) => {
                eprintln!("unable to compile irp ‘{irp_notation}’: {s}");
                std::process::exit(2);
            }
        };

        let decoder = Decoder::new(options);

        irp_decoders.push((decoder, dfa, name, protocol));
    }

    let mut lircd_decoders = Vec::new();

    for (remotes, _) in &lircd_remotes {
        lircd_decoders.extend(remotes.iter().map(|remote| {
            let mut options =
                remote.default_options(decode.options.aeps, decode.options.eps, max_gap);

            options.nfa = decode.options.save_nfa;
            options.dfa = decode.options.save_dfa;

            remote.decoder(options)
        }));
    }

    let mut feed_decoder = |raw: &[InfraredData]| {
        for ir in raw {
            for decoder in &mut rc_keymap_decoders {
                decoder.input(*ir, |name, _| {
                    println!("decoded: keymap:{} code:{}", decoder.keymap.name, name);
                });
            }

            let mut decodes = Vec::new();

            for (decoder, dfa, name, protocol) in irp_decoders.iter_mut() {
                decoder.dfa_input(*ir, dfa, |event, var| {
                    let mut var: Vec<(String, i64)> = var.into_iter().collect();
                    var.sort_by(|a, b| a.0.partial_cmp(&b.0).unwrap());
                    decodes.push((
                        *protocol,
                        format!(
                            "decoded: {name} {event} {}",
                            var.iter()
                                .map(|(name, val)| format!("{name}={val}"))
                                .join(", ")
                        ),
                    ));
                });
            }

            let prefer_over: Vec<&String> = decodes
                .iter()
                .filter_map(|e| e.0.as_ref().map(|no| &irp_protocols_xml[*no].prefer_over))
                .flatten()
                .collect();

            for (proto_no, s) in decodes {
                if let Some(no) = proto_no {
                    if prefer_over.contains(&&irp_protocols_xml[no].name) {
                        continue;
                    }
                }
                println!("{s}");
            }

            for decoder in &mut lircd_decoders {
                decoder.input(*ir, |name, _| {
                    println!("decoded: remote:{} code:{}", decoder.remote.name, name);
                });
            }
        }
    };

    for filename in &decode.file {
        let input = match fs::read_to_string(filename) {
            Ok(s) => s,
            Err(s) => {
                error!("{}: {}", Path::new(filename).display(), s);
                std::process::exit(2);
            }
        };

        info!("parsing ‘{}’ as rawir", filename.to_string_lossy());

        match Message::parse(&input) {
            Ok(raw) => {
                info!("decoding: {}", raw.print_rawir());
                feed_decoder(&InfraredData::from_u32_slice(&raw.raw));
            }
            Err(msg) => {
                info!("parsing ‘{}’ as mode2", filename.to_string_lossy());

                match Message::parse_mode2(&input) {
                    Ok(m) => {
                        info!("decoding: {}", m.print_rawir());
                        feed_decoder(&InfraredData::from_u32_slice(&m.raw));
                    }
                    Err((line_no, error)) => {
                        error!("{}: parse as rawir: {}", Path::new(filename).display(), msg);
                        error!(
                            "{}:{}: parse as mode2: {}",
                            Path::new(filename).display(),
                            line_no,
                            error
                        );
                        std::process::exit(2);
                    }
                }
            }
        }
    }

    for rawir in &decode.rawir {
        match Message::parse(rawir) {
            Ok(raw) => {
                info!("decoding: {}", raw.print_rawir());
                feed_decoder(&InfraredData::from_u32_slice(&raw.raw));
            }
            Err(msg) => {
                error!("parsing ‘{}’: {}", rawir, msg);
                std::process::exit(2);
            }
        }
    }

    #[cfg(target_os = "linux")]
    if let Some(mut lircdev) = lircdev {
        let mut rawbuf = Vec::with_capacity(1024);

        loop {
            if let Err(err) = lircdev.receive_raw(&mut rawbuf) {
                eprintln!("error: {err}");
                std::process::exit(1);
            }

            let raw: Vec<_> = rawbuf
                .iter()
                .filter_map(|raw| {
                    if raw.is_pulse() {
                        Some(InfraredData::Flash(raw.value()))
                    } else if raw.is_space() || raw.is_timeout() {
                        Some(InfraredData::Gap(raw.value()))
                    } else if raw.is_overflow() {
                        Some(InfraredData::Reset)
                    } else {
                        None
                    }
                })
                .collect();

            log::trace!("decoding: {}", raw.iter().join(" "));

            feed_decoder(&raw);
        }
    }
}

#[cfg(target_os = "linux")]
fn open_lirc(
    input_on_cli: bool,
    decode: &crate::Decode,
    abs_tolerance: Option<&mut u32>,
    max_gap: &mut u32,
) -> Option<Lirc> {
    if input_on_cli {
        return None;
    }

    // open lirc
    let rcdev = find_devices(&decode.device, Purpose::Receive);

    if let Some(lircdev) = rcdev.lircdev {
        let lircpath = std::path::PathBuf::from(lircdev);

        log::trace!("opening lirc device: {}", lircpath.display());

        let mut lircdev = match Lirc::open(&lircpath) {
            Ok(l) => l,
            Err(s) => {
                eprintln!("error: {}: {}", lircpath.display(), s);
                std::process::exit(1);
            }
        };

        if decode.learning {
            let mut learning_mode = false;

            if lircdev.can_measure_carrier() {
                if let Err(err) = lircdev.set_measure_carrier(true) {
                    eprintln!("error: {lircdev}: failed to enable measure carrier: {err}");
                    std::process::exit(1);
                }
                learning_mode = true;
            }

            if lircdev.can_use_wideband_receiver() {
                if let Err(err) = lircdev.set_wideband_receiver(true) {
                    eprintln!("error: {lircdev}: failed to enable wideband receiver: {err}");
                    std::process::exit(1);
                }
                learning_mode = true;
            }

            if !learning_mode {
                eprintln!("error: {lircdev}: lirc device does not support learning mode");
                std::process::exit(1);
            }
        }

        if lircdev.can_receive_raw() {
            if let Some(abs_tolerance) = abs_tolerance {
                if let Ok(resolution) = lircdev.receiver_resolution() {
                    if resolution > *abs_tolerance {
                        log::info!(
                            "{} resolution is {}, using absolute tolerance {} rather than {}",
                            lircdev,
                            resolution,
                            resolution,
                            abs_tolerance
                        );

                        *abs_tolerance = resolution;
                    }
                }
            }

            if let Ok(timeout) = lircdev.get_timeout() {
                let dev_max_gap = (timeout * 9) / 10;

                log::trace!(
                    "device reports timeout of {}, using 90% of that as {} max_gap",
                    timeout,
                    dev_max_gap
                );

                *max_gap = dev_max_gap;
            }

            Some(lircdev)
        } else {
            error!("{}: device cannot receive raw", lircdev);
            std::process::exit(1);
        }
    } else {
        error!("{}: no lirc device found", rcdev.name);
        std::process::exit(1);
    }
}