FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/fftools/thread_queue.c
Date: 2025-06-23 20:06:14
Exec Total Coverage
Lines: 94 109 86.2%
Functions: 7 7 100.0%
Branches: 41 54 75.9%
Line Branch Exec Source
1 /*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 #include <stdint.h>
20 #include <string.h>
21
22 #include "libavutil/avassert.h"
23 #include "libavutil/container_fifo.h"
24 #include "libavutil/error.h"
25 #include "libavutil/fifo.h"
26 #include "libavutil/frame.h"
27 #include "libavutil/intreadwrite.h"
28 #include "libavutil/mem.h"
29 #include "libavutil/thread.h"
30
31 #include "libavcodec/packet.h"
32
33 #include "thread_queue.h"
34
35 enum {
36 FINISHED_SEND = (1 << 0),
37 FINISHED_RECV = (1 << 1),
38 };
39
40 struct ThreadQueue {
41 int *finished;
42 unsigned int nb_streams;
43
44 enum ThreadQueueType type;
45
46 AVContainerFifo *fifo;
47 AVFifo *fifo_stream_index;
48
49 pthread_mutex_t lock;
50 pthread_cond_t cond;
51 };
52
53 30975 void tq_free(ThreadQueue **ptq)
54 {
55 30975 ThreadQueue *tq = *ptq;
56
57
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30975 times.
 30975 if (!tq)
58 ✗ return;
59
60 30975 av_container_fifo_free(&tq->fifo);
61 30975 av_fifo_freep2(&tq->fifo_stream_index);
62
63 30975 av_freep(&tq->finished);
64
65 30975 pthread_cond_destroy(&tq->cond);
66 30975 pthread_mutex_destroy(&tq->lock);
67
68 30975 av_freep(ptq);
69 }
70
71 30975 ThreadQueue *tq_alloc(unsigned int nb_streams, size_t queue_size,
72 enum ThreadQueueType type)
73 {
74 ThreadQueue *tq;
75 int ret;
76
77 30975 tq = av_mallocz(sizeof(*tq));
78
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30975 times.
 30975 if (!tq)
79 ✗ return NULL;
80
81 30975 ret = pthread_cond_init(&tq->cond, NULL);
82
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30975 times.
 30975 if (ret) {
83 ✗ av_freep(&tq);
84 ✗ return NULL;
85 }
86
87 30975 ret = pthread_mutex_init(&tq->lock, NULL);
88
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30975 times.
 30975 if (ret) {
89 ✗ pthread_cond_destroy(&tq->cond);
90 ✗ av_freep(&tq);
91 ✗ return NULL;
92 }
93
94 30975 tq->finished = av_calloc(nb_streams, sizeof(*tq->finished));
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30975 times.
 30975 if (!tq->finished)
96 ✗ goto fail;
97 30975 tq->nb_streams = nb_streams;
98
99 30975 tq->type = type;
100
101 30975 tq->fifo = (type == THREAD_QUEUE_FRAMES) ?
102
2/2
✓ Branch 0 taken 15920 times.
✓ Branch 1 taken 15055 times.
 30975 av_container_fifo_alloc_avframe(0) : av_container_fifo_alloc_avpacket(0);
103
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30975 times.
 30975 if (!tq->fifo)
104 ✗ goto fail;
105
106 30975 tq->fifo_stream_index = av_fifo_alloc2(queue_size, sizeof(unsigned), 0);
107
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30975 times.
 30975 if (!tq->fifo_stream_index)
108 ✗ goto fail;
109
110 30975 return tq;
111 ✗ fail:
112 ✗ tq_free(&tq);
113 ✗ return NULL;
114 }
115
116 1751581 int tq_send(ThreadQueue *tq, unsigned int stream_idx, void *data)
117 {
118 int *finished;
119 int ret;
120
121
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1751581 times.
 1751581 av_assert0(stream_idx < tq->nb_streams);
122 1751581 finished = &tq->finished[stream_idx];
123
124 1751581 pthread_mutex_lock(&tq->lock);
125
126
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1751580 times.
 1751581 if (*finished & FINISHED_SEND) {
127 1 ret = AVERROR(EINVAL);
128 1 goto finish;
129 }
130
131
4/4
✓ Branch 0 taken 2153690 times.
✓ Branch 1 taken 6962 times.
✓ Branch 3 taken 409072 times.
✓ Branch 4 taken 1744618 times.
 2160652 while (!(*finished & FINISHED_RECV) && !av_fifo_can_write(tq->fifo_stream_index))
132 409072 pthread_cond_wait(&tq->cond, &tq->lock);
133
134
2/2
✓ Branch 0 taken 6962 times.
✓ Branch 1 taken 1744618 times.
 1751580 if (*finished & FINISHED_RECV) {
135 6962 ret = AVERROR_EOF;
136 6962 *finished |= FINISHED_SEND;
137 } else {
138 1744618 ret = av_fifo_write(tq->fifo_stream_index, &stream_idx, 1);
139
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1744618 times.
 1744618 if (ret < 0)
140 ✗ goto finish;
141
142 1744618 ret = av_container_fifo_write(tq->fifo, data, 0);
143
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1744618 times.
 1744618 if (ret < 0)
144 ✗ goto finish;
145
146 1744618 pthread_cond_broadcast(&tq->cond);
147 }
148
149 1751581 finish:
150 1751581 pthread_mutex_unlock(&tq->lock);
151
152 1751581 return ret;
153 }
154
155 2517225 static int receive_locked(ThreadQueue *tq, int *stream_idx,
156 void *data)
157 {
158 2517225 unsigned int nb_finished = 0;
159
160
2/2
✓ Branch 1 taken 1690520 times.
✓ Branch 2 taken 826889 times.
 2517409 while (av_container_fifo_read(tq->fifo, data, 0) >= 0) {
161 unsigned idx;
162 int ret;
163
164 1690520 ret = av_fifo_read(tq->fifo_stream_index, &idx, 1);
165
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1690520 times.
 1690520 av_assert0(ret >= 0);
166
2/2
✓ Branch 0 taken 184 times.
✓ Branch 1 taken 1690336 times.
 1690520 if (tq->finished[idx] & FINISHED_RECV) {
167 184 (tq->type == THREAD_QUEUE_FRAMES) ?
168
2/2
✓ Branch 0 taken 8 times.
✓ Branch 1 taken 176 times.
 184 av_frame_unref(data) : av_packet_unref(data);
169 184 continue;
170 }
171
172 1690336 *stream_idx = idx;
173 1690336 return 0;
174 }
175
176
2/2
✓ Branch 0 taken 1036886 times.
✓ Branch 1 taken 806808 times.
 1843694 for (unsigned int i = 0; i < tq->nb_streams; i++) {
177
2/2
✓ Branch 0 taken 999671 times.
✓ Branch 1 taken 37215 times.
 1036886 if (!tq->finished[i])
178 999671 continue;
179
180 /* return EOF to the consumer at most once for each stream */
181
2/2
✓ Branch 0 taken 20081 times.
✓ Branch 1 taken 17134 times.
 37215 if (!(tq->finished[i] & FINISHED_RECV)) {
182 20081 tq->finished[i] |= FINISHED_RECV;
183 20081 *stream_idx = i;
184 20081 return AVERROR_EOF;
185 }
186
187 17134 nb_finished++;
188 }
189
190
2/2
✓ Branch 0 taken 8256 times.
✓ Branch 1 taken 798552 times.
 806808 return nb_finished == tq->nb_streams ? AVERROR_EOF : AVERROR(EAGAIN);
191 }
192
193 1718673 int tq_receive(ThreadQueue *tq, int *stream_idx, void *data)
194 {
195 int ret;
196
197 1718673 *stream_idx = -1;
198
199 1718673 pthread_mutex_lock(&tq->lock);
200
201 798552 while (1) {
202 2517225 size_t can_read = av_container_fifo_can_read(tq->fifo);
203
204 2517225 ret = receive_locked(tq, stream_idx, data);
205
206 // signal other threads if the fifo state changed
207
2/2
✓ Branch 1 taken 1690373 times.
✓ Branch 2 taken 826852 times.
 2517225 if (can_read != av_container_fifo_can_read(tq->fifo))
208 1690373 pthread_cond_broadcast(&tq->cond);
209
210
2/2
✓ Branch 0 taken 798552 times.
✓ Branch 1 taken 1718673 times.
 2517225 if (ret == AVERROR(EAGAIN)) {
211 798552 pthread_cond_wait(&tq->cond, &tq->lock);
212 798552 continue;
213 }
214
215 1718673 break;
216 }
217
218 1718673 pthread_mutex_unlock(&tq->lock);
219
220 1718673 return ret;
221 }
222
223 45464 void tq_send_finish(ThreadQueue *tq, unsigned int stream_idx)
224 {
225
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 45464 times.
 45464 av_assert0(stream_idx < tq->nb_streams);
226
227 45464 pthread_mutex_lock(&tq->lock);
228
229 /* mark the stream as send-finished;
230 * next time the consumer thread tries to read this stream it will get
231 * an EOF and recv-finished flag will be set */
232 45464 tq->finished[stream_idx] |= FINISHED_SEND;
233 45464 pthread_cond_broadcast(&tq->cond);
234
235 45464 pthread_mutex_unlock(&tq->lock);
236 45464 }
237
238 38484 void tq_receive_finish(ThreadQueue *tq, unsigned int stream_idx)
239 {
240
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 38484 times.
 38484 av_assert0(stream_idx < tq->nb_streams);
241
242 38484 pthread_mutex_lock(&tq->lock);
243
244 /* mark the stream as recv-finished;
245 * next time the producer thread tries to send for this stream, it will
246 * get an EOF and send-finished flag will be set */
247 38484 tq->finished[stream_idx] |= FINISHED_RECV;
248 38484 pthread_cond_broadcast(&tq->cond);
249
250 38484 pthread_mutex_unlock(&tq->lock);
251 38484 }
252