add snapshot shell bin for display

Change-Id: Ic828a0b9a101431622f119472d393e3394ad44d1
Signed-off-by: fanby01 <yaojian7@huawei.com>
This commit is contained in:
fanby01
2022-01-12 15:25:36 +08:00
parent 50c6b45f98
commit e2bea864df
5 changed files with 325 additions and 0 deletions
+1
View File
@@ -24,6 +24,7 @@
"//foundation/windowmanager/wm:libwm",
"//foundation/windowmanager/wmserver:libwms",
"//foundation/windowmanager/wm:libwmutil",
"//foundation/windowmanager/snapshot:snapshot_display",
"//foundation/windowmanager/interfaces/kits/napi:windowstage",
"//foundation/windowmanager/interfaces/kits/napi:napi_packages"
],
+45
View File
@@ -0,0 +1,45 @@
# Copyright (c) 2021 Huawei Device Co., Ltd.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import("//build/ohos.gni")
## Build snapshot {{{
config("snapshot_config") {
visibility = [ ":*" ]
}
ohos_executable("snapshot_display") {
install_enable = false
sources = [
"snapshot_display.cpp",
"snapshot_utils.cpp",
]
configs = [ ":snapshot_config" ]
deps = [
"//foundation/multimedia/image_standard/interfaces/innerkits:image_native", # PixelMap
"//foundation/windowmanager/dm:libdm",
"//foundation/windowmanager/wm:libwm",
"//third_party/libpng:libpng", # png
]
part_name = "window_manager"
subsystem_name = "window"
}
## Build snapshot }}}
group("test") {
testonly = true
}
+48
View File
@@ -0,0 +1,48 @@
/*
* Copyright (c) 2021 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <cstdio>
#include "snapshot_utils.h"
using namespace OHOS;
using namespace OHOS::Media;
using namespace OHOS::Rosen;
int main(int argc, char *argv[])
{
CmdArgments cmdArgments;
cmdArgments.fileName = "/data/snapshot_display_1.png";
if (!SnapShotUtils::ProcessArgs(argc, argv, cmdArgments)) {
return 0;
}
// get PixelMap from DisplayManager API
auto pixelMap = DisplayManager::GetInstance().GetScreenshot(cmdArgments.displayId);
bool ret = false;
if (pixelMap != nullptr) {
ret = SnapShotUtils::WriteToPngWithPixelMap(cmdArgments.fileName, *pixelMap);
}
if (!ret) {
printf("error: snapshot display %" PRIu64 ", write to %s as png failed!\n",
cmdArgments.displayId, cmdArgments.fileName.c_str());
return -1;
}
printf("success: snapshot display %" PRIu64 ", write to %s as png\n",
cmdArgments.displayId, cmdArgments.fileName.c_str());
return 0;
}
+178
View File
@@ -0,0 +1,178 @@
/*
* Copyright (c) 2021 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "snapshot_utils.h"
#include <cstdio>
#include <getopt.h>
#include <png.h>
using namespace OHOS::Media;
using namespace OHOS::Rosen;
namespace OHOS {
constexpr int BITMAP_DEPTH = 8;
void SnapShotUtils::PrintUsage(const std::string &cmdLine)
{
printf("usage: %s [-i displayId] [-f output_file]\n", cmdLine.c_str());
}
bool SnapShotUtils::CheckFileNameValid(const std::string &fileName)
{
std::string fileDir = fileName;
auto pos = fileDir.find_last_of("/");
if (pos != std::string::npos) {
fileDir.erase(pos + 1);
} else {
fileDir = ".";
}
char resolvedPath[PATH_MAX] = { 0 };
char *realPath = realpath(fileDir.c_str(), resolvedPath);
if (realPath == nullptr) {
printf("error: fileName %s invalid, nullptr!\n", fileName.c_str());
return false;
}
std::string realPathString = realPath;
if (realPathString.find("/data") != 0) {
printf("error: fileName %s invalid, %s must dump at dir: /data \n", fileName.c_str(), realPathString.c_str());
return false;
}
return true;
}
bool SnapShotUtils::WriteToPng(const std::string &fileName, const WriteToPngParam &param)
{
if (!CheckFileNameValid(fileName)) {
return false;
}
png_structp pngStruct = png_create_write_struct(PNG_LIBPNG_VER_STRING, nullptr, nullptr, nullptr);
if (pngStruct == nullptr) {
printf("error: png_create_write_struct nullptr!\n");
return false;
}
png_infop pngInfo = png_create_info_struct(pngStruct);
if (pngInfo == nullptr) {
printf("error: png_create_info_struct error nullptr!\n");
png_destroy_write_struct(&pngStruct, nullptr);
return false;
}
FILE *fp = fopen(fileName.c_str(), "wb");
if (fp == nullptr) {
printf("error: open file [%s] error, %d [%s]!\n", fileName.c_str(), errno, strerror(errno));
png_destroy_write_struct(&pngStruct, &pngInfo);
return false;
}
png_init_io(pngStruct, fp);
// set png header
png_set_IHDR(pngStruct, pngInfo,
param.width, param.height,
param.bitDepth,
PNG_COLOR_TYPE_RGBA,
PNG_INTERLACE_NONE,
PNG_COMPRESSION_TYPE_BASE,
PNG_FILTER_TYPE_BASE);
png_set_packing(pngStruct); // set packing info
png_write_info(pngStruct, pngInfo); // write to header
for (uint32_t i = 0; i < param.height; i++) {
png_write_row(pngStruct, param.data + (i * param.stride));
}
png_write_end(pngStruct, pngInfo);
// free
png_destroy_write_struct(&pngStruct, &pngInfo);
if (fclose(fp) != 0) {
return false;
}
return true;
}
bool SnapShotUtils::WriteToPngWithPixelMap(const std::string &fileName, PixelMap &pixelMap)
{
WriteToPngParam param;
param.width = pixelMap.GetWidth();
param.height = pixelMap.GetHeight();
param.data = pixelMap.GetPixels();
param.stride = pixelMap.GetRowBytes();
param.bitDepth = BITMAP_DEPTH;
return SnapShotUtils::WriteToPng(fileName, param);
}
static bool ProcessDisplayId(DisplayId &displayId)
{
if (displayId == DISPLAY_ID_INVALD) {
displayId = DisplayManager::GetInstance().GetDefaultDisplayId();
} else {
bool validFlag = false;
auto displayIds = DisplayManager::GetInstance().GetAllDisplayIds();
for (auto id: displayIds) {
if (displayId == id) {
validFlag = true;
break;
}
}
if (!validFlag) {
printf("error: displayId %" PRIu64 " invalid!\n", displayId);
printf("tips: supported displayIds:\n");
for (auto id: displayIds) {
printf("\t%" PRIu64 "\n", id);
}
return false;
}
}
return true;
}
bool SnapShotUtils::ProcessArgs(int argc, char * const argv[], CmdArgments &cmdArgments)
{
int opt = 0;
const struct option longOption[] = {
{ "id", required_argument, nullptr, 'i' },
{ "file", required_argument, nullptr, 'f' },
{ "help", required_argument, nullptr, 'h' },
{ nullptr, 0, nullptr, 0 }
};
while ((opt = getopt_long(argc, argv, "i:f:h", longOption, nullptr)) != -1) {
switch (opt) {
case 'i': // display id
cmdArgments.displayId = atoll(optarg);
break;
case 'f': // output file name
cmdArgments.fileName = optarg;
break;
case 'h': // help
SnapShotUtils::PrintUsage(argv[0]);
return false;
default:
SnapShotUtils::PrintUsage(argv[0]);
return false;
}
}
if (!ProcessDisplayId(cmdArgments.displayId)) {
return false;
}
// check fileName
if (!SnapShotUtils::CheckFileNameValid(cmdArgments.fileName)) {
printf("error: filename %s invalid!\n", cmdArgments.fileName.c_str());
return false;
}
return true;
}
}
+53
View File
@@ -0,0 +1,53 @@
/*
* Copyright (c) 2021 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef SNAPSHOT_UTILS_H
#define SNAPSHOT_UTILS_H
#include <cstdint>
#include <string>
#include <pixel_map.h>
#include "display_manager.h"
namespace OHOS {
using WriteToPngParam = struct {
uint32_t width;
uint32_t height;
uint32_t stride;
uint32_t bitDepth;
const uint8_t *data;
};
using CmdArgments = struct {
Rosen::DisplayId displayId = Rosen::DISPLAY_ID_INVALD;
std::string fileName;
};
class SnapShotUtils {
public:
SnapShotUtils() = default;
~SnapShotUtils() = default;
static void PrintUsage(const std::string &cmdLine);
static bool CheckFileNameValid(const std::string &fileName);
static bool WriteToPng(const std::string &fileName, const WriteToPngParam &param);
static bool WriteToPngWithPixelMap(const std::string &fileName, Media::PixelMap &pixelMap);
static bool ProcessArgs(int argc, char * const argv[], CmdArgments& cmdArgments);
private:
};
}
#endif // SNAPSHOT_UTILS_H