summaryrefslogtreecommitdiff
path: root/src/lib/disk_writer_messages.h
blob: 61cdbcfbddebaa3c119ebf5d092163a5b7b45334 (plain)
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
/*
    Copyright (C) 2020 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    DCP-o-matic is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/

/* dcpomatic_disk_writer receives

DCP pathname\n
Internal name of drive to write to\n

   Then responds with one of the following.
*/

/** Write finished and everything was OK, e.g.

D\n

*/
#define DISK_WRITER_OK "D"

/** There was an error.  Following this will come

error message\n
error number\n

e.g.

E\n
Disc full\n
42\n

*/
#define DISK_WRITER_ERROR "E"

/** The disk writer is formatting the drive.  It is not possible
 *  to give progress reports on this so the writer just tells us
 *  it's happening.  This is finished when DISK_WRITER_PROGRESS
 *  messages start arriving
 */
#define DISK_WRITER_FORMATTING "F"

/** Some progress has been made in the main "copy" part of the task.
 *  Following this will come

progress as a float from 0 to 1\n

e.g.

P\n
0.3\n

*/
#define DISK_WRITER_PROGRESS "P"

/** dcpomatic_disk_writer may also receive

Q\n

as a request to quit.
*/
#define DISK_WRITER_QUIT "Q"