nugu_prof.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. All rights reserved.
 *
 * 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 __NUGU_PROF_H__
#define __NUGU_PROF_H__
 
#include <nugu.h>
#include <base/nugu_uuid.h>
#include <glib.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum nugu_prof_type {
        NUGU_PROF_TYPE_SDK_CREATED,
        NUGU_PROF_TYPE_SDK_PLUGIN_INIT_START,
        NUGU_PROF_TYPE_SDK_PLUGIN_INIT_DONE,
        NUGU_PROF_TYPE_SDK_INIT_DONE,
        NUGU_PROF_TYPE_NETWORK_CONNECT_REQUEST,
        NUGU_PROF_TYPE_NETWORK_REGISTRY_REQUEST,
        NUGU_PROF_TYPE_NETWORK_REGISTRY_RESPONSE,
        NUGU_PROF_TYPE_NETWORK_REGISTRY_FAILED,
        NUGU_PROF_TYPE_NETWORK_SERVER_ESTABLISH_REQUEST,
        NUGU_PROF_TYPE_NETWORK_SERVER_ESTABLISH_RESPONSE,
        NUGU_PROF_TYPE_NETWORK_SERVER_ESTABLISH_FAILED,
        NUGU_PROF_TYPE_NETWORK_CONNECTED,
        NUGU_PROF_TYPE_NETWORK_DIRECTIVES_CLOSED,
        NUGU_PROF_TYPE_NETWORK_DNS_FAILED,
        NUGU_PROF_TYPE_NETWORK_SSL_FAILED,
        NUGU_PROF_TYPE_NETWORK_TIMEOUT,
        NUGU_PROF_TYPE_NETWORK_INTERNAL_ERROR,
        NUGU_PROF_TYPE_NETWORK_INVALID_TOKEN,
        NUGU_PROF_TYPE_NETWORK_PING_REQUEST,
        NUGU_PROF_TYPE_NETWORK_PING_RESPONSE,
        NUGU_PROF_TYPE_NETWORK_PING_FAILED,
        NUGU_PROF_TYPE_NETWORK_EVENT_REQUEST,
        NUGU_PROF_TYPE_NETWORK_EVENT_RESPONSE,
        NUGU_PROF_TYPE_NETWORK_EVENT_FAILED,
        NUGU_PROF_TYPE_NETWORK_EVENT_ATTACHMENT_REQUEST,
        NUGU_PROF_TYPE_NETWORK_EVENT_DIRECTIVE_RESPONSE,
        NUGU_PROF_TYPE_NETWORK_EVENT_DIRECTIVE_TIMEOUT,
        NUGU_PROF_TYPE_LAST_SERVER_INITIATIVE_DATA,
        NUGU_PROF_TYPE_WAKEUP_KEYWORD_DETECTED,
        NUGU_PROF_TYPE_ASR_LISTENING_STARTED,
        NUGU_PROF_TYPE_ASR_RECOGNIZE,
        NUGU_PROF_TYPE_ASR_RECOGNIZING_STARTED,
        NUGU_PROF_TYPE_ASR_END_POINT_DETECTED,
        NUGU_PROF_TYPE_ASR_TIMEOUT,
        NUGU_PROF_TYPE_ASR_FIRST_ATTACHMENT,
        NUGU_PROF_TYPE_ASR_LAST_ATTACHMENT,
        NUGU_PROF_TYPE_ASR_RESULT,
        NUGU_PROF_TYPE_TTS_SPEAK_DIRECTIVE,
        NUGU_PROF_TYPE_TTS_FAILED,
        NUGU_PROF_TYPE_TTS_STARTED,
        NUGU_PROF_TYPE_TTS_NET_FIRST_ATTACHMENT,
        NUGU_PROF_TYPE_TTS_FIRST_ATTACHMENT,
        NUGU_PROF_TYPE_TTS_FIRST_DECODING,
        NUGU_PROF_TYPE_TTS_FIRST_PCM_WRITE,
        NUGU_PROF_TYPE_TTS_LAST_ATTACHMENT,
        NUGU_PROF_TYPE_TTS_STOPPED,
        NUGU_PROF_TYPE_TTS_FINISHED,
        NUGU_PROF_TYPE_AUDIO_STARTED,
        NUGU_PROF_TYPE_AUDIO_FINISHED,
        NUGU_PROF_TYPE_MAX
};
 
struct nugu_prof_data {
        enum nugu_prof_type type; 
        char dialog_id[NUGU_MAX_UUID_STRING_SIZE + 1]; /* dialog request id */
        char msg_id[NUGU_MAX_UUID_STRING_SIZE + 1]; /* message id */
        gint64 timestamp; /* timestamp(microseconds) */
        char *contents; /* additional contents */
};
 
typedef void (*NuguProfCallback)(enum nugu_prof_type type,
                                 const struct nugu_prof_data *data,
                                 void *userdata);
 
NUGU_API void nugu_prof_clear(void);
 
NUGU_API void nugu_prof_enable_tracelog(void);
 
NUGU_API void nugu_prof_disable_tracelog(void);
 
NUGU_API void nugu_prof_set_callback(NuguProfCallback callback, void *userdata);
 
NUGU_API int nugu_prof_mark(enum nugu_prof_type type);
 
NUGU_API int nugu_prof_mark_data(enum nugu_prof_type type,
                                 const char *dialog_id, const char *msg_id,
                                 const char *contents);
 
NUGU_API struct nugu_prof_data *
nugu_prof_get_last_data(enum nugu_prof_type type);
 
NUGU_API int nugu_prof_get_diff_msec_timespec(const struct timespec *ts1,
                                              const struct timespec *ts2);
 
NUGU_API int nugu_prof_get_diff_msec_type(enum nugu_prof_type type1,
                                          enum nugu_prof_type type2);
 
NUGU_API int nugu_prof_get_diff_msec(const struct nugu_prof_data *prof1,
                                     const struct nugu_prof_data *prof2);
 
NUGU_API const char *nugu_prof_get_type_name(enum nugu_prof_type type);
 
NUGU_API void nugu_prof_dump(enum nugu_prof_type from, enum nugu_prof_type to);
 
#ifdef __cplusplus
}
#endif
 
#endif