[babeltrace.git] / bindings / python / bt2 / bt2 / native_btctfwriter.i

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/* Types */
struct bt_ctf_clock;
struct bt_ctf_writer;

/* Clock functions */
struct bt_ctf_clock *bt_ctf_clock_create(const char *name);
const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock);
const char *bt_ctf_clock_get_description(struct bt_ctf_clock *clock);
int bt_ctf_clock_set_description(struct bt_ctf_clock *clock,
		const char *desc);
uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock);
int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock,
		uint64_t freq);
uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock);
int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock,
		uint64_t precision);
int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock,
		int64_t *OUTPUT);
int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock,
		int64_t offset_s);
int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock,
		int64_t *OUTPUT);
int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock,
		int64_t offset);
int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock);
int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock,
		int is_absolute);
BTUUID bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock);
int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock,
		BTUUID uuid);
int bt_ctf_clock_set_time(struct bt_ctf_clock *clock,
		int64_t time);

/* Stream functions */
int bt_stream_get_discarded_events_count(
		struct bt_stream *stream, uint64_t *OUTPUT);
void bt_stream_append_discarded_events(struct bt_stream *stream,
		uint64_t event_count);
int bt_stream_append_event(struct bt_stream *stream,
		struct bt_event *event);
struct bt_field *bt_stream_get_packet_header(
		struct bt_stream *stream);
int bt_stream_set_packet_header(
		struct bt_stream *stream,
		struct bt_field *packet_header);
struct bt_field *bt_stream_get_packet_context(
		struct bt_stream *stream);
int bt_stream_set_packet_context(
		struct bt_stream *stream,
		struct bt_field *packet_context);
int bt_stream_flush(struct bt_stream *stream);
int bt_stream_is_writer(struct bt_stream *stream);

/* Stream class functions */
int bt_stream_class_set_clock(
		struct bt_stream_class *stream_class,
		struct bt_ctf_clock *clock);
struct bt_ctf_clock *bt_stream_class_get_clock(
		struct bt_stream_class *stream_class);

/* Writer functions */
struct bt_ctf_writer *bt_ctf_writer_create(const char *path);
struct bt_trace *bt_ctf_writer_get_trace(
		struct bt_ctf_writer *writer);
int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer,
		struct bt_ctf_clock *clock);
char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer);
void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer);
Commit	Line	Data
81447b5b PP	1	/*
	2	* The MIT License (MIT)
	3	*
	4	* Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	19	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24
81447b5b PP	25	/* Types */
	26	struct bt_ctf_clock;
	27	struct bt_ctf_writer;
	28
	29	/* Clock functions */
	30	struct bt_ctf_clock bt_ctf_clock_create(const char name);
	31	const char bt_ctf_clock_get_name(struct bt_ctf_clock clock);
	32	const char bt_ctf_clock_get_description(struct bt_ctf_clock clock);
	33	int bt_ctf_clock_set_description(struct bt_ctf_clock *clock,
	34	const char *desc);
	35	uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock);
	36	int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock,
	37	uint64_t freq);
	38	uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock);
	39	int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock,
	40	uint64_t precision);
	41	int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock,
	42	int64_t *OUTPUT);
	43	int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock,
	44	int64_t offset_s);
	45	int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock,
	46	int64_t *OUTPUT);
	47	int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock,
	48	int64_t offset);
	49	int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock);
	50	int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock,
	51	int is_absolute);
	52	BTUUID bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock);
	53	int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock,
	54	BTUUID uuid);
	55	int bt_ctf_clock_set_time(struct bt_ctf_clock *clock,
	56	int64_t time);
	57
	58	/* Stream functions */
839d52a5 PP	59	int bt_stream_get_discarded_events_count(
	60	struct bt_stream stream, uint64_t OUTPUT);
	61	void bt_stream_append_discarded_events(struct bt_stream *stream,
81447b5b	62	uint64_t event_count);
839d52a5 PP	63	int bt_stream_append_event(struct bt_stream *stream,
	64	struct bt_event *event);
	65	struct bt_field *bt_stream_get_packet_header(
	66	struct bt_stream *stream);
	67	int bt_stream_set_packet_header(
	68	struct bt_stream *stream,
	69	struct bt_field *packet_header);
	70	struct bt_field *bt_stream_get_packet_context(
	71	struct bt_stream *stream);
	72	int bt_stream_set_packet_context(
	73	struct bt_stream *stream,
	74	struct bt_field *packet_context);
	75	int bt_stream_flush(struct bt_stream *stream);
	76	int bt_stream_is_writer(struct bt_stream *stream);
81447b5b PP	77
81447b5b PP	78	/* Stream class functions */
839d52a5 PP	79	int bt_stream_class_set_clock(
839d52a5 PP	80	struct bt_stream_class *stream_class,
81447b5b	81	struct bt_ctf_clock *clock);
839d52a5 PP	82	struct bt_ctf_clock *bt_stream_class_get_clock(
839d52a5 PP	83	struct bt_stream_class *stream_class);
81447b5b PP	84
	85	/* Writer functions */
	86	struct bt_ctf_writer bt_ctf_writer_create(const char path);
839d52a5	87	struct bt_trace *bt_ctf_writer_get_trace(
81447b5b PP	88	struct bt_ctf_writer *writer);
	89	int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer,
	90	struct bt_ctf_clock *clock);
	91	char bt_ctf_writer_get_metadata_string(struct bt_ctf_writer writer);
	92	void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer);