<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>oc_jpegencode: cocotb/interfaces.py Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">oc_jpegencode
 <span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">JPEGencoder</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,'Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('interfaces_8py_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">interfaces.py</div> </div>
</div><!--header-->
<div class="contents">
<a href="interfaces_8py.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="namespaceinterfaces.html"> 1</a></span> <span class="stringliteral">"""</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="stringliteral">A driver and monitor to abstract the interface to the JPEG encoder</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="stringliteral">"""</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="keyword">import</span> io</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="keyword">from</span> PIL <span class="keyword">import</span> Image</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">import</span> cocotb</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">from</span> cocotb.triggers <span class="keyword">import</span> RisingEdge, ReadOnly</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">from</span> cocotb.drivers <span class="keyword">import</span> Driver</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">from</span> cocotb.monitors <span class="keyword">import</span> Monitor</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="namespaceinterfaces.html#aaadc9fecf6b30b4cb8af1a36e479c4af"> 13</a></span> _jpeg_header = open(<span class="stringliteral">"header.bin"</span>, <span class="stringliteral">"r").read()</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="stringliteral"></span></div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classinterfaces_1_1JpegMonitor.html"> 15</a></span> <span class="stringliteral"></span><span class="keyword">class </span>JpegMonitor(Monitor):</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classinterfaces_1_1JpegMonitor.html#a08c09c7927a8b90e1dc4340b9b6589f2"> 17</a></span>  <span class="keyword">def </span><a class="code" href="classinterfaces_1_1JpegMonitor.html#a08c09c7927a8b90e1dc4340b9b6589f2">__init__</a>(self, dut, **kwargs):</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classinterfaces_1_1JpegMonitor.html#a623de4718fe48a8e036a1041bd516956"> 18</a></span>  self.<a class="code" href="classinterfaces_1_1JpegMonitor.html#a623de4718fe48a8e036a1041bd516956">dut</a> = dut</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  Monitor.__init__(self, **kwargs)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  @cocotb.coroutine</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classinterfaces_1_1JpegMonitor.html#ab8ec3f722072894b00035a3d4f870c0f"> 22</a></span>  <span class="keyword">def </span><a class="code" href="classinterfaces_1_1JpegMonitor.html#ab8ec3f722072894b00035a3d4f870c0f">_monitor_recv</a>(self):</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="stringliteral">"""Creates an Image object from the output of the DUT"""</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  data = <span class="stringliteral">""</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  clkedge = RisingEdge(self.dut.clk)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  ro = ReadOnly()</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">while</span> <span class="keyword">True</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">yield</span> clkedge</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">yield</span> ro</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> self.dut.data_ready.value:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  data += self.dut.JPEG_bitstream.value.buff</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">if</span> self.dut.eof_data_partial_ready.value:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  f_obj = io.BytesIO(_jpeg_header + data + <span class="stringliteral">"\xff\xd9"</span>)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  img = Image.open(f_obj)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  self.log.info(<span class="stringliteral">"Recovered image %s of %dx%d in mode %s"</span> % (</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  img.format, img.size[0], img.size[1], img.mode))</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">yield</span> clkedge</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  self._recv(img)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  data = <span class="stringliteral">""</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classinterfaces_1_1ImageDriver.html"> 43</a></span> <span class="keyword">class </span>ImageDriver(Driver):</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classinterfaces_1_1ImageDriver.html#a1a43e3d3feaff46c3422fa323584a36b"> 45</a></span>  <span class="keyword">def </span><a class="code" href="classinterfaces_1_1ImageDriver.html#a1a43e3d3feaff46c3422fa323584a36b">__init__</a>(self, dut):</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classinterfaces_1_1ImageDriver.html#a623de4718fe48a8e036a1041bd516956"> 46</a></span>  self.<a class="code" href="classinterfaces_1_1ImageDriver.html#a623de4718fe48a8e036a1041bd516956">dut</a> = dut</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  Driver.__init__(self)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  @cocotb.coroutine</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classinterfaces_1_1ImageDriver.html#a16dd974a09634de67ecd877325280997"> 50</a></span>  <span class="keyword">def </span><a class="code" href="classinterfaces_1_1ImageDriver.html#a16dd974a09634de67ecd877325280997">_driver_send</a>(self, image, **kwargs):</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="stringliteral">"""</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="stringliteral"> Send an image into the DUT. Image should be in RGB format and a </span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="stringliteral"> multiple of 8 pixels in both width and height</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="stringliteral"></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="stringliteral"> Args:</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="stringliteral"></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="stringliteral"> image (PIL.Image) image to send into the dut</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="stringliteral"> """</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">if</span> image.mode != <span class="stringliteral">"RGB"</span>: <span class="comment"># pragma: no cover</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">raise</span> TypeError(<span class="stringliteral">"Require an format RGB image"</span>)</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  width, height = image.size</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  dut = self.<a class="code" href="classinterfaces_1_1ImageDriver.html#a623de4718fe48a8e036a1041bd516956">dut</a> <span class="comment"># Local reference to save lookup</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  clk_edge = RisingEdge(dut.clk) <span class="comment"># Recycle objects for efficiency</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">yield</span> clk_edge <span class="comment"># Reset the dut first</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  dut.rst <= 1</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">yield</span> clk_edge</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  dut.rst <= 0</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  dut.end_of_file_signal <= 0</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  pixels = image.load()</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">for</span> y <span class="keywordflow">in</span> xrange(0,height,8):</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">for</span> x <span class="keywordflow">in</span> xrange(0,width,8):</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  dut.enable <= 1</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  self.log.debug(<span class="stringliteral">"Sending block X% 4d/% 4d, Y% 4d/% 4d"</span> % (</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  x, width, y, height))</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">if</span> y >= height-8 <span class="keywordflow">and</span> x >= width-8:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  dut.end_of_file_signal <= 1</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">for</span> y_block <span class="keywordflow">in</span> xrange(8):</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">for</span> x_block <span class="keywordflow">in</span> xrange(8):</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment"># If the image isn't a multiple of 8 pixels we </span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment"># repeat the edge values (see Readme.doc)</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  x_ofs = min(x+x_block, width-1)</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  y_ofs = min(y+y_block, height-1)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  r,g,b = pixels[x_ofs, y_ofs]</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  dut.data_in <= (b<<16 | g<<8 | r)</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">yield</span> clk_edge</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  dut.end_of_file_signal <= 0</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">for</span> i <span class="keywordflow">in</span> xrange(33):</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">yield</span> clk_edge</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  dut.enable <= 0</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">yield</span> clk_edge</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="ttc" id="classinterfaces_1_1JpegMonitor_html_ab8ec3f722072894b00035a3d4f870c0f"><div class="ttname"><a href="classinterfaces_1_1JpegMonitor.html#ab8ec3f722072894b00035a3d4f870c0f">interfaces.JpegMonitor._monitor_recv</a></div><div class="ttdeci">def _monitor_recv( self)</div><div class="ttdef"><b>Definition:</b> <a href="interfaces_8py_source.html#l00022">interfaces.py:22</a></div></div>
<div class="ttc" id="classinterfaces_1_1JpegMonitor_html_a623de4718fe48a8e036a1041bd516956"><div class="ttname"><a href="classinterfaces_1_1JpegMonitor.html#a623de4718fe48a8e036a1041bd516956">interfaces.JpegMonitor.dut</a></div><div class="ttdeci">dut</div><div class="ttdef"><b>Definition:</b> <a href="interfaces_8py_source.html#l00018">interfaces.py:18</a></div></div>
<div class="ttc" id="classinterfaces_1_1JpegMonitor_html_a08c09c7927a8b90e1dc4340b9b6589f2"><div class="ttname"><a href="classinterfaces_1_1JpegMonitor.html#a08c09c7927a8b90e1dc4340b9b6589f2">interfaces.JpegMonitor.__init__</a></div><div class="ttdeci">def __init__( self, dut, kwargs)</div><div class="ttdef"><b>Definition:</b> <a href="interfaces_8py_source.html#l00017">interfaces.py:17</a></div></div>
<div class="ttc" id="classinterfaces_1_1ImageDriver_html_a1a43e3d3feaff46c3422fa323584a36b"><div class="ttname"><a href="classinterfaces_1_1ImageDriver.html#a1a43e3d3feaff46c3422fa323584a36b">interfaces.ImageDriver.__init__</a></div><div class="ttdeci">def __init__( self, dut)</div><div class="ttdef"><b>Definition:</b> <a href="interfaces_8py_source.html#l00045">interfaces.py:45</a></div></div>
<div class="ttc" id="classinterfaces_1_1ImageDriver_html_a623de4718fe48a8e036a1041bd516956"><div class="ttname"><a href="classinterfaces_1_1ImageDriver.html#a623de4718fe48a8e036a1041bd516956">interfaces.ImageDriver.dut</a></div><div class="ttdeci">dut</div><div class="ttdef"><b>Definition:</b> <a href="interfaces_8py_source.html#l00046">interfaces.py:46</a></div></div>
<div class="ttc" id="classinterfaces_1_1ImageDriver_html_a16dd974a09634de67ecd877325280997"><div class="ttname"><a href="classinterfaces_1_1ImageDriver.html#a16dd974a09634de67ecd877325280997">interfaces.ImageDriver._driver_send</a></div><div class="ttdeci">def _driver_send( self, image, kwargs)</div><div class="ttdef"><b>Definition:</b> <a href="interfaces_8py_source.html#l00050">interfaces.py:50</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3fb45d1d7bf874fe99917f7eb306aec1.html">cocotb</a></li><li class="navelem"><a class="el" href="interfaces_8py.html">interfaces.py</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
</ul>
</div>
</body>
</html>