retrace: Support index bias.
[mesa.git] / src / gallium / tests / python / retrace / interpreter.py
1 #!/usr/bin/env python
2 ##########################################################################
3 #
4 # Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
5 # All Rights Reserved.
6 #
7 # Permission is hereby granted, free of charge, to any person obtaining a
8 # copy of this software and associated documentation files (the
9 # "Software"), to deal in the Software without restriction, including
10 # without limitation the rights to use, copy, modify, merge, publish,
11 # distribute, sub license, and/or sell copies of the Software, and to
12 # permit persons to whom the Software is furnished to do so, subject to
13 # the following conditions:
14 #
15 # The above copyright notice and this permission notice (including the
16 # next paragraph) shall be included in all copies or substantial portions
17 # of the Software.
18 #
19 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
22 # IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
23 # ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 #
27 ##########################################################################
28
29
30 import sys
31 import struct
32
33 import gallium
34 import model
35 import parse as parser
36
37
38 try:
39 from struct import unpack_from
40 except ImportError:
41 def unpack_from(fmt, buf, offset=0):
42 size = struct.calcsize(fmt)
43 return struct.unpack(fmt, buf[offset:offset + size])
44
45
46 def make_image(ctx, surface, x=None, y=None, w=None, h=None):
47 if x is None:
48 x = 0
49 if y is None:
50 y = 0
51 if w is None:
52 w = surface.width - x
53 if h is None:
54 h = surface.height - y
55 data = ctx.surface_read_rgba8(surface, x, y, surface.width, surface.height)
56
57 import Image
58 outimage = Image.fromstring('RGBA', (w, h), data, "raw", 'RGBA', 0, 1)
59 return outimage
60
61 def save_image(ctx, filename, surface, x=None, y=None, w=None, h=None):
62 outimage = make_image(ctx, surface, x, y, w, h)
63 outimage.save(filename, "PNG")
64
65 def show_image(ctx, surface, title, x=None, y=None, w=None, h=None):
66 outimage = make_image(ctx, surface, x, y, w, h)
67
68 import Tkinter as tk
69 from PIL import Image, ImageTk
70 root = tk.Tk()
71
72 root.title(title)
73
74 image1 = ImageTk.PhotoImage(outimage)
75 w = image1.width()
76 h = image1.height()
77 x = 100
78 y = 100
79 root.geometry("%dx%d+%d+%d" % (w, h, x, y))
80 panel1 = tk.Label(root, image=image1)
81 panel1.pack(side='top', fill='both', expand='yes')
82 panel1.image = image1
83 root.mainloop()
84
85
86 class Struct:
87 """C-like struct"""
88
89 # A basic Python class can pass as a C-like structure
90 pass
91
92
93 struct_factories = {
94 "pipe_blend_color": gallium.BlendColor,
95 "pipe_blend_state": gallium.Blend,
96 #"pipe_clip_state": gallium.Clip,
97 #"pipe_buffer": gallium.Buffer,
98 "pipe_depth_state": gallium.Depth,
99 "pipe_stencil_state": gallium.Stencil,
100 "pipe_alpha_state": gallium.Alpha,
101 "pipe_depth_stencil_alpha_state": gallium.DepthStencilAlpha,
102 #"pipe_framebuffer_state": gallium.Framebuffer,
103 "pipe_poly_stipple": gallium.PolyStipple,
104 "pipe_rasterizer_state": gallium.Rasterizer,
105 "pipe_sampler_state": gallium.Sampler,
106 "pipe_scissor_state": gallium.Scissor,
107 #"pipe_shader_state": gallium.Shader,
108 #"pipe_vertex_buffer": gallium.VertexBuffer,
109 "pipe_vertex_element": gallium.VertexElement,
110 "pipe_viewport_state": gallium.Viewport,
111 #"pipe_texture": gallium.Texture,
112 'pipe_subresource': gallium.pipe_subresource,
113 'pipe_box': gallium.pipe_box,
114 }
115
116
117 member_array_factories = {
118 #"pipe_rasterizer_state": {"sprite_coord_mode": gallium.ByteArray},
119 "pipe_poly_stipple": {"stipple": gallium.UnsignedArray},
120 "pipe_viewport_state": {"scale": gallium.FloatArray, "translate": gallium.FloatArray},
121 #"pipe_clip_state": {"ucp": gallium.FloatArray},
122 "pipe_depth_stencil_alpha_state": {"stencil": gallium.StencilArray},
123 "pipe_blend_color": {"color": gallium.FloatArray},
124 "pipe_sampler_state": {"border_color": gallium.FloatArray},
125 }
126
127
128 class Translator(model.Visitor):
129 """Translate model arguments into regular Python objects"""
130
131 def __init__(self, interpreter):
132 self.interpreter = interpreter
133 self.result = None
134
135 def visit(self, node):
136 self.result = None
137 node.visit(self)
138 return self.result
139
140 def visit_literal(self, node):
141 self.result = node.value
142
143 def visit_named_constant(self, node):
144 # lookup the named constant in the gallium module
145 self.result = getattr(gallium, node.name)
146
147 def visit_array(self, node):
148 array = []
149 for element in node.elements:
150 array.append(self.visit(element))
151 self.result = array
152
153 def visit_struct(self, node):
154 struct_factory = struct_factories.get(node.name, Struct)
155 struct = struct_factory()
156 for member_name, member_node in node.members:
157 member_value = self.visit(member_node)
158 try:
159 array_factory = member_array_factories[node.name][member_name]
160 except KeyError:
161 pass
162 else:
163 assert isinstance(member_value, list)
164 array = array_factory(len(member_value))
165 for i in range(len(member_value)):
166 array[i] = member_value[i]
167 member_value = array
168 #print node.name, member_name, member_value
169 assert isinstance(struct, Struct) or hasattr(struct, member_name)
170 setattr(struct, member_name, member_value)
171 self.result = struct
172
173 def visit_pointer(self, node):
174 self.result = self.interpreter.lookup_object(node.address)
175
176
177 class Object:
178
179 def __init__(self, interpreter, real):
180 self.interpreter = interpreter
181 self.real = real
182
183
184 class Global(Object):
185
186 def __init__(self, interpreter, real):
187 self.interpreter = interpreter
188 self.real = real
189
190 def pipe_screen_create(self):
191 real = gallium.Device()
192 return Screen(self.interpreter, real)
193
194 def pipe_context_create(self, screen):
195 context = screen.real.context_create()
196 return Context(self.interpreter, context)
197
198
199 class Transfer:
200
201 def __init__(self, resource, usage, subresource, box):
202 self.resource = resource
203 self.usage = usage
204 self.subresource = subresource
205 self.box = box
206
207
208 class Screen(Object):
209
210 def __init__(self, interpreter, real):
211 Object.__init__(self, interpreter, real)
212 self.context = self.real.context_create()
213
214 def destroy(self):
215 pass
216
217 def get_name(self):
218 pass
219
220 def get_vendor(self):
221 pass
222
223 def get_param(self, param):
224 pass
225
226 def get_paramf(self, param):
227 pass
228
229 def context_create(self):
230 context = self.real.context_create()
231 return Context(self.interpreter, context)
232
233 def is_format_supported(self, format, target, bind, geom_flags):
234 return self.real.is_format_supported(format, target, bind, geom_flags)
235
236 def resource_create(self, templat):
237 return self.real.resource_create(
238 format = templat.format,
239 width = templat.width,
240 height = templat.height,
241 depth = templat.depth,
242 last_level = templat.last_level,
243 target = templat.target,
244 bind = templat.bind,
245 )
246
247 def texture_destroy(self, texture):
248 self.interpreter.unregister_object(texture)
249
250 def texture_release(self, surface):
251 pass
252
253 def get_tex_surface(self, texture, face, level, zslice, usage):
254 if texture is None:
255 return None
256 return texture.get_surface(face, level, zslice)
257
258 def tex_surface_destroy(self, surface):
259 self.interpreter.unregister_object(surface)
260
261 def tex_surface_release(self, surface):
262 pass
263
264 def user_buffer_create(self, data, size, usage):
265 bind = usage
266 # We don't really care to distinguish between user and regular buffers
267 buffer = self.real.buffer_create(size, bind)
268 assert size == len(data)
269 self.context.buffer_write(buffer, data)
270 return buffer
271
272 def buffer_create(self, alignment, usage, size):
273 return self.real.buffer_create(size, alignment, usage)
274
275 def buffer_destroy(self, buffer):
276 pass
277
278 def fence_finish(self, fence, flags):
279 pass
280
281 def fence_reference(self, dst, src):
282 pass
283
284 def flush_frontbuffer(self, surface):
285 pass
286
287
288 class Context(Object):
289
290 def __init__(self, interpreter, real):
291 Object.__init__(self, interpreter, real)
292 self.cbufs = []
293 self.zsbuf = None
294 self.vbufs = []
295 self.velems = []
296 self.dirty = False
297
298 def destroy(self):
299 pass
300
301 def create_blend_state(self, state):
302 if isinstance(state, str):
303 state = gallium.Blend(state)
304 sys.stdout.write('\t%s\n' % state)
305 return state
306
307 def bind_blend_state(self, state):
308 if state is not None:
309 self.real.set_blend(state)
310
311 def delete_blend_state(self, state):
312 pass
313
314 def create_sampler_state(self, state):
315 return state
316
317 def delete_sampler_state(self, state):
318 pass
319
320 def bind_vertex_sampler_states(self, num_states, states):
321 for i in range(num_states):
322 self.real.set_vertex_sampler(i, states[i])
323
324 def bind_fragment_sampler_states(self, num_states, states):
325 for i in range(num_states):
326 self.real.set_fragment_sampler(i, states[i])
327
328 def create_rasterizer_state(self, state):
329 return state
330
331 def bind_rasterizer_state(self, state):
332 if state is not None:
333 self.real.set_rasterizer(state)
334
335 def delete_rasterizer_state(self, state):
336 pass
337
338 def create_depth_stencil_alpha_state(self, state):
339 return state
340
341 def bind_depth_stencil_alpha_state(self, state):
342 if state is not None:
343 self.real.set_depth_stencil_alpha(state)
344
345 def delete_depth_stencil_alpha_state(self, state):
346 pass
347
348 def create_fs_state(self, state):
349 tokens = str(state.tokens)
350 shader = gallium.Shader(tokens)
351 return shader
352
353 create_vs_state = create_fs_state
354
355 def bind_fs_state(self, state):
356 self.real.set_fragment_shader(state)
357
358 def bind_vs_state(self, state):
359 self.real.set_vertex_shader(state)
360
361 def delete_fs_state(self, state):
362 pass
363
364 delete_vs_state = delete_fs_state
365
366 def set_blend_color(self, state):
367 self.real.set_blend_color(state)
368
369 def set_stencil_ref(self, state):
370 self.real.set_stencil_ref(state)
371
372 def set_clip_state(self, state):
373 _state = gallium.Clip()
374 _state.nr = state.nr
375 if state.nr:
376 # FIXME
377 ucp = gallium.FloatArray(gallium.PIPE_MAX_CLIP_PLANES*4)
378 for i in range(len(state.ucp)):
379 for j in range(len(state.ucp[i])):
380 ucp[i*4 + j] = state.ucp[i][j]
381 _state.ucp = ucp
382 self.real.set_clip(_state)
383
384 def dump_constant_buffer(self, buffer):
385 if not self.interpreter.verbosity(2):
386 return
387
388 data = self.real.buffer_read(buffer)
389 format = '4f'
390 index = 0
391 for offset in range(0, len(data), struct.calcsize(format)):
392 x, y, z, w = unpack_from(format, data, offset)
393 sys.stdout.write('\tCONST[%2u] = {%10.4f, %10.4f, %10.4f, %10.4f}\n' % (index, x, y, z, w))
394 index += 1
395 sys.stdout.flush()
396
397 def set_constant_buffer(self, shader, index, buffer):
398 if buffer is not None:
399 self.real.set_constant_buffer(shader, index, buffer)
400
401 self.dump_constant_buffer(buffer)
402
403 def set_framebuffer_state(self, state):
404 _state = gallium.Framebuffer()
405 _state.width = state.width
406 _state.height = state.height
407 _state.nr_cbufs = state.nr_cbufs
408 for i in range(len(state.cbufs)):
409 _state.set_cbuf(i, state.cbufs[i])
410 _state.set_zsbuf(state.zsbuf)
411 self.real.set_framebuffer(_state)
412
413 self.cbufs = state.cbufs
414 self.zsbuf = state.zsbuf
415
416 def set_polygon_stipple(self, state):
417 self.real.set_polygon_stipple(state)
418
419 def set_scissor_state(self, state):
420 self.real.set_scissor(state)
421
422 def set_viewport_state(self, state):
423 self.real.set_viewport(state)
424
425 def create_sampler_view(self, texture, templ):
426 return self.real.create_sampler_view(texture,
427 format = templ.format,
428 first_level = templ.first_level,
429 last_level = templ.last_level,
430 swizzle_r = templ.swizzle_r,
431 swizzle_g = templ.swizzle_r,
432 swizzle_b = templ.swizzle_g,
433 swizzle_a = templ.swizzle_a)
434
435 def set_fragment_sampler_views(self, num, views):
436 for i in range(num):
437 self.real.set_fragment_sampler_view(i, views[i])
438
439 def set_vertex_sampler_views(self, num, views):
440 for i in range(num):
441 self.real.set_vertex_sampler_view(i, views[i])
442
443 def set_vertex_buffers(self, num_buffers, buffers):
444 self.vbufs = buffers[0:num_buffers]
445 for i in range(num_buffers):
446 vbuf = buffers[i]
447 self.real.set_vertex_buffer(
448 i,
449 stride = vbuf.stride,
450 max_index = vbuf.max_index,
451 buffer_offset = vbuf.buffer_offset,
452 buffer = vbuf.buffer,
453 )
454
455 def create_vertex_elements_state(self, num_elements, elements):
456 return elements[0:num_elements]
457
458 def bind_vertex_elements_state(self, state):
459 elements = state
460 num_elements = len(elements)
461 self.velems = elements
462 for i in range(num_elements):
463 self.real.set_vertex_element(i, elements[i])
464 self.real.set_vertex_elements(num_elements)
465
466 def delete_vertex_elements_state(self, state):
467 pass
468
469 def dump_vertices(self, start, count):
470 if not self.interpreter.verbosity(2):
471 return
472
473 for index in range(start, start + count):
474 if index >= start + 16:
475 sys.stdout.write('\t...\n')
476 break
477 sys.stdout.write('\t{\n')
478 for velem in self.velems:
479 vbuf = self.vbufs[velem.vertex_buffer_index]
480
481 offset = vbuf.buffer_offset + velem.src_offset + vbuf.stride*index
482 format = {
483 gallium.PIPE_FORMAT_R32_FLOAT: 'f',
484 gallium.PIPE_FORMAT_R32G32_FLOAT: '2f',
485 gallium.PIPE_FORMAT_R32G32B32_FLOAT: '3f',
486 gallium.PIPE_FORMAT_R32G32B32A32_FLOAT: '4f',
487 gallium.PIPE_FORMAT_A8R8G8B8_UNORM: '4B',
488 gallium.PIPE_FORMAT_R8G8B8A8_UNORM: '4B',
489 gallium.PIPE_FORMAT_B8G8R8A8_UNORM: '4B',
490 gallium.PIPE_FORMAT_R16G16B16_SNORM: '3h',
491 }[velem.src_format]
492
493 data = self.real.buffer_read(vbuf.buffer)
494 values = unpack_from(format, data, offset)
495 sys.stdout.write('\t\t{' + ', '.join(map(str, values)) + '},\n')
496 sys.stdout.write('\t},\n')
497 sys.stdout.flush()
498
499 def dump_indices(self, ibuf, isize, ibias, start, count):
500 if not self.interpreter.verbosity(2):
501 return
502
503 format = {
504 1: 'B',
505 2: 'H',
506 4: 'I',
507 }[isize]
508
509 assert struct.calcsize(format) == isize
510
511 data = self.real.buffer_read(ibuf)
512 maxindex, minindex = 0, 0xffffffff
513
514 sys.stdout.write('\t{\n')
515 for i in range(start, start + count):
516 if i >= start + 16 and not self.interpreter.verbosity(3):
517 sys.stdout.write('\t...\n')
518 break
519 offset = i*isize
520 index, = unpack_from(format, data, offset)
521 sys.stdout.write('\t\t%u,\n' % index)
522 minindex = min(minindex, index)
523 maxindex = max(maxindex, index)
524 sys.stdout.write('\t},\n')
525 sys.stdout.flush()
526
527 return minindex + ibias, maxindex + ibias
528
529 def draw_arrays(self, mode, start, count):
530 self.dump_vertices(start, count)
531
532 self.real.draw_arrays(mode, start, count)
533 self._set_dirty()
534
535 def draw_elements(self, indexBuffer, indexSize, indexBias, mode, start, count):
536 if self.interpreter.verbosity(2):
537 minindex, maxindex = self.dump_indices(indexBuffer, indexSize, indexBias, start, count)
538 self.dump_vertices(minindex, maxindex - minindex)
539
540 self.real.draw_elements(indexBuffer, indexSize, indexBias, mode, start, count)
541 self._set_dirty()
542
543 def draw_range_elements(self, indexBuffer, indexSize, indexBias, minIndex, maxIndex, mode, start, count):
544 if self.interpreter.verbosity(2):
545 minindex, maxindex = self.dump_indices(indexBuffer, indexSize, indexBias, start, count)
546 minindex = min(minindex, minIndex)
547 maxindex = min(maxindex, maxIndex)
548 self.dump_vertices(minindex, maxindex - minindex)
549
550 self.real.draw_range_elements(indexBuffer, indexSize, indexBias, minIndex, maxIndex, mode, start, count)
551 self._set_dirty()
552
553 def surface_copy(self, dest, destx, desty, src, srcx, srcy, width, height):
554 if dest is not None and src is not None:
555 if self.interpreter.options.all:
556 self.interpreter.present(self.real, src, 'surface_copy_src', srcx, srcy, width, height)
557 self.real.surface_copy(dest, destx, desty, src, srcx, srcy, width, height)
558 if dest in self.cbufs:
559 self._set_dirty()
560 flags = gallium.PIPE_FLUSH_FRAME
561 else:
562 flags = 0
563 self.flush(flags)
564 if self.interpreter.options.all:
565 self.interpreter.present(self.real, dest, 'surface_copy_dest', destx, desty, width, height)
566
567 def is_resource_referenced(self, texture, face, level):
568 #return self.real.is_resource_referenced(format, texture, face, level)
569 pass
570
571 def buffer_write(self, buffer, data, size, offset=0):
572 assert size == len(data)
573 self.buffer_write(buffer, data)
574
575 def surface_write(self, surface, data, stride, size):
576 if surface is None:
577 return
578 # assert surface.nblocksy * stride == size
579 surface.put_tile_raw(0, 0, surface.width, surface.height, data, stride)
580
581 def get_transfer(self, texture, sr, usage, box):
582 if texture is None:
583 return None
584 transfer = Transfer(texture, sr, usage, box)
585 if transfer and usage & gallium.PIPE_TRANSFER_READ:
586 if self.interpreter.options.all:
587 surface = texture.get_surface(sr.face, sr.level, box.z)
588 self.interpreter.present(self.real, transfer.surface, 'transf_read', box.x, box.y, box.w, box.h)
589 return transfer
590
591 def tex_transfer_destroy(self, transfer):
592 self.interpreter.unregister_object(transfer)
593
594 def transfer_inline_write(self, resource, sr, usage, box, stride, slice_stride, data):
595 self.real.transfer_inline_write(resource, sr, usage, box, data, stride, slice_stride)
596
597 def _set_dirty(self):
598 if self.interpreter.options.step:
599 self._present()
600 else:
601 self.dirty = True
602
603 def flush(self, flags):
604 self.real.flush(flags)
605 if self.dirty:
606 if flags & gallium.PIPE_FLUSH_FRAME:
607 self._present()
608 self.dirty = False
609 return None
610
611 def clear(self, buffers, rgba, depth, stencil):
612 _rgba = gallium.FloatArray(4)
613 for i in range(4):
614 _rgba[i] = rgba[i]
615 self.real.clear(buffers, _rgba, depth, stencil)
616
617 def _present(self):
618 self.real.flush()
619
620 if self.cbufs and self.cbufs[0]:
621 self.interpreter.present(self.real, self.cbufs[0], "cbuf")
622 if self.zsbuf:
623 if self.interpreter.options.all:
624 self.interpreter.present(self.real, self.zsbuf, "zsbuf")
625
626
627 class Interpreter(parser.TraceDumper):
628
629 ignore_calls = set((
630 ('pipe_screen', 'is_format_supported'),
631 ('pipe_screen', 'get_param'),
632 ('pipe_screen', 'get_paramf'),
633 ))
634
635 def __init__(self, stream, options):
636 parser.TraceDumper.__init__(self, stream)
637 self.options = options
638 self.objects = {}
639 self.result = None
640 self.globl = Global(self, None)
641 self.call_no = None
642
643 def register_object(self, address, object):
644 self.objects[address] = object
645
646 def unregister_object(self, object):
647 # FIXME:
648 pass
649
650 def lookup_object(self, address):
651 return self.objects[address]
652
653 def interpret(self, trace):
654 for call in trace.calls:
655 self.interpret_call(call)
656
657 def handle_call(self, call):
658 if self.options.stop and call.no > self.options.stop:
659 sys.exit(0)
660
661 if (call.klass, call.method) in self.ignore_calls:
662 return
663
664 self.call_no = call.no
665
666 if self.verbosity(1):
667 parser.TraceDumper.handle_call(self, call)
668 sys.stdout.flush()
669
670 args = [(str(name), self.interpret_arg(arg)) for name, arg in call.args]
671
672 if call.klass:
673 name, obj = args[0]
674 args = args[1:]
675 else:
676 obj = self.globl
677
678 method = getattr(obj, call.method)
679 ret = method(**dict(args))
680
681 if call.ret and isinstance(call.ret, model.Pointer):
682 if ret is None:
683 sys.stderr.write('warning: NULL returned\n')
684 self.register_object(call.ret.address, ret)
685
686 self.call_no = None
687
688 def interpret_arg(self, node):
689 translator = Translator(self)
690 return translator.visit(node)
691
692 def verbosity(self, level):
693 return self.options.verbosity >= level
694
695 def present(self, ctx, surface, description, x=None, y=None, w=None, h=None):
696 if self.call_no < self.options.start:
697 return
698
699 if self.options.images:
700 filename = '%04u_%s.png' % (self.call_no, description)
701 save_image(ctx, filename, surface, x, y, w, h)
702 else:
703 title = '%u. %s' % (self.call_no, description)
704 show_image(ctx, surface, title, x, y, w, h)
705
706
707 class Main(parser.Main):
708
709 def get_optparser(self):
710 optparser = parser.Main.get_optparser(self)
711 optparser.add_option("-q", "--quiet", action="store_const", const=0, dest="verbosity", help="no messages")
712 optparser.add_option("-v", "--verbose", action="count", dest="verbosity", default=1, help="increase verbosity level")
713 optparser.add_option("-i", "--images", action="store_true", dest="images", default=False, help="save images instead of showing them")
714 optparser.add_option("-a", "--all", action="store_true", dest="all", default=False, help="show depth, stencil, and transfers")
715 optparser.add_option("-s", "--step", action="store_true", dest="step", default=False, help="step trhough every draw")
716 optparser.add_option("-f", "--from", action="store", type="int", dest="start", default=0, help="from call no")
717 optparser.add_option("-t", "--to", action="store", type="int", dest="stop", default=0, help="until call no")
718 return optparser
719
720 def process_arg(self, stream, options):
721 parser = Interpreter(stream, options)
722 parser.parse()
723
724
725 if __name__ == '__main__':
726 Main().main()