jack2/common/JackEngine.cpp at develop · jackaudio/jack2 · GitHub

History

1274 lines (1065 loc) · 39.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

This program is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 2 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

#include <iostream>

#include <fstream>

#include <set>

#include <assert.h>

#include <ctype.h>

#include "JackSystemDeps.h"

#include "JackLockedEngine.h"

#include "JackExternalClient.h"

#include "JackInternalClient.h"

#include "JackEngineControl.h"

#include "JackClientControl.h"

#include "JackServerGlobals.h"

#include "JackGlobals.h"

#include "JackChannel.h"

#include "JackError.h"

extern const char* JACK_METADATA_HARDWARE;

extern const char* JACK_METADATA_PRETTY_NAME;

namespace Jack

{

JackEngine::JackEngine(JackGraphManager* manager,

JackSynchro* table,

JackEngineControl* control,

char self_connect_mode)

: JackLockAble(control->fServerName),

fSignal(control->fServerName),

fMetadata(true)

{

fGraphManager = manager;

fSynchroTable = table;

fEngineControl = control;

fSelfConnectMode = self_connect_mode;

for (int i = 0; i < CLIENT_NUM; i++) {

fClientTable[i] = NULL;

}

fLastSwitchUsecs = 0;

fSessionPendingReplies = 0;

fSessionTransaction = NULL;

fSessionResult = NULL;

}

JackEngine::~JackEngine()

{}

int JackEngine::Open()

{

jack_log("JackEngine::Open");

// Open audio thread => request thread communication channel

if (fChannel.Open(fEngineControl->fServerName) < 0) {

jack_error("Cannot connect to server");

return -1;

} else {

return 0;

}

int JackEngine::Close()

{

jack_log("JackEngine::Close");

fChannel.Close();

// Close remaining clients (RT is stopped)

for (int i = fEngineControl->fDriverNum; i < CLIENT_NUM; i++) {

if (JackLoadableInternalClient* loadable_client = dynamic_cast<JackLoadableInternalClient*>(fClientTable[i])) {

jack_log("JackEngine::Close loadable client = %s", loadable_client->GetClientControl()->fName);

loadable_client->Close();

fClientTable[i] = NULL;

delete loadable_client;

} else if (JackExternalClient* external_client = dynamic_cast<JackExternalClient*>(fClientTable[i])) {

jack_log("JackEngine::Close external client = %s", external_client->GetClientControl()->fName);

external_client->Close();

fClientTable[i] = NULL;

delete external_client;

}

return 0;

}

void JackEngine::NotifyQuit()

{

fChannel.NotifyQuit();

}

//-----------------------------

// Client resource management

//-----------------------------

int JackEngine::AllocateRefnum()

{

for (int i = 0; i < CLIENT_NUM; i++) {

if (!fClientTable[i]) {

jack_log("JackEngine::AllocateRefNum ref = %ld", i);

return i;

}

return -1;

}

void JackEngine::ReleaseRefnum(int refnum)

{

fClientTable[refnum] = NULL;

if (fEngineControl->fTemporary) {

int i;

for (i = fEngineControl->fDriverNum; i < CLIENT_NUM; i++) {

if (fClientTable[i]) {

break;

}

if (i == CLIENT_NUM) {

// Last client and temporary case: quit the server

jack_log("JackEngine::ReleaseRefnum server quit");

fEngineControl->fTemporary = false;

throw JackTemporaryException();

}

//------------------

// Graph management

//------------------

void JackEngine::ProcessNext(jack_time_t cur_cycle_begin)

{

fLastSwitchUsecs = cur_cycle_begin;

if (fGraphManager->RunNextGraph()) { // True if the graph actually switched to a new state

fChannel.Notify(ALL_CLIENTS, kGraphOrderCallback, 0);

}

fSignal.Signal(); // Signal for threads waiting for next cycle

}

void JackEngine::ProcessCurrent(jack_time_t cur_cycle_begin)

{

if (cur_cycle_begin < fLastSwitchUsecs + 2 * fEngineControl->fPeriodUsecs) { // Signal XRun only for the first failing cycle

CheckXRun(cur_cycle_begin);

}

fGraphManager->RunCurrentGraph();

}

bool JackEngine::Process(jack_time_t cur_cycle_begin, jack_time_t prev_cycle_end)

{

bool res = true;

// Cycle begin

fEngineControl->CycleBegin(fClientTable, fGraphManager, cur_cycle_begin, prev_cycle_end);

// Graph

if (fGraphManager->IsFinishedGraph()) {

ProcessNext(cur_cycle_begin);

res = true;

} else {

jack_log("Process: graph not finished!");

if (cur_cycle_begin > fLastSwitchUsecs + fEngineControl->fTimeOutUsecs) {

jack_log("Process: switch to next state delta = %ld", long(cur_cycle_begin - fLastSwitchUsecs));

ProcessNext(cur_cycle_begin);

res = true;

} else {

jack_log("Process: waiting to switch delta = %ld", long(cur_cycle_begin - fLastSwitchUsecs));

ProcessCurrent(cur_cycle_begin);

res = false;

}

// Cycle end

fEngineControl->CycleEnd(fClientTable);

return res;

}

Client that finish *after* the callback date are considered late even if their output buffers may have been

correctly mixed in the time window: callbackUsecs <==> Read <==> Write.

static const char* State2String(jack_client_state_t state)

{

switch (state) {

case NotTriggered:

return "NotTriggered";

case Triggered:

return "Triggered";

case Running:

return "Running";

case Finished:

return "Finished";

default:

return "";

}

void JackEngine::CheckXRun(jack_time_t callback_usecs) // REVOIR les conditions de fin

{

for (int i = fEngineControl->fDriverNum; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client && client->GetClientControl()->fActive) {

JackClientTiming* timing = fGraphManager->GetClientTiming(i);

jack_client_state_t status = timing->fStatus;

jack_time_t finished_date = timing->fFinishedAt;

if (status != NotTriggered && status != Finished) {

jack_error("JackEngine::XRun: client = %s was not finished, state = %s", client->GetClientControl()->fName, State2String(status));

fChannel.Notify(ALL_CLIENTS, kXRunCallback, 0); // Notify all clients

}

if (status == Finished && (long)(finished_date - callback_usecs) > 0) {

jack_error("JackEngine::XRun: client %s finished after current callback", client->GetClientControl()->fName);

fChannel.Notify(ALL_CLIENTS, kXRunCallback, 0); // Notify all clients

}

int JackEngine::ComputeTotalLatencies()

{

std::vector<jack_int_t> sorted;

std::vector<jack_int_t>::iterator it;

std::vector<jack_int_t>::reverse_iterator rit;

fGraphManager->TopologicalSort(sorted);

/* iterate over all clients in graph order, and emit

* capture latency callback.

for (it = sorted.begin(); it != sorted.end(); it++) {

NotifyClient(*it, kLatencyCallback, true, "", 0, 0);

}

/* now issue playback latency callbacks in reverse graph order.

for (rit = sorted.rbegin(); rit != sorted.rend(); rit++) {

NotifyClient(*rit, kLatencyCallback, true, "", 1, 0);

}

return 0;

}

//--------------

// Metadata API

//--------------

int JackEngine::PropertyChangeNotify(jack_uuid_t subject, const char* key, jack_property_change_t change)

{

jack_log("JackEngine::PropertyChangeNotify: subject = %x key = %s change = %x", subject, key, change);

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client) {

char buf[JACK_UUID_STRING_SIZE];

jack_uuid_unparse(subject, buf);

client->ClientNotify(i, buf, kPropertyChangeCallback, false, key, change, 0);

}

return 0;

}

//---------------

// Notifications

//---------------

int JackEngine::ClientNotify(JackClientInterface* client, int refnum, const char* name, int notify, int sync, const char* message, int value1, int value2)

{

// Check if notification is needed

if (!client->GetClientControl()->fCallback[notify]) {

jack_log("JackEngine::ClientNotify: no callback for notification = %ld", notify);

return 0;

}

int res1;

// External client

if (dynamic_cast<JackExternalClient*>(client)) {

res1 = client->ClientNotify(refnum, name, notify, sync, message, value1, value2);

// Important for internal client : unlock before calling the notification callbacks

} else {

bool res2 = Unlock();

res1 = client->ClientNotify(refnum, name, notify, sync, message, value1, value2);

if (res2) {

Lock();

}

if (res1 < 0) {

jack_error("ClientNotify fails name = %s notification = %ld val1 = %ld val2 = %ld", name, notify, value1, value2);

}

return res1;

}

void JackEngine::NotifyClient(int refnum, int event, int sync, const char* message, int value1, int value2)

{

JackClientInterface* client = fClientTable[refnum];

if (client) {

ClientNotify(client, refnum, client->GetClientControl()->fName, event, sync, message, value1, value2);

}

void JackEngine::NotifyClients(int event, int sync, const char* message, int value1, int value2)

{

for (int i = 0; i < CLIENT_NUM; i++) {

NotifyClient(i, event, sync, message, value1, value2);

}

int JackEngine::NotifyAddClient(JackClientInterface* new_client, const char* new_name, int refnum)

{

jack_log("JackEngine::NotifyAddClient: name = %s", new_name);

// Notify existing clients of the new client and new client of existing clients.

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* old_client = fClientTable[i];

if (old_client && old_client != new_client) {

char* old_name = old_client->GetClientControl()->fName;

if (ClientNotify(old_client, refnum, new_name, kAddClient, false, "", 0, 0) < 0) {

jack_error("NotifyAddClient old_client fails name = %s", old_name);

// Not considered as a failure...

}

if (ClientNotify(new_client, i, old_name, kAddClient, true, "", 0, 0) < 0) {

jack_error("NotifyAddClient new_client fails name = %s", new_name);

return -1;

}

return 0;

}

void JackEngine::NotifyRemoveClient(const char* name, int refnum)

{

// Notify existing clients (including the one being suppressed) of the removed client

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client) {

ClientNotify(client, refnum, name, kRemoveClient, false, "", 0, 0);

}

// Coming from the driver

void JackEngine::NotifyDriverXRun()

{

// Use the audio thread => request thread communication channel

fChannel.Notify(ALL_CLIENTS, kXRunCallback, 0);

}

void JackEngine::NotifyClientXRun(int refnum)

{

if (refnum == ALL_CLIENTS) {

NotifyClients(kXRunCallback, false, "", 0, 0);

} else {

NotifyClient(refnum, kXRunCallback, false, "", 0, 0);

}

void JackEngine::NotifyGraphReorder()

{

ComputeTotalLatencies();

NotifyClients(kGraphOrderCallback, false, "", 0, 0);

}

void JackEngine::NotifyBufferSize(jack_nframes_t buffer_size)

{

NotifyClients(kBufferSizeCallback, true, "", buffer_size, 0);

}

void JackEngine::NotifySampleRate(jack_nframes_t sample_rate)

{

NotifyClients(kSampleRateCallback, true, "", sample_rate, 0);

}

void JackEngine::NotifyFailure(int code, const char* reason)

{

NotifyClients(kShutDownCallback, false, reason, code, 0);

}

void JackEngine::NotifyFreewheel(bool onoff)

{

if (onoff) {

// Save RT state

fEngineControl->fSavedRealTime = fEngineControl->fRealTime;

fEngineControl->fRealTime = false;

} else {

// Restore RT state

fEngineControl->fRealTime = fEngineControl->fSavedRealTime;

fEngineControl->fSavedRealTime = false;

}

NotifyClients((onoff ? kStartFreewheelCallback : kStopFreewheelCallback), true, "", 0, 0);

}

void JackEngine::NotifyPortRegistation(jack_port_id_t port_index, bool onoff)

{

NotifyClients((onoff ? kPortRegistrationOnCallback : kPortRegistrationOffCallback), false, "", port_index, 0);

}

void JackEngine::NotifyPortRename(jack_port_id_t port, const char* old_name)

{

NotifyClients(kPortRenameCallback, false, old_name, port, 0);

}

void JackEngine::NotifyPortConnect(jack_port_id_t src, jack_port_id_t dst, bool onoff)

{

NotifyClients((onoff ? kPortConnectCallback : kPortDisconnectCallback), false, "", src, dst);

}

void JackEngine::NotifyActivate(int refnum)

{

NotifyClient(refnum, kActivateClient, true, "", 0, 0);

}

//----------------------------

// Loadable client management

//----------------------------

int JackEngine::GetInternalClientName(int refnum, char* name_res)

{

JackClientInterface* client = fClientTable[refnum];

assert(client);

strncpy(name_res, client->GetClientControl()->fName, JACK_CLIENT_NAME_SIZE);

return 0;

}

int JackEngine::InternalClientHandle(const char* client_name, int* status, int* int_ref)

{

// Clear status

*status = 0;

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client && dynamic_cast<JackLoadableInternalClient*>(client) && (strcmp(client->GetClientControl()->fName, client_name) == 0)) {

jack_log("InternalClientHandle found client name = %s ref = %ld", client_name, i);

*int_ref = i;

return 0;

}

*status |= (JackNoSuchClient | JackFailure);

return -1;

}

int JackEngine::InternalClientUnload(int refnum, int* status)

{

JackClientInterface* client = fClientTable[refnum];

if (client) {

int res = client->Close();

delete client;

*status = 0;

return res;

} else {

*status = (JackNoSuchClient | JackFailure);

return -1;

}

//-------------------

// Client management

//-------------------

int JackEngine::ClientCheck(const char* name, jack_uuid_t uuid, char* name_res, int protocol, int options, int* status)

{

// Clear status

*status = 0;

strcpy(name_res, name);

jack_log("Check protocol client = %ld server = %ld", protocol, JACK_PROTOCOL_VERSION);

if (protocol != JACK_PROTOCOL_VERSION) {

*status |= (JackFailure | JackVersionError);

jack_error("JACK protocol mismatch (%d vs %d)", protocol, JACK_PROTOCOL_VERSION);

return -1;

}

std::map<int,std::string>::iterator res = fReservationMap.find(uuid);

if (res != fReservationMap.end()) {

strncpy(name_res, res->second.c_str(), JACK_CLIENT_NAME_SIZE);

} else if (ClientCheckName(name)) {

*status |= JackNameNotUnique;

if (options & JackUseExactName) {

jack_error("cannot create new client; %s already exists", name);

*status |= JackFailure;

return -1;

}

if (GenerateUniqueName(name_res)) {

*status |= JackFailure;

return -1;

}

return 0;

}

bool JackEngine::GenerateUniqueName(char* name)

{

int tens, ones;

int length = strlen(name);

if (length > JACK_CLIENT_NAME_SIZE - 4) {

jack_error("%s exists and is too long to make unique", name);

return true; /* failure */

}

/* generate a unique name by appending "-01".."-99" */

name[length++] = '-';

tens = length++;

ones = length++;

name[tens] = '0';

name[ones] = '1';

name[length] = '\0';

while (ClientCheckName(name)) {

if (name[ones] == '9') {

if (name[tens] == '9') {

jack_error("client %s has 99 extra instances already", name);

return true; /* give up */

}

name[tens]++;

name[ones] = '0';

} else {

name[ones]++;

}

return false;

}

bool JackEngine::ClientCheckName(const char* name)

{

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client && (strcmp(client->GetClientControl()->fName, name) == 0)) {

return true;

}

for (std::map<int,std::string>::iterator i = fReservationMap.begin(); i != fReservationMap.end(); i++) {

if (i->second == name) {

return true;

}

return false;

}

void JackEngine::EnsureUUID(jack_uuid_t uuid)

{

if (jack_uuid_empty(uuid))

return;

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client && jack_uuid_compare(client->GetClientControl()->fSessionID, uuid) == 0) {

// FIXME? this code does nothing, but jack1 has it like this too..

jack_uuid_clear (&uuid);

// client->GetClientControl()->fSessionID = jack_client_uuid_generate();

}

int JackEngine::GetClientPID(const char* name)

{

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client && (strcmp(client->GetClientControl()->fName, name) == 0)) {

return client->GetClientControl()->fPID;

}

return 0;

}

int JackEngine::GetClientRefNum(const char* name)

{

for (int i = 0; i < CLIENT_NUM; i++) {

JackClientInterface* client = fClientTable[i];

if (client && (strcmp(client->GetClientControl()->fName, name) == 0)) {

return client->GetClientControl()->fRefNum;

}

return -1;

}

// Used for external clients

int JackEngine::ClientExternalOpen(const char* name, int pid, jack_uuid_t uuid, int* ref, int* shared_engine, int* shared_client, int* shared_graph_manager)

{

char real_name[JACK_CLIENT_NAME_SIZE + 1];

if (jack_uuid_empty(uuid)) {

uuid = jack_client_uuid_generate();

strncpy(real_name, name, JACK_CLIENT_NAME_SIZE);

} else {

std::map<int, std::string>::iterator res = fReservationMap.find(uuid);

if (res != fReservationMap.end()) {

strncpy(real_name, res->second.c_str(), JACK_CLIENT_NAME_SIZE);

fReservationMap.erase(uuid);

} else {

strncpy(real_name, name, JACK_CLIENT_NAME_SIZE);

}

EnsureUUID(uuid);

}

jack_log("JackEngine::ClientExternalOpen: uuid = %d, name = %s", uuid, real_name);

int refnum = AllocateRefnum();

if (refnum < 0) {

jack_error("No more refnum available");

return -1;

}

JackExternalClient* client = new JackExternalClient();

if (!fSynchroTable[refnum].Allocate(real_name, fEngineControl->fServerName, 0)) {

jack_error("Cannot allocate synchro");

goto error;

}

if (client->Open(real_name, pid, refnum, uuid, shared_client) < 0) {

jack_error("Cannot open client");

goto error;

}

if (!fSignal.LockedTimedWait(DRIVER_OPEN_TIMEOUT * 1000000)) {

// Failure if RT thread is not running (problem with the driver...)

jack_error("Driver is not running");

goto error;

}

fClientTable[refnum] = client;

if (NotifyAddClient(client, real_name, refnum) < 0) {

jack_error("Cannot notify add client");

goto error;

}

fGraphManager->InitRefNum(refnum);

fEngineControl->ResetRollingUsecs();

*shared_engine = fEngineControl->GetShmIndex();

*shared_graph_manager = fGraphManager->GetShmIndex();

*ref = refnum;

return 0;

error:

// Cleanup...

fSynchroTable[refnum].Destroy();

fClientTable[refnum] = 0;

client->Close();

delete client;

return -1;

}

// Used for server driver clients

int JackEngine::ClientInternalOpen(const char* name, int* ref, JackEngineControl** shared_engine, JackGraphManager** shared_manager, JackClientInterface* client, bool wait)

{

jack_log("JackEngine::ClientInternalOpen: name = %s", name);

int refnum = AllocateRefnum();

if (refnum < 0) {

jack_error("No more refnum available");

goto error;

}

if (!fSynchroTable[refnum].Allocate(name, fEngineControl->fServerName, 0)) {

jack_error("Cannot allocate synchro");

goto error;

}

if (wait && !fSignal.LockedTimedWait(DRIVER_OPEN_TIMEOUT * 1000000)) {

// Failure if RT thread is not running (problem with the driver...)

jack_error("Driver is not running");

goto error;

}

fClientTable[refnum] = client;

if (NotifyAddClient(client, name, refnum) < 0) {

jack_error("Cannot notify add client");

goto error;

}

fGraphManager->InitRefNum(refnum);

fEngineControl->ResetRollingUsecs();

*shared_engine = fEngineControl;

*shared_manager = fGraphManager;

*ref = refnum;

return 0;

error:

// Cleanup...

fSynchroTable[refnum].Destroy();

fClientTable[refnum] = 0;

return -1;

}

// Used for external clients

int JackEngine::ClientExternalClose(int refnum)

{

jack_log("JackEngine::ClientExternalClose ref = %ld", refnum);

JackClientInterface* client = fClientTable[refnum];

assert(client);

int res = ClientCloseAux(refnum, true);

client->Close();

delete client;

return res;

}

// Used for server internal clients or drivers when the RT thread is stopped

int JackEngine::ClientInternalClose(int refnum, bool wait)

{

jack_log("JackEngine::ClientInternalClose ref = %ld", refnum);

return ClientCloseAux(refnum, wait);

}

int JackEngine::ClientCloseAux(int refnum, bool wait)

{

jack_log("JackEngine::ClientCloseAux ref = %ld", refnum);

JackClientInterface* client = fClientTable[refnum];

fEngineControl->fTransport.ResetTimebase(refnum);

jack_uuid_t uuid = JACK_UUID_EMPTY_INITIALIZER;

jack_uuid_copy (&uuid, client->GetClientControl()->fSessionID);

// Unregister all ports ==> notifications are sent

jack_int_t ports[PORT_NUM_FOR_CLIENT];

int i;

fGraphManager->GetInputPorts(refnum, ports);

for (i = 0; (i < PORT_NUM_FOR_CLIENT) && (ports[i] != EMPTY); i++) {

PortUnRegister(refnum, ports[i]);

}

fGraphManager->GetOutputPorts(refnum, ports);

for (i = 0; (i < PORT_NUM_FOR_CLIENT) && (ports[i] != EMPTY); i++) {

PortUnRegister(refnum, ports[i]);

}

// Remove the client from the table

ReleaseRefnum(refnum);

// Remove all ports

fGraphManager->RemoveAllPorts(refnum);

// Wait until next cycle to be sure client is not used anymore

if (wait) {

if (!fSignal.LockedTimedWait(fEngineControl->fTimeOutUsecs * 2)) { // Must wait at least until a switch occurs in Process, even in case of graph end failure

jack_error("JackEngine::ClientCloseAux wait error ref = %ld", refnum);

}

if (fMetadata.RemoveProperties(NULL, uuid) > 0) {

/* have to do the notification ourselves, since the client argument

to fMetadata->RemoveProperties() was NULL

PropertyChangeNotify(uuid, NULL, PropertyDeleted);

}

// Notify running clients

NotifyRemoveClient(client->GetClientControl()->fName, refnum);

// Cleanup...

fSynchroTable[refnum].Destroy();

fEngineControl->ResetRollingUsecs();

return 0;

}

int JackEngine::ClientActivate(int refnum, bool is_real_time, bool wait)

{

JackClientInterface* client = fClientTable[refnum];

jack_log("JackEngine::ClientActivate ref = %ld name = %s", refnum, client->GetClientControl()->fName);

if (is_real_time) {

fGraphManager->Activate(refnum);

}

// Wait for graph state change to be effective

if (wait && !fSignal.LockedTimedWait(fEngineControl->fTimeOutUsecs * 10)) {

jack_error("JackEngine::ClientActivate wait error ref = %ld name = %s", refnum, client->GetClientControl()->fName);

return -1;

} else {

jack_int_t input_ports[PORT_NUM_FOR_CLIENT];

jack_int_t output_ports[PORT_NUM_FOR_CLIENT];

fGraphManager->GetInputPorts(refnum, input_ports);

fGraphManager->GetOutputPorts(refnum, output_ports);

// Notify client

NotifyActivate(refnum);

// Then issue port registration notification

for (int i = 0; (i < PORT_NUM_FOR_CLIENT) && (input_ports[i] != EMPTY); i++) {

NotifyPortRegistation(input_ports[i], true);

}

for (int i = 0; (i < PORT_NUM_FOR_CLIENT) && (output_ports[i] != EMPTY); i++) {

NotifyPortRegistation(output_ports[i], true);

}

return 0;

}

// May be called without client

int JackEngine::ClientDeactivate(int refnum, bool wait)

{

JackClientInterface* client = fClientTable[refnum];

jack_log("JackEngine::ClientDeactivate ref = %ld name = %s", refnum, client->GetClientControl()->fName);

jack_int_t input_ports[PORT_NUM_FOR_CLIENT];

jack_int_t output_ports[PORT_NUM_FOR_CLIENT];

fGraphManager->GetInputPorts(refnum, input_ports);

fGraphManager->GetOutputPorts(refnum, output_ports);

// First disconnect all ports

for (int i = 0; (i < PORT_NUM_FOR_CLIENT) && (input_ports[i] != EMPTY); i++) {

PortDisconnect(-1, input_ports[i], ALL_PORTS);

}

for (int i = 0; (i < PORT_NUM_FOR_CLIENT) && (output_ports[i] != EMPTY); i++) {

PortDisconnect(-1, output_ports[i], ALL_PORTS);

}

// Then issue port registration notification

for (int i = 0; (i < PORT_NUM_FOR_CLIENT) && (input_ports[i] != EMPTY); i++) {

NotifyPortRegistation(input_ports[i], false);

}

for (int i = 0; (i < PORT_NUM_FOR_CLIENT) && (output_ports[i] != EMPTY); i++) {

NotifyPortRegistation(output_ports[i], false);

}

fGraphManager->Deactivate(refnum);

fLastSwitchUsecs = 0; // Force switch to occur next cycle, even when called with "dead" clients

// Wait for graph state change to be effective

if (wait && !fSignal.LockedTimedWait(fEngineControl->fTimeOutUsecs * 10)) {

jack_error("JackEngine::ClientDeactivate wait error ref = %ld name = %s", refnum, client->GetClientControl()->fName);

return -1;

} else {

return 0;

}

void JackEngine::ClientKill(int refnum)

{

jack_log("JackEngine::ClientKill ref = %ld", refnum);

if (ClientDeactivate(refnum, true) < 0) {

jack_error("JackEngine::ClientKill ref = %ld cannot be removed from the graph !!", refnum);

}

if (ClientExternalClose(refnum) < 0) {

jack_error("JackEngine::ClientKill ref = %ld cannot be closed", refnum);

}

//-----------------

// Port management

//-----------------

int JackEngine::PortRegister(int refnum, const char* name, const char *type, unsigned int flags, unsigned int buffer_size, jack_port_id_t* port_index)

{

jack_log("JackEngine::PortRegister ref = %ld name = %s type = %s flags = %d buffer_size = %d", refnum, name, type, flags, buffer_size);

JackClientInterface* client = fClientTable[refnum];

// Check if port name already exists

if (fGraphManager->GetPort(name) != NO_PORT) {

jack_error("port_name \"%s\" already exists", name);

return -1;

}

// buffer_size is actually ignored...

*port_index = fGraphManager->AllocatePort(refnum, name, type, (JackPortFlags)flags, fEngineControl->fBufferSize);

if (*port_index != NO_PORT) {

if (client->GetClientControl()->fActive) {

NotifyPortRegistation(*port_index, true);

}

return 0;

} else {

return -1;

}

int JackEngine::PortUnRegister(int refnum, jack_port_id_t port_index)

{

jack_log("JackEngine::PortUnRegister ref = %ld port_index = %ld", refnum, port_index);

JackClientInterface* client = fClientTable[refnum];

assert(client);

// Disconnect port ==> notification is sent

PortDisconnect(-1, port_index, ALL_PORTS);

if (fGraphManager->ReleasePort(refnum, port_index) == 0) {

const jack_uuid_t uuid = jack_port_uuid_generate(port_index);

if (!jack_uuid_empty(uuid))

{

if (fMetadata.RemoveProperties(NULL, uuid) > 0) {

/* have to do the notification ourselves, since the client argument

to fMetadata->RemoveProperties() was NULL

PropertyChangeNotify(uuid, NULL, PropertyDeleted);

}

if (client->GetClientControl()->fActive) {

NotifyPortRegistation(port_index, false);

}

return 0;

} else {

return -1;

}

// this check is to prevent apps to self connect to other apps

// TODO: make this work with multiple clients per app

int JackEngine::CheckPortsConnect(int refnum, jack_port_id_t src, jack_port_id_t dst)

{

if (fSelfConnectMode == ' ') return 1;

JackPort* src_port = fGraphManager->GetPort(src);

JackPort* dst_port = fGraphManager->GetPort(dst);

jack_log("JackEngine::CheckPortsConnect(ref = %d, src = %d, dst = %d)", refnum, src_port->GetRefNum(), dst_port->GetRefNum());

//jack_log("%s -> %s", src_port->GetName(), dst_port->GetName());

//jack_log("mode = '%c'", fSelfConnectMode);

int src_self = src_port->GetRefNum() == refnum ? 1 : 0;

int dst_self = dst_port->GetRefNum() == refnum ? 1 : 0;

//jack_log("src_self is %s", src_self ? "true" : "false");

//jack_log("dst_self is %s", dst_self ? "true" : "false");

// 0 means client is connecting other client ports (control app patchbay functionality)

// 1 means client is connecting its own port to port of other client (e.g. self connecting into "system" client)

// 2 means client is connecting its own ports (for app internal functionality)

int sum = src_self + dst_self;

//jack_log("sum = %d", sum);

if (sum == 0) return 1;

char lmode = tolower(fSelfConnectMode);

//jack_log("lmode = '%c'", lmode);

if (sum == 2 && lmode == 'e') return 1;

bool fail = lmode != fSelfConnectMode; // fail modes are upper case

//jack_log("fail = %d", (int)fail);

jack_info(

"%s port self connect request%s (%s -> %s)",

fail ? "rejecting" : "ignoring",

sum == 1 ? " to external port" : "",

src_port->GetName(),

dst_port->GetName());

return fail ? -1 : 0;

}

int JackEngine::PortConnect(int refnum, const char* src, const char* dst)

{

jack_log("JackEngine::PortConnect ref = %d src = %s dst = %s", refnum, src, dst);

jack_port_id_t port_src, port_dst;

return (fGraphManager->GetTwoPorts(src, dst, &port_src, &port_dst) < 0)

? -1

: PortConnect(refnum, port_src, port_dst);

}

int JackEngine::PortConnect(int refnum, jack_port_id_t src, jack_port_id_t dst)

{

jack_log("JackEngine::PortConnect ref = %d src = %d dst = %d", refnum, src, dst);

JackClientInterface* client;

int ref;

if (fGraphManager->CheckPorts(src, dst) < 0) {

return -1;

}

ref = fGraphManager->GetOutputRefNum(src);

assert(ref >= 0);

client = fClientTable[ref];

assert(client);

if (!client->GetClientControl()->fActive) {

jack_error("Cannot connect ports owned by inactive clients:"

View remainder of file in raw view

jack2/common/JackEngine.cpp at develop · jackaudio/jack2 · GitHub

Uh oh!

Expand file tree

Breadcrumbs

JackEngine.cpp

Latest commit

History

Breadcrumbs

JackEngine.cpp

File metadata and controls