/usr/share/hplip/base/mfpdtf.py is in hplip-data 3.14.6-1+deb8u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
#
# (c) Copyright 2003-2007 Hewlett-Packard Development Company, L.P.
#
# This program 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.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Author: Don Welch
#
# Std Lib
import struct
import cStringIO
# Local
from g import *
from codes import *
# Page flags
NEW_PAGE = 0x01
END_PAGE = 0x02
NEW_DOCUMENT = 0x04
END_DOCUMENT = 0x08
END_STREAM = 0x10
RESERVED_20 = 0x20
RESERVED_40 = 0x40
RESERVED_80 = 0x80
MFPDTF_RASTER_BITMAP = 0
MFPDTF_RASTER_GRAYMAP = 1
MFPDTF_RASTER_MH = 2
MFPDTF_RASTER_MR = 3
MFPDTF_RASTER_MMR = 4
MFPDTF_RASTER_RGB = 5
MFPDTF_RASTER_YCC411 = 6
MFPDTF_RASTER_JPEG = 7
MFPDTF_RASTER_PCL = 8
MFPDTF_RASTER_NOT = 9
# Data types for FH
DT_UNKNOWN = 0
DT_FAX_IMAGES = 1
DT_SCANNED_IMAGES= 2
DT_DIAL_STRINGS = 3
DT_DEMO_PAGES = 4
DT_SPEED_DIALS = 5
DT_FAX_LOGS = 6
DT_CFG_PARMS = 7
DT_LANG_STRS = 8
DT_JUNK_FAX_CSIDS= 9
DT_REPORT_STRS = 10
DT_FONTS = 11
DT_TTI_BITMAP = 12
DT_COUNTERS = 13
DT_DEF_PARMS = 14
DT_SCAN_OPTIONS = 15
DT_FW_JOB_TABLE = 17
# Raster data record types
RT_START_PAGE = 0
RT_RASTER = 1
RT_END_PAGE = 2
# FH
FIXED_HEADER_SIZE = 8
# Variants
IMAGE_VARIANT_HEADER_SIZE = 10
DIAL_STRINGS_VARIANT_HEADER_SIZE = 6
FAX_IMAGE_VARIANT_HEADER_SIZE = 74
# Data records
SOP_RECORD_SIZE = 36
RASTER_RECORD_SIZE = 4
EOP_RECORD_SIZE = 12
DIAL_STRING_RECORD_SIZE = 51
# Page flags
PAGE_FLAG_NEW_PAGE = 0x01
PAGE_FLAG_END_PAGE = 0x02
PAGE_FLAG_NEW_DOC = 0x04
PAGE_FLAG_END_DOC = 0x08
PAGE_FLAG_END_STREAM = 0x10
# Fax data variant header data source
SRC_UNKNOWN = 0
SRC_HOST = 2
SRC_SCANNER = 5
SRC_HOST_THEN_SCANNER = 6
SRC_SCANNER_THEN_HOST = 7
# Fax data variant header TTI header control
TTI_NONE = 0
TTI_PREPENDED_TO_IMAGE = 1
TTI_OVERLAYED_ON_IMAGE = 2
MAJOR_VER = 2
MINOR_VER = 0
def parseFixedHeader(buffer):
fmt = "<IHBB"
block_len, header_len, data_type, page_flags = struct.unpack(fmt, buffer[:8])
page_flags = page_flags & 0x1f
return block_len, header_len, data_type, page_flags
def parseImageVariantHeader(buffer, data_type):
if data_type == DT_SCANNED_IMAGES:
fmt = "<BBHHHH"
major_ver, minor_ver, src_pages, copies_per_page, zoom, jpeg_q_factor = struct.unpack(fmt, buffer[:10])
return major_ver, minor_ver, src_pages, copies_per_page, zoom, jpeg_q_factor
elif data_type == DT_FAX_IMAGES:
pass
def parseRecord(buffer):
record_type = struct.unpack("<B", buffer[0])[0]
if record_type == RT_START_PAGE:
fmt = "<BBHHHIIIHHIII"
id, encoding, page_num, black_ppr, black_bpp, black_rpp, black_hort_dpi, black_vert_dpi, cmy_ppr, cmy_bpp, cmy_rpp, cmy_hort_dpi, cmy_vert_dpi = \
struct.unpack(fmt, buffer[:SOP_RECORD_SIZE])
assert id == record_type
return id, (encoding, page_num, black_ppr, black_bpp, black_rpp, black_hort_dpi, black_vert_dpi, cmy_ppr, cmy_bpp, cmy_rpp, cmy_hort_dpi, cmy_vert_dpi)
elif record_type == RT_RASTER:
fmt = "<BBH"
id, unused, data_size = struct.unpack(fmt, buffer[:RASTER_RECORD_SIZE])
assert id == record_type
return id, (unused, data_size)
elif record_type == RT_END_PAGE:
fmt = "<BBBBII"
id, unused1, unused2, unused3, black_rows, cmy_rows = struct.unpack(fmt, buffer[:EOP_RECORD_SIZE])
assert id == record_type
return id, (unused1, unused2, unused3, black_rows, cmy_rows)
log.error("Error: Invalid record type: %d" % record_type)
raise Error(ERROR_INTERNAL)
def readChannelToStream(device, channel_id, stream, single_read=True, callback=None):
STATE_END, STATE_FIXED_HEADER, STATE_VARIANT_HEADER, STATE_RECORD = range(4)
state, total_bytes, block_remaining, header_remaining, data_remaining = 1, 0, 0, 0, 0
endScan = False
while state != STATE_END:
log.debug("**** State %d ****" % state)
if state == STATE_FIXED_HEADER:
if endScan:
state = STATE_END
break
if data_remaining == 0:
fields, data = device.readChannel(channel_id)
data_remaining = len(data)
if callback is not None:
endScan = callback()
block_len, header_len, data_type, page_flags = parseFixedHeader(data)
block_remaining, header_remaining = block_len-FIXED_HEADER_SIZE, header_len-FIXED_HEADER_SIZE
log.debug("Fixed header: (datalen=%d(0x%x),blocklen=%d(0x%x),headerlen=%d(0x%x),datatype=0x%x,pageflags=0x%x)" %
(len(data), len(data), block_len, block_len, header_len, header_len, data_type, page_flags))
data_remaining -= FIXED_HEADER_SIZE
data = data[FIXED_HEADER_SIZE:]
state = STATE_RECORD
log.debug("Data: data=%d,block=%d,header=%d" % (data_remaining, block_remaining, header_remaining))
if page_flags & PAGE_FLAG_END_STREAM:
state = STATE_END
break
if header_remaining > 0:
state = STATE_VARIANT_HEADER
elif state == STATE_VARIANT_HEADER:
if data_type == DT_SCANNED_IMAGES:
major_ver, minor_ver, src_pages, copies_per_page, zoom, jpeg_q_factor = parseImageVariantHeader(data, data_type)
log.debug("Variant header: (major/minor=%d/%d,src_pages=%d,copies_per_page=%d,zoom=%d,jpeg_q_factor=%d" %
(major_ver, minor_ver, src_pages, copies_per_page, zoom, jpeg_q_factor))
data = data[IMAGE_VARIANT_HEADER_SIZE:]
block_remaining -= IMAGE_VARIANT_HEADER_SIZE
header_remaining -= IMAGE_VARIANT_HEADER_SIZE
data_remaining -= IMAGE_VARIANT_HEADER_SIZE
elif data_type == DT_FAX_IMAGES:
log.error("Unsupported data type")
else:
log.error("Unsupported data type")
log.debug("Data: data=%d,block=%d,header=%d" % (data_remaining, block_remaining, header_remaining))
if header_remaining > 0:
log.error("Header size error.")
state = STATE_END
continue
state = STATE_RECORD
if block_remaining == 0:
state = STATE_FIXED_HEADER
continue
elif state == STATE_RECORD:
record_type, record = parseRecord(data)
if record_type == RT_START_PAGE:
encoding, page_num, black_ppr, black_bpp, black_rpp, black_hort_dpi, black_vert_dpi, \
cmy_ppr, cmy_bpp, cmy_rpp, cmy_hort_dpi, cmy_vert_dpi = record
log.debug("Start page record: (encoding=0x%x, page=%d)" % (encoding, page_num))
data = data[SOP_RECORD_SIZE:]
block_remaining -= SOP_RECORD_SIZE
data_remaining -= SOP_RECORD_SIZE
if block_remaining != 0:
log.error("Block size error.")
state = STATE_END
continue
if single_read:
state = STATE_END
else:
state = STATE_FIXED_HEADER
log.debug("Data: data=%d,block=%d,header=%d" % (data_remaining, block_remaining, header_remaining))
continue
elif record_type == RT_RASTER:
unused, data_size = record
log.debug("Raster record: (data size=%d(0x%x))" % (data_size, data_size))
data = data[RASTER_RECORD_SIZE:]
block_remaining -= RASTER_RECORD_SIZE
data_remaining -= RASTER_RECORD_SIZE
log.debug("Data: data=%d,block=%d,header=%d" % (data_remaining, block_remaining, header_remaining))
if block_remaining > 0 and data_remaining > 0:
log.debug("Writing remainder of data...")
data_len = len(data)
log.debug("Data len=%d(0x%x)" % (data_len,data_len))
stream.write(data[:block_remaining])
block_remaining -= data_len
data_remaining -= data_len
if data_remaining != 0:
log.error("Data size error")
state = STATE_END
continue
while block_remaining > 0:
if endScan:
#state = STATE_END
break
log.debug("Reading more data from device...")
fields, data = device.readChannel(channel_id)
if callback is not None:
endScan = callback()
data_len = len(data)
log.debug("Data len=%d(0x%x)" % (data_len,data_len))
stream.write(data[:block_remaining])
total_bytes += data_len
block_remaining -= data_len
if block_remaining != 0:
log.error("Block size error.")
state = STATE_END
continue
state = STATE_FIXED_HEADER
continue
elif record_type == RT_END_PAGE:
unused1, unused2, unused3, black_rows, cmy_rows = record
log.debug("End page record: (black_rows=%d,cmy_rows=%d)" % (black_rows, cmy_rows))
data = data[EOP_RECORD_SIZE:]
block_remaining -= EOP_RECORD_SIZE
data_remaining -= EOP_RECORD_SIZE
if block_remaining != 0:
log.error("Block size error.")
log.debug("Data: data=%d,block=%d,header=%d" % (data_remaining, block_remaining, header_remaining))
if page_flags & PAGE_FLAG_END_DOC or \
page_flags & PAGE_FLAG_END_STREAM:
state = STATE_END
else:
state = STATE_FIXED_HEADER
continue
log.debug("Read %d bytes" % total_bytes)
return endScan
def buildMFPDTFBlock(data_type, page_flags=0, send_variant=False, data=None):
# Fixed header
# [Variant header - dial, fax, or scan]
# Data Record
block = cStringIO.StringIO()
block.write(struct.pack("<I", 0)) # Block len (4bytes)
header_len = FIXED_HEADER_SIZE
if send_variant:
if data_type == DT_DIAL_STRINGS:
header_len += DIAL_STRINGS_VARIANT_HEADER_SIZE
elif data_type == DT_FAX_IMAGES:
header_len += FAX_IMAGE_VARIANT_HEADER_SIZE
block.write(struct.pack("<H", header_len)) # Header len (2 bytes)
block.write(struct.pack("<B", data_type)) # Data type (1 byte)
block.write(struct.pack("<B", page_flags)) # Page flags (1 byte)
if send_variant:
if data_type == DT_DIAL_STRINGS:
block.write(struct.pack("<BB", MAJOR_VER, MINOR_VER))
block.write(struct.pack("<H", 1)) # num strings
block.write(struct.pack("<H", 51)) # ?
elif data_type == DT_FAX_IMAGES:
block.write(struct.pack("<BB", MAJOR_VER, MINOR_VER))
block.write(struct.pack("<B", SRC_HOST)) # Data source (1 byte)
block.write(struct.pack("<H", 1)) # Num pages (2 bytes)
block.write(struct.pack("<B", TTI_NONE)) # TTI control
block.write(struct.pack("<I", 0)) # time (4 bytes)
block.write("\x00"*20) # T30_CSI (20 bytes)
block.write("\x20"*20) # T30_SUB (20 bytes)
block.write("\x20"*20) # T30_PWD (20 bytes)
block.write("<I", 0) # xaction ID (4 bytes)
if data_type == DT_DIAL_STRINGS:
if data is not None:
dial_string = data['dial-string']
block.write(dial_string)
block.write('\x00'*(51-len(dial_string)))
elif data_type == DT_FAX_IMAGES:
pass
# fixed header (8 bytes):
#
# +----------------------------+
# | |
# | block len (32 bits) |
# | length of entire |
# | block of data |
# +----------------------------+
# | |
# | header length (16 bits) |
# | length of fixed and |
# | variant header (if any) |
# | ==8 if no variant (fixed |
# | only |
# | >8 if variant header |
# | |
# +----------------------------+
# | | 1=FAX
# | data type (8 bits) | 3=DIAL_STRINGS
# | data type of data record(s)| 12=TTI BITMAP
# | |
# +----------------------------+
# | |
# | page flags (8 bits) |
# | |
# +----------------------------+
#
# followed by variant header and/or
# data record(s)...
#
# image header variant (10 bytes)
#
# +----------------------------+
# | |
# | major ver (8 bits) |
# | |
# +----------------------------+
# | |
# | minor ver (8 bits) |
# | |
# +----------------------------+
# | |
# | source pages (16 bits) |
# | |
# +----------------------------+
# | |
# | copies/page (16 bits) |
# | |
# +----------------------------+
# | |
# | zoom factor (16 bits) |
# | |
# +----------------------------+
# | |
# | jpeg Q factor (16 bits) |
# | |
# +----------------------------+
#
# dial strings variant header (6 bytes)
#
# +----------------------------+
# | |
# | major ver (8 bits) |
# | |
# +----------------------------+
# | |
# | minor ver (8 bits) |
# | |
# +----------------------------+
# | |
# | num strings (16 bits) |
# | |
# +----------------------------+
# | |
# | dial string len (16 bits) |
# | |
# +----------------------------+
#
# dial string data part
# +----------------------------+
# | |
# | dial string (51 bytes) |
# | |
# +----------------------------+
#
# start page (SOP) record (36 bytes)
#
# +----------------------------+
# | |
# | id = 0 (8 bits) |
# | |
# +----------------------------+
# | |
# | encoding (8 bits) |
# | |
# +----------------------------+
# | |
# | page num (16 bits) |
# | |
# +----------------------------+
# | |
# | black data desc (16 bytes) |
# | |
# +----------------------------+
# | |
# | cmy data desc (16 bytes) |
# | |
# +----------------------------+
#
#
# raster data record (4 bytes + data)
#
# +----------------------------+
# | |
# | id = 1 (8 bits) |
# | |
# +----------------------------+
# | |
# | unused (8 bits) |
# | |
# +----------------------------+
# | |
# | data bytes (n) (16 bits) |
# | |
# +----------------------------+
# | |
# | data (n bytes) |
# | |
# +----------------------------+
#
#
# end page (EOP) record (12 bytes)
#
# +----------------------------+
# | |
# | id = 2 (8 bits) |
# | |
# +----------------------------+
# | |
# | unused (24 bits) |
# | |
# +----------------------------+
# | |
# | rows of black (32 bits) |
# | |
# +----------------------------+
# | |
# | rows of cmy (32 bits) |
# | |
# +----------------------------+
#
|