diff options
Diffstat (limited to 'libcrystfel/src')
-rw-r--r-- | libcrystfel/src/stream.c | 87 | ||||
-rw-r--r-- | libcrystfel/src/stream.h | 2 |
2 files changed, 73 insertions, 16 deletions
diff --git a/libcrystfel/src/stream.c b/libcrystfel/src/stream.c index fa893a30..13b9065d 100644 --- a/libcrystfel/src/stream.c +++ b/libcrystfel/src/stream.c @@ -840,6 +840,20 @@ Stream *open_stream_for_read(const char *filename) } +/** + * open_stream_fd_for_write + * @fd: File descriptor (e.g. from open()) to use for stream data. + * + * Creates a new %Stream from @fd, so that stream data can be written to @fd + * using write_chunk(). + * + * In contrast to open_stream_for_write(), this function does not write any of + * the usual headers. This function is mostly for use when multiple substreams + * need to be multiplexed into a single master stream. The master would be + * opened using open_stream_for_write(), and the substreams using this function. + * + * Returns: a %Stream, or NULL on failure. + */ Stream *open_stream_fd_for_write(int fd) { Stream *st; @@ -856,25 +870,64 @@ Stream *open_stream_fd_for_write(int fd) st->major_version = LATEST_MAJOR_VERSION; st->minor_version = LATEST_MINOR_VERSION; - fprintf(st->fh, "CrystFEL stream format %i.%i\n", - st->major_version, st->minor_version); - fprintf(st->fh, "Generated by CrystFEL "CRYSTFEL_VERSIONSTRING"\n"); return st; } +/** + * open_stream_for_write + * @filename: Filename of new stream + * + * Creates a new stream with name @filename, and adds the stream format + * and version headers. + * + * You may want to follow this with a call to write_command() to record the + * command line. + * + * Returns: a %Stream, or NULL on failure. + */ Stream *open_stream_for_write(const char *filename) { - int fd; + Stream *st; + + st = malloc(sizeof(struct _stream)); + if ( st == NULL ) return NULL; - fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, - S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH); - if ( fd == -1 ) { + st->fh = fopen(filename, "w"); + if ( st->fh == NULL ) { ERROR("Failed to open stream.\n"); + free(st); return NULL; } - return open_stream_fd_for_write(fd); + st->major_version = LATEST_MAJOR_VERSION; + st->minor_version = LATEST_MINOR_VERSION; + + fprintf(st->fh, "CrystFEL stream format %i.%i\n", + st->major_version, st->minor_version); + fprintf(st->fh, "Generated by CrystFEL "CRYSTFEL_VERSIONSTRING"\n"); + fflush(st->fh); + + return st; +} + + +/** + * get_stream_fd + * @st: A %Stream + * + * This function gets the integer file descriptor for @st, a bit like fileno(). + * + * This is useful in conjunction with open_stream_fd_for_write(), to get the + * underlying file descriptor to which the multiplexed stream data should be + * written. In this case, the only other operations you should ever do (or have + * done) on @st are open_stream_for_write() and close_stream(). + * + * Returns: an integer file descriptor + */ +int get_stream_fd(Stream *st) +{ + return fileno(st->fh); } @@ -906,13 +959,16 @@ int is_stream(const char *filename) } -void write_line(Stream *st, const char *line) -{ - fprintf(st->fh, "%s\n", line); - fflush(st->fh); -} - - +/** + * write_command + * @st: A %Stream + * @argc: number of arguments + * @argv: command-line arguments + * + * Writes the command line to @st. @argc and @argv should be exactly as were + * given to main(). This should usually be called immediately after + * open_stream_for_write(). + */ void write_command(Stream *st, int argc, char *argv[]) { int i; @@ -924,6 +980,7 @@ void write_command(Stream *st, int argc, char *argv[]) fprintf(st->fh, "%s", argv[i]); } fprintf(st->fh, "\n"); + fflush(st->fh); } diff --git a/libcrystfel/src/stream.h b/libcrystfel/src/stream.h index 9f852c60..78c27b44 100644 --- a/libcrystfel/src/stream.h +++ b/libcrystfel/src/stream.h @@ -77,6 +77,7 @@ typedef enum { extern Stream *open_stream_for_read(const char *filename); extern Stream *open_stream_for_write(const char *filename); extern Stream *open_stream_fd_for_write(int fd); +extern int get_stream_fd(Stream *st); extern void close_stream(Stream *st); extern int read_chunk(Stream *st, struct image *image); @@ -84,7 +85,6 @@ extern int read_chunk_2(Stream *st, struct image *image, StreamReadFlags srf); extern void write_chunk(Stream *st, struct image *image, struct hdfile *hdfile, int include_peaks, int include_reflections); -extern void write_line(Stream *st, const char *line); extern void write_command(Stream *st, int argc, char *argv[]); extern int rewind_stream(Stream *st); |