FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
unix.c
Go to the documentation of this file.
1 /*
2  * Unix socket protocol
3  * Copyright (c) 2013 Luca Barbato
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  *
25  * Unix socket url_protocol
26  *
27  */
28 
29 #include "libavutil/avstring.h"
30 #include "libavutil/opt.h"
31 #include "os_support.h"
32 #include "network.h"
33 #include <sys/un.h>
34 #include "url.h"
35 
36 typedef struct UnixContext {
37  const AVClass *class;
38  struct sockaddr_un addr;
39  int timeout;
40  int listen;
41  int type;
42  int fd;
43 } UnixContext;
44 
45 #define OFFSET(x) offsetof(UnixContext, x)
46 #define ED AV_OPT_FLAG_DECODING_PARAM|AV_OPT_FLAG_ENCODING_PARAM
47 static const AVOption unix_options[] = {
48  { "listen", "Open socket for listening", OFFSET(listen), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, ED },
49  { "timeout", "Timeout in ms", OFFSET(timeout), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, ED },
50  { "type", "Socket type", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = SOCK_STREAM }, INT_MIN, INT_MAX, ED, "type" },
51  { "stream", "Stream (reliable stream-oriented)", 0, AV_OPT_TYPE_CONST, { .i64 = SOCK_STREAM }, INT_MIN, INT_MAX, ED, "type" },
52  { "datagram", "Datagram (unreliable packet-oriented)", 0, AV_OPT_TYPE_CONST, { .i64 = SOCK_DGRAM }, INT_MIN, INT_MAX, ED, "type" },
53  { "seqpacket", "Seqpacket (reliable packet-oriented", 0, AV_OPT_TYPE_CONST, { .i64 = SOCK_SEQPACKET }, INT_MIN, INT_MAX, ED, "type" },
54  { NULL }
55 };
56 
57 static const AVClass unix_class = {
58  .class_name = "unix",
59  .item_name = av_default_item_name,
60  .option = unix_options,
61  .version = LIBAVUTIL_VERSION_INT,
62 };
63 
64 static int unix_open(URLContext *h, const char *filename, int flags)
65 {
66  UnixContext *s = h->priv_data;
67  int fd, ret;
68 
69  av_strstart(filename, "unix:", &filename);
70  s->addr.sun_family = AF_UNIX;
71  av_strlcpy(s->addr.sun_path, filename, sizeof(s->addr.sun_path));
72 
73  if ((fd = ff_socket(AF_UNIX, s->type, 0)) < 0)
74  return ff_neterrno();
75 
76  if (s->listen) {
77  ret = ff_listen_bind(fd, (struct sockaddr *)&s->addr,
78  sizeof(s->addr), s->timeout, h);
79  if (ret < 0)
80  goto fail;
81  fd = ret;
82  } else {
83  ret = ff_listen_connect(fd, (struct sockaddr *)&s->addr,
84  sizeof(s->addr), s->timeout, h, 0);
85  if (ret < 0)
86  goto fail;
87  }
88 
89  s->fd = fd;
90 
91  return 0;
92 
93 fail:
94  if (s->listen && AVUNERROR(ret) != EADDRINUSE)
95  unlink(s->addr.sun_path);
96  if (fd >= 0)
97  closesocket(fd);
98  return ret;
99 }
100 
101 static int unix_read(URLContext *h, uint8_t *buf, int size)
102 {
103  UnixContext *s = h->priv_data;
104  int ret;
105 
106  if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
107  ret = ff_network_wait_fd(s->fd, 0);
108  if (ret < 0)
109  return ret;
110  }
111  ret = recv(s->fd, buf, size, 0);
112  return ret < 0 ? ff_neterrno() : ret;
113 }
114 
115 static int unix_write(URLContext *h, const uint8_t *buf, int size)
116 {
117  UnixContext *s = h->priv_data;
118  int ret;
119 
120  if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
121  ret = ff_network_wait_fd(s->fd, 1);
122  if (ret < 0)
123  return ret;
124  }
125  ret = send(s->fd, buf, size, MSG_NOSIGNAL);
126  return ret < 0 ? ff_neterrno() : ret;
127 }
128 
129 static int unix_close(URLContext *h)
130 {
131  UnixContext *s = h->priv_data;
132  if (s->listen)
133  unlink(s->addr.sun_path);
134  closesocket(s->fd);
135  return 0;
136 }
137 
139 {
140  UnixContext *s = h->priv_data;
141  return s->fd;
142 }
143 
145  .name = "unix",
146  .url_open = unix_open,
147  .url_read = unix_read,
148  .url_write = unix_write,
149  .url_close = unix_close,
150  .url_get_file_handle = unix_get_file_handle,
151  .priv_data_size = sizeof(UnixContext),
152  .priv_data_class = &unix_class,
154 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:631
static const AVClass unix_class
Definition: unix.c:57
#define URL_PROTOCOL_FLAG_NETWORK
Definition: url.h:35
AVOption.
Definition: opt.h:255
int timeout
Definition: unix.c:39
#define LIBAVUTIL_VERSION_INT
Definition: version.h:62
static int unix_write(URLContext *h, const uint8_t *buf, int size)
Definition: unix.c:115
static int unix_get_file_handle(URLContext *h)
Definition: unix.c:138
int flags
Definition: url.h:44
#define OFFSET(x)
Definition: unix.c:45
int ff_socket(int af, int type, int proto)
Definition: network.c:166
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
int ff_listen_bind(int fd, const struct sockaddr *addr, socklen_t addrlen, int timeout, URLContext *h)
Bind to a file descriptor and poll for a connection.
Definition: network.c:226
uint8_t
AVOptions.
miscellaneous OS support macros and functions.
int fd
Definition: unix.c:42
int ff_listen_connect(int fd, const struct sockaddr *addr, socklen_t addrlen, int timeout, URLContext *h, int will_try_next)
Connect to a file descriptor and poll for result.
Definition: network.c:238
ptrdiff_t size
Definition: opengl_enc.c:101
#define ED
Definition: unix.c:46
av_default_item_name
#define closesocket
Definition: ffserver.c:28
int type
Definition: unix.c:41
static int unix_close(URLContext *h)
Definition: unix.c:129
size_t av_strlcpy(char *dst, const char *src, size_t size)
Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.
Definition: avstring.c:83
#define fail()
Definition: checkasm.h:57
int listen
Definition: unix.c:40
#define ff_neterrno()
Definition: network.h:64
#define AVIO_FLAG_NONBLOCK
Use non-blocking mode.
Definition: avio.h:504
void * buf
Definition: avisynth_c.h:553
Definition: url.h:39
GLint GLenum type
Definition: opengl_enc.c:105
Describe the class of an AVClass context structure.
Definition: log.h:67
void * priv_data
Definition: url.h:42
static const AVOption unix_options[]
Definition: unix.c:47
static int unix_read(URLContext *h, uint8_t *buf, int size)
Definition: unix.c:101
static int unix_open(URLContext *h, const char *filename, int flags)
Definition: unix.c:64
const char * name
Definition: url.h:53
static int flags
Definition: cpu.c:47
URLProtocol ff_unix_protocol
Definition: unix.c:144
int av_strstart(const char *str, const char *pfx, const char **ptr)
Return non-zero if pfx is a prefix of str.
Definition: avstring.c:34
#define AVUNERROR(e)
Definition: error.h:44
#define MSG_NOSIGNAL
Definition: network.h:123
int ff_network_wait_fd(int fd, int write)
Definition: network.c:73
unbuffered private I/O API
struct sockaddr_un addr
Definition: unix.c:38