<!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.6"/>
<title>libmtp: /builddir/build/BUILD/libmtp-1.1.9/src/chdk_live_view.h 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="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 style="padding-left: 0.5em;">
<div id="projectname">libmtp
 <span id="projectnumber">1.1.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">chdk_live_view.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __LIVE_VIEW_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define __LIVE_VIEW_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Note: used in modules and platform independent code. </span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Do not add platform dependent stuff in here (#ifdef/#endif compile options or camera dependent values)</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">Protocol notes:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">- Unless otherwise specified, all structure values are packed in camera native (little</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> endian) byte order</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">- Frame buffer and palette data are in native camera formats</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> Some documentation may be found at http://chdk.wikia.com/wiki/Frame_buffers </span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">- The frame buffer descriptions returned may not be correct depending on the</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> camera model and various camera settings (shooting mode, digital zoom, aspect ratio)</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> This may result in partial images, garbage in the "valid" area or incorrect position</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">- In some cases, the requested data may not be available. If this happens, the framebuffer</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> or palette data offset will be zero. </span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">- The frame buffer descriptions are returned regardless of whether the data is available</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// Live View protocol version</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define LIVE_VIEW_VERSION_MAJOR 2 // increase only with backwards incompatible changes (and reset minor)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="preprocessor">#define LIVE_VIEW_VERSION_MINOR 1 // increase with extensions of functionality</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">protocol version history</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">< 2.0 - development versions</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">2.0 - initial release, chdk 1.1</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">2.1 - added palette type 4 - 16 entry VUYA, 2 bit alpha</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// Control flags for determining which data block to transfer</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define LV_TFR_VIEWPORT 0x01</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#define LV_TFR_BITMAP 0x04</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define LV_TFR_PALETTE 0x08</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">enum</span> lv_aspect_rato {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  LV_ASPECT_4_3,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  LV_ASPECT_16_9,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</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> <span class="comment">/*</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">Framebuffer types</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">additional values will be added if new data formats appear</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">enum</span> lv_fb_type {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  LV_FB_YUV8, <span class="comment">// 8 bit per element UYVYYY, used for live view</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  LV_FB_PAL8, <span class="comment">// 8 bit paletted, used for bitmap overlay. Note palette data and type sent separately</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> };</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">framebuffer data description</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">NOTE YUV pixels widths are based on the number of Y elements</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structlv__framebuffer__desc.html"> 55</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> fb_type; <span class="comment">// framebuffer type - note future versions might use different structures depending on type</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> data_start; <span class="comment">// offset of data from start of live view header</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">/*</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> buffer width in pixels</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> data size is always buffer_width*visible_height*(buffer bpp based on type)</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">int</span> buffer_width;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">/*</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> visible size in pixels</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> describes data within the buffer which contains image data to be displayed</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> any offsets within buffer data are added before sending, so the top left</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> pixel is always the first first byte of data.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> width must always be <= buffer_width</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> if buffer_width is > width, the additional data should be skipped</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> visible_height also defines the number of data rows</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">int</span> visible_width;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">int</span> visible_height;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">/*</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> margins</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> pixels offsets needed to replicate display position on cameras screen</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> not used for any buffer offsets</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">int</span> margin_left;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">int</span> margin_top;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> margin_right;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> margin_bot;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <a class="code" href="structlv__framebuffer__desc.html">lv_framebuffer_desc</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structlv__data__header.html"> 87</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// live view sub-protocol version</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">int</span> version_major;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">int</span> version_minor;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">int</span> lcd_aspect_ratio; <span class="comment">// physical aspect ratio of LCD</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">int</span> palette_type;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">int</span> palette_data_start;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// framebuffer descriptions are given as offsets, to allow expanding the structures in minor protocol changes</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">int</span> vp_desc_start;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">int</span> bm_desc_start;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <a class="code" href="structlv__data__header.html">lv_data_header</a>;</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> <span class="preprocessor">#endif // __LIVE_VIEW_H</span></div>
<div class="ttc" id="structlv__data__header_html"><div class="ttname"><a href="structlv__data__header.html">lv_data_header</a></div><div class="ttdef"><b>Definition:</b> chdk_live_view.h:87</div></div>
<div class="ttc" id="structlv__framebuffer__desc_html"><div class="ttname"><a href="structlv__framebuffer__desc.html">lv_framebuffer_desc</a></div><div class="ttdef"><b>Definition:</b> chdk_live_view.h:55</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
