bindings/python/bt2/bt2/native_btctfwriter.i

   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
  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 */
  59 int bt_ctf_stream_get_discarded_events_count(
  60                 struct bt_ctf_stream *stream, uint64_t *OUTPUT);
  61 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
  62                 uint64_t event_count);
  63 int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
  64                 struct bt_ctf_event *event);
  65 struct bt_ctf_field *bt_ctf_stream_get_packet_header(
  66                 struct bt_ctf_stream *stream);
  67 int bt_ctf_stream_set_packet_header(
  68                 struct bt_ctf_stream *stream,
  69                 struct bt_ctf_field *packet_header);
  70 struct bt_ctf_field *bt_ctf_stream_get_packet_context(
  71                 struct bt_ctf_stream *stream);
  72 int bt_ctf_stream_set_packet_context(
  73                 struct bt_ctf_stream *stream,
  74                 struct bt_ctf_field *packet_context);
  75 int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
  76 int bt_ctf_stream_is_writer(struct bt_ctf_stream *stream);
  77
  78 /* Stream class functions */
  79 int bt_ctf_stream_class_set_clock(
  80                 struct bt_ctf_stream_class *stream_class,
  81                 struct bt_ctf_clock *clock);
  82 struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
  83                 struct bt_ctf_stream_class *stream_class);
  84
  85 /* Writer functions */
  86 struct bt_ctf_writer *bt_ctf_writer_create(const char *path);
  87 struct bt_ctf_trace *bt_ctf_writer_get_trace(
  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);